* Interesting member variables:
* dygraph_ - the graph.
* global - global attributes (common among all graphs, AIUI)
- * global_user - attributes set by the user
- * axes
+ * 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.
*/
/**
- * @constructor
- *
* This parses attributes into an object that can be easily queried.
*
+ * It doesn't necessarily mean that all options are available, specifically
+ * 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.
+ * @constructor
*/
var DygraphOptions = function(dygraph) {
this.dygraph_ = dygraph;
- this.axes = [];
- this.series = {};
+ this.axes_ = [];
+ this.series_ = {};
- // Once these two objects are initialized, you can call find();
- this.global = this.dygraph_.attrs_;
- this.global_user = this.dygraph_.user_attrs_ || {};
+ // 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.
- this.labels = this.find("labels").slice(1);
+
+ var labels = this.get("labels");
+ if (!labels) {
+ return; // -- can't do more for now, will parse after getting the labels.
+ }
+
+ this.reparseSeries();
+};
+
+/**
+ * Reparses options that are all related to series. This typically occurs when
+ * options are either updated, or source data has been made avaialble.
+ *
+ * TODO(konigsberg): The method name is kind of weak; fix.
+ */
+DygraphOptions.prototype.reparseSeries = function() {
+ this.labels = this.get("labels").slice(1);
+
+ this.axes_ = [ {} ]; // Always one axis at least.
+ 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:
+ //
+ // {
+ // labels: [ "X", "foo", "bar" ],
+ // pointSize: 3,
+ // series : {
+ // foo : {}, // options for foo
+ // bar : {} // options for bar
+ // }
+ // }
+ //
+ // So, if series is found, it's expected to contain per-series data, otherwise we fall
+ // back.
+ var allseries = this.user_["series"] ? this.user_.series : this.user_;
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.global_user[seriesName] || {};
+ var optionsForSeries = allseries[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 };
+ 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 optionsForSeries = this.series_[seriesName]["options"];
var axis = optionsForSeries["axis"];
if (typeof(axis) == 'string') {
- if (!this.series.hasOwnProperty(axis)) {
+ 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;
+ this.series_[seriesName].yAxis = this.series_[axis].yAxis;
}
}
// This doesn't support reading from the 'x' axis, only 'y' and 'y2.
// Read from the global "axes" option.
- if (this.global_user.hasOwnProperty("axes")) {
- var axis_opts = this.global_user.axes;
+ if (this.user_["axes"]) {
+ var axis_opts = this.user_.axes;
- this.axes.push(axis_opts["y"] || {});
- this.axes.push(axis_opts["y2"] || {});
- } else {
- this.axes.push(axis_opts["y"] || {}); // There has to be at least one axis.
+ 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);
+ }
}
};
-DygraphOptions.prototype.find = function(name) {
- if (this.global_user.hasOwnProperty(name)) {
- return this.global_user[name];
+/**
+ * Get a global value.
+ *
+ * @param {String} name the name of the option.
+ */
+DygraphOptions.prototype.get = function(name) {
+ if (this.user_.hasOwnProperty(name)) {
+ return this.user_[name];
}
- if (this.global.hasOwnProperty(name)) {
- return this.global[name];
+ if (this.global_.hasOwnProperty(name)) {
+ return this.global_[name];
}
return null;
-}
-
-DygraphOptions.prototype.findForAxis = function(name, axis) {
+};
- var axisIdx = (axis == "y2" || axis == 1) ? 1 : 0;
+/**
+ * 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
+ * ("y", "y2") or the axis number (0, 1).
+ */
+DygraphOptions.prototype.getForAxis = function(name, axis) {
+ var axisIdx = 0;
+ if (typeof(axis) == 'number') {
+ axisIdx = axis;
+ } else {
+ // TODO(konigsberg): Accept only valid axis strings?
+ axisIdx = (axis == "y2") ? 1 : 0;
+ }
- var axisOptions = this.axes[axisIdx];
+ var axisOptions = this.axes_[axisIdx];
if (axisOptions.hasOwnProperty(name)) {
return axisOptions[name];
}
- return this.find(name);
-}
+ return this.get(name);
+};
-DygraphOptions.prototype.findForSeries = function(name, series) {
+/**
+ * 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.
+ */
+DygraphOptions.prototype.getForSeries = function(name, series) {
// Honors indexes as series.
var seriesName = (typeof(series) == "number") ? this.labels[series] : series;
- if (!this.series.hasOwnProperty(seriesName)) {
+ if (seriesName === this.dygraph_.highlightSet_) {
+ if (this.highlightSeries_.hasOwnProperty(name)) {
+ return this.highlightSeries_[name];
+ }
+ }
+
+ if (!this.series_.hasOwnProperty(seriesName)) {
throw "Unknown series: " + series;
}
- var seriesObj = this.series[seriesName];
+ var seriesObj = this.series_[seriesName];
var seriesOptions = seriesObj["options"];
if (seriesOptions.hasOwnProperty(name)) {
return seriesOptions[name];
}
- return this.findForAxis(name, seriesObj["yAxis"]);
-}
+
+ return this.getForAxis(name, seriesObj["yAxis"]);
+};
projects / dygraphs.git / blobdiff