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