Merge branch 'i382' of https://github.com/kberg/dygraphs into i382
[dygraphs.git] / dygraph-options.js
index 87632ff..55bfe1a 100644 (file)
@@ -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";
 
 /*
@@ -38,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();
 };
 
@@ -75,8 +78,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 +90,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 +129,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];
-  
+
       var optionsForSeries = this.user_[seriesName] || {};
-  
+
       var yAxis = 0;
       var axis = optionsForSeries["axis"];
       if (typeof(axis) == 'object') {
@@ -144,14 +152,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"]; 
+      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 " +
@@ -185,7 +193,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 +205,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 +226,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 +243,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 +270,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;
   }
 
@@ -281,24 +289,21 @@ DygraphOptions.prototype.getForAxis = function(name, axis) {
  * 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} 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];
@@ -318,8 +323,8 @@ DygraphOptions.prototype.numAxes = function() {
 /**
  * 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;
 };
 
 /**
@@ -344,7 +349,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.
@@ -352,3 +357,7 @@ DygraphOptions.prototype.seriesNames = function() {
 DygraphOptions.prototype.indexOfSeries = function(series) {
   return this.series_[series].idx;
 };
+
+return DygraphOptions;
+
+})();