dygraph-options.js

   1 /**
   2  * @fileoverview DygraphOptions is responsible for parsing and returning information about options.
   3  *
   4  * Still tightly coupled to Dygraphs, we could remove some of that, you know.
   5  */
   6
   7 "use strict";
   8
   9 /*
  10  * Interesting member variables:
  11  * dygraph_ - the graph.
  12  * global - global attributes (common among all graphs, AIUI)
  13  * user - attributes set by the user
  14  * axes
  15  * series - { seriesName -> { idx, yAxis, options }
  16  * labels - used as mapping from index to series name.
  17  */
  18
  19 /**
  20  * This parses attributes into an object that can be easily queried.
  21  *
  22  * @param {Dyraph} dygraph The chart to which these options belong.
  23  * @constructor
  24  */
  25 var DygraphOptions = function(dygraph) {
  26   this.dygraph_ = dygraph;
  27   this.axes_ = [];
  28   this.series_ = {};
  29
  30   // Once these two objects are initialized, you can call find();
  31   this.global_ = this.dygraph_.attrs_;
  32   this.user_ = this.dygraph_.user_attrs_ || {};
  33
  34   this.highlightSeries_ = this.find("highlightSeriesOpts") || {};
  35   // Get a list of series names.
  36
  37   var labels = this.find("labels");
  38   if (!labels) {
  39     return; // -- can't do more for now, will parse after getting the labels.
  40   };
  41
  42   this.reparseSeries();
  43 }
  44
  45 DygraphOptions.prototype.reparseSeries = function() {
  46   this.labels = this.find("labels").slice(1);
  47
  48   this.axes_ = [ {} ]; // Always one axis at least.
  49   this.series_ = {};
  50
  51   var axisId = 0; // 0-offset; there's always one.
  52   // Go through once, add all the series, and for those with {} axis options, add a new axis.
  53   for (var idx = 0; idx < this.labels.length; idx++) {
  54     var seriesName = this.labels[idx];
  55
  56     var optionsForSeries = this.user_[seriesName] || {};
  57     var yAxis = 0;
  58
  59     var axis = optionsForSeries["axis"];
  60     if (typeof(axis) == 'object') {
  61       yAxis = ++axisId;
  62       this.axes_[yAxis] = axis;
  63     }
  64     this.series_[seriesName] = { idx: idx, yAxis: yAxis, options : optionsForSeries };
  65   }
  66
  67   // Go through one more time and assign series to an axis defined by another
  68   // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
  69   for (var idx = 0; idx < this.labels.length; idx++) {
  70     var seriesName = this.labels[idx];
  71     var optionsForSeries = this.series_[seriesName]["options"];
  72     var axis = optionsForSeries["axis"];
  73
  74     if (typeof(axis) == 'string') {
  75       if (!this.series_.hasOwnProperty(axis)) {
  76         this.dygraph_.error("Series " + seriesName + " wants to share a y-axis with " +
  77                    "series " + axis + ", which does not define its own axis.");
  78         return null;
  79       }
  80       this.series_[seriesName].yAxis = this.series_[axis].yAxis;
  81     }
  82   }
  83
  84   // This doesn't support reading from the 'x' axis, only 'y' and 'y2.
  85   // Read from the global "axes" option.
  86   if (this.user_.hasOwnProperty("axes")) {
  87     var axis_opts = this.user_.axes;
  88
  89     if (axis_opts.hasOwnProperty("y")) {
  90       Dygraph.update(this.axes_[0], axis_opts.y);
  91     }
  92
  93     if (axis_opts.hasOwnProperty("y2")) {
  94       this.axes_[1] = this.axes_[1] || {};
  95       Dygraph.update(this.axes_[1], axis_opts.y2);
  96     }
  97   }
  98 };
  99
 100 DygraphOptions.prototype.find = function(name) {
 101   if (this.user_.hasOwnProperty(name)) {
 102     return this.user_[name];
 103   }
 104   if (this.global_.hasOwnProperty(name)) {
 105     return this.global_[name];
 106   }
 107   return null;
 108 }
 109
 110 DygraphOptions.prototype.findForAxis = function(name, axis) {
 111   var axisIdx = (axis == "y2" || axis == "y2" || axis == 1) ? 1 : 0;
 112
 113   var axisOptions = this.axes_[axisIdx];
 114   if (axisOptions.hasOwnProperty(name)) {
 115     return axisOptions[name];
 116   }
 117   return this.find(name);
 118 }
 119
 120 DygraphOptions.prototype.findForSeries = function(name, series) {
 121   // Honors indexes as series.
 122   var seriesName = (typeof(series) == "number") ? this.labels[series] : series;
 123
 124   if (seriesName === this.dygraph_.highlightSet_) {
 125     if (this.highlightSeries_.hasOwnProperty(name)) {
 126       return this.highlightSeries_[name];
 127     }
 128   }
 129
 130   if (!this.series_.hasOwnProperty(seriesName)) {
 131     throw "Unknown series: " + series;
 132   }
 133
 134   var seriesObj = this.series_[seriesName];
 135   var seriesOptions = seriesObj["options"];
 136   if (seriesOptions.hasOwnProperty(name)) {
 137     return seriesOptions[name];
 138   }
 139
 140   return this.findForAxis(name, seriesObj["yAxis"]);
 141 }
 142