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