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