Commit | Line | Data |
---|---|---|
c1780ad0 RK |
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) | |
ed30673a | 13 | * user - attributes set by the user |
5daa462d | 14 | * axes - map of options specific to the axis. |
c1780ad0 RK |
15 | * series - { seriesName -> { idx, yAxis, options } |
16 | * labels - used as mapping from index to series name. | |
17 | */ | |
18 | ||
19 | /** | |
c1780ad0 RK |
20 | * This parses attributes into an object that can be easily queried. |
21 | * | |
5daa462d RK |
22 | * It doesn't necessarily mean that all options are available, specifically |
23 | * if labels are not yet available, since those drive details of the per-series | |
24 | * and per-axis options. | |
25 | * | |
c1780ad0 | 26 | * @param {Dyraph} dygraph The chart to which these options belong. |
d67a4279 | 27 | * @constructor |
c1780ad0 RK |
28 | */ |
29 | var DygraphOptions = function(dygraph) { | |
30 | this.dygraph_ = dygraph; | |
ed30673a RK |
31 | this.axes_ = []; |
32 | this.series_ = {}; | |
c1780ad0 | 33 | |
5daa462d | 34 | // Once these two objects are initialized, you can call get(); |
ed30673a RK |
35 | this.global_ = this.dygraph_.attrs_; |
36 | this.user_ = this.dygraph_.user_attrs_ || {}; | |
c1780ad0 | 37 | |
5daa462d | 38 | this.highlightSeries_ = this.get("highlightSeriesOpts") || {}; |
c1780ad0 | 39 | // Get a list of series names. |
34825ef5 | 40 | |
5daa462d | 41 | var labels = this.get("labels"); |
34825ef5 RK |
42 | if (!labels) { |
43 | return; // -- can't do more for now, will parse after getting the labels. | |
5daa462d | 44 | } |
34825ef5 | 45 | |
dd724e22 | 46 | this.reparseSeries(); |
5daa462d | 47 | }; |
34825ef5 | 48 | |
5daa462d RK |
49 | /** |
50 | * Reparses options that are all related to series. This typically occurs when | |
51 | * options are either updated, or source data has been made avaialble. | |
52 | * | |
53 | * TODO(konigsberg): The method name is kind of weak; fix. | |
54 | */ | |
34825ef5 | 55 | DygraphOptions.prototype.reparseSeries = function() { |
5daa462d | 56 | this.labels = this.get("labels").slice(1); |
c1780ad0 | 57 | |
ed30673a RK |
58 | this.axes_ = [ {} ]; // Always one axis at least. |
59 | this.series_ = {}; | |
eb0da59f | 60 | |
c1780ad0 RK |
61 | var axisId = 0; // 0-offset; there's always one. |
62 | // Go through once, add all the series, and for those with {} axis options, add a new axis. | |
63 | for (var idx = 0; idx < this.labels.length; idx++) { | |
64 | var seriesName = this.labels[idx]; | |
65 | ||
ed30673a | 66 | var optionsForSeries = this.user_[seriesName] || {}; |
c1780ad0 RK |
67 | var yAxis = 0; |
68 | ||
69 | var axis = optionsForSeries["axis"]; | |
70 | if (typeof(axis) == 'object') { | |
71 | yAxis = ++axisId; | |
ed30673a | 72 | this.axes_[yAxis] = axis; |
c1780ad0 | 73 | } |
ed30673a | 74 | this.series_[seriesName] = { idx: idx, yAxis: yAxis, options : optionsForSeries }; |
c1780ad0 RK |
75 | } |
76 | ||
77 | // Go through one more time and assign series to an axis defined by another | |
78 | // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } } | |
79 | for (var idx = 0; idx < this.labels.length; idx++) { | |
80 | var seriesName = this.labels[idx]; | |
ed30673a | 81 | var optionsForSeries = this.series_[seriesName]["options"]; |
c1780ad0 RK |
82 | var axis = optionsForSeries["axis"]; |
83 | ||
84 | if (typeof(axis) == 'string') { | |
ed30673a | 85 | if (!this.series_.hasOwnProperty(axis)) { |
c1780ad0 RK |
86 | this.dygraph_.error("Series " + seriesName + " wants to share a y-axis with " + |
87 | "series " + axis + ", which does not define its own axis."); | |
88 | return null; | |
89 | } | |
ed30673a | 90 | this.series_[seriesName].yAxis = this.series_[axis].yAxis; |
c1780ad0 RK |
91 | } |
92 | } | |
93 | ||
94 | // This doesn't support reading from the 'x' axis, only 'y' and 'y2. | |
95 | // Read from the global "axes" option. | |
ed30673a RK |
96 | if (this.user_.hasOwnProperty("axes")) { |
97 | var axis_opts = this.user_.axes; | |
c1780ad0 | 98 | |
eb0da59f | 99 | if (axis_opts.hasOwnProperty("y")) { |
ed30673a | 100 | Dygraph.update(this.axes_[0], axis_opts.y); |
eb0da59f RK |
101 | } |
102 | ||
103 | if (axis_opts.hasOwnProperty("y2")) { | |
ed30673a RK |
104 | this.axes_[1] = this.axes_[1] || {}; |
105 | Dygraph.update(this.axes_[1], axis_opts.y2); | |
eb0da59f | 106 | } |
c1780ad0 RK |
107 | } |
108 | }; | |
109 | ||
5daa462d RK |
110 | /** |
111 | * Get a global value. | |
112 | * | |
113 | * @param {String} name the name of the option. | |
114 | */ | |
115 | DygraphOptions.prototype.get = function(name) { | |
ed30673a RK |
116 | if (this.user_.hasOwnProperty(name)) { |
117 | return this.user_[name]; | |
c1780ad0 | 118 | } |
ed30673a RK |
119 | if (this.global_.hasOwnProperty(name)) { |
120 | return this.global_[name]; | |
c1780ad0 RK |
121 | } |
122 | return null; | |
5daa462d | 123 | }; |
c1780ad0 | 124 | |
5daa462d RK |
125 | /** |
126 | * Get a value for a specific axis. If there is no specific value for the axis, | |
127 | * the global value is returned. | |
128 | * | |
129 | * @param {String} name the name of the option. | |
130 | * @param {String|number} axis the axis to search. Can be the string representation | |
131 | * ("y", "y2") or the axis number (0, 1). | |
132 | */ | |
133 | DygraphOptions.prototype.getForAxis = function(name, axis) { | |
134 | var axisIdx = 0; | |
135 | if (typeof(axis) == 'number') { | |
136 | axisIdx = axis; | |
137 | } else { | |
138 | // TODO(konigsberg): Accept only valid axis strings? | |
139 | axisIdx = (axis == "y2") ? 1 : 0; | |
140 | } | |
c1780ad0 | 141 | |
ed30673a | 142 | var axisOptions = this.axes_[axisIdx]; |
c1780ad0 RK |
143 | if (axisOptions.hasOwnProperty(name)) { |
144 | return axisOptions[name]; | |
145 | } | |
5daa462d RK |
146 | return this.get(name); |
147 | }; | |
c1780ad0 | 148 | |
5daa462d RK |
149 | /** |
150 | * Get a value for a specific series. If there is no specific value for the series, | |
151 | * the value for the axis is returned (and afterwards, the global value.) | |
152 | * | |
153 | * @param {String} name the name of the option. | |
154 | * @param {String|number} series the series to search. Can be the string representation | |
155 | * or 0-offset series number. | |
156 | */ | |
157 | DygraphOptions.prototype.getForSeries = function(name, series) { | |
c1780ad0 RK |
158 | // Honors indexes as series. |
159 | var seriesName = (typeof(series) == "number") ? this.labels[series] : series; | |
160 | ||
ed30673a RK |
161 | if (seriesName === this.dygraph_.highlightSet_) { |
162 | if (this.highlightSeries_.hasOwnProperty(name)) { | |
163 | return this.highlightSeries_[name]; | |
164 | } | |
165 | } | |
166 | ||
167 | if (!this.series_.hasOwnProperty(seriesName)) { | |
c1780ad0 RK |
168 | throw "Unknown series: " + series; |
169 | } | |
170 | ||
ed30673a | 171 | var seriesObj = this.series_[seriesName]; |
c1780ad0 RK |
172 | var seriesOptions = seriesObj["options"]; |
173 | if (seriesOptions.hasOwnProperty(name)) { | |
174 | return seriesOptions[name]; | |
175 | } | |
ed30673a | 176 | |
5daa462d RK |
177 | return this.getForAxis(name, seriesObj["yAxis"]); |
178 | }; | |
c1780ad0 | 179 |