some gadget options
[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
584ceeaa
DV
614 var isOK = function(x) { return x && !isNaN(x); };
615
6a1aa64f
DV
616 if (selPoints.length > 0) {
617 var canvasx = selPoints[0].canvasx;
618
619 // Set the status message to indicate the selected point(s)
285a6bda 620 var replace = this.attr_('xValueFormatter')(lastx, this) + ":";
6a1aa64f
DV
621 var clen = this.colors_.length;
622 for (var i = 0; i < selPoints.length; i++) {
584ceeaa 623 if (!isOK(selPoints[i].canvasy)) continue;
285a6bda 624 if (this.attr_("labelsSeparateLines")) {
6a1aa64f
DV
625 replace += "<br/>";
626 }
627 var point = selPoints[i];
628 replace += " <b><font color='" + this.colors_[i%clen].toHexString() + "'>"
629 + point.name + "</font></b>:"
630 + this.round_(point.yval, 2);
631 }
285a6bda 632 this.attr_("labelsDiv").innerHTML = replace;
6a1aa64f
DV
633
634 // Save last x position for callbacks.
635 this.lastx_ = lastx;
636
637 // Draw colored circles over the center of each selected point
638 ctx.save()
639 for (var i = 0; i < selPoints.length; i++) {
584ceeaa 640 if (!isOK(selPoints[i%clen].canvasy)) continue;
6a1aa64f
DV
641 ctx.beginPath();
642 ctx.fillStyle = this.colors_[i%clen].toRGBString();
643 ctx.arc(canvasx, selPoints[i%clen].canvasy, circleSize, 0, 360, false);
644 ctx.fill();
645 }
646 ctx.restore();
647
648 this.previousVerticalX_ = canvasx;
649 }
650};
651
652/**
653 * The mouse has left the canvas. Clear out whatever artifacts remain
654 * @param {Object} event the mouseout event from the browser.
655 * @private
656 */
285a6bda 657Dygraph.prototype.mouseOut_ = function(event) {
6a1aa64f
DV
658 // Get rid of the overlay data
659 var ctx = this.canvas_.getContext("2d");
660 ctx.clearRect(0, 0, this.width_, this.height_);
285a6bda 661 this.attr_("labelsDiv").innerHTML = "";
6a1aa64f
DV
662};
663
285a6bda 664Dygraph.zeropad = function(x) {
32988383
DV
665 if (x < 10) return "0" + x; else return "" + x;
666}
667
6a1aa64f 668/**
6b8e33dd
DV
669 * Return a string version of the hours, minutes and seconds portion of a date.
670 * @param {Number} date The JavaScript date (ms since epoch)
671 * @return {String} A time of the form "HH:MM:SS"
672 * @private
673 */
285a6bda
DV
674Dygraph.prototype.hmsString_ = function(date) {
675 var zeropad = Dygraph.zeropad;
6b8e33dd
DV
676 var d = new Date(date);
677 if (d.getSeconds()) {
678 return zeropad(d.getHours()) + ":" +
679 zeropad(d.getMinutes()) + ":" +
680 zeropad(d.getSeconds());
681 } else if (d.getMinutes()) {
682 return zeropad(d.getHours()) + ":" + zeropad(d.getMinutes());
683 } else {
684 return zeropad(d.getHours());
685 }
686}
687
688/**
6a1aa64f
DV
689 * Convert a JS date (millis since epoch) to YYYY/MM/DD
690 * @param {Number} date The JavaScript date (ms since epoch)
691 * @return {String} A date of the form "YYYY/MM/DD"
692 * @private
285a6bda 693 * TODO(danvk): why is this part of the prototype?
6a1aa64f 694 */
285a6bda
DV
695Dygraph.dateString_ = function(date, self) {
696 var zeropad = Dygraph.zeropad;
6a1aa64f
DV
697 var d = new Date(date);
698
699 // Get the year:
700 var year = "" + d.getFullYear();
701 // Get a 0 padded month string
6b8e33dd 702 var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh
6a1aa64f 703 // Get a 0 padded day string
6b8e33dd 704 var day = zeropad(d.getDate());
6a1aa64f 705
6b8e33dd
DV
706 var ret = "";
707 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
285a6bda 708 if (frac) ret = " " + self.hmsString_(date);
6b8e33dd
DV
709
710 return year + "/" + month + "/" + day + ret;
6a1aa64f
DV
711};
712
713/**
714 * Round a number to the specified number of digits past the decimal point.
715 * @param {Number} num The number to round
716 * @param {Number} places The number of decimals to which to round
717 * @return {Number} The rounded number
718 * @private
719 */
285a6bda 720Dygraph.prototype.round_ = function(num, places) {
6a1aa64f
DV
721 var shift = Math.pow(10, places);
722 return Math.round(num * shift)/shift;
723};
724
725/**
726 * Fires when there's data available to be graphed.
727 * @param {String} data Raw CSV data to be plotted
728 * @private
729 */
285a6bda 730Dygraph.prototype.loadedEvent_ = function(data) {
6a1aa64f
DV
731 this.rawData_ = this.parseCSV_(data);
732 this.drawGraph_(this.rawData_);
733};
734
285a6bda 735Dygraph.prototype.months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
8846615a 736 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
285a6bda 737Dygraph.prototype.quarters = ["Jan", "Apr", "Jul", "Oct"];
6a1aa64f
DV
738
739/**
740 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
741 * @private
742 */
285a6bda 743Dygraph.prototype.addXTicks_ = function() {
6a1aa64f
DV
744 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
745 var startDate, endDate;
746 if (this.dateWindow_) {
747 startDate = this.dateWindow_[0];
748 endDate = this.dateWindow_[1];
749 } else {
750 startDate = this.rawData_[0][0];
751 endDate = this.rawData_[this.rawData_.length - 1][0];
752 }
753
285a6bda 754 var xTicks = this.attr_('xTicker')(startDate, endDate, this);
6a1aa64f 755 this.layout_.updateOptions({xTicks: xTicks});
32988383
DV
756};
757
758// Time granularity enumeration
285a6bda
DV
759Dygraph.SECONDLY = 0;
760Dygraph.TEN_SECONDLY = 1;
761Dygraph.THIRTY_SECONDLY = 2;
762Dygraph.MINUTELY = 3;
763Dygraph.TEN_MINUTELY = 4;
764Dygraph.THIRTY_MINUTELY = 5;
765Dygraph.HOURLY = 6;
766Dygraph.SIX_HOURLY = 7;
767Dygraph.DAILY = 8;
768Dygraph.WEEKLY = 9;
769Dygraph.MONTHLY = 10;
770Dygraph.QUARTERLY = 11;
771Dygraph.BIANNUAL = 12;
772Dygraph.ANNUAL = 13;
773Dygraph.DECADAL = 14;
774Dygraph.NUM_GRANULARITIES = 15;
775
776Dygraph.SHORT_SPACINGS = [];
777Dygraph.SHORT_SPACINGS[Dygraph.SECONDLY] = 1000 * 1;
778Dygraph.SHORT_SPACINGS[Dygraph.TEN_SECONDLY] = 1000 * 10;
779Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_SECONDLY] = 1000 * 30;
780Dygraph.SHORT_SPACINGS[Dygraph.MINUTELY] = 1000 * 60;
781Dygraph.SHORT_SPACINGS[Dygraph.TEN_MINUTELY] = 1000 * 60 * 10;
782Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_MINUTELY] = 1000 * 60 * 30;
783Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600;
784Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600 * 6;
785Dygraph.SHORT_SPACINGS[Dygraph.DAILY] = 1000 * 86400;
786Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY] = 1000 * 604800;
32988383
DV
787
788// NumXTicks()
789//
790// If we used this time granularity, how many ticks would there be?
791// This is only an approximation, but it's generally good enough.
792//
285a6bda
DV
793Dygraph.prototype.NumXTicks = function(start_time, end_time, granularity) {
794 if (granularity < Dygraph.MONTHLY) {
32988383 795 // Generate one tick mark for every fixed interval of time.
285a6bda 796 var spacing = Dygraph.SHORT_SPACINGS[granularity];
32988383
DV
797 return Math.floor(0.5 + 1.0 * (end_time - start_time) / spacing);
798 } else {
799 var year_mod = 1; // e.g. to only print one point every 10 years.
800 var num_months = 12;
285a6bda
DV
801 if (granularity == Dygraph.QUARTERLY) num_months = 3;
802 if (granularity == Dygraph.BIANNUAL) num_months = 2;
803 if (granularity == Dygraph.ANNUAL) num_months = 1;
804 if (granularity == Dygraph.DECADAL) { num_months = 1; year_mod = 10; }
32988383
DV
805
806 var msInYear = 365.2524 * 24 * 3600 * 1000;
807 var num_years = 1.0 * (end_time - start_time) / msInYear;
808 return Math.floor(0.5 + 1.0 * num_years * num_months / year_mod);
809 }
810};
811
812// GetXAxis()
813//
814// Construct an x-axis of nicely-formatted times on meaningful boundaries
815// (e.g. 'Jan 09' rather than 'Jan 22, 2009').
816//
817// Returns an array containing {v: millis, label: label} dictionaries.
818//
285a6bda 819Dygraph.prototype.GetXAxis = function(start_time, end_time, granularity) {
32988383 820 var ticks = [];
285a6bda 821 if (granularity < Dygraph.MONTHLY) {
32988383 822 // Generate one tick mark for every fixed interval of time.
285a6bda 823 var spacing = Dygraph.SHORT_SPACINGS[granularity];
32988383 824 var format = '%d%b'; // e.g. "1 Jan"
328bb812 825 // TODO(danvk): be smarter about making sure this really hits a "nice" time.
285a6bda 826 if (granularity < Dygraph.HOURLY) {
328bb812
DV
827 start_time = spacing * Math.floor(0.5 + start_time / spacing);
828 }
32988383
DV
829 for (var t = start_time; t <= end_time; t += spacing) {
830 var d = new Date(t);
831 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
285a6bda 832 if (frac == 0 || granularity >= Dygraph.DAILY) {
32988383
DV
833 // the extra hour covers DST problems.
834 ticks.push({ v:t, label: new Date(t + 3600*1000).strftime(format) });
835 } else {
836 ticks.push({ v:t, label: this.hmsString_(t) });
837 }
838 }
839 } else {
840 // Display a tick mark on the first of a set of months of each year.
841 // Years get a tick mark iff y % year_mod == 0. This is useful for
842 // displaying a tick mark once every 10 years, say, on long time scales.
843 var months;
844 var year_mod = 1; // e.g. to only print one point every 10 years.
845
285a6bda 846 if (granularity == Dygraph.MONTHLY) {
32988383 847 months = [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
285a6bda 848 } else if (granularity == Dygraph.QUARTERLY) {
32988383 849 months = [ 0, 3, 6, 9 ];
285a6bda 850 } else if (granularity == Dygraph.BIANNUAL) {
32988383 851 months = [ 0, 6 ];
285a6bda 852 } else if (granularity == Dygraph.ANNUAL) {
32988383 853 months = [ 0 ];
285a6bda 854 } else if (granularity == Dygraph.DECADAL) {
32988383
DV
855 months = [ 0 ];
856 year_mod = 10;
857 }
858
859 var start_year = new Date(start_time).getFullYear();
860 var end_year = new Date(end_time).getFullYear();
285a6bda 861 var zeropad = Dygraph.zeropad;
32988383
DV
862 for (var i = start_year; i <= end_year; i++) {
863 if (i % year_mod != 0) continue;
864 for (var j = 0; j < months.length; j++) {
865 var date_str = i + "/" + zeropad(1 + months[j]) + "/01";
866 var t = Date.parse(date_str);
867 if (t < start_time || t > end_time) continue;
868 ticks.push({ v:t, label: new Date(t).strftime('%b %y') });
869 }
870 }
871 }
872
873 return ticks;
874};
875
6a1aa64f
DV
876
877/**
878 * Add ticks to the x-axis based on a date range.
879 * @param {Number} startDate Start of the date window (millis since epoch)
880 * @param {Number} endDate End of the date window (millis since epoch)
881 * @return {Array.<Object>} Array of {label, value} tuples.
882 * @public
883 */
285a6bda 884Dygraph.dateTicker = function(startDate, endDate, self) {
32988383 885 var chosen = -1;
285a6bda
DV
886 for (var i = 0; i < Dygraph.NUM_GRANULARITIES; i++) {
887 var num_ticks = self.NumXTicks(startDate, endDate, i);
888 if (self.width_ / num_ticks >= self.attr_('pixelsPerXLabel')) {
32988383
DV
889 chosen = i;
890 break;
2769de62 891 }
6a1aa64f
DV
892 }
893
32988383 894 if (chosen >= 0) {
285a6bda 895 return self.GetXAxis(startDate, endDate, chosen);
6a1aa64f 896 } else {
32988383 897 // TODO(danvk): signal error.
6a1aa64f 898 }
6a1aa64f
DV
899};
900
901/**
902 * Add ticks when the x axis has numbers on it (instead of dates)
903 * @param {Number} startDate Start of the date window (millis since epoch)
904 * @param {Number} endDate End of the date window (millis since epoch)
905 * @return {Array.<Object>} Array of {label, value} tuples.
906 * @public
907 */
285a6bda 908Dygraph.numericTicks = function(minV, maxV, self) {
c6336f04
DV
909 // Basic idea:
910 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
911 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks).
285a6bda 912 // The first spacing greater than pixelsPerYLabel is what we use.
c6336f04
DV
913 var mults = [1, 2, 5];
914 var scale, low_val, high_val, nTicks;
285a6bda
DV
915 // TODO(danvk): make it possible to set this for x- and y-axes independently.
916 var pixelsPerTick = self.attr_('pixelsPerYLabel');
c6336f04
DV
917 for (var i = -10; i < 50; i++) {
918 var base_scale = Math.pow(10, i);
919 for (var j = 0; j < mults.length; j++) {
920 scale = base_scale * mults[j];
c6336f04
DV
921 low_val = Math.floor(minV / scale) * scale;
922 high_val = Math.ceil(maxV / scale) * scale;
923 nTicks = (high_val - low_val) / scale;
285a6bda 924 var spacing = self.height_ / nTicks;
c6336f04 925 // wish I could break out of both loops at once...
285a6bda 926 if (spacing > pixelsPerTick) break;
c6336f04 927 }
285a6bda 928 if (spacing > pixelsPerTick) break;
6a1aa64f
DV
929 }
930
931 // Construct labels for the ticks
932 var ticks = [];
c6336f04
DV
933 for (var i = 0; i < nTicks; i++) {
934 var tickV = low_val + i * scale;
285a6bda
DV
935 var label = self.round_(tickV, 2);
936 if (self.attr_("labelsKMB")) {
6a1aa64f
DV
937 var k = 1000;
938 if (tickV >= k*k*k) {
285a6bda 939 label = self.round_(tickV/(k*k*k), 1) + "B";
6a1aa64f 940 } else if (tickV >= k*k) {
285a6bda 941 label = self.round_(tickV/(k*k), 1) + "M";
6a1aa64f 942 } else if (tickV >= k) {
285a6bda 943 label = self.round_(tickV/k, 1) + "K";
6a1aa64f
DV
944 }
945 }
946 ticks.push( {label: label, v: tickV} );
947 }
948 return ticks;
949};
950
951/**
952 * Adds appropriate ticks on the y-axis
953 * @param {Number} minY The minimum Y value in the data set
954 * @param {Number} maxY The maximum Y value in the data set
955 * @private
956 */
285a6bda 957Dygraph.prototype.addYTicks_ = function(minY, maxY) {
6a1aa64f 958 // Set the number of ticks so that the labels are human-friendly.
285a6bda
DV
959 // TODO(danvk): make this an attribute as well.
960 var ticks = Dygraph.numericTicks(minY, maxY, this);
6a1aa64f
DV
961 this.layout_.updateOptions( { yAxis: [minY, maxY],
962 yTicks: ticks } );
963};
964
5011e7a1
DV
965// Computes the range of the data series (including confidence intervals).
966// series is either [ [x1, y1], [x2, y2], ... ] or
967// [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
968// Returns [low, high]
969Dygraph.prototype.extremeValues_ = function(series) {
970 var minY = null, maxY = null;
971
972 var bars = this.attr_("errorBars") || this.customBars_;
973 if (bars) {
974 // With custom bars, maxY is the max of the high values.
975 for (var j = 0; j < series.length; j++) {
976 var y = series[j][1][0];
977 if (!y) continue;
978 var low = y - series[j][1][1];
979 var high = y + series[j][1][2];
980 if (low > y) low = y; // this can happen with custom bars,
981 if (high < y) high = y; // e.g. in tests/custom-bars.html
982 if (maxY == null || high > maxY) {
983 maxY = high;
984 }
985 if (minY == null || low < minY) {
986 minY = low;
987 }
988 }
989 } else {
990 for (var j = 0; j < series.length; j++) {
991 var y = series[j][1];
992 if (!y) continue;
993 if (maxY == null || y > maxY) {
994 maxY = y;
995 }
996 if (minY == null || y < minY) {
997 minY = y;
998 }
999 }
1000 }
1001
1002 return [minY, maxY];
1003};
1004
6a1aa64f
DV
1005/**
1006 * Update the graph with new data. Data is in the format
1007 * [ [date1, val1, val2, ...], [date2, val1, val2, ...] if errorBars=false
1008 * or, if errorBars=true,
1009 * [ [date1, [val1,stddev1], [val2,stddev2], ...], [date2, ...], ...]
1010 * @param {Array.<Object>} data The data (see above)
1011 * @private
1012 */
285a6bda 1013Dygraph.prototype.drawGraph_ = function(data) {
3bd9c228 1014 var minY = null, maxY = null;
6a1aa64f 1015 this.layout_.removeAllDatasets();
285a6bda
DV
1016 this.setColors_();
1017
6a1aa64f
DV
1018 // Loop over all fields in the dataset
1019 for (var i = 1; i < data[0].length; i++) {
1020 var series = [];
1021 for (var j = 0; j < data.length; j++) {
1022 var date = data[j][0];
1023 series[j] = [date, data[j][i]];
1024 }
1025 series = this.rollingAverage(series, this.rollPeriod_);
1026
1027 // Prune down to the desired range, if necessary (for zooming)
285a6bda 1028 var bars = this.attr_("errorBars") || this.customBars_;
6a1aa64f
DV
1029 if (this.dateWindow_) {
1030 var low = this.dateWindow_[0];
1031 var high= this.dateWindow_[1];
1032 var pruned = [];
1033 for (var k = 0; k < series.length; k++) {
1034 if (series[k][0] >= low && series[k][0] <= high) {
1035 pruned.push(series[k]);
6a1aa64f
DV
1036 }
1037 }
1038 series = pruned;
6a1aa64f
DV
1039 }
1040
648acd28
DV
1041 var extremes = this.extremeValues_(series);
1042 var thisMinY = extremes[0];
1043 var thisMaxY = extremes[1];
5011e7a1
DV
1044 if (!minY || thisMinY < minY) minY = thisMinY;
1045 if (!maxY || thisMaxY > maxY) maxY = thisMaxY;
1046
6a1aa64f
DV
1047 if (bars) {
1048 var vals = [];
1049 for (var j=0; j<series.length; j++)
1050 vals[j] = [series[j][0],
1051 series[j][1][0], series[j][1][1], series[j][1][2]];
285a6bda 1052 this.layout_.addDataset(this.attr_("labels")[i], vals);
6a1aa64f 1053 } else {
285a6bda 1054 this.layout_.addDataset(this.attr_("labels")[i], series);
6a1aa64f
DV
1055 }
1056 }
1057
1058 // Use some heuristics to come up with a good maxY value, unless it's been
1059 // set explicitly by the user.
1060 if (this.valueRange_ != null) {
1061 this.addYTicks_(this.valueRange_[0], this.valueRange_[1]);
1062 } else {
1063 // Add some padding and round up to an integer to be human-friendly.
3bd9c228
DV
1064 var span = maxY - minY;
1065 var maxAxisY = maxY + 0.1 * span;
1066 var minAxisY = minY - 0.1 * span;
1067
1068 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
ceb009dd
DV
1069 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
1070 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
3bd9c228
DV
1071
1072 if (this.attr_("includeZero")) {
1073 if (maxY < 0) maxAxisY = 0;
1074 if (minY > 0) minAxisY = 0;
1075 }
1076
1077 this.addYTicks_(minAxisY, maxAxisY);
6a1aa64f
DV
1078 }
1079
1080 this.addXTicks_();
1081
1082 // Tell PlotKit to use this new data and render itself
1083 this.layout_.evaluateWithError();
1084 this.plotter_.clear();
1085 this.plotter_.render();
1086 this.canvas_.getContext('2d').clearRect(0, 0,
1087 this.canvas_.width, this.canvas_.height);
1088};
1089
1090/**
1091 * Calculates the rolling average of a data set.
1092 * If originalData is [label, val], rolls the average of those.
1093 * If originalData is [label, [, it's interpreted as [value, stddev]
1094 * and the roll is returned in the same form, with appropriately reduced
1095 * stddev for each value.
1096 * Note that this is where fractional input (i.e. '5/10') is converted into
1097 * decimal values.
1098 * @param {Array} originalData The data in the appropriate format (see above)
1099 * @param {Number} rollPeriod The number of days over which to average the data
1100 */
285a6bda 1101Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
6a1aa64f
DV
1102 if (originalData.length < 2)
1103 return originalData;
1104 var rollPeriod = Math.min(rollPeriod, originalData.length - 1);
1105 var rollingData = [];
285a6bda 1106 var sigma = this.attr_("sigma");
6a1aa64f
DV
1107
1108 if (this.fractions_) {
1109 var num = 0;
1110 var den = 0; // numerator/denominator
1111 var mult = 100.0;
1112 for (var i = 0; i < originalData.length; i++) {
1113 num += originalData[i][1][0];
1114 den += originalData[i][1][1];
1115 if (i - rollPeriod >= 0) {
1116 num -= originalData[i - rollPeriod][1][0];
1117 den -= originalData[i - rollPeriod][1][1];
1118 }
1119
1120 var date = originalData[i][0];
1121 var value = den ? num / den : 0.0;
285a6bda 1122 if (this.attr_("errorBars")) {
6a1aa64f
DV
1123 if (this.wilsonInterval_) {
1124 // For more details on this confidence interval, see:
1125 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
1126 if (den) {
1127 var p = value < 0 ? 0 : value, n = den;
1128 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
1129 var denom = 1 + sigma * sigma / den;
1130 var low = (p + sigma * sigma / (2 * den) - pm) / denom;
1131 var high = (p + sigma * sigma / (2 * den) + pm) / denom;
1132 rollingData[i] = [date,
1133 [p * mult, (p - low) * mult, (high - p) * mult]];
1134 } else {
1135 rollingData[i] = [date, [0, 0, 0]];
1136 }
1137 } else {
1138 var stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
1139 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
1140 }
1141 } else {
1142 rollingData[i] = [date, mult * value];
1143 }
1144 }
1145 } else if (this.customBars_) {
f6885d6a
DV
1146 var low = 0;
1147 var mid = 0;
1148 var high = 0;
1149 var count = 0;
6a1aa64f
DV
1150 for (var i = 0; i < originalData.length; i++) {
1151 var data = originalData[i][1];
1152 var y = data[1];
1153 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
f6885d6a
DV
1154
1155 low += data[0];
1156 mid += y;
1157 high += data[2];
1158 count += 1;
1159 if (i - rollPeriod >= 0) {
1160 var prev = originalData[i - rollPeriod];
1161 low -= prev[1][0];
1162 mid -= prev[1][1];
1163 high -= prev[1][2];
1164 count -= 1;
1165 }
1166 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
1167 1.0 * (mid - low) / count,
1168 1.0 * (high - mid) / count ]];
2769de62 1169 }
6a1aa64f
DV
1170 } else {
1171 // Calculate the rolling average for the first rollPeriod - 1 points where
1172 // there is not enough data to roll over the full number of days
1173 var num_init_points = Math.min(rollPeriod - 1, originalData.length - 2);
285a6bda 1174 if (!this.attr_("errorBars")){
5011e7a1
DV
1175 if (rollPeriod == 1) {
1176 return originalData;
1177 }
1178
6a1aa64f
DV
1179 for (var i = 0; i < num_init_points; i++) {
1180 var sum = 0;
1181 for (var j = 0; j < i + 1; j++)
1182 sum += originalData[j][1];
1183 rollingData[i] = [originalData[i][0], sum / (i + 1)];
1184 }
1185 // Calculate the rolling average for the remaining points
1186 for (var i = Math.min(rollPeriod - 1, originalData.length - 2);
1187 i < originalData.length;
1188 i++) {
1189 var sum = 0;
1190 for (var j = i - rollPeriod + 1; j < i + 1; j++)
1191 sum += originalData[j][1];
1192 rollingData[i] = [originalData[i][0], sum / rollPeriod];
1193 }
1194 } else {
1195 for (var i = 0; i < num_init_points; i++) {
1196 var sum = 0;
1197 var variance = 0;
5011e7a1 1198 var num_ok = 0;
6a1aa64f 1199 for (var j = 0; j < i + 1; j++) {
5011e7a1
DV
1200 var y = originalData[j][1][0];
1201 if (!y || isNaN(y)) continue;
1202 num_ok++;
1203 sum += y;
6a1aa64f
DV
1204 variance += Math.pow(originalData[j][1][1], 2);
1205 }
5011e7a1
DV
1206 if (num_ok) {
1207 var stddev = Math.sqrt(variance)/num_ok;
1208 rollingData[i] = [originalData[i][0],
1209 [sum/num_ok, sigma * stddev, sigma * stddev]];
1210 } else {
1211 rollingData[i] = [originalData[i][0], [null, null, null]];
1212 }
6a1aa64f
DV
1213 }
1214 // Calculate the rolling average for the remaining points
1215 for (var i = Math.min(rollPeriod - 1, originalData.length - 2);
1216 i < originalData.length;
1217 i++) {
1218 var sum = 0;
1219 var variance = 0;
5011e7a1 1220 var num_ok = 0;
6a1aa64f 1221 for (var j = i - rollPeriod + 1; j < i + 1; j++) {
5011e7a1
DV
1222 var y = originalData[j][1][0];
1223 if (!y || isNaN(y)) continue;
1224 num_ok++;
6a1aa64f
DV
1225 sum += originalData[j][1][0];
1226 variance += Math.pow(originalData[j][1][1], 2);
1227 }
5011e7a1
DV
1228 if (num_ok) {
1229 var stddev = Math.sqrt(variance) / num_ok;
1230 rollingData[i] = [originalData[i][0],
1231 [sum / num_ok, sigma * stddev, sigma * stddev]];
1232 } else {
1233 rollingData[i] = [originalData[i][0], [null, null, null]];
1234 }
6a1aa64f
DV
1235 }
1236 }
1237 }
1238
1239 return rollingData;
1240};
1241
1242/**
1243 * Parses a date, returning the number of milliseconds since epoch. This can be
285a6bda
DV
1244 * passed in as an xValueParser in the Dygraph constructor.
1245 * TODO(danvk): enumerate formats that this understands.
6a1aa64f
DV
1246 * @param {String} A date in YYYYMMDD format.
1247 * @return {Number} Milliseconds since epoch.
1248 * @public
1249 */
285a6bda 1250Dygraph.dateParser = function(dateStr, self) {
6a1aa64f 1251 var dateStrSlashed;
285a6bda 1252 var d;
2769de62 1253 if (dateStr.length == 10 && dateStr.search("-") != -1) { // e.g. '2009-07-12'
6a1aa64f 1254 dateStrSlashed = dateStr.replace("-", "/", "g");
353a0294
DV
1255 while (dateStrSlashed.search("-") != -1) {
1256 dateStrSlashed = dateStrSlashed.replace("-", "/");
1257 }
285a6bda 1258 d = Date.parse(dateStrSlashed);
2769de62 1259 } else if (dateStr.length == 8) { // e.g. '20090712'
285a6bda 1260 // TODO(danvk): remove support for this format. It's confusing.
6a1aa64f
DV
1261 dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2)
1262 + "/" + dateStr.substr(6,2);
285a6bda 1263 d = Date.parse(dateStrSlashed);
2769de62
DV
1264 } else {
1265 // Any format that Date.parse will accept, e.g. "2009/07/12" or
1266 // "2009/07/12 12:34:56"
285a6bda
DV
1267 d = Date.parse(dateStr);
1268 }
1269
1270 if (!d || isNaN(d)) {
1271 self.error("Couldn't parse " + dateStr + " as a date");
1272 }
1273 return d;
1274};
1275
1276/**
1277 * Detects the type of the str (date or numeric) and sets the various
1278 * formatting attributes in this.attrs_ based on this type.
1279 * @param {String} str An x value.
1280 * @private
1281 */
1282Dygraph.prototype.detectTypeFromString_ = function(str) {
1283 var isDate = false;
1284 if (str.indexOf('-') >= 0 ||
1285 str.indexOf('/') >= 0 ||
1286 isNaN(parseFloat(str))) {
1287 isDate = true;
1288 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
1289 // TODO(danvk): remove support for this format.
1290 isDate = true;
1291 }
1292
1293 if (isDate) {
1294 this.attrs_.xValueFormatter = Dygraph.dateString_;
1295 this.attrs_.xValueParser = Dygraph.dateParser;
1296 this.attrs_.xTicker = Dygraph.dateTicker;
1297 } else {
1298 this.attrs_.xValueFormatter = function(x) { return x; };
1299 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
1300 this.attrs_.xTicker = Dygraph.numericTicks;
6a1aa64f 1301 }
6a1aa64f
DV
1302};
1303
1304/**
1305 * Parses a string in a special csv format. We expect a csv file where each
1306 * line is a date point, and the first field in each line is the date string.
1307 * We also expect that all remaining fields represent series.
285a6bda 1308 * if the errorBars attribute is set, then interpret the fields as:
6a1aa64f
DV
1309 * date, series1, stddev1, series2, stddev2, ...
1310 * @param {Array.<Object>} data See above.
1311 * @private
285a6bda
DV
1312 *
1313 * @return Array.<Object> An array with one entry for each row. These entries
1314 * are an array of cells in that row. The first entry is the parsed x-value for
1315 * the row. The second, third, etc. are the y-values. These can take on one of
1316 * three forms, depending on the CSV and constructor parameters:
1317 * 1. numeric value
1318 * 2. [ value, stddev ]
1319 * 3. [ low value, center value, high value ]
6a1aa64f 1320 */
285a6bda 1321Dygraph.prototype.parseCSV_ = function(data) {
6a1aa64f
DV
1322 var ret = [];
1323 var lines = data.split("\n");
285a6bda 1324 var start = 0;
6a1aa64f 1325 if (this.labelsFromCSV_) {
285a6bda
DV
1326 start = 1;
1327 this.attrs_.labels = lines[0].split(",");
6a1aa64f
DV
1328 }
1329
285a6bda
DV
1330 var xParser;
1331 var defaultParserSet = false; // attempt to auto-detect x value type
1332 var expectedCols = this.attr_("labels").length;
6a1aa64f
DV
1333 for (var i = start; i < lines.length; i++) {
1334 var line = lines[i];
1335 if (line.length == 0) continue; // skip blank lines
1336 var inFields = line.split(',');
285a6bda 1337 if (inFields.length < 2) continue;
6a1aa64f
DV
1338
1339 var fields = [];
285a6bda
DV
1340 if (!defaultParserSet) {
1341 this.detectTypeFromString_(inFields[0]);
1342 xParser = this.attr_("xValueParser");
1343 defaultParserSet = true;
1344 }
1345 fields[0] = xParser(inFields[0], this);
6a1aa64f
DV
1346
1347 // If fractions are expected, parse the numbers as "A/B"
1348 if (this.fractions_) {
1349 for (var j = 1; j < inFields.length; j++) {
1350 // TODO(danvk): figure out an appropriate way to flag parse errors.
1351 var vals = inFields[j].split("/");
1352 fields[j] = [parseFloat(vals[0]), parseFloat(vals[1])];
1353 }
285a6bda 1354 } else if (this.attr_("errorBars")) {
6a1aa64f
DV
1355 // If there are error bars, values are (value, stddev) pairs
1356 for (var j = 1; j < inFields.length; j += 2)
1357 fields[(j + 1) / 2] = [parseFloat(inFields[j]),
1358 parseFloat(inFields[j + 1])];
1359 } else if (this.customBars_) {
1360 // Bars are a low;center;high tuple
1361 for (var j = 1; j < inFields.length; j++) {
1362 var vals = inFields[j].split(";");
1363 fields[j] = [ parseFloat(vals[0]),
1364 parseFloat(vals[1]),
1365 parseFloat(vals[2]) ];
1366 }
1367 } else {
1368 // Values are just numbers
285a6bda 1369 for (var j = 1; j < inFields.length; j++) {
6a1aa64f 1370 fields[j] = parseFloat(inFields[j]);
285a6bda 1371 }
6a1aa64f
DV
1372 }
1373 ret.push(fields);
285a6bda
DV
1374
1375 if (fields.length != expectedCols) {
1376 this.error("Number of columns in line " + i + " (" + fields.length +
1377 ") does not agree with number of labels (" + expectedCols +
1378 ") " + line);
1379 }
6a1aa64f
DV
1380 }
1381 return ret;
1382};
1383
1384/**
285a6bda
DV
1385 * The user has provided their data as a pre-packaged JS array. If the x values
1386 * are numeric, this is the same as dygraphs' internal format. If the x values
1387 * are dates, we need to convert them from Date objects to ms since epoch.
1388 * @param {Array.<Object>} data
1389 * @return {Array.<Object>} data with numeric x values.
1390 */
1391Dygraph.prototype.parseArray_ = function(data) {
1392 // Peek at the first x value to see if it's numeric.
1393 if (data.length == 0) {
1394 this.error("Can't plot empty data set");
1395 return null;
1396 }
1397 if (data[0].length == 0) {
1398 this.error("Data set cannot contain an empty row");
1399 return null;
1400 }
1401
1402 if (this.attr_("labels") == null) {
1403 this.warn("Using default labels. Set labels explicitly via 'labels' " +
1404 "in the options parameter");
1405 this.attrs_.labels = [ "X" ];
1406 for (var i = 1; i < data[0].length; i++) {
1407 this.attrs_.labels.push("Y" + i);
1408 }
1409 }
1410
1411 if (MochiKit.Base.isDateLike(data[0][0])) {
1412 // Some intelligent defaults for a date x-axis.
1413 this.attrs_.xValueFormatter = Dygraph.dateString_;
1414 this.attrs_.xTicker = Dygraph.dateTicker;
1415
1416 // Assume they're all dates.
1417 var parsedData = MochiKit.Base.clone(data);
1418 for (var i = 0; i < data.length; i++) {
1419 if (parsedData[i].length == 0) {
1420 this.error("Row " << (1 + i) << " of data is empty");
1421 return null;
1422 }
1423 if (parsedData[i][0] == null
1424 || typeof(parsedData[i][0].getTime) != 'function') {
1425 this.error("x value in row " << (1 + i) << " is not a Date");
1426 return null;
1427 }
1428 parsedData[i][0] = parsedData[i][0].getTime();
1429 }
1430 return parsedData;
1431 } else {
1432 // Some intelligent defaults for a numeric x-axis.
1433 this.attrs_.xValueFormatter = function(x) { return x; };
1434 this.attrs_.xTicker = Dygraph.numericTicks;
1435 return data;
1436 }
1437};
1438
1439/**
79420a1e
DV
1440 * Parses a DataTable object from gviz.
1441 * The data is expected to have a first column that is either a date or a
1442 * number. All subsequent columns must be numbers. If there is a clear mismatch
1443 * between this.xValueParser_ and the type of the first column, it will be
1444 * fixed. Returned value is in the same format as return value of parseCSV_.
1445 * @param {Array.<Object>} data See above.
1446 * @private
1447 */
285a6bda 1448Dygraph.prototype.parseDataTable_ = function(data) {
79420a1e
DV
1449 var cols = data.getNumberOfColumns();
1450 var rows = data.getNumberOfRows();
1451
1452 // Read column labels
1453 var labels = [];
1454 for (var i = 0; i < cols; i++) {
1455 labels.push(data.getColumnLabel(i));
1456 }
285a6bda 1457 this.attrs_.labels = labels;
79420a1e 1458
d955e223 1459 var indepType = data.getColumnType(0);
285a6bda
DV
1460 if (indepType == 'date') {
1461 this.attrs_.xValueFormatter = Dygraph.dateString_;
1462 this.attrs_.xValueParser = Dygraph.dateParser;
1463 this.attrs_.xTicker = Dygraph.dateTicker;
33127159 1464 } else if (indepType == 'number') {
285a6bda
DV
1465 this.attrs_.xValueFormatter = function(x) { return x; };
1466 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
1467 this.attrs_.xTicker = Dygraph.numericTicks;
1468 } else {
33127159 1469 this.error("only 'date' and 'number' types are supported for column 1 " +
285a6bda 1470 "of DataTable input (Got '" + indepType + "')");
79420a1e
DV
1471 return null;
1472 }
1473
1474 var ret = [];
1475 for (var i = 0; i < rows; i++) {
1476 var row = [];
b3b20e24 1477 if (!data.getValue(i, 0)) continue;
d955e223
DV
1478 if (indepType == 'date') {
1479 row.push(data.getValue(i, 0).getTime());
1480 } else {
1481 row.push(data.getValue(i, 0));
1482 }
79420a1e
DV
1483 for (var j = 1; j < cols; j++) {
1484 row.push(data.getValue(i, j));
1485 }
243d96e8 1486 ret.push(row);
79420a1e
DV
1487 }
1488 return ret;
1489}
1490
1491/**
6a1aa64f
DV
1492 * Get the CSV data. If it's in a function, call that function. If it's in a
1493 * file, do an XMLHttpRequest to get it.
1494 * @private
1495 */
285a6bda 1496Dygraph.prototype.start_ = function() {
6a1aa64f 1497 if (typeof this.file_ == 'function') {
285a6bda 1498 // CSV string. Pretend we got it via XHR.
6a1aa64f 1499 this.loadedEvent_(this.file_());
285a6bda
DV
1500 } else if (MochiKit.Base.isArrayLike(this.file_)) {
1501 this.rawData_ = this.parseArray_(this.file_);
1502 this.drawGraph_(this.rawData_);
79420a1e
DV
1503 } else if (typeof this.file_ == 'object' &&
1504 typeof this.file_.getColumnRange == 'function') {
1505 // must be a DataTable from gviz.
1506 this.rawData_ = this.parseDataTable_(this.file_);
1507 this.drawGraph_(this.rawData_);
285a6bda
DV
1508 } else if (typeof this.file_ == 'string') {
1509 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
1510 if (this.file_.indexOf('\n') >= 0) {
1511 this.loadedEvent_(this.file_);
1512 } else {
1513 var req = new XMLHttpRequest();
1514 var caller = this;
1515 req.onreadystatechange = function () {
1516 if (req.readyState == 4) {
1517 if (req.status == 200) {
1518 caller.loadedEvent_(req.responseText);
1519 }
6a1aa64f 1520 }
285a6bda 1521 };
6a1aa64f 1522
285a6bda
DV
1523 req.open("GET", this.file_, true);
1524 req.send(null);
1525 }
1526 } else {
1527 this.error("Unknown data format: " + (typeof this.file_));
6a1aa64f
DV
1528 }
1529};
1530
1531/**
1532 * Changes various properties of the graph. These can include:
1533 * <ul>
1534 * <li>file: changes the source data for the graph</li>
1535 * <li>errorBars: changes whether the data contains stddev</li>
1536 * </ul>
1537 * @param {Object} attrs The new properties and values
1538 */
285a6bda
DV
1539Dygraph.prototype.updateOptions = function(attrs) {
1540 // TODO(danvk): this is a mess. Rethink this function.
6a1aa64f
DV
1541 if (attrs.customBars) {
1542 this.customBars_ = attrs.customBars;
1543 }
6a1aa64f
DV
1544 if (attrs.rollPeriod) {
1545 this.rollPeriod_ = attrs.rollPeriod;
1546 }
1547 if (attrs.dateWindow) {
1548 this.dateWindow_ = attrs.dateWindow;
1549 }
1550 if (attrs.valueRange) {
1551 this.valueRange_ = attrs.valueRange;
1552 }
285a6bda
DV
1553 MochiKit.Base.update(this.user_attrs_, attrs);
1554
1555 this.labelsFromCSV_ = (this.attr_("labels") == null);
1556
1557 // TODO(danvk): this doesn't match the constructor logic
1558 this.layout_.updateOptions({ 'errorBars': this.attr_("errorBars") });
6a1aa64f
DV
1559 if (attrs['file'] && attrs['file'] != this.file_) {
1560 this.file_ = attrs['file'];
1561 this.start_();
1562 } else {
1563 this.drawGraph_(this.rawData_);
1564 }
1565};
1566
1567/**
1568 * Adjusts the number of days in the rolling average. Updates the graph to
1569 * reflect the new averaging period.
1570 * @param {Number} length Number of days over which to average the data.
1571 */
285a6bda 1572Dygraph.prototype.adjustRoll = function(length) {
6a1aa64f
DV
1573 this.rollPeriod_ = length;
1574 this.drawGraph_(this.rawData_);
1575};
540d00f1
DV
1576
1577
1578/**
285a6bda 1579 * A wrapper around Dygraph that implements the gviz API.
540d00f1
DV
1580 * @param {Object} container The DOM object the visualization should live in.
1581 */
285a6bda 1582Dygraph.GVizChart = function(container) {
540d00f1
DV
1583 this.container = container;
1584}
1585
285a6bda 1586Dygraph.GVizChart.prototype.draw = function(data, options) {
540d00f1 1587 this.container.innerHTML = '';
285a6bda 1588 this.date_graph = new Dygraph(this.container, data, options);
540d00f1 1589}
285a6bda
DV
1590
1591// Older pages may still use this name.
1592DateGraph = Dygraph;