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