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