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