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