Commit | Line | Data |
---|---|---|
74a5af31 | 1 | // Copyright 2011 Dan Vanderkam (danvdk@gmail.com) |
5108eb20 | 2 | // MIT-licensed (http://opensource.org/licenses/MIT) |
74a5af31 DV |
3 | |
4 | /** | |
5 | * @fileoverview Based on PlotKitLayout, but modified to meet the needs of | |
6 | * dygraphs. | |
7 | */ | |
8 | ||
9 | /** | |
10 | * Creates a new DygraphLayout object. | |
11 | * | |
12 | * This class contains all the data to be charted. | |
13 | * It uses data coordinates, but also records the chart range (in data | |
14 | * coordinates) and hence is able to calculate percentage positions ('In this | |
15 | * view, Point A lies 25% down the x-axis.') | |
16 | * | |
17 | * Two things that it does not do are: | |
18 | * 1. Record pixel coordinates for anything. | |
19 | * 2. (oddly) determine anything about the layout of chart elements. | |
20 | * | |
21 | * The naming is a vestige of Dygraph's original PlotKit roots. | |
22 | * | |
23 | * @constructor | |
24 | */ | |
25 | DygraphLayout = function(dygraph) { | |
26 | this.dygraph_ = dygraph; | |
27 | this.datasets = new Array(); | |
28 | this.annotations = new Array(); | |
29 | this.yAxes_ = null; | |
30 | ||
31 | // TODO(danvk): it's odd that xTicks_ and yTicks_ are inputs, but xticks and | |
32 | // yticks are outputs. Clean this up. | |
33 | this.xTicks_ = null; | |
34 | this.yTicks_ = null; | |
35 | }; | |
36 | ||
37 | DygraphLayout.prototype.attr_ = function(name) { | |
38 | return this.dygraph_.attr_(name); | |
39 | }; | |
40 | ||
41 | DygraphLayout.prototype.addDataset = function(setname, set_xy) { | |
42 | this.datasets[setname] = set_xy; | |
43 | }; | |
44 | ||
45 | DygraphLayout.prototype.setAnnotations = function(ann) { | |
46 | // The Dygraph object's annotations aren't parsed. We parse them here and | |
47 | // save a copy. If there is no parser, then the user must be using raw format. | |
48 | this.annotations = []; | |
49 | var parse = this.attr_('xValueParser') || function(x) { return x; }; | |
50 | for (var i = 0; i < ann.length; i++) { | |
51 | var a = {}; | |
52 | if (!ann[i].xval && !ann[i].x) { | |
53 | this.dygraph_.error("Annotations must have an 'x' property"); | |
54 | return; | |
55 | } | |
56 | if (ann[i].icon && | |
57 | !(ann[i].hasOwnProperty('width') && | |
58 | ann[i].hasOwnProperty('height'))) { | |
59 | this.dygraph_.error("Must set width and height when setting " + | |
60 | "annotation.icon property"); | |
61 | return; | |
62 | } | |
63 | Dygraph.update(a, ann[i]); | |
64 | if (!a.xval) a.xval = parse(a.x); | |
65 | this.annotations.push(a); | |
66 | } | |
67 | }; | |
68 | ||
69 | DygraphLayout.prototype.setXTicks = function(xTicks) { | |
70 | this.xTicks_ = xTicks; | |
71 | }; | |
72 | ||
73 | // TODO(danvk): add this to the Dygraph object's API or move it into Layout. | |
74 | DygraphLayout.prototype.setYAxes = function (yAxes) { | |
75 | this.yAxes_ = yAxes; | |
76 | }; | |
77 | ||
78 | DygraphLayout.prototype.setDateWindow = function(dateWindow) { | |
79 | this.dateWindow_ = dateWindow; | |
80 | }; | |
81 | ||
82 | DygraphLayout.prototype.evaluate = function() { | |
83 | this._evaluateLimits(); | |
84 | this._evaluateLineCharts(); | |
85 | this._evaluateLineTicks(); | |
86 | this._evaluateAnnotations(); | |
87 | }; | |
88 | ||
89 | DygraphLayout.prototype._evaluateLimits = function() { | |
90 | this.minxval = this.maxxval = null; | |
91 | if (this.dateWindow_) { | |
92 | this.minxval = this.dateWindow_[0]; | |
93 | this.maxxval = this.dateWindow_[1]; | |
94 | } else { | |
95 | for (var name in this.datasets) { | |
96 | if (!this.datasets.hasOwnProperty(name)) continue; | |
97 | var series = this.datasets[name]; | |
98 | if (series.length > 1) { | |
99 | var x1 = series[0][0]; | |
100 | if (!this.minxval || x1 < this.minxval) this.minxval = x1; | |
101 | ||
102 | var x2 = series[series.length - 1][0]; | |
103 | if (!this.maxxval || x2 > this.maxxval) this.maxxval = x2; | |
104 | } | |
105 | } | |
106 | } | |
107 | this.xrange = this.maxxval - this.minxval; | |
108 | this.xscale = (this.xrange != 0 ? 1/this.xrange : 1.0); | |
109 | ||
110 | for (var i = 0; i < this.yAxes_.length; i++) { | |
111 | var axis = this.yAxes_[i]; | |
112 | axis.minyval = axis.computedValueRange[0]; | |
113 | axis.maxyval = axis.computedValueRange[1]; | |
114 | axis.yrange = axis.maxyval - axis.minyval; | |
115 | axis.yscale = (axis.yrange != 0 ? 1.0 / axis.yrange : 1.0); | |
116 | ||
117 | if (axis.g.attr_("logscale")) { | |
118 | axis.ylogrange = Dygraph.log10(axis.maxyval) - Dygraph.log10(axis.minyval); | |
119 | axis.ylogscale = (axis.ylogrange != 0 ? 1.0 / axis.ylogrange : 1.0); | |
120 | if (!isFinite(axis.ylogrange) || isNaN(axis.ylogrange)) { | |
121 | axis.g.error('axis ' + i + ' of graph at ' + axis.g + | |
122 | ' can\'t be displayed in log scale for range [' + | |
123 | axis.minyval + ' - ' + axis.maxyval + ']'); | |
124 | } | |
125 | } | |
126 | } | |
127 | }; | |
128 | ||
7f028980 DV |
129 | DygraphLayout._calcYNormal = function(axis, value) { |
130 | if (axis.logscale) { | |
131 | return 1.0 - ((Dygraph.log10(value) - Dygraph.log10(axis.minyval)) * axis.ylogscale); | |
132 | } else { | |
133 | return 1.0 - ((value - axis.minyval) * axis.yscale); | |
134 | } | |
135 | }; | |
136 | ||
74a5af31 DV |
137 | DygraphLayout.prototype._evaluateLineCharts = function() { |
138 | // add all the rects | |
139 | this.points = new Array(); | |
c3e1495b AR |
140 | // An array to keep track of how many points will be drawn for each set. |
141 | // This will allow for the canvas renderer to not have to check every point | |
fc77253b DV |
142 | // for every data set since the points are added in order of the sets in |
143 | // datasets. | |
c3e1495b AR |
144 | this.setPointsLengths = new Array(); |
145 | ||
74a5af31 DV |
146 | for (var setName in this.datasets) { |
147 | if (!this.datasets.hasOwnProperty(setName)) continue; | |
148 | ||
149 | var dataset = this.datasets[setName]; | |
150 | var axis = this.dygraph_.axisPropertiesForSeries(setName); | |
151 | ||
c3e1495b | 152 | var setPointsLength = 0; |
ecf9b464 | 153 | |
74a5af31 DV |
154 | for (var j = 0; j < dataset.length; j++) { |
155 | var item = dataset[j]; | |
4ab8db0c AR |
156 | var xValue = parseFloat(dataset[j][0]); |
157 | var yValue = parseFloat(dataset[j][1]); | |
ecf9b464 | 158 | |
4ab8db0c | 159 | // Range from 0-1 where 0 represents left and 1 represents right. |
7f028980 DV |
160 | var xNormal = (xValue - this.minxval) * this.xscale; |
161 | // Range from 0-1 where 0 represents top and 1 represents bottom | |
162 | var yNormal = DygraphLayout._calcYNormal(axis, yValue); | |
163 | ||
f9414b11 DV |
164 | var point = { |
165 | // TODO(danvk): here | |
166 | x: xNormal, | |
167 | y: yNormal, | |
168 | xval: xValue, | |
169 | yval: yValue, | |
170 | name: setName | |
171 | }; | |
172 | this.points.push(point); | |
173 | setPointsLength += 1; | |
74a5af31 | 174 | } |
c3e1495b | 175 | this.setPointsLengths.push(setPointsLength); |
74a5af31 DV |
176 | } |
177 | }; | |
178 | ||
179 | DygraphLayout.prototype._evaluateLineTicks = function() { | |
180 | this.xticks = new Array(); | |
181 | for (var i = 0; i < this.xTicks_.length; i++) { | |
182 | var tick = this.xTicks_[i]; | |
183 | var label = tick.label; | |
184 | var pos = this.xscale * (tick.v - this.minxval); | |
185 | if ((pos >= 0.0) && (pos <= 1.0)) { | |
186 | this.xticks.push([pos, label]); | |
187 | } | |
188 | } | |
189 | ||
190 | this.yticks = new Array(); | |
191 | for (var i = 0; i < this.yAxes_.length; i++ ) { | |
192 | var axis = this.yAxes_[i]; | |
193 | for (var j = 0; j < axis.ticks.length; j++) { | |
194 | var tick = axis.ticks[j]; | |
195 | var label = tick.label; | |
196 | var pos = this.dygraph_.toPercentYCoord(tick.v, i); | |
197 | if ((pos >= 0.0) && (pos <= 1.0)) { | |
198 | this.yticks.push([i, pos, label]); | |
199 | } | |
200 | } | |
201 | } | |
202 | }; | |
203 | ||
204 | ||
205 | /** | |
206 | * Behaves the same way as PlotKit.Layout, but also copies the errors | |
207 | * @private | |
208 | */ | |
209 | DygraphLayout.prototype.evaluateWithError = function() { | |
210 | this.evaluate(); | |
211 | if (!(this.attr_('errorBars') || this.attr_('customBars'))) return; | |
212 | ||
213 | // Copy over the error terms | |
214 | var i = 0; // index in this.points | |
215 | for (var setName in this.datasets) { | |
216 | if (!this.datasets.hasOwnProperty(setName)) continue; | |
217 | var j = 0; | |
218 | var dataset = this.datasets[setName]; | |
7f028980 | 219 | var axis = this.dygraph_.axisPropertiesForSeries(setName); |
74a5af31 DV |
220 | for (var j = 0; j < dataset.length; j++, i++) { |
221 | var item = dataset[j]; | |
222 | var xv = parseFloat(item[0]); | |
223 | var yv = parseFloat(item[1]); | |
224 | ||
225 | if (xv == this.points[i].xval && | |
226 | yv == this.points[i].yval) { | |
7f028980 DV |
227 | var errorMinus = parseFloat(item[2]); |
228 | var errorPlus = parseFloat(item[3]); | |
229 | ||
230 | var yv_minus = yv - errorMinus; | |
231 | var yv_plus = yv + errorPlus; | |
232 | this.points[i].y_top = DygraphLayout._calcYNormal(axis, yv_minus); | |
233 | this.points[i].y_bottom = DygraphLayout._calcYNormal(axis, yv_plus); | |
74a5af31 DV |
234 | } |
235 | } | |
236 | } | |
237 | }; | |
238 | ||
239 | DygraphLayout.prototype._evaluateAnnotations = function() { | |
240 | // Add the annotations to the point to which they belong. | |
241 | // Make a map from (setName, xval) to annotation for quick lookups. | |
242 | var annotations = {}; | |
243 | for (var i = 0; i < this.annotations.length; i++) { | |
244 | var a = this.annotations[i]; | |
245 | annotations[a.xval + "," + a.series] = a; | |
246 | } | |
247 | ||
248 | this.annotated_points = []; | |
d570a072 AR |
249 | |
250 | // Exit the function early if there are no annotations. | |
251 | if (!this.annotations || !this.annotations.length) { | |
252 | return; | |
253 | } | |
254 | ||
255 | // TODO(antrob): loop through annotations not points. | |
74a5af31 DV |
256 | for (var i = 0; i < this.points.length; i++) { |
257 | var p = this.points[i]; | |
258 | var k = p.xval + "," + p.name; | |
259 | if (k in annotations) { | |
260 | p.annotation = annotations[k]; | |
261 | this.annotated_points.push(p); | |
262 | } | |
263 | } | |
264 | }; | |
265 | ||
266 | /** | |
267 | * Convenience function to remove all the data sets from a graph | |
268 | */ | |
269 | DygraphLayout.prototype.removeAllDatasets = function() { | |
270 | delete this.datasets; | |
271 | this.datasets = new Array(); | |
272 | }; | |
273 | ||
274 | /** | |
275 | * Return a copy of the point at the indicated index, with its yval unstacked. | |
276 | * @param int index of point in layout_.points | |
277 | */ | |
278 | DygraphLayout.prototype.unstackPointAtIndex = function(idx) { | |
279 | var point = this.points[idx]; | |
280 | ||
281 | // Clone the point since we modify it | |
282 | var unstackedPoint = {}; | |
283 | for (var i in point) { | |
284 | unstackedPoint[i] = point[i]; | |
285 | } | |
286 | ||
287 | if (!this.attr_("stackedGraph")) { | |
288 | return unstackedPoint; | |
289 | } | |
290 | ||
291 | // The unstacked yval is equal to the current yval minus the yval of the | |
292 | // next point at the same xval. | |
293 | for (var i = idx+1; i < this.points.length; i++) { | |
294 | if (this.points[i].xval == point.xval) { | |
295 | unstackedPoint.yval -= this.points[i].yval; | |
296 | break; | |
297 | } | |
298 | } | |
299 | ||
300 | return unstackedPoint; | |
301 | } |