0d21e42c2a9690c362f0de34af8480eb204b8d28
[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 // Self is the graph.
1093 var self = this;
1094
1095 // Function that binds the graph and context to the handler.
1096 var bindHandler = function(handler) {
1097 return function(event) {
1098 handler(event, self, context);
1099 };
1100 };
1101
1102 for (var eventName in interactionModel) {
1103 if (!interactionModel.hasOwnProperty(eventName)) continue;
1104 Dygraph.addEvent(this.mouseEventElement_, eventName,
1105 bindHandler(interactionModel[eventName]));
1106 }
1107
1108 // If the user releases the mouse button during a drag, but not over the
1109 // canvas, then it doesn't count as a zooming action.
1110 Dygraph.addEvent(document, 'mouseup', function(event) {
1111 if (context.isZooming || context.isPanning) {
1112 context.isZooming = false;
1113 context.dragStartX = null;
1114 context.dragStartY = null;
1115 }
1116
1117 if (context.isPanning) {
1118 context.isPanning = false;
1119 context.draggingDate = null;
1120 context.dateRange = null;
1121 for (var i = 0; i < self.axes_.length; i++) {
1122 delete self.axes_[i].draggingValue;
1123 delete self.axes_[i].dragValueRange;
1124 }
1125 }
1126 });
1127 };
1128
1129 /**
1130 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1131 * up any previous zoom rectangles that were drawn. This could be optimized to
1132 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1133 * dots.
1134 *
1135 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1136 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1137 * @param {Number} startX The X position where the drag started, in canvas
1138 * coordinates.
1139 * @param {Number} endX The current X position of the drag, in canvas coords.
1140 * @param {Number} startY The Y position where the drag started, in canvas
1141 * coordinates.
1142 * @param {Number} endY The current Y position of the drag, in canvas coords.
1143 * @param {Number} prevDirection the value of direction on the previous call to
1144 * this function. Used to avoid excess redrawing
1145 * @param {Number} prevEndX The value of endX on the previous call to this
1146 * function. Used to avoid excess redrawing
1147 * @param {Number} prevEndY The value of endY on the previous call to this
1148 * function. Used to avoid excess redrawing
1149 * @private
1150 */
1151 Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY, endY,
1152 prevDirection, prevEndX, prevEndY) {
1153 var ctx = this.canvas_.getContext("2d");
1154
1155 // Clean up from the previous rect if necessary
1156 if (prevDirection == Dygraph.HORIZONTAL) {
1157 ctx.clearRect(Math.min(startX, prevEndX), 0,
1158 Math.abs(startX - prevEndX), this.height_);
1159 } else if (prevDirection == Dygraph.VERTICAL){
1160 ctx.clearRect(0, Math.min(startY, prevEndY),
1161 this.width_, Math.abs(startY - prevEndY));
1162 }
1163
1164 // Draw a light-grey rectangle to show the new viewing area
1165 if (direction == Dygraph.HORIZONTAL) {
1166 if (endX && startX) {
1167 ctx.fillStyle = "rgba(128,128,128,0.33)";
1168 ctx.fillRect(Math.min(startX, endX), 0,
1169 Math.abs(endX - startX), this.height_);
1170 }
1171 }
1172 if (direction == Dygraph.VERTICAL) {
1173 if (endY && startY) {
1174 ctx.fillStyle = "rgba(128,128,128,0.33)";
1175 ctx.fillRect(0, Math.min(startY, endY),
1176 this.width_, Math.abs(endY - startY));
1177 }
1178 }
1179 };
1180
1181 /**
1182 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1183 * the canvas. The exact zoom window may be slightly larger if there are no data
1184 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1185 * which accepts dates that match the raw data. This function redraws the graph.
1186 *
1187 * @param {Number} lowX The leftmost pixel value that should be visible.
1188 * @param {Number} highX The rightmost pixel value that should be visible.
1189 * @private
1190 */
1191 Dygraph.prototype.doZoomX_ = function(lowX, highX) {
1192 // Find the earliest and latest dates contained in this canvasx range.
1193 // Convert the call to date ranges of the raw data.
1194 var r = this.toDataCoords(lowX, null);
1195 var minDate = r[0];
1196 r = this.toDataCoords(highX, null);
1197 var maxDate = r[0];
1198 this.doZoomXDates_(minDate, maxDate);
1199 };
1200
1201 /**
1202 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1203 * method with doZoomX which accepts pixel coordinates. This function redraws
1204 * the graph.
1205 *
1206 * @param {Number} minDate The minimum date that should be visible.
1207 * @param {Number} maxDate The maximum date that should be visible.
1208 * @private
1209 */
1210 Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
1211 this.dateWindow_ = [minDate, maxDate];
1212 this.drawGraph_();
1213 if (this.attr_("zoomCallback")) {
1214 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1215 }
1216 };
1217
1218 /**
1219 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1220 * the canvas. This function redraws the graph.
1221 *
1222 * @param {Number} lowY The topmost pixel value that should be visible.
1223 * @param {Number} highY The lowest pixel value that should be visible.
1224 * @private
1225 */
1226 Dygraph.prototype.doZoomY_ = function(lowY, highY) {
1227 // Find the highest and lowest values in pixel range for each axis.
1228 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1229 // This is because pixels increase as you go down on the screen, whereas data
1230 // coordinates increase as you go up the screen.
1231 var valueRanges = [];
1232 for (var i = 0; i < this.axes_.length; i++) {
1233 var hi = this.toDataCoords(null, lowY, i);
1234 var low = this.toDataCoords(null, highY, i);
1235 this.axes_[i].valueWindow = [low[1], hi[1]];
1236 valueRanges.push([low[1], hi[1]]);
1237 }
1238
1239 this.drawGraph_();
1240 if (this.attr_("zoomCallback")) {
1241 var xRange = this.xAxisRange();
1242 this.attr_("zoomCallback")(xRange[0], xRange[1], this.yAxisRanges());
1243 }
1244 };
1245
1246 /**
1247 * Reset the zoom to the original view coordinates. This is the same as
1248 * double-clicking on the graph.
1249 *
1250 * @private
1251 */
1252 Dygraph.prototype.doUnzoom_ = function() {
1253 var dirty = false;
1254 if (this.dateWindow_ != null) {
1255 dirty = true;
1256 this.dateWindow_ = null;
1257 }
1258
1259 for (var i = 0; i < this.axes_.length; i++) {
1260 if (this.axes_[i].valueWindow != null) {
1261 dirty = true;
1262 delete this.axes_[i].valueWindow;
1263 }
1264 }
1265
1266 if (dirty) {
1267 // Putting the drawing operation before the callback because it resets
1268 // yAxisRange.
1269 this.drawGraph_();
1270 if (this.attr_("zoomCallback")) {
1271 var minDate = this.rawData_[0][0];
1272 var maxDate = this.rawData_[this.rawData_.length - 1][0];
1273 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1274 }
1275 }
1276 };
1277
1278 /**
1279 * When the mouse moves in the canvas, display information about a nearby data
1280 * point and draw dots over those points in the data series. This function
1281 * takes care of cleanup of previously-drawn dots.
1282 * @param {Object} event The mousemove event from the browser.
1283 * @private
1284 */
1285 Dygraph.prototype.mouseMove_ = function(event) {
1286 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
1287 var points = this.layout_.points;
1288
1289 var lastx = -1;
1290 var lasty = -1;
1291
1292 // Loop through all the points and find the date nearest to our current
1293 // location.
1294 var minDist = 1e+100;
1295 var idx = -1;
1296 for (var i = 0; i < points.length; i++) {
1297 var point = points[i];
1298 if (point == null) continue;
1299 var dist = Math.abs(point.canvasx - canvasx);
1300 if (dist > minDist) continue;
1301 minDist = dist;
1302 idx = i;
1303 }
1304 if (idx >= 0) lastx = points[idx].xval;
1305 // Check that you can really highlight the last day's data
1306 var last = points[points.length-1];
1307 if (last != null && canvasx > last.canvasx)
1308 lastx = points[points.length-1].xval;
1309
1310 // Extract the points we've selected
1311 this.selPoints_ = [];
1312 var l = points.length;
1313 if (!this.attr_("stackedGraph")) {
1314 for (var i = 0; i < l; i++) {
1315 if (points[i].xval == lastx) {
1316 this.selPoints_.push(points[i]);
1317 }
1318 }
1319 } else {
1320 // Need to 'unstack' points starting from the bottom
1321 var cumulative_sum = 0;
1322 for (var i = l - 1; i >= 0; i--) {
1323 if (points[i].xval == lastx) {
1324 var p = {}; // Clone the point since we modify it
1325 for (var k in points[i]) {
1326 p[k] = points[i][k];
1327 }
1328 p.yval -= cumulative_sum;
1329 cumulative_sum += p.yval;
1330 this.selPoints_.push(p);
1331 }
1332 }
1333 this.selPoints_.reverse();
1334 }
1335
1336 if (this.attr_("highlightCallback")) {
1337 var px = this.lastx_;
1338 if (px !== null && lastx != px) {
1339 // only fire if the selected point has changed.
1340 this.attr_("highlightCallback")(event, lastx, this.selPoints_, this.idxToRow_(idx));
1341 }
1342 }
1343
1344 // Save last x position for callbacks.
1345 this.lastx_ = lastx;
1346
1347 this.updateSelection_();
1348 };
1349
1350 /**
1351 * Transforms layout_.points index into data row number.
1352 * @param int layout_.points index
1353 * @return int row number, or -1 if none could be found.
1354 * @private
1355 */
1356 Dygraph.prototype.idxToRow_ = function(idx) {
1357 if (idx < 0) return -1;
1358
1359 for (var i in this.layout_.datasets) {
1360 if (idx < this.layout_.datasets[i].length) {
1361 return this.boundaryIds_[0][0]+idx;
1362 }
1363 idx -= this.layout_.datasets[i].length;
1364 }
1365 return -1;
1366 };
1367
1368 /**
1369 * Draw dots over the selectied points in the data series. This function
1370 * takes care of cleanup of previously-drawn dots.
1371 * @private
1372 */
1373 Dygraph.prototype.updateSelection_ = function() {
1374 // Clear the previously drawn vertical, if there is one
1375 var ctx = this.canvas_.getContext("2d");
1376 if (this.previousVerticalX_ >= 0) {
1377 // Determine the maximum highlight circle size.
1378 var maxCircleSize = 0;
1379 var labels = this.attr_('labels');
1380 for (var i = 1; i < labels.length; i++) {
1381 var r = this.attr_('highlightCircleSize', labels[i]);
1382 if (r > maxCircleSize) maxCircleSize = r;
1383 }
1384 var px = this.previousVerticalX_;
1385 ctx.clearRect(px - maxCircleSize - 1, 0,
1386 2 * maxCircleSize + 2, this.height_);
1387 }
1388
1389 var isOK = function(x) { return x && !isNaN(x); };
1390
1391 if (this.selPoints_.length > 0) {
1392 var canvasx = this.selPoints_[0].canvasx;
1393
1394 // Set the status message to indicate the selected point(s)
1395 var replace = this.attr_('xValueFormatter')(this.lastx_, this) + ":";
1396 var fmtFunc = this.attr_('yValueFormatter');
1397 var clen = this.colors_.length;
1398
1399 if (this.attr_('showLabelsOnHighlight')) {
1400 // Set the status message to indicate the selected point(s)
1401 for (var i = 0; i < this.selPoints_.length; i++) {
1402 if (!this.attr_("labelsShowZeroValues") && this.selPoints_[i].yval == 0) continue;
1403 if (!isOK(this.selPoints_[i].canvasy)) continue;
1404 if (this.attr_("labelsSeparateLines")) {
1405 replace += "<br/>";
1406 }
1407 var point = this.selPoints_[i];
1408 var c = new RGBColor(this.plotter_.colors[point.name]);
1409 var yval = fmtFunc(point.yval);
1410 replace += " <b><font color='" + c.toHex() + "'>"
1411 + point.name + "</font></b>:"
1412 + yval;
1413 }
1414
1415 this.attr_("labelsDiv").innerHTML = replace;
1416 }
1417
1418 // Draw colored circles over the center of each selected point
1419 ctx.save();
1420 for (var i = 0; i < this.selPoints_.length; i++) {
1421 if (!isOK(this.selPoints_[i].canvasy)) continue;
1422 var circleSize =
1423 this.attr_('highlightCircleSize', this.selPoints_[i].name);
1424 ctx.beginPath();
1425 ctx.fillStyle = this.plotter_.colors[this.selPoints_[i].name];
1426 ctx.arc(canvasx, this.selPoints_[i].canvasy, circleSize,
1427 0, 2 * Math.PI, false);
1428 ctx.fill();
1429 }
1430 ctx.restore();
1431
1432 this.previousVerticalX_ = canvasx;
1433 }
1434 };
1435
1436 /**
1437 * Set manually set selected dots, and display information about them
1438 * @param int row number that should by highlighted
1439 * false value clears the selection
1440 * @public
1441 */
1442 Dygraph.prototype.setSelection = function(row) {
1443 // Extract the points we've selected
1444 this.selPoints_ = [];
1445 var pos = 0;
1446
1447 if (row !== false) {
1448 row = row-this.boundaryIds_[0][0];
1449 }
1450
1451 if (row !== false && row >= 0) {
1452 for (var i in this.layout_.datasets) {
1453 if (row < this.layout_.datasets[i].length) {
1454 var point = this.layout_.points[pos+row];
1455
1456 if (this.attr_("stackedGraph")) {
1457 point = this.layout_.unstackPointAtIndex(pos+row);
1458 }
1459
1460 this.selPoints_.push(point);
1461 }
1462 pos += this.layout_.datasets[i].length;
1463 }
1464 }
1465
1466 if (this.selPoints_.length) {
1467 this.lastx_ = this.selPoints_[0].xval;
1468 this.updateSelection_();
1469 } else {
1470 this.lastx_ = -1;
1471 this.clearSelection();
1472 }
1473
1474 };
1475
1476 /**
1477 * The mouse has left the canvas. Clear out whatever artifacts remain
1478 * @param {Object} event the mouseout event from the browser.
1479 * @private
1480 */
1481 Dygraph.prototype.mouseOut_ = function(event) {
1482 if (this.attr_("unhighlightCallback")) {
1483 this.attr_("unhighlightCallback")(event);
1484 }
1485
1486 if (this.attr_("hideOverlayOnMouseOut")) {
1487 this.clearSelection();
1488 }
1489 };
1490
1491 /**
1492 * Remove all selection from the canvas
1493 * @public
1494 */
1495 Dygraph.prototype.clearSelection = function() {
1496 // Get rid of the overlay data
1497 var ctx = this.canvas_.getContext("2d");
1498 ctx.clearRect(0, 0, this.width_, this.height_);
1499 this.attr_("labelsDiv").innerHTML = "";
1500 this.selPoints_ = [];
1501 this.lastx_ = -1;
1502 }
1503
1504 /**
1505 * Returns the number of the currently selected row
1506 * @return int row number, of -1 if nothing is selected
1507 * @public
1508 */
1509 Dygraph.prototype.getSelection = function() {
1510 if (!this.selPoints_ || this.selPoints_.length < 1) {
1511 return -1;
1512 }
1513
1514 for (var row=0; row<this.layout_.points.length; row++ ) {
1515 if (this.layout_.points[row].x == this.selPoints_[0].x) {
1516 return row + this.boundaryIds_[0][0];
1517 }
1518 }
1519 return -1;
1520 }
1521
1522 Dygraph.zeropad = function(x) {
1523 if (x < 10) return "0" + x; else return "" + x;
1524 }
1525
1526 /**
1527 * Return a string version of the hours, minutes and seconds portion of a date.
1528 * @param {Number} date The JavaScript date (ms since epoch)
1529 * @return {String} A time of the form "HH:MM:SS"
1530 * @private
1531 */
1532 Dygraph.hmsString_ = function(date) {
1533 var zeropad = Dygraph.zeropad;
1534 var d = new Date(date);
1535 if (d.getSeconds()) {
1536 return zeropad(d.getHours()) + ":" +
1537 zeropad(d.getMinutes()) + ":" +
1538 zeropad(d.getSeconds());
1539 } else {
1540 return zeropad(d.getHours()) + ":" + zeropad(d.getMinutes());
1541 }
1542 }
1543
1544 /**
1545 * Convert a JS date to a string appropriate to display on an axis that
1546 * is displaying values at the stated granularity.
1547 * @param {Date} date The date to format
1548 * @param {Number} granularity One of the Dygraph granularity constants
1549 * @return {String} The formatted date
1550 * @private
1551 */
1552 Dygraph.dateAxisFormatter = function(date, granularity) {
1553 if (granularity >= Dygraph.DECADAL) {
1554 return date.strftime('%Y');
1555 } else if (granularity >= Dygraph.MONTHLY) {
1556 return date.strftime('%b %y');
1557 } else {
1558 var frac = date.getHours() * 3600 + date.getMinutes() * 60 + date.getSeconds() + date.getMilliseconds();
1559 if (frac == 0 || granularity >= Dygraph.DAILY) {
1560 return new Date(date.getTime() + 3600*1000).strftime('%d%b');
1561 } else {
1562 return Dygraph.hmsString_(date.getTime());
1563 }
1564 }
1565 }
1566
1567 /**
1568 * Convert a JS date (millis since epoch) to YYYY/MM/DD
1569 * @param {Number} date The JavaScript date (ms since epoch)
1570 * @return {String} A date of the form "YYYY/MM/DD"
1571 * @private
1572 */
1573 Dygraph.dateString_ = function(date, self) {
1574 var zeropad = Dygraph.zeropad;
1575 var d = new Date(date);
1576
1577 // Get the year:
1578 var year = "" + d.getFullYear();
1579 // Get a 0 padded month string
1580 var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh
1581 // Get a 0 padded day string
1582 var day = zeropad(d.getDate());
1583
1584 var ret = "";
1585 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
1586 if (frac) ret = " " + Dygraph.hmsString_(date);
1587
1588 return year + "/" + month + "/" + day + ret;
1589 };
1590
1591 /**
1592 * Round a number to the specified number of digits past the decimal point.
1593 * @param {Number} num The number to round
1594 * @param {Number} places The number of decimals to which to round
1595 * @return {Number} The rounded number
1596 * @private
1597 */
1598 Dygraph.round_ = function(num, places) {
1599 var shift = Math.pow(10, places);
1600 return Math.round(num * shift)/shift;
1601 };
1602
1603 /**
1604 * Fires when there's data available to be graphed.
1605 * @param {String} data Raw CSV data to be plotted
1606 * @private
1607 */
1608 Dygraph.prototype.loadedEvent_ = function(data) {
1609 this.rawData_ = this.parseCSV_(data);
1610 this.predraw_();
1611 };
1612
1613 Dygraph.prototype.months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
1614 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
1615 Dygraph.prototype.quarters = ["Jan", "Apr", "Jul", "Oct"];
1616
1617 /**
1618 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1619 * @private
1620 */
1621 Dygraph.prototype.addXTicks_ = function() {
1622 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1623 var startDate, endDate;
1624 if (this.dateWindow_) {
1625 startDate = this.dateWindow_[0];
1626 endDate = this.dateWindow_[1];
1627 } else {
1628 startDate = this.rawData_[0][0];
1629 endDate = this.rawData_[this.rawData_.length - 1][0];
1630 }
1631
1632 var xTicks = this.attr_('xTicker')(startDate, endDate, this);
1633 this.layout_.updateOptions({xTicks: xTicks});
1634 };
1635
1636 // Time granularity enumeration
1637 Dygraph.SECONDLY = 0;
1638 Dygraph.TWO_SECONDLY = 1;
1639 Dygraph.FIVE_SECONDLY = 2;
1640 Dygraph.TEN_SECONDLY = 3;
1641 Dygraph.THIRTY_SECONDLY = 4;
1642 Dygraph.MINUTELY = 5;
1643 Dygraph.TWO_MINUTELY = 6;
1644 Dygraph.FIVE_MINUTELY = 7;
1645 Dygraph.TEN_MINUTELY = 8;
1646 Dygraph.THIRTY_MINUTELY = 9;
1647 Dygraph.HOURLY = 10;
1648 Dygraph.TWO_HOURLY = 11;
1649 Dygraph.SIX_HOURLY = 12;
1650 Dygraph.DAILY = 13;
1651 Dygraph.WEEKLY = 14;
1652 Dygraph.MONTHLY = 15;
1653 Dygraph.QUARTERLY = 16;
1654 Dygraph.BIANNUAL = 17;
1655 Dygraph.ANNUAL = 18;
1656 Dygraph.DECADAL = 19;
1657 Dygraph.CENTENNIAL = 20;
1658 Dygraph.NUM_GRANULARITIES = 21;
1659
1660 Dygraph.SHORT_SPACINGS = [];
1661 Dygraph.SHORT_SPACINGS[Dygraph.SECONDLY] = 1000 * 1;
1662 Dygraph.SHORT_SPACINGS[Dygraph.TWO_SECONDLY] = 1000 * 2;
1663 Dygraph.SHORT_SPACINGS[Dygraph.FIVE_SECONDLY] = 1000 * 5;
1664 Dygraph.SHORT_SPACINGS[Dygraph.TEN_SECONDLY] = 1000 * 10;
1665 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_SECONDLY] = 1000 * 30;
1666 Dygraph.SHORT_SPACINGS[Dygraph.MINUTELY] = 1000 * 60;
1667 Dygraph.SHORT_SPACINGS[Dygraph.TWO_MINUTELY] = 1000 * 60 * 2;
1668 Dygraph.SHORT_SPACINGS[Dygraph.FIVE_MINUTELY] = 1000 * 60 * 5;
1669 Dygraph.SHORT_SPACINGS[Dygraph.TEN_MINUTELY] = 1000 * 60 * 10;
1670 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_MINUTELY] = 1000 * 60 * 30;
1671 Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600;
1672 Dygraph.SHORT_SPACINGS[Dygraph.TWO_HOURLY] = 1000 * 3600 * 2;
1673 Dygraph.SHORT_SPACINGS[Dygraph.SIX_HOURLY] = 1000 * 3600 * 6;
1674 Dygraph.SHORT_SPACINGS[Dygraph.DAILY] = 1000 * 86400;
1675 Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY] = 1000 * 604800;
1676
1677 // NumXTicks()
1678 //
1679 // If we used this time granularity, how many ticks would there be?
1680 // This is only an approximation, but it's generally good enough.
1681 //
1682 Dygraph.prototype.NumXTicks = function(start_time, end_time, granularity) {
1683 if (granularity < Dygraph.MONTHLY) {
1684 // Generate one tick mark for every fixed interval of time.
1685 var spacing = Dygraph.SHORT_SPACINGS[granularity];
1686 return Math.floor(0.5 + 1.0 * (end_time - start_time) / spacing);
1687 } else {
1688 var year_mod = 1; // e.g. to only print one point every 10 years.
1689 var num_months = 12;
1690 if (granularity == Dygraph.QUARTERLY) num_months = 3;
1691 if (granularity == Dygraph.BIANNUAL) num_months = 2;
1692 if (granularity == Dygraph.ANNUAL) num_months = 1;
1693 if (granularity == Dygraph.DECADAL) { num_months = 1; year_mod = 10; }
1694 if (granularity == Dygraph.CENTENNIAL) { num_months = 1; year_mod = 100; }
1695
1696 var msInYear = 365.2524 * 24 * 3600 * 1000;
1697 var num_years = 1.0 * (end_time - start_time) / msInYear;
1698 return Math.floor(0.5 + 1.0 * num_years * num_months / year_mod);
1699 }
1700 };
1701
1702 // GetXAxis()
1703 //
1704 // Construct an x-axis of nicely-formatted times on meaningful boundaries
1705 // (e.g. 'Jan 09' rather than 'Jan 22, 2009').
1706 //
1707 // Returns an array containing {v: millis, label: label} dictionaries.
1708 //
1709 Dygraph.prototype.GetXAxis = function(start_time, end_time, granularity) {
1710 var formatter = this.attr_("xAxisLabelFormatter");
1711 var ticks = [];
1712 if (granularity < Dygraph.MONTHLY) {
1713 // Generate one tick mark for every fixed interval of time.
1714 var spacing = Dygraph.SHORT_SPACINGS[granularity];
1715 var format = '%d%b'; // e.g. "1Jan"
1716
1717 // Find a time less than start_time which occurs on a "nice" time boundary
1718 // for this granularity.
1719 var g = spacing / 1000;
1720 var d = new Date(start_time);
1721 if (g <= 60) { // seconds
1722 var x = d.getSeconds(); d.setSeconds(x - x % g);
1723 } else {
1724 d.setSeconds(0);
1725 g /= 60;
1726 if (g <= 60) { // minutes
1727 var x = d.getMinutes(); d.setMinutes(x - x % g);
1728 } else {
1729 d.setMinutes(0);
1730 g /= 60;
1731
1732 if (g <= 24) { // days
1733 var x = d.getHours(); d.setHours(x - x % g);
1734 } else {
1735 d.setHours(0);
1736 g /= 24;
1737
1738 if (g == 7) { // one week
1739 d.setDate(d.getDate() - d.getDay());
1740 }
1741 }
1742 }
1743 }
1744 start_time = d.getTime();
1745
1746 for (var t = start_time; t <= end_time; t += spacing) {
1747 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
1748 }
1749 } else {
1750 // Display a tick mark on the first of a set of months of each year.
1751 // Years get a tick mark iff y % year_mod == 0. This is useful for
1752 // displaying a tick mark once every 10 years, say, on long time scales.
1753 var months;
1754 var year_mod = 1; // e.g. to only print one point every 10 years.
1755
1756 if (granularity == Dygraph.MONTHLY) {
1757 months = [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
1758 } else if (granularity == Dygraph.QUARTERLY) {
1759 months = [ 0, 3, 6, 9 ];
1760 } else if (granularity == Dygraph.BIANNUAL) {
1761 months = [ 0, 6 ];
1762 } else if (granularity == Dygraph.ANNUAL) {
1763 months = [ 0 ];
1764 } else if (granularity == Dygraph.DECADAL) {
1765 months = [ 0 ];
1766 year_mod = 10;
1767 } else if (granularity == Dygraph.CENTENNIAL) {
1768 months = [ 0 ];
1769 year_mod = 100;
1770 } else {
1771 this.warn("Span of dates is too long");
1772 }
1773
1774 var start_year = new Date(start_time).getFullYear();
1775 var end_year = new Date(end_time).getFullYear();
1776 var zeropad = Dygraph.zeropad;
1777 for (var i = start_year; i <= end_year; i++) {
1778 if (i % year_mod != 0) continue;
1779 for (var j = 0; j < months.length; j++) {
1780 var date_str = i + "/" + zeropad(1 + months[j]) + "/01";
1781 var t = Date.parse(date_str);
1782 if (t < start_time || t > end_time) continue;
1783 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
1784 }
1785 }
1786 }
1787
1788 return ticks;
1789 };
1790
1791
1792 /**
1793 * Add ticks to the x-axis based on a date range.
1794 * @param {Number} startDate Start of the date window (millis since epoch)
1795 * @param {Number} endDate End of the date window (millis since epoch)
1796 * @return {Array.<Object>} Array of {label, value} tuples.
1797 * @public
1798 */
1799 Dygraph.dateTicker = function(startDate, endDate, self) {
1800 var chosen = -1;
1801 for (var i = 0; i < Dygraph.NUM_GRANULARITIES; i++) {
1802 var num_ticks = self.NumXTicks(startDate, endDate, i);
1803 if (self.width_ / num_ticks >= self.attr_('pixelsPerXLabel')) {
1804 chosen = i;
1805 break;
1806 }
1807 }
1808
1809 if (chosen >= 0) {
1810 return self.GetXAxis(startDate, endDate, chosen);
1811 } else {
1812 // TODO(danvk): signal error.
1813 }
1814 };
1815
1816 /**
1817 * Add ticks when the x axis has numbers on it (instead of dates)
1818 * @param {Number} startDate Start of the date window (millis since epoch)
1819 * @param {Number} endDate End of the date window (millis since epoch)
1820 * @param self
1821 * @param {function} attribute accessor function.
1822 * @return {Array.<Object>} Array of {label, value} tuples.
1823 * @public
1824 */
1825 Dygraph.numericTicks = function(minV, maxV, self, axis_props, vals) {
1826 var attr = function(k) {
1827 if (axis_props && axis_props.hasOwnProperty(k)) return axis_props[k];
1828 return self.attr_(k);
1829 };
1830
1831 var ticks = [];
1832 if (vals) {
1833 for (var i = 0; i < vals.length; i++) {
1834 ticks.push({v: vals[i]});
1835 }
1836 } else {
1837 // Basic idea:
1838 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
1839 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks).
1840 // The first spacing greater than pixelsPerYLabel is what we use.
1841 // TODO(danvk): version that works on a log scale.
1842 if (attr("labelsKMG2")) {
1843 var mults = [1, 2, 4, 8];
1844 } else {
1845 var mults = [1, 2, 5];
1846 }
1847 var scale, low_val, high_val, nTicks;
1848 // TODO(danvk): make it possible to set this for x- and y-axes independently.
1849 var pixelsPerTick = attr('pixelsPerYLabel');
1850 for (var i = -10; i < 50; i++) {
1851 if (attr("labelsKMG2")) {
1852 var base_scale = Math.pow(16, i);
1853 } else {
1854 var base_scale = Math.pow(10, i);
1855 }
1856 for (var j = 0; j < mults.length; j++) {
1857 scale = base_scale * mults[j];
1858 low_val = Math.floor(minV / scale) * scale;
1859 high_val = Math.ceil(maxV / scale) * scale;
1860 nTicks = Math.abs(high_val - low_val) / scale;
1861 var spacing = self.height_ / nTicks;
1862 // wish I could break out of both loops at once...
1863 if (spacing > pixelsPerTick) break;
1864 }
1865 if (spacing > pixelsPerTick) break;
1866 }
1867
1868 // Construct the set of ticks.
1869 // Allow reverse y-axis if it's explicitly requested.
1870 if (low_val > high_val) scale *= -1;
1871 for (var i = 0; i < nTicks; i++) {
1872 var tickV = low_val + i * scale;
1873 ticks.push( {v: tickV} );
1874 }
1875 }
1876
1877 // Add formatted labels to the ticks.
1878 var k;
1879 var k_labels = [];
1880 if (attr("labelsKMB")) {
1881 k = 1000;
1882 k_labels = [ "K", "M", "B", "T" ];
1883 }
1884 if (attr("labelsKMG2")) {
1885 if (k) self.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
1886 k = 1024;
1887 k_labels = [ "k", "M", "G", "T" ];
1888 }
1889 var formatter = attr('yAxisLabelFormatter') ? attr('yAxisLabelFormatter') : attr('yValueFormatter');
1890
1891 for (var i = 0; i < ticks.length; i++) {
1892 var tickV = ticks[i].v;
1893 var absTickV = Math.abs(tickV);
1894 var label;
1895 if (formatter != undefined) {
1896 label = formatter(tickV);
1897 } else {
1898 label = Dygraph.round_(tickV, 2);
1899 }
1900 if (k_labels.length) {
1901 // Round up to an appropriate unit.
1902 var n = k*k*k*k;
1903 for (var j = 3; j >= 0; j--, n /= k) {
1904 if (absTickV >= n) {
1905 label = Dygraph.round_(tickV / n, 1) + k_labels[j];
1906 break;
1907 }
1908 }
1909 }
1910 ticks[i].label = label;
1911 }
1912 return ticks;
1913 };
1914
1915 // Computes the range of the data series (including confidence intervals).
1916 // series is either [ [x1, y1], [x2, y2], ... ] or
1917 // [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
1918 // Returns [low, high]
1919 Dygraph.prototype.extremeValues_ = function(series) {
1920 var minY = null, maxY = null;
1921
1922 var bars = this.attr_("errorBars") || this.attr_("customBars");
1923 if (bars) {
1924 // With custom bars, maxY is the max of the high values.
1925 for (var j = 0; j < series.length; j++) {
1926 var y = series[j][1][0];
1927 if (!y) continue;
1928 var low = y - series[j][1][1];
1929 var high = y + series[j][1][2];
1930 if (low > y) low = y; // this can happen with custom bars,
1931 if (high < y) high = y; // e.g. in tests/custom-bars.html
1932 if (maxY == null || high > maxY) {
1933 maxY = high;
1934 }
1935 if (minY == null || low < minY) {
1936 minY = low;
1937 }
1938 }
1939 } else {
1940 for (var j = 0; j < series.length; j++) {
1941 var y = series[j][1];
1942 if (y === null || isNaN(y)) continue;
1943 if (maxY == null || y > maxY) {
1944 maxY = y;
1945 }
1946 if (minY == null || y < minY) {
1947 minY = y;
1948 }
1949 }
1950 }
1951
1952 return [minY, maxY];
1953 };
1954
1955 /**
1956 * This function is called once when the chart's data is changed or the options
1957 * dictionary is updated. It is _not_ called when the user pans or zooms. The
1958 * idea is that values derived from the chart's data can be computed here,
1959 * rather than every time the chart is drawn. This includes things like the
1960 * number of axes, rolling averages, etc.
1961 */
1962 Dygraph.prototype.predraw_ = function() {
1963 // TODO(danvk): move more computations out of drawGraph_ and into here.
1964 this.computeYAxes_();
1965
1966 // Create a new plotter.
1967 if (this.plotter_) this.plotter_.clear();
1968 this.plotter_ = new DygraphCanvasRenderer(this,
1969 this.hidden_, this.layout_,
1970 this.renderOptions_);
1971
1972 // The roller sits in the bottom left corner of the chart. We don't know where
1973 // this will be until the options are available, so it's positioned here.
1974 this.createRollInterface_();
1975
1976 // Same thing applies for the labelsDiv. It's right edge should be flush with
1977 // the right edge of the charting area (which may not be the same as the right
1978 // edge of the div, if we have two y-axes.
1979 this.positionLabelsDiv_();
1980
1981 // If the data or options have changed, then we'd better redraw.
1982 this.drawGraph_();
1983 };
1984
1985 /**
1986 =======
1987 * Update the graph with new data. This method is called when the viewing area
1988 * has changed. If the underlying data or options have changed, predraw_ will
1989 * be called before drawGraph_ is called.
1990 * @private
1991 */
1992 Dygraph.prototype.drawGraph_ = function() {
1993 var data = this.rawData_;
1994
1995 // This is used to set the second parameter to drawCallback, below.
1996 var is_initial_draw = this.is_initial_draw_;
1997 this.is_initial_draw_ = false;
1998
1999 var minY = null, maxY = null;
2000 this.layout_.removeAllDatasets();
2001 this.setColors_();
2002 this.attrs_['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
2003
2004 // Loop over the fields (series). Go from the last to the first,
2005 // because if they're stacked that's how we accumulate the values.
2006
2007 var cumulative_y = []; // For stacked series.
2008 var datasets = [];
2009
2010 var extremes = {}; // series name -> [low, high]
2011
2012 // Loop over all fields and create datasets
2013 for (var i = data[0].length - 1; i >= 1; i--) {
2014 if (!this.visibility()[i - 1]) continue;
2015
2016 var seriesName = this.attr_("labels")[i];
2017 var connectSeparatedPoints = this.attr_('connectSeparatedPoints', i);
2018
2019 var series = [];
2020 for (var j = 0; j < data.length; j++) {
2021 if (data[j][i] != null || !connectSeparatedPoints) {
2022 var date = data[j][0];
2023 series.push([date, data[j][i]]);
2024 }
2025 }
2026
2027 // TODO(danvk): move this into predraw_. It's insane to do it here.
2028 series = this.rollingAverage(series, this.rollPeriod_);
2029
2030 // Prune down to the desired range, if necessary (for zooming)
2031 // Because there can be lines going to points outside of the visible area,
2032 // we actually prune to visible points, plus one on either side.
2033 var bars = this.attr_("errorBars") || this.attr_("customBars");
2034 if (this.dateWindow_) {
2035 var low = this.dateWindow_[0];
2036 var high= this.dateWindow_[1];
2037 var pruned = [];
2038 // TODO(danvk): do binary search instead of linear search.
2039 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2040 var firstIdx = null, lastIdx = null;
2041 for (var k = 0; k < series.length; k++) {
2042 if (series[k][0] >= low && firstIdx === null) {
2043 firstIdx = k;
2044 }
2045 if (series[k][0] <= high) {
2046 lastIdx = k;
2047 }
2048 }
2049 if (firstIdx === null) firstIdx = 0;
2050 if (firstIdx > 0) firstIdx--;
2051 if (lastIdx === null) lastIdx = series.length - 1;
2052 if (lastIdx < series.length - 1) lastIdx++;
2053 this.boundaryIds_[i-1] = [firstIdx, lastIdx];
2054 for (var k = firstIdx; k <= lastIdx; k++) {
2055 pruned.push(series[k]);
2056 }
2057 series = pruned;
2058 } else {
2059 this.boundaryIds_[i-1] = [0, series.length-1];
2060 }
2061
2062 var seriesExtremes = this.extremeValues_(series);
2063
2064 if (bars) {
2065 for (var j=0; j<series.length; j++) {
2066 val = [series[j][0], series[j][1][0], series[j][1][1], series[j][1][2]];
2067 series[j] = val;
2068 }
2069 } else if (this.attr_("stackedGraph")) {
2070 var l = series.length;
2071 var actual_y;
2072 for (var j = 0; j < l; j++) {
2073 // If one data set has a NaN, let all subsequent stacked
2074 // sets inherit the NaN -- only start at 0 for the first set.
2075 var x = series[j][0];
2076 if (cumulative_y[x] === undefined) {
2077 cumulative_y[x] = 0;
2078 }
2079
2080 actual_y = series[j][1];
2081 cumulative_y[x] += actual_y;
2082
2083 series[j] = [x, cumulative_y[x]]
2084
2085 if (cumulative_y[x] > seriesExtremes[1]) {
2086 seriesExtremes[1] = cumulative_y[x];
2087 }
2088 if (cumulative_y[x] < seriesExtremes[0]) {
2089 seriesExtremes[0] = cumulative_y[x];
2090 }
2091 }
2092 }
2093 extremes[seriesName] = seriesExtremes;
2094
2095 datasets[i] = series;
2096 }
2097
2098 for (var i = 1; i < datasets.length; i++) {
2099 if (!this.visibility()[i - 1]) continue;
2100 this.layout_.addDataset(this.attr_("labels")[i], datasets[i]);
2101 }
2102
2103 // TODO(danvk): this method doesn't need to return anything.
2104 var out = this.computeYAxisRanges_(extremes);
2105 var axes = out[0];
2106 var seriesToAxisMap = out[1];
2107 this.layout_.updateOptions( { yAxes: axes,
2108 seriesToAxisMap: seriesToAxisMap
2109 } );
2110
2111 this.addXTicks_();
2112
2113 // Tell PlotKit to use this new data and render itself
2114 this.layout_.updateOptions({dateWindow: this.dateWindow_});
2115 this.layout_.evaluateWithError();
2116 this.plotter_.clear();
2117 this.plotter_.render();
2118 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2119 this.canvas_.height);
2120
2121 if (this.attr_("drawCallback") !== null) {
2122 this.attr_("drawCallback")(this, is_initial_draw);
2123 }
2124 };
2125
2126 /**
2127 * Determine properties of the y-axes which are independent of the data
2128 * currently being displayed. This includes things like the number of axes and
2129 * the style of the axes. It does not include the range of each axis and its
2130 * tick marks.
2131 * This fills in this.axes_ and this.seriesToAxisMap_.
2132 * axes_ = [ { options } ]
2133 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2134 * indices are into the axes_ array.
2135 */
2136 Dygraph.prototype.computeYAxes_ = function() {
2137 this.axes_ = [{}]; // always have at least one y-axis.
2138 this.seriesToAxisMap_ = {};
2139
2140 // Get a list of series names.
2141 var labels = this.attr_("labels");
2142 var series = {};
2143 for (var i = 1; i < labels.length; i++) series[labels[i]] = (i - 1);
2144
2145 // all options which could be applied per-axis:
2146 var axisOptions = [
2147 'includeZero',
2148 'valueRange',
2149 'labelsKMB',
2150 'labelsKMG2',
2151 'pixelsPerYLabel',
2152 'yAxisLabelWidth',
2153 'axisLabelFontSize',
2154 'axisTickSize'
2155 ];
2156
2157 // Copy global axis options over to the first axis.
2158 for (var i = 0; i < axisOptions.length; i++) {
2159 var k = axisOptions[i];
2160 var v = this.attr_(k);
2161 if (v) this.axes_[0][k] = v;
2162 }
2163
2164 // Go through once and add all the axes.
2165 for (var seriesName in series) {
2166 if (!series.hasOwnProperty(seriesName)) continue;
2167 var axis = this.attr_("axis", seriesName);
2168 if (axis == null) {
2169 this.seriesToAxisMap_[seriesName] = 0;
2170 continue;
2171 }
2172 if (typeof(axis) == 'object') {
2173 // Add a new axis, making a copy of its per-axis options.
2174 var opts = {};
2175 Dygraph.update(opts, this.axes_[0]);
2176 Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this.
2177 Dygraph.update(opts, axis);
2178 this.axes_.push(opts);
2179 this.seriesToAxisMap_[seriesName] = this.axes_.length - 1;
2180 }
2181 }
2182
2183 // Go through one more time and assign series to an axis defined by another
2184 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2185 for (var seriesName in series) {
2186 if (!series.hasOwnProperty(seriesName)) continue;
2187 var axis = this.attr_("axis", seriesName);
2188 if (typeof(axis) == 'string') {
2189 if (!this.seriesToAxisMap_.hasOwnProperty(axis)) {
2190 this.error("Series " + seriesName + " wants to share a y-axis with " +
2191 "series " + axis + ", which does not define its own axis.");
2192 return null;
2193 }
2194 var idx = this.seriesToAxisMap_[axis];
2195 this.seriesToAxisMap_[seriesName] = idx;
2196 }
2197 }
2198
2199 // Now we remove series from seriesToAxisMap_ which are not visible. We do
2200 // this last so that hiding the first series doesn't destroy the axis
2201 // properties of the primary axis.
2202 var seriesToAxisFiltered = {};
2203 var vis = this.visibility();
2204 for (var i = 1; i < labels.length; i++) {
2205 var s = labels[i];
2206 if (vis[i - 1]) seriesToAxisFiltered[s] = this.seriesToAxisMap_[s];
2207 }
2208 this.seriesToAxisMap_ = seriesToAxisFiltered;
2209 };
2210
2211 /**
2212 * Returns the number of y-axes on the chart.
2213 * @return {Number} the number of axes.
2214 */
2215 Dygraph.prototype.numAxes = function() {
2216 var last_axis = 0;
2217 for (var series in this.seriesToAxisMap_) {
2218 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2219 var idx = this.seriesToAxisMap_[series];
2220 if (idx > last_axis) last_axis = idx;
2221 }
2222 return 1 + last_axis;
2223 };
2224
2225 /**
2226 * Determine the value range and tick marks for each axis.
2227 * @param {Object} extremes A mapping from seriesName -> [low, high]
2228 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2229 */
2230 Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2231 // Build a map from axis number -> [list of series names]
2232 var seriesForAxis = [];
2233 for (var series in this.seriesToAxisMap_) {
2234 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2235 var idx = this.seriesToAxisMap_[series];
2236 while (seriesForAxis.length <= idx) seriesForAxis.push([]);
2237 seriesForAxis[idx].push(series);
2238 }
2239
2240 // Compute extreme values, a span and tick marks for each axis.
2241 for (var i = 0; i < this.axes_.length; i++) {
2242 var axis = this.axes_[i];
2243 if (axis.valueWindow) {
2244 // This is only set if the user has zoomed on the y-axis. It is never set
2245 // by a user. It takes precedence over axis.valueRange because, if you set
2246 // valueRange, you'd still expect to be able to pan.
2247 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
2248 } else if (axis.valueRange) {
2249 // This is a user-set value range for this axis.
2250 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
2251 } else {
2252 // Calculate the extremes of extremes.
2253 var series = seriesForAxis[i];
2254 var minY = Infinity; // extremes[series[0]][0];
2255 var maxY = -Infinity; // extremes[series[0]][1];
2256 for (var j = 0; j < series.length; j++) {
2257 minY = Math.min(extremes[series[j]][0], minY);
2258 maxY = Math.max(extremes[series[j]][1], maxY);
2259 }
2260 if (axis.includeZero && minY > 0) minY = 0;
2261
2262 // Add some padding and round up to an integer to be human-friendly.
2263 var span = maxY - minY;
2264 // special case: if we have no sense of scale, use +/-10% of the sole value.
2265 if (span == 0) { span = maxY; }
2266 var maxAxisY = maxY + 0.1 * span;
2267 var minAxisY = minY - 0.1 * span;
2268
2269 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2270 if (!this.attr_("avoidMinZero")) {
2271 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2272 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
2273 }
2274
2275 if (this.attr_("includeZero")) {
2276 if (maxY < 0) maxAxisY = 0;
2277 if (minY > 0) minAxisY = 0;
2278 }
2279
2280 axis.computedValueRange = [minAxisY, maxAxisY];
2281 }
2282
2283 // Add ticks. By default, all axes inherit the tick positions of the
2284 // primary axis. However, if an axis is specifically marked as having
2285 // independent ticks, then that is permissible as well.
2286 if (i == 0 || axis.independentTicks) {
2287 axis.ticks =
2288 Dygraph.numericTicks(axis.computedValueRange[0],
2289 axis.computedValueRange[1],
2290 this,
2291 axis);
2292 } else {
2293 var p_axis = this.axes_[0];
2294 var p_ticks = p_axis.ticks;
2295 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
2296 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
2297 var tick_values = [];
2298 for (var i = 0; i < p_ticks.length; i++) {
2299 var y_frac = (p_ticks[i].v - p_axis.computedValueRange[0]) / p_scale;
2300 var y_val = axis.computedValueRange[0] + y_frac * scale;
2301 tick_values.push(y_val);
2302 }
2303
2304 axis.ticks =
2305 Dygraph.numericTicks(axis.computedValueRange[0],
2306 axis.computedValueRange[1],
2307 this, axis, tick_values);
2308 }
2309 }
2310
2311 return [this.axes_, this.seriesToAxisMap_];
2312 };
2313
2314 /**
2315 * Calculates the rolling average of a data set.
2316 * If originalData is [label, val], rolls the average of those.
2317 * If originalData is [label, [, it's interpreted as [value, stddev]
2318 * and the roll is returned in the same form, with appropriately reduced
2319 * stddev for each value.
2320 * Note that this is where fractional input (i.e. '5/10') is converted into
2321 * decimal values.
2322 * @param {Array} originalData The data in the appropriate format (see above)
2323 * @param {Number} rollPeriod The number of days over which to average the data
2324 */
2325 Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
2326 if (originalData.length < 2)
2327 return originalData;
2328 var rollPeriod = Math.min(rollPeriod, originalData.length - 1);
2329 var rollingData = [];
2330 var sigma = this.attr_("sigma");
2331
2332 if (this.fractions_) {
2333 var num = 0;
2334 var den = 0; // numerator/denominator
2335 var mult = 100.0;
2336 for (var i = 0; i < originalData.length; i++) {
2337 num += originalData[i][1][0];
2338 den += originalData[i][1][1];
2339 if (i - rollPeriod >= 0) {
2340 num -= originalData[i - rollPeriod][1][0];
2341 den -= originalData[i - rollPeriod][1][1];
2342 }
2343
2344 var date = originalData[i][0];
2345 var value = den ? num / den : 0.0;
2346 if (this.attr_("errorBars")) {
2347 if (this.wilsonInterval_) {
2348 // For more details on this confidence interval, see:
2349 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
2350 if (den) {
2351 var p = value < 0 ? 0 : value, n = den;
2352 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
2353 var denom = 1 + sigma * sigma / den;
2354 var low = (p + sigma * sigma / (2 * den) - pm) / denom;
2355 var high = (p + sigma * sigma / (2 * den) + pm) / denom;
2356 rollingData[i] = [date,
2357 [p * mult, (p - low) * mult, (high - p) * mult]];
2358 } else {
2359 rollingData[i] = [date, [0, 0, 0]];
2360 }
2361 } else {
2362 var stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
2363 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
2364 }
2365 } else {
2366 rollingData[i] = [date, mult * value];
2367 }
2368 }
2369 } else if (this.attr_("customBars")) {
2370 var low = 0;
2371 var mid = 0;
2372 var high = 0;
2373 var count = 0;
2374 for (var i = 0; i < originalData.length; i++) {
2375 var data = originalData[i][1];
2376 var y = data[1];
2377 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
2378
2379 if (y != null && !isNaN(y)) {
2380 low += data[0];
2381 mid += y;
2382 high += data[2];
2383 count += 1;
2384 }
2385 if (i - rollPeriod >= 0) {
2386 var prev = originalData[i - rollPeriod];
2387 if (prev[1][1] != null && !isNaN(prev[1][1])) {
2388 low -= prev[1][0];
2389 mid -= prev[1][1];
2390 high -= prev[1][2];
2391 count -= 1;
2392 }
2393 }
2394 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
2395 1.0 * (mid - low) / count,
2396 1.0 * (high - mid) / count ]];
2397 }
2398 } else {
2399 // Calculate the rolling average for the first rollPeriod - 1 points where
2400 // there is not enough data to roll over the full number of days
2401 var num_init_points = Math.min(rollPeriod - 1, originalData.length - 2);
2402 if (!this.attr_("errorBars")){
2403 if (rollPeriod == 1) {
2404 return originalData;
2405 }
2406
2407 for (var i = 0; i < originalData.length; i++) {
2408 var sum = 0;
2409 var num_ok = 0;
2410 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2411 var y = originalData[j][1];
2412 if (y == null || isNaN(y)) continue;
2413 num_ok++;
2414 sum += originalData[j][1];
2415 }
2416 if (num_ok) {
2417 rollingData[i] = [originalData[i][0], sum / num_ok];
2418 } else {
2419 rollingData[i] = [originalData[i][0], null];
2420 }
2421 }
2422
2423 } else {
2424 for (var i = 0; i < originalData.length; i++) {
2425 var sum = 0;
2426 var variance = 0;
2427 var num_ok = 0;
2428 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2429 var y = originalData[j][1][0];
2430 if (y == null || isNaN(y)) continue;
2431 num_ok++;
2432 sum += originalData[j][1][0];
2433 variance += Math.pow(originalData[j][1][1], 2);
2434 }
2435 if (num_ok) {
2436 var stddev = Math.sqrt(variance) / num_ok;
2437 rollingData[i] = [originalData[i][0],
2438 [sum / num_ok, sigma * stddev, sigma * stddev]];
2439 } else {
2440 rollingData[i] = [originalData[i][0], [null, null, null]];
2441 }
2442 }
2443 }
2444 }
2445
2446 return rollingData;
2447 };
2448
2449 /**
2450 * Parses a date, returning the number of milliseconds since epoch. This can be
2451 * passed in as an xValueParser in the Dygraph constructor.
2452 * TODO(danvk): enumerate formats that this understands.
2453 * @param {String} A date in YYYYMMDD format.
2454 * @return {Number} Milliseconds since epoch.
2455 * @public
2456 */
2457 Dygraph.dateParser = function(dateStr, self) {
2458 var dateStrSlashed;
2459 var d;
2460 if (dateStr.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
2461 dateStrSlashed = dateStr.replace("-", "/", "g");
2462 while (dateStrSlashed.search("-") != -1) {
2463 dateStrSlashed = dateStrSlashed.replace("-", "/");
2464 }
2465 d = Date.parse(dateStrSlashed);
2466 } else if (dateStr.length == 8) { // e.g. '20090712'
2467 // TODO(danvk): remove support for this format. It's confusing.
2468 dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2)
2469 + "/" + dateStr.substr(6,2);
2470 d = Date.parse(dateStrSlashed);
2471 } else {
2472 // Any format that Date.parse will accept, e.g. "2009/07/12" or
2473 // "2009/07/12 12:34:56"
2474 d = Date.parse(dateStr);
2475 }
2476
2477 if (!d || isNaN(d)) {
2478 self.error("Couldn't parse " + dateStr + " as a date");
2479 }
2480 return d;
2481 };
2482
2483 /**
2484 * Detects the type of the str (date or numeric) and sets the various
2485 * formatting attributes in this.attrs_ based on this type.
2486 * @param {String} str An x value.
2487 * @private
2488 */
2489 Dygraph.prototype.detectTypeFromString_ = function(str) {
2490 var isDate = false;
2491 if (str.indexOf('-') >= 0 ||
2492 str.indexOf('/') >= 0 ||
2493 isNaN(parseFloat(str))) {
2494 isDate = true;
2495 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
2496 // TODO(danvk): remove support for this format.
2497 isDate = true;
2498 }
2499
2500 if (isDate) {
2501 this.attrs_.xValueFormatter = Dygraph.dateString_;
2502 this.attrs_.xValueParser = Dygraph.dateParser;
2503 this.attrs_.xTicker = Dygraph.dateTicker;
2504 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
2505 } else {
2506 this.attrs_.xValueFormatter = function(x) { return x; };
2507 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2508 this.attrs_.xTicker = Dygraph.numericTicks;
2509 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
2510 }
2511 };
2512
2513 /**
2514 * Parses a string in a special csv format. We expect a csv file where each
2515 * line is a date point, and the first field in each line is the date string.
2516 * We also expect that all remaining fields represent series.
2517 * if the errorBars attribute is set, then interpret the fields as:
2518 * date, series1, stddev1, series2, stddev2, ...
2519 * @param {Array.<Object>} data See above.
2520 * @private
2521 *
2522 * @return Array.<Object> An array with one entry for each row. These entries
2523 * are an array of cells in that row. The first entry is the parsed x-value for
2524 * the row. The second, third, etc. are the y-values. These can take on one of
2525 * three forms, depending on the CSV and constructor parameters:
2526 * 1. numeric value
2527 * 2. [ value, stddev ]
2528 * 3. [ low value, center value, high value ]
2529 */
2530 Dygraph.prototype.parseCSV_ = function(data) {
2531 var ret = [];
2532 var lines = data.split("\n");
2533
2534 // Use the default delimiter or fall back to a tab if that makes sense.
2535 var delim = this.attr_('delimiter');
2536 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
2537 delim = '\t';
2538 }
2539
2540 var start = 0;
2541 if (this.labelsFromCSV_) {
2542 start = 1;
2543 this.attrs_.labels = lines[0].split(delim);
2544 }
2545
2546 // Parse the x as a float or return null if it's not a number.
2547 var parseFloatOrNull = function(x) {
2548 var val = parseFloat(x);
2549 // isFinite() returns false for NaN and +/-Infinity.
2550 return isFinite(val) ? val : null;
2551 };
2552
2553 var xParser;
2554 var defaultParserSet = false; // attempt to auto-detect x value type
2555 var expectedCols = this.attr_("labels").length;
2556 var outOfOrder = false;
2557 for (var i = start; i < lines.length; i++) {
2558 var line = lines[i];
2559 if (line.length == 0) continue; // skip blank lines
2560 if (line[0] == '#') continue; // skip comment lines
2561 var inFields = line.split(delim);
2562 if (inFields.length < 2) continue;
2563
2564 var fields = [];
2565 if (!defaultParserSet) {
2566 this.detectTypeFromString_(inFields[0]);
2567 xParser = this.attr_("xValueParser");
2568 defaultParserSet = true;
2569 }
2570 fields[0] = xParser(inFields[0], this);
2571
2572 // If fractions are expected, parse the numbers as "A/B"
2573 if (this.fractions_) {
2574 for (var j = 1; j < inFields.length; j++) {
2575 // TODO(danvk): figure out an appropriate way to flag parse errors.
2576 var vals = inFields[j].split("/");
2577 fields[j] = [parseFloatOrNull(vals[0]), parseFloatOrNull(vals[1])];
2578 }
2579 } else if (this.attr_("errorBars")) {
2580 // If there are error bars, values are (value, stddev) pairs
2581 for (var j = 1; j < inFields.length; j += 2)
2582 fields[(j + 1) / 2] = [parseFloatOrNull(inFields[j]),
2583 parseFloatOrNull(inFields[j + 1])];
2584 } else if (this.attr_("customBars")) {
2585 // Bars are a low;center;high tuple
2586 for (var j = 1; j < inFields.length; j++) {
2587 var vals = inFields[j].split(";");
2588 fields[j] = [ parseFloatOrNull(vals[0]),
2589 parseFloatOrNull(vals[1]),
2590 parseFloatOrNull(vals[2]) ];
2591 }
2592 } else {
2593 // Values are just numbers
2594 for (var j = 1; j < inFields.length; j++) {
2595 fields[j] = parseFloatOrNull(inFields[j]);
2596 }
2597 }
2598 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2599 outOfOrder = true;
2600 }
2601 ret.push(fields);
2602
2603 if (fields.length != expectedCols) {
2604 this.error("Number of columns in line " + i + " (" + fields.length +
2605 ") does not agree with number of labels (" + expectedCols +
2606 ") " + line);
2607 }
2608 }
2609
2610 if (outOfOrder) {
2611 this.warn("CSV is out of order; order it correctly to speed loading.");
2612 ret.sort(function(a,b) { return a[0] - b[0] });
2613 }
2614
2615 return ret;
2616 };
2617
2618 /**
2619 * The user has provided their data as a pre-packaged JS array. If the x values
2620 * are numeric, this is the same as dygraphs' internal format. If the x values
2621 * are dates, we need to convert them from Date objects to ms since epoch.
2622 * @param {Array.<Object>} data
2623 * @return {Array.<Object>} data with numeric x values.
2624 */
2625 Dygraph.prototype.parseArray_ = function(data) {
2626 // Peek at the first x value to see if it's numeric.
2627 if (data.length == 0) {
2628 this.error("Can't plot empty data set");
2629 return null;
2630 }
2631 if (data[0].length == 0) {
2632 this.error("Data set cannot contain an empty row");
2633 return null;
2634 }
2635
2636 if (this.attr_("labels") == null) {
2637 this.warn("Using default labels. Set labels explicitly via 'labels' " +
2638 "in the options parameter");
2639 this.attrs_.labels = [ "X" ];
2640 for (var i = 1; i < data[0].length; i++) {
2641 this.attrs_.labels.push("Y" + i);
2642 }
2643 }
2644
2645 if (Dygraph.isDateLike(data[0][0])) {
2646 // Some intelligent defaults for a date x-axis.
2647 this.attrs_.xValueFormatter = Dygraph.dateString_;
2648 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
2649 this.attrs_.xTicker = Dygraph.dateTicker;
2650
2651 // Assume they're all dates.
2652 var parsedData = Dygraph.clone(data);
2653 for (var i = 0; i < data.length; i++) {
2654 if (parsedData[i].length == 0) {
2655 this.error("Row " + (1 + i) + " of data is empty");
2656 return null;
2657 }
2658 if (parsedData[i][0] == null
2659 || typeof(parsedData[i][0].getTime) != 'function'
2660 || isNaN(parsedData[i][0].getTime())) {
2661 this.error("x value in row " + (1 + i) + " is not a Date");
2662 return null;
2663 }
2664 parsedData[i][0] = parsedData[i][0].getTime();
2665 }
2666 return parsedData;
2667 } else {
2668 // Some intelligent defaults for a numeric x-axis.
2669 this.attrs_.xValueFormatter = function(x) { return x; };
2670 this.attrs_.xTicker = Dygraph.numericTicks;
2671 return data;
2672 }
2673 };
2674
2675 /**
2676 * Parses a DataTable object from gviz.
2677 * The data is expected to have a first column that is either a date or a
2678 * number. All subsequent columns must be numbers. If there is a clear mismatch
2679 * between this.xValueParser_ and the type of the first column, it will be
2680 * fixed. Fills out rawData_.
2681 * @param {Array.<Object>} data See above.
2682 * @private
2683 */
2684 Dygraph.prototype.parseDataTable_ = function(data) {
2685 var cols = data.getNumberOfColumns();
2686 var rows = data.getNumberOfRows();
2687
2688 var indepType = data.getColumnType(0);
2689 if (indepType == 'date' || indepType == 'datetime') {
2690 this.attrs_.xValueFormatter = Dygraph.dateString_;
2691 this.attrs_.xValueParser = Dygraph.dateParser;
2692 this.attrs_.xTicker = Dygraph.dateTicker;
2693 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
2694 } else if (indepType == 'number') {
2695 this.attrs_.xValueFormatter = function(x) { return x; };
2696 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2697 this.attrs_.xTicker = Dygraph.numericTicks;
2698 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
2699 } else {
2700 this.error("only 'date', 'datetime' and 'number' types are supported for " +
2701 "column 1 of DataTable input (Got '" + indepType + "')");
2702 return null;
2703 }
2704
2705 // Array of the column indices which contain data (and not annotations).
2706 var colIdx = [];
2707 var annotationCols = {}; // data index -> [annotation cols]
2708 var hasAnnotations = false;
2709 for (var i = 1; i < cols; i++) {
2710 var type = data.getColumnType(i);
2711 if (type == 'number') {
2712 colIdx.push(i);
2713 } else if (type == 'string' && this.attr_('displayAnnotations')) {
2714 // This is OK -- it's an annotation column.
2715 var dataIdx = colIdx[colIdx.length - 1];
2716 if (!annotationCols.hasOwnProperty(dataIdx)) {
2717 annotationCols[dataIdx] = [i];
2718 } else {
2719 annotationCols[dataIdx].push(i);
2720 }
2721 hasAnnotations = true;
2722 } else {
2723 this.error("Only 'number' is supported as a dependent type with Gviz." +
2724 " 'string' is only supported if displayAnnotations is true");
2725 }
2726 }
2727
2728 // Read column labels
2729 // TODO(danvk): add support back for errorBars
2730 var labels = [data.getColumnLabel(0)];
2731 for (var i = 0; i < colIdx.length; i++) {
2732 labels.push(data.getColumnLabel(colIdx[i]));
2733 if (this.attr_("errorBars")) i += 1;
2734 }
2735 this.attrs_.labels = labels;
2736 cols = labels.length;
2737
2738 var ret = [];
2739 var outOfOrder = false;
2740 var annotations = [];
2741 for (var i = 0; i < rows; i++) {
2742 var row = [];
2743 if (typeof(data.getValue(i, 0)) === 'undefined' ||
2744 data.getValue(i, 0) === null) {
2745 this.warn("Ignoring row " + i +
2746 " of DataTable because of undefined or null first column.");
2747 continue;
2748 }
2749
2750 if (indepType == 'date' || indepType == 'datetime') {
2751 row.push(data.getValue(i, 0).getTime());
2752 } else {
2753 row.push(data.getValue(i, 0));
2754 }
2755 if (!this.attr_("errorBars")) {
2756 for (var j = 0; j < colIdx.length; j++) {
2757 var col = colIdx[j];
2758 row.push(data.getValue(i, col));
2759 if (hasAnnotations &&
2760 annotationCols.hasOwnProperty(col) &&
2761 data.getValue(i, annotationCols[col][0]) != null) {
2762 var ann = {};
2763 ann.series = data.getColumnLabel(col);
2764 ann.xval = row[0];
2765 ann.shortText = String.fromCharCode(65 /* A */ + annotations.length)
2766 ann.text = '';
2767 for (var k = 0; k < annotationCols[col].length; k++) {
2768 if (k) ann.text += "\n";
2769 ann.text += data.getValue(i, annotationCols[col][k]);
2770 }
2771 annotations.push(ann);
2772 }
2773 }
2774 } else {
2775 for (var j = 0; j < cols - 1; j++) {
2776 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
2777 }
2778 }
2779 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
2780 outOfOrder = true;
2781 }
2782
2783 // Strip out infinities, which give dygraphs problems later on.
2784 for (var j = 0; j < row.length; j++) {
2785 if (!isFinite(row[j])) row[j] = null;
2786 }
2787 ret.push(row);
2788 }
2789
2790 if (outOfOrder) {
2791 this.warn("DataTable is out of order; order it correctly to speed loading.");
2792 ret.sort(function(a,b) { return a[0] - b[0] });
2793 }
2794 this.rawData_ = ret;
2795
2796 if (annotations.length > 0) {
2797 this.setAnnotations(annotations, true);
2798 }
2799 }
2800
2801 // These functions are all based on MochiKit.
2802 Dygraph.update = function (self, o) {
2803 if (typeof(o) != 'undefined' && o !== null) {
2804 for (var k in o) {
2805 if (o.hasOwnProperty(k)) {
2806 self[k] = o[k];
2807 }
2808 }
2809 }
2810 return self;
2811 };
2812
2813 Dygraph.isArrayLike = function (o) {
2814 var typ = typeof(o);
2815 if (
2816 (typ != 'object' && !(typ == 'function' &&
2817 typeof(o.item) == 'function')) ||
2818 o === null ||
2819 typeof(o.length) != 'number' ||
2820 o.nodeType === 3
2821 ) {
2822 return false;
2823 }
2824 return true;
2825 };
2826
2827 Dygraph.isDateLike = function (o) {
2828 if (typeof(o) != "object" || o === null ||
2829 typeof(o.getTime) != 'function') {
2830 return false;
2831 }
2832 return true;
2833 };
2834
2835 Dygraph.clone = function(o) {
2836 // TODO(danvk): figure out how MochiKit's version works
2837 var r = [];
2838 for (var i = 0; i < o.length; i++) {
2839 if (Dygraph.isArrayLike(o[i])) {
2840 r.push(Dygraph.clone(o[i]));
2841 } else {
2842 r.push(o[i]);
2843 }
2844 }
2845 return r;
2846 };
2847
2848
2849 /**
2850 * Get the CSV data. If it's in a function, call that function. If it's in a
2851 * file, do an XMLHttpRequest to get it.
2852 * @private
2853 */
2854 Dygraph.prototype.start_ = function() {
2855 if (typeof this.file_ == 'function') {
2856 // CSV string. Pretend we got it via XHR.
2857 this.loadedEvent_(this.file_());
2858 } else if (Dygraph.isArrayLike(this.file_)) {
2859 this.rawData_ = this.parseArray_(this.file_);
2860 this.predraw_();
2861 } else if (typeof this.file_ == 'object' &&
2862 typeof this.file_.getColumnRange == 'function') {
2863 // must be a DataTable from gviz.
2864 this.parseDataTable_(this.file_);
2865 this.predraw_();
2866 } else if (typeof this.file_ == 'string') {
2867 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
2868 if (this.file_.indexOf('\n') >= 0) {
2869 this.loadedEvent_(this.file_);
2870 } else {
2871 var req = new XMLHttpRequest();
2872 var caller = this;
2873 req.onreadystatechange = function () {
2874 if (req.readyState == 4) {
2875 if (req.status == 200) {
2876 caller.loadedEvent_(req.responseText);
2877 }
2878 }
2879 };
2880
2881 req.open("GET", this.file_, true);
2882 req.send(null);
2883 }
2884 } else {
2885 this.error("Unknown data format: " + (typeof this.file_));
2886 }
2887 };
2888
2889 /**
2890 * Changes various properties of the graph. These can include:
2891 * <ul>
2892 * <li>file: changes the source data for the graph</li>
2893 * <li>errorBars: changes whether the data contains stddev</li>
2894 * </ul>
2895 * @param {Object} attrs The new properties and values
2896 */
2897 Dygraph.prototype.updateOptions = function(attrs) {
2898 // TODO(danvk): this is a mess. Rethink this function.
2899 if ('rollPeriod' in attrs) {
2900 this.rollPeriod_ = attrs.rollPeriod;
2901 }
2902 if ('dateWindow' in attrs) {
2903 this.dateWindow_ = attrs.dateWindow;
2904 }
2905
2906 // TODO(danvk): validate per-series options.
2907 // Supported:
2908 // strokeWidth
2909 // pointSize
2910 // drawPoints
2911 // highlightCircleSize
2912
2913 Dygraph.update(this.user_attrs_, attrs);
2914 Dygraph.update(this.renderOptions_, attrs);
2915
2916 this.labelsFromCSV_ = (this.attr_("labels") == null);
2917
2918 // TODO(danvk): this doesn't match the constructor logic
2919 this.layout_.updateOptions({ 'errorBars': this.attr_("errorBars") });
2920 if (attrs['file']) {
2921 this.file_ = attrs['file'];
2922 this.start_();
2923 } else {
2924 this.predraw_();
2925 }
2926 };
2927
2928 /**
2929 * Resizes the dygraph. If no parameters are specified, resizes to fill the
2930 * containing div (which has presumably changed size since the dygraph was
2931 * instantiated. If the width/height are specified, the div will be resized.
2932 *
2933 * This is far more efficient than destroying and re-instantiating a
2934 * Dygraph, since it doesn't have to reparse the underlying data.
2935 *
2936 * @param {Number} width Width (in pixels)
2937 * @param {Number} height Height (in pixels)
2938 */
2939 Dygraph.prototype.resize = function(width, height) {
2940 if (this.resize_lock) {
2941 return;
2942 }
2943 this.resize_lock = true;
2944
2945 if ((width === null) != (height === null)) {
2946 this.warn("Dygraph.resize() should be called with zero parameters or " +
2947 "two non-NULL parameters. Pretending it was zero.");
2948 width = height = null;
2949 }
2950
2951 // TODO(danvk): there should be a clear() method.
2952 this.maindiv_.innerHTML = "";
2953 this.attrs_.labelsDiv = null;
2954
2955 if (width) {
2956 this.maindiv_.style.width = width + "px";
2957 this.maindiv_.style.height = height + "px";
2958 this.width_ = width;
2959 this.height_ = height;
2960 } else {
2961 this.width_ = this.maindiv_.offsetWidth;
2962 this.height_ = this.maindiv_.offsetHeight;
2963 }
2964
2965 this.createInterface_();
2966 this.predraw_();
2967
2968 this.resize_lock = false;
2969 };
2970
2971 /**
2972 * Adjusts the number of days in the rolling average. Updates the graph to
2973 * reflect the new averaging period.
2974 * @param {Number} length Number of days over which to average the data.
2975 */
2976 Dygraph.prototype.adjustRoll = function(length) {
2977 this.rollPeriod_ = length;
2978 this.predraw_();
2979 };
2980
2981 /**
2982 * Returns a boolean array of visibility statuses.
2983 */
2984 Dygraph.prototype.visibility = function() {
2985 // Do lazy-initialization, so that this happens after we know the number of
2986 // data series.
2987 if (!this.attr_("visibility")) {
2988 this.attrs_["visibility"] = [];
2989 }
2990 while (this.attr_("visibility").length < this.rawData_[0].length - 1) {
2991 this.attr_("visibility").push(true);
2992 }
2993 return this.attr_("visibility");
2994 };
2995
2996 /**
2997 * Changes the visiblity of a series.
2998 */
2999 Dygraph.prototype.setVisibility = function(num, value) {
3000 var x = this.visibility();
3001 if (num < 0 || num >= x.length) {
3002 this.warn("invalid series number in setVisibility: " + num);
3003 } else {
3004 x[num] = value;
3005 this.predraw_();
3006 }
3007 };
3008
3009 /**
3010 * Update the list of annotations and redraw the chart.
3011 */
3012 Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3013 // Only add the annotation CSS rule once we know it will be used.
3014 Dygraph.addAnnotationRule();
3015 this.annotations_ = ann;
3016 this.layout_.setAnnotations(this.annotations_);
3017 if (!suppressDraw) {
3018 this.predraw_();
3019 }
3020 };
3021
3022 /**
3023 * Return the list of annotations.
3024 */
3025 Dygraph.prototype.annotations = function() {
3026 return this.annotations_;
3027 };
3028
3029 /**
3030 * Get the index of a series (column) given its name. The first column is the
3031 * x-axis, so the data series start with index 1.
3032 */
3033 Dygraph.prototype.indexFromSetName = function(name) {
3034 var labels = this.attr_("labels");
3035 for (var i = 0; i < labels.length; i++) {
3036 if (labels[i] == name) return i;
3037 }
3038 return null;
3039 };
3040
3041 Dygraph.addAnnotationRule = function() {
3042 if (Dygraph.addedAnnotationCSS) return;
3043
3044 var rule = "border: 1px solid black; " +
3045 "background-color: white; " +
3046 "text-align: center;";
3047
3048 var styleSheetElement = document.createElement("style");
3049 styleSheetElement.type = "text/css";
3050 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3051
3052 // Find the first style sheet that we can access.
3053 // We may not add a rule to a style sheet from another domain for security
3054 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3055 // adds its own style sheets from google.com.
3056 for (var i = 0; i < document.styleSheets.length; i++) {
3057 if (document.styleSheets[i].disabled) continue;
3058 var mysheet = document.styleSheets[i];
3059 try {
3060 if (mysheet.insertRule) { // Firefox
3061 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3062 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3063 } else if (mysheet.addRule) { // IE
3064 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3065 }
3066 Dygraph.addedAnnotationCSS = true;
3067 return;
3068 } catch(err) {
3069 // Was likely a security exception.
3070 }
3071 }
3072
3073 this.warn("Unable to add default annotation CSS rule; display may be off.");
3074 }
3075
3076 /**
3077 * Create a new canvas element. This is more complex than a simple
3078 * document.createElement("canvas") because of IE and excanvas.
3079 */
3080 Dygraph.createCanvas = function() {
3081 var canvas = document.createElement("canvas");
3082
3083 isIE = (/MSIE/.test(navigator.userAgent) && !window.opera);
3084 if (isIE && (typeof(G_vmlCanvasManager) != 'undefined')) {
3085 canvas = G_vmlCanvasManager.initElement(canvas);
3086 }
3087
3088 return canvas;
3089 };
3090
3091
3092 /**
3093 * A wrapper around Dygraph that implements the gviz API.
3094 * @param {Object} container The DOM object the visualization should live in.
3095 */
3096 Dygraph.GVizChart = function(container) {
3097 this.container = container;
3098 }
3099
3100 Dygraph.GVizChart.prototype.draw = function(data, options) {
3101 // Clear out any existing dygraph.
3102 // TODO(danvk): would it make more sense to simply redraw using the current
3103 // date_graph object?
3104 this.container.innerHTML = '';
3105 if (typeof(this.date_graph) != 'undefined') {
3106 this.date_graph.destroy();
3107 }
3108
3109 this.date_graph = new Dygraph(this.container, data, options);
3110 }
3111
3112 /**
3113 * Google charts compatible setSelection
3114 * Only row selection is supported, all points in the row will be highlighted
3115 * @param {Array} array of the selected cells
3116 * @public
3117 */
3118 Dygraph.GVizChart.prototype.setSelection = function(selection_array) {
3119 var row = false;
3120 if (selection_array.length) {
3121 row = selection_array[0].row;
3122 }
3123 this.date_graph.setSelection(row);
3124 }
3125
3126 /**
3127 * Google charts compatible getSelection implementation
3128 * @return {Array} array of the selected cells
3129 * @public
3130 */
3131 Dygraph.GVizChart.prototype.getSelection = function() {
3132 var selection = [];
3133
3134 var row = this.date_graph.getSelection();
3135
3136 if (row < 0) return selection;
3137
3138 col = 1;
3139 for (var i in this.date_graph.layout_.datasets) {
3140 selection.push({row: row, column: col});
3141 col++;
3142 }
3143
3144 return selection;
3145 }
3146
3147 // Older pages may still use this name.
3148 DateGraph = Dygraph;