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