Commit | Line | Data |
---|---|---|
6a1aa64f DV |
1 | // Copyright 2006 Dan Vanderkam (danvdk@gmail.com) |
2 | // All Rights Reserved. | |
3 | ||
4 | /** | |
5 | * @fileoverview Creates an interactive, zoomable graph based on a CSV file or | |
285a6bda DV |
6 | * string. Dygraph can handle multiple series with or without error bars. The |
7 | * date/value ranges will be automatically set. Dygraph uses the | |
6a1aa64f DV |
8 | * <canvas> tag, so it only works in FF1.5+. |
9 | * @author danvdk@gmail.com (Dan Vanderkam) | |
10 | ||
11 | Usage: | |
12 | <div id="graphdiv" style="width:800px; height:500px;"></div> | |
13 | <script type="text/javascript"> | |
285a6bda DV |
14 | new Dygraph(document.getElementById("graphdiv"), |
15 | "datafile.csv", // CSV file with headers | |
16 | { }); // options | |
6a1aa64f DV |
17 | </script> |
18 | ||
19 | The CSV file is of the form | |
20 | ||
285a6bda | 21 | Date,SeriesA,SeriesB,SeriesC |
6a1aa64f DV |
22 | YYYYMMDD,A1,B1,C1 |
23 | YYYYMMDD,A2,B2,C2 | |
24 | ||
6a1aa64f DV |
25 | If the 'errorBars' option is set in the constructor, the input should be of |
26 | the form | |
285a6bda | 27 | Date,SeriesA,SeriesB,... |
6a1aa64f DV |
28 | YYYYMMDD,A1,sigmaA1,B1,sigmaB1,... |
29 | YYYYMMDD,A2,sigmaA2,B2,sigmaB2,... | |
30 | ||
31 | If the 'fractions' option is set, the input should be of the form: | |
32 | ||
285a6bda | 33 | Date,SeriesA,SeriesB,... |
6a1aa64f DV |
34 | YYYYMMDD,A1/B1,A2/B2,... |
35 | YYYYMMDD,A1/B1,A2/B2,... | |
36 | ||
37 | And error bars will be calculated automatically using a binomial distribution. | |
38 | ||
727439b4 | 39 | For further documentation and examples, see http://dygraphs.com/ |
6a1aa64f DV |
40 | |
41 | */ | |
42 | ||
43 | /** | |
44 | * An interactive, zoomable graph | |
45 | * @param {String | Function} file A file containing CSV data or a function that | |
46 | * returns this data. The expected format for each line is | |
47 | * YYYYMMDD,val1,val2,... or, if attrs.errorBars is set, | |
48 | * YYYYMMDD,val1,stddev1,val2,stddev2,... | |
6a1aa64f DV |
49 | * @param {Object} attrs Various other attributes, e.g. errorBars determines |
50 | * whether the input data contains error ranges. | |
51 | */ | |
285a6bda DV |
52 | Dygraph = function(div, data, opts) { |
53 | if (arguments.length > 0) { | |
54 | if (arguments.length == 4) { | |
55 | // Old versions of dygraphs took in the series labels as a constructor | |
56 | // parameter. This doesn't make sense anymore, but it's easy to continue | |
57 | // to support this usage. | |
58 | this.warn("Using deprecated four-argument dygraph constructor"); | |
59 | this.__old_init__(div, data, arguments[2], arguments[3]); | |
60 | } else { | |
61 | this.__init__(div, data, opts); | |
62 | } | |
63 | } | |
6a1aa64f DV |
64 | }; |
65 | ||
285a6bda DV |
66 | Dygraph.NAME = "Dygraph"; |
67 | Dygraph.VERSION = "1.2"; | |
68 | Dygraph.__repr__ = function() { | |
6a1aa64f DV |
69 | return "[" + this.NAME + " " + this.VERSION + "]"; |
70 | }; | |
285a6bda | 71 | Dygraph.toString = function() { |
6a1aa64f DV |
72 | return this.__repr__(); |
73 | }; | |
74 | ||
75 | // Various default values | |
285a6bda DV |
76 | Dygraph.DEFAULT_ROLL_PERIOD = 1; |
77 | Dygraph.DEFAULT_WIDTH = 480; | |
78 | Dygraph.DEFAULT_HEIGHT = 320; | |
79 | Dygraph.AXIS_LINE_WIDTH = 0.3; | |
6a1aa64f | 80 | |
d59b6f34 | 81 | Dygraph.LOG_SCALE = 10; |
0037b2a4 | 82 | Dygraph.LN_TEN = Math.log(Dygraph.LOG_SCALE); |
d59b6f34 | 83 | Dygraph.log10 = function(x) { |
0037b2a4 | 84 | return Math.log(x) / Dygraph.LN_TEN; |
d59b6f34 | 85 | } |
062ef401 | 86 | |
8e4a6af3 | 87 | // Default attribute values. |
285a6bda | 88 | Dygraph.DEFAULT_ATTRS = { |
a9fc39ab | 89 | highlightCircleSize: 3, |
8e4a6af3 | 90 | pixelsPerXLabel: 60, |
c6336f04 | 91 | pixelsPerYLabel: 30, |
285a6bda | 92 | |
8e4a6af3 DV |
93 | labelsDivWidth: 250, |
94 | labelsDivStyles: { | |
95 | // TODO(danvk): move defaults from createStatusMessage_ here. | |
285a6bda DV |
96 | }, |
97 | labelsSeparateLines: false, | |
bcd3ebf0 | 98 | labelsShowZeroValues: true, |
285a6bda | 99 | labelsKMB: false, |
afefbcdb | 100 | labelsKMG2: false, |
d160cc3b | 101 | showLabelsOnHighlight: true, |
12e4c741 | 102 | |
2e1fcf1a DV |
103 | yValueFormatter: function(a,b) { return Dygraph.numberFormatter(a,b); }, |
104 | digitsAfterDecimal: 2, | |
105 | maxNumberWidth: 6, | |
19589a3e | 106 | sigFigs: null, |
285a6bda DV |
107 | |
108 | strokeWidth: 1.0, | |
8e4a6af3 | 109 | |
8846615a DV |
110 | axisTickSize: 3, |
111 | axisLabelFontSize: 14, | |
112 | xAxisLabelWidth: 50, | |
113 | yAxisLabelWidth: 50, | |
bf640e56 | 114 | xAxisLabelFormatter: Dygraph.dateAxisFormatter, |
8846615a | 115 | rightGap: 5, |
285a6bda DV |
116 | |
117 | showRoller: false, | |
118 | xValueFormatter: Dygraph.dateString_, | |
119 | xValueParser: Dygraph.dateParser, | |
120 | xTicker: Dygraph.dateTicker, | |
121 | ||
3d67f03b DV |
122 | delimiter: ',', |
123 | ||
285a6bda DV |
124 | sigma: 2.0, |
125 | errorBars: false, | |
126 | fractions: false, | |
127 | wilsonInterval: true, // only relevant if fractions is true | |
5954ef32 | 128 | customBars: false, |
43af96e7 NK |
129 | fillGraph: false, |
130 | fillAlpha: 0.15, | |
f032c51d | 131 | connectSeparatedPoints: false, |
43af96e7 NK |
132 | |
133 | stackedGraph: false, | |
afdc483f NN |
134 | hideOverlayOnMouseOut: true, |
135 | ||
2fccd3dc DV |
136 | // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms. |
137 | legend: 'onmouseover', // the only relevant value at the moment is 'always'. | |
138 | ||
00c281d4 | 139 | stepPlot: false, |
062ef401 JB |
140 | avoidMinZero: false, |
141 | ||
ad1798c2 | 142 | // Sizes of the various chart labels. |
b4202b3d | 143 | titleHeight: 28, |
86cce9e8 DV |
144 | xLabelHeight: 18, |
145 | yLabelWidth: 18, | |
ad1798c2 | 146 | |
062ef401 | 147 | interactionModel: null // will be set to Dygraph.defaultInteractionModel. |
285a6bda DV |
148 | }; |
149 | ||
150 | // Various logging levels. | |
151 | Dygraph.DEBUG = 1; | |
152 | Dygraph.INFO = 2; | |
153 | Dygraph.WARNING = 3; | |
154 | Dygraph.ERROR = 3; | |
155 | ||
39b0e098 RK |
156 | // Directions for panning and zooming. Use bit operations when combined |
157 | // values are possible. | |
158 | Dygraph.HORIZONTAL = 1; | |
159 | Dygraph.VERTICAL = 2; | |
160 | ||
5c528fa2 DV |
161 | // Used for initializing annotation CSS rules only once. |
162 | Dygraph.addedAnnotationCSS = false; | |
163 | ||
2cf95fff RK |
164 | /** |
165 | * Return the 2d context for a dygraph canvas. | |
166 | * | |
167 | * This method is only exposed for the sake of replacing the function in | |
168 | * automated tests, e.g. | |
169 | * | |
170 | * var oldFunc = Dygraph.getContext(); | |
171 | * Dygraph.getContext = function(canvas) { | |
172 | * var realContext = oldFunc(canvas); | |
173 | * return new Proxy(realContext); | |
174 | * }; | |
175 | */ | |
176 | Dygraph.getContext = function(canvas) { | |
177 | return canvas.getContext("2d"); | |
178 | }; | |
179 | ||
285a6bda DV |
180 | Dygraph.prototype.__old_init__ = function(div, file, labels, attrs) { |
181 | // Labels is no longer a constructor parameter, since it's typically set | |
182 | // directly from the data source. It also conains a name for the x-axis, | |
183 | // which the previous constructor form did not. | |
184 | if (labels != null) { | |
185 | var new_labels = ["Date"]; | |
186 | for (var i = 0; i < labels.length; i++) new_labels.push(labels[i]); | |
fc80a396 | 187 | Dygraph.update(attrs, { 'labels': new_labels }); |
285a6bda DV |
188 | } |
189 | this.__init__(div, file, attrs); | |
8e4a6af3 DV |
190 | }; |
191 | ||
6a1aa64f | 192 | /** |
285a6bda | 193 | * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit |
7aedf6fe | 194 | * and context <canvas> inside of it. See the constructor for details. |
6a1aa64f | 195 | * on the parameters. |
12e4c741 | 196 | * @param {Element} div the Element to render the graph into. |
6a1aa64f | 197 | * @param {String | Function} file Source data |
6a1aa64f DV |
198 | * @param {Object} attrs Miscellaneous other options |
199 | * @private | |
200 | */ | |
285a6bda | 201 | Dygraph.prototype.__init__ = function(div, file, attrs) { |
a2c8fff4 DV |
202 | // Hack for IE: if we're using excanvas and the document hasn't finished |
203 | // loading yet (and hence may not have initialized whatever it needs to | |
204 | // initialize), then keep calling this routine periodically until it has. | |
205 | if (/MSIE/.test(navigator.userAgent) && !window.opera && | |
206 | typeof(G_vmlCanvasManager) != 'undefined' && | |
207 | document.readyState != 'complete') { | |
208 | var self = this; | |
209 | setTimeout(function() { self.__init__(div, file, attrs) }, 100); | |
210 | } | |
211 | ||
285a6bda DV |
212 | // Support two-argument constructor |
213 | if (attrs == null) { attrs = {}; } | |
214 | ||
6a1aa64f | 215 | // Copy the important bits into the object |
32988383 | 216 | // TODO(danvk): most of these should just stay in the attrs_ dictionary. |
6a1aa64f | 217 | this.maindiv_ = div; |
6a1aa64f | 218 | this.file_ = file; |
285a6bda | 219 | this.rollPeriod_ = attrs.rollPeriod || Dygraph.DEFAULT_ROLL_PERIOD; |
6a1aa64f | 220 | this.previousVerticalX_ = -1; |
6a1aa64f | 221 | this.fractions_ = attrs.fractions || false; |
6a1aa64f | 222 | this.dateWindow_ = attrs.dateWindow || null; |
8b83c6cc | 223 | |
6a1aa64f | 224 | this.wilsonInterval_ = attrs.wilsonInterval || true; |
fe0b7c03 | 225 | this.is_initial_draw_ = true; |
5c528fa2 | 226 | this.annotations_ = []; |
7aedf6fe | 227 | |
45f2c689 | 228 | // Zoomed indicators - These indicate when the graph has been zoomed and on what axis. |
57baab03 NN |
229 | this.zoomed_x_ = false; |
230 | this.zoomed_y_ = false; | |
45f2c689 | 231 | |
f7d6278e DV |
232 | // Clear the div. This ensure that, if multiple dygraphs are passed the same |
233 | // div, then only one will be drawn. | |
234 | div.innerHTML = ""; | |
235 | ||
c21d2c2d | 236 | // If the div isn't already sized then inherit from our attrs or |
237 | // give it a default size. | |
285a6bda | 238 | if (div.style.width == '') { |
ddd1b11f | 239 | div.style.width = (attrs.width || Dygraph.DEFAULT_WIDTH) + "px"; |
285a6bda DV |
240 | } |
241 | if (div.style.height == '') { | |
ddd1b11f | 242 | div.style.height = (attrs.height || Dygraph.DEFAULT_HEIGHT) + "px"; |
32988383 | 243 | } |
285a6bda DV |
244 | this.width_ = parseInt(div.style.width, 10); |
245 | this.height_ = parseInt(div.style.height, 10); | |
c21d2c2d | 246 | // The div might have been specified as percent of the current window size, |
247 | // convert that to an appropriate number of pixels. | |
248 | if (div.style.width.indexOf("%") == div.style.width.length - 1) { | |
c6f45033 | 249 | this.width_ = div.offsetWidth; |
c21d2c2d | 250 | } |
251 | if (div.style.height.indexOf("%") == div.style.height.length - 1) { | |
c6f45033 | 252 | this.height_ = div.offsetHeight; |
c21d2c2d | 253 | } |
32988383 | 254 | |
10a6456d DV |
255 | if (this.width_ == 0) { |
256 | this.error("dygraph has zero width. Please specify a width in pixels."); | |
257 | } | |
258 | if (this.height_ == 0) { | |
259 | this.error("dygraph has zero height. Please specify a height in pixels."); | |
260 | } | |
261 | ||
344ba8c0 | 262 | // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_. |
43af96e7 NK |
263 | if (attrs['stackedGraph']) { |
264 | attrs['fillGraph'] = true; | |
265 | // TODO(nikhilk): Add any other stackedGraph checks here. | |
266 | } | |
267 | ||
285a6bda DV |
268 | // Dygraphs has many options, some of which interact with one another. |
269 | // To keep track of everything, we maintain two sets of options: | |
270 | // | |
c21d2c2d | 271 | // this.user_attrs_ only options explicitly set by the user. |
285a6bda DV |
272 | // this.attrs_ defaults, options derived from user_attrs_, data. |
273 | // | |
274 | // Options are then accessed this.attr_('attr'), which first looks at | |
275 | // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent | |
276 | // defaults without overriding behavior that the user specifically asks for. | |
277 | this.user_attrs_ = {}; | |
fc80a396 | 278 | Dygraph.update(this.user_attrs_, attrs); |
6a1aa64f | 279 | |
285a6bda | 280 | this.attrs_ = {}; |
fc80a396 | 281 | Dygraph.update(this.attrs_, Dygraph.DEFAULT_ATTRS); |
6a1aa64f | 282 | |
16269f6e | 283 | this.boundaryIds_ = []; |
6a1aa64f | 284 | |
285a6bda DV |
285 | // Make a note of whether labels will be pulled from the CSV file. |
286 | this.labelsFromCSV_ = (this.attr_("labels") == null); | |
6a1aa64f DV |
287 | |
288 | // Create the containing DIV and other interactive elements | |
289 | this.createInterface_(); | |
290 | ||
738fc797 | 291 | this.start_(); |
6a1aa64f DV |
292 | }; |
293 | ||
dcb25130 NN |
294 | /** |
295 | * Returns the zoomed status of the chart for one or both axes. | |
296 | * | |
297 | * Axis is an optional parameter. Can be set to 'x' or 'y'. | |
298 | * | |
299 | * The zoomed status for an axis is set whenever a user zooms using the mouse | |
e5152598 | 300 | * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom |
dcb25130 NN |
301 | * option is also specified). |
302 | */ | |
57baab03 NN |
303 | Dygraph.prototype.isZoomed = function(axis) { |
304 | if (axis == null) return this.zoomed_x_ || this.zoomed_y_; | |
305 | if (axis == 'x') return this.zoomed_x_; | |
306 | if (axis == 'y') return this.zoomed_y_; | |
307 | throw "axis parameter to Dygraph.isZoomed must be missing, 'x' or 'y'."; | |
308 | }; | |
309 | ||
22bd1dfb RK |
310 | Dygraph.prototype.toString = function() { |
311 | var maindiv = this.maindiv_; | |
312 | var id = (maindiv && maindiv.id) ? maindiv.id : maindiv | |
313 | return "[Dygraph " + id + "]"; | |
314 | } | |
315 | ||
227b93cc | 316 | Dygraph.prototype.attr_ = function(name, seriesName) { |
028ddf8a DV |
317 | // <REMOVE_FOR_COMBINED> |
318 | if (typeof(Dygraph.OPTIONS_REFERENCE) === 'undefined') { | |
319 | this.error('Must include options reference JS for testing'); | |
320 | } else if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(name)) { | |
321 | this.error('Dygraphs is using property ' + name + ', which has no entry ' + | |
322 | 'in the Dygraphs.OPTIONS_REFERENCE listing.'); | |
323 | // Only log this error once. | |
324 | Dygraph.OPTIONS_REFERENCE[name] = true; | |
325 | } | |
326 | // </REMOVE_FOR_COMBINED> | |
227b93cc DV |
327 | if (seriesName && |
328 | typeof(this.user_attrs_[seriesName]) != 'undefined' && | |
329 | this.user_attrs_[seriesName] != null && | |
330 | typeof(this.user_attrs_[seriesName][name]) != 'undefined') { | |
331 | return this.user_attrs_[seriesName][name]; | |
450fe64b | 332 | } else if (typeof(this.user_attrs_[name]) != 'undefined') { |
285a6bda DV |
333 | return this.user_attrs_[name]; |
334 | } else if (typeof(this.attrs_[name]) != 'undefined') { | |
335 | return this.attrs_[name]; | |
336 | } else { | |
337 | return null; | |
338 | } | |
339 | }; | |
340 | ||
341 | // TODO(danvk): any way I can get the line numbers to be this.warn call? | |
342 | Dygraph.prototype.log = function(severity, message) { | |
343 | if (typeof(console) != 'undefined') { | |
344 | switch (severity) { | |
345 | case Dygraph.DEBUG: | |
346 | console.debug('dygraphs: ' + message); | |
347 | break; | |
348 | case Dygraph.INFO: | |
349 | console.info('dygraphs: ' + message); | |
350 | break; | |
351 | case Dygraph.WARNING: | |
352 | console.warn('dygraphs: ' + message); | |
353 | break; | |
354 | case Dygraph.ERROR: | |
355 | console.error('dygraphs: ' + message); | |
356 | break; | |
357 | } | |
358 | } | |
359 | } | |
360 | Dygraph.prototype.info = function(message) { | |
361 | this.log(Dygraph.INFO, message); | |
362 | } | |
363 | Dygraph.prototype.warn = function(message) { | |
364 | this.log(Dygraph.WARNING, message); | |
365 | } | |
366 | Dygraph.prototype.error = function(message) { | |
367 | this.log(Dygraph.ERROR, message); | |
368 | } | |
369 | ||
6a1aa64f DV |
370 | /** |
371 | * Returns the current rolling period, as set by the user or an option. | |
6faebb69 | 372 | * @return {Number} The number of points in the rolling window |
6a1aa64f | 373 | */ |
285a6bda | 374 | Dygraph.prototype.rollPeriod = function() { |
6a1aa64f | 375 | return this.rollPeriod_; |
76171648 DV |
376 | }; |
377 | ||
599fb4ad DV |
378 | /** |
379 | * Returns the currently-visible x-range. This can be affected by zooming, | |
380 | * panning or a call to updateOptions. | |
381 | * Returns a two-element array: [left, right]. | |
382 | * If the Dygraph has dates on the x-axis, these will be millis since epoch. | |
383 | */ | |
384 | Dygraph.prototype.xAxisRange = function() { | |
4cac8c7a RK |
385 | return this.dateWindow_ ? this.dateWindow_ : this.xAxisExtremes(); |
386 | }; | |
599fb4ad | 387 | |
4cac8c7a RK |
388 | /** |
389 | * Returns the lower- and upper-bound x-axis values of the | |
390 | * data set. | |
391 | */ | |
392 | Dygraph.prototype.xAxisExtremes = function() { | |
599fb4ad DV |
393 | var left = this.rawData_[0][0]; |
394 | var right = this.rawData_[this.rawData_.length - 1][0]; | |
395 | return [left, right]; | |
396 | }; | |
397 | ||
3230c662 | 398 | /** |
d58ae307 DV |
399 | * Returns the currently-visible y-range for an axis. This can be affected by |
400 | * zooming, panning or a call to updateOptions. Axis indices are zero-based. If | |
401 | * called with no arguments, returns the range of the first axis. | |
3230c662 DV |
402 | * Returns a two-element array: [bottom, top]. |
403 | */ | |
d58ae307 | 404 | Dygraph.prototype.yAxisRange = function(idx) { |
d63e6799 | 405 | if (typeof(idx) == "undefined") idx = 0; |
d58ae307 DV |
406 | if (idx < 0 || idx >= this.axes_.length) return null; |
407 | return [ this.axes_[idx].computedValueRange[0], | |
408 | this.axes_[idx].computedValueRange[1] ]; | |
409 | }; | |
410 | ||
411 | /** | |
412 | * Returns the currently-visible y-ranges for each axis. This can be affected by | |
413 | * zooming, panning, calls to updateOptions, etc. | |
414 | * Returns an array of [bottom, top] pairs, one for each y-axis. | |
415 | */ | |
416 | Dygraph.prototype.yAxisRanges = function() { | |
417 | var ret = []; | |
418 | for (var i = 0; i < this.axes_.length; i++) { | |
419 | ret.push(this.yAxisRange(i)); | |
420 | } | |
421 | return ret; | |
3230c662 DV |
422 | }; |
423 | ||
d58ae307 | 424 | // TODO(danvk): use these functions throughout dygraphs. |
3230c662 DV |
425 | /** |
426 | * Convert from data coordinates to canvas/div X/Y coordinates. | |
d58ae307 DV |
427 | * If specified, do this conversion for the coordinate system of a particular |
428 | * axis. Uses the first axis by default. | |
3230c662 | 429 | * Returns a two-element array: [X, Y] |
ff022deb | 430 | * |
0747928a | 431 | * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord |
ff022deb | 432 | * instead of toDomCoords(null, y, axis). |
3230c662 | 433 | */ |
d58ae307 | 434 | Dygraph.prototype.toDomCoords = function(x, y, axis) { |
ff022deb RK |
435 | return [ this.toDomXCoord(x), this.toDomYCoord(y, axis) ]; |
436 | }; | |
437 | ||
438 | /** | |
439 | * Convert from data x coordinates to canvas/div X coordinate. | |
440 | * If specified, do this conversion for the coordinate system of a particular | |
0037b2a4 RK |
441 | * axis. |
442 | * Returns a single value or null if x is null. | |
ff022deb RK |
443 | */ |
444 | Dygraph.prototype.toDomXCoord = function(x) { | |
445 | if (x == null) { | |
446 | return null; | |
447 | }; | |
448 | ||
3230c662 | 449 | var area = this.plotter_.area; |
ff022deb RK |
450 | var xRange = this.xAxisRange(); |
451 | return area.x + (x - xRange[0]) / (xRange[1] - xRange[0]) * area.w; | |
452 | } | |
3230c662 | 453 | |
ff022deb RK |
454 | /** |
455 | * Convert from data x coordinates to canvas/div Y coordinate and optional | |
456 | * axis. Uses the first axis by default. | |
457 | * | |
458 | * returns a single value or null if y is null. | |
459 | */ | |
460 | Dygraph.prototype.toDomYCoord = function(y, axis) { | |
0747928a | 461 | var pct = this.toPercentYCoord(y, axis); |
3230c662 | 462 | |
ff022deb RK |
463 | if (pct == null) { |
464 | return null; | |
465 | } | |
e4416fb9 | 466 | var area = this.plotter_.area; |
ff022deb RK |
467 | return area.y + pct * area.h; |
468 | } | |
3230c662 DV |
469 | |
470 | /** | |
471 | * Convert from canvas/div coords to data coordinates. | |
d58ae307 DV |
472 | * If specified, do this conversion for the coordinate system of a particular |
473 | * axis. Uses the first axis by default. | |
ff022deb RK |
474 | * Returns a two-element array: [X, Y]. |
475 | * | |
0747928a | 476 | * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord |
ff022deb | 477 | * instead of toDataCoords(null, y, axis). |
3230c662 | 478 | */ |
d58ae307 | 479 | Dygraph.prototype.toDataCoords = function(x, y, axis) { |
ff022deb RK |
480 | return [ this.toDataXCoord(x), this.toDataYCoord(y, axis) ]; |
481 | }; | |
482 | ||
483 | /** | |
484 | * Convert from canvas/div x coordinate to data coordinate. | |
485 | * | |
486 | * If x is null, this returns null. | |
487 | */ | |
488 | Dygraph.prototype.toDataXCoord = function(x) { | |
489 | if (x == null) { | |
490 | return null; | |
3230c662 DV |
491 | } |
492 | ||
ff022deb RK |
493 | var area = this.plotter_.area; |
494 | var xRange = this.xAxisRange(); | |
495 | return xRange[0] + (x - area.x) / area.w * (xRange[1] - xRange[0]); | |
496 | }; | |
497 | ||
498 | /** | |
499 | * Convert from canvas/div y coord to value. | |
500 | * | |
501 | * If y is null, this returns null. | |
502 | * if axis is null, this uses the first axis. | |
503 | */ | |
504 | Dygraph.prototype.toDataYCoord = function(y, axis) { | |
505 | if (y == null) { | |
506 | return null; | |
3230c662 DV |
507 | } |
508 | ||
ff022deb RK |
509 | var area = this.plotter_.area; |
510 | var yRange = this.yAxisRange(axis); | |
511 | ||
b70247dc RK |
512 | if (typeof(axis) == "undefined") axis = 0; |
513 | if (!this.axes_[axis].logscale) { | |
ff022deb RK |
514 | return yRange[0] + (area.h - y) / area.h * (yRange[1] - yRange[0]); |
515 | } else { | |
516 | // Computing the inverse of toDomCoord. | |
517 | var pct = (y - area.y) / area.h | |
518 | ||
519 | // Computing the inverse of toPercentYCoord. The function was arrived at with | |
520 | // the following steps: | |
521 | // | |
522 | // Original calcuation: | |
d59b6f34 | 523 | // pct = (logr1 - Dygraph.log10(y)) / (logr1 - Dygraph.log10(yRange[0])); |
ff022deb RK |
524 | // |
525 | // Move denominator to both sides: | |
d59b6f34 | 526 | // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y); |
ff022deb RK |
527 | // |
528 | // subtract logr1, and take the negative value. | |
d59b6f34 | 529 | // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y); |
ff022deb RK |
530 | // |
531 | // Swap both sides of the equation, and we can compute the log of the | |
532 | // return value. Which means we just need to use that as the exponent in | |
533 | // e^exponent. | |
d59b6f34 | 534 | // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))); |
ff022deb | 535 | |
d59b6f34 RK |
536 | var logr1 = Dygraph.log10(yRange[1]); |
537 | var exponent = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))); | |
538 | var value = Math.pow(Dygraph.LOG_SCALE, exponent); | |
ff022deb RK |
539 | return value; |
540 | } | |
3230c662 DV |
541 | }; |
542 | ||
e99fde05 | 543 | /** |
ff022deb | 544 | * Converts a y for an axis to a percentage from the top to the |
4cac8c7a | 545 | * bottom of the drawing area. |
ff022deb RK |
546 | * |
547 | * If the coordinate represents a value visible on the canvas, then | |
548 | * the value will be between 0 and 1, where 0 is the top of the canvas. | |
549 | * However, this method will return values outside the range, as | |
550 | * values can fall outside the canvas. | |
551 | * | |
552 | * If y is null, this returns null. | |
553 | * if axis is null, this uses the first axis. | |
554 | */ | |
555 | Dygraph.prototype.toPercentYCoord = function(y, axis) { | |
556 | if (y == null) { | |
557 | return null; | |
558 | } | |
7d0e7a0d | 559 | if (typeof(axis) == "undefined") axis = 0; |
ff022deb RK |
560 | |
561 | var area = this.plotter_.area; | |
562 | var yRange = this.yAxisRange(axis); | |
563 | ||
564 | var pct; | |
7d0e7a0d | 565 | if (!this.axes_[axis].logscale) { |
4cac8c7a RK |
566 | // yRange[1] - y is unit distance from the bottom. |
567 | // yRange[1] - yRange[0] is the scale of the range. | |
ff022deb RK |
568 | // (yRange[1] - y) / (yRange[1] - yRange[0]) is the % from the bottom. |
569 | pct = (yRange[1] - y) / (yRange[1] - yRange[0]); | |
570 | } else { | |
d59b6f34 RK |
571 | var logr1 = Dygraph.log10(yRange[1]); |
572 | pct = (logr1 - Dygraph.log10(y)) / (logr1 - Dygraph.log10(yRange[0])); | |
ff022deb RK |
573 | } |
574 | return pct; | |
575 | } | |
576 | ||
577 | /** | |
4cac8c7a RK |
578 | * Converts an x value to a percentage from the left to the right of |
579 | * the drawing area. | |
580 | * | |
581 | * If the coordinate represents a value visible on the canvas, then | |
582 | * the value will be between 0 and 1, where 0 is the left of the canvas. | |
583 | * However, this method will return values outside the range, as | |
584 | * values can fall outside the canvas. | |
585 | * | |
586 | * If x is null, this returns null. | |
587 | */ | |
588 | Dygraph.prototype.toPercentXCoord = function(x) { | |
589 | if (x == null) { | |
590 | return null; | |
591 | } | |
592 | ||
4cac8c7a | 593 | var xRange = this.xAxisRange(); |
965a030e | 594 | return (x - xRange[0]) / (xRange[1] - xRange[0]); |
4cac8c7a RK |
595 | } |
596 | ||
597 | /** | |
e99fde05 DV |
598 | * Returns the number of columns (including the independent variable). |
599 | */ | |
600 | Dygraph.prototype.numColumns = function() { | |
601 | return this.rawData_[0].length; | |
602 | }; | |
603 | ||
604 | /** | |
605 | * Returns the number of rows (excluding any header/label row). | |
606 | */ | |
607 | Dygraph.prototype.numRows = function() { | |
608 | return this.rawData_.length; | |
609 | }; | |
610 | ||
611 | /** | |
612 | * Returns the value in the given row and column. If the row and column exceed | |
613 | * the bounds on the data, returns null. Also returns null if the value is | |
614 | * missing. | |
615 | */ | |
616 | Dygraph.prototype.getValue = function(row, col) { | |
617 | if (row < 0 || row > this.rawData_.length) return null; | |
618 | if (col < 0 || col > this.rawData_[row].length) return null; | |
619 | ||
620 | return this.rawData_[row][col]; | |
621 | }; | |
622 | ||
76171648 DV |
623 | Dygraph.addEvent = function(el, evt, fn) { |
624 | var normed_fn = function(e) { | |
625 | if (!e) var e = window.event; | |
626 | fn(e); | |
627 | }; | |
628 | if (window.addEventListener) { // Mozilla, Netscape, Firefox | |
629 | el.addEventListener(evt, normed_fn, false); | |
630 | } else { // IE | |
631 | el.attachEvent('on' + evt, normed_fn); | |
632 | } | |
633 | }; | |
6a1aa64f | 634 | |
062ef401 JB |
635 | |
636 | // Based on the article at | |
637 | // http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel | |
638 | Dygraph.cancelEvent = function(e) { | |
639 | e = e ? e : window.event; | |
640 | if (e.stopPropagation) { | |
641 | e.stopPropagation(); | |
642 | } | |
643 | if (e.preventDefault) { | |
644 | e.preventDefault(); | |
645 | } | |
646 | e.cancelBubble = true; | |
647 | e.cancel = true; | |
648 | e.returnValue = false; | |
649 | return false; | |
650 | } | |
651 | ||
652 | ||
6a1aa64f | 653 | /** |
285a6bda | 654 | * Generates interface elements for the Dygraph: a containing div, a div to |
6a1aa64f | 655 | * display the current point, and a textbox to adjust the rolling average |
697e70b2 | 656 | * period. Also creates the Renderer/Layout elements. |
6a1aa64f DV |
657 | * @private |
658 | */ | |
285a6bda | 659 | Dygraph.prototype.createInterface_ = function() { |
6a1aa64f DV |
660 | // Create the all-enclosing graph div |
661 | var enclosing = this.maindiv_; | |
662 | ||
b0c3b730 DV |
663 | this.graphDiv = document.createElement("div"); |
664 | this.graphDiv.style.width = this.width_ + "px"; | |
665 | this.graphDiv.style.height = this.height_ + "px"; | |
666 | enclosing.appendChild(this.graphDiv); | |
667 | ||
668 | // Create the canvas for interactive parts of the chart. | |
f8cfec73 | 669 | this.canvas_ = Dygraph.createCanvas(); |
b0c3b730 DV |
670 | this.canvas_.style.position = "absolute"; |
671 | this.canvas_.width = this.width_; | |
672 | this.canvas_.height = this.height_; | |
f8cfec73 DV |
673 | this.canvas_.style.width = this.width_ + "px"; // for IE |
674 | this.canvas_.style.height = this.height_ + "px"; // for IE | |
b0c3b730 | 675 | |
2cf95fff RK |
676 | this.canvas_ctx_ = Dygraph.getContext(this.canvas_); |
677 | ||
b0c3b730 | 678 | // ... and for static parts of the chart. |
6a1aa64f | 679 | this.hidden_ = this.createPlotKitCanvas_(this.canvas_); |
2cf95fff | 680 | this.hidden_ctx_ = Dygraph.getContext(this.hidden_); |
76171648 | 681 | |
eb7bf005 EC |
682 | // The interactive parts of the graph are drawn on top of the chart. |
683 | this.graphDiv.appendChild(this.hidden_); | |
684 | this.graphDiv.appendChild(this.canvas_); | |
685 | this.mouseEventElement_ = this.canvas_; | |
686 | ||
76171648 | 687 | var dygraph = this; |
eb7bf005 | 688 | Dygraph.addEvent(this.mouseEventElement_, 'mousemove', function(e) { |
76171648 DV |
689 | dygraph.mouseMove_(e); |
690 | }); | |
eb7bf005 | 691 | Dygraph.addEvent(this.mouseEventElement_, 'mouseout', function(e) { |
76171648 DV |
692 | dygraph.mouseOut_(e); |
693 | }); | |
697e70b2 DV |
694 | |
695 | // Create the grapher | |
696 | // TODO(danvk): why does the Layout need its own set of options? | |
697 | this.layoutOptions_ = { 'xOriginIsZero': false }; | |
698 | Dygraph.update(this.layoutOptions_, this.attrs_); | |
699 | Dygraph.update(this.layoutOptions_, this.user_attrs_); | |
700 | Dygraph.update(this.layoutOptions_, { | |
701 | 'errorBars': (this.attr_("errorBars") || this.attr_("customBars")) }); | |
702 | ||
703 | this.layout_ = new DygraphLayout(this, this.layoutOptions_); | |
704 | ||
705 | // TODO(danvk): why does the Renderer need its own set of options? | |
706 | this.renderOptions_ = { colorScheme: this.colors_, | |
707 | strokeColor: null, | |
708 | axisLineWidth: Dygraph.AXIS_LINE_WIDTH }; | |
709 | Dygraph.update(this.renderOptions_, this.attrs_); | |
710 | Dygraph.update(this.renderOptions_, this.user_attrs_); | |
697e70b2 DV |
711 | |
712 | this.createStatusMessage_(); | |
697e70b2 | 713 | this.createDragInterface_(); |
4cfcc38c DV |
714 | }; |
715 | ||
716 | /** | |
717 | * Detach DOM elements in the dygraph and null out all data references. | |
718 | * Calling this when you're done with a dygraph can dramatically reduce memory | |
719 | * usage. See, e.g., the tests/perf.html example. | |
720 | */ | |
721 | Dygraph.prototype.destroy = function() { | |
722 | var removeRecursive = function(node) { | |
723 | while (node.hasChildNodes()) { | |
724 | removeRecursive(node.firstChild); | |
725 | node.removeChild(node.firstChild); | |
726 | } | |
727 | }; | |
728 | removeRecursive(this.maindiv_); | |
729 | ||
730 | var nullOut = function(obj) { | |
731 | for (var n in obj) { | |
732 | if (typeof(obj[n]) === 'object') { | |
733 | obj[n] = null; | |
734 | } | |
735 | } | |
736 | }; | |
737 | ||
738 | // These may not all be necessary, but it can't hurt... | |
739 | nullOut(this.layout_); | |
740 | nullOut(this.plotter_); | |
741 | nullOut(this); | |
742 | }; | |
6a1aa64f DV |
743 | |
744 | /** | |
745 | * Creates the canvas containing the PlotKit graph. Only plotkit ever draws on | |
285a6bda | 746 | * this particular canvas. All Dygraph work is done on this.canvas_. |
8846615a | 747 | * @param {Object} canvas The Dygraph canvas over which to overlay the plot |
6a1aa64f DV |
748 | * @return {Object} The newly-created canvas |
749 | * @private | |
750 | */ | |
285a6bda | 751 | Dygraph.prototype.createPlotKitCanvas_ = function(canvas) { |
f8cfec73 | 752 | var h = Dygraph.createCanvas(); |
6a1aa64f | 753 | h.style.position = "absolute"; |
9ac5e4ae DV |
754 | // TODO(danvk): h should be offset from canvas. canvas needs to include |
755 | // some extra area to make it easier to zoom in on the far left and far | |
756 | // right. h needs to be precisely the plot area, so that clipping occurs. | |
6a1aa64f DV |
757 | h.style.top = canvas.style.top; |
758 | h.style.left = canvas.style.left; | |
759 | h.width = this.width_; | |
760 | h.height = this.height_; | |
f8cfec73 DV |
761 | h.style.width = this.width_ + "px"; // for IE |
762 | h.style.height = this.height_ + "px"; // for IE | |
6a1aa64f DV |
763 | return h; |
764 | }; | |
765 | ||
f474c2a3 DV |
766 | // Taken from MochiKit.Color |
767 | Dygraph.hsvToRGB = function (hue, saturation, value) { | |
768 | var red; | |
769 | var green; | |
770 | var blue; | |
771 | if (saturation === 0) { | |
772 | red = value; | |
773 | green = value; | |
774 | blue = value; | |
775 | } else { | |
776 | var i = Math.floor(hue * 6); | |
777 | var f = (hue * 6) - i; | |
778 | var p = value * (1 - saturation); | |
779 | var q = value * (1 - (saturation * f)); | |
780 | var t = value * (1 - (saturation * (1 - f))); | |
781 | switch (i) { | |
782 | case 1: red = q; green = value; blue = p; break; | |
783 | case 2: red = p; green = value; blue = t; break; | |
784 | case 3: red = p; green = q; blue = value; break; | |
785 | case 4: red = t; green = p; blue = value; break; | |
786 | case 5: red = value; green = p; blue = q; break; | |
787 | case 6: // fall through | |
788 | case 0: red = value; green = t; blue = p; break; | |
789 | } | |
790 | } | |
791 | red = Math.floor(255 * red + 0.5); | |
792 | green = Math.floor(255 * green + 0.5); | |
793 | blue = Math.floor(255 * blue + 0.5); | |
794 | return 'rgb(' + red + ',' + green + ',' + blue + ')'; | |
795 | }; | |
796 | ||
797 | ||
6a1aa64f DV |
798 | /** |
799 | * Generate a set of distinct colors for the data series. This is done with a | |
800 | * color wheel. Saturation/Value are customizable, and the hue is | |
801 | * equally-spaced around the color wheel. If a custom set of colors is | |
802 | * specified, that is used instead. | |
6a1aa64f DV |
803 | * @private |
804 | */ | |
285a6bda DV |
805 | Dygraph.prototype.setColors_ = function() { |
806 | // TODO(danvk): compute this directly into this.attrs_['colorScheme'] and do | |
807 | // away with this.renderOptions_. | |
808 | var num = this.attr_("labels").length - 1; | |
6a1aa64f | 809 | this.colors_ = []; |
285a6bda DV |
810 | var colors = this.attr_('colors'); |
811 | if (!colors) { | |
812 | var sat = this.attr_('colorSaturation') || 1.0; | |
813 | var val = this.attr_('colorValue') || 0.5; | |
2aa21213 | 814 | var half = Math.ceil(num / 2); |
6a1aa64f | 815 | for (var i = 1; i <= num; i++) { |
ec1959eb | 816 | if (!this.visibility()[i-1]) continue; |
43af96e7 | 817 | // alternate colors for high contrast. |
2aa21213 | 818 | var idx = i % 2 ? Math.ceil(i / 2) : (half + i / 2); |
43af96e7 NK |
819 | var hue = (1.0 * idx/ (1 + num)); |
820 | this.colors_.push(Dygraph.hsvToRGB(hue, sat, val)); | |
6a1aa64f DV |
821 | } |
822 | } else { | |
823 | for (var i = 0; i < num; i++) { | |
ec1959eb | 824 | if (!this.visibility()[i]) continue; |
285a6bda | 825 | var colorStr = colors[i % colors.length]; |
f474c2a3 | 826 | this.colors_.push(colorStr); |
6a1aa64f DV |
827 | } |
828 | } | |
285a6bda | 829 | |
c21d2c2d | 830 | // TODO(danvk): update this w/r/t/ the new options system. |
285a6bda | 831 | this.renderOptions_.colorScheme = this.colors_; |
fc80a396 DV |
832 | Dygraph.update(this.plotter_.options, this.renderOptions_); |
833 | Dygraph.update(this.layoutOptions_, this.user_attrs_); | |
834 | Dygraph.update(this.layoutOptions_, this.attrs_); | |
6a1aa64f DV |
835 | } |
836 | ||
43af96e7 NK |
837 | /** |
838 | * Return the list of colors. This is either the list of colors passed in the | |
839 | * attributes, or the autogenerated list of rgb(r,g,b) strings. | |
840 | * @return {Array<string>} The list of colors. | |
841 | */ | |
842 | Dygraph.prototype.getColors = function() { | |
843 | return this.colors_; | |
844 | }; | |
845 | ||
5e60386d DV |
846 | // The following functions are from quirksmode.org with a modification for Safari from |
847 | // http://blog.firetree.net/2005/07/04/javascript-find-position/ | |
3df0ccf0 DV |
848 | // http://www.quirksmode.org/js/findpos.html |
849 | Dygraph.findPosX = function(obj) { | |
850 | var curleft = 0; | |
5e60386d | 851 | if(obj.offsetParent) |
50360fd0 | 852 | while(1) |
5e60386d | 853 | { |
3df0ccf0 | 854 | curleft += obj.offsetLeft; |
5e60386d DV |
855 | if(!obj.offsetParent) |
856 | break; | |
3df0ccf0 DV |
857 | obj = obj.offsetParent; |
858 | } | |
5e60386d | 859 | else if(obj.x) |
3df0ccf0 DV |
860 | curleft += obj.x; |
861 | return curleft; | |
862 | }; | |
c21d2c2d | 863 | |
3df0ccf0 DV |
864 | Dygraph.findPosY = function(obj) { |
865 | var curtop = 0; | |
5e60386d DV |
866 | if(obj.offsetParent) |
867 | while(1) | |
868 | { | |
3df0ccf0 | 869 | curtop += obj.offsetTop; |
5e60386d DV |
870 | if(!obj.offsetParent) |
871 | break; | |
3df0ccf0 DV |
872 | obj = obj.offsetParent; |
873 | } | |
5e60386d | 874 | else if(obj.y) |
3df0ccf0 DV |
875 | curtop += obj.y; |
876 | return curtop; | |
877 | }; | |
878 | ||
5e60386d | 879 | |
71a11a8e | 880 | |
6a1aa64f DV |
881 | /** |
882 | * Create the div that contains information on the selected point(s) | |
883 | * This goes in the top right of the canvas, unless an external div has already | |
884 | * been specified. | |
885 | * @private | |
886 | */ | |
fedbd797 | 887 | Dygraph.prototype.createStatusMessage_ = function() { |
888 | var userLabelsDiv = this.user_attrs_["labelsDiv"]; | |
889 | if (userLabelsDiv && null != userLabelsDiv | |
890 | && (typeof(userLabelsDiv) == "string" || userLabelsDiv instanceof String)) { | |
891 | this.user_attrs_["labelsDiv"] = document.getElementById(userLabelsDiv); | |
892 | } | |
285a6bda DV |
893 | if (!this.attr_("labelsDiv")) { |
894 | var divWidth = this.attr_('labelsDivWidth'); | |
b0c3b730 | 895 | var messagestyle = { |
6a1aa64f DV |
896 | "position": "absolute", |
897 | "fontSize": "14px", | |
898 | "zIndex": 10, | |
899 | "width": divWidth + "px", | |
900 | "top": "0px", | |
8846615a | 901 | "left": (this.width_ - divWidth - 2) + "px", |
6a1aa64f DV |
902 | "background": "white", |
903 | "textAlign": "left", | |
b0c3b730 | 904 | "overflow": "hidden"}; |
fc80a396 | 905 | Dygraph.update(messagestyle, this.attr_('labelsDivStyles')); |
b0c3b730 DV |
906 | var div = document.createElement("div"); |
907 | for (var name in messagestyle) { | |
85b99f0b DV |
908 | if (messagestyle.hasOwnProperty(name)) { |
909 | div.style[name] = messagestyle[name]; | |
910 | } | |
b0c3b730 DV |
911 | } |
912 | this.graphDiv.appendChild(div); | |
285a6bda | 913 | this.attrs_.labelsDiv = div; |
6a1aa64f DV |
914 | } |
915 | }; | |
916 | ||
917 | /** | |
ad1798c2 DV |
918 | * Position the labels div so that: |
919 | * - its right edge is flush with the right edge of the charting area | |
920 | * - its top edge is flush with the top edge of the charting area | |
0abfbd7e DV |
921 | */ |
922 | Dygraph.prototype.positionLabelsDiv_ = function() { | |
923 | // Don't touch a user-specified labelsDiv. | |
924 | if (this.user_attrs_.hasOwnProperty("labelsDiv")) return; | |
925 | ||
926 | var area = this.plotter_.area; | |
927 | var div = this.attr_("labelsDiv"); | |
8c21adcf | 928 | div.style.left = area.x + area.w - this.attr_("labelsDivWidth") - 1 + "px"; |
ad1798c2 | 929 | div.style.top = area.y + "px"; |
0abfbd7e DV |
930 | }; |
931 | ||
932 | /** | |
6a1aa64f | 933 | * Create the text box to adjust the averaging period |
6a1aa64f DV |
934 | * @private |
935 | */ | |
285a6bda | 936 | Dygraph.prototype.createRollInterface_ = function() { |
8c69de65 DV |
937 | // Create a roller if one doesn't exist already. |
938 | if (!this.roller_) { | |
939 | this.roller_ = document.createElement("input"); | |
940 | this.roller_.type = "text"; | |
941 | this.roller_.style.display = "none"; | |
942 | this.graphDiv.appendChild(this.roller_); | |
943 | } | |
944 | ||
945 | var display = this.attr_('showRoller') ? 'block' : 'none'; | |
26ca7938 | 946 | |
0c38f187 | 947 | var area = this.plotter_.area; |
b0c3b730 DV |
948 | var textAttr = { "position": "absolute", |
949 | "zIndex": 10, | |
0c38f187 DV |
950 | "top": (area.y + area.h - 25) + "px", |
951 | "left": (area.x + 1) + "px", | |
b0c3b730 | 952 | "display": display |
6a1aa64f | 953 | }; |
8c69de65 DV |
954 | this.roller_.size = "2"; |
955 | this.roller_.value = this.rollPeriod_; | |
b0c3b730 | 956 | for (var name in textAttr) { |
85b99f0b | 957 | if (textAttr.hasOwnProperty(name)) { |
8c69de65 | 958 | this.roller_.style[name] = textAttr[name]; |
85b99f0b | 959 | } |
b0c3b730 DV |
960 | } |
961 | ||
76171648 | 962 | var dygraph = this; |
8c69de65 | 963 | this.roller_.onchange = function() { dygraph.adjustRoll(dygraph.roller_.value); }; |
76171648 DV |
964 | }; |
965 | ||
966 | // These functions are taken from MochiKit.Signal | |
967 | Dygraph.pageX = function(e) { | |
968 | if (e.pageX) { | |
969 | return (!e.pageX || e.pageX < 0) ? 0 : e.pageX; | |
970 | } else { | |
971 | var de = document; | |
972 | var b = document.body; | |
973 | return e.clientX + | |
974 | (de.scrollLeft || b.scrollLeft) - | |
975 | (de.clientLeft || 0); | |
976 | } | |
977 | }; | |
978 | ||
979 | Dygraph.pageY = function(e) { | |
980 | if (e.pageY) { | |
981 | return (!e.pageY || e.pageY < 0) ? 0 : e.pageY; | |
982 | } else { | |
983 | var de = document; | |
984 | var b = document.body; | |
985 | return e.clientY + | |
986 | (de.scrollTop || b.scrollTop) - | |
987 | (de.clientTop || 0); | |
988 | } | |
989 | }; | |
6a1aa64f | 990 | |
062ef401 JB |
991 | Dygraph.prototype.dragGetX_ = function(e, context) { |
992 | return Dygraph.pageX(e) - context.px | |
993 | }; | |
bce01b0f | 994 | |
062ef401 JB |
995 | Dygraph.prototype.dragGetY_ = function(e, context) { |
996 | return Dygraph.pageY(e) - context.py | |
997 | }; | |
ee672584 | 998 | |
062ef401 JB |
999 | // Called in response to an interaction model operation that |
1000 | // should start the default panning behavior. | |
1001 | // | |
1002 | // It's used in the default callback for "mousedown" operations. | |
1003 | // Custom interaction model builders can use it to provide the default | |
1004 | // panning behavior. | |
1005 | // | |
1006 | Dygraph.startPan = function(event, g, context) { | |
062ef401 JB |
1007 | context.isPanning = true; |
1008 | var xRange = g.xAxisRange(); | |
1009 | context.dateRange = xRange[1] - xRange[0]; | |
ec291cbe RK |
1010 | context.initialLeftmostDate = xRange[0]; |
1011 | context.xUnitsPerPixel = context.dateRange / (g.plotter_.area.w - 1); | |
062ef401 | 1012 | |
965a030e RK |
1013 | if (g.attr_("panEdgeFraction")) { |
1014 | var maxXPixelsToDraw = g.width_ * g.attr_("panEdgeFraction"); | |
4cac8c7a RK |
1015 | var xExtremes = g.xAxisExtremes(); // I REALLY WANT TO CALL THIS xTremes! |
1016 | ||
1017 | var boundedLeftX = g.toDomXCoord(xExtremes[0]) - maxXPixelsToDraw; | |
1018 | var boundedRightX = g.toDomXCoord(xExtremes[1]) + maxXPixelsToDraw; | |
1019 | ||
1020 | var boundedLeftDate = g.toDataXCoord(boundedLeftX); | |
1021 | var boundedRightDate = g.toDataXCoord(boundedRightX); | |
1022 | context.boundedDates = [boundedLeftDate, boundedRightDate]; | |
1023 | ||
1024 | var boundedValues = []; | |
965a030e | 1025 | var maxYPixelsToDraw = g.height_ * g.attr_("panEdgeFraction"); |
4cac8c7a RK |
1026 | |
1027 | for (var i = 0; i < g.axes_.length; i++) { | |
1028 | var axis = g.axes_[i]; | |
1029 | var yExtremes = axis.extremeRange; | |
1030 | ||
1031 | var boundedTopY = g.toDomYCoord(yExtremes[0], i) + maxYPixelsToDraw; | |
1032 | var boundedBottomY = g.toDomYCoord(yExtremes[1], i) - maxYPixelsToDraw; | |
1033 | ||
1034 | var boundedTopValue = g.toDataYCoord(boundedTopY); | |
1035 | var boundedBottomValue = g.toDataYCoord(boundedBottomY); | |
1036 | ||
4cac8c7a RK |
1037 | boundedValues[i] = [boundedTopValue, boundedBottomValue]; |
1038 | } | |
1039 | context.boundedValues = boundedValues; | |
1040 | } | |
1041 | ||
062ef401 JB |
1042 | // Record the range of each y-axis at the start of the drag. |
1043 | // If any axis has a valueRange or valueWindow, then we want a 2D pan. | |
1044 | context.is2DPan = false; | |
1045 | for (var i = 0; i < g.axes_.length; i++) { | |
1046 | var axis = g.axes_[i]; | |
1047 | var yRange = g.yAxisRange(i); | |
ec291cbe | 1048 | // TODO(konigsberg): These values should be in |context|. |
ed898bdd RK |
1049 | // In log scale, initialTopValue, dragValueRange and unitsPerPixel are log scale. |
1050 | if (axis.logscale) { | |
1051 | axis.initialTopValue = Dygraph.log10(yRange[1]); | |
1052 | axis.dragValueRange = Dygraph.log10(yRange[1]) - Dygraph.log10(yRange[0]); | |
1053 | } else { | |
1054 | axis.initialTopValue = yRange[1]; | |
1055 | axis.dragValueRange = yRange[1] - yRange[0]; | |
1056 | } | |
ec291cbe | 1057 | axis.unitsPerPixel = axis.dragValueRange / (g.plotter_.area.h - 1); |
ed898bdd RK |
1058 | |
1059 | // While calculating axes, set 2dpan. | |
062ef401 JB |
1060 | if (axis.valueWindow || axis.valueRange) context.is2DPan = true; |
1061 | } | |
062ef401 | 1062 | }; |
6a1aa64f | 1063 | |
062ef401 JB |
1064 | // Called in response to an interaction model operation that |
1065 | // responds to an event that pans the view. | |
1066 | // | |
1067 | // It's used in the default callback for "mousemove" operations. | |
1068 | // Custom interaction model builders can use it to provide the default | |
1069 | // panning behavior. | |
1070 | // | |
1071 | Dygraph.movePan = function(event, g, context) { | |
1072 | context.dragEndX = g.dragGetX_(event, context); | |
1073 | context.dragEndY = g.dragGetY_(event, context); | |
79b3ee42 | 1074 | |
ec291cbe RK |
1075 | var minDate = context.initialLeftmostDate - |
1076 | (context.dragEndX - context.dragStartX) * context.xUnitsPerPixel; | |
4cac8c7a RK |
1077 | if (context.boundedDates) { |
1078 | minDate = Math.max(minDate, context.boundedDates[0]); | |
1079 | } | |
062ef401 | 1080 | var maxDate = minDate + context.dateRange; |
4cac8c7a RK |
1081 | if (context.boundedDates) { |
1082 | if (maxDate > context.boundedDates[1]) { | |
1083 | // Adjust minDate, and recompute maxDate. | |
1084 | minDate = minDate - (maxDate - context.boundedDates[1]); | |
965a030e | 1085 | maxDate = minDate + context.dateRange; |
4cac8c7a RK |
1086 | } |
1087 | } | |
1088 | ||
062ef401 JB |
1089 | g.dateWindow_ = [minDate, maxDate]; |
1090 | ||
1091 | // y-axis scaling is automatic unless this is a full 2D pan. | |
1092 | if (context.is2DPan) { | |
1093 | // Adjust each axis appropriately. | |
062ef401 JB |
1094 | for (var i = 0; i < g.axes_.length; i++) { |
1095 | var axis = g.axes_[i]; | |
ed898bdd RK |
1096 | |
1097 | var pixelsDragged = context.dragEndY - context.dragStartY; | |
1098 | var unitsDragged = pixelsDragged * axis.unitsPerPixel; | |
4cac8c7a RK |
1099 | |
1100 | var boundedValue = context.boundedValues ? context.boundedValues[i] : null; | |
ed898bdd RK |
1101 | |
1102 | // In log scale, maxValue and minValue are the logs of those values. | |
1103 | var maxValue = axis.initialTopValue + unitsDragged; | |
4cac8c7a RK |
1104 | if (boundedValue) { |
1105 | maxValue = Math.min(maxValue, boundedValue[1]); | |
1106 | } | |
062ef401 | 1107 | var minValue = maxValue - axis.dragValueRange; |
4cac8c7a RK |
1108 | if (boundedValue) { |
1109 | if (minValue < boundedValue[0]) { | |
1110 | // Adjust maxValue, and recompute minValue. | |
1111 | maxValue = maxValue - (minValue - boundedValue[0]); | |
1112 | minValue = maxValue - axis.dragValueRange; | |
1113 | } | |
1114 | } | |
ed898bdd | 1115 | if (axis.logscale) { |
5db0e241 DV |
1116 | axis.valueWindow = [ Math.pow(Dygraph.LOG_SCALE, minValue), |
1117 | Math.pow(Dygraph.LOG_SCALE, maxValue) ]; | |
ed898bdd RK |
1118 | } else { |
1119 | axis.valueWindow = [ minValue, maxValue ]; | |
1120 | } | |
6faebb69 | 1121 | } |
062ef401 | 1122 | } |
bce01b0f | 1123 | |
062ef401 JB |
1124 | g.drawGraph_(); |
1125 | } | |
ee672584 | 1126 | |
062ef401 JB |
1127 | // Called in response to an interaction model operation that |
1128 | // responds to an event that ends panning. | |
1129 | // | |
1130 | // It's used in the default callback for "mouseup" operations. | |
1131 | // Custom interaction model builders can use it to provide the default | |
1132 | // panning behavior. | |
1133 | // | |
1134 | Dygraph.endPan = function(event, g, context) { | |
ec291cbe RK |
1135 | // TODO(konigsberg): Clear the context data from the axis. |
1136 | // TODO(konigsberg): mouseup should just delete the | |
1137 | // context object, and mousedown should create a new one. | |
062ef401 JB |
1138 | context.isPanning = false; |
1139 | context.is2DPan = false; | |
ec291cbe | 1140 | context.initialLeftmostDate = null; |
062ef401 JB |
1141 | context.dateRange = null; |
1142 | context.valueRange = null; | |
9ec21d0a RK |
1143 | context.boundedDates = null; |
1144 | context.boundedValues = null; | |
062ef401 | 1145 | } |
ee672584 | 1146 | |
062ef401 JB |
1147 | // Called in response to an interaction model operation that |
1148 | // responds to an event that starts zooming. | |
1149 | // | |
1150 | // It's used in the default callback for "mousedown" operations. | |
1151 | // Custom interaction model builders can use it to provide the default | |
1152 | // zooming behavior. | |
1153 | // | |
1154 | Dygraph.startZoom = function(event, g, context) { | |
1155 | context.isZooming = true; | |
1156 | } | |
1157 | ||
1158 | // Called in response to an interaction model operation that | |
1159 | // responds to an event that defines zoom boundaries. | |
1160 | // | |
1161 | // It's used in the default callback for "mousemove" operations. | |
1162 | // Custom interaction model builders can use it to provide the default | |
1163 | // zooming behavior. | |
1164 | // | |
1165 | Dygraph.moveZoom = function(event, g, context) { | |
1166 | context.dragEndX = g.dragGetX_(event, context); | |
1167 | context.dragEndY = g.dragGetY_(event, context); | |
1168 | ||
1169 | var xDelta = Math.abs(context.dragStartX - context.dragEndX); | |
1170 | var yDelta = Math.abs(context.dragStartY - context.dragEndY); | |
1171 | ||
1172 | // drag direction threshold for y axis is twice as large as x axis | |
1173 | context.dragDirection = (xDelta < yDelta / 2) ? Dygraph.VERTICAL : Dygraph.HORIZONTAL; | |
1174 | ||
1175 | g.drawZoomRect_( | |
1176 | context.dragDirection, | |
1177 | context.dragStartX, | |
1178 | context.dragEndX, | |
1179 | context.dragStartY, | |
1180 | context.dragEndY, | |
1181 | context.prevDragDirection, | |
1182 | context.prevEndX, | |
1183 | context.prevEndY); | |
1184 | ||
1185 | context.prevEndX = context.dragEndX; | |
1186 | context.prevEndY = context.dragEndY; | |
1187 | context.prevDragDirection = context.dragDirection; | |
1188 | } | |
1189 | ||
1190 | // Called in response to an interaction model operation that | |
1191 | // responds to an event that performs a zoom based on previously defined | |
1192 | // bounds.. | |
1193 | // | |
1194 | // It's used in the default callback for "mouseup" operations. | |
1195 | // Custom interaction model builders can use it to provide the default | |
1196 | // zooming behavior. | |
1197 | // | |
1198 | Dygraph.endZoom = function(event, g, context) { | |
1199 | context.isZooming = false; | |
1200 | context.dragEndX = g.dragGetX_(event, context); | |
1201 | context.dragEndY = g.dragGetY_(event, context); | |
1202 | var regionWidth = Math.abs(context.dragEndX - context.dragStartX); | |
1203 | var regionHeight = Math.abs(context.dragEndY - context.dragStartY); | |
1204 | ||
1205 | if (regionWidth < 2 && regionHeight < 2 && | |
1206 | g.lastx_ != undefined && g.lastx_ != -1) { | |
1207 | // TODO(danvk): pass along more info about the points, e.g. 'x' | |
1208 | if (g.attr_('clickCallback') != null) { | |
1209 | g.attr_('clickCallback')(event, g.lastx_, g.selPoints_); | |
1210 | } | |
1211 | if (g.attr_('pointClickCallback')) { | |
1212 | // check if the click was on a particular point. | |
1213 | var closestIdx = -1; | |
1214 | var closestDistance = 0; | |
1215 | for (var i = 0; i < g.selPoints_.length; i++) { | |
1216 | var p = g.selPoints_[i]; | |
1217 | var distance = Math.pow(p.canvasx - context.dragEndX, 2) + | |
1218 | Math.pow(p.canvasy - context.dragEndY, 2); | |
1219 | if (closestIdx == -1 || distance < closestDistance) { | |
1220 | closestDistance = distance; | |
1221 | closestIdx = i; | |
d58ae307 DV |
1222 | } |
1223 | } | |
e3489f4f | 1224 | |
062ef401 JB |
1225 | // Allow any click within two pixels of the dot. |
1226 | var radius = g.attr_('highlightCircleSize') + 2; | |
1227 | if (closestDistance <= 5 * 5) { | |
1228 | g.attr_('pointClickCallback')(event, g.selPoints_[closestIdx]); | |
6faebb69 | 1229 | } |
062ef401 JB |
1230 | } |
1231 | } | |
0a52ab7a | 1232 | |
062ef401 JB |
1233 | if (regionWidth >= 10 && context.dragDirection == Dygraph.HORIZONTAL) { |
1234 | g.doZoomX_(Math.min(context.dragStartX, context.dragEndX), | |
1235 | Math.max(context.dragStartX, context.dragEndX)); | |
1236 | } else if (regionHeight >= 10 && context.dragDirection == Dygraph.VERTICAL) { | |
1237 | g.doZoomY_(Math.min(context.dragStartY, context.dragEndY), | |
1238 | Math.max(context.dragStartY, context.dragEndY)); | |
1239 | } else { | |
2cf95fff | 1240 | g.canvas_ctx_.clearRect(0, 0, g.canvas_.width, g.canvas_.height); |
062ef401 JB |
1241 | } |
1242 | context.dragStartX = null; | |
1243 | context.dragStartY = null; | |
1244 | } | |
1245 | ||
1246 | Dygraph.defaultInteractionModel = { | |
1247 | // Track the beginning of drag events | |
1248 | mousedown: function(event, g, context) { | |
1249 | context.initializeMouseDown(event, g, context); | |
1250 | ||
1251 | if (event.altKey || event.shiftKey) { | |
1252 | Dygraph.startPan(event, g, context); | |
bce01b0f | 1253 | } else { |
062ef401 | 1254 | Dygraph.startZoom(event, g, context); |
bce01b0f | 1255 | } |
062ef401 | 1256 | }, |
6a1aa64f | 1257 | |
062ef401 JB |
1258 | // Draw zoom rectangles when the mouse is down and the user moves around |
1259 | mousemove: function(event, g, context) { | |
1260 | if (context.isZooming) { | |
1261 | Dygraph.moveZoom(event, g, context); | |
1262 | } else if (context.isPanning) { | |
1263 | Dygraph.movePan(event, g, context); | |
6a1aa64f | 1264 | } |
062ef401 | 1265 | }, |
bce01b0f | 1266 | |
062ef401 JB |
1267 | mouseup: function(event, g, context) { |
1268 | if (context.isZooming) { | |
1269 | Dygraph.endZoom(event, g, context); | |
1270 | } else if (context.isPanning) { | |
1271 | Dygraph.endPan(event, g, context); | |
bce01b0f | 1272 | } |
062ef401 | 1273 | }, |
6a1aa64f DV |
1274 | |
1275 | // Temporarily cancel the dragging event when the mouse leaves the graph | |
062ef401 JB |
1276 | mouseout: function(event, g, context) { |
1277 | if (context.isZooming) { | |
1278 | context.dragEndX = null; | |
1279 | context.dragEndY = null; | |
6a1aa64f | 1280 | } |
062ef401 | 1281 | }, |
6a1aa64f | 1282 | |
062ef401 JB |
1283 | // Disable zooming out if panning. |
1284 | dblclick: function(event, g, context) { | |
1285 | if (event.altKey || event.shiftKey) { | |
1286 | return; | |
1287 | } | |
1288 | // TODO(konigsberg): replace g.doUnzoom()_ with something that is | |
1289 | // friendlier to public use. | |
1290 | g.doUnzoom_(); | |
1291 | } | |
1292 | }; | |
1e1bf7df | 1293 | |
062ef401 | 1294 | Dygraph.DEFAULT_ATTRS.interactionModel = Dygraph.defaultInteractionModel; |
6a1aa64f | 1295 | |
062ef401 JB |
1296 | /** |
1297 | * Set up all the mouse handlers needed to capture dragging behavior for zoom | |
1298 | * events. | |
1299 | * @private | |
1300 | */ | |
1301 | Dygraph.prototype.createDragInterface_ = function() { | |
1302 | var context = { | |
1303 | // Tracks whether the mouse is down right now | |
1304 | isZooming: false, | |
1305 | isPanning: false, // is this drag part of a pan? | |
1306 | is2DPan: false, // if so, is that pan 1- or 2-dimensional? | |
1307 | dragStartX: null, | |
1308 | dragStartY: null, | |
1309 | dragEndX: null, | |
1310 | dragEndY: null, | |
1311 | dragDirection: null, | |
1312 | prevEndX: null, | |
1313 | prevEndY: null, | |
1314 | prevDragDirection: null, | |
1315 | ||
ec291cbe RK |
1316 | // The value on the left side of the graph when a pan operation starts. |
1317 | initialLeftmostDate: null, | |
1318 | ||
1319 | // The number of units each pixel spans. (This won't be valid for log | |
1320 | // scales) | |
1321 | xUnitsPerPixel: null, | |
062ef401 JB |
1322 | |
1323 | // TODO(danvk): update this comment | |
1324 | // The range in second/value units that the viewport encompasses during a | |
1325 | // panning operation. | |
1326 | dateRange: null, | |
1327 | ||
1328 | // Utility function to convert page-wide coordinates to canvas coords | |
1329 | px: 0, | |
1330 | py: 0, | |
1331 | ||
965a030e | 1332 | // Values for use with panEdgeFraction, which limit how far outside the |
4cac8c7a RK |
1333 | // graph's data boundaries it can be panned. |
1334 | boundedDates: null, // [minDate, maxDate] | |
1335 | boundedValues: null, // [[minValue, maxValue] ...] | |
1336 | ||
062ef401 JB |
1337 | initializeMouseDown: function(event, g, context) { |
1338 | // prevents mouse drags from selecting page text. | |
1339 | if (event.preventDefault) { | |
1340 | event.preventDefault(); // Firefox, Chrome, etc. | |
6a1aa64f | 1341 | } else { |
062ef401 JB |
1342 | event.returnValue = false; // IE |
1343 | event.cancelBubble = true; | |
6a1aa64f DV |
1344 | } |
1345 | ||
062ef401 JB |
1346 | context.px = Dygraph.findPosX(g.canvas_); |
1347 | context.py = Dygraph.findPosY(g.canvas_); | |
1348 | context.dragStartX = g.dragGetX_(event, context); | |
1349 | context.dragStartY = g.dragGetY_(event, context); | |
6a1aa64f | 1350 | } |
062ef401 | 1351 | }; |
2b188b3d | 1352 | |
062ef401 | 1353 | var interactionModel = this.attr_("interactionModel"); |
8b83c6cc | 1354 | |
062ef401 JB |
1355 | // Self is the graph. |
1356 | var self = this; | |
6faebb69 | 1357 | |
062ef401 JB |
1358 | // Function that binds the graph and context to the handler. |
1359 | var bindHandler = function(handler) { | |
1360 | return function(event) { | |
1361 | handler(event, self, context); | |
1362 | }; | |
1363 | }; | |
1364 | ||
1365 | for (var eventName in interactionModel) { | |
1366 | if (!interactionModel.hasOwnProperty(eventName)) continue; | |
1367 | Dygraph.addEvent(this.mouseEventElement_, eventName, | |
1368 | bindHandler(interactionModel[eventName])); | |
1369 | } | |
1370 | ||
1371 | // If the user releases the mouse button during a drag, but not over the | |
1372 | // canvas, then it doesn't count as a zooming action. | |
1373 | Dygraph.addEvent(document, 'mouseup', function(event) { | |
1374 | if (context.isZooming || context.isPanning) { | |
1375 | context.isZooming = false; | |
1376 | context.dragStartX = null; | |
1377 | context.dragStartY = null; | |
1378 | } | |
1379 | ||
1380 | if (context.isPanning) { | |
1381 | context.isPanning = false; | |
1382 | context.draggingDate = null; | |
1383 | context.dateRange = null; | |
1384 | for (var i = 0; i < self.axes_.length; i++) { | |
1385 | delete self.axes_[i].draggingValue; | |
1386 | delete self.axes_[i].dragValueRange; | |
1387 | } | |
1388 | } | |
6a1aa64f DV |
1389 | }); |
1390 | }; | |
1391 | ||
062ef401 | 1392 | |
6a1aa64f DV |
1393 | /** |
1394 | * Draw a gray zoom rectangle over the desired area of the canvas. Also clears | |
1395 | * up any previous zoom rectangles that were drawn. This could be optimized to | |
1396 | * avoid extra redrawing, but it's tricky to avoid interactions with the status | |
1397 | * dots. | |
8b83c6cc | 1398 | * |
39b0e098 RK |
1399 | * @param {Number} direction the direction of the zoom rectangle. Acceptable |
1400 | * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL. | |
6a1aa64f DV |
1401 | * @param {Number} startX The X position where the drag started, in canvas |
1402 | * coordinates. | |
1403 | * @param {Number} endX The current X position of the drag, in canvas coords. | |
8b83c6cc RK |
1404 | * @param {Number} startY The Y position where the drag started, in canvas |
1405 | * coordinates. | |
1406 | * @param {Number} endY The current Y position of the drag, in canvas coords. | |
39b0e098 | 1407 | * @param {Number} prevDirection the value of direction on the previous call to |
8b83c6cc | 1408 | * this function. Used to avoid excess redrawing |
6a1aa64f DV |
1409 | * @param {Number} prevEndX The value of endX on the previous call to this |
1410 | * function. Used to avoid excess redrawing | |
8b83c6cc RK |
1411 | * @param {Number} prevEndY The value of endY on the previous call to this |
1412 | * function. Used to avoid excess redrawing | |
6a1aa64f DV |
1413 | * @private |
1414 | */ | |
7201b11e JB |
1415 | Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY, |
1416 | endY, prevDirection, prevEndX, | |
1417 | prevEndY) { | |
2cf95fff | 1418 | var ctx = this.canvas_ctx_; |
6a1aa64f DV |
1419 | |
1420 | // Clean up from the previous rect if necessary | |
39b0e098 | 1421 | if (prevDirection == Dygraph.HORIZONTAL) { |
6a1aa64f DV |
1422 | ctx.clearRect(Math.min(startX, prevEndX), 0, |
1423 | Math.abs(startX - prevEndX), this.height_); | |
39b0e098 | 1424 | } else if (prevDirection == Dygraph.VERTICAL){ |
8b83c6cc RK |
1425 | ctx.clearRect(0, Math.min(startY, prevEndY), |
1426 | this.width_, Math.abs(startY - prevEndY)); | |
6a1aa64f DV |
1427 | } |
1428 | ||
1429 | // Draw a light-grey rectangle to show the new viewing area | |
39b0e098 | 1430 | if (direction == Dygraph.HORIZONTAL) { |
8b83c6cc RK |
1431 | if (endX && startX) { |
1432 | ctx.fillStyle = "rgba(128,128,128,0.33)"; | |
1433 | ctx.fillRect(Math.min(startX, endX), 0, | |
1434 | Math.abs(endX - startX), this.height_); | |
1435 | } | |
1436 | } | |
39b0e098 | 1437 | if (direction == Dygraph.VERTICAL) { |
8b83c6cc RK |
1438 | if (endY && startY) { |
1439 | ctx.fillStyle = "rgba(128,128,128,0.33)"; | |
1440 | ctx.fillRect(0, Math.min(startY, endY), | |
1441 | this.width_, Math.abs(endY - startY)); | |
1442 | } | |
6a1aa64f DV |
1443 | } |
1444 | }; | |
1445 | ||
1446 | /** | |
8b83c6cc RK |
1447 | * Zoom to something containing [lowX, highX]. These are pixel coordinates in |
1448 | * the canvas. The exact zoom window may be slightly larger if there are no data | |
1449 | * points near lowX or highX. Don't confuse this function with doZoomXDates, | |
1450 | * which accepts dates that match the raw data. This function redraws the graph. | |
d58ae307 | 1451 | * |
6a1aa64f DV |
1452 | * @param {Number} lowX The leftmost pixel value that should be visible. |
1453 | * @param {Number} highX The rightmost pixel value that should be visible. | |
1454 | * @private | |
1455 | */ | |
8b83c6cc | 1456 | Dygraph.prototype.doZoomX_ = function(lowX, highX) { |
6a1aa64f | 1457 | // Find the earliest and latest dates contained in this canvasx range. |
8b83c6cc | 1458 | // Convert the call to date ranges of the raw data. |
ff022deb RK |
1459 | var minDate = this.toDataXCoord(lowX); |
1460 | var maxDate = this.toDataXCoord(highX); | |
8b83c6cc RK |
1461 | this.doZoomXDates_(minDate, maxDate); |
1462 | }; | |
6a1aa64f | 1463 | |
8b83c6cc RK |
1464 | /** |
1465 | * Zoom to something containing [minDate, maxDate] values. Don't confuse this | |
1466 | * method with doZoomX which accepts pixel coordinates. This function redraws | |
1467 | * the graph. | |
d58ae307 | 1468 | * |
8b83c6cc RK |
1469 | * @param {Number} minDate The minimum date that should be visible. |
1470 | * @param {Number} maxDate The maximum date that should be visible. | |
1471 | * @private | |
1472 | */ | |
1473 | Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) { | |
6a1aa64f | 1474 | this.dateWindow_ = [minDate, maxDate]; |
57baab03 | 1475 | this.zoomed_x_ = true; |
26ca7938 | 1476 | this.drawGraph_(); |
285a6bda | 1477 | if (this.attr_("zoomCallback")) { |
ac139d19 | 1478 | this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges()); |
8b83c6cc RK |
1479 | } |
1480 | }; | |
1481 | ||
1482 | /** | |
1483 | * Zoom to something containing [lowY, highY]. These are pixel coordinates in | |
d58ae307 DV |
1484 | * the canvas. This function redraws the graph. |
1485 | * | |
8b83c6cc RK |
1486 | * @param {Number} lowY The topmost pixel value that should be visible. |
1487 | * @param {Number} highY The lowest pixel value that should be visible. | |
1488 | * @private | |
1489 | */ | |
1490 | Dygraph.prototype.doZoomY_ = function(lowY, highY) { | |
d58ae307 DV |
1491 | // Find the highest and lowest values in pixel range for each axis. |
1492 | // Note that lowY (in pixels) corresponds to the max Value (in data coords). | |
1493 | // This is because pixels increase as you go down on the screen, whereas data | |
1494 | // coordinates increase as you go up the screen. | |
1495 | var valueRanges = []; | |
1496 | for (var i = 0; i < this.axes_.length; i++) { | |
ff022deb RK |
1497 | var hi = this.toDataYCoord(lowY, i); |
1498 | var low = this.toDataYCoord(highY, i); | |
1499 | this.axes_[i].valueWindow = [low, hi]; | |
1500 | valueRanges.push([low, hi]); | |
d58ae307 | 1501 | } |
8b83c6cc | 1502 | |
57baab03 | 1503 | this.zoomed_y_ = true; |
66c380c4 | 1504 | this.drawGraph_(); |
8b83c6cc | 1505 | if (this.attr_("zoomCallback")) { |
d58ae307 | 1506 | var xRange = this.xAxisRange(); |
45f2c689 | 1507 | var yRange = this.yAxisRange(); |
d58ae307 | 1508 | this.attr_("zoomCallback")(xRange[0], xRange[1], this.yAxisRanges()); |
8b83c6cc RK |
1509 | } |
1510 | }; | |
1511 | ||
1512 | /** | |
1513 | * Reset the zoom to the original view coordinates. This is the same as | |
1514 | * double-clicking on the graph. | |
d58ae307 | 1515 | * |
8b83c6cc RK |
1516 | * @private |
1517 | */ | |
1518 | Dygraph.prototype.doUnzoom_ = function() { | |
d58ae307 | 1519 | var dirty = false; |
8b83c6cc | 1520 | if (this.dateWindow_ != null) { |
d58ae307 | 1521 | dirty = true; |
8b83c6cc RK |
1522 | this.dateWindow_ = null; |
1523 | } | |
d58ae307 DV |
1524 | |
1525 | for (var i = 0; i < this.axes_.length; i++) { | |
1526 | if (this.axes_[i].valueWindow != null) { | |
1527 | dirty = true; | |
1528 | delete this.axes_[i].valueWindow; | |
1529 | } | |
8b83c6cc RK |
1530 | } |
1531 | ||
1532 | if (dirty) { | |
437c0979 RK |
1533 | // Putting the drawing operation before the callback because it resets |
1534 | // yAxisRange. | |
57baab03 NN |
1535 | this.zoomed_x_ = false; |
1536 | this.zoomed_y_ = false; | |
66c380c4 | 1537 | this.drawGraph_(); |
8b83c6cc RK |
1538 | if (this.attr_("zoomCallback")) { |
1539 | var minDate = this.rawData_[0][0]; | |
1540 | var maxDate = this.rawData_[this.rawData_.length - 1][0]; | |
d58ae307 | 1541 | this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges()); |
8b83c6cc | 1542 | } |
67e650dc | 1543 | } |
6a1aa64f DV |
1544 | }; |
1545 | ||
1546 | /** | |
1547 | * When the mouse moves in the canvas, display information about a nearby data | |
1548 | * point and draw dots over those points in the data series. This function | |
1549 | * takes care of cleanup of previously-drawn dots. | |
1550 | * @param {Object} event The mousemove event from the browser. | |
1551 | * @private | |
1552 | */ | |
285a6bda | 1553 | Dygraph.prototype.mouseMove_ = function(event) { |
e863a17d | 1554 | // This prevents JS errors when mousing over the canvas before data loads. |
4cac8c7a | 1555 | var points = this.layout_.points; |
685ebbb3 | 1556 | if (points === undefined) return; |
e863a17d | 1557 | |
4cac8c7a RK |
1558 | var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_); |
1559 | ||
6a1aa64f DV |
1560 | var lastx = -1; |
1561 | var lasty = -1; | |
1562 | ||
1563 | // Loop through all the points and find the date nearest to our current | |
1564 | // location. | |
1565 | var minDist = 1e+100; | |
1566 | var idx = -1; | |
1567 | for (var i = 0; i < points.length; i++) { | |
8a7cc60e RK |
1568 | var point = points[i]; |
1569 | if (point == null) continue; | |
062ef401 | 1570 | var dist = Math.abs(point.canvasx - canvasx); |
f032c51d | 1571 | if (dist > minDist) continue; |
6a1aa64f DV |
1572 | minDist = dist; |
1573 | idx = i; | |
1574 | } | |
1575 | if (idx >= 0) lastx = points[idx].xval; | |
6a1aa64f DV |
1576 | |
1577 | // Extract the points we've selected | |
b258a3da | 1578 | this.selPoints_ = []; |
50360fd0 | 1579 | var l = points.length; |
416b05ad NK |
1580 | if (!this.attr_("stackedGraph")) { |
1581 | for (var i = 0; i < l; i++) { | |
1582 | if (points[i].xval == lastx) { | |
1583 | this.selPoints_.push(points[i]); | |
1584 | } | |
1585 | } | |
1586 | } else { | |
354e15ab DE |
1587 | // Need to 'unstack' points starting from the bottom |
1588 | var cumulative_sum = 0; | |
416b05ad NK |
1589 | for (var i = l - 1; i >= 0; i--) { |
1590 | if (points[i].xval == lastx) { | |
354e15ab | 1591 | var p = {}; // Clone the point since we modify it |
d4139cd8 NK |
1592 | for (var k in points[i]) { |
1593 | p[k] = points[i][k]; | |
50360fd0 NK |
1594 | } |
1595 | p.yval -= cumulative_sum; | |
1596 | cumulative_sum += p.yval; | |
d4139cd8 | 1597 | this.selPoints_.push(p); |
12e4c741 | 1598 | } |
6a1aa64f | 1599 | } |
354e15ab | 1600 | this.selPoints_.reverse(); |
6a1aa64f DV |
1601 | } |
1602 | ||
b258a3da | 1603 | if (this.attr_("highlightCallback")) { |
a4c6a67c | 1604 | var px = this.lastx_; |
dd082dda | 1605 | if (px !== null && lastx != px) { |
344ba8c0 | 1606 | // only fire if the selected point has changed. |
2ddb1197 | 1607 | this.attr_("highlightCallback")(event, lastx, this.selPoints_, this.idxToRow_(idx)); |
43af96e7 | 1608 | } |
12e4c741 | 1609 | } |
43af96e7 | 1610 | |
239c712d NAG |
1611 | // Save last x position for callbacks. |
1612 | this.lastx_ = lastx; | |
50360fd0 | 1613 | |
239c712d NAG |
1614 | this.updateSelection_(); |
1615 | }; | |
b258a3da | 1616 | |
239c712d | 1617 | /** |
1903f1e4 | 1618 | * Transforms layout_.points index into data row number. |
2ddb1197 | 1619 | * @param int layout_.points index |
1903f1e4 | 1620 | * @return int row number, or -1 if none could be found. |
2ddb1197 SC |
1621 | * @private |
1622 | */ | |
1623 | Dygraph.prototype.idxToRow_ = function(idx) { | |
1903f1e4 | 1624 | if (idx < 0) return -1; |
2ddb1197 | 1625 | |
1903f1e4 DV |
1626 | for (var i in this.layout_.datasets) { |
1627 | if (idx < this.layout_.datasets[i].length) { | |
1628 | return this.boundaryIds_[0][0]+idx; | |
1629 | } | |
1630 | idx -= this.layout_.datasets[i].length; | |
1631 | } | |
1632 | return -1; | |
1633 | }; | |
2ddb1197 | 1634 | |
2fccd3dc | 1635 | // TODO(danvk): rename this function to something like 'isNonZeroNan'. |
e9fe4a2f DV |
1636 | Dygraph.isOK = function(x) { |
1637 | return x && !isNaN(x); | |
1638 | }; | |
1639 | ||
1640 | Dygraph.prototype.generateLegendHTML_ = function(x, sel_points) { | |
2fccd3dc DV |
1641 | // If no points are selected, we display a default legend. Traditionally, |
1642 | // this has been blank. But a better default would be a conventional legend, | |
1643 | // which provides essential information for a non-interactive chart. | |
1644 | if (typeof(x) === 'undefined') { | |
1645 | if (this.attr_('legend') != 'always') return ''; | |
1646 | ||
1647 | var sepLines = this.attr_('labelsSeparateLines'); | |
1648 | var labels = this.attr_('labels'); | |
1649 | var html = ''; | |
1650 | for (var i = 1; i < labels.length; i++) { | |
352c8310 | 1651 | if (!this.visibility()[i - 1]) continue; |
bafe040e | 1652 | var c = this.plotter_.colors[labels[i]]; |
352c8310 | 1653 | if (html != '') html += (sepLines ? '<br/>' : ' '); |
bafe040e DV |
1654 | html += "<b><span style='color: " + c + ";'>—" + labels[i] + |
1655 | "</span></b>"; | |
2fccd3dc DV |
1656 | } |
1657 | return html; | |
1658 | } | |
1659 | ||
032e4c1d | 1660 | var html = this.attr_('xValueFormatter')(x) + ":"; |
e9fe4a2f DV |
1661 | |
1662 | var fmtFunc = this.attr_('yValueFormatter'); | |
1663 | var showZeros = this.attr_("labelsShowZeroValues"); | |
1664 | var sepLines = this.attr_("labelsSeparateLines"); | |
1665 | for (var i = 0; i < this.selPoints_.length; i++) { | |
1666 | var pt = this.selPoints_[i]; | |
1667 | if (pt.yval == 0 && !showZeros) continue; | |
1668 | if (!Dygraph.isOK(pt.canvasy)) continue; | |
1669 | if (sepLines) html += "<br/>"; | |
1670 | ||
bafe040e | 1671 | var c = this.plotter_.colors[pt.name]; |
91c10d9c | 1672 | var yval = fmtFunc(pt.yval, this); |
2fccd3dc | 1673 | // TODO(danvk): use a template string here and make it an attribute. |
bafe040e DV |
1674 | html += " <b><span style='color: " + c + ";'>" |
1675 | + pt.name + "</span></b>:" | |
e9fe4a2f DV |
1676 | + yval; |
1677 | } | |
1678 | return html; | |
1679 | }; | |
1680 | ||
91c10d9c DV |
1681 | Dygraph.prototype.setLegendHTML_ = function(x, sel_points) { |
1682 | var html = this.generateLegendHTML_(x, sel_points); | |
1683 | var labelsDiv = this.attr_("labelsDiv"); | |
1684 | if (labelsDiv !== null) { | |
1685 | labelsDiv.innerHTML = html; | |
1686 | } else { | |
1687 | if (typeof(this.shown_legend_error_) == 'undefined') { | |
1688 | this.error('labelsDiv is set to something nonexistent; legend will not be shown.'); | |
1689 | this.shown_legend_error_ = true; | |
1690 | } | |
1691 | } | |
1692 | }; | |
1693 | ||
2ddb1197 | 1694 | /** |
239c712d NAG |
1695 | * Draw dots over the selectied points in the data series. This function |
1696 | * takes care of cleanup of previously-drawn dots. | |
1697 | * @private | |
1698 | */ | |
1699 | Dygraph.prototype.updateSelection_ = function() { | |
6a1aa64f | 1700 | // Clear the previously drawn vertical, if there is one |
2cf95fff | 1701 | var ctx = this.canvas_ctx_; |
6a1aa64f | 1702 | if (this.previousVerticalX_ >= 0) { |
46dde5f9 DV |
1703 | // Determine the maximum highlight circle size. |
1704 | var maxCircleSize = 0; | |
227b93cc DV |
1705 | var labels = this.attr_('labels'); |
1706 | for (var i = 1; i < labels.length; i++) { | |
1707 | var r = this.attr_('highlightCircleSize', labels[i]); | |
46dde5f9 DV |
1708 | if (r > maxCircleSize) maxCircleSize = r; |
1709 | } | |
6a1aa64f | 1710 | var px = this.previousVerticalX_; |
46dde5f9 DV |
1711 | ctx.clearRect(px - maxCircleSize - 1, 0, |
1712 | 2 * maxCircleSize + 2, this.height_); | |
6a1aa64f DV |
1713 | } |
1714 | ||
d160cc3b | 1715 | if (this.selPoints_.length > 0) { |
6a1aa64f | 1716 | // Set the status message to indicate the selected point(s) |
d160cc3b | 1717 | if (this.attr_('showLabelsOnHighlight')) { |
91c10d9c | 1718 | this.setLegendHTML_(this.lastx_, this.selPoints_); |
6a1aa64f | 1719 | } |
6a1aa64f | 1720 | |
6a1aa64f | 1721 | // Draw colored circles over the center of each selected point |
e9fe4a2f | 1722 | var canvasx = this.selPoints_[0].canvasx; |
43af96e7 | 1723 | ctx.save(); |
b258a3da | 1724 | for (var i = 0; i < this.selPoints_.length; i++) { |
e9fe4a2f DV |
1725 | var pt = this.selPoints_[i]; |
1726 | if (!Dygraph.isOK(pt.canvasy)) continue; | |
1727 | ||
1728 | var circleSize = this.attr_('highlightCircleSize', pt.name); | |
6a1aa64f | 1729 | ctx.beginPath(); |
e9fe4a2f DV |
1730 | ctx.fillStyle = this.plotter_.colors[pt.name]; |
1731 | ctx.arc(canvasx, pt.canvasy, circleSize, 0, 2 * Math.PI, false); | |
6a1aa64f DV |
1732 | ctx.fill(); |
1733 | } | |
1734 | ctx.restore(); | |
1735 | ||
1736 | this.previousVerticalX_ = canvasx; | |
1737 | } | |
1738 | }; | |
1739 | ||
1740 | /** | |
239c712d NAG |
1741 | * Set manually set selected dots, and display information about them |
1742 | * @param int row number that should by highlighted | |
1743 | * false value clears the selection | |
1744 | * @public | |
1745 | */ | |
1746 | Dygraph.prototype.setSelection = function(row) { | |
1747 | // Extract the points we've selected | |
1748 | this.selPoints_ = []; | |
1749 | var pos = 0; | |
50360fd0 | 1750 | |
239c712d | 1751 | if (row !== false) { |
16269f6e NAG |
1752 | row = row-this.boundaryIds_[0][0]; |
1753 | } | |
50360fd0 | 1754 | |
16269f6e | 1755 | if (row !== false && row >= 0) { |
239c712d | 1756 | for (var i in this.layout_.datasets) { |
16269f6e | 1757 | if (row < this.layout_.datasets[i].length) { |
38f33a44 | 1758 | var point = this.layout_.points[pos+row]; |
1759 | ||
1760 | if (this.attr_("stackedGraph")) { | |
8c03ba63 | 1761 | point = this.layout_.unstackPointAtIndex(pos+row); |
38f33a44 | 1762 | } |
1763 | ||
1764 | this.selPoints_.push(point); | |
16269f6e | 1765 | } |
239c712d NAG |
1766 | pos += this.layout_.datasets[i].length; |
1767 | } | |
16269f6e | 1768 | } |
50360fd0 | 1769 | |
16269f6e | 1770 | if (this.selPoints_.length) { |
239c712d NAG |
1771 | this.lastx_ = this.selPoints_[0].xval; |
1772 | this.updateSelection_(); | |
1773 | } else { | |
239c712d NAG |
1774 | this.clearSelection(); |
1775 | } | |
1776 | ||
1777 | }; | |
1778 | ||
1779 | /** | |
6a1aa64f DV |
1780 | * The mouse has left the canvas. Clear out whatever artifacts remain |
1781 | * @param {Object} event the mouseout event from the browser. | |
1782 | * @private | |
1783 | */ | |
285a6bda | 1784 | Dygraph.prototype.mouseOut_ = function(event) { |
a4c6a67c AV |
1785 | if (this.attr_("unhighlightCallback")) { |
1786 | this.attr_("unhighlightCallback")(event); | |
1787 | } | |
1788 | ||
43af96e7 | 1789 | if (this.attr_("hideOverlayOnMouseOut")) { |
239c712d | 1790 | this.clearSelection(); |
43af96e7 | 1791 | } |
6a1aa64f DV |
1792 | }; |
1793 | ||
239c712d NAG |
1794 | /** |
1795 | * Remove all selection from the canvas | |
1796 | * @public | |
1797 | */ | |
1798 | Dygraph.prototype.clearSelection = function() { | |
1799 | // Get rid of the overlay data | |
2cf95fff | 1800 | this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_); |
91c10d9c | 1801 | this.setLegendHTML_(); |
239c712d NAG |
1802 | this.selPoints_ = []; |
1803 | this.lastx_ = -1; | |
1804 | } | |
1805 | ||
103b7292 NAG |
1806 | /** |
1807 | * Returns the number of the currently selected row | |
1808 | * @return int row number, of -1 if nothing is selected | |
1809 | * @public | |
1810 | */ | |
1811 | Dygraph.prototype.getSelection = function() { | |
1812 | if (!this.selPoints_ || this.selPoints_.length < 1) { | |
1813 | return -1; | |
1814 | } | |
50360fd0 | 1815 | |
103b7292 NAG |
1816 | for (var row=0; row<this.layout_.points.length; row++ ) { |
1817 | if (this.layout_.points[row].x == this.selPoints_[0].x) { | |
16269f6e | 1818 | return row + this.boundaryIds_[0][0]; |
103b7292 NAG |
1819 | } |
1820 | } | |
1821 | return -1; | |
2e1fcf1a | 1822 | }; |
103b7292 | 1823 | |
19589a3e DV |
1824 | /** |
1825 | * Number formatting function which mimicks the behavior of %g in printf, i.e. | |
1826 | * either exponential or fixed format (without trailing 0s) is used depending on | |
1827 | * the length of the generated string. The advantage of this format is that | |
1828 | * there is a predictable upper bound on the resulting string length, | |
1829 | * significant figures are not dropped, and normal numbers are not displayed in | |
1830 | * exponential notation. | |
1831 | * | |
1832 | * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g. | |
1833 | * It creates strings which are too long for absolute values between 10^-4 and | |
1834 | * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for | |
1835 | * output examples. | |
1836 | * | |
1837 | * @param {Number} x The number to format | |
1838 | * @param {Number} opt_precision The precision to use, default 2. | |
1839 | * @return {String} A string formatted like %g in printf. The max generated | |
1840 | * string length should be precision + 6 (e.g 1.123e+300). | |
1841 | */ | |
1842 | Dygraph.floatFormat = function(x, opt_precision) { | |
1843 | // Avoid invalid precision values; [1, 21] is the valid range. | |
1844 | var p = Math.min(Math.max(1, opt_precision || 2), 21); | |
1845 | ||
1846 | // This is deceptively simple. The actual algorithm comes from: | |
1847 | // | |
1848 | // Max allowed length = p + 4 | |
1849 | // where 4 comes from 'e+n' and '.'. | |
1850 | // | |
1851 | // Length of fixed format = 2 + y + p | |
1852 | // where 2 comes from '0.' and y = # of leading zeroes. | |
1853 | // | |
1854 | // Equating the two and solving for y yields y = 2, or 0.00xxxx which is | |
1855 | // 1.0e-3. | |
1856 | // | |
1857 | // Since the behavior of toPrecision() is identical for larger numbers, we | |
1858 | // don't have to worry about the other bound. | |
1859 | // | |
1860 | // Finally, the argument for toExponential() is the number of trailing digits, | |
1861 | // so we take off 1 for the value before the '.'. | |
1862 | return (Math.abs(x) < 1.0e-3 && x != 0.0) ? | |
1863 | x.toExponential(p - 1) : x.toPrecision(p); | |
2e1fcf1a DV |
1864 | }; |
1865 | ||
1866 | /** | |
1867 | * Return a string version of a number. This respects the digitsAfterDecimal | |
1868 | * and maxNumberWidth options. | |
1869 | * @param {Number} x The number to be formatted | |
1870 | * @param {Dygraph} g The dygraph object | |
1871 | */ | |
1872 | Dygraph.numberFormatter = function(x, g) { | |
19589a3e DV |
1873 | var sigFigs = g.attr_('sigFigs'); |
1874 | ||
1875 | if (sigFigs !== null) { | |
1876 | // User has opted for a fixed number of significant figures. | |
1877 | return Dygraph.floatFormat(x, sigFigs); | |
1878 | } | |
1879 | ||
2e1fcf1a DV |
1880 | var digits = g.attr_('digitsAfterDecimal'); |
1881 | var maxNumberWidth = g.attr_('maxNumberWidth'); | |
1882 | ||
19589a3e DV |
1883 | // switch to scientific notation if we underflow or overflow fixed display. |
1884 | if (x !== 0.0 && | |
1885 | (Math.abs(x) >= Math.pow(10, maxNumberWidth) || | |
1886 | Math.abs(x) < Math.pow(10, -digits))) { | |
1887 | return x.toExponential(digits); | |
2e1fcf1a DV |
1888 | } else { |
1889 | return '' + Dygraph.round_(x, digits); | |
1890 | } | |
1891 | }; | |
32988383 | 1892 | |
19589a3e DV |
1893 | Dygraph.zeropad = function(x) { |
1894 | if (x < 10) return "0" + x; else return "" + x; | |
1895 | }; | |
1896 | ||
6a1aa64f | 1897 | /** |
6b8e33dd DV |
1898 | * Return a string version of the hours, minutes and seconds portion of a date. |
1899 | * @param {Number} date The JavaScript date (ms since epoch) | |
1900 | * @return {String} A time of the form "HH:MM:SS" | |
1901 | * @private | |
1902 | */ | |
bf640e56 | 1903 | Dygraph.hmsString_ = function(date) { |
285a6bda | 1904 | var zeropad = Dygraph.zeropad; |
6b8e33dd DV |
1905 | var d = new Date(date); |
1906 | if (d.getSeconds()) { | |
1907 | return zeropad(d.getHours()) + ":" + | |
1908 | zeropad(d.getMinutes()) + ":" + | |
1909 | zeropad(d.getSeconds()); | |
6b8e33dd | 1910 | } else { |
054531ca | 1911 | return zeropad(d.getHours()) + ":" + zeropad(d.getMinutes()); |
6b8e33dd | 1912 | } |
2e1fcf1a | 1913 | }; |
6b8e33dd DV |
1914 | |
1915 | /** | |
bf640e56 AV |
1916 | * Convert a JS date to a string appropriate to display on an axis that |
1917 | * is displaying values at the stated granularity. | |
1918 | * @param {Date} date The date to format | |
1919 | * @param {Number} granularity One of the Dygraph granularity constants | |
1920 | * @return {String} The formatted date | |
1921 | * @private | |
1922 | */ | |
1923 | Dygraph.dateAxisFormatter = function(date, granularity) { | |
062ef401 JB |
1924 | if (granularity >= Dygraph.DECADAL) { |
1925 | return date.strftime('%Y'); | |
1926 | } else if (granularity >= Dygraph.MONTHLY) { | |
bf640e56 AV |
1927 | return date.strftime('%b %y'); |
1928 | } else { | |
31eddad3 | 1929 | var frac = date.getHours() * 3600 + date.getMinutes() * 60 + date.getSeconds() + date.getMilliseconds(); |
bf640e56 AV |
1930 | if (frac == 0 || granularity >= Dygraph.DAILY) { |
1931 | return new Date(date.getTime() + 3600*1000).strftime('%d%b'); | |
1932 | } else { | |
1933 | return Dygraph.hmsString_(date.getTime()); | |
1934 | } | |
1935 | } | |
2e1fcf1a | 1936 | }; |
bf640e56 AV |
1937 | |
1938 | /** | |
6a1aa64f DV |
1939 | * Convert a JS date (millis since epoch) to YYYY/MM/DD |
1940 | * @param {Number} date The JavaScript date (ms since epoch) | |
1941 | * @return {String} A date of the form "YYYY/MM/DD" | |
1942 | * @private | |
1943 | */ | |
6be8e54c | 1944 | Dygraph.dateString_ = function(date) { |
285a6bda | 1945 | var zeropad = Dygraph.zeropad; |
6a1aa64f DV |
1946 | var d = new Date(date); |
1947 | ||
1948 | // Get the year: | |
1949 | var year = "" + d.getFullYear(); | |
1950 | // Get a 0 padded month string | |
6b8e33dd | 1951 | var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh |
6a1aa64f | 1952 | // Get a 0 padded day string |
6b8e33dd | 1953 | var day = zeropad(d.getDate()); |
6a1aa64f | 1954 | |
6b8e33dd DV |
1955 | var ret = ""; |
1956 | var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds(); | |
bf640e56 | 1957 | if (frac) ret = " " + Dygraph.hmsString_(date); |
6b8e33dd DV |
1958 | |
1959 | return year + "/" + month + "/" + day + ret; | |
6a1aa64f DV |
1960 | }; |
1961 | ||
1962 | /** | |
032e4c1d DV |
1963 | * Round a number to the specified number of digits past the decimal point. |
1964 | * @param {Number} num The number to round | |
1965 | * @param {Number} places The number of decimals to which to round | |
1966 | * @return {Number} The rounded number | |
1967 | * @private | |
1968 | */ | |
1969 | Dygraph.round_ = function(num, places) { | |
1970 | var shift = Math.pow(10, places); | |
1971 | return Math.round(num * shift)/shift; | |
1972 | }; | |
1973 | ||
1974 | /** | |
6a1aa64f DV |
1975 | * Fires when there's data available to be graphed. |
1976 | * @param {String} data Raw CSV data to be plotted | |
1977 | * @private | |
1978 | */ | |
285a6bda | 1979 | Dygraph.prototype.loadedEvent_ = function(data) { |
6a1aa64f | 1980 | this.rawData_ = this.parseCSV_(data); |
26ca7938 | 1981 | this.predraw_(); |
6a1aa64f DV |
1982 | }; |
1983 | ||
285a6bda | 1984 | Dygraph.prototype.months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", |
8846615a | 1985 | "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]; |
285a6bda | 1986 | Dygraph.prototype.quarters = ["Jan", "Apr", "Jul", "Oct"]; |
6a1aa64f DV |
1987 | |
1988 | /** | |
1989 | * Add ticks on the x-axis representing years, months, quarters, weeks, or days | |
1990 | * @private | |
1991 | */ | |
285a6bda | 1992 | Dygraph.prototype.addXTicks_ = function() { |
6a1aa64f | 1993 | // Determine the correct ticks scale on the x-axis: quarterly, monthly, ... |
7201b11e | 1994 | var range; |
6a1aa64f | 1995 | if (this.dateWindow_) { |
7201b11e | 1996 | range = [this.dateWindow_[0], this.dateWindow_[1]]; |
6a1aa64f | 1997 | } else { |
7201b11e JB |
1998 | range = [this.rawData_[0][0], this.rawData_[this.rawData_.length - 1][0]]; |
1999 | } | |
2000 | ||
032e4c1d | 2001 | var xTicks = this.attr_('xTicker')(range[0], range[1], this); |
7201b11e | 2002 | this.layout_.updateOptions({xTicks: xTicks}); |
32988383 DV |
2003 | }; |
2004 | ||
2005 | // Time granularity enumeration | |
285a6bda | 2006 | Dygraph.SECONDLY = 0; |
20a41c17 DV |
2007 | Dygraph.TWO_SECONDLY = 1; |
2008 | Dygraph.FIVE_SECONDLY = 2; | |
2009 | Dygraph.TEN_SECONDLY = 3; | |
2010 | Dygraph.THIRTY_SECONDLY = 4; | |
2011 | Dygraph.MINUTELY = 5; | |
2012 | Dygraph.TWO_MINUTELY = 6; | |
2013 | Dygraph.FIVE_MINUTELY = 7; | |
2014 | Dygraph.TEN_MINUTELY = 8; | |
2015 | Dygraph.THIRTY_MINUTELY = 9; | |
2016 | Dygraph.HOURLY = 10; | |
2017 | Dygraph.TWO_HOURLY = 11; | |
2018 | Dygraph.SIX_HOURLY = 12; | |
2019 | Dygraph.DAILY = 13; | |
2020 | Dygraph.WEEKLY = 14; | |
2021 | Dygraph.MONTHLY = 15; | |
2022 | Dygraph.QUARTERLY = 16; | |
2023 | Dygraph.BIANNUAL = 17; | |
2024 | Dygraph.ANNUAL = 18; | |
2025 | Dygraph.DECADAL = 19; | |
062ef401 JB |
2026 | Dygraph.CENTENNIAL = 20; |
2027 | Dygraph.NUM_GRANULARITIES = 21; | |
285a6bda DV |
2028 | |
2029 | Dygraph.SHORT_SPACINGS = []; | |
2030 | Dygraph.SHORT_SPACINGS[Dygraph.SECONDLY] = 1000 * 1; | |
20a41c17 DV |
2031 | Dygraph.SHORT_SPACINGS[Dygraph.TWO_SECONDLY] = 1000 * 2; |
2032 | Dygraph.SHORT_SPACINGS[Dygraph.FIVE_SECONDLY] = 1000 * 5; | |
285a6bda DV |
2033 | Dygraph.SHORT_SPACINGS[Dygraph.TEN_SECONDLY] = 1000 * 10; |
2034 | Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_SECONDLY] = 1000 * 30; | |
2035 | Dygraph.SHORT_SPACINGS[Dygraph.MINUTELY] = 1000 * 60; | |
20a41c17 DV |
2036 | Dygraph.SHORT_SPACINGS[Dygraph.TWO_MINUTELY] = 1000 * 60 * 2; |
2037 | Dygraph.SHORT_SPACINGS[Dygraph.FIVE_MINUTELY] = 1000 * 60 * 5; | |
285a6bda DV |
2038 | Dygraph.SHORT_SPACINGS[Dygraph.TEN_MINUTELY] = 1000 * 60 * 10; |
2039 | Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_MINUTELY] = 1000 * 60 * 30; | |
2040 | Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600; | |
20a41c17 | 2041 | Dygraph.SHORT_SPACINGS[Dygraph.TWO_HOURLY] = 1000 * 3600 * 2; |
805d5519 | 2042 | Dygraph.SHORT_SPACINGS[Dygraph.SIX_HOURLY] = 1000 * 3600 * 6; |
285a6bda DV |
2043 | Dygraph.SHORT_SPACINGS[Dygraph.DAILY] = 1000 * 86400; |
2044 | Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY] = 1000 * 604800; | |
32988383 DV |
2045 | |
2046 | // NumXTicks() | |
2047 | // | |
2048 | // If we used this time granularity, how many ticks would there be? | |
2049 | // This is only an approximation, but it's generally good enough. | |
2050 | // | |
285a6bda DV |
2051 | Dygraph.prototype.NumXTicks = function(start_time, end_time, granularity) { |
2052 | if (granularity < Dygraph.MONTHLY) { | |
32988383 | 2053 | // Generate one tick mark for every fixed interval of time. |
285a6bda | 2054 | var spacing = Dygraph.SHORT_SPACINGS[granularity]; |
32988383 DV |
2055 | return Math.floor(0.5 + 1.0 * (end_time - start_time) / spacing); |
2056 | } else { | |
2057 | var year_mod = 1; // e.g. to only print one point every 10 years. | |
2058 | var num_months = 12; | |
285a6bda DV |
2059 | if (granularity == Dygraph.QUARTERLY) num_months = 3; |
2060 | if (granularity == Dygraph.BIANNUAL) num_months = 2; | |
2061 | if (granularity == Dygraph.ANNUAL) num_months = 1; | |
2062 | if (granularity == Dygraph.DECADAL) { num_months = 1; year_mod = 10; } | |
062ef401 | 2063 | if (granularity == Dygraph.CENTENNIAL) { num_months = 1; year_mod = 100; } |
32988383 DV |
2064 | |
2065 | var msInYear = 365.2524 * 24 * 3600 * 1000; | |
2066 | var num_years = 1.0 * (end_time - start_time) / msInYear; | |
2067 | return Math.floor(0.5 + 1.0 * num_years * num_months / year_mod); | |
2068 | } | |
2069 | }; | |
2070 | ||
2071 | // GetXAxis() | |
2072 | // | |
2073 | // Construct an x-axis of nicely-formatted times on meaningful boundaries | |
2074 | // (e.g. 'Jan 09' rather than 'Jan 22, 2009'). | |
2075 | // | |
2076 | // Returns an array containing {v: millis, label: label} dictionaries. | |
2077 | // | |
285a6bda | 2078 | Dygraph.prototype.GetXAxis = function(start_time, end_time, granularity) { |
bf640e56 | 2079 | var formatter = this.attr_("xAxisLabelFormatter"); |
32988383 | 2080 | var ticks = []; |
285a6bda | 2081 | if (granularity < Dygraph.MONTHLY) { |
32988383 | 2082 | // Generate one tick mark for every fixed interval of time. |
285a6bda | 2083 | var spacing = Dygraph.SHORT_SPACINGS[granularity]; |
3d29302c | 2084 | var format = '%d%b'; // e.g. "1Jan" |
076c9622 DV |
2085 | |
2086 | // Find a time less than start_time which occurs on a "nice" time boundary | |
2087 | // for this granularity. | |
2088 | var g = spacing / 1000; | |
076c9622 DV |
2089 | var d = new Date(start_time); |
2090 | if (g <= 60) { // seconds | |
2091 | var x = d.getSeconds(); d.setSeconds(x - x % g); | |
2092 | } else { | |
2093 | d.setSeconds(0); | |
2094 | g /= 60; | |
2095 | if (g <= 60) { // minutes | |
2096 | var x = d.getMinutes(); d.setMinutes(x - x % g); | |
2097 | } else { | |
2098 | d.setMinutes(0); | |
2099 | g /= 60; | |
2100 | ||
2101 | if (g <= 24) { // days | |
2102 | var x = d.getHours(); d.setHours(x - x % g); | |
2103 | } else { | |
2104 | d.setHours(0); | |
2105 | g /= 24; | |
2106 | ||
2107 | if (g == 7) { // one week | |
20a41c17 | 2108 | d.setDate(d.getDate() - d.getDay()); |
076c9622 DV |
2109 | } |
2110 | } | |
2111 | } | |
328bb812 | 2112 | } |
076c9622 DV |
2113 | start_time = d.getTime(); |
2114 | ||
32988383 | 2115 | for (var t = start_time; t <= end_time; t += spacing) { |
bf640e56 | 2116 | ticks.push({ v:t, label: formatter(new Date(t), granularity) }); |
32988383 DV |
2117 | } |
2118 | } else { | |
2119 | // Display a tick mark on the first of a set of months of each year. | |
2120 | // Years get a tick mark iff y % year_mod == 0. This is useful for | |
2121 | // displaying a tick mark once every 10 years, say, on long time scales. | |
2122 | var months; | |
2123 | var year_mod = 1; // e.g. to only print one point every 10 years. | |
2124 | ||
285a6bda | 2125 | if (granularity == Dygraph.MONTHLY) { |
32988383 | 2126 | months = [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; |
285a6bda | 2127 | } else if (granularity == Dygraph.QUARTERLY) { |
32988383 | 2128 | months = [ 0, 3, 6, 9 ]; |
285a6bda | 2129 | } else if (granularity == Dygraph.BIANNUAL) { |
32988383 | 2130 | months = [ 0, 6 ]; |
285a6bda | 2131 | } else if (granularity == Dygraph.ANNUAL) { |
32988383 | 2132 | months = [ 0 ]; |
285a6bda | 2133 | } else if (granularity == Dygraph.DECADAL) { |
32988383 DV |
2134 | months = [ 0 ]; |
2135 | year_mod = 10; | |
062ef401 JB |
2136 | } else if (granularity == Dygraph.CENTENNIAL) { |
2137 | months = [ 0 ]; | |
2138 | year_mod = 100; | |
2139 | } else { | |
2140 | this.warn("Span of dates is too long"); | |
32988383 DV |
2141 | } |
2142 | ||
2143 | var start_year = new Date(start_time).getFullYear(); | |
2144 | var end_year = new Date(end_time).getFullYear(); | |
285a6bda | 2145 | var zeropad = Dygraph.zeropad; |
32988383 DV |
2146 | for (var i = start_year; i <= end_year; i++) { |
2147 | if (i % year_mod != 0) continue; | |
2148 | for (var j = 0; j < months.length; j++) { | |
2149 | var date_str = i + "/" + zeropad(1 + months[j]) + "/01"; | |
d96b7d1a | 2150 | var t = Dygraph.dateStrToMillis(date_str); |
32988383 | 2151 | if (t < start_time || t > end_time) continue; |
bf640e56 | 2152 | ticks.push({ v:t, label: formatter(new Date(t), granularity) }); |
32988383 DV |
2153 | } |
2154 | } | |
2155 | } | |
2156 | ||
2157 | return ticks; | |
2158 | }; | |
2159 | ||
6a1aa64f DV |
2160 | |
2161 | /** | |
2162 | * Add ticks to the x-axis based on a date range. | |
2163 | * @param {Number} startDate Start of the date window (millis since epoch) | |
2164 | * @param {Number} endDate End of the date window (millis since epoch) | |
2165 | * @return {Array.<Object>} Array of {label, value} tuples. | |
2166 | * @public | |
2167 | */ | |
285a6bda | 2168 | Dygraph.dateTicker = function(startDate, endDate, self) { |
32988383 | 2169 | var chosen = -1; |
285a6bda DV |
2170 | for (var i = 0; i < Dygraph.NUM_GRANULARITIES; i++) { |
2171 | var num_ticks = self.NumXTicks(startDate, endDate, i); | |
2172 | if (self.width_ / num_ticks >= self.attr_('pixelsPerXLabel')) { | |
32988383 DV |
2173 | chosen = i; |
2174 | break; | |
2769de62 | 2175 | } |
6a1aa64f DV |
2176 | } |
2177 | ||
32988383 | 2178 | if (chosen >= 0) { |
285a6bda | 2179 | return self.GetXAxis(startDate, endDate, chosen); |
6a1aa64f | 2180 | } else { |
32988383 | 2181 | // TODO(danvk): signal error. |
6a1aa64f | 2182 | } |
6a1aa64f DV |
2183 | }; |
2184 | ||
c1bc242a DV |
2185 | // This is a list of human-friendly values at which to show tick marks on a log |
2186 | // scale. It is k * 10^n, where k=1..9 and n=-39..+39, so: | |
2187 | // ..., 1, 2, 3, 4, 5, ..., 9, 10, 20, 30, ..., 90, 100, 200, 300, ... | |
5db0e241 | 2188 | // NOTE: this assumes that Dygraph.LOG_SCALE = 10. |
0cfa06d1 | 2189 | Dygraph.PREFERRED_LOG_TICK_VALUES = function() { |
6821efbe RK |
2190 | var vals = []; |
2191 | for (var power = -39; power <= 39; power++) { | |
2192 | var range = Math.pow(10, power); | |
4b467120 RK |
2193 | for (var mult = 1; mult <= 9; mult++) { |
2194 | var val = range * mult; | |
6821efbe RK |
2195 | vals.push(val); |
2196 | } | |
2197 | } | |
2198 | return vals; | |
2199 | }(); | |
2200 | ||
0cfa06d1 RK |
2201 | // val is the value to search for |
2202 | // arry is the value over which to search | |
2203 | // if abs > 0, find the lowest entry greater than val | |
2204 | // if abs < 0, find the highest entry less than val | |
2205 | // if abs == 0, find the entry that equals val. | |
2206 | // Currently does not work when val is outside the range of arry's values. | |
2207 | Dygraph.binarySearch = function(val, arry, abs, low, high) { | |
2208 | if (low == null || high == null) { | |
2209 | low = 0; | |
2210 | high = arry.length - 1; | |
2211 | } | |
2212 | if (low > high) { | |
2213 | return -1; | |
2214 | } | |
2215 | if (abs == null) { | |
2216 | abs = 0; | |
2217 | } | |
2218 | var validIndex = function(idx) { | |
2219 | return idx >= 0 && idx < arry.length; | |
2220 | } | |
2221 | var mid = parseInt((low + high) / 2); | |
2222 | var element = arry[mid]; | |
2223 | if (element == val) { | |
2224 | return mid; | |
2225 | } | |
2226 | if (element > val) { | |
2227 | if (abs > 0) { | |
2228 | // Accept if element > val, but also if prior element < val. | |
2229 | var idx = mid - 1; | |
2230 | if (validIndex(idx) && arry[idx] < val) { | |
2231 | return mid; | |
2232 | } | |
2233 | } | |
c1bc242a | 2234 | return Dygraph.binarySearch(val, arry, abs, low, mid - 1); |
0cfa06d1 RK |
2235 | } |
2236 | if (element < val) { | |
2237 | if (abs < 0) { | |
2238 | // Accept if element < val, but also if prior element > val. | |
2239 | var idx = mid + 1; | |
2240 | if (validIndex(idx) && arry[idx] > val) { | |
2241 | return mid; | |
2242 | } | |
2243 | } | |
2244 | return Dygraph.binarySearch(val, arry, abs, mid + 1, high); | |
2245 | } | |
60a19014 | 2246 | }; |
0cfa06d1 | 2247 | |
6a1aa64f DV |
2248 | /** |
2249 | * Add ticks when the x axis has numbers on it (instead of dates) | |
ff022deb RK |
2250 | * TODO(konigsberg): Update comment. |
2251 | * | |
7d0e7a0d RK |
2252 | * @param {Number} minV minimum value |
2253 | * @param {Number} maxV maximum value | |
84fc6aa7 | 2254 | * @param self |
f30cf740 | 2255 | * @param {function} attribute accessor function. |
6a1aa64f DV |
2256 | * @return {Array.<Object>} Array of {label, value} tuples. |
2257 | * @public | |
2258 | */ | |
0d64e596 | 2259 | Dygraph.numericTicks = function(minV, maxV, self, axis_props, vals) { |
70c80071 DV |
2260 | var attr = function(k) { |
2261 | if (axis_props && axis_props.hasOwnProperty(k)) return axis_props[k]; | |
2262 | return self.attr_(k); | |
2263 | }; | |
f09fc545 | 2264 | |
0d64e596 DV |
2265 | var ticks = []; |
2266 | if (vals) { | |
2267 | for (var i = 0; i < vals.length; i++) { | |
e863a17d | 2268 | ticks.push({v: vals[i]}); |
0d64e596 | 2269 | } |
f09e46d4 | 2270 | } else { |
7d0e7a0d | 2271 | if (axis_props && attr("logscale")) { |
ff022deb | 2272 | var pixelsPerTick = attr('pixelsPerYLabel'); |
7d0e7a0d | 2273 | // NOTE(konigsberg): Dan, should self.height_ be self.plotter_.area.h? |
ff022deb | 2274 | var nTicks = Math.floor(self.height_ / pixelsPerTick); |
0cfa06d1 RK |
2275 | var minIdx = Dygraph.binarySearch(minV, Dygraph.PREFERRED_LOG_TICK_VALUES, 1); |
2276 | var maxIdx = Dygraph.binarySearch(maxV, Dygraph.PREFERRED_LOG_TICK_VALUES, -1); | |
2277 | if (minIdx == -1) { | |
6821efbe RK |
2278 | minIdx = 0; |
2279 | } | |
0cfa06d1 RK |
2280 | if (maxIdx == -1) { |
2281 | maxIdx = Dygraph.PREFERRED_LOG_TICK_VALUES.length - 1; | |
6821efbe | 2282 | } |
0cfa06d1 RK |
2283 | // Count the number of tick values would appear, if we can get at least |
2284 | // nTicks / 4 accept them. | |
00aa7f61 | 2285 | var lastDisplayed = null; |
0cfa06d1 | 2286 | if (maxIdx - minIdx >= nTicks / 4) { |
00aa7f61 | 2287 | var axisId = axis_props.yAxisId; |
0cfa06d1 RK |
2288 | for (var idx = maxIdx; idx >= minIdx; idx--) { |
2289 | var tickValue = Dygraph.PREFERRED_LOG_TICK_VALUES[idx]; | |
00aa7f61 RK |
2290 | var domCoord = axis_props.g.toDomYCoord(tickValue, axisId); |
2291 | var tick = { v: tickValue }; | |
2292 | if (lastDisplayed == null) { | |
2293 | lastDisplayed = { | |
2294 | tickValue : tickValue, | |
2295 | domCoord : domCoord | |
2296 | }; | |
2297 | } else { | |
2298 | if (domCoord - lastDisplayed.domCoord >= pixelsPerTick) { | |
2299 | lastDisplayed = { | |
2300 | tickValue : tickValue, | |
2301 | domCoord : domCoord | |
2302 | }; | |
2303 | } else { | |
c1bc242a | 2304 | tick.label = ""; |
00aa7f61 RK |
2305 | } |
2306 | } | |
2307 | ticks.push(tick); | |
6821efbe | 2308 | } |
0cfa06d1 RK |
2309 | // Since we went in backwards order. |
2310 | ticks.reverse(); | |
6821efbe | 2311 | } |
f09e46d4 | 2312 | } |
c1bc242a | 2313 | |
6821efbe RK |
2314 | // ticks.length won't be 0 if the log scale function finds values to insert. |
2315 | if (ticks.length == 0) { | |
ff022deb RK |
2316 | // Basic idea: |
2317 | // Try labels every 1, 2, 5, 10, 20, 50, 100, etc. | |
2318 | // Calculate the resulting tick spacing (i.e. this.height_ / nTicks). | |
2319 | // The first spacing greater than pixelsPerYLabel is what we use. | |
2320 | // TODO(danvk): version that works on a log scale. | |
0d64e596 | 2321 | if (attr("labelsKMG2")) { |
ff022deb | 2322 | var mults = [1, 2, 4, 8]; |
0d64e596 | 2323 | } else { |
ff022deb | 2324 | var mults = [1, 2, 5]; |
0d64e596 | 2325 | } |
ff022deb RK |
2326 | var scale, low_val, high_val, nTicks; |
2327 | // TODO(danvk): make it possible to set this for x- and y-axes independently. | |
2328 | var pixelsPerTick = attr('pixelsPerYLabel'); | |
2329 | for (var i = -10; i < 50; i++) { | |
2330 | if (attr("labelsKMG2")) { | |
2331 | var base_scale = Math.pow(16, i); | |
2332 | } else { | |
2333 | var base_scale = Math.pow(10, i); | |
2334 | } | |
2335 | for (var j = 0; j < mults.length; j++) { | |
2336 | scale = base_scale * mults[j]; | |
2337 | low_val = Math.floor(minV / scale) * scale; | |
2338 | high_val = Math.ceil(maxV / scale) * scale; | |
2339 | nTicks = Math.abs(high_val - low_val) / scale; | |
2340 | var spacing = self.height_ / nTicks; | |
2341 | // wish I could break out of both loops at once... | |
2342 | if (spacing > pixelsPerTick) break; | |
2343 | } | |
0d64e596 DV |
2344 | if (spacing > pixelsPerTick) break; |
2345 | } | |
0d64e596 | 2346 | |
ff022deb RK |
2347 | // Construct the set of ticks. |
2348 | // Allow reverse y-axis if it's explicitly requested. | |
2349 | if (low_val > high_val) scale *= -1; | |
2350 | for (var i = 0; i < nTicks; i++) { | |
2351 | var tickV = low_val + i * scale; | |
2352 | ticks.push( {v: tickV} ); | |
2353 | } | |
0d64e596 | 2354 | } |
6a1aa64f DV |
2355 | } |
2356 | ||
0d64e596 | 2357 | // Add formatted labels to the ticks. |
ed11be50 DV |
2358 | var k; |
2359 | var k_labels = []; | |
f09fc545 | 2360 | if (attr("labelsKMB")) { |
ed11be50 DV |
2361 | k = 1000; |
2362 | k_labels = [ "K", "M", "B", "T" ]; | |
2363 | } | |
f09fc545 | 2364 | if (attr("labelsKMG2")) { |
ed11be50 DV |
2365 | if (k) self.warn("Setting both labelsKMB and labelsKMG2. Pick one!"); |
2366 | k = 1024; | |
2367 | k_labels = [ "k", "M", "G", "T" ]; | |
2368 | } | |
3c1d225b JB |
2369 | var formatter = attr('yAxisLabelFormatter') ? |
2370 | attr('yAxisLabelFormatter') : attr('yValueFormatter'); | |
2371 | ||
0cfa06d1 | 2372 | // Add labels to the ticks. |
0d64e596 | 2373 | for (var i = 0; i < ticks.length; i++) { |
e863a17d | 2374 | if (ticks[i].label !== undefined) continue; // Use current label. |
0d64e596 | 2375 | var tickV = ticks[i].v; |
0af6e346 | 2376 | var absTickV = Math.abs(tickV); |
2e1fcf1a | 2377 | var label = formatter(tickV, self); |
3c1d225b | 2378 | if (k_labels.length > 0) { |
ed11be50 DV |
2379 | // Round up to an appropriate unit. |
2380 | var n = k*k*k*k; | |
2381 | for (var j = 3; j >= 0; j--, n /= k) { | |
2382 | if (absTickV >= n) { | |
17d0210c | 2383 | label = Dygraph.round_(tickV / n, attr('digitsAfterDecimal')) + k_labels[j]; |
ed11be50 DV |
2384 | break; |
2385 | } | |
afefbcdb | 2386 | } |
6a1aa64f | 2387 | } |
d916677a | 2388 | ticks[i].label = label; |
6a1aa64f | 2389 | } |
d916677a | 2390 | |
032e4c1d | 2391 | return ticks; |
6a1aa64f DV |
2392 | }; |
2393 | ||
5011e7a1 DV |
2394 | // Computes the range of the data series (including confidence intervals). |
2395 | // series is either [ [x1, y1], [x2, y2], ... ] or | |
2396 | // [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ... | |
2397 | // Returns [low, high] | |
2398 | Dygraph.prototype.extremeValues_ = function(series) { | |
2399 | var minY = null, maxY = null; | |
2400 | ||
9922b78b | 2401 | var bars = this.attr_("errorBars") || this.attr_("customBars"); |
5011e7a1 DV |
2402 | if (bars) { |
2403 | // With custom bars, maxY is the max of the high values. | |
2404 | for (var j = 0; j < series.length; j++) { | |
2405 | var y = series[j][1][0]; | |
2406 | if (!y) continue; | |
2407 | var low = y - series[j][1][1]; | |
2408 | var high = y + series[j][1][2]; | |
2409 | if (low > y) low = y; // this can happen with custom bars, | |
2410 | if (high < y) high = y; // e.g. in tests/custom-bars.html | |
2411 | if (maxY == null || high > maxY) { | |
2412 | maxY = high; | |
2413 | } | |
2414 | if (minY == null || low < minY) { | |
2415 | minY = low; | |
2416 | } | |
2417 | } | |
2418 | } else { | |
2419 | for (var j = 0; j < series.length; j++) { | |
2420 | var y = series[j][1]; | |
d12999d3 | 2421 | if (y === null || isNaN(y)) continue; |
5011e7a1 DV |
2422 | if (maxY == null || y > maxY) { |
2423 | maxY = y; | |
2424 | } | |
2425 | if (minY == null || y < minY) { | |
2426 | minY = y; | |
2427 | } | |
2428 | } | |
2429 | } | |
2430 | ||
2431 | return [minY, maxY]; | |
2432 | }; | |
2433 | ||
6a1aa64f | 2434 | /** |
26ca7938 DV |
2435 | * This function is called once when the chart's data is changed or the options |
2436 | * dictionary is updated. It is _not_ called when the user pans or zooms. The | |
2437 | * idea is that values derived from the chart's data can be computed here, | |
2438 | * rather than every time the chart is drawn. This includes things like the | |
2439 | * number of axes, rolling averages, etc. | |
2440 | */ | |
2441 | Dygraph.prototype.predraw_ = function() { | |
2442 | // TODO(danvk): move more computations out of drawGraph_ and into here. | |
2443 | this.computeYAxes_(); | |
2444 | ||
2445 | // Create a new plotter. | |
70c80071 | 2446 | if (this.plotter_) this.plotter_.clear(); |
26ca7938 | 2447 | this.plotter_ = new DygraphCanvasRenderer(this, |
2cf95fff RK |
2448 | this.hidden_, |
2449 | this.hidden_ctx_, | |
2450 | this.layout_, | |
26ca7938 DV |
2451 | this.renderOptions_); |
2452 | ||
0abfbd7e DV |
2453 | // The roller sits in the bottom left corner of the chart. We don't know where |
2454 | // this will be until the options are available, so it's positioned here. | |
8c69de65 | 2455 | this.createRollInterface_(); |
26ca7938 | 2456 | |
0abfbd7e DV |
2457 | // Same thing applies for the labelsDiv. It's right edge should be flush with |
2458 | // the right edge of the charting area (which may not be the same as the right | |
2459 | // edge of the div, if we have two y-axes. | |
2460 | this.positionLabelsDiv_(); | |
2461 | ||
26ca7938 DV |
2462 | // If the data or options have changed, then we'd better redraw. |
2463 | this.drawGraph_(); | |
2464 | }; | |
2465 | ||
2466 | /** | |
2467 | * Update the graph with new data. This method is called when the viewing area | |
2468 | * has changed. If the underlying data or options have changed, predraw_ will | |
2469 | * be called before drawGraph_ is called. | |
6a1aa64f DV |
2470 | * @private |
2471 | */ | |
26ca7938 DV |
2472 | Dygraph.prototype.drawGraph_ = function() { |
2473 | var data = this.rawData_; | |
2474 | ||
fe0b7c03 DV |
2475 | // This is used to set the second parameter to drawCallback, below. |
2476 | var is_initial_draw = this.is_initial_draw_; | |
2477 | this.is_initial_draw_ = false; | |
2478 | ||
3bd9c228 | 2479 | var minY = null, maxY = null; |
6a1aa64f | 2480 | this.layout_.removeAllDatasets(); |
285a6bda | 2481 | this.setColors_(); |
9317362d | 2482 | this.attrs_['pointSize'] = 0.5 * this.attr_('highlightCircleSize'); |
285a6bda | 2483 | |
354e15ab DE |
2484 | // Loop over the fields (series). Go from the last to the first, |
2485 | // because if they're stacked that's how we accumulate the values. | |
43af96e7 | 2486 | |
354e15ab DE |
2487 | var cumulative_y = []; // For stacked series. |
2488 | var datasets = []; | |
2489 | ||
f09fc545 DV |
2490 | var extremes = {}; // series name -> [low, high] |
2491 | ||
354e15ab DE |
2492 | // Loop over all fields and create datasets |
2493 | for (var i = data[0].length - 1; i >= 1; i--) { | |
1cf11047 DV |
2494 | if (!this.visibility()[i - 1]) continue; |
2495 | ||
f09fc545 | 2496 | var seriesName = this.attr_("labels")[i]; |
450fe64b | 2497 | var connectSeparatedPoints = this.attr_('connectSeparatedPoints', i); |
6e6a2b0a | 2498 | var logScale = this.attr_('logscale', i); |
450fe64b | 2499 | |
6a1aa64f DV |
2500 | var series = []; |
2501 | for (var j = 0; j < data.length; j++) { | |
6e6a2b0a RK |
2502 | var date = data[j][0]; |
2503 | var point = data[j][i]; | |
2504 | if (logScale) { | |
2505 | // On the log scale, points less than zero do not exist. | |
2506 | // This will create a gap in the chart. Note that this ignores | |
2507 | // connectSeparatedPoints. | |
e863a17d | 2508 | if (point <= 0) { |
6e6a2b0a RK |
2509 | point = null; |
2510 | } | |
2511 | series.push([date, point]); | |
2512 | } else { | |
2513 | if (point != null || !connectSeparatedPoints) { | |
2514 | series.push([date, point]); | |
2515 | } | |
f032c51d | 2516 | } |
6a1aa64f | 2517 | } |
2f5e7e1a DV |
2518 | |
2519 | // TODO(danvk): move this into predraw_. It's insane to do it here. | |
6a1aa64f DV |
2520 | series = this.rollingAverage(series, this.rollPeriod_); |
2521 | ||
2522 | // Prune down to the desired range, if necessary (for zooming) | |
1a26f3fb DV |
2523 | // Because there can be lines going to points outside of the visible area, |
2524 | // we actually prune to visible points, plus one on either side. | |
9922b78b | 2525 | var bars = this.attr_("errorBars") || this.attr_("customBars"); |
6a1aa64f DV |
2526 | if (this.dateWindow_) { |
2527 | var low = this.dateWindow_[0]; | |
2528 | var high= this.dateWindow_[1]; | |
2529 | var pruned = []; | |
1a26f3fb DV |
2530 | // TODO(danvk): do binary search instead of linear search. |
2531 | // TODO(danvk): pass firstIdx and lastIdx directly to the renderer. | |
2532 | var firstIdx = null, lastIdx = null; | |
6a1aa64f | 2533 | for (var k = 0; k < series.length; k++) { |
1a26f3fb DV |
2534 | if (series[k][0] >= low && firstIdx === null) { |
2535 | firstIdx = k; | |
2536 | } | |
2537 | if (series[k][0] <= high) { | |
2538 | lastIdx = k; | |
6a1aa64f DV |
2539 | } |
2540 | } | |
1a26f3fb DV |
2541 | if (firstIdx === null) firstIdx = 0; |
2542 | if (firstIdx > 0) firstIdx--; | |
2543 | if (lastIdx === null) lastIdx = series.length - 1; | |
2544 | if (lastIdx < series.length - 1) lastIdx++; | |
16269f6e | 2545 | this.boundaryIds_[i-1] = [firstIdx, lastIdx]; |
1a26f3fb DV |
2546 | for (var k = firstIdx; k <= lastIdx; k++) { |
2547 | pruned.push(series[k]); | |
6a1aa64f DV |
2548 | } |
2549 | series = pruned; | |
16269f6e NAG |
2550 | } else { |
2551 | this.boundaryIds_[i-1] = [0, series.length-1]; | |
6a1aa64f DV |
2552 | } |
2553 | ||
f09fc545 | 2554 | var seriesExtremes = this.extremeValues_(series); |
5011e7a1 | 2555 | |
6a1aa64f | 2556 | if (bars) { |
354e15ab DE |
2557 | for (var j=0; j<series.length; j++) { |
2558 | val = [series[j][0], series[j][1][0], series[j][1][1], series[j][1][2]]; | |
2559 | series[j] = val; | |
2560 | } | |
43af96e7 | 2561 | } else if (this.attr_("stackedGraph")) { |
43af96e7 NK |
2562 | var l = series.length; |
2563 | var actual_y; | |
2564 | for (var j = 0; j < l; j++) { | |
354e15ab DE |
2565 | // If one data set has a NaN, let all subsequent stacked |
2566 | // sets inherit the NaN -- only start at 0 for the first set. | |
2567 | var x = series[j][0]; | |
41b0f691 | 2568 | if (cumulative_y[x] === undefined) { |
354e15ab | 2569 | cumulative_y[x] = 0; |
41b0f691 | 2570 | } |
43af96e7 NK |
2571 | |
2572 | actual_y = series[j][1]; | |
354e15ab | 2573 | cumulative_y[x] += actual_y; |
43af96e7 | 2574 | |
354e15ab | 2575 | series[j] = [x, cumulative_y[x]] |
43af96e7 | 2576 | |
41b0f691 DV |
2577 | if (cumulative_y[x] > seriesExtremes[1]) { |
2578 | seriesExtremes[1] = cumulative_y[x]; | |
2579 | } | |
2580 | if (cumulative_y[x] < seriesExtremes[0]) { | |
2581 | seriesExtremes[0] = cumulative_y[x]; | |
2582 | } | |
43af96e7 | 2583 | } |
6a1aa64f | 2584 | } |
41b0f691 | 2585 | extremes[seriesName] = seriesExtremes; |
354e15ab DE |
2586 | |
2587 | datasets[i] = series; | |
6a1aa64f DV |
2588 | } |
2589 | ||
354e15ab | 2590 | for (var i = 1; i < datasets.length; i++) { |
4523c1f6 | 2591 | if (!this.visibility()[i - 1]) continue; |
354e15ab | 2592 | this.layout_.addDataset(this.attr_("labels")[i], datasets[i]); |
43af96e7 NK |
2593 | } |
2594 | ||
6faebb69 JB |
2595 | this.computeYAxisRanges_(extremes); |
2596 | this.layout_.updateOptions( { yAxes: this.axes_, | |
2597 | seriesToAxisMap: this.seriesToAxisMap_ | |
9012dd21 | 2598 | } ); |
6a1aa64f DV |
2599 | this.addXTicks_(); |
2600 | ||
81856f70 NN |
2601 | // Save the X axis zoomed status as the updateOptions call will tend to set it errorneously |
2602 | var tmp_zoomed_x = this.zoomed_x_; | |
6a1aa64f | 2603 | // Tell PlotKit to use this new data and render itself |
d033ae1c | 2604 | this.layout_.updateOptions({dateWindow: this.dateWindow_}); |
81856f70 | 2605 | this.zoomed_x_ = tmp_zoomed_x; |
6a1aa64f DV |
2606 | this.layout_.evaluateWithError(); |
2607 | this.plotter_.clear(); | |
2608 | this.plotter_.render(); | |
f6401bf6 | 2609 | this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width, |
2f5e7e1a | 2610 | this.canvas_.height); |
599fb4ad | 2611 | |
2fccd3dc DV |
2612 | if (is_initial_draw) { |
2613 | // Generate a static legend before any particular point is selected. | |
91c10d9c | 2614 | this.setLegendHTML_(); |
06303c32 DV |
2615 | } else { |
2616 | if (typeof(this.selPoints_) !== 'undefined' && this.selPoints_.length) { | |
2617 | this.lastx_ = this.selPoints_[0].xval; | |
2618 | this.updateSelection_(); | |
2619 | } else { | |
2620 | this.clearSelection(); | |
2621 | } | |
2fccd3dc DV |
2622 | } |
2623 | ||
599fb4ad | 2624 | if (this.attr_("drawCallback") !== null) { |
fe0b7c03 | 2625 | this.attr_("drawCallback")(this, is_initial_draw); |
599fb4ad | 2626 | } |
6a1aa64f DV |
2627 | }; |
2628 | ||
2629 | /** | |
26ca7938 DV |
2630 | * Determine properties of the y-axes which are independent of the data |
2631 | * currently being displayed. This includes things like the number of axes and | |
2632 | * the style of the axes. It does not include the range of each axis and its | |
2633 | * tick marks. | |
2634 | * This fills in this.axes_ and this.seriesToAxisMap_. | |
2635 | * axes_ = [ { options } ] | |
2636 | * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... } | |
2637 | * indices are into the axes_ array. | |
f09fc545 | 2638 | */ |
26ca7938 | 2639 | Dygraph.prototype.computeYAxes_ = function() { |
00aa7f61 | 2640 | this.axes_ = [{ yAxisId : 0, g : this }]; // always have at least one y-axis. |
26ca7938 DV |
2641 | this.seriesToAxisMap_ = {}; |
2642 | ||
2643 | // Get a list of series names. | |
2644 | var labels = this.attr_("labels"); | |
1c77a3a1 | 2645 | var series = {}; |
26ca7938 | 2646 | for (var i = 1; i < labels.length; i++) series[labels[i]] = (i - 1); |
f09fc545 DV |
2647 | |
2648 | // all options which could be applied per-axis: | |
2649 | var axisOptions = [ | |
2650 | 'includeZero', | |
2651 | 'valueRange', | |
2652 | 'labelsKMB', | |
2653 | 'labelsKMG2', | |
2654 | 'pixelsPerYLabel', | |
2655 | 'yAxisLabelWidth', | |
2656 | 'axisLabelFontSize', | |
7d0e7a0d RK |
2657 | 'axisTickSize', |
2658 | 'logscale' | |
f09fc545 DV |
2659 | ]; |
2660 | ||
2661 | // Copy global axis options over to the first axis. | |
2662 | for (var i = 0; i < axisOptions.length; i++) { | |
2663 | var k = axisOptions[i]; | |
2664 | var v = this.attr_(k); | |
26ca7938 | 2665 | if (v) this.axes_[0][k] = v; |
f09fc545 DV |
2666 | } |
2667 | ||
2668 | // Go through once and add all the axes. | |
26ca7938 DV |
2669 | for (var seriesName in series) { |
2670 | if (!series.hasOwnProperty(seriesName)) continue; | |
f09fc545 DV |
2671 | var axis = this.attr_("axis", seriesName); |
2672 | if (axis == null) { | |
26ca7938 | 2673 | this.seriesToAxisMap_[seriesName] = 0; |
f09fc545 DV |
2674 | continue; |
2675 | } | |
2676 | if (typeof(axis) == 'object') { | |
2677 | // Add a new axis, making a copy of its per-axis options. | |
2678 | var opts = {}; | |
26ca7938 | 2679 | Dygraph.update(opts, this.axes_[0]); |
f09fc545 | 2680 | Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this. |
00aa7f61 RK |
2681 | var yAxisId = this.axes_.length; |
2682 | opts.yAxisId = yAxisId; | |
2683 | opts.g = this; | |
f09fc545 | 2684 | Dygraph.update(opts, axis); |
26ca7938 | 2685 | this.axes_.push(opts); |
00aa7f61 | 2686 | this.seriesToAxisMap_[seriesName] = yAxisId; |
f09fc545 DV |
2687 | } |
2688 | } | |
2689 | ||
2690 | // Go through one more time and assign series to an axis defined by another | |
2691 | // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } } | |
26ca7938 DV |
2692 | for (var seriesName in series) { |
2693 | if (!series.hasOwnProperty(seriesName)) continue; | |
f09fc545 DV |
2694 | var axis = this.attr_("axis", seriesName); |
2695 | if (typeof(axis) == 'string') { | |
26ca7938 | 2696 | if (!this.seriesToAxisMap_.hasOwnProperty(axis)) { |
f09fc545 DV |
2697 | this.error("Series " + seriesName + " wants to share a y-axis with " + |
2698 | "series " + axis + ", which does not define its own axis."); | |
2699 | return null; | |
2700 | } | |
26ca7938 DV |
2701 | var idx = this.seriesToAxisMap_[axis]; |
2702 | this.seriesToAxisMap_[seriesName] = idx; | |
f09fc545 DV |
2703 | } |
2704 | } | |
1c77a3a1 DV |
2705 | |
2706 | // Now we remove series from seriesToAxisMap_ which are not visible. We do | |
2707 | // this last so that hiding the first series doesn't destroy the axis | |
2708 | // properties of the primary axis. | |
2709 | var seriesToAxisFiltered = {}; | |
2710 | var vis = this.visibility(); | |
2711 | for (var i = 1; i < labels.length; i++) { | |
2712 | var s = labels[i]; | |
2713 | if (vis[i - 1]) seriesToAxisFiltered[s] = this.seriesToAxisMap_[s]; | |
2714 | } | |
2715 | this.seriesToAxisMap_ = seriesToAxisFiltered; | |
26ca7938 DV |
2716 | }; |
2717 | ||
2718 | /** | |
2719 | * Returns the number of y-axes on the chart. | |
2720 | * @return {Number} the number of axes. | |
2721 | */ | |
2722 | Dygraph.prototype.numAxes = function() { | |
2723 | var last_axis = 0; | |
2724 | for (var series in this.seriesToAxisMap_) { | |
2725 | if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue; | |
2726 | var idx = this.seriesToAxisMap_[series]; | |
2727 | if (idx > last_axis) last_axis = idx; | |
2728 | } | |
2729 | return 1 + last_axis; | |
2730 | }; | |
2731 | ||
2732 | /** | |
2733 | * Determine the value range and tick marks for each axis. | |
2734 | * @param {Object} extremes A mapping from seriesName -> [low, high] | |
2735 | * This fills in the valueRange and ticks fields in each entry of this.axes_. | |
2736 | */ | |
2737 | Dygraph.prototype.computeYAxisRanges_ = function(extremes) { | |
2738 | // Build a map from axis number -> [list of series names] | |
2739 | var seriesForAxis = []; | |
2740 | for (var series in this.seriesToAxisMap_) { | |
2741 | if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue; | |
2742 | var idx = this.seriesToAxisMap_[series]; | |
2743 | while (seriesForAxis.length <= idx) seriesForAxis.push([]); | |
2744 | seriesForAxis[idx].push(series); | |
2745 | } | |
f09fc545 DV |
2746 | |
2747 | // Compute extreme values, a span and tick marks for each axis. | |
26ca7938 DV |
2748 | for (var i = 0; i < this.axes_.length; i++) { |
2749 | var axis = this.axes_[i]; | |
4cac8c7a | 2750 | |
06fc69b6 AV |
2751 | if (!seriesForAxis[i]) { |
2752 | // If no series are defined or visible then use a reasonable default | |
2753 | axis.extremeRange = [0, 1]; | |
2754 | } else { | |
1c77a3a1 | 2755 | // Calculate the extremes of extremes. |
f09fc545 DV |
2756 | var series = seriesForAxis[i]; |
2757 | var minY = Infinity; // extremes[series[0]][0]; | |
2758 | var maxY = -Infinity; // extremes[series[0]][1]; | |
ba049b89 | 2759 | var extremeMinY, extremeMaxY; |
f09fc545 | 2760 | for (var j = 0; j < series.length; j++) { |
ba049b89 NN |
2761 | // Only use valid extremes to stop null data series' from corrupting the scale. |
2762 | extremeMinY = extremes[series[j]][0]; | |
2763 | if (extremeMinY != null) { | |
36dfa958 | 2764 | minY = Math.min(extremeMinY, minY); |
ba049b89 NN |
2765 | } |
2766 | extremeMaxY = extremes[series[j]][1]; | |
2767 | if (extremeMaxY != null) { | |
36dfa958 | 2768 | maxY = Math.max(extremeMaxY, maxY); |
ba049b89 | 2769 | } |
f09fc545 DV |
2770 | } |
2771 | if (axis.includeZero && minY > 0) minY = 0; | |
2772 | ||
ba049b89 | 2773 | // Ensure we have a valid scale, otherwise defualt to zero for safety. |
36dfa958 DV |
2774 | if (minY == Infinity) minY = 0; |
2775 | if (maxY == -Infinity) maxY = 0; | |
ba049b89 | 2776 | |
f09fc545 DV |
2777 | // Add some padding and round up to an integer to be human-friendly. |
2778 | var span = maxY - minY; | |
2779 | // special case: if we have no sense of scale, use +/-10% of the sole value. | |
2780 | if (span == 0) { span = maxY; } | |
f09fc545 | 2781 | |
ff022deb RK |
2782 | var maxAxisY; |
2783 | var minAxisY; | |
7d0e7a0d | 2784 | if (axis.logscale) { |
ff022deb RK |
2785 | var maxAxisY = maxY + 0.1 * span; |
2786 | var minAxisY = minY; | |
2787 | } else { | |
2788 | var maxAxisY = maxY + 0.1 * span; | |
2789 | var minAxisY = minY - 0.1 * span; | |
f09fc545 | 2790 | |
ff022deb RK |
2791 | // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense. |
2792 | if (!this.attr_("avoidMinZero")) { | |
2793 | if (minAxisY < 0 && minY >= 0) minAxisY = 0; | |
2794 | if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0; | |
2795 | } | |
f09fc545 | 2796 | |
ff022deb RK |
2797 | if (this.attr_("includeZero")) { |
2798 | if (maxY < 0) maxAxisY = 0; | |
2799 | if (minY > 0) minAxisY = 0; | |
2800 | } | |
f09fc545 | 2801 | } |
4cac8c7a RK |
2802 | axis.extremeRange = [minAxisY, maxAxisY]; |
2803 | } | |
2804 | if (axis.valueWindow) { | |
2805 | // This is only set if the user has zoomed on the y-axis. It is never set | |
2806 | // by a user. It takes precedence over axis.valueRange because, if you set | |
2807 | // valueRange, you'd still expect to be able to pan. | |
2808 | axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]]; | |
2809 | } else if (axis.valueRange) { | |
2810 | // This is a user-set value range for this axis. | |
2811 | axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]]; | |
2812 | } else { | |
2813 | axis.computedValueRange = axis.extremeRange; | |
f09fc545 DV |
2814 | } |
2815 | ||
0d64e596 DV |
2816 | // Add ticks. By default, all axes inherit the tick positions of the |
2817 | // primary axis. However, if an axis is specifically marked as having | |
2818 | // independent ticks, then that is permissible as well. | |
2819 | if (i == 0 || axis.independentTicks) { | |
032e4c1d | 2820 | axis.ticks = |
0d64e596 DV |
2821 | Dygraph.numericTicks(axis.computedValueRange[0], |
2822 | axis.computedValueRange[1], | |
2823 | this, | |
2824 | axis); | |
2825 | } else { | |
2826 | var p_axis = this.axes_[0]; | |
2827 | var p_ticks = p_axis.ticks; | |
2828 | var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0]; | |
2829 | var scale = axis.computedValueRange[1] - axis.computedValueRange[0]; | |
2830 | var tick_values = []; | |
2831 | for (var i = 0; i < p_ticks.length; i++) { | |
2832 | var y_frac = (p_ticks[i].v - p_axis.computedValueRange[0]) / p_scale; | |
2833 | var y_val = axis.computedValueRange[0] + y_frac * scale; | |
2834 | tick_values.push(y_val); | |
2835 | } | |
2836 | ||
032e4c1d | 2837 | axis.ticks = |
0d64e596 DV |
2838 | Dygraph.numericTicks(axis.computedValueRange[0], |
2839 | axis.computedValueRange[1], | |
2840 | this, axis, tick_values); | |
2841 | } | |
f09fc545 | 2842 | } |
f09fc545 DV |
2843 | }; |
2844 | ||
2845 | /** | |
6a1aa64f DV |
2846 | * Calculates the rolling average of a data set. |
2847 | * If originalData is [label, val], rolls the average of those. | |
2848 | * If originalData is [label, [, it's interpreted as [value, stddev] | |
2849 | * and the roll is returned in the same form, with appropriately reduced | |
2850 | * stddev for each value. | |
2851 | * Note that this is where fractional input (i.e. '5/10') is converted into | |
2852 | * decimal values. | |
2853 | * @param {Array} originalData The data in the appropriate format (see above) | |
6faebb69 JB |
2854 | * @param {Number} rollPeriod The number of points over which to average the |
2855 | * data | |
6a1aa64f | 2856 | */ |
285a6bda | 2857 | Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) { |
6a1aa64f DV |
2858 | if (originalData.length < 2) |
2859 | return originalData; | |
2860 | var rollPeriod = Math.min(rollPeriod, originalData.length - 1); | |
2861 | var rollingData = []; | |
285a6bda | 2862 | var sigma = this.attr_("sigma"); |
6a1aa64f DV |
2863 | |
2864 | if (this.fractions_) { | |
2865 | var num = 0; | |
2866 | var den = 0; // numerator/denominator | |
2867 | var mult = 100.0; | |
2868 | for (var i = 0; i < originalData.length; i++) { | |
2869 | num += originalData[i][1][0]; | |
2870 | den += originalData[i][1][1]; | |
2871 | if (i - rollPeriod >= 0) { | |
2872 | num -= originalData[i - rollPeriod][1][0]; | |
2873 | den -= originalData[i - rollPeriod][1][1]; | |
2874 | } | |
2875 | ||
2876 | var date = originalData[i][0]; | |
2877 | var value = den ? num / den : 0.0; | |
285a6bda | 2878 | if (this.attr_("errorBars")) { |
6a1aa64f DV |
2879 | if (this.wilsonInterval_) { |
2880 | // For more details on this confidence interval, see: | |
2881 | // http://en.wikipedia.org/wiki/Binomial_confidence_interval | |
2882 | if (den) { | |
2883 | var p = value < 0 ? 0 : value, n = den; | |
2884 | var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n)); | |
2885 | var denom = 1 + sigma * sigma / den; | |
2886 | var low = (p + sigma * sigma / (2 * den) - pm) / denom; | |
2887 | var high = (p + sigma * sigma / (2 * den) + pm) / denom; | |
2888 | rollingData[i] = [date, | |
2889 | [p * mult, (p - low) * mult, (high - p) * mult]]; | |
2890 | } else { | |
2891 | rollingData[i] = [date, [0, 0, 0]]; | |
2892 | } | |
2893 | } else { | |
2894 | var stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0; | |
2895 | rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]]; | |
2896 | } | |
2897 | } else { | |
2898 | rollingData[i] = [date, mult * value]; | |
2899 | } | |
2900 | } | |
9922b78b | 2901 | } else if (this.attr_("customBars")) { |
f6885d6a DV |
2902 | var low = 0; |
2903 | var mid = 0; | |
2904 | var high = 0; | |
2905 | var count = 0; | |
6a1aa64f DV |
2906 | for (var i = 0; i < originalData.length; i++) { |
2907 | var data = originalData[i][1]; | |
2908 | var y = data[1]; | |
2909 | rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]]; | |
f6885d6a | 2910 | |
8b91c51f | 2911 | if (y != null && !isNaN(y)) { |
49a7d0d5 DV |
2912 | low += data[0]; |
2913 | mid += y; | |
2914 | high += data[2]; | |
2915 | count += 1; | |
2916 | } | |
f6885d6a DV |
2917 | if (i - rollPeriod >= 0) { |
2918 | var prev = originalData[i - rollPeriod]; | |
8b91c51f | 2919 | if (prev[1][1] != null && !isNaN(prev[1][1])) { |
49a7d0d5 DV |
2920 | low -= prev[1][0]; |
2921 | mid -= prev[1][1]; | |
2922 | high -= prev[1][2]; | |
2923 | count -= 1; | |
2924 | } | |
f6885d6a DV |
2925 | } |
2926 | rollingData[i] = [originalData[i][0], [ 1.0 * mid / count, | |
2927 | 1.0 * (mid - low) / count, | |
2928 | 1.0 * (high - mid) / count ]]; | |
2769de62 | 2929 | } |
6a1aa64f DV |
2930 | } else { |
2931 | // Calculate the rolling average for the first rollPeriod - 1 points where | |
6faebb69 | 2932 | // there is not enough data to roll over the full number of points |
6a1aa64f | 2933 | var num_init_points = Math.min(rollPeriod - 1, originalData.length - 2); |
285a6bda | 2934 | if (!this.attr_("errorBars")){ |
5011e7a1 DV |
2935 | if (rollPeriod == 1) { |
2936 | return originalData; | |
2937 | } | |
2938 | ||
2847c1cf | 2939 | for (var i = 0; i < originalData.length; i++) { |
6a1aa64f | 2940 | var sum = 0; |
5011e7a1 | 2941 | var num_ok = 0; |
2847c1cf DV |
2942 | for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) { |
2943 | var y = originalData[j][1]; | |
8b91c51f | 2944 | if (y == null || isNaN(y)) continue; |
5011e7a1 | 2945 | num_ok++; |
2847c1cf | 2946 | sum += originalData[j][1]; |
6a1aa64f | 2947 | } |
5011e7a1 | 2948 | if (num_ok) { |
2847c1cf | 2949 | rollingData[i] = [originalData[i][0], sum / num_ok]; |
5011e7a1 | 2950 | } else { |
2847c1cf | 2951 | rollingData[i] = [originalData[i][0], null]; |
5011e7a1 | 2952 | } |
6a1aa64f | 2953 | } |
2847c1cf DV |
2954 | |
2955 | } else { | |
2956 | for (var i = 0; i < originalData.length; i++) { | |
6a1aa64f DV |
2957 | var sum = 0; |
2958 | var variance = 0; | |
5011e7a1 | 2959 | var num_ok = 0; |
2847c1cf | 2960 | for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) { |
5011e7a1 | 2961 | var y = originalData[j][1][0]; |
8b91c51f | 2962 | if (y == null || isNaN(y)) continue; |
5011e7a1 | 2963 | num_ok++; |
6a1aa64f DV |
2964 | sum += originalData[j][1][0]; |
2965 | variance += Math.pow(originalData[j][1][1], 2); | |
2966 | } | |
5011e7a1 DV |
2967 | if (num_ok) { |
2968 | var stddev = Math.sqrt(variance) / num_ok; | |
2969 | rollingData[i] = [originalData[i][0], | |
2970 | [sum / num_ok, sigma * stddev, sigma * stddev]]; | |
2971 | } else { | |
2972 | rollingData[i] = [originalData[i][0], [null, null, null]]; | |
2973 | } | |
6a1aa64f DV |
2974 | } |
2975 | } | |
2976 | } | |
2977 | ||
2978 | return rollingData; | |
2979 | }; | |
2980 | ||
2981 | /** | |
2982 | * Parses a date, returning the number of milliseconds since epoch. This can be | |
285a6bda DV |
2983 | * passed in as an xValueParser in the Dygraph constructor. |
2984 | * TODO(danvk): enumerate formats that this understands. | |
6a1aa64f DV |
2985 | * @param {String} A date in YYYYMMDD format. |
2986 | * @return {Number} Milliseconds since epoch. | |
2987 | * @public | |
2988 | */ | |
285a6bda | 2989 | Dygraph.dateParser = function(dateStr, self) { |
6a1aa64f | 2990 | var dateStrSlashed; |
285a6bda | 2991 | var d; |
986a5026 | 2992 | if (dateStr.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12' |
6a1aa64f | 2993 | dateStrSlashed = dateStr.replace("-", "/", "g"); |
353a0294 DV |
2994 | while (dateStrSlashed.search("-") != -1) { |
2995 | dateStrSlashed = dateStrSlashed.replace("-", "/"); | |
2996 | } | |
d96b7d1a | 2997 | d = Dygraph.dateStrToMillis(dateStrSlashed); |
2769de62 | 2998 | } else if (dateStr.length == 8) { // e.g. '20090712' |
285a6bda | 2999 | // TODO(danvk): remove support for this format. It's confusing. |
6a1aa64f DV |
3000 | dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2) |
3001 | + "/" + dateStr.substr(6,2); | |
d96b7d1a | 3002 | d = Dygraph.dateStrToMillis(dateStrSlashed); |
2769de62 DV |
3003 | } else { |
3004 | // Any format that Date.parse will accept, e.g. "2009/07/12" or | |
3005 | // "2009/07/12 12:34:56" | |
d96b7d1a | 3006 | d = Dygraph.dateStrToMillis(dateStr); |
285a6bda DV |
3007 | } |
3008 | ||
3009 | if (!d || isNaN(d)) { | |
3010 | self.error("Couldn't parse " + dateStr + " as a date"); | |
3011 | } | |
3012 | return d; | |
3013 | }; | |
3014 | ||
3015 | /** | |
3016 | * Detects the type of the str (date or numeric) and sets the various | |
3017 | * formatting attributes in this.attrs_ based on this type. | |
3018 | * @param {String} str An x value. | |
3019 | * @private | |
3020 | */ | |
3021 | Dygraph.prototype.detectTypeFromString_ = function(str) { | |
3022 | var isDate = false; | |
ea62df82 | 3023 | if (str.indexOf('-') > 0 || |
285a6bda DV |
3024 | str.indexOf('/') >= 0 || |
3025 | isNaN(parseFloat(str))) { | |
3026 | isDate = true; | |
3027 | } else if (str.length == 8 && str > '19700101' && str < '20371231') { | |
3028 | // TODO(danvk): remove support for this format. | |
3029 | isDate = true; | |
3030 | } | |
3031 | ||
3032 | if (isDate) { | |
3033 | this.attrs_.xValueFormatter = Dygraph.dateString_; | |
3034 | this.attrs_.xValueParser = Dygraph.dateParser; | |
3035 | this.attrs_.xTicker = Dygraph.dateTicker; | |
bf640e56 | 3036 | this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter; |
285a6bda | 3037 | } else { |
17d0210c | 3038 | // TODO(danvk): use Dygraph.numberFormatter here? |
032e4c1d | 3039 | this.attrs_.xValueFormatter = function(x) { return x; }; |
285a6bda DV |
3040 | this.attrs_.xValueParser = function(x) { return parseFloat(x); }; |
3041 | this.attrs_.xTicker = Dygraph.numericTicks; | |
bf640e56 | 3042 | this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter; |
6a1aa64f | 3043 | } |
6a1aa64f DV |
3044 | }; |
3045 | ||
3046 | /** | |
5cd7ac68 DV |
3047 | * Parses the value as a floating point number. This is like the parseFloat() |
3048 | * built-in, but with a few differences: | |
3049 | * - the empty string is parsed as null, rather than NaN. | |
3050 | * - if the string cannot be parsed at all, an error is logged. | |
3051 | * If the string can't be parsed, this method returns null. | |
3052 | * @param {String} x The string to be parsed | |
3053 | * @param {Number} opt_line_no The line number from which the string comes. | |
3054 | * @param {String} opt_line The text of the line from which the string comes. | |
3055 | * @private | |
3056 | */ | |
3057 | ||
3058 | // Parse the x as a float or return null if it's not a number. | |
3059 | Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) { | |
3060 | var val = parseFloat(x); | |
3061 | if (!isNaN(val)) return val; | |
3062 | ||
3063 | // Try to figure out what happeend. | |
3064 | // If the value is the empty string, parse it as null. | |
3065 | if (/^ *$/.test(x)) return null; | |
3066 | ||
3067 | // If it was actually "NaN", return it as NaN. | |
3068 | if (/^ *nan *$/i.test(x)) return NaN; | |
3069 | ||
3070 | // Looks like a parsing error. | |
3071 | var msg = "Unable to parse '" + x + "' as a number"; | |
3072 | if (opt_line !== null && opt_line_no !== null) { | |
3073 | msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV."; | |
3074 | } | |
3075 | this.error(msg); | |
3076 | ||
3077 | return null; | |
3078 | }; | |
3079 | ||
3080 | /** | |
6a1aa64f DV |
3081 | * Parses a string in a special csv format. We expect a csv file where each |
3082 | * line is a date point, and the first field in each line is the date string. | |
3083 | * We also expect that all remaining fields represent series. | |
285a6bda | 3084 | * if the errorBars attribute is set, then interpret the fields as: |
6a1aa64f DV |
3085 | * date, series1, stddev1, series2, stddev2, ... |
3086 | * @param {Array.<Object>} data See above. | |
3087 | * @private | |
285a6bda DV |
3088 | * |
3089 | * @return Array.<Object> An array with one entry for each row. These entries | |
3090 | * are an array of cells in that row. The first entry is the parsed x-value for | |
3091 | * the row. The second, third, etc. are the y-values. These can take on one of | |
3092 | * three forms, depending on the CSV and constructor parameters: | |
3093 | * 1. numeric value | |
3094 | * 2. [ value, stddev ] | |
3095 | * 3. [ low value, center value, high value ] | |
6a1aa64f | 3096 | */ |
285a6bda | 3097 | Dygraph.prototype.parseCSV_ = function(data) { |
6a1aa64f DV |
3098 | var ret = []; |
3099 | var lines = data.split("\n"); | |
3d67f03b DV |
3100 | |
3101 | // Use the default delimiter or fall back to a tab if that makes sense. | |
3102 | var delim = this.attr_('delimiter'); | |
3103 | if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) { | |
3104 | delim = '\t'; | |
3105 | } | |
3106 | ||
285a6bda | 3107 | var start = 0; |
6a1aa64f | 3108 | if (this.labelsFromCSV_) { |
285a6bda | 3109 | start = 1; |
3d67f03b | 3110 | this.attrs_.labels = lines[0].split(delim); |
6a1aa64f | 3111 | } |
5cd7ac68 | 3112 | var line_no = 0; |
03b522a4 | 3113 | |
285a6bda DV |
3114 | var xParser; |
3115 | var defaultParserSet = false; // attempt to auto-detect x value type | |
3116 | var expectedCols = this.attr_("labels").length; | |
987840a2 | 3117 | var outOfOrder = false; |
6a1aa64f DV |
3118 | for (var i = start; i < lines.length; i++) { |
3119 | var line = lines[i]; | |
5cd7ac68 | 3120 | line_no = i; |
6a1aa64f | 3121 | if (line.length == 0) continue; // skip blank lines |
3d67f03b DV |
3122 | if (line[0] == '#') continue; // skip comment lines |
3123 | var inFields = line.split(delim); | |
285a6bda | 3124 | if (inFields.length < 2) continue; |
6a1aa64f DV |
3125 | |
3126 | var fields = []; | |
285a6bda DV |
3127 | if (!defaultParserSet) { |
3128 | this.detectTypeFromString_(inFields[0]); | |
3129 | xParser = this.attr_("xValueParser"); | |
3130 | defaultParserSet = true; | |
3131 | } | |
3132 | fields[0] = xParser(inFields[0], this); | |
6a1aa64f DV |
3133 | |
3134 | // If fractions are expected, parse the numbers as "A/B" | |
3135 | if (this.fractions_) { | |
3136 | for (var j = 1; j < inFields.length; j++) { | |
3137 | // TODO(danvk): figure out an appropriate way to flag parse errors. | |
3138 | var vals = inFields[j].split("/"); | |
7219edb3 DV |
3139 | if (vals.length != 2) { |
3140 | this.error('Expected fractional "num/den" values in CSV data ' + | |
3141 | "but found a value '" + inFields[j] + "' on line " + | |
3142 | (1 + i) + " ('" + line + "') which is not of this form."); | |
3143 | fields[j] = [0, 0]; | |
3144 | } else { | |
3145 | fields[j] = [this.parseFloat_(vals[0], i, line), | |
3146 | this.parseFloat_(vals[1], i, line)]; | |
3147 | } | |
6a1aa64f | 3148 | } |
285a6bda | 3149 | } else if (this.attr_("errorBars")) { |
6a1aa64f | 3150 | // If there are error bars, values are (value, stddev) pairs |
7219edb3 DV |
3151 | if (inFields.length % 2 != 1) { |
3152 | this.error('Expected alternating (value, stdev.) pairs in CSV data ' + | |
3153 | 'but line ' + (1 + i) + ' has an odd number of values (' + | |
3154 | (inFields.length - 1) + "): '" + line + "'"); | |
3155 | } | |
3156 | for (var j = 1; j < inFields.length; j += 2) { | |
5cd7ac68 DV |
3157 | fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line), |
3158 | this.parseFloat_(inFields[j + 1], i, line)]; | |
7219edb3 | 3159 | } |
9922b78b | 3160 | } else if (this.attr_("customBars")) { |
6a1aa64f DV |
3161 | // Bars are a low;center;high tuple |
3162 | for (var j = 1; j < inFields.length; j++) { | |
327a9279 DV |
3163 | var val = inFields[j]; |
3164 | if (/^ *$/.test(val)) { | |
3165 | fields[j] = [null, null, null]; | |
3166 | } else { | |
3167 | var vals = val.split(";"); | |
3168 | if (vals.length == 3) { | |
3169 | fields[j] = [ this.parseFloat_(vals[0], i, line), | |
3170 | this.parseFloat_(vals[1], i, line), | |
3171 | this.parseFloat_(vals[2], i, line) ]; | |
3172 | } else { | |
3173 | this.warning('When using customBars, values must be either blank ' + | |
3174 | 'or "low;center;high" tuples (got "' + val + | |
3175 | '" on line ' + (1+i)); | |
3176 | } | |
3177 | } | |
6a1aa64f DV |
3178 | } |
3179 | } else { | |
3180 | // Values are just numbers | |
285a6bda | 3181 | for (var j = 1; j < inFields.length; j++) { |
5cd7ac68 | 3182 | fields[j] = this.parseFloat_(inFields[j], i, line); |
285a6bda | 3183 | } |
6a1aa64f | 3184 | } |
987840a2 DV |
3185 | if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) { |
3186 | outOfOrder = true; | |
3187 | } | |
285a6bda DV |
3188 | |
3189 | if (fields.length != expectedCols) { | |
3190 | this.error("Number of columns in line " + i + " (" + fields.length + | |
3191 | ") does not agree with number of labels (" + expectedCols + | |
3192 | ") " + line); | |
3193 | } | |
6d0aaa09 DV |
3194 | |
3195 | // If the user specified the 'labels' option and none of the cells of the | |
3196 | // first row parsed correctly, then they probably double-specified the | |
3197 | // labels. We go with the values set in the option, discard this row and | |
3198 | // log a warning to the JS console. | |
3199 | if (i == 0 && this.attr_('labels')) { | |
3200 | var all_null = true; | |
3201 | for (var j = 0; all_null && j < fields.length; j++) { | |
3202 | if (fields[j]) all_null = false; | |
3203 | } | |
3204 | if (all_null) { | |
3205 | this.warn("The dygraphs 'labels' option is set, but the first row of " + | |
3206 | "CSV data ('" + line + "') appears to also contain labels. " + | |
3207 | "Will drop the CSV labels and use the option labels."); | |
3208 | continue; | |
3209 | } | |
3210 | } | |
3211 | ret.push(fields); | |
6a1aa64f | 3212 | } |
987840a2 DV |
3213 | |
3214 | if (outOfOrder) { | |
3215 | this.warn("CSV is out of order; order it correctly to speed loading."); | |
3216 | ret.sort(function(a,b) { return a[0] - b[0] }); | |
3217 | } | |
3218 | ||
6a1aa64f DV |
3219 | return ret; |
3220 | }; | |
3221 | ||
3222 | /** | |
285a6bda DV |
3223 | * The user has provided their data as a pre-packaged JS array. If the x values |
3224 | * are numeric, this is the same as dygraphs' internal format. If the x values | |
3225 | * are dates, we need to convert them from Date objects to ms since epoch. | |
3226 | * @param {Array.<Object>} data | |
3227 | * @return {Array.<Object>} data with numeric x values. | |
3228 | */ | |
3229 | Dygraph.prototype.parseArray_ = function(data) { | |
3230 | // Peek at the first x value to see if it's numeric. | |
3231 | if (data.length == 0) { | |
3232 | this.error("Can't plot empty data set"); | |
3233 | return null; | |
3234 | } | |
3235 | if (data[0].length == 0) { | |
3236 | this.error("Data set cannot contain an empty row"); | |
3237 | return null; | |
3238 | } | |
3239 | ||
3240 | if (this.attr_("labels") == null) { | |
3241 | this.warn("Using default labels. Set labels explicitly via 'labels' " + | |
3242 | "in the options parameter"); | |
3243 | this.attrs_.labels = [ "X" ]; | |
3244 | for (var i = 1; i < data[0].length; i++) { | |
3245 | this.attrs_.labels.push("Y" + i); | |
3246 | } | |
3247 | } | |
3248 | ||
2dda3850 | 3249 | if (Dygraph.isDateLike(data[0][0])) { |
285a6bda DV |
3250 | // Some intelligent defaults for a date x-axis. |
3251 | this.attrs_.xValueFormatter = Dygraph.dateString_; | |
bf640e56 | 3252 | this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter; |
285a6bda DV |
3253 | this.attrs_.xTicker = Dygraph.dateTicker; |
3254 | ||
3255 | // Assume they're all dates. | |
e3ab7b40 | 3256 | var parsedData = Dygraph.clone(data); |
285a6bda DV |
3257 | for (var i = 0; i < data.length; i++) { |
3258 | if (parsedData[i].length == 0) { | |
a323ff4a | 3259 | this.error("Row " + (1 + i) + " of data is empty"); |
285a6bda DV |
3260 | return null; |
3261 | } | |
3262 | if (parsedData[i][0] == null | |
3a909ec5 DV |
3263 | || typeof(parsedData[i][0].getTime) != 'function' |
3264 | || isNaN(parsedData[i][0].getTime())) { | |
be96a1f5 | 3265 | this.error("x value in row " + (1 + i) + " is not a Date"); |
285a6bda DV |
3266 | return null; |
3267 | } | |
3268 | parsedData[i][0] = parsedData[i][0].getTime(); | |
3269 | } | |
3270 | return parsedData; | |
3271 | } else { | |
3272 | // Some intelligent defaults for a numeric x-axis. | |
032e4c1d | 3273 | this.attrs_.xValueFormatter = function(x) { return x; }; |
285a6bda DV |
3274 | this.attrs_.xTicker = Dygraph.numericTicks; |
3275 | return data; | |
3276 | } | |
3277 | }; | |
3278 | ||
3279 | /** | |
79420a1e DV |
3280 | * Parses a DataTable object from gviz. |
3281 | * The data is expected to have a first column that is either a date or a | |
3282 | * number. All subsequent columns must be numbers. If there is a clear mismatch | |
3283 | * between this.xValueParser_ and the type of the first column, it will be | |
a685723c | 3284 | * fixed. Fills out rawData_. |
79420a1e DV |
3285 | * @param {Array.<Object>} data See above. |
3286 | * @private | |
3287 | */ | |
285a6bda | 3288 | Dygraph.prototype.parseDataTable_ = function(data) { |
79420a1e DV |
3289 | var cols = data.getNumberOfColumns(); |
3290 | var rows = data.getNumberOfRows(); | |
3291 | ||
d955e223 | 3292 | var indepType = data.getColumnType(0); |
4440f6c8 | 3293 | if (indepType == 'date' || indepType == 'datetime') { |
285a6bda DV |
3294 | this.attrs_.xValueFormatter = Dygraph.dateString_; |
3295 | this.attrs_.xValueParser = Dygraph.dateParser; | |
3296 | this.attrs_.xTicker = Dygraph.dateTicker; | |
bf640e56 | 3297 | this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter; |
33127159 | 3298 | } else if (indepType == 'number') { |
032e4c1d | 3299 | this.attrs_.xValueFormatter = function(x) { return x; }; |
285a6bda DV |
3300 | this.attrs_.xValueParser = function(x) { return parseFloat(x); }; |
3301 | this.attrs_.xTicker = Dygraph.numericTicks; | |
bf640e56 | 3302 | this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter; |
285a6bda | 3303 | } else { |
987840a2 DV |
3304 | this.error("only 'date', 'datetime' and 'number' types are supported for " + |
3305 | "column 1 of DataTable input (Got '" + indepType + "')"); | |
79420a1e DV |
3306 | return null; |
3307 | } | |
3308 | ||
a685723c DV |
3309 | // Array of the column indices which contain data (and not annotations). |
3310 | var colIdx = []; | |
3311 | var annotationCols = {}; // data index -> [annotation cols] | |
3312 | var hasAnnotations = false; | |
3313 | for (var i = 1; i < cols; i++) { | |
3314 | var type = data.getColumnType(i); | |
3315 | if (type == 'number') { | |
3316 | colIdx.push(i); | |
3317 | } else if (type == 'string' && this.attr_('displayAnnotations')) { | |
3318 | // This is OK -- it's an annotation column. | |
3319 | var dataIdx = colIdx[colIdx.length - 1]; | |
3320 | if (!annotationCols.hasOwnProperty(dataIdx)) { | |
3321 | annotationCols[dataIdx] = [i]; | |
3322 | } else { | |
3323 | annotationCols[dataIdx].push(i); | |
3324 | } | |
3325 | hasAnnotations = true; | |
3326 | } else { | |
3327 | this.error("Only 'number' is supported as a dependent type with Gviz." + | |
3328 | " 'string' is only supported if displayAnnotations is true"); | |
3329 | } | |
3330 | } | |
3331 | ||
3332 | // Read column labels | |
3333 | // TODO(danvk): add support back for errorBars | |
3334 | var labels = [data.getColumnLabel(0)]; | |
3335 | for (var i = 0; i < colIdx.length; i++) { | |
3336 | labels.push(data.getColumnLabel(colIdx[i])); | |
f9348814 | 3337 | if (this.attr_("errorBars")) i += 1; |
a685723c DV |
3338 | } |
3339 | this.attrs_.labels = labels; | |
3340 | cols = labels.length; | |
3341 | ||
79420a1e | 3342 | var ret = []; |
987840a2 | 3343 | var outOfOrder = false; |
a685723c | 3344 | var annotations = []; |
79420a1e DV |
3345 | for (var i = 0; i < rows; i++) { |
3346 | var row = []; | |
debe4434 DV |
3347 | if (typeof(data.getValue(i, 0)) === 'undefined' || |
3348 | data.getValue(i, 0) === null) { | |
129569a5 FD |
3349 | this.warn("Ignoring row " + i + |
3350 | " of DataTable because of undefined or null first column."); | |
debe4434 DV |
3351 | continue; |
3352 | } | |
3353 | ||
c21d2c2d | 3354 | if (indepType == 'date' || indepType == 'datetime') { |
d955e223 DV |
3355 | row.push(data.getValue(i, 0).getTime()); |
3356 | } else { | |
3357 | row.push(data.getValue(i, 0)); | |
3358 | } | |
3e3f84e4 | 3359 | if (!this.attr_("errorBars")) { |
a685723c DV |
3360 | for (var j = 0; j < colIdx.length; j++) { |
3361 | var col = colIdx[j]; | |
3362 | row.push(data.getValue(i, col)); | |
3363 | if (hasAnnotations && | |
3364 | annotationCols.hasOwnProperty(col) && | |
3365 | data.getValue(i, annotationCols[col][0]) != null) { | |
3366 | var ann = {}; | |
3367 | ann.series = data.getColumnLabel(col); | |
3368 | ann.xval = row[0]; | |
3369 | ann.shortText = String.fromCharCode(65 /* A */ + annotations.length) | |
3370 | ann.text = ''; | |
3371 | for (var k = 0; k < annotationCols[col].length; k++) { | |
3372 | if (k) ann.text += "\n"; | |
3373 | ann.text += data.getValue(i, annotationCols[col][k]); | |
3374 | } | |
3375 | annotations.push(ann); | |
3376 | } | |
3e3f84e4 | 3377 | } |
92fd68d8 DV |
3378 | |
3379 | // Strip out infinities, which give dygraphs problems later on. | |
3380 | for (var j = 0; j < row.length; j++) { | |
3381 | if (!isFinite(row[j])) row[j] = null; | |
3382 | } | |
3e3f84e4 DV |
3383 | } else { |
3384 | for (var j = 0; j < cols - 1; j++) { | |
3385 | row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]); | |
3386 | } | |
79420a1e | 3387 | } |
987840a2 DV |
3388 | if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) { |
3389 | outOfOrder = true; | |
3390 | } | |
243d96e8 | 3391 | ret.push(row); |
79420a1e | 3392 | } |
987840a2 DV |
3393 | |
3394 | if (outOfOrder) { | |
3395 | this.warn("DataTable is out of order; order it correctly to speed loading."); | |
3396 | ret.sort(function(a,b) { return a[0] - b[0] }); | |
3397 | } | |
a685723c DV |
3398 | this.rawData_ = ret; |
3399 | ||
3400 | if (annotations.length > 0) { | |
3401 | this.setAnnotations(annotations, true); | |
3402 | } | |
79420a1e DV |
3403 | } |
3404 | ||
d96b7d1a DV |
3405 | // This is identical to JavaScript's built-in Date.parse() method, except that |
3406 | // it doesn't get replaced with an incompatible method by aggressive JS | |
3407 | // libraries like MooTools or Joomla. | |
3408 | Dygraph.dateStrToMillis = function(str) { | |
3409 | return new Date(str).getTime(); | |
3410 | }; | |
3411 | ||
24e5350c | 3412 | // These functions are all based on MochiKit. |
fc80a396 DV |
3413 | Dygraph.update = function (self, o) { |
3414 | if (typeof(o) != 'undefined' && o !== null) { | |
3415 | for (var k in o) { | |
85b99f0b DV |
3416 | if (o.hasOwnProperty(k)) { |
3417 | self[k] = o[k]; | |
3418 | } | |
fc80a396 DV |
3419 | } |
3420 | } | |
3421 | return self; | |
3422 | }; | |
3423 | ||
2dda3850 DV |
3424 | Dygraph.isArrayLike = function (o) { |
3425 | var typ = typeof(o); | |
3426 | if ( | |
c21d2c2d | 3427 | (typ != 'object' && !(typ == 'function' && |
2dda3850 DV |
3428 | typeof(o.item) == 'function')) || |
3429 | o === null || | |
3430 | typeof(o.length) != 'number' || | |
3431 | o.nodeType === 3 | |
3432 | ) { | |
3433 | return false; | |
3434 | } | |
3435 | return true; | |
3436 | }; | |
3437 | ||
3438 | Dygraph.isDateLike = function (o) { | |
3439 | if (typeof(o) != "object" || o === null || | |
3440 | typeof(o.getTime) != 'function') { | |
3441 | return false; | |
3442 | } | |
3443 | return true; | |
3444 | }; | |
3445 | ||
e3ab7b40 DV |
3446 | Dygraph.clone = function(o) { |
3447 | // TODO(danvk): figure out how MochiKit's version works | |
3448 | var r = []; | |
3449 | for (var i = 0; i < o.length; i++) { | |
3450 | if (Dygraph.isArrayLike(o[i])) { | |
3451 | r.push(Dygraph.clone(o[i])); | |
3452 | } else { | |
3453 | r.push(o[i]); | |
3454 | } | |
3455 | } | |
3456 | return r; | |
24e5350c DV |
3457 | }; |
3458 | ||
2dda3850 | 3459 | |
79420a1e | 3460 | /** |
6a1aa64f DV |
3461 | * Get the CSV data. If it's in a function, call that function. If it's in a |
3462 | * file, do an XMLHttpRequest to get it. | |
3463 | * @private | |
3464 | */ | |
285a6bda | 3465 | Dygraph.prototype.start_ = function() { |
6a1aa64f | 3466 | if (typeof this.file_ == 'function') { |
285a6bda | 3467 | // CSV string. Pretend we got it via XHR. |
6a1aa64f | 3468 | this.loadedEvent_(this.file_()); |
2dda3850 | 3469 | } else if (Dygraph.isArrayLike(this.file_)) { |
285a6bda | 3470 | this.rawData_ = this.parseArray_(this.file_); |
26ca7938 | 3471 | this.predraw_(); |
79420a1e DV |
3472 | } else if (typeof this.file_ == 'object' && |
3473 | typeof this.file_.getColumnRange == 'function') { | |
3474 | // must be a DataTable from gviz. | |
a685723c | 3475 | this.parseDataTable_(this.file_); |
26ca7938 | 3476 | this.predraw_(); |
285a6bda DV |
3477 | } else if (typeof this.file_ == 'string') { |
3478 | // Heuristic: a newline means it's CSV data. Otherwise it's an URL. | |
3479 | if (this.file_.indexOf('\n') >= 0) { | |
3480 | this.loadedEvent_(this.file_); | |
3481 | } else { | |
3482 | var req = new XMLHttpRequest(); | |
3483 | var caller = this; | |
3484 | req.onreadystatechange = function () { | |
3485 | if (req.readyState == 4) { | |
3486 | if (req.status == 200) { | |
3487 | caller.loadedEvent_(req.responseText); | |
3488 | } | |
6a1aa64f | 3489 | } |
285a6bda | 3490 | }; |
6a1aa64f | 3491 | |
285a6bda DV |
3492 | req.open("GET", this.file_, true); |
3493 | req.send(null); | |
3494 | } | |
3495 | } else { | |
3496 | this.error("Unknown data format: " + (typeof this.file_)); | |
6a1aa64f DV |
3497 | } |
3498 | }; | |
3499 | ||
3500 | /** | |
3501 | * Changes various properties of the graph. These can include: | |
3502 | * <ul> | |
3503 | * <li>file: changes the source data for the graph</li> | |
3504 | * <li>errorBars: changes whether the data contains stddev</li> | |
3505 | * </ul> | |
dcb25130 | 3506 | * |
6a1aa64f DV |
3507 | * @param {Object} attrs The new properties and values |
3508 | */ | |
285a6bda DV |
3509 | Dygraph.prototype.updateOptions = function(attrs) { |
3510 | // TODO(danvk): this is a mess. Rethink this function. | |
c65f2303 | 3511 | if ('rollPeriod' in attrs) { |
6a1aa64f DV |
3512 | this.rollPeriod_ = attrs.rollPeriod; |
3513 | } | |
c65f2303 | 3514 | if ('dateWindow' in attrs) { |
6a1aa64f | 3515 | this.dateWindow_ = attrs.dateWindow; |
e5152598 | 3516 | if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) { |
81856f70 NN |
3517 | this.zoomed_x_ = attrs.dateWindow != null; |
3518 | } | |
b7e5862d | 3519 | } |
e5152598 | 3520 | if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) { |
b7e5862d | 3521 | this.zoomed_y_ = attrs.valueRange != null; |
6a1aa64f | 3522 | } |
450fe64b DV |
3523 | |
3524 | // TODO(danvk): validate per-series options. | |
46dde5f9 DV |
3525 | // Supported: |
3526 | // strokeWidth | |
3527 | // pointSize | |
3528 | // drawPoints | |
3529 | // highlightCircleSize | |
450fe64b | 3530 | |
fc80a396 | 3531 | Dygraph.update(this.user_attrs_, attrs); |
87bb7958 | 3532 | Dygraph.update(this.renderOptions_, attrs); |
285a6bda DV |
3533 | |
3534 | this.labelsFromCSV_ = (this.attr_("labels") == null); | |
3535 | ||
3536 | // TODO(danvk): this doesn't match the constructor logic | |
3537 | this.layout_.updateOptions({ 'errorBars': this.attr_("errorBars") }); | |
5e50289f | 3538 | if (attrs['file']) { |
6a1aa64f DV |
3539 | this.file_ = attrs['file']; |
3540 | this.start_(); | |
3541 | } else { | |
26ca7938 | 3542 | this.predraw_(); |
6a1aa64f DV |
3543 | } |
3544 | }; | |
3545 | ||
3546 | /** | |
697e70b2 DV |
3547 | * Resizes the dygraph. If no parameters are specified, resizes to fill the |
3548 | * containing div (which has presumably changed size since the dygraph was | |
3549 | * instantiated. If the width/height are specified, the div will be resized. | |
964f30c6 DV |
3550 | * |
3551 | * This is far more efficient than destroying and re-instantiating a | |
3552 | * Dygraph, since it doesn't have to reparse the underlying data. | |
3553 | * | |
697e70b2 DV |
3554 | * @param {Number} width Width (in pixels) |
3555 | * @param {Number} height Height (in pixels) | |
3556 | */ | |
3557 | Dygraph.prototype.resize = function(width, height) { | |
e8c7ef86 DV |
3558 | if (this.resize_lock) { |
3559 | return; | |
3560 | } | |
3561 | this.resize_lock = true; | |
3562 | ||
697e70b2 DV |
3563 | if ((width === null) != (height === null)) { |
3564 | this.warn("Dygraph.resize() should be called with zero parameters or " + | |
3565 | "two non-NULL parameters. Pretending it was zero."); | |
3566 | width = height = null; | |
3567 | } | |
3568 | ||
b16e6369 | 3569 | // TODO(danvk): there should be a clear() method. |
697e70b2 | 3570 | this.maindiv_.innerHTML = ""; |
b16e6369 DV |
3571 | this.attrs_.labelsDiv = null; |
3572 | ||
697e70b2 DV |
3573 | if (width) { |
3574 | this.maindiv_.style.width = width + "px"; | |
3575 | this.maindiv_.style.height = height + "px"; | |
3576 | this.width_ = width; | |
3577 | this.height_ = height; | |
3578 | } else { | |
3579 | this.width_ = this.maindiv_.offsetWidth; | |
3580 | this.height_ = this.maindiv_.offsetHeight; | |
3581 | } | |
3582 | ||
3583 | this.createInterface_(); | |
26ca7938 | 3584 | this.predraw_(); |
e8c7ef86 DV |
3585 | |
3586 | this.resize_lock = false; | |
697e70b2 DV |
3587 | }; |
3588 | ||
3589 | /** | |
6faebb69 | 3590 | * Adjusts the number of points in the rolling average. Updates the graph to |
6a1aa64f | 3591 | * reflect the new averaging period. |
6faebb69 | 3592 | * @param {Number} length Number of points over which to average the data. |
6a1aa64f | 3593 | */ |
285a6bda | 3594 | Dygraph.prototype.adjustRoll = function(length) { |
6a1aa64f | 3595 | this.rollPeriod_ = length; |
26ca7938 | 3596 | this.predraw_(); |
6a1aa64f | 3597 | }; |
540d00f1 | 3598 | |
f8cfec73 | 3599 | /** |
1cf11047 DV |
3600 | * Returns a boolean array of visibility statuses. |
3601 | */ | |
3602 | Dygraph.prototype.visibility = function() { | |
3603 | // Do lazy-initialization, so that this happens after we know the number of | |
3604 | // data series. | |
3605 | if (!this.attr_("visibility")) { | |
f38dec01 | 3606 | this.attrs_["visibility"] = []; |
1cf11047 DV |
3607 | } |
3608 | while (this.attr_("visibility").length < this.rawData_[0].length - 1) { | |
f38dec01 | 3609 | this.attr_("visibility").push(true); |
1cf11047 DV |
3610 | } |
3611 | return this.attr_("visibility"); | |
3612 | }; | |
3613 | ||
3614 | /** | |
3615 | * Changes the visiblity of a series. | |
3616 | */ | |
3617 | Dygraph.prototype.setVisibility = function(num, value) { | |
3618 | var x = this.visibility(); | |
a6c109c1 | 3619 | if (num < 0 || num >= x.length) { |
1cf11047 DV |
3620 | this.warn("invalid series number in setVisibility: " + num); |
3621 | } else { | |
3622 | x[num] = value; | |
26ca7938 | 3623 | this.predraw_(); |
1cf11047 DV |
3624 | } |
3625 | }; | |
3626 | ||
3627 | /** | |
5c528fa2 DV |
3628 | * Update the list of annotations and redraw the chart. |
3629 | */ | |
a685723c | 3630 | Dygraph.prototype.setAnnotations = function(ann, suppressDraw) { |
3c51ab74 DV |
3631 | // Only add the annotation CSS rule once we know it will be used. |
3632 | Dygraph.addAnnotationRule(); | |
5c528fa2 DV |
3633 | this.annotations_ = ann; |
3634 | this.layout_.setAnnotations(this.annotations_); | |
a685723c | 3635 | if (!suppressDraw) { |
26ca7938 | 3636 | this.predraw_(); |
a685723c | 3637 | } |
5c528fa2 DV |
3638 | }; |
3639 | ||
3640 | /** | |
3641 | * Return the list of annotations. | |
3642 | */ | |
3643 | Dygraph.prototype.annotations = function() { | |
3644 | return this.annotations_; | |
3645 | }; | |
3646 | ||
46dde5f9 DV |
3647 | /** |
3648 | * Get the index of a series (column) given its name. The first column is the | |
3649 | * x-axis, so the data series start with index 1. | |
3650 | */ | |
3651 | Dygraph.prototype.indexFromSetName = function(name) { | |
3652 | var labels = this.attr_("labels"); | |
3653 | for (var i = 0; i < labels.length; i++) { | |
3654 | if (labels[i] == name) return i; | |
3655 | } | |
3656 | return null; | |
3657 | }; | |
3658 | ||
5c528fa2 DV |
3659 | Dygraph.addAnnotationRule = function() { |
3660 | if (Dygraph.addedAnnotationCSS) return; | |
3661 | ||
5c528fa2 DV |
3662 | var rule = "border: 1px solid black; " + |
3663 | "background-color: white; " + | |
3664 | "text-align: center;"; | |
22186871 DV |
3665 | |
3666 | var styleSheetElement = document.createElement("style"); | |
3667 | styleSheetElement.type = "text/css"; | |
3668 | document.getElementsByTagName("head")[0].appendChild(styleSheetElement); | |
3669 | ||
3670 | // Find the first style sheet that we can access. | |
3671 | // We may not add a rule to a style sheet from another domain for security | |
3672 | // reasons. This sometimes comes up when using gviz, since the Google gviz JS | |
3673 | // adds its own style sheets from google.com. | |
3674 | for (var i = 0; i < document.styleSheets.length; i++) { | |
3675 | if (document.styleSheets[i].disabled) continue; | |
3676 | var mysheet = document.styleSheets[i]; | |
3677 | try { | |
3678 | if (mysheet.insertRule) { // Firefox | |
3679 | var idx = mysheet.cssRules ? mysheet.cssRules.length : 0; | |
3680 | mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx); | |
3681 | } else if (mysheet.addRule) { // IE | |
3682 | mysheet.addRule(".dygraphDefaultAnnotation", rule); | |
3683 | } | |
3684 | Dygraph.addedAnnotationCSS = true; | |
3685 | return; | |
3686 | } catch(err) { | |
3687 | // Was likely a security exception. | |
3688 | } | |
5c528fa2 DV |
3689 | } |
3690 | ||
22186871 | 3691 | this.warn("Unable to add default annotation CSS rule; display may be off."); |
5c528fa2 DV |
3692 | } |
3693 | ||
3694 | /** | |
f8cfec73 DV |
3695 | * Create a new canvas element. This is more complex than a simple |
3696 | * document.createElement("canvas") because of IE and excanvas. | |
3697 | */ | |
3698 | Dygraph.createCanvas = function() { | |
3699 | var canvas = document.createElement("canvas"); | |
3700 | ||
3701 | isIE = (/MSIE/.test(navigator.userAgent) && !window.opera); | |
8b8f2d59 | 3702 | if (isIE && (typeof(G_vmlCanvasManager) != 'undefined')) { |
f8cfec73 DV |
3703 | canvas = G_vmlCanvasManager.initElement(canvas); |
3704 | } | |
3705 | ||
3706 | return canvas; | |
3707 | }; | |
3708 | ||
540d00f1 DV |
3709 | |
3710 | /** | |
285a6bda | 3711 | * A wrapper around Dygraph that implements the gviz API. |
540d00f1 DV |
3712 | * @param {Object} container The DOM object the visualization should live in. |
3713 | */ | |
285a6bda | 3714 | Dygraph.GVizChart = function(container) { |
540d00f1 DV |
3715 | this.container = container; |
3716 | } | |
3717 | ||
285a6bda | 3718 | Dygraph.GVizChart.prototype.draw = function(data, options) { |
c91f4ae8 DV |
3719 | // Clear out any existing dygraph. |
3720 | // TODO(danvk): would it make more sense to simply redraw using the current | |
3721 | // date_graph object? | |
540d00f1 | 3722 | this.container.innerHTML = ''; |
c91f4ae8 DV |
3723 | if (typeof(this.date_graph) != 'undefined') { |
3724 | this.date_graph.destroy(); | |
3725 | } | |
3726 | ||
285a6bda | 3727 | this.date_graph = new Dygraph(this.container, data, options); |
540d00f1 | 3728 | } |
285a6bda | 3729 | |
239c712d NAG |
3730 | /** |
3731 | * Google charts compatible setSelection | |
50360fd0 | 3732 | * Only row selection is supported, all points in the row will be highlighted |
239c712d NAG |
3733 | * @param {Array} array of the selected cells |
3734 | * @public | |
3735 | */ | |
3736 | Dygraph.GVizChart.prototype.setSelection = function(selection_array) { | |
3737 | var row = false; | |
3738 | if (selection_array.length) { | |
3739 | row = selection_array[0].row; | |
3740 | } | |
3741 | this.date_graph.setSelection(row); | |
3742 | } | |
3743 | ||
103b7292 NAG |
3744 | /** |
3745 | * Google charts compatible getSelection implementation | |
3746 | * @return {Array} array of the selected cells | |
3747 | * @public | |
3748 | */ | |
3749 | Dygraph.GVizChart.prototype.getSelection = function() { | |
3750 | var selection = []; | |
50360fd0 | 3751 | |
103b7292 | 3752 | var row = this.date_graph.getSelection(); |
50360fd0 | 3753 | |
103b7292 | 3754 | if (row < 0) return selection; |
50360fd0 | 3755 | |
103b7292 NAG |
3756 | col = 1; |
3757 | for (var i in this.date_graph.layout_.datasets) { | |
3758 | selection.push({row: row, column: col}); | |
3759 | col++; | |
3760 | } | |
3761 | ||
3762 | return selection; | |
3763 | } | |
3764 | ||
285a6bda DV |
3765 | // Older pages may still use this name. |
3766 | DateGraph = Dygraph; | |
028ddf8a DV |
3767 | |
3768 | // <REMOVE_FOR_COMBINED> | |
0addac07 DV |
3769 | Dygraph.OPTIONS_REFERENCE = // <JSON> |
3770 | { | |
a38e9336 DV |
3771 | "xValueParser": { |
3772 | "default": "parseFloat() or Date.parse()*", | |
3773 | "labels": ["CSV parsing"], | |
3774 | "type": "function(str) -> number", | |
3775 | "description": "A function which parses x-values (i.e. the dependent series). Must return a number, even when the values are dates. In this case, millis since epoch are used. This is used primarily for parsing CSV data. *=Dygraphs is slightly more accepting in the dates which it will parse. See code for details." | |
3776 | }, | |
3777 | "stackedGraph": { | |
a96f59f4 | 3778 | "default": "false", |
a38e9336 DV |
3779 | "labels": ["Data Line display"], |
3780 | "type": "boolean", | |
3781 | "description": "If set, stack series on top of one another rather than drawing them independently." | |
a96f59f4 | 3782 | }, |
a38e9336 | 3783 | "pointSize": { |
a96f59f4 | 3784 | "default": "1", |
a38e9336 DV |
3785 | "labels": ["Data Line display"], |
3786 | "type": "integer", | |
3787 | "description": "The size of the dot to draw on each point in pixels (see drawPoints). A dot is always drawn when a point is \"isolated\", i.e. there is a missing point on either side of it. This also controls the size of those dots." | |
a96f59f4 | 3788 | }, |
a38e9336 DV |
3789 | "labelsDivStyles": { |
3790 | "default": "null", | |
3791 | "labels": ["Legend"], | |
3792 | "type": "{}", | |
3793 | "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold." | |
a96f59f4 | 3794 | }, |
a38e9336 | 3795 | "drawPoints": { |
a96f59f4 | 3796 | "default": "false", |
a38e9336 DV |
3797 | "labels": ["Data Line display"], |
3798 | "type": "boolean", | |
3799 | "description": "Draw a small dot at each point, in addition to a line going through the point. This makes the individual data points easier to see, but can increase visual clutter in the chart." | |
a96f59f4 | 3800 | }, |
a38e9336 DV |
3801 | "height": { |
3802 | "default": "320", | |
3803 | "labels": ["Overall display"], | |
3804 | "type": "integer", | |
3805 | "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored." | |
a96f59f4 DV |
3806 | }, |
3807 | "zoomCallback": { | |
a96f59f4 | 3808 | "default": "null", |
a38e9336 DV |
3809 | "labels": ["Callbacks"], |
3810 | "type": "function(minDate, maxDate, yRanges)", | |
a96f59f4 DV |
3811 | "description": "A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. yRanges is an array of [bottom, top] pairs, one for each y-axis." |
3812 | }, | |
a38e9336 DV |
3813 | "pointClickCallback": { |
3814 | "default": "", | |
3815 | "labels": ["Callbacks", "Interactive Elements"], | |
3816 | "type": "", | |
3817 | "description": "" | |
a96f59f4 | 3818 | }, |
a38e9336 DV |
3819 | "colors": { |
3820 | "default": "(see description)", | |
3821 | "labels": ["Data Series Colors"], | |
3822 | "type": "array<string>", | |
3823 | "example": "['red', '#00FF00']", | |
3824 | "description": "List of colors for the data series. These can be of the form \"#AABBCC\" or \"rgb(255,100,200)\" or \"yellow\", etc. If not specified, equally-spaced points around a color wheel are used." | |
a96f59f4 | 3825 | }, |
a38e9336 | 3826 | "connectSeparatedPoints": { |
a96f59f4 | 3827 | "default": "false", |
a38e9336 DV |
3828 | "labels": ["Data Line display"], |
3829 | "type": "boolean", | |
3830 | "description": "Usually, when Dygraphs encounters a missing value in a data series, it interprets this as a gap and draws it as such. If, instead, the missing values represents an x-value for which only a different series has data, then you'll want to connect the dots by setting this to true. To explicitly include a gap with this option set, use a value of NaN." | |
a96f59f4 | 3831 | }, |
a38e9336 | 3832 | "highlightCallback": { |
a96f59f4 | 3833 | "default": "null", |
a38e9336 DV |
3834 | "labels": ["Callbacks"], |
3835 | "type": "function(event, x, points,row)", | |
3836 | "description": "When set, this callback gets called every time a new point is highlighted. The parameters are the JavaScript mousemove event, the x-coordinate of the highlighted points and an array of highlighted points: <code>[ {name: 'series', yval: y-value}, … ]</code>" | |
a96f59f4 | 3837 | }, |
a38e9336 | 3838 | "includeZero": { |
a96f59f4 | 3839 | "default": "false", |
a38e9336 | 3840 | "labels": ["Axis display"], |
a96f59f4 | 3841 | "type": "boolean", |
a38e9336 | 3842 | "description": "Usually, dygraphs will use the range of the data plus some padding to set the range of the y-axis. If this option is set, the y-axis will always include zero, typically as the lowest value. This can be used to avoid exaggerating the variance in the data" |
a96f59f4 | 3843 | }, |
a38e9336 DV |
3844 | "rollPeriod": { |
3845 | "default": "1", | |
3846 | "labels": ["Error Bars", "Rolling Averages"], | |
3847 | "type": "integer >= 1", | |
3848 | "description": "Number of days over which to average data. Discussed extensively above." | |
a96f59f4 | 3849 | }, |
a38e9336 | 3850 | "unhighlightCallback": { |
a96f59f4 | 3851 | "default": "null", |
a38e9336 DV |
3852 | "labels": ["Callbacks"], |
3853 | "type": "function(event)", | |
3854 | "description": "When set, this callback gets called every time the user stops highlighting any point by mousing out of the graph. The parameter is the mouseout event." | |
a96f59f4 | 3855 | }, |
a38e9336 DV |
3856 | "axisTickSize": { |
3857 | "default": "3.0", | |
3858 | "labels": ["Axis display"], | |
3859 | "type": "number", | |
3860 | "description": "The size of the line to display next to each tick mark on x- or y-axes." | |
a96f59f4 | 3861 | }, |
a38e9336 | 3862 | "labelsSeparateLines": { |
a96f59f4 | 3863 | "default": "false", |
a38e9336 DV |
3864 | "labels": ["Legend"], |
3865 | "type": "boolean", | |
3866 | "description": "Put <code><br/></code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>." | |
a96f59f4 | 3867 | }, |
a38e9336 DV |
3868 | "xValueFormatter": { |
3869 | "default": "(Round to 2 decimal places)", | |
3870 | "labels": ["Axis display"], | |
3871 | "type": "function(x)", | |
3872 | "description": "Function to provide a custom display format for the X value for mouseover." | |
a96f59f4 DV |
3873 | }, |
3874 | "pixelsPerYLabel": { | |
a96f59f4 | 3875 | "default": "30", |
a38e9336 DV |
3876 | "labels": ["Axis display", "Grid"], |
3877 | "type": "integer", | |
a96f59f4 DV |
3878 | "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks." |
3879 | }, | |
a38e9336 | 3880 | "annotationMouseOverHandler": { |
5cc5f631 | 3881 | "default": "null", |
a38e9336 | 3882 | "labels": ["Annotations"], |
5cc5f631 DV |
3883 | "type": "function(annotation, point, dygraph, event)", |
3884 | "description": "If provided, this function is called whenever the user mouses over an annotation." | |
3885 | }, | |
3886 | "annotationMouseOutHandler": { | |
3887 | "default": "null", | |
3888 | "labels": ["Annotations"], | |
3889 | "type": "function(annotation, point, dygraph, event)", | |
3890 | "description": "If provided, this function is called whenever the user mouses out of an annotation." | |
a96f59f4 | 3891 | }, |
8165189e | 3892 | "annotationClickHandler": { |
5cc5f631 | 3893 | "default": "null", |
8165189e | 3894 | "labels": ["Annotations"], |
5cc5f631 DV |
3895 | "type": "function(annotation, point, dygraph, event)", |
3896 | "description": "If provided, this function is called whenever the user clicks on an annotation." | |
8165189e DV |
3897 | }, |
3898 | "annotationDblClickHandler": { | |
5cc5f631 | 3899 | "default": "null", |
8165189e | 3900 | "labels": ["Annotations"], |
5cc5f631 DV |
3901 | "type": "function(annotation, point, dygraph, event)", |
3902 | "description": "If provided, this function is called whenever the user double-clicks on an annotation." | |
8165189e | 3903 | }, |
a38e9336 DV |
3904 | "drawCallback": { |
3905 | "default": "null", | |
3906 | "labels": ["Callbacks"], | |
3907 | "type": "function(dygraph, is_initial)", | |
3908 | "description": "When set, this callback gets called every time the dygraph is drawn. This includes the initial draw, after zooming and repeatedly while panning. The first parameter is the dygraph being drawn. The second is a boolean value indicating whether this is the initial draw." | |
3909 | }, | |
3910 | "labelsKMG2": { | |
3911 | "default": "false", | |
3912 | "labels": ["Value display/formatting"], | |
3913 | "type": "boolean", | |
3914 | "description": "Show k/M/G for kilo/Mega/Giga on y-axis. This is different than <code>labelsKMB</code> in that it uses base 2, not 10." | |
3915 | }, | |
3916 | "delimiter": { | |
3917 | "default": ",", | |
3918 | "labels": ["CSV parsing"], | |
3919 | "type": "string", | |
3920 | "description": "The delimiter to look for when separating fields of a CSV file. Setting this to a tab is not usually necessary, since tab-delimited data is auto-detected." | |
a96f59f4 DV |
3921 | }, |
3922 | "axisLabelFontSize": { | |
a96f59f4 | 3923 | "default": "14", |
a38e9336 DV |
3924 | "labels": ["Axis display"], |
3925 | "type": "integer", | |
a96f59f4 DV |
3926 | "description": "Size of the font (in pixels) to use in the axis labels, both x- and y-axis." |
3927 | }, | |
a38e9336 DV |
3928 | "underlayCallback": { |
3929 | "default": "null", | |
3930 | "labels": ["Callbacks"], | |
3931 | "type": "function(canvas, area, dygraph)", | |
3932 | "description": "When set, this callback gets called before the chart is drawn. It details on how to use this." | |
a96f59f4 | 3933 | }, |
a38e9336 DV |
3934 | "width": { |
3935 | "default": "480", | |
3936 | "labels": ["Overall display"], | |
3937 | "type": "integer", | |
3938 | "description": "Width, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored." | |
a96f59f4 | 3939 | }, |
a38e9336 DV |
3940 | "interactionModel": { |
3941 | "default": "...", | |
3942 | "labels": ["Interactive Elements"], | |
3943 | "type": "Object", | |
3944 | "description": "TODO(konigsberg): document this" | |
3945 | }, | |
3946 | "xTicker": { | |
3947 | "default": "Dygraph.dateTicker or Dygraph.numericTicks", | |
3948 | "labels": ["Axis display"], | |
3949 | "type": "function(min, max, dygraph) -> [{v: ..., label: ...}, ...]", | |
3950 | "description": "This lets you specify an arbitrary function to generate tick marks on an axis. The tick marks are an array of (value, label) pairs. The built-in functions go to great lengths to choose good tick marks so, if you set this option, you'll most likely want to call one of them and modify the result." | |
3951 | }, | |
3952 | "xAxisLabelWidth": { | |
3953 | "default": "50", | |
3954 | "labels": ["Axis display"], | |
a96f59f4 | 3955 | "type": "integer", |
a38e9336 | 3956 | "description": "Width, in pixels, of the x-axis labels." |
a96f59f4 | 3957 | }, |
a38e9336 DV |
3958 | "showLabelsOnHighlight": { |
3959 | "default": "true", | |
3960 | "labels": ["Interactive Elements", "Legend"], | |
a96f59f4 | 3961 | "type": "boolean", |
a38e9336 | 3962 | "description": "Whether to show the legend upon mouseover." |
a96f59f4 | 3963 | }, |
a38e9336 DV |
3964 | "axis": { |
3965 | "default": "(none)", | |
3966 | "labels": ["Axis display"], | |
3967 | "type": "string or object", | |
3968 | "description": "Set to either an object ({}) filled with options for this axis or to the name of an existing data series with its own axis to re-use that axis. See tests for usage." | |
3969 | }, | |
3970 | "pixelsPerXLabel": { | |
3971 | "default": "60", | |
3972 | "labels": ["Axis display", "Grid"], | |
a96f59f4 | 3973 | "type": "integer", |
a38e9336 DV |
3974 | "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks." |
3975 | }, | |
3976 | "labelsDiv": { | |
3977 | "default": "null", | |
3978 | "labels": ["Legend"], | |
3979 | "type": "DOM element or string", | |
3980 | "example": "<code style='font-size: small'>document.getElementById('foo')</code>or<code>'foo'", | |
3981 | "description": "Show data labels in an external div, rather than on the graph. This value can either be a div element or a div id." | |
a96f59f4 DV |
3982 | }, |
3983 | "fractions": { | |
a96f59f4 | 3984 | "default": "false", |
a38e9336 DV |
3985 | "labels": ["CSV parsing", "Error Bars"], |
3986 | "type": "boolean", | |
a96f59f4 DV |
3987 | "description": "When set, attempt to parse each cell in the CSV file as \"a/b\", where a and b are integers. The ratio will be plotted. This allows computation of Wilson confidence intervals (see below)." |
3988 | }, | |
a38e9336 DV |
3989 | "logscale": { |
3990 | "default": "false", | |
3991 | "labels": ["Axis display"], | |
a96f59f4 | 3992 | "type": "boolean", |
a109b711 | 3993 | "description": "When set for a y-axis, the graph shows that axis in log scale. Any values less than or equal to zero are not displayed.\n\nNot compatible with showZero, and ignores connectSeparatedPoints. Also, showing log scale with valueRanges that are less than zero will result in an unviewable graph." |
a38e9336 DV |
3994 | }, |
3995 | "strokeWidth": { | |
3996 | "default": "1.0", | |
3997 | "labels": ["Data Line display"], | |
3998 | "type": "integer", | |
3999 | "example": "0.5, 2.0", | |
4000 | "description": "The width of the lines connecting data points. This can be used to increase the contrast or some graphs." | |
4001 | }, | |
4002 | "wilsonInterval": { | |
a96f59f4 | 4003 | "default": "true", |
a38e9336 DV |
4004 | "labels": ["Error Bars"], |
4005 | "type": "boolean", | |
a96f59f4 DV |
4006 | "description": "Use in conjunction with the \"fractions\" option. Instead of plotting +/- N standard deviations, dygraphs will compute a Wilson confidence interval and plot that. This has more reasonable behavior for ratios close to 0 or 1." |
4007 | }, | |
a38e9336 | 4008 | "fillGraph": { |
a96f59f4 | 4009 | "default": "false", |
a38e9336 DV |
4010 | "labels": ["Data Line display"], |
4011 | "type": "boolean", | |
4012 | "description": "Should the area underneath the graph be filled? This option is not compatible with error bars." | |
a96f59f4 | 4013 | }, |
a38e9336 DV |
4014 | "highlightCircleSize": { |
4015 | "default": "3", | |
4016 | "labels": ["Interactive Elements"], | |
4017 | "type": "integer", | |
4018 | "description": "The size in pixels of the dot drawn over highlighted points." | |
a96f59f4 DV |
4019 | }, |
4020 | "gridLineColor": { | |
a96f59f4 | 4021 | "default": "rgb(128,128,128)", |
a38e9336 DV |
4022 | "labels": ["Grid"], |
4023 | "type": "red, blue", | |
a96f59f4 DV |
4024 | "description": "The color of the gridlines." |
4025 | }, | |
a38e9336 DV |
4026 | "visibility": { |
4027 | "default": "[true, true, ...]", | |
4028 | "labels": ["Data Line display"], | |
4029 | "type": "Array of booleans", | |
4030 | "description": "Which series should initially be visible? Once the Dygraph has been constructed, you can access and modify the visibility of each series using the <code>visibility</code> and <code>setVisibility</code> methods." | |
a96f59f4 | 4031 | }, |
a38e9336 DV |
4032 | "valueRange": { |
4033 | "default": "Full range of the input is shown", | |
4034 | "labels": ["Axis display"], | |
4035 | "type": "Array of two numbers", | |
4036 | "example": "[10, 110]", | |
4037 | "description": "Explicitly set the vertical range of the graph to [low, high]." | |
a96f59f4 | 4038 | }, |
a38e9336 DV |
4039 | "labelsDivWidth": { |
4040 | "default": "250", | |
4041 | "labels": ["Legend"], | |
a96f59f4 | 4042 | "type": "integer", |
a38e9336 | 4043 | "description": "Width (in pixels) of the div which shows information on the currently-highlighted points." |
a96f59f4 | 4044 | }, |
a38e9336 DV |
4045 | "colorSaturation": { |
4046 | "default": "1.0", | |
4047 | "labels": ["Data Series Colors"], | |
4048 | "type": "0.0 - 1.0", | |
4049 | "description": "If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors." | |
4050 | }, | |
4051 | "yAxisLabelWidth": { | |
4052 | "default": "50", | |
4053 | "labels": ["Axis display"], | |
a96f59f4 | 4054 | "type": "integer", |
a38e9336 | 4055 | "description": "Width, in pixels, of the y-axis labels." |
a96f59f4 | 4056 | }, |
a38e9336 DV |
4057 | "hideOverlayOnMouseOut": { |
4058 | "default": "true", | |
4059 | "labels": ["Interactive Elements", "Legend"], | |
a96f59f4 | 4060 | "type": "boolean", |
a38e9336 | 4061 | "description": "Whether to hide the legend when the mouse leaves the chart area." |
a96f59f4 DV |
4062 | }, |
4063 | "yValueFormatter": { | |
a96f59f4 | 4064 | "default": "(Round to 2 decimal places)", |
a38e9336 DV |
4065 | "labels": ["Axis display"], |
4066 | "type": "function(x)", | |
a96f59f4 DV |
4067 | "description": "Function to provide a custom display format for the Y value for mouseover." |
4068 | }, | |
a38e9336 DV |
4069 | "legend": { |
4070 | "default": "onmouseover", | |
4071 | "labels": ["Legend"], | |
4072 | "type": "string", | |
4073 | "description": "When to display the legend. By default, it only appears when a user mouses over the chart. Set it to \"always\" to always display a legend of some sort." | |
4074 | }, | |
4075 | "labelsShowZeroValues": { | |
4076 | "default": "true", | |
4077 | "labels": ["Legend"], | |
a96f59f4 | 4078 | "type": "boolean", |
a38e9336 DV |
4079 | "description": "Show zero value labels in the labelsDiv." |
4080 | }, | |
4081 | "stepPlot": { | |
a96f59f4 | 4082 | "default": "false", |
a38e9336 DV |
4083 | "labels": ["Data Line display"], |
4084 | "type": "boolean", | |
4085 | "description": "When set, display the graph as a step plot instead of a line plot." | |
a96f59f4 | 4086 | }, |
a38e9336 DV |
4087 | "labelsKMB": { |
4088 | "default": "false", | |
4089 | "labels": ["Value display/formatting"], | |
a96f59f4 | 4090 | "type": "boolean", |
a38e9336 DV |
4091 | "description": "Show K/M/B for thousands/millions/billions on y-axis." |
4092 | }, | |
4093 | "rightGap": { | |
4094 | "default": "5", | |
4095 | "labels": ["Overall display"], | |
4096 | "type": "integer", | |
4097 | "description": "Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point." | |
4098 | }, | |
4099 | "avoidMinZero": { | |
a96f59f4 | 4100 | "default": "false", |
a38e9336 DV |
4101 | "labels": ["Axis display"], |
4102 | "type": "boolean", | |
4103 | "description": "When set, the heuristic that fixes the Y axis at zero for a data set with the minimum Y value of zero is disabled. \nThis is particularly useful for data sets that contain many zero values, especially for step plots which may otherwise have lines not visible running along the bottom axis." | |
4104 | }, | |
4105 | "xAxisLabelFormatter": { | |
4106 | "default": "Dygraph.dateAxisFormatter", | |
4107 | "labels": ["Axis display", "Value display/formatting"], | |
4108 | "type": "function(date, granularity)", | |
4109 | "description": "Function to call to format values along the x axis." | |
4110 | }, | |
4111 | "clickCallback": { | |
4112 | "snippet": "function(e, date){<br> alert(date);<br>}", | |
4113 | "default": "null", | |
4114 | "labels": ["Callbacks"], | |
4115 | "type": "function(e, date)", | |
4116 | "description": "A function to call when a data point is clicked. The function should take two arguments, the event object for the click and the date that was clicked." | |
4117 | }, | |
4118 | "yAxisLabelFormatter": { | |
4119 | "default": "yValueFormatter", | |
4120 | "labels": ["Axis display", "Value display/formatting"], | |
4121 | "type": "function(x)", | |
4122 | "description": "Function used to format values along the Y axis. By default it uses the same as the <code>yValueFormatter</code> unless specified." | |
a96f59f4 DV |
4123 | }, |
4124 | "labels": { | |
a96f59f4 | 4125 | "default": "[\"X\", \"Y1\", \"Y2\", ...]*", |
a38e9336 DV |
4126 | "labels": ["Legend"], |
4127 | "type": "array<string>", | |
a96f59f4 DV |
4128 | "description": "A name for each data series, including the independent (X) series. For CSV files and DataTable objections, this is determined by context. For raw data, this must be specified. If it is not, default values are supplied and a warning is logged." |
4129 | }, | |
a38e9336 DV |
4130 | "dateWindow": { |
4131 | "default": "Full range of the input is shown", | |
4132 | "labels": ["Axis display"], | |
4133 | "type": "Array of two Dates or numbers", | |
4134 | "example": "[<br> Date.parse('2006-01-01'),<br> (new Date()).valueOf()<br>]", | |
4135 | "description": "Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch. If the data for the x-axis is numeric, the values in dateWindow must also be numbers." | |
a96f59f4 | 4136 | }, |
a38e9336 DV |
4137 | "showRoller": { |
4138 | "default": "false", | |
4139 | "labels": ["Interactive Elements", "Rolling Averages"], | |
4140 | "type": "boolean", | |
4141 | "description": "If the rolling average period text box should be shown." | |
a96f59f4 | 4142 | }, |
a38e9336 DV |
4143 | "sigma": { |
4144 | "default": "2.0", | |
4145 | "labels": ["Error Bars"], | |
ca49434a | 4146 | "type": "float", |
a38e9336 | 4147 | "description": "When errorBars is set, shade this many standard deviations above/below each point." |
a96f59f4 | 4148 | }, |
a38e9336 | 4149 | "customBars": { |
a96f59f4 | 4150 | "default": "false", |
a38e9336 | 4151 | "labels": ["CSV parsing", "Error Bars"], |
a96f59f4 | 4152 | "type": "boolean", |
a38e9336 | 4153 | "description": "When set, parse each CSV cell as \"low;middle;high\". Error bars will be drawn for each point between low and high, with the series itself going through middle." |
a96f59f4 | 4154 | }, |
a38e9336 DV |
4155 | "colorValue": { |
4156 | "default": "1.0", | |
4157 | "labels": ["Data Series Colors"], | |
4158 | "type": "float (0.0 - 1.0)", | |
4159 | "description": "If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)" | |
a96f59f4 | 4160 | }, |
a38e9336 DV |
4161 | "errorBars": { |
4162 | "default": "false", | |
4163 | "labels": ["CSV parsing", "Error Bars"], | |
a96f59f4 | 4164 | "type": "boolean", |
a38e9336 | 4165 | "description": "Does the data contain standard deviations? Setting this to true alters the input format (see above)." |
a96f59f4 | 4166 | }, |
a38e9336 DV |
4167 | "displayAnnotations": { |
4168 | "default": "false", | |
4169 | "labels": ["Annotations"], | |
a96f59f4 | 4170 | "type": "boolean", |
a38e9336 | 4171 | "description": "Only applies when Dygraphs is used as a GViz chart. Causes string columns following a data series to be interpreted as annotations on points in that series. This is the same format used by Google's AnnotatedTimeLine chart." |
4cac8c7a | 4172 | }, |
965a030e | 4173 | "panEdgeFraction": { |
4cac8c7a | 4174 | "default": "null", |
965a030e | 4175 | "labels": ["Axis Display", "Interactive Elements"], |
4cac8c7a RK |
4176 | "type": "float", |
4177 | "default": "null", | |
4178 | "description": "A value representing the farthest a graph may be panned, in percent of the display. For example, a value of 0.1 means that the graph can only be panned 10% pased the edges of the displayed values. null means no bounds." | |
ca49434a DV |
4179 | }, |
4180 | "title": { | |
4181 | "labels": ["Chart labels"], | |
4182 | "type": "string", | |
4183 | "default": "null", | |
4184 | "description": "Text to display above the chart. You can supply any HTML for this value, not just text. If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-title' classes." | |
4185 | }, | |
4186 | "titleHeight": { | |
4187 | "default": "18", | |
4188 | "labels": ["Chart labels"], | |
4189 | "type": "integer", | |
4190 | "description": "Height of the chart title, in pixels. This also controls the default font size of the title. If you style the title on your own, this controls how much space is set aside above the chart for the title's div." | |
4191 | }, | |
4192 | "xlabel": { | |
4193 | "labels": ["Chart labels"], | |
4194 | "type": "string", | |
4195 | "default": "null", | |
4196 | "description": "Text to display below the chart's x-axis. You can supply any HTML for this value, not just text. If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-xlabel' classes." | |
4197 | }, | |
4198 | "xLabelHeight": { | |
4199 | "labels": ["Chart labels"], | |
4200 | "type": "integer", | |
4201 | "default": "18", | |
4202 | "description": "Height of the x-axis label, in pixels. This also controls the default font size of the x-axis label. If you style the label on your own, this controls how much space is set aside below the chart for the x-axis label's div." | |
4203 | }, | |
4204 | "ylabel": { | |
4205 | "labels": ["Chart labels"], | |
4206 | "type": "string", | |
4207 | "default": "null", | |
4208 | "description": "Text to display to the left of the chart's y-axis. You can supply any HTML for this value, not just text. If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-ylabel' classes. The text will be rotated 90 degrees by default, so CSS rules may behave in unintuitive ways. No additional space is set aside for a y-axis label. If you need more space, increase the width of the y-axis tick labels using the yAxisLabelWidth option. If you need a wider div for the y-axis label, either style it that way with CSS (but remember that it's rotated, so width is controlled by the 'height' property) or set the yLabelWidth option." | |
4209 | }, | |
4210 | "yLabelWidth": { | |
4211 | "labels": ["Chart labels"], | |
4212 | "type": "integer", | |
4213 | "default": "18", | |
4214 | "description": "Width of the div which contains the y-axis label. Since the y-axis label appears rotated 90 degrees, this actually affects the height of its div." | |
5bc3e265 | 4215 | }, |
e5152598 NN |
4216 | "isZoomedIgnoreProgrammaticZoom" : { |
4217 | "default": "false", | |
4218 | "labels": ["Zooming"], | |
4219 | "type": "boolean", | |
36dfa958 | 4220 | "description" : "When this option is passed to updateOptions() along with either the <code>dateWindow</code> or <code>valueRange</code> options, the zoom flags are not changed to reflect a zoomed state. This is primarily useful for when the display area of a chart is changed programmatically and also where manual zooming is allowed and use is made of the <code>isZoomed</code> method to determine this." |
17d0210c DV |
4221 | }, |
4222 | "sigFigs" : { | |
4223 | "default": "null", | |
4224 | "labels": ["Value display/formatting"], | |
4225 | "type": "integer", | |
4226 | "description": "By default, dygraphs displays numbers with a fixed number of digits after the decimal point. If you'd prefer to have a fixed number of significant figures, set this option to that number of sig figs. A value of 2, for instance, would cause 1 to be display as 1.0 and 1234 to be displayed as 1.23e+3." | |
4227 | }, | |
4228 | "digitsAfterDecimal" : { | |
4229 | "default": "2", | |
4230 | "labels": ["Value display/formatting"], | |
4231 | "type": "integer", | |
4232 | "description": "Unless it's run in scientific mode (see the <code>sigFigs</code> option), dygraphs displays numbers with <code>digitsAfterDecimal</code> digits after the decimal point. Trailing zeros are not displayed, so with a value of 2 you'll get '0', '0.1', '0.12', '123.45' but not '123.456' (it will be rounded to '123.46'). Numbers with absolute value less than 0.1^digitsAfterDecimal (i.e. those which would show up as '0.00') will be displayed in scientific notation." | |
4233 | }, | |
4234 | "maxNumberWidth" : { | |
4235 | "default": "6", | |
4236 | "labels": ["Value display/formatting"], | |
4237 | "type": "integer", | |
4238 | "description": "When displaying numbers in normal (not scientific) mode, large numbers will be displayed with many trailing zeros (e.g. 100000000 instead of 1e9). This can lead to unwieldy y-axis labels. If there are more than <code>maxNumberWidth</code> digits to the left of the decimal in a number, dygraphs will switch to scientific notation, even when not operating in scientific mode. If you'd like to see all those digits, set this to something large, like 20 or 30." | |
028ddf8a | 4239 | } |
0addac07 DV |
4240 | } |
4241 | ; // </JSON> | |
4242 | // NOTE: in addition to parsing as JS, this snippet is expected to be valid | |
4243 | // JSON. This assumption cannot be checked in JS, but it will be checked when | |
ca49434a DV |
4244 | // documentation is generated by the generate-documentation.py script. For the |
4245 | // most part, this just means that you should always use double quotes. | |
028ddf8a DV |
4246 | |
4247 | // Do a quick sanity check on the options reference. | |
4248 | (function() { | |
4249 | var warn = function(msg) { if (console) console.warn(msg); }; | |
4250 | var flds = ['type', 'default', 'description']; | |
a38e9336 DV |
4251 | var valid_cats = [ |
4252 | 'Annotations', | |
4253 | 'Axis display', | |
ca49434a | 4254 | 'Chart labels', |
a38e9336 DV |
4255 | 'CSV parsing', |
4256 | 'Callbacks', | |
4257 | 'Data Line display', | |
4258 | 'Data Series Colors', | |
4259 | 'Error Bars', | |
4260 | 'Grid', | |
4261 | 'Interactive Elements', | |
4262 | 'Legend', | |
4263 | 'Overall display', | |
4264 | 'Rolling Averages', | |
36dfa958 DV |
4265 | 'Value display/formatting', |
4266 | 'Zooming' | |
a38e9336 DV |
4267 | ]; |
4268 | var cats = {}; | |
4269 | for (var i = 0; i < valid_cats.length; i++) cats[valid_cats[i]] = true; | |
4270 | ||
028ddf8a DV |
4271 | for (var k in Dygraph.OPTIONS_REFERENCE) { |
4272 | if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(k)) continue; | |
4273 | var op = Dygraph.OPTIONS_REFERENCE[k]; | |
4274 | for (var i = 0; i < flds.length; i++) { | |
4275 | if (!op.hasOwnProperty(flds[i])) { | |
4276 | warn('Option ' + k + ' missing "' + flds[i] + '" property'); | |
4277 | } else if (typeof(op[flds[i]]) != 'string') { | |
4278 | warn(k + '.' + flds[i] + ' must be of type string'); | |
4279 | } | |
4280 | } | |
a38e9336 DV |
4281 | var labels = op['labels']; |
4282 | if (typeof(labels) !== 'object') { | |
4283 | warn('Option "' + k + '" is missing a "labels": [...] option'); | |
4284 | for (var i = 0; i < labels.length; i++) { | |
4285 | if (!cats.hasOwnProperty(labels[i])) { | |
4286 | warn('Option "' + k + '" has label "' + labels[i] + | |
4287 | '", which is invalid.'); | |
4288 | } | |
4289 | } | |
4290 | } | |
028ddf8a DV |
4291 | } |
4292 | })(); | |
4293 | // </REMOVE_FOR_COMBINED> |