/*
* Interesting member variables:
* dygraph_ - the graph.
- * global - global attributes (common among all graphs, AIUI)
+ * global_ - global attributes (common among all graphs, AIUI)
* user - attributes set by the user
- * axes
- * series - { seriesName -> { idx, yAxis, options }
- * labels - used as mapping from index to series name.
+ * axes_ - array of axis index to { series : [ series names ] , options : { axis-specific options. }
+ * 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_ = {};
- // Once these two objects are initialized, you can call find();
+ // Once these two objects are initialized, you can call get();
this.global_ = this.dygraph_.attrs_;
this.user_ = this.dygraph_.user_attrs_ || {};
- this.highlightSeries_ = this.find("highlightSeriesOpts") || {};
+ this.highlightSeries_ = this.get("highlightSeriesOpts") || {};
// Get a list of series names.
- var labels = this.find("labels");
+ 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.find("labels").slice(1);
+ this.labels = this.get("labels").slice(1);
- this.axes_ = [ {} ]; // Always one axis at least.
+ this.axes_ = [ { series : [], options : {}} ]; // Always one axis at least.
this.series_ = {};
var axisId = 0; // 0-offset; there's always one.
var axis = optionsForSeries["axis"];
if (typeof(axis) == 'object') {
yAxis = ++axisId;
- this.axes_[yAxis] = axis;
+ this.axes_[yAxis] = { series : [ seriesName ], options : axis };
}
+
+ // Associate series without axis options with axis 0.
+ if (!axis) { // undefined
+ this.axes_[0].series.push(seriesName);
+ }
+
this.series_[seriesName] = { idx: idx, yAxis: yAxis, options : optionsForSeries };
}
"series " + axis + ", which does not define its own axis.");
return null;
}
- this.series_[seriesName].yAxis = this.series_[axis].yAxis;
+ var yAxis = this.series_[axis].yAxis;
+ this.series_[seriesName].yAxis = yAxis;
+ this.axes_[yAxis].series.push(seriesName);
}
}
var axis_opts = this.user_.axes;
if (axis_opts.hasOwnProperty("y")) {
- Dygraph.update(this.axes_[0], axis_opts.y);
+ Dygraph.update(this.axes_[0].options, axis_opts.y);
}
if (axis_opts.hasOwnProperty("y2")) {
- this.axes_[1] = this.axes_[1] || {};
- Dygraph.update(this.axes_[1], axis_opts.y2);
+ this.axes_[1] = this.axes_[1] || {}; // FIX
+ Dygraph.update(this.axes_[1].options, axis_opts.y2);
}
}
};
-DygraphOptions.prototype.find = function(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];
}
return this.global_[name];
}
return null;
-}
+};
-DygraphOptions.prototype.findForAxis = function(name, axis) {
- var axisIdx = (axis == "y2" || 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].options;
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;
return seriesOptions[name];
}
- return this.findForAxis(name, seriesObj["yAxis"]);
+ 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.axes_.length;
}
+/**
+ * Return the y-axis for a given series, specified by name.
+ */
+DygraphOptions.prototype.axisForSeries = function(seriesName) {
+ return this.series_[seriesName].yAxis;
+}
+
+/**
+ * Returns the options for the specified axis.
+ */
+DygraphOptions.prototype.axisOptions = function(yAxis) {
+ return this.axes_[yAxis].options;
+}
+
+/**
+ * Return the series associated with an axis.
+ */
+DygraphOptions.prototype.seriesForAxis = function(yAxis) {
+ return this.axes_[yAxis].series;
+}
projects / dygraphs.git / blobdiff