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