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