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