X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=dygraph-options.js;h=55bfe1a977063d6cb36aa5b547cdc8eae7d4a6e7;hb=d66c74ef29a8ad222e7203911af1b46b37f5bde1;hp=f734c5da470b5b4c1e2dcbe9b656e904cb02d321;hpb=c70fe730d3e8a4ff32f9371d95a7894441f2f671;p=dygraphs.git diff --git a/dygraph-options.js b/dygraph-options.js index f734c5d..55bfe1a 100644 --- a/dygraph-options.js +++ b/dygraph-options.js @@ -1,9 +1,19 @@ /** + * @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 sub:true */ +/*global Dygraph:false */ "use strict"; /* @@ -11,7 +21,8 @@ * dygraph_ - the graph. * global_ - global attributes (common among all graphs, AIUI) * user - attributes set by the user - * axes_ - array of axis index to { series : [ series names ] , options : { axis-specific options. } + * yAxes_ - array of axis index to { series : [ series names ] , options : { axis-specific options. } + * xAxis_ - { options : { axis-specific options. } * series_ - { seriesName -> { idx, yAxis, options }} * labels_ - used as mapping from index to series name. */ @@ -28,7 +39,8 @@ */ var DygraphOptions = function(dygraph) { this.dygraph_ = dygraph; - this.axes_ = []; + this.yAxes_ = []; + this.xAxis_ = {}; this.series_ = {}; // Once these two objects are initialized, you can call get(); @@ -36,13 +48,6 @@ var DygraphOptions = function(dygraph) { 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. - } - this.reparseSeries(); }; @@ -57,20 +62,24 @@ DygraphOptions.AXIS_STRING_MAPPINGS_ = { 'Y1' : 0, 'y2' : 1, 'Y2' : 1 -} +}; 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 (typeof(axis) == "object") { + throw "Using objects for axis specification " + + "is not supported inside the 'series' option."; } if (axis) { throw "Unknown axis : " + axis; @@ -81,14 +90,20 @@ DygraphOptions.axisToIndex_ = function(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_ = [ { series : [], options : {}} ]; // 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 @@ -114,37 +129,37 @@ DygraphOptions.prototype.reparseSeries = function() { // 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] = { series : [ seriesName ], options : axis }; + this.yAxes_[yAxis] = { series : [ seriesName ], options : axis }; } // Associate series without axis options with axis 0. if (!axis) { // undefined - this.axes_[0].series.push(seriesName); + this.yAxes_[0].series.push(seriesName); } 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)) { this.dygraph_.error("Series " + seriesName + " wants to share a y-axis with " + @@ -153,52 +168,63 @@ DygraphOptions.prototype.reparseSeries = function() { } var yAxis = this.series_[axis].yAxis; this.series_[seriesName].yAxis = yAxis; - this.axes_[yAxis].series.push(seriesName); + this.yAxes_[yAxis].series.push(seriesName); } } } 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"]); - maxYAxis = Math.max(yAxis, maxYAxis); - this.series_[seriesName] = { idx: idx, yAxis: yAxis, options : optionsForSeries }; - if (!this.axes_[yAxis]) { - this.axes_[yAxis] = { series : [ seriesName ], options : {} }; + if (!this.yAxes_[yAxis]) { + this.yAxes_[yAxis] = { series : [ seriesName ], options : {} }; } else { - this.axes_[yAxis].series.push(seriesName); + this.yAxes_[yAxis].series.push(seriesName); } } } - // This doesn't support reading from the 'x' axis, only 'y' and 'y2. var axis_opts = this.user_["axes"] || {}; - Dygraph.update(this.axes_[0].options, axis_opts["y"] || {}); - if (this.axes_.length > 1) { - Dygraph.update(this.axes_[1].options, axis_opts["y2"] || {}); + 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"] || {}); }; /** * 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; }; @@ -206,49 +232,78 @@ DygraphOptions.prototype.get = function(name) { * 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 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]; + } } - var axisOptions = this.axes_[axisIdx].options; - if (axisOptions.hasOwnProperty(name)) { - return axisOptions[name]; + // User-specified global options second. + var result = this.getGlobalUser_(name); + if (result !== null) { + return result; } - return this.get(name); + + // 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_.highlightSet_) { 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]; @@ -262,42 +317,47 @@ DygraphOptions.prototype.getForSeries = function(name, series) { * @return {Number} the number of axes. */ DygraphOptions.prototype.numAxes = function() { - return this.axes_.length; -} + return this.yAxes_.length; +}; /** * Return the y-axis for a given series, specified by name. */ -DygraphOptions.prototype.axisForSeries = function(seriesName) { - return this.series_[seriesName].yAxis; -} +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.axes_[yAxis].options; -} + return this.yAxes_[yAxis].options; +}; /** * Return the series associated with an axis. */ DygraphOptions.prototype.seriesForAxis = function(yAxis) { - return this.axes_[yAxis].series; -} + return this.yAxes_[yAxis].series; +}; /** * Return the list of all series, in their columnar order. */ DygraphOptions.prototype.seriesNames = function() { return this.labels_; -} +}; -/* Are we using this? */ +/* Are we using this? */ /** * Return the index of the specified series. * @param {string} series the series name. */ DygraphOptions.prototype.indexOfSeries = function(series) { return this.series_[series].idx; -} +}; + +return DygraphOptions; + +})();