/**
+ * @license
+ * Copyright 2011 Dan Vanderkam (danvdk@gmail.com)
+ * MIT-licensed (http://opensource.org/licenses/MIT)
+ */
+
+/**
* @fileoverview DygraphOptions is responsible for parsing and returning information about options.
*
* Still tightly coupled to Dygraphs, we could remove some of that, you know.
*/
+var DygraphOptions = (function() {
+/*jshint strict:false */
+
+// For "production" code, this gets set to false by uglifyjs.
+// Need to define it outside of "use strict", hence the nested IIFEs.
+if (typeof(DEBUG) === 'undefined') DEBUG=true;
+
+return (function() {
+
+// TODO: remove this jshint directive & fix the warnings.
+/*jshint sub:true */
+/*global Dygraph:false */
"use strict";
/*
- * Interesting member variables:
- * dygraph_ - the graph.
- * global - global attributes (common among all graphs, AIUI)
+ * Interesting member variables: (REMOVING THIS LIST AS I CLOSURIZE)
+ * global_ - global attributes (common among all graphs, AIUI)
* user - attributes set by the user
- * axes - map of options specific to the axis.
- * series - { seriesName -> { idx, yAxis, options }
- * labels - used as mapping from index to series name.
+ * series_ - { seriesName -> { idx, yAxis, options }}
*/
/**
* if labels are not yet available, since those drive details of the per-series
* and per-axis options.
*
- * @param {Dyraph} dygraph The chart to which these options belong.
+ * @param {Dygraph} dygraph The chart to which these options belong.
* @constructor
*/
var DygraphOptions = function(dygraph) {
+ /**
+ * The dygraph.
+ * @type {!Dygraph}
+ */
this.dygraph_ = dygraph;
- this.axes_ = [];
+
+ /**
+ * Array of axis index to { series : [ series names ] , options : { axis-specific options. }
+ * @type {Array.<{series : Array.<string>, options : Object}>} @private
+ */
+ this.yAxes_ = [];
+
+ /**
+ * Contains x-axis specific options, which are stored in the options key.
+ * This matches the yAxes_ object structure (by being a dictionary with an
+ * options element) allowing for shared code.
+ * @type {options: Object} @private
+ */
+ this.xAxis_ = {};
this.series_ = {};
// Once these two objects are initialized, you can call get();
this.global_ = this.dygraph_.attrs_;
this.user_ = this.dygraph_.user_attrs_ || {};
- this.highlightSeries_ = this.get("highlightSeriesOpts") || {};
- // Get a list of series names.
-
- var labels = this.get("labels");
- if (!labels) {
- return; // -- can't do more for now, will parse after getting the labels.
- }
+ /**
+ * A list of series in columnar order.
+ * @type {Array.<string>}
+ */
+ this.labels_ = [];
+ this.highlightSeries_ = this.get("highlightSeriesOpts") || {};
this.reparseSeries();
};
-/*
+/**
* Not optimal, but does the trick when you're only using two axes.
* If we move to more axes, this can just become a function.
+ *
+ * @type {Object.<number>}
+ * @private
*/
DygraphOptions.AXIS_STRING_MAPPINGS_ = {
'y' : 0,
'Y1' : 0,
'y2' : 1,
'Y2' : 1
-}
+};
+/**
+ * @param {string|number} axis
+ * @private
+ */
DygraphOptions.axisToIndex_ = function(axis) {
if (typeof(axis) == "string") {
if (DygraphOptions.AXIS_STRING_MAPPINGS_.hasOwnProperty(axis)) {
return DygraphOptions.AXIS_STRING_MAPPINGS_[axis];
}
- throw "Unknown axis : " + text;
+ throw "Unknown axis : " + axis;
}
if (typeof(axis) == "number") {
- if (axis == 0 || axis == 1) {
+ if (axis === 0 || axis === 1) {
return axis;
}
- throw "Dygraphs only supports two y-axes, indexed from 0-1."
+ throw "Dygraphs only supports two y-axes, indexed from 0-1.";
}
if (axis) {
throw "Unknown axis : " + axis;
/**
* Reparses options that are all related to series. This typically occurs when
- * options are either updated, or source data has been made avaialble.
+ * options are either updated, or source data has been made available.
*
* TODO(konigsberg): The method name is kind of weak; fix.
*/
DygraphOptions.prototype.reparseSeries = function() {
- this.labels = this.get("labels").slice(1);
+ var labels = this.get("labels");
+ if (!labels) {
+ return; // -- can't do more for now, will parse after getting the labels.
+ }
+
+ this.labels_ = labels.slice(1);
- this.axes_ = [ {} ]; // Always one axis at least.
+ this.yAxes_ = [ { series : [], options : {}} ]; // Always one axis at least.
+ this.xAxis_ = { options : {} };
this.series_ = {};
- // Traditionally, per-series options were specified right up there with the options. For instance
- // {
- // labels: [ "X", "foo", "bar" ],
- // pointSize: 3,
- // foo : {}, // options for foo
- // bar : {} // options for bar
- // }
- //
- // Moving forward, series really should be specified in the series element, separating them.
- // like so:
+ // Series are specified in the series element:
//
// {
// labels: [ "X", "foo", "bar" ],
// }
// }
//
- // So, if series is found, it's expected to contain per-series data, otherwise we fall
- // back.
- var oldStyleSeries = !this.user_["series"];
-
- if (oldStyleSeries) {
- var axisId = 0; // 0-offset; there's always one.
- // Go through once, add all the series, and for those with {} axis options, add a new axis.
- for (var idx = 0; idx < this.labels.length; idx++) {
- var seriesName = this.labels[idx];
-
- var optionsForSeries = this.user_[seriesName] || {};
-
- var yAxis = 0;
- var axis = optionsForSeries["axis"];
- if (typeof(axis) == 'object') {
- yAxis = ++axisId;
- this.axes_[yAxis] = axis;
- }
- this.series_[seriesName] = { idx: idx, yAxis: yAxis, options : optionsForSeries };
- }
-
- // Go through one more time and assign series to an axis defined by another
- // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
- for (var idx = 0; idx < this.labels.length; idx++) {
- var seriesName = this.labels[idx];
- var optionsForSeries = this.series_[seriesName]["options"];
- var axis = optionsForSeries["axis"];
-
- if (typeof(axis) == 'string') {
- if (!this.series_.hasOwnProperty(axis)) {
- this.dygraph_.error("Series " + seriesName + " wants to share a y-axis with " +
- "series " + axis + ", which does not define its own axis.");
- return null;
- }
- this.series_[seriesName].yAxis = this.series_[axis].yAxis;
- }
- }
- } else {
- var maxYAxis = 0;
-
- for (var idx = 0; idx < this.labels.length; idx++) {
- var seriesName = this.labels[idx];
- var optionsForSeries = this.user_.series[seriesName] || {};
- var yAxis = DygraphOptions.axisToIndex_(optionsForSeries["axis"]);
+ // So, if series is found, it's expected to contain per-series data, otherwise set a
+ // default.
+ var seriesDict = this.user_.series || {};
+ for (var idx = 0; idx < this.labels_.length; idx++) {
+ var seriesName = this.labels_[idx];
+ var optionsForSeries = seriesDict[seriesName] || {};
+ var yAxis = DygraphOptions.axisToIndex_(optionsForSeries["axis"]);
- maxYAxis = Math.max(yAxis, maxYAxis);
+ this.series_[seriesName] = {
+ idx: idx,
+ yAxis: yAxis,
+ options : optionsForSeries };
- this.series_[seriesName] = {
- idx: idx,
- yAxis: yAxis,
- options : optionsForSeries };
- }
-
- for (; maxYAxis >= 0; maxYAxis--) {
- this.axes_[maxYAxis] = {};
+ if (!this.yAxes_[yAxis]) {
+ this.yAxes_[yAxis] = { series : [ seriesName ], options : {} };
+ } else {
+ this.yAxes_[yAxis].series.push(seriesName);
}
}
- // This doesn't support reading from the 'x' axis, only 'y' and 'y2.
- if (this.user_["axes"]) {
- var axis_opts = this.user_.axes;
-
- if (axis_opts.hasOwnProperty("y")) {
- Dygraph.update(this.axes_[0], axis_opts.y);
- }
-
- if (axis_opts.hasOwnProperty("y2")) {
- this.axes_[1] = this.axes_[1] || {};
- Dygraph.update(this.axes_[1], axis_opts.y2);
- }
+ var axis_opts = this.user_["axes"] || {};
+ Dygraph.update(this.yAxes_[0].options, axis_opts["y"] || {});
+ if (this.yAxes_.length > 1) {
+ Dygraph.update(this.yAxes_[1].options, axis_opts["y2"] || {});
}
+ Dygraph.update(this.xAxis_.options, axis_opts["x"] || {});
+
+ if (DEBUG) this.validateOptions_();
};
/**
* Get a global value.
*
- * @param {String} name the name of the option.
+ * @param {string} name the name of the option.
*/
DygraphOptions.prototype.get = function(name) {
+ var result = this.getGlobalUser_(name);
+ if (result !== null) {
+ return result;
+ }
+ return this.getGlobalDefault_(name);
+};
+
+DygraphOptions.prototype.getGlobalUser_ = function(name) {
if (this.user_.hasOwnProperty(name)) {
return this.user_[name];
}
+ return null;
+};
+
+DygraphOptions.prototype.getGlobalDefault_ = function(name) {
if (this.global_.hasOwnProperty(name)) {
return this.global_[name];
}
+ if (Dygraph.DEFAULT_ATTRS.hasOwnProperty(name)) {
+ return Dygraph.DEFAULT_ATTRS[name];
+ }
return null;
};
* Get a value for a specific axis. If there is no specific value for the axis,
* the global value is returned.
*
- * @param {String} name the name of the option.
- * @param {String|number} axis the axis to search. Can be the string representation
+ * @param {string} name the name of the option.
+ * @param {string|number} axis the axis to search. Can be the string representation
* ("y", "y2") or the axis number (0, 1).
*/
DygraphOptions.prototype.getForAxis = function(name, axis) {
- var axisIdx = 0;
+ var axisIdx;
+ var axisString;
+
+ // Since axis can be a number or a string, straighten everything out here.
if (typeof(axis) == 'number') {
axisIdx = axis;
+ axisString = axisIdx === 0 ? "y" : "y2";
} else {
- // TODO(konigsberg): Accept only valid axis strings?
- axisIdx = (axis == "y2") ? 1 : 0;
+ if (axis == "y1") { axis = "y"; } // Standardize on 'y'. Is this bad? I think so.
+ if (axis == "y") {
+ axisIdx = 0;
+ } else if (axis == "y2") {
+ axisIdx = 1;
+ } else if (axis == "x") {
+ axisIdx = -1; // simply a placeholder for below.
+ } else {
+ throw "Unknown axis " + axis;
+ }
+ axisString = axis;
}
- var axisOptions = this.axes_[axisIdx];
- if (axisOptions.hasOwnProperty(name)) {
- return axisOptions[name];
+ var userAxis = (axisIdx == -1) ? this.xAxis_ : this.yAxes_[axisIdx];
+
+ // Search the user-specified axis option first.
+ if (userAxis) { // This condition could be removed if we always set up this.yAxes_ for y2.
+ var axisOptions = userAxis.options;
+ if (axisOptions.hasOwnProperty(name)) {
+ return axisOptions[name];
+ }
}
- return this.get(name);
+
+ // User-specified global options second.
+ // But, hack, ignore globally-specified 'logscale' for 'x' axis declaration.
+ if (!(axis === 'x' && name === 'logscale')) {
+ var result = this.getGlobalUser_(name);
+ if (result !== null) {
+ return result;
+ }
+ }
+ // Default axis options third.
+ var defaultAxisOptions = Dygraph.DEFAULT_ATTRS.axes[axisString];
+ if (defaultAxisOptions.hasOwnProperty(name)) {
+ return defaultAxisOptions[name];
+ }
+
+ // Default global options last.
+ return this.getGlobalDefault_(name);
};
/**
* Get a value for a specific series. If there is no specific value for the series,
* the value for the axis is returned (and afterwards, the global value.)
*
- * @param {String} name the name of the option.
- * @param {String|number} series the series to search. Can be the string representation
- * or 0-offset series number.
+ * @param {string} name the name of the option.
+ * @param {string} series the series to search.
*/
DygraphOptions.prototype.getForSeries = function(name, series) {
// Honors indexes as series.
- var seriesName = (typeof(series) == "number") ? this.labels[series] : series;
-
- if (seriesName === this.dygraph_.highlightSet_) {
+ if (series === this.dygraph_.getHighlightSeries()) {
if (this.highlightSeries_.hasOwnProperty(name)) {
return this.highlightSeries_[name];
}
}
- if (!this.series_.hasOwnProperty(seriesName)) {
+ if (!this.series_.hasOwnProperty(series)) {
throw "Unknown series: " + series;
}
- var seriesObj = this.series_[seriesName];
+ var seriesObj = this.series_[series];
var seriesOptions = seriesObj["options"];
if (seriesOptions.hasOwnProperty(name)) {
return seriesOptions[name];
return this.getForAxis(name, seriesObj["yAxis"]);
};
+
+/**
+ * Returns the number of y-axes on the chart.
+ * @return {number} the number of axes.
+ */
+DygraphOptions.prototype.numAxes = function() {
+ return this.yAxes_.length;
+};
+
+/**
+ * Return the y-axis for a given series, specified by name.
+ */
+DygraphOptions.prototype.axisForSeries = function(series) {
+ return this.series_[series].yAxis;
+};
+
+/**
+ * Returns the options for the specified axis.
+ */
+// TODO(konigsberg): this is y-axis specific. Support the x axis.
+DygraphOptions.prototype.axisOptions = function(yAxis) {
+ return this.yAxes_[yAxis].options;
+};
+
+/**
+ * Return the series associated with an axis.
+ */
+DygraphOptions.prototype.seriesForAxis = function(yAxis) {
+ return this.yAxes_[yAxis].series;
+};
+
+/**
+ * Return the list of all series, in their columnar order.
+ */
+DygraphOptions.prototype.seriesNames = function() {
+ return this.labels_;
+};
+
+if (DEBUG) {
+
+/**
+ * Validate all options.
+ * This requires Dygraph.OPTIONS_REFERENCE, which is only available in debug builds.
+ * @private
+ */
+DygraphOptions.prototype.validateOptions_ = function() {
+ if (typeof Dygraph.OPTIONS_REFERENCE === 'undefined') {
+ throw 'Called validateOptions_ in prod build.';
+ }
+
+ var that = this;
+ var validateOption = function(optionName) {
+ if (!Dygraph.OPTIONS_REFERENCE[optionName]) {
+ that.warnInvalidOption_(optionName);
+ }
+ };
+
+ var optionsDicts = [this.xAxis_.options,
+ this.yAxes_[0].options,
+ this.yAxes_[1] && this.yAxes_[1].options,
+ this.global_,
+ this.user_,
+ this.highlightSeries_];
+ var names = this.seriesNames();
+ for (var i = 0; i < names.length; i++) {
+ var name = names[i];
+ if (this.series_.hasOwnProperty(name)) {
+ optionsDicts.push(this.series_[name].options);
+ }
+ }
+ for (var i = 0; i < optionsDicts.length; i++) {
+ var dict = optionsDicts[i];
+ if (!dict) continue;
+ for (var optionName in dict) {
+ if (dict.hasOwnProperty(optionName)) {
+ validateOption(optionName);
+ }
+ }
+ }
+};
+
+var WARNINGS = {}; // Only show any particular warning once.
+
+/**
+ * Logs a warning about invalid options.
+ * TODO: make this throw for testing
+ * @private
+ */
+DygraphOptions.prototype.warnInvalidOption_ = function(optionName) {
+ if (!WARNINGS[optionName]) {
+ WARNINGS[optionName] = true;
+ var isSeries = (this.labels_.indexOf(optionName) >= 0);
+ if (isSeries) {
+ console.warn('Use new-style per-series options (saw ' + optionName + ' as top-level options key). See http://bit.ly/1tceaJs');
+ } else {
+ console.warn('Unknown option ' + optionName + ' (full list of options at dygraphs.com/options.html');
+ throw "invalid option " + optionName;
+ }
+ }
+};
+
+// Reset list of previously-shown warnings. Used for testing.
+DygraphOptions.resetWarnings_ = function() {
+ WARNINGS = {};
+};
+
+}
+
+return DygraphOptions;
+
+})();
+})();