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