X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=dygraph-options.js;h=ccba4f89637429c6547ab48eecfd7c335d34160b;hb=7b00a3cd1eedf449f0d08f63efc544ffb566ed08;hp=907811c8aed5bc38ff0d6fc239e4ad4f7fb1affa;hpb=8e19509a9e0a607dcd2e5b0c3bcbe0e39e3170c2;p=dygraphs.git diff --git a/dygraph-options.js b/dygraph-options.js index 907811c..ccba4f8 100644 --- a/dygraph-options.js +++ b/dygraph-options.js @@ -1,20 +1,26 @@ /** + * @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"; /* - * Interesting member variables: - * dygraph_ - the graph. + * Interesting member variables: (REMOVING THIS LIST AS I CLOSURIZE) * global_ - global attributes (common among all graphs, AIUI) * user - attributes set by the user - * 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. */ /** @@ -24,12 +30,26 @@ * 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; + + /** + * Array of axis index to { series : [ series names ] , options : { axis-specific options. } + * @type {Array.<{series : Array., options : Object}>} + */ this.yAxes_ = []; + + /** + * { options : { axis-specific options. } + * @type {Object} + */ this.xAxis_ = {}; this.series_ = {}; @@ -37,20 +57,22 @@ var DygraphOptions = function(dygraph) { 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.} + */ + 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.} + * @private */ DygraphOptions.AXIS_STRING_MAPPINGS_ = { 'y' : 0, @@ -75,8 +97,8 @@ DygraphOptions.axisToIndex_ = function(axis) { 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."; + throw "Using objects for axis specification " + + "is not supported inside the 'series' option."; } if (axis) { throw "Unknown axis : " + axis; @@ -87,12 +109,17 @@ 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.yAxes_ = [ { series : [], options : {}} ]; // Always one axis at least. this.xAxis_ = { options : {} }; @@ -121,15 +148,15 @@ 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]; - + 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') { @@ -144,14 +171,14 @@ DygraphOptions.prototype.reparseSeries = function() { 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"]; + 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 " + @@ -164,8 +191,8 @@ DygraphOptions.prototype.reparseSeries = function() { } } } else { - for (var idx = 0; idx < this.labels.length; idx++) { - var seriesName = this.labels[idx]; + 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"]); @@ -185,7 +212,7 @@ DygraphOptions.prototype.reparseSeries = function() { 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.yAxes_[1].options, axis_opts["y2"] || {}); } Dygraph.update(this.xAxis_.options, axis_opts["x"] || {}); }; @@ -197,7 +224,7 @@ DygraphOptions.prototype.reparseSeries = function() { */ DygraphOptions.prototype.get = function(name) { var result = this.getGlobalUser_(name); - if (result != null) { + if (result !== null) { return result; } return this.getGlobalDefault_(name); @@ -218,7 +245,7 @@ DygraphOptions.prototype.getGlobalDefault_ = function(name) { return Dygraph.DEFAULT_ATTRS[name]; } return null; -} +}; /** * Get a value for a specific axis. If there is no specific value for the axis, @@ -235,7 +262,7 @@ DygraphOptions.prototype.getForAxis = function(name, axis) { // Since axis can be a number or a string, straighten everything out here. if (typeof(axis) == 'number') { axisIdx = axis; - axisString = axisIdx == 0 ? "y" : "y2"; + axisString = axisIdx === 0 ? "y" : "y2"; } else { if (axis == "y1") { axis = "y"; } // Standardize on 'y'. Is this bad? I think so. if (axis == "y") { @@ -262,7 +289,7 @@ DygraphOptions.prototype.getForAxis = function(name, axis) { // User-specified global options second. var result = this.getGlobalUser_(name); - if (result != null) { + if (result !== null) { return result; } @@ -306,7 +333,7 @@ DygraphOptions.prototype.getForSeries = function(name, series) { /** * Returns the number of y-axes on the chart. - * @return {Number} the number of axes. + * @return {number} the number of axes. */ DygraphOptions.prototype.numAxes = function() { return this.yAxes_.length; @@ -341,7 +368,7 @@ 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. @@ -349,3 +376,7 @@ DygraphOptions.prototype.seriesNames = function() { DygraphOptions.prototype.indexOfSeries = function(series) { return this.series_[series].idx; }; + +return DygraphOptions; + +})();