When pan is the default behavior, clearSelection can't be called on
[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
fc4e84fa 1230 g.drawGraph_(false);
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.
fc4e84fa
RK
2677 *
2678 * clearSelection, when undefined or true, causes this.clearSelection to be
2679 * called at the end of the draw operation. This should rarely be defined,
2680 * and never true (that is it should be undefined most of the time, and
2681 * rarely false.)
2682 *
6a1aa64f
DV
2683 * @private
2684 */
fc4e84fa
RK
2685Dygraph.prototype.drawGraph_ = function(clearSelection) {
2686 if (typeof clearSelection === 'undefined') {
2687 clearSelection = true;
2688 }
2689
26ca7938
DV
2690 var data = this.rawData_;
2691
fe0b7c03
DV
2692 // This is used to set the second parameter to drawCallback, below.
2693 var is_initial_draw = this.is_initial_draw_;
2694 this.is_initial_draw_ = false;
2695
3bd9c228 2696 var minY = null, maxY = null;
6a1aa64f 2697 this.layout_.removeAllDatasets();
285a6bda 2698 this.setColors_();
9317362d 2699 this.attrs_['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
285a6bda 2700
354e15ab
DE
2701 // Loop over the fields (series). Go from the last to the first,
2702 // because if they're stacked that's how we accumulate the values.
43af96e7 2703
354e15ab
DE
2704 var cumulative_y = []; // For stacked series.
2705 var datasets = [];
2706
f09fc545
DV
2707 var extremes = {}; // series name -> [low, high]
2708
354e15ab
DE
2709 // Loop over all fields and create datasets
2710 for (var i = data[0].length - 1; i >= 1; i--) {
1cf11047
DV
2711 if (!this.visibility()[i - 1]) continue;
2712
f09fc545 2713 var seriesName = this.attr_("labels")[i];
450fe64b 2714 var connectSeparatedPoints = this.attr_('connectSeparatedPoints', i);
6e6a2b0a 2715 var logScale = this.attr_('logscale', i);
450fe64b 2716
6a1aa64f
DV
2717 var series = [];
2718 for (var j = 0; j < data.length; j++) {
6e6a2b0a
RK
2719 var date = data[j][0];
2720 var point = data[j][i];
2721 if (logScale) {
2722 // On the log scale, points less than zero do not exist.
2723 // This will create a gap in the chart. Note that this ignores
2724 // connectSeparatedPoints.
e863a17d 2725 if (point <= 0) {
6e6a2b0a
RK
2726 point = null;
2727 }
2728 series.push([date, point]);
2729 } else {
2730 if (point != null || !connectSeparatedPoints) {
2731 series.push([date, point]);
2732 }
f032c51d 2733 }
6a1aa64f 2734 }
2f5e7e1a
DV
2735
2736 // TODO(danvk): move this into predraw_. It's insane to do it here.
6a1aa64f
DV
2737 series = this.rollingAverage(series, this.rollPeriod_);
2738
2739 // Prune down to the desired range, if necessary (for zooming)
1a26f3fb
DV
2740 // Because there can be lines going to points outside of the visible area,
2741 // we actually prune to visible points, plus one on either side.
9922b78b 2742 var bars = this.attr_("errorBars") || this.attr_("customBars");
6a1aa64f
DV
2743 if (this.dateWindow_) {
2744 var low = this.dateWindow_[0];
2745 var high= this.dateWindow_[1];
2746 var pruned = [];
1a26f3fb
DV
2747 // TODO(danvk): do binary search instead of linear search.
2748 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2749 var firstIdx = null, lastIdx = null;
6a1aa64f 2750 for (var k = 0; k < series.length; k++) {
1a26f3fb
DV
2751 if (series[k][0] >= low && firstIdx === null) {
2752 firstIdx = k;
2753 }
2754 if (series[k][0] <= high) {
2755 lastIdx = k;
6a1aa64f
DV
2756 }
2757 }
1a26f3fb
DV
2758 if (firstIdx === null) firstIdx = 0;
2759 if (firstIdx > 0) firstIdx--;
2760 if (lastIdx === null) lastIdx = series.length - 1;
2761 if (lastIdx < series.length - 1) lastIdx++;
16269f6e 2762 this.boundaryIds_[i-1] = [firstIdx, lastIdx];
1a26f3fb
DV
2763 for (var k = firstIdx; k <= lastIdx; k++) {
2764 pruned.push(series[k]);
6a1aa64f
DV
2765 }
2766 series = pruned;
16269f6e
NAG
2767 } else {
2768 this.boundaryIds_[i-1] = [0, series.length-1];
6a1aa64f
DV
2769 }
2770
f09fc545 2771 var seriesExtremes = this.extremeValues_(series);
5011e7a1 2772
6a1aa64f 2773 if (bars) {
354e15ab
DE
2774 for (var j=0; j<series.length; j++) {
2775 val = [series[j][0], series[j][1][0], series[j][1][1], series[j][1][2]];
2776 series[j] = val;
2777 }
43af96e7 2778 } else if (this.attr_("stackedGraph")) {
43af96e7
NK
2779 var l = series.length;
2780 var actual_y;
2781 for (var j = 0; j < l; j++) {
354e15ab
DE
2782 // If one data set has a NaN, let all subsequent stacked
2783 // sets inherit the NaN -- only start at 0 for the first set.
2784 var x = series[j][0];
41b0f691 2785 if (cumulative_y[x] === undefined) {
354e15ab 2786 cumulative_y[x] = 0;
41b0f691 2787 }
43af96e7
NK
2788
2789 actual_y = series[j][1];
354e15ab 2790 cumulative_y[x] += actual_y;
43af96e7 2791
354e15ab 2792 series[j] = [x, cumulative_y[x]]
43af96e7 2793
41b0f691
DV
2794 if (cumulative_y[x] > seriesExtremes[1]) {
2795 seriesExtremes[1] = cumulative_y[x];
2796 }
2797 if (cumulative_y[x] < seriesExtremes[0]) {
2798 seriesExtremes[0] = cumulative_y[x];
2799 }
43af96e7 2800 }
6a1aa64f 2801 }
41b0f691 2802 extremes[seriesName] = seriesExtremes;
354e15ab
DE
2803
2804 datasets[i] = series;
6a1aa64f
DV
2805 }
2806
354e15ab 2807 for (var i = 1; i < datasets.length; i++) {
4523c1f6 2808 if (!this.visibility()[i - 1]) continue;
354e15ab 2809 this.layout_.addDataset(this.attr_("labels")[i], datasets[i]);
43af96e7
NK
2810 }
2811
6faebb69 2812 this.computeYAxisRanges_(extremes);
b2c9222a
DV
2813 this.layout_.setYAxes(this.axes_);
2814
6a1aa64f
DV
2815 this.addXTicks_();
2816
b2c9222a 2817 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
81856f70 2818 var tmp_zoomed_x = this.zoomed_x_;
6a1aa64f 2819 // Tell PlotKit to use this new data and render itself
b2c9222a 2820 this.layout_.setDateWindow(this.dateWindow_);
81856f70 2821 this.zoomed_x_ = tmp_zoomed_x;
6a1aa64f
DV
2822 this.layout_.evaluateWithError();
2823 this.plotter_.clear();
2824 this.plotter_.render();
f6401bf6 2825 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2f5e7e1a 2826 this.canvas_.height);
599fb4ad 2827
2fccd3dc
DV
2828 if (is_initial_draw) {
2829 // Generate a static legend before any particular point is selected.
91c10d9c 2830 this.setLegendHTML_();
06303c32 2831 } else {
fc4e84fa
RK
2832 if (clearSelection) {
2833 if (typeof(this.selPoints_) !== 'undefined' && this.selPoints_.length) {
2834 // We should select the point nearest the page x/y here, but it's easier
2835 // to just clear the selection. This prevents erroneous hover dots from
2836 // being displayed.
2837 this.clearSelection();
2838 } else {
2839 this.clearSelection();
2840 }
06303c32 2841 }
2fccd3dc
DV
2842 }
2843
599fb4ad 2844 if (this.attr_("drawCallback") !== null) {
fe0b7c03 2845 this.attr_("drawCallback")(this, is_initial_draw);
599fb4ad 2846 }
6a1aa64f
DV
2847};
2848
2849/**
629a09ae 2850 * @private
26ca7938
DV
2851 * Determine properties of the y-axes which are independent of the data
2852 * currently being displayed. This includes things like the number of axes and
2853 * the style of the axes. It does not include the range of each axis and its
2854 * tick marks.
2855 * This fills in this.axes_ and this.seriesToAxisMap_.
2856 * axes_ = [ { options } ]
2857 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2858 * indices are into the axes_ array.
f09fc545 2859 */
26ca7938 2860Dygraph.prototype.computeYAxes_ = function() {
00aa7f61 2861 this.axes_ = [{ yAxisId : 0, g : this }]; // always have at least one y-axis.
26ca7938
DV
2862 this.seriesToAxisMap_ = {};
2863
2864 // Get a list of series names.
2865 var labels = this.attr_("labels");
1c77a3a1 2866 var series = {};
26ca7938 2867 for (var i = 1; i < labels.length; i++) series[labels[i]] = (i - 1);
f09fc545
DV
2868
2869 // all options which could be applied per-axis:
2870 var axisOptions = [
2871 'includeZero',
2872 'valueRange',
2873 'labelsKMB',
2874 'labelsKMG2',
2875 'pixelsPerYLabel',
2876 'yAxisLabelWidth',
2877 'axisLabelFontSize',
7d0e7a0d
RK
2878 'axisTickSize',
2879 'logscale'
f09fc545
DV
2880 ];
2881
2882 // Copy global axis options over to the first axis.
2883 for (var i = 0; i < axisOptions.length; i++) {
2884 var k = axisOptions[i];
2885 var v = this.attr_(k);
26ca7938 2886 if (v) this.axes_[0][k] = v;
f09fc545
DV
2887 }
2888
2889 // Go through once and add all the axes.
26ca7938
DV
2890 for (var seriesName in series) {
2891 if (!series.hasOwnProperty(seriesName)) continue;
f09fc545
DV
2892 var axis = this.attr_("axis", seriesName);
2893 if (axis == null) {
26ca7938 2894 this.seriesToAxisMap_[seriesName] = 0;
f09fc545
DV
2895 continue;
2896 }
2897 if (typeof(axis) == 'object') {
2898 // Add a new axis, making a copy of its per-axis options.
2899 var opts = {};
26ca7938 2900 Dygraph.update(opts, this.axes_[0]);
f09fc545 2901 Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this.
00aa7f61
RK
2902 var yAxisId = this.axes_.length;
2903 opts.yAxisId = yAxisId;
2904 opts.g = this;
f09fc545 2905 Dygraph.update(opts, axis);
26ca7938 2906 this.axes_.push(opts);
00aa7f61 2907 this.seriesToAxisMap_[seriesName] = yAxisId;
f09fc545
DV
2908 }
2909 }
2910
2911 // Go through one more time and assign series to an axis defined by another
2912 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
26ca7938
DV
2913 for (var seriesName in series) {
2914 if (!series.hasOwnProperty(seriesName)) continue;
f09fc545
DV
2915 var axis = this.attr_("axis", seriesName);
2916 if (typeof(axis) == 'string') {
26ca7938 2917 if (!this.seriesToAxisMap_.hasOwnProperty(axis)) {
f09fc545
DV
2918 this.error("Series " + seriesName + " wants to share a y-axis with " +
2919 "series " + axis + ", which does not define its own axis.");
2920 return null;
2921 }
26ca7938
DV
2922 var idx = this.seriesToAxisMap_[axis];
2923 this.seriesToAxisMap_[seriesName] = idx;
f09fc545
DV
2924 }
2925 }
1c77a3a1
DV
2926
2927 // Now we remove series from seriesToAxisMap_ which are not visible. We do
2928 // this last so that hiding the first series doesn't destroy the axis
2929 // properties of the primary axis.
2930 var seriesToAxisFiltered = {};
2931 var vis = this.visibility();
2932 for (var i = 1; i < labels.length; i++) {
2933 var s = labels[i];
2934 if (vis[i - 1]) seriesToAxisFiltered[s] = this.seriesToAxisMap_[s];
2935 }
2936 this.seriesToAxisMap_ = seriesToAxisFiltered;
26ca7938
DV
2937};
2938
2939/**
2940 * Returns the number of y-axes on the chart.
2941 * @return {Number} the number of axes.
2942 */
2943Dygraph.prototype.numAxes = function() {
2944 var last_axis = 0;
2945 for (var series in this.seriesToAxisMap_) {
2946 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2947 var idx = this.seriesToAxisMap_[series];
2948 if (idx > last_axis) last_axis = idx;
2949 }
2950 return 1 + last_axis;
2951};
2952
2953/**
629a09ae 2954 * @private
b2c9222a
DV
2955 * Returns axis properties for the given series.
2956 * @param { String } setName The name of the series for which to get axis
2957 * properties, e.g. 'Y1'.
2958 * @return { Object } The axis properties.
2959 */
2960Dygraph.prototype.axisPropertiesForSeries = function(series) {
2961 // TODO(danvk): handle errors.
2962 return this.axes_[this.seriesToAxisMap_[series]];
2963};
2964
2965/**
2966 * @private
26ca7938
DV
2967 * Determine the value range and tick marks for each axis.
2968 * @param {Object} extremes A mapping from seriesName -> [low, high]
2969 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2970 */
2971Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2972 // Build a map from axis number -> [list of series names]
2973 var seriesForAxis = [];
2974 for (var series in this.seriesToAxisMap_) {
2975 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2976 var idx = this.seriesToAxisMap_[series];
2977 while (seriesForAxis.length <= idx) seriesForAxis.push([]);
2978 seriesForAxis[idx].push(series);
2979 }
f09fc545
DV
2980
2981 // Compute extreme values, a span and tick marks for each axis.
26ca7938
DV
2982 for (var i = 0; i < this.axes_.length; i++) {
2983 var axis = this.axes_[i];
4cac8c7a 2984
06fc69b6
AV
2985 if (!seriesForAxis[i]) {
2986 // If no series are defined or visible then use a reasonable default
2987 axis.extremeRange = [0, 1];
2988 } else {
1c77a3a1 2989 // Calculate the extremes of extremes.
f09fc545
DV
2990 var series = seriesForAxis[i];
2991 var minY = Infinity; // extremes[series[0]][0];
2992 var maxY = -Infinity; // extremes[series[0]][1];
ba049b89 2993 var extremeMinY, extremeMaxY;
f09fc545 2994 for (var j = 0; j < series.length; j++) {
ba049b89
NN
2995 // Only use valid extremes to stop null data series' from corrupting the scale.
2996 extremeMinY = extremes[series[j]][0];
2997 if (extremeMinY != null) {
36dfa958 2998 minY = Math.min(extremeMinY, minY);
ba049b89
NN
2999 }
3000 extremeMaxY = extremes[series[j]][1];
3001 if (extremeMaxY != null) {
36dfa958 3002 maxY = Math.max(extremeMaxY, maxY);
ba049b89 3003 }
f09fc545
DV
3004 }
3005 if (axis.includeZero && minY > 0) minY = 0;
3006
ba049b89 3007 // Ensure we have a valid scale, otherwise defualt to zero for safety.
36dfa958
DV
3008 if (minY == Infinity) minY = 0;
3009 if (maxY == -Infinity) maxY = 0;
ba049b89 3010
f09fc545
DV
3011 // Add some padding and round up to an integer to be human-friendly.
3012 var span = maxY - minY;
3013 // special case: if we have no sense of scale, use +/-10% of the sole value.
3014 if (span == 0) { span = maxY; }
f09fc545 3015
ff022deb
RK
3016 var maxAxisY;
3017 var minAxisY;
7d0e7a0d 3018 if (axis.logscale) {
ff022deb
RK
3019 var maxAxisY = maxY + 0.1 * span;
3020 var minAxisY = minY;
3021 } else {
3022 var maxAxisY = maxY + 0.1 * span;
3023 var minAxisY = minY - 0.1 * span;
f09fc545 3024
ff022deb
RK
3025 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
3026 if (!this.attr_("avoidMinZero")) {
3027 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
3028 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
3029 }
f09fc545 3030
ff022deb
RK
3031 if (this.attr_("includeZero")) {
3032 if (maxY < 0) maxAxisY = 0;
3033 if (minY > 0) minAxisY = 0;
3034 }
f09fc545 3035 }
4cac8c7a
RK
3036 axis.extremeRange = [minAxisY, maxAxisY];
3037 }
3038 if (axis.valueWindow) {
3039 // This is only set if the user has zoomed on the y-axis. It is never set
3040 // by a user. It takes precedence over axis.valueRange because, if you set
3041 // valueRange, you'd still expect to be able to pan.
3042 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
3043 } else if (axis.valueRange) {
3044 // This is a user-set value range for this axis.
3045 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
3046 } else {
3047 axis.computedValueRange = axis.extremeRange;
f09fc545
DV
3048 }
3049
0d64e596
DV
3050 // Add ticks. By default, all axes inherit the tick positions of the
3051 // primary axis. However, if an axis is specifically marked as having
3052 // independent ticks, then that is permissible as well.
3053 if (i == 0 || axis.independentTicks) {
032e4c1d 3054 axis.ticks =
0d64e596
DV
3055 Dygraph.numericTicks(axis.computedValueRange[0],
3056 axis.computedValueRange[1],
3057 this,
3058 axis);
3059 } else {
3060 var p_axis = this.axes_[0];
3061 var p_ticks = p_axis.ticks;
3062 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
3063 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
3064 var tick_values = [];
3065 for (var i = 0; i < p_ticks.length; i++) {
3066 var y_frac = (p_ticks[i].v - p_axis.computedValueRange[0]) / p_scale;
3067 var y_val = axis.computedValueRange[0] + y_frac * scale;
3068 tick_values.push(y_val);
3069 }
3070
032e4c1d 3071 axis.ticks =
0d64e596
DV
3072 Dygraph.numericTicks(axis.computedValueRange[0],
3073 axis.computedValueRange[1],
3074 this, axis, tick_values);
3075 }
f09fc545 3076 }
f09fc545
DV
3077};
3078
3079/**
629a09ae 3080 * @private
6a1aa64f
DV
3081 * Calculates the rolling average of a data set.
3082 * If originalData is [label, val], rolls the average of those.
3083 * If originalData is [label, [, it's interpreted as [value, stddev]
3084 * and the roll is returned in the same form, with appropriately reduced
3085 * stddev for each value.
3086 * Note that this is where fractional input (i.e. '5/10') is converted into
3087 * decimal values.
3088 * @param {Array} originalData The data in the appropriate format (see above)
6faebb69
JB
3089 * @param {Number} rollPeriod The number of points over which to average the
3090 * data
6a1aa64f 3091 */
285a6bda 3092Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
6a1aa64f
DV
3093 if (originalData.length < 2)
3094 return originalData;
3095 var rollPeriod = Math.min(rollPeriod, originalData.length - 1);
3096 var rollingData = [];
285a6bda 3097 var sigma = this.attr_("sigma");
6a1aa64f
DV
3098
3099 if (this.fractions_) {
3100 var num = 0;
3101 var den = 0; // numerator/denominator
3102 var mult = 100.0;
3103 for (var i = 0; i < originalData.length; i++) {
3104 num += originalData[i][1][0];
3105 den += originalData[i][1][1];
3106 if (i - rollPeriod >= 0) {
3107 num -= originalData[i - rollPeriod][1][0];
3108 den -= originalData[i - rollPeriod][1][1];
3109 }
3110
3111 var date = originalData[i][0];
3112 var value = den ? num / den : 0.0;
285a6bda 3113 if (this.attr_("errorBars")) {
6a1aa64f
DV
3114 if (this.wilsonInterval_) {
3115 // For more details on this confidence interval, see:
3116 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
3117 if (den) {
3118 var p = value < 0 ? 0 : value, n = den;
3119 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
3120 var denom = 1 + sigma * sigma / den;
3121 var low = (p + sigma * sigma / (2 * den) - pm) / denom;
3122 var high = (p + sigma * sigma / (2 * den) + pm) / denom;
3123 rollingData[i] = [date,
3124 [p * mult, (p - low) * mult, (high - p) * mult]];
3125 } else {
3126 rollingData[i] = [date, [0, 0, 0]];
3127 }
3128 } else {
3129 var stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
3130 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
3131 }
3132 } else {
3133 rollingData[i] = [date, mult * value];
3134 }
3135 }
9922b78b 3136 } else if (this.attr_("customBars")) {
f6885d6a
DV
3137 var low = 0;
3138 var mid = 0;
3139 var high = 0;
3140 var count = 0;
6a1aa64f
DV
3141 for (var i = 0; i < originalData.length; i++) {
3142 var data = originalData[i][1];
3143 var y = data[1];
3144 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
f6885d6a 3145
8b91c51f 3146 if (y != null && !isNaN(y)) {
49a7d0d5
DV
3147 low += data[0];
3148 mid += y;
3149 high += data[2];
3150 count += 1;
3151 }
f6885d6a
DV
3152 if (i - rollPeriod >= 0) {
3153 var prev = originalData[i - rollPeriod];
8b91c51f 3154 if (prev[1][1] != null && !isNaN(prev[1][1])) {
49a7d0d5
DV
3155 low -= prev[1][0];
3156 mid -= prev[1][1];
3157 high -= prev[1][2];
3158 count -= 1;
3159 }
f6885d6a
DV
3160 }
3161 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
3162 1.0 * (mid - low) / count,
3163 1.0 * (high - mid) / count ]];
2769de62 3164 }
6a1aa64f
DV
3165 } else {
3166 // Calculate the rolling average for the first rollPeriod - 1 points where
6faebb69 3167 // there is not enough data to roll over the full number of points
6a1aa64f 3168 var num_init_points = Math.min(rollPeriod - 1, originalData.length - 2);
285a6bda 3169 if (!this.attr_("errorBars")){
5011e7a1
DV
3170 if (rollPeriod == 1) {
3171 return originalData;
3172 }
3173
2847c1cf 3174 for (var i = 0; i < originalData.length; i++) {
6a1aa64f 3175 var sum = 0;
5011e7a1 3176 var num_ok = 0;
2847c1cf
DV
3177 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
3178 var y = originalData[j][1];
8b91c51f 3179 if (y == null || isNaN(y)) continue;
5011e7a1 3180 num_ok++;
2847c1cf 3181 sum += originalData[j][1];
6a1aa64f 3182 }
5011e7a1 3183 if (num_ok) {
2847c1cf 3184 rollingData[i] = [originalData[i][0], sum / num_ok];
5011e7a1 3185 } else {
2847c1cf 3186 rollingData[i] = [originalData[i][0], null];
5011e7a1 3187 }
6a1aa64f 3188 }
2847c1cf
DV
3189
3190 } else {
3191 for (var i = 0; i < originalData.length; i++) {
6a1aa64f
DV
3192 var sum = 0;
3193 var variance = 0;
5011e7a1 3194 var num_ok = 0;
2847c1cf 3195 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
5011e7a1 3196 var y = originalData[j][1][0];
8b91c51f 3197 if (y == null || isNaN(y)) continue;
5011e7a1 3198 num_ok++;
6a1aa64f
DV
3199 sum += originalData[j][1][0];
3200 variance += Math.pow(originalData[j][1][1], 2);
3201 }
5011e7a1
DV
3202 if (num_ok) {
3203 var stddev = Math.sqrt(variance) / num_ok;
3204 rollingData[i] = [originalData[i][0],
3205 [sum / num_ok, sigma * stddev, sigma * stddev]];
3206 } else {
3207 rollingData[i] = [originalData[i][0], [null, null, null]];
3208 }
6a1aa64f
DV
3209 }
3210 }
3211 }
3212
3213 return rollingData;
3214};
3215
3216/**
629a09ae 3217 * @private
6a1aa64f 3218 * Parses a date, returning the number of milliseconds since epoch. This can be
285a6bda
DV
3219 * passed in as an xValueParser in the Dygraph constructor.
3220 * TODO(danvk): enumerate formats that this understands.
6a1aa64f
DV
3221 * @param {String} A date in YYYYMMDD format.
3222 * @return {Number} Milliseconds since epoch.
6a1aa64f 3223 */
285a6bda 3224Dygraph.dateParser = function(dateStr, self) {
6a1aa64f 3225 var dateStrSlashed;
285a6bda 3226 var d;
986a5026 3227 if (dateStr.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
6a1aa64f 3228 dateStrSlashed = dateStr.replace("-", "/", "g");
353a0294
DV
3229 while (dateStrSlashed.search("-") != -1) {
3230 dateStrSlashed = dateStrSlashed.replace("-", "/");
3231 }
d96b7d1a 3232 d = Dygraph.dateStrToMillis(dateStrSlashed);
2769de62 3233 } else if (dateStr.length == 8) { // e.g. '20090712'
285a6bda 3234 // TODO(danvk): remove support for this format. It's confusing.
6a1aa64f
DV
3235 dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2)
3236 + "/" + dateStr.substr(6,2);
d96b7d1a 3237 d = Dygraph.dateStrToMillis(dateStrSlashed);
2769de62
DV
3238 } else {
3239 // Any format that Date.parse will accept, e.g. "2009/07/12" or
3240 // "2009/07/12 12:34:56"
d96b7d1a 3241 d = Dygraph.dateStrToMillis(dateStr);
285a6bda
DV
3242 }
3243
3244 if (!d || isNaN(d)) {
3245 self.error("Couldn't parse " + dateStr + " as a date");
3246 }
3247 return d;
3248};
3249
3250/**
3251 * Detects the type of the str (date or numeric) and sets the various
3252 * formatting attributes in this.attrs_ based on this type.
3253 * @param {String} str An x value.
3254 * @private
3255 */
3256Dygraph.prototype.detectTypeFromString_ = function(str) {
3257 var isDate = false;
ea62df82 3258 if (str.indexOf('-') > 0 ||
285a6bda
DV
3259 str.indexOf('/') >= 0 ||
3260 isNaN(parseFloat(str))) {
3261 isDate = true;
3262 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
3263 // TODO(danvk): remove support for this format.
3264 isDate = true;
3265 }
3266
3267 if (isDate) {
3268 this.attrs_.xValueFormatter = Dygraph.dateString_;
3269 this.attrs_.xValueParser = Dygraph.dateParser;
3270 this.attrs_.xTicker = Dygraph.dateTicker;
bf640e56 3271 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
285a6bda 3272 } else {
17d0210c 3273 // TODO(danvk): use Dygraph.numberFormatter here?
c39e1d93 3274 /** @private (shut up, jsdoc!) */
032e4c1d 3275 this.attrs_.xValueFormatter = function(x) { return x; };
c39e1d93 3276 /** @private (shut up, jsdoc!) */
285a6bda
DV
3277 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
3278 this.attrs_.xTicker = Dygraph.numericTicks;
bf640e56 3279 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
6a1aa64f 3280 }
6a1aa64f
DV
3281};
3282
3283/**
5cd7ac68
DV
3284 * Parses the value as a floating point number. This is like the parseFloat()
3285 * built-in, but with a few differences:
3286 * - the empty string is parsed as null, rather than NaN.
3287 * - if the string cannot be parsed at all, an error is logged.
3288 * If the string can't be parsed, this method returns null.
3289 * @param {String} x The string to be parsed
3290 * @param {Number} opt_line_no The line number from which the string comes.
3291 * @param {String} opt_line The text of the line from which the string comes.
3292 * @private
3293 */
3294
3295// Parse the x as a float or return null if it's not a number.
3296Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) {
3297 var val = parseFloat(x);
3298 if (!isNaN(val)) return val;
3299
3300 // Try to figure out what happeend.
3301 // If the value is the empty string, parse it as null.
3302 if (/^ *$/.test(x)) return null;
3303
3304 // If it was actually "NaN", return it as NaN.
3305 if (/^ *nan *$/i.test(x)) return NaN;
3306
3307 // Looks like a parsing error.
3308 var msg = "Unable to parse '" + x + "' as a number";
3309 if (opt_line !== null && opt_line_no !== null) {
3310 msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV.";
3311 }
3312 this.error(msg);
3313
3314 return null;
3315};
3316
3317/**
629a09ae 3318 * @private
6a1aa64f
DV
3319 * Parses a string in a special csv format. We expect a csv file where each
3320 * line is a date point, and the first field in each line is the date string.
3321 * We also expect that all remaining fields represent series.
285a6bda 3322 * if the errorBars attribute is set, then interpret the fields as:
6a1aa64f 3323 * date, series1, stddev1, series2, stddev2, ...
629a09ae 3324 * @param {[Object]} data See above.
285a6bda 3325 *
629a09ae 3326 * @return [Object] An array with one entry for each row. These entries
285a6bda
DV
3327 * are an array of cells in that row. The first entry is the parsed x-value for
3328 * the row. The second, third, etc. are the y-values. These can take on one of
3329 * three forms, depending on the CSV and constructor parameters:
3330 * 1. numeric value
3331 * 2. [ value, stddev ]
3332 * 3. [ low value, center value, high value ]
6a1aa64f 3333 */
285a6bda 3334Dygraph.prototype.parseCSV_ = function(data) {
6a1aa64f
DV
3335 var ret = [];
3336 var lines = data.split("\n");
3d67f03b
DV
3337
3338 // Use the default delimiter or fall back to a tab if that makes sense.
3339 var delim = this.attr_('delimiter');
3340 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
3341 delim = '\t';
3342 }
3343
285a6bda 3344 var start = 0;
d7beab6b
DV
3345 if (!('labels' in this.user_attrs_)) {
3346 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
285a6bda 3347 start = 1;
d7beab6b 3348 this.attrs_.labels = lines[0].split(delim); // NOTE: _not_ user_attrs_.
6a1aa64f 3349 }
5cd7ac68 3350 var line_no = 0;
03b522a4 3351
285a6bda
DV
3352 var xParser;
3353 var defaultParserSet = false; // attempt to auto-detect x value type
3354 var expectedCols = this.attr_("labels").length;
987840a2 3355 var outOfOrder = false;
6a1aa64f
DV
3356 for (var i = start; i < lines.length; i++) {
3357 var line = lines[i];
5cd7ac68 3358 line_no = i;
6a1aa64f 3359 if (line.length == 0) continue; // skip blank lines
3d67f03b
DV
3360 if (line[0] == '#') continue; // skip comment lines
3361 var inFields = line.split(delim);
285a6bda 3362 if (inFields.length < 2) continue;
6a1aa64f
DV
3363
3364 var fields = [];
285a6bda
DV
3365 if (!defaultParserSet) {
3366 this.detectTypeFromString_(inFields[0]);
3367 xParser = this.attr_("xValueParser");
3368 defaultParserSet = true;
3369 }
3370 fields[0] = xParser(inFields[0], this);
6a1aa64f
DV
3371
3372 // If fractions are expected, parse the numbers as "A/B"
3373 if (this.fractions_) {
3374 for (var j = 1; j < inFields.length; j++) {
3375 // TODO(danvk): figure out an appropriate way to flag parse errors.
3376 var vals = inFields[j].split("/");
7219edb3
DV
3377 if (vals.length != 2) {
3378 this.error('Expected fractional "num/den" values in CSV data ' +
3379 "but found a value '" + inFields[j] + "' on line " +
3380 (1 + i) + " ('" + line + "') which is not of this form.");
3381 fields[j] = [0, 0];
3382 } else {
3383 fields[j] = [this.parseFloat_(vals[0], i, line),
3384 this.parseFloat_(vals[1], i, line)];
3385 }
6a1aa64f 3386 }
285a6bda 3387 } else if (this.attr_("errorBars")) {
6a1aa64f 3388 // If there are error bars, values are (value, stddev) pairs
7219edb3
DV
3389 if (inFields.length % 2 != 1) {
3390 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3391 'but line ' + (1 + i) + ' has an odd number of values (' +
3392 (inFields.length - 1) + "): '" + line + "'");
3393 }
3394 for (var j = 1; j < inFields.length; j += 2) {
5cd7ac68
DV
3395 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3396 this.parseFloat_(inFields[j + 1], i, line)];
7219edb3 3397 }
9922b78b 3398 } else if (this.attr_("customBars")) {
6a1aa64f
DV
3399 // Bars are a low;center;high tuple
3400 for (var j = 1; j < inFields.length; j++) {
327a9279
DV
3401 var val = inFields[j];
3402 if (/^ *$/.test(val)) {
3403 fields[j] = [null, null, null];
3404 } else {
3405 var vals = val.split(";");
3406 if (vals.length == 3) {
3407 fields[j] = [ this.parseFloat_(vals[0], i, line),
3408 this.parseFloat_(vals[1], i, line),
3409 this.parseFloat_(vals[2], i, line) ];
3410 } else {
3411 this.warning('When using customBars, values must be either blank ' +
3412 'or "low;center;high" tuples (got "' + val +
3413 '" on line ' + (1+i));
3414 }
3415 }
6a1aa64f
DV
3416 }
3417 } else {
3418 // Values are just numbers
285a6bda 3419 for (var j = 1; j < inFields.length; j++) {
5cd7ac68 3420 fields[j] = this.parseFloat_(inFields[j], i, line);
285a6bda 3421 }
6a1aa64f 3422 }
987840a2
DV
3423 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3424 outOfOrder = true;
3425 }
285a6bda
DV
3426
3427 if (fields.length != expectedCols) {
3428 this.error("Number of columns in line " + i + " (" + fields.length +
3429 ") does not agree with number of labels (" + expectedCols +
3430 ") " + line);
3431 }
6d0aaa09
DV
3432
3433 // If the user specified the 'labels' option and none of the cells of the
3434 // first row parsed correctly, then they probably double-specified the
3435 // labels. We go with the values set in the option, discard this row and
3436 // log a warning to the JS console.
3437 if (i == 0 && this.attr_('labels')) {
3438 var all_null = true;
3439 for (var j = 0; all_null && j < fields.length; j++) {
3440 if (fields[j]) all_null = false;
3441 }
3442 if (all_null) {
3443 this.warn("The dygraphs 'labels' option is set, but the first row of " +
3444 "CSV data ('" + line + "') appears to also contain labels. " +
3445 "Will drop the CSV labels and use the option labels.");
3446 continue;
3447 }
3448 }
3449 ret.push(fields);
6a1aa64f 3450 }
987840a2
DV
3451
3452 if (outOfOrder) {
3453 this.warn("CSV is out of order; order it correctly to speed loading.");
3454 ret.sort(function(a,b) { return a[0] - b[0] });
3455 }
3456
6a1aa64f
DV
3457 return ret;
3458};
3459
3460/**
629a09ae 3461 * @private
285a6bda
DV
3462 * The user has provided their data as a pre-packaged JS array. If the x values
3463 * are numeric, this is the same as dygraphs' internal format. If the x values
3464 * are dates, we need to convert them from Date objects to ms since epoch.
629a09ae
DV
3465 * @param {[Object]} data
3466 * @return {[Object]} data with numeric x values.
285a6bda
DV
3467 */
3468Dygraph.prototype.parseArray_ = function(data) {
3469 // Peek at the first x value to see if it's numeric.
3470 if (data.length == 0) {
3471 this.error("Can't plot empty data set");
3472 return null;
3473 }
3474 if (data[0].length == 0) {
3475 this.error("Data set cannot contain an empty row");
3476 return null;
3477 }
3478
3479 if (this.attr_("labels") == null) {
3480 this.warn("Using default labels. Set labels explicitly via 'labels' " +
3481 "in the options parameter");
3482 this.attrs_.labels = [ "X" ];
3483 for (var i = 1; i < data[0].length; i++) {
3484 this.attrs_.labels.push("Y" + i);
3485 }
3486 }
3487
2dda3850 3488 if (Dygraph.isDateLike(data[0][0])) {
285a6bda
DV
3489 // Some intelligent defaults for a date x-axis.
3490 this.attrs_.xValueFormatter = Dygraph.dateString_;
bf640e56 3491 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
285a6bda
DV
3492 this.attrs_.xTicker = Dygraph.dateTicker;
3493
3494 // Assume they're all dates.
e3ab7b40 3495 var parsedData = Dygraph.clone(data);
285a6bda
DV
3496 for (var i = 0; i < data.length; i++) {
3497 if (parsedData[i].length == 0) {
a323ff4a 3498 this.error("Row " + (1 + i) + " of data is empty");
285a6bda
DV
3499 return null;
3500 }
3501 if (parsedData[i][0] == null
3a909ec5
DV
3502 || typeof(parsedData[i][0].getTime) != 'function'
3503 || isNaN(parsedData[i][0].getTime())) {
be96a1f5 3504 this.error("x value in row " + (1 + i) + " is not a Date");
285a6bda
DV
3505 return null;
3506 }
3507 parsedData[i][0] = parsedData[i][0].getTime();
3508 }
3509 return parsedData;
3510 } else {
3511 // Some intelligent defaults for a numeric x-axis.
c39e1d93 3512 /** @private (shut up, jsdoc!) */
032e4c1d 3513 this.attrs_.xValueFormatter = function(x) { return x; };
285a6bda
DV
3514 this.attrs_.xTicker = Dygraph.numericTicks;
3515 return data;
3516 }
3517};
3518
3519/**
79420a1e
DV
3520 * Parses a DataTable object from gviz.
3521 * The data is expected to have a first column that is either a date or a
3522 * number. All subsequent columns must be numbers. If there is a clear mismatch
3523 * between this.xValueParser_ and the type of the first column, it will be
a685723c 3524 * fixed. Fills out rawData_.
629a09ae 3525 * @param {[Object]} data See above.
79420a1e
DV
3526 * @private
3527 */
285a6bda 3528Dygraph.prototype.parseDataTable_ = function(data) {
79420a1e
DV
3529 var cols = data.getNumberOfColumns();
3530 var rows = data.getNumberOfRows();
3531
d955e223 3532 var indepType = data.getColumnType(0);
4440f6c8 3533 if (indepType == 'date' || indepType == 'datetime') {
285a6bda
DV
3534 this.attrs_.xValueFormatter = Dygraph.dateString_;
3535 this.attrs_.xValueParser = Dygraph.dateParser;
3536 this.attrs_.xTicker = Dygraph.dateTicker;
bf640e56 3537 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
33127159 3538 } else if (indepType == 'number') {
032e4c1d 3539 this.attrs_.xValueFormatter = function(x) { return x; };
285a6bda
DV
3540 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
3541 this.attrs_.xTicker = Dygraph.numericTicks;
bf640e56 3542 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
285a6bda 3543 } else {
987840a2
DV
3544 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3545 "column 1 of DataTable input (Got '" + indepType + "')");
79420a1e
DV
3546 return null;
3547 }
3548
a685723c
DV
3549 // Array of the column indices which contain data (and not annotations).
3550 var colIdx = [];
3551 var annotationCols = {}; // data index -> [annotation cols]
3552 var hasAnnotations = false;
3553 for (var i = 1; i < cols; i++) {
3554 var type = data.getColumnType(i);
3555 if (type == 'number') {
3556 colIdx.push(i);
3557 } else if (type == 'string' && this.attr_('displayAnnotations')) {
3558 // This is OK -- it's an annotation column.
3559 var dataIdx = colIdx[colIdx.length - 1];
3560 if (!annotationCols.hasOwnProperty(dataIdx)) {
3561 annotationCols[dataIdx] = [i];
3562 } else {
3563 annotationCols[dataIdx].push(i);
3564 }
3565 hasAnnotations = true;
3566 } else {
3567 this.error("Only 'number' is supported as a dependent type with Gviz." +
3568 " 'string' is only supported if displayAnnotations is true");
3569 }
3570 }
3571
3572 // Read column labels
3573 // TODO(danvk): add support back for errorBars
3574 var labels = [data.getColumnLabel(0)];
3575 for (var i = 0; i < colIdx.length; i++) {
3576 labels.push(data.getColumnLabel(colIdx[i]));
f9348814 3577 if (this.attr_("errorBars")) i += 1;
a685723c
DV
3578 }
3579 this.attrs_.labels = labels;
3580 cols = labels.length;
3581
79420a1e 3582 var ret = [];
987840a2 3583 var outOfOrder = false;
a685723c 3584 var annotations = [];
79420a1e
DV
3585 for (var i = 0; i < rows; i++) {
3586 var row = [];
debe4434
DV
3587 if (typeof(data.getValue(i, 0)) === 'undefined' ||
3588 data.getValue(i, 0) === null) {
129569a5
FD
3589 this.warn("Ignoring row " + i +
3590 " of DataTable because of undefined or null first column.");
debe4434
DV
3591 continue;
3592 }
3593
c21d2c2d 3594 if (indepType == 'date' || indepType == 'datetime') {
d955e223
DV
3595 row.push(data.getValue(i, 0).getTime());
3596 } else {
3597 row.push(data.getValue(i, 0));
3598 }
3e3f84e4 3599 if (!this.attr_("errorBars")) {
a685723c
DV
3600 for (var j = 0; j < colIdx.length; j++) {
3601 var col = colIdx[j];
3602 row.push(data.getValue(i, col));
3603 if (hasAnnotations &&
3604 annotationCols.hasOwnProperty(col) &&
3605 data.getValue(i, annotationCols[col][0]) != null) {
3606 var ann = {};
3607 ann.series = data.getColumnLabel(col);
3608 ann.xval = row[0];
3609 ann.shortText = String.fromCharCode(65 /* A */ + annotations.length)
3610 ann.text = '';
3611 for (var k = 0; k < annotationCols[col].length; k++) {
3612 if (k) ann.text += "\n";
3613 ann.text += data.getValue(i, annotationCols[col][k]);
3614 }
3615 annotations.push(ann);
3616 }
3e3f84e4 3617 }
92fd68d8
DV
3618
3619 // Strip out infinities, which give dygraphs problems later on.
3620 for (var j = 0; j < row.length; j++) {
3621 if (!isFinite(row[j])) row[j] = null;
3622 }
3e3f84e4
DV
3623 } else {
3624 for (var j = 0; j < cols - 1; j++) {
3625 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
3626 }
79420a1e 3627 }
987840a2
DV
3628 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
3629 outOfOrder = true;
3630 }
243d96e8 3631 ret.push(row);
79420a1e 3632 }
987840a2
DV
3633
3634 if (outOfOrder) {
3635 this.warn("DataTable is out of order; order it correctly to speed loading.");
3636 ret.sort(function(a,b) { return a[0] - b[0] });
3637 }
a685723c
DV
3638 this.rawData_ = ret;
3639
3640 if (annotations.length > 0) {
3641 this.setAnnotations(annotations, true);
3642 }
79420a1e
DV
3643}
3644
629a09ae
DV
3645/**
3646 * @private
3647 * This is identical to JavaScript's built-in Date.parse() method, except that
3648 * it doesn't get replaced with an incompatible method by aggressive JS
3649 * libraries like MooTools or Joomla.
3650 * @param { String } str The date string, e.g. "2011/05/06"
3651 * @return { Integer } millis since epoch
3652 */
d96b7d1a
DV
3653Dygraph.dateStrToMillis = function(str) {
3654 return new Date(str).getTime();
3655};
3656
24e5350c 3657// These functions are all based on MochiKit.
629a09ae
DV
3658/**
3659 * @private
3660 */
fc80a396
DV
3661Dygraph.update = function (self, o) {
3662 if (typeof(o) != 'undefined' && o !== null) {
3663 for (var k in o) {
85b99f0b
DV
3664 if (o.hasOwnProperty(k)) {
3665 self[k] = o[k];
3666 }
fc80a396
DV
3667 }
3668 }
3669 return self;
3670};
3671
629a09ae
DV
3672/**
3673 * @private
3674 */
2dda3850
DV
3675Dygraph.isArrayLike = function (o) {
3676 var typ = typeof(o);
3677 if (
c21d2c2d 3678 (typ != 'object' && !(typ == 'function' &&
2dda3850
DV
3679 typeof(o.item) == 'function')) ||
3680 o === null ||
3681 typeof(o.length) != 'number' ||
3682 o.nodeType === 3
3683 ) {
3684 return false;
3685 }
3686 return true;
3687};
3688
629a09ae
DV
3689/**
3690 * @private
3691 */
2dda3850
DV
3692Dygraph.isDateLike = function (o) {
3693 if (typeof(o) != "object" || o === null ||
3694 typeof(o.getTime) != 'function') {
3695 return false;
3696 }
3697 return true;
3698};
3699
629a09ae
DV
3700/**
3701 * @private
3702 */
e3ab7b40
DV
3703Dygraph.clone = function(o) {
3704 // TODO(danvk): figure out how MochiKit's version works
3705 var r = [];
3706 for (var i = 0; i < o.length; i++) {
3707 if (Dygraph.isArrayLike(o[i])) {
3708 r.push(Dygraph.clone(o[i]));
3709 } else {
3710 r.push(o[i]);
3711 }
3712 }
3713 return r;
24e5350c
DV
3714};
3715
2dda3850 3716
79420a1e 3717/**
6a1aa64f
DV
3718 * Get the CSV data. If it's in a function, call that function. If it's in a
3719 * file, do an XMLHttpRequest to get it.
3720 * @private
3721 */
285a6bda 3722Dygraph.prototype.start_ = function() {
6a1aa64f 3723 if (typeof this.file_ == 'function') {
285a6bda 3724 // CSV string. Pretend we got it via XHR.
6a1aa64f 3725 this.loadedEvent_(this.file_());
2dda3850 3726 } else if (Dygraph.isArrayLike(this.file_)) {
285a6bda 3727 this.rawData_ = this.parseArray_(this.file_);
26ca7938 3728 this.predraw_();
79420a1e
DV
3729 } else if (typeof this.file_ == 'object' &&
3730 typeof this.file_.getColumnRange == 'function') {
3731 // must be a DataTable from gviz.
a685723c 3732 this.parseDataTable_(this.file_);
26ca7938 3733 this.predraw_();
285a6bda
DV
3734 } else if (typeof this.file_ == 'string') {
3735 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3736 if (this.file_.indexOf('\n') >= 0) {
3737 this.loadedEvent_(this.file_);
3738 } else {
3739 var req = new XMLHttpRequest();
3740 var caller = this;
3741 req.onreadystatechange = function () {
3742 if (req.readyState == 4) {
3743 if (req.status == 200) {
3744 caller.loadedEvent_(req.responseText);
3745 }
6a1aa64f 3746 }
285a6bda 3747 };
6a1aa64f 3748
285a6bda
DV
3749 req.open("GET", this.file_, true);
3750 req.send(null);
3751 }
3752 } else {
3753 this.error("Unknown data format: " + (typeof this.file_));
6a1aa64f
DV
3754 }
3755};
3756
3757/**
3758 * Changes various properties of the graph. These can include:
3759 * <ul>
3760 * <li>file: changes the source data for the graph</li>
3761 * <li>errorBars: changes whether the data contains stddev</li>
3762 * </ul>
dcb25130 3763 *
ccfcc169
DV
3764 * There's a huge variety of options that can be passed to this method. For a
3765 * full list, see http://dygraphs.com/options.html.
3766 *
6a1aa64f 3767 * @param {Object} attrs The new properties and values
ccfcc169
DV
3768 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3769 * call to updateOptions(). If you know better, you can pass true to explicitly
3770 * block the redraw. This can be useful for chaining updateOptions() calls,
3771 * avoiding the occasional infinite loop and preventing redraws when it's not
3772 * necessary (e.g. when updating a callback).
6a1aa64f 3773 */
ccfcc169
DV
3774Dygraph.prototype.updateOptions = function(attrs, block_redraw) {
3775 if (typeof(block_redraw) == 'undefined') block_redraw = false;
3776
3777 // TODO(danvk): this is a mess. Move these options into attr_.
c65f2303 3778 if ('rollPeriod' in attrs) {
6a1aa64f
DV
3779 this.rollPeriod_ = attrs.rollPeriod;
3780 }
c65f2303 3781 if ('dateWindow' in attrs) {
6a1aa64f 3782 this.dateWindow_ = attrs.dateWindow;
e5152598 3783 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
81856f70
NN
3784 this.zoomed_x_ = attrs.dateWindow != null;
3785 }
b7e5862d 3786 }
e5152598 3787 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
b7e5862d 3788 this.zoomed_y_ = attrs.valueRange != null;
6a1aa64f 3789 }
450fe64b
DV
3790
3791 // TODO(danvk): validate per-series options.
46dde5f9
DV
3792 // Supported:
3793 // strokeWidth
3794 // pointSize
3795 // drawPoints
3796 // highlightCircleSize
450fe64b 3797
fc80a396 3798 Dygraph.update(this.user_attrs_, attrs);
285a6bda 3799
5e50289f 3800 if (attrs['file']) {
6a1aa64f 3801 this.file_ = attrs['file'];
ccfcc169 3802 if (!block_redraw) this.start_();
6a1aa64f 3803 } else {
ccfcc169 3804 if (!block_redraw) this.predraw_();
6a1aa64f
DV
3805 }
3806};
3807
3808/**
697e70b2
DV
3809 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3810 * containing div (which has presumably changed size since the dygraph was
3811 * instantiated. If the width/height are specified, the div will be resized.
964f30c6
DV
3812 *
3813 * This is far more efficient than destroying and re-instantiating a
3814 * Dygraph, since it doesn't have to reparse the underlying data.
3815 *
629a09ae
DV
3816 * @param {Number} [width] Width (in pixels)
3817 * @param {Number} [height] Height (in pixels)
697e70b2
DV
3818 */
3819Dygraph.prototype.resize = function(width, height) {
e8c7ef86
DV
3820 if (this.resize_lock) {
3821 return;
3822 }
3823 this.resize_lock = true;
3824
697e70b2
DV
3825 if ((width === null) != (height === null)) {
3826 this.warn("Dygraph.resize() should be called with zero parameters or " +
3827 "two non-NULL parameters. Pretending it was zero.");
3828 width = height = null;
3829 }
3830
b16e6369 3831 // TODO(danvk): there should be a clear() method.
697e70b2 3832 this.maindiv_.innerHTML = "";
b16e6369
DV
3833 this.attrs_.labelsDiv = null;
3834
697e70b2
DV
3835 if (width) {
3836 this.maindiv_.style.width = width + "px";
3837 this.maindiv_.style.height = height + "px";
3838 this.width_ = width;
3839 this.height_ = height;
3840 } else {
3841 this.width_ = this.maindiv_.offsetWidth;
3842 this.height_ = this.maindiv_.offsetHeight;
3843 }
3844
3845 this.createInterface_();
26ca7938 3846 this.predraw_();
e8c7ef86
DV
3847
3848 this.resize_lock = false;
697e70b2
DV
3849};
3850
3851/**
6faebb69 3852 * Adjusts the number of points in the rolling average. Updates the graph to
6a1aa64f 3853 * reflect the new averaging period.
6faebb69 3854 * @param {Number} length Number of points over which to average the data.
6a1aa64f 3855 */
285a6bda 3856Dygraph.prototype.adjustRoll = function(length) {
6a1aa64f 3857 this.rollPeriod_ = length;
26ca7938 3858 this.predraw_();
6a1aa64f 3859};
540d00f1 3860
f8cfec73 3861/**
1cf11047
DV
3862 * Returns a boolean array of visibility statuses.
3863 */
3864Dygraph.prototype.visibility = function() {
3865 // Do lazy-initialization, so that this happens after we know the number of
3866 // data series.
3867 if (!this.attr_("visibility")) {
f38dec01 3868 this.attrs_["visibility"] = [];
1cf11047
DV
3869 }
3870 while (this.attr_("visibility").length < this.rawData_[0].length - 1) {
f38dec01 3871 this.attr_("visibility").push(true);
1cf11047
DV
3872 }
3873 return this.attr_("visibility");
3874};
3875
3876/**
3877 * Changes the visiblity of a series.
3878 */
3879Dygraph.prototype.setVisibility = function(num, value) {
3880 var x = this.visibility();
a6c109c1 3881 if (num < 0 || num >= x.length) {
1cf11047
DV
3882 this.warn("invalid series number in setVisibility: " + num);
3883 } else {
3884 x[num] = value;
26ca7938 3885 this.predraw_();
1cf11047
DV
3886 }
3887};
3888
3889/**
5c528fa2
DV
3890 * Update the list of annotations and redraw the chart.
3891 */
a685723c 3892Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3c51ab74
DV
3893 // Only add the annotation CSS rule once we know it will be used.
3894 Dygraph.addAnnotationRule();
5c528fa2
DV
3895 this.annotations_ = ann;
3896 this.layout_.setAnnotations(this.annotations_);
a685723c 3897 if (!suppressDraw) {
26ca7938 3898 this.predraw_();
a685723c 3899 }
5c528fa2
DV
3900};
3901
3902/**
3903 * Return the list of annotations.
3904 */
3905Dygraph.prototype.annotations = function() {
3906 return this.annotations_;
3907};
3908
46dde5f9
DV
3909/**
3910 * Get the index of a series (column) given its name. The first column is the
3911 * x-axis, so the data series start with index 1.
3912 */
3913Dygraph.prototype.indexFromSetName = function(name) {
3914 var labels = this.attr_("labels");
3915 for (var i = 0; i < labels.length; i++) {
3916 if (labels[i] == name) return i;
3917 }
3918 return null;
3919};
3920
629a09ae
DV
3921/**
3922 * @private
3923 * Adds a default style for the annotation CSS classes to the document. This is
3924 * only executed when annotations are actually used. It is designed to only be
3925 * called once -- all calls after the first will return immediately.
3926 */
5c528fa2
DV
3927Dygraph.addAnnotationRule = function() {
3928 if (Dygraph.addedAnnotationCSS) return;
3929
5c528fa2
DV
3930 var rule = "border: 1px solid black; " +
3931 "background-color: white; " +
3932 "text-align: center;";
22186871
DV
3933
3934 var styleSheetElement = document.createElement("style");
3935 styleSheetElement.type = "text/css";
3936 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3937
3938 // Find the first style sheet that we can access.
3939 // We may not add a rule to a style sheet from another domain for security
3940 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3941 // adds its own style sheets from google.com.
3942 for (var i = 0; i < document.styleSheets.length; i++) {
3943 if (document.styleSheets[i].disabled) continue;
3944 var mysheet = document.styleSheets[i];
3945 try {
3946 if (mysheet.insertRule) { // Firefox
3947 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3948 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3949 } else if (mysheet.addRule) { // IE
3950 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3951 }
3952 Dygraph.addedAnnotationCSS = true;
3953 return;
3954 } catch(err) {
3955 // Was likely a security exception.
3956 }
5c528fa2
DV
3957 }
3958
22186871 3959 this.warn("Unable to add default annotation CSS rule; display may be off.");
5c528fa2
DV
3960}
3961
3962/**
629a09ae 3963 * @private
f8cfec73
DV
3964 * Create a new canvas element. This is more complex than a simple
3965 * document.createElement("canvas") because of IE and excanvas.
3966 */
3967Dygraph.createCanvas = function() {
3968 var canvas = document.createElement("canvas");
3969
3970 isIE = (/MSIE/.test(navigator.userAgent) && !window.opera);
8b8f2d59 3971 if (isIE && (typeof(G_vmlCanvasManager) != 'undefined')) {
f8cfec73
DV
3972 canvas = G_vmlCanvasManager.initElement(canvas);
3973 }
3974
3975 return canvas;
3976};
3977
540d00f1
DV
3978
3979/**
285a6bda 3980 * A wrapper around Dygraph that implements the gviz API.
540d00f1
DV
3981 * @param {Object} container The DOM object the visualization should live in.
3982 */
285a6bda 3983Dygraph.GVizChart = function(container) {
540d00f1
DV
3984 this.container = container;
3985}
3986
285a6bda 3987Dygraph.GVizChart.prototype.draw = function(data, options) {
c91f4ae8
DV
3988 // Clear out any existing dygraph.
3989 // TODO(danvk): would it make more sense to simply redraw using the current
3990 // date_graph object?
540d00f1 3991 this.container.innerHTML = '';
c91f4ae8
DV
3992 if (typeof(this.date_graph) != 'undefined') {
3993 this.date_graph.destroy();
3994 }
3995
285a6bda 3996 this.date_graph = new Dygraph(this.container, data, options);
540d00f1 3997}
285a6bda 3998
239c712d
NAG
3999/**
4000 * Google charts compatible setSelection
50360fd0 4001 * Only row selection is supported, all points in the row will be highlighted
239c712d
NAG
4002 * @param {Array} array of the selected cells
4003 * @public
4004 */
4005Dygraph.GVizChart.prototype.setSelection = function(selection_array) {
4006 var row = false;
4007 if (selection_array.length) {
4008 row = selection_array[0].row;
4009 }
4010 this.date_graph.setSelection(row);
4011}
4012
103b7292
NAG
4013/**
4014 * Google charts compatible getSelection implementation
4015 * @return {Array} array of the selected cells
4016 * @public
4017 */
4018Dygraph.GVizChart.prototype.getSelection = function() {
4019 var selection = [];
50360fd0 4020
103b7292 4021 var row = this.date_graph.getSelection();
50360fd0 4022
103b7292 4023 if (row < 0) return selection;
50360fd0 4024
103b7292
NAG
4025 col = 1;
4026 for (var i in this.date_graph.layout_.datasets) {
4027 selection.push({row: row, column: col});
4028 col++;
4029 }
4030
4031 return selection;
4032}
4033
285a6bda
DV
4034// Older pages may still use this name.
4035DateGraph = Dygraph;
028ddf8a
DV
4036
4037// <REMOVE_FOR_COMBINED>
0addac07
DV
4038Dygraph.OPTIONS_REFERENCE = // <JSON>
4039{
a38e9336
DV
4040 "xValueParser": {
4041 "default": "parseFloat() or Date.parse()*",
4042 "labels": ["CSV parsing"],
4043 "type": "function(str) -> number",
4044 "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."
4045 },
4046 "stackedGraph": {
a96f59f4 4047 "default": "false",
a38e9336
DV
4048 "labels": ["Data Line display"],
4049 "type": "boolean",
4050 "description": "If set, stack series on top of one another rather than drawing them independently."
a96f59f4 4051 },
a38e9336 4052 "pointSize": {
a96f59f4 4053 "default": "1",
a38e9336
DV
4054 "labels": ["Data Line display"],
4055 "type": "integer",
4056 "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 4057 },
a38e9336
DV
4058 "labelsDivStyles": {
4059 "default": "null",
4060 "labels": ["Legend"],
4061 "type": "{}",
4062 "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold."
a96f59f4 4063 },
a38e9336 4064 "drawPoints": {
a96f59f4 4065 "default": "false",
a38e9336
DV
4066 "labels": ["Data Line display"],
4067 "type": "boolean",
4068 "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 4069 },
a38e9336
DV
4070 "height": {
4071 "default": "320",
4072 "labels": ["Overall display"],
4073 "type": "integer",
4074 "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
a96f59f4
DV
4075 },
4076 "zoomCallback": {
a96f59f4 4077 "default": "null",
a38e9336
DV
4078 "labels": ["Callbacks"],
4079 "type": "function(minDate, maxDate, yRanges)",
a96f59f4
DV
4080 "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."
4081 },
a38e9336
DV
4082 "pointClickCallback": {
4083 "default": "",
4084 "labels": ["Callbacks", "Interactive Elements"],
4085 "type": "",
4086 "description": ""
a96f59f4 4087 },
a38e9336
DV
4088 "colors": {
4089 "default": "(see description)",
4090 "labels": ["Data Series Colors"],
4091 "type": "array<string>",
4092 "example": "['red', '#00FF00']",
4093 "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 4094 },
a38e9336 4095 "connectSeparatedPoints": {
a96f59f4 4096 "default": "false",
a38e9336
DV
4097 "labels": ["Data Line display"],
4098 "type": "boolean",
4099 "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 4100 },
a38e9336 4101 "highlightCallback": {
a96f59f4 4102 "default": "null",
a38e9336
DV
4103 "labels": ["Callbacks"],
4104 "type": "function(event, x, points,row)",
4105 "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 4106 },
a38e9336 4107 "includeZero": {
a96f59f4 4108 "default": "false",
a38e9336 4109 "labels": ["Axis display"],
a96f59f4 4110 "type": "boolean",
a38e9336 4111 "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 4112 },
a38e9336
DV
4113 "rollPeriod": {
4114 "default": "1",
4115 "labels": ["Error Bars", "Rolling Averages"],
4116 "type": "integer &gt;= 1",
4117 "description": "Number of days over which to average data. Discussed extensively above."
a96f59f4 4118 },
a38e9336 4119 "unhighlightCallback": {
a96f59f4 4120 "default": "null",
a38e9336
DV
4121 "labels": ["Callbacks"],
4122 "type": "function(event)",
4123 "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 4124 },
a38e9336
DV
4125 "axisTickSize": {
4126 "default": "3.0",
4127 "labels": ["Axis display"],
4128 "type": "number",
4129 "description": "The size of the line to display next to each tick mark on x- or y-axes."
a96f59f4 4130 },
a38e9336 4131 "labelsSeparateLines": {
a96f59f4 4132 "default": "false",
a38e9336
DV
4133 "labels": ["Legend"],
4134 "type": "boolean",
4135 "description": "Put <code>&lt;br/&gt;</code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>."
a96f59f4 4136 },
a38e9336
DV
4137 "xValueFormatter": {
4138 "default": "(Round to 2 decimal places)",
4139 "labels": ["Axis display"],
4140 "type": "function(x)",
4141 "description": "Function to provide a custom display format for the X value for mouseover."
a96f59f4
DV
4142 },
4143 "pixelsPerYLabel": {
a96f59f4 4144 "default": "30",
a38e9336
DV
4145 "labels": ["Axis display", "Grid"],
4146 "type": "integer",
a96f59f4
DV
4147 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
4148 },
a38e9336 4149 "annotationMouseOverHandler": {
5cc5f631 4150 "default": "null",
a38e9336 4151 "labels": ["Annotations"],
5cc5f631
DV
4152 "type": "function(annotation, point, dygraph, event)",
4153 "description": "If provided, this function is called whenever the user mouses over an annotation."
4154 },
4155 "annotationMouseOutHandler": {
4156 "default": "null",
4157 "labels": ["Annotations"],
4158 "type": "function(annotation, point, dygraph, event)",
4159 "description": "If provided, this function is called whenever the user mouses out of an annotation."
a96f59f4 4160 },
8165189e 4161 "annotationClickHandler": {
5cc5f631 4162 "default": "null",
8165189e 4163 "labels": ["Annotations"],
5cc5f631
DV
4164 "type": "function(annotation, point, dygraph, event)",
4165 "description": "If provided, this function is called whenever the user clicks on an annotation."
8165189e
DV
4166 },
4167 "annotationDblClickHandler": {
5cc5f631 4168 "default": "null",
8165189e 4169 "labels": ["Annotations"],
5cc5f631
DV
4170 "type": "function(annotation, point, dygraph, event)",
4171 "description": "If provided, this function is called whenever the user double-clicks on an annotation."
8165189e 4172 },
a38e9336
DV
4173 "drawCallback": {
4174 "default": "null",
4175 "labels": ["Callbacks"],
4176 "type": "function(dygraph, is_initial)",
4177 "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."
4178 },
4179 "labelsKMG2": {
4180 "default": "false",
4181 "labels": ["Value display/formatting"],
4182 "type": "boolean",
4183 "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."
4184 },
4185 "delimiter": {
4186 "default": ",",
4187 "labels": ["CSV parsing"],
4188 "type": "string",
4189 "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
4190 },
4191 "axisLabelFontSize": {
a96f59f4 4192 "default": "14",
a38e9336
DV
4193 "labels": ["Axis display"],
4194 "type": "integer",
a96f59f4
DV
4195 "description": "Size of the font (in pixels) to use in the axis labels, both x- and y-axis."
4196 },
a38e9336
DV
4197 "underlayCallback": {
4198 "default": "null",
4199 "labels": ["Callbacks"],
4200 "type": "function(canvas, area, dygraph)",
4201 "description": "When set, this callback gets called before the chart is drawn. It details on how to use this."
a96f59f4 4202 },
a38e9336
DV
4203 "width": {
4204 "default": "480",
4205 "labels": ["Overall display"],
4206 "type": "integer",
4207 "description": "Width, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
a96f59f4 4208 },
a38e9336
DV
4209 "interactionModel": {
4210 "default": "...",
4211 "labels": ["Interactive Elements"],
4212 "type": "Object",
4213 "description": "TODO(konigsberg): document this"
4214 },
4215 "xTicker": {
4216 "default": "Dygraph.dateTicker or Dygraph.numericTicks",
4217 "labels": ["Axis display"],
4218 "type": "function(min, max, dygraph) -> [{v: ..., label: ...}, ...]",
4219 "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."
4220 },
4221 "xAxisLabelWidth": {
4222 "default": "50",
4223 "labels": ["Axis display"],
a96f59f4 4224 "type": "integer",
a38e9336 4225 "description": "Width, in pixels, of the x-axis labels."
a96f59f4 4226 },
a38e9336
DV
4227 "showLabelsOnHighlight": {
4228 "default": "true",
4229 "labels": ["Interactive Elements", "Legend"],
a96f59f4 4230 "type": "boolean",
a38e9336 4231 "description": "Whether to show the legend upon mouseover."
a96f59f4 4232 },
a38e9336
DV
4233 "axis": {
4234 "default": "(none)",
4235 "labels": ["Axis display"],
4236 "type": "string or object",
4237 "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."
4238 },
4239 "pixelsPerXLabel": {
4240 "default": "60",
4241 "labels": ["Axis display", "Grid"],
a96f59f4 4242 "type": "integer",
a38e9336
DV
4243 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
4244 },
4245 "labelsDiv": {
4246 "default": "null",
4247 "labels": ["Legend"],
4248 "type": "DOM element or string",
4249 "example": "<code style='font-size: small'>document.getElementById('foo')</code>or<code>'foo'",
4250 "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
4251 },
4252 "fractions": {
a96f59f4 4253 "default": "false",
a38e9336
DV
4254 "labels": ["CSV parsing", "Error Bars"],
4255 "type": "boolean",
a96f59f4
DV
4256 "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)."
4257 },
a38e9336
DV
4258 "logscale": {
4259 "default": "false",
4260 "labels": ["Axis display"],
a96f59f4 4261 "type": "boolean",
a109b711 4262 "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
4263 },
4264 "strokeWidth": {
4265 "default": "1.0",
4266 "labels": ["Data Line display"],
4267 "type": "integer",
4268 "example": "0.5, 2.0",
4269 "description": "The width of the lines connecting data points. This can be used to increase the contrast or some graphs."
4270 },
4271 "wilsonInterval": {
a96f59f4 4272 "default": "true",
a38e9336
DV
4273 "labels": ["Error Bars"],
4274 "type": "boolean",
a96f59f4
DV
4275 "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."
4276 },
a38e9336 4277 "fillGraph": {
a96f59f4 4278 "default": "false",
a38e9336
DV
4279 "labels": ["Data Line display"],
4280 "type": "boolean",
4281 "description": "Should the area underneath the graph be filled? This option is not compatible with error bars."
a96f59f4 4282 },
a38e9336
DV
4283 "highlightCircleSize": {
4284 "default": "3",
4285 "labels": ["Interactive Elements"],
4286 "type": "integer",
4287 "description": "The size in pixels of the dot drawn over highlighted points."
a96f59f4
DV
4288 },
4289 "gridLineColor": {
a96f59f4 4290 "default": "rgb(128,128,128)",
a38e9336
DV
4291 "labels": ["Grid"],
4292 "type": "red, blue",
a96f59f4
DV
4293 "description": "The color of the gridlines."
4294 },
a38e9336
DV
4295 "visibility": {
4296 "default": "[true, true, ...]",
4297 "labels": ["Data Line display"],
4298 "type": "Array of booleans",
4299 "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 4300 },
a38e9336
DV
4301 "valueRange": {
4302 "default": "Full range of the input is shown",
4303 "labels": ["Axis display"],
4304 "type": "Array of two numbers",
4305 "example": "[10, 110]",
4306 "description": "Explicitly set the vertical range of the graph to [low, high]."
a96f59f4 4307 },
a38e9336
DV
4308 "labelsDivWidth": {
4309 "default": "250",
4310 "labels": ["Legend"],
a96f59f4 4311 "type": "integer",
a38e9336 4312 "description": "Width (in pixels) of the div which shows information on the currently-highlighted points."
a96f59f4 4313 },
a38e9336
DV
4314 "colorSaturation": {
4315 "default": "1.0",
4316 "labels": ["Data Series Colors"],
990d6a35 4317 "type": "float (0.0 - 1.0)",
a38e9336
DV
4318 "description": "If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors."
4319 },
4320 "yAxisLabelWidth": {
4321 "default": "50",
4322 "labels": ["Axis display"],
a96f59f4 4323 "type": "integer",
990d6a35 4324 "description": "Width, in pixels, of the y-axis labels. This also affects the amount of space available for a y-axis chart label."
a96f59f4 4325 },
a38e9336
DV
4326 "hideOverlayOnMouseOut": {
4327 "default": "true",
4328 "labels": ["Interactive Elements", "Legend"],
a96f59f4 4329 "type": "boolean",
a38e9336 4330 "description": "Whether to hide the legend when the mouse leaves the chart area."
a96f59f4
DV
4331 },
4332 "yValueFormatter": {
a96f59f4 4333 "default": "(Round to 2 decimal places)",
a38e9336
DV
4334 "labels": ["Axis display"],
4335 "type": "function(x)",
a96f59f4
DV
4336 "description": "Function to provide a custom display format for the Y value for mouseover."
4337 },
a38e9336
DV
4338 "legend": {
4339 "default": "onmouseover",
4340 "labels": ["Legend"],
4341 "type": "string",
4342 "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."
4343 },
4344 "labelsShowZeroValues": {
4345 "default": "true",
4346 "labels": ["Legend"],
a96f59f4 4347 "type": "boolean",
a38e9336
DV
4348 "description": "Show zero value labels in the labelsDiv."
4349 },
4350 "stepPlot": {
a96f59f4 4351 "default": "false",
a38e9336
DV
4352 "labels": ["Data Line display"],
4353 "type": "boolean",
4354 "description": "When set, display the graph as a step plot instead of a line plot."
a96f59f4 4355 },
a38e9336
DV
4356 "labelsKMB": {
4357 "default": "false",
4358 "labels": ["Value display/formatting"],
a96f59f4 4359 "type": "boolean",
a38e9336
DV
4360 "description": "Show K/M/B for thousands/millions/billions on y-axis."
4361 },
4362 "rightGap": {
4363 "default": "5",
4364 "labels": ["Overall display"],
4365 "type": "integer",
4366 "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."
4367 },
4368 "avoidMinZero": {
a96f59f4 4369 "default": "false",
a38e9336
DV
4370 "labels": ["Axis display"],
4371 "type": "boolean",
4372 "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."
4373 },
4374 "xAxisLabelFormatter": {
4375 "default": "Dygraph.dateAxisFormatter",
4376 "labels": ["Axis display", "Value display/formatting"],
4377 "type": "function(date, granularity)",
4378 "description": "Function to call to format values along the x axis."
4379 },
4380 "clickCallback": {
4381 "snippet": "function(e, date){<br>&nbsp;&nbsp;alert(date);<br>}",
4382 "default": "null",
4383 "labels": ["Callbacks"],
4384 "type": "function(e, date)",
4385 "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."
4386 },
4387 "yAxisLabelFormatter": {
4388 "default": "yValueFormatter",
4389 "labels": ["Axis display", "Value display/formatting"],
4390 "type": "function(x)",
4391 "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
4392 },
4393 "labels": {
a96f59f4 4394 "default": "[\"X\", \"Y1\", \"Y2\", ...]*",
a38e9336
DV
4395 "labels": ["Legend"],
4396 "type": "array<string>",
a96f59f4
DV
4397 "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."
4398 },
a38e9336
DV
4399 "dateWindow": {
4400 "default": "Full range of the input is shown",
4401 "labels": ["Axis display"],
4402 "type": "Array of two Dates or numbers",
4403 "example": "[<br>&nbsp;&nbsp;Date.parse('2006-01-01'),<br>&nbsp;&nbsp;(new Date()).valueOf()<br>]",
4404 "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 4405 },
a38e9336
DV
4406 "showRoller": {
4407 "default": "false",
4408 "labels": ["Interactive Elements", "Rolling Averages"],
4409 "type": "boolean",
4410 "description": "If the rolling average period text box should be shown."
a96f59f4 4411 },
a38e9336
DV
4412 "sigma": {
4413 "default": "2.0",
4414 "labels": ["Error Bars"],
ca49434a 4415 "type": "float",
a38e9336 4416 "description": "When errorBars is set, shade this many standard deviations above/below each point."
a96f59f4 4417 },
a38e9336 4418 "customBars": {
a96f59f4 4419 "default": "false",
a38e9336 4420 "labels": ["CSV parsing", "Error Bars"],
a96f59f4 4421 "type": "boolean",
a38e9336 4422 "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 4423 },
a38e9336
DV
4424 "colorValue": {
4425 "default": "1.0",
4426 "labels": ["Data Series Colors"],
4427 "type": "float (0.0 - 1.0)",
4428 "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 4429 },
a38e9336
DV
4430 "errorBars": {
4431 "default": "false",
4432 "labels": ["CSV parsing", "Error Bars"],
a96f59f4 4433 "type": "boolean",
a38e9336 4434 "description": "Does the data contain standard deviations? Setting this to true alters the input format (see above)."
a96f59f4 4435 },
a38e9336
DV
4436 "displayAnnotations": {
4437 "default": "false",
4438 "labels": ["Annotations"],
a96f59f4 4439 "type": "boolean",
a38e9336 4440 "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 4441 },
965a030e 4442 "panEdgeFraction": {
4cac8c7a 4443 "default": "null",
965a030e 4444 "labels": ["Axis Display", "Interactive Elements"],
4cac8c7a
RK
4445 "type": "float",
4446 "default": "null",
4447 "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
4448 },
4449 "title": {
4450 "labels": ["Chart labels"],
4451 "type": "string",
4452 "default": "null",
4453 "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."
4454 },
4455 "titleHeight": {
4456 "default": "18",
4457 "labels": ["Chart labels"],
4458 "type": "integer",
4459 "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."
4460 },
4461 "xlabel": {
4462 "labels": ["Chart labels"],
4463 "type": "string",
4464 "default": "null",
4465 "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."
4466 },
4467 "xLabelHeight": {
4468 "labels": ["Chart labels"],
4469 "type": "integer",
4470 "default": "18",
4471 "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."
4472 },
4473 "ylabel": {
4474 "labels": ["Chart labels"],
4475 "type": "string",
4476 "default": "null",
4477 "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."
4478 },
4479 "yLabelWidth": {
4480 "labels": ["Chart labels"],
4481 "type": "integer",
4482 "default": "18",
4483 "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 4484 },
e5152598
NN
4485 "isZoomedIgnoreProgrammaticZoom" : {
4486 "default": "false",
4487 "labels": ["Zooming"],
4488 "type": "boolean",
36dfa958 4489 "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 4490 },
990d6a35
DV
4491 "drawXGrid": {
4492 "default": "true",
4493 "labels": ["Grid"],
4494 "type": "boolean",
4495 "description" : "Whether to display vertical gridlines under the chart."
4496 },
4497 "drawYGrid": {
4498 "default": "true",
4499 "labels": ["Grid"],
4500 "type": "boolean",
4501 "description" : "Whether to display horizontal gridlines under the chart."
4502 },
4503 "drawXAxis": {
4504 "default": "true",
4505 "labels": ["Axis display"],
4506 "type": "boolean",
4507 "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."
4508 },
4509 "drawYAxis": {
4510 "default": "true",
4511 "labels": ["Axis display"],
4512 "type": "boolean",
4513 "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."
4514 },
4515 "gridLineWidth": {
4516 "default": "0.3",
4517 "labels": ["Grid"],
4518 "type": "float",
4519 "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."
4520 },
4521 "axisLineWidth": {
4522 "default": "0.3",
4523 "labels": ["Axis display"],
4524 "type": "float",
4525 "description" : "Thickness (in pixels) of the x- and y-axis lines."
4526 },
4527 "axisLineColor": {
4528 "default": "black",
4529 "labels": ["Axis display"],
4530 "type": "string",
4531 "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)'."
4532 },
4533 "fillAlpha": {
4534 "default": "0.15",
e829f52c 4535 "labels": ["Error bars", "Data Series Colors"],
990d6a35
DV
4536 "type": "float (0.0 - 1.0)",
4537 "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."
4538 },
4539 "axisLabelColor": {
4540 "default": "black",
4541 "labels": ["Axis display"],
4542 "type": "string",
4543 "description" : "Color for x- and y-axis labels. This is a CSS color string."
4544 },
4545 "axisLabelWidth": {
4546 "default": "50",
6beca822 4547 "labels": ["Axis display", "Chart labels"],
990d6a35
DV
4548 "type": "integer",
4549 "description" : "Width (in pixels) of the containing divs for x- and y-axis labels. For the y-axis, this also controls "
4550 },
17d0210c
DV
4551 "sigFigs" : {
4552 "default": "null",
4553 "labels": ["Value display/formatting"],
4554 "type": "integer",
4555 "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."
4556 },
4557 "digitsAfterDecimal" : {
4558 "default": "2",
4559 "labels": ["Value display/formatting"],
4560 "type": "integer",
4561 "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."
4562 },
4563 "maxNumberWidth" : {
4564 "default": "6",
4565 "labels": ["Value display/formatting"],
4566 "type": "integer",
4567 "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
4568 },
4569 "file": {
4570 "default": "(set when constructed)",
4571 "labels": ["Data"],
4572 "type": "string (URL of CSV or CSV), GViz DataTable or 2D Array",
4573 "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 4574 }
0addac07
DV
4575}
4576; // </JSON>
4577// NOTE: in addition to parsing as JS, this snippet is expected to be valid
4578// JSON. This assumption cannot be checked in JS, but it will be checked when
ca49434a
DV
4579// documentation is generated by the generate-documentation.py script. For the
4580// most part, this just means that you should always use double quotes.
028ddf8a
DV
4581
4582// Do a quick sanity check on the options reference.
4583(function() {
4584 var warn = function(msg) { if (console) console.warn(msg); };
4585 var flds = ['type', 'default', 'description'];
a38e9336
DV
4586 var valid_cats = [
4587 'Annotations',
4588 'Axis display',
ca49434a 4589 'Chart labels',
a38e9336
DV
4590 'CSV parsing',
4591 'Callbacks',
e829f52c 4592 'Data',
a38e9336
DV
4593 'Data Line display',
4594 'Data Series Colors',
4595 'Error Bars',
4596 'Grid',
4597 'Interactive Elements',
4598 'Legend',
4599 'Overall display',
4600 'Rolling Averages',
36dfa958
DV
4601 'Value display/formatting',
4602 'Zooming'
a38e9336
DV
4603 ];
4604 var cats = {};
4605 for (var i = 0; i < valid_cats.length; i++) cats[valid_cats[i]] = true;
4606
028ddf8a
DV
4607 for (var k in Dygraph.OPTIONS_REFERENCE) {
4608 if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(k)) continue;
4609 var op = Dygraph.OPTIONS_REFERENCE[k];
4610 for (var i = 0; i < flds.length; i++) {
4611 if (!op.hasOwnProperty(flds[i])) {
4612 warn('Option ' + k + ' missing "' + flds[i] + '" property');
4613 } else if (typeof(op[flds[i]]) != 'string') {
4614 warn(k + '.' + flds[i] + ' must be of type string');
4615 }
4616 }
a38e9336
DV
4617 var labels = op['labels'];
4618 if (typeof(labels) !== 'object') {
4619 warn('Option "' + k + '" is missing a "labels": [...] option');
4620 for (var i = 0; i < labels.length; i++) {
4621 if (!cats.hasOwnProperty(labels[i])) {
4622 warn('Option "' + k + '" has label "' + labels[i] +
4623 '", which is invalid.');
4624 }
4625 }
4626 }
028ddf8a
DV
4627 }
4628})();
4629// </REMOVE_FOR_COMBINED>