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