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