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