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