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