keep hacking out of plotkit
[dygraphs.git] / dygraph.js
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
6 * string. Dygraph can handle multiple series with or without error bars. The
7 * date/value ranges will be automatically set. Dygraph uses the
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">
14 new Dygraph(document.getElementById("graphdiv"),
15 "datafile.csv", // CSV file with headers
16 { }); // options
17 </script>
18
19 The CSV file is of the form
20
21 Date,SeriesA,SeriesB,SeriesC
22 YYYYMMDD,A1,B1,C1
23 YYYYMMDD,A2,B2,C2
24
25 If the 'errorBars' option is set in the constructor, the input should be of
26 the form
27
28 Date,SeriesA,SeriesB,...
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
34 Date,SeriesA,SeriesB,...
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
40 For further documentation and examples, see http://www.danvk.org/dygraphs
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,...
50 * @param {Object} attrs Various other attributes, e.g. errorBars determines
51 * whether the input data contains error ranges.
52 */
53 Dygraph = 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 }
65 };
66
67 Dygraph.NAME = "Dygraph";
68 Dygraph.VERSION = "1.2";
69 Dygraph.__repr__ = function() {
70 return "[" + this.NAME + " " + this.VERSION + "]";
71 };
72 Dygraph.toString = function() {
73 return this.__repr__();
74 };
75
76 // Various default values
77 Dygraph.DEFAULT_ROLL_PERIOD = 1;
78 Dygraph.DEFAULT_WIDTH = 480;
79 Dygraph.DEFAULT_HEIGHT = 320;
80 Dygraph.AXIS_LINE_WIDTH = 0.3;
81
82 // Default attribute values.
83 Dygraph.DEFAULT_ATTRS = {
84 highlightCircleSize: 3,
85 pixelsPerXLabel: 60,
86 pixelsPerYLabel: 30,
87
88 labelsDivWidth: 250,
89 labelsDivStyles: {
90 // TODO(danvk): move defaults from createStatusMessage_ here.
91 },
92 labelsSeparateLines: false,
93 labelsKMB: false,
94
95 strokeWidth: 1.0,
96
97 axisTickSize: 3,
98 axisLabelFontSize: 14,
99 xAxisLabelWidth: 50,
100 yAxisLabelWidth: 50,
101 rightGap: 5,
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.
116 Dygraph.DEBUG = 1;
117 Dygraph.INFO = 2;
118 Dygraph.WARNING = 3;
119 Dygraph.ERROR = 3;
120
121 Dygraph.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);
131 };
132
133 /**
134 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
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 */
142 Dygraph.prototype.__init__ = function(div, file, attrs) {
143 // Support two-argument constructor
144 if (attrs == null) { attrs = {}; }
145
146 // Copy the important bits into the object
147 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
148 this.maindiv_ = div;
149 this.file_ = file;
150 this.rollPeriod_ = attrs.rollPeriod || Dygraph.DEFAULT_ROLL_PERIOD;
151 this.previousVerticalX_ = -1;
152 this.fractions_ = attrs.fractions || false;
153 this.dateWindow_ = attrs.dateWindow || null;
154 this.valueRange_ = attrs.valueRange || null;
155 this.wilsonInterval_ = attrs.wilsonInterval || true;
156
157 // Clear the div. This ensure that, if multiple dygraphs are passed the same
158 // div, then only one will be drawn.
159 div.innerHTML = "";
160
161 // If the div isn't already sized then give it a default size.
162 if (div.style.width == '') {
163 div.style.width = Dygraph.DEFAULT_WIDTH + "px";
164 }
165 if (div.style.height == '') {
166 div.style.height = Dygraph.DEFAULT_HEIGHT + "px";
167 }
168 this.width_ = parseInt(div.style.width, 10);
169 this.height_ = parseInt(div.style.height, 10);
170
171 // Dygraphs has many options, some of which interact with one another.
172 // To keep track of everything, we maintain two sets of options:
173 //
174 // this.user_attrs_ only options explicitly set by the user.
175 // this.attrs_ defaults, options derived from user_attrs_, data.
176 //
177 // Options are then accessed this.attr_('attr'), which first looks at
178 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
179 // defaults without overriding behavior that the user specifically asks for.
180 this.user_attrs_ = {};
181 MochiKit.Base.update(this.user_attrs_, attrs);
182
183 this.attrs_ = {};
184 MochiKit.Base.update(this.attrs_, Dygraph.DEFAULT_ATTRS);
185
186 // Make a note of whether labels will be pulled from the CSV file.
187 this.labelsFromCSV_ = (this.attr_("labels") == null);
188
189 // Create the containing DIV and other interactive elements
190 this.createInterface_();
191
192 // Create the PlotKit grapher
193 // TODO(danvk): why does the Layout need its own set of options?
194 this.layoutOptions_ = { 'errorBars': (this.attr_("errorBars") ||
195 this.attr_("customBars")),
196 'xOriginIsZero': false };
197 MochiKit.Base.update(this.layoutOptions_, this.attrs_);
198 MochiKit.Base.update(this.layoutOptions_, this.user_attrs_);
199
200 this.layout_ = new DygraphLayout(this.layoutOptions_);
201
202 // TODO(danvk): why does the Renderer need its own set of options?
203 this.renderOptions_ = { colorScheme: this.colors_,
204 strokeColor: null,
205 axisLineWidth: Dygraph.AXIS_LINE_WIDTH };
206 MochiKit.Base.update(this.renderOptions_, this.attrs_);
207 MochiKit.Base.update(this.renderOptions_, this.user_attrs_);
208 this.plotter_ = new DygraphCanvasRenderer(this,
209 this.hidden_, this.layout_,
210 this.renderOptions_);
211
212 this.createStatusMessage_();
213 this.createRollInterface_();
214 this.createDragInterface_();
215
216 // connect(window, 'onload', this, function(e) { this.start_(); });
217 this.start_();
218 };
219
220 Dygraph.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?
231 Dygraph.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 }
249 Dygraph.prototype.info = function(message) {
250 this.log(Dygraph.INFO, message);
251 }
252 Dygraph.prototype.warn = function(message) {
253 this.log(Dygraph.WARNING, message);
254 }
255 Dygraph.prototype.error = function(message) {
256 this.log(Dygraph.ERROR, message);
257 }
258
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 */
263 Dygraph.prototype.rollPeriod = function() {
264 return this.rollPeriod_;
265 }
266
267 /**
268 * Generates interface elements for the Dygraph: a containing div, a div to
269 * display the current point, and a textbox to adjust the rolling average
270 * period.
271 * @private
272 */
273 Dygraph.prototype.createInterface_ = function() {
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
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
292 var canvas = MochiKit.DOM.CANVAS;
293 this.canvas_ = canvas( { style: { 'position': 'absolute' },
294 width: this.width_,
295 height: this.height_
296 });
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
306 * this particular canvas. All Dygraph work is done on this.canvas_.
307 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
308 * @return {Object} The newly-created canvas
309 * @private
310 */
311 Dygraph.prototype.createPlotKitCanvas_ = function(canvas) {
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.
327 * @private
328 */
329 Dygraph.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;
333 this.colors_ = [];
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;
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++) {
344 var colorStr = colors[i % colors.length];
345 this.colors_.push( MochiKit.Color.Color.fromString(colorStr) );
346 }
347 }
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_);
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 */
362 Dygraph.prototype.createStatusMessage_ = function(){
363 if (!this.attr_("labelsDiv")) {
364 var divWidth = this.attr_('labelsDivWidth');
365 var messagestyle = { "style": {
366 "position": "absolute",
367 "fontSize": "14px",
368 "zIndex": 10,
369 "width": divWidth + "px",
370 "top": "0px",
371 "left": (this.width_ - divWidth - 2) + "px",
372 "background": "white",
373 "textAlign": "left",
374 "overflow": "hidden"}};
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;
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 */
387 Dygraph.prototype.createRollInterface_ = function() {
388 var display = this.attr_('showRoller') ? "block" : "none";
389 var textAttr = { "type": "text",
390 "size": "2",
391 "value": this.rollPeriod_,
392 "style": { "position": "absolute",
393 "zIndex": 10,
394 "top": (this.plotter_.area.h - 25) + "px",
395 "left": (this.plotter_.area.x + 1) + "px",
396 "display": display }
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 */
411 Dygraph.prototype.createDragInterface_ = function() {
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
423 var px = 0;
424 var py = 0;
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;
442 px = PlotKit.Base.findPosX(self.canvas_);
443 py = PlotKit.Base.findPosY(self.canvas_);
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 &&
477 self.attr_('clickCallback') != null &&
478 self.lastx_ != undefined) {
479 // TODO(danvk): pass along more info about the point.
480 self.attr_('clickCallback')(event, new Date(self.lastx_));
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];
503 if (self.attr_("zoomCallback")) {
504 self.attr_("zoomCallback")(minDate, maxDate);
505 }
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 */
521 Dygraph.prototype.drawZoomRect_ = function(startX, endX, prevEndX) {
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 */
546 Dygraph.prototype.doZoom_ = function(lowX, highX) {
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_);
564 if (this.attr_("zoomCallback")) {
565 this.attr_("zoomCallback")(minDate, maxDate);
566 }
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 */
576 Dygraph.prototype.mouseMove_ = function(event) {
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
607 var circleSize = this.attr_('highlightCircleSize');
608 var ctx = this.canvas_.getContext("2d");
609 if (this.previousVerticalX_ >= 0) {
610 var px = this.previousVerticalX_;
611 ctx.clearRect(px - circleSize - 1, 0, 2 * circleSize + 2, this.height_);
612 }
613
614 var isOK = function(x) { return x && !isNaN(x); };
615
616 if (selPoints.length > 0) {
617 var canvasx = selPoints[0].canvasx;
618
619 // Set the status message to indicate the selected point(s)
620 var replace = this.attr_('xValueFormatter')(lastx, this) + ":";
621 var clen = this.colors_.length;
622 for (var i = 0; i < selPoints.length; i++) {
623 if (!isOK(selPoints[i].canvasy)) continue;
624 if (this.attr_("labelsSeparateLines")) {
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 }
632 this.attr_("labelsDiv").innerHTML = replace;
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++) {
640 if (!isOK(selPoints[i%clen].canvasy)) continue;
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 */
657 Dygraph.prototype.mouseOut_ = function(event) {
658 // Get rid of the overlay data
659 var ctx = this.canvas_.getContext("2d");
660 ctx.clearRect(0, 0, this.width_, this.height_);
661 this.attr_("labelsDiv").innerHTML = "";
662 };
663
664 Dygraph.zeropad = function(x) {
665 if (x < 10) return "0" + x; else return "" + x;
666 }
667
668 /**
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 */
674 Dygraph.prototype.hmsString_ = function(date) {
675 var zeropad = Dygraph.zeropad;
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 /**
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
693 * TODO(danvk): why is this part of the prototype?
694 */
695 Dygraph.dateString_ = function(date, self) {
696 var zeropad = Dygraph.zeropad;
697 var d = new Date(date);
698
699 // Get the year:
700 var year = "" + d.getFullYear();
701 // Get a 0 padded month string
702 var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh
703 // Get a 0 padded day string
704 var day = zeropad(d.getDate());
705
706 var ret = "";
707 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
708 if (frac) ret = " " + self.hmsString_(date);
709
710 return year + "/" + month + "/" + day + ret;
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 */
720 Dygraph.prototype.round_ = function(num, places) {
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 */
730 Dygraph.prototype.loadedEvent_ = function(data) {
731 this.rawData_ = this.parseCSV_(data);
732 this.drawGraph_(this.rawData_);
733 };
734
735 Dygraph.prototype.months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
736 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
737 Dygraph.prototype.quarters = ["Jan", "Apr", "Jul", "Oct"];
738
739 /**
740 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
741 * @private
742 */
743 Dygraph.prototype.addXTicks_ = function() {
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
754 var xTicks = this.attr_('xTicker')(startDate, endDate, this);
755 this.layout_.updateOptions({xTicks: xTicks});
756 };
757
758 // Time granularity enumeration
759 Dygraph.SECONDLY = 0;
760 Dygraph.TEN_SECONDLY = 1;
761 Dygraph.THIRTY_SECONDLY = 2;
762 Dygraph.MINUTELY = 3;
763 Dygraph.TEN_MINUTELY = 4;
764 Dygraph.THIRTY_MINUTELY = 5;
765 Dygraph.HOURLY = 6;
766 Dygraph.SIX_HOURLY = 7;
767 Dygraph.DAILY = 8;
768 Dygraph.WEEKLY = 9;
769 Dygraph.MONTHLY = 10;
770 Dygraph.QUARTERLY = 11;
771 Dygraph.BIANNUAL = 12;
772 Dygraph.ANNUAL = 13;
773 Dygraph.DECADAL = 14;
774 Dygraph.NUM_GRANULARITIES = 15;
775
776 Dygraph.SHORT_SPACINGS = [];
777 Dygraph.SHORT_SPACINGS[Dygraph.SECONDLY] = 1000 * 1;
778 Dygraph.SHORT_SPACINGS[Dygraph.TEN_SECONDLY] = 1000 * 10;
779 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_SECONDLY] = 1000 * 30;
780 Dygraph.SHORT_SPACINGS[Dygraph.MINUTELY] = 1000 * 60;
781 Dygraph.SHORT_SPACINGS[Dygraph.TEN_MINUTELY] = 1000 * 60 * 10;
782 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_MINUTELY] = 1000 * 60 * 30;
783 Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600;
784 Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600 * 6;
785 Dygraph.SHORT_SPACINGS[Dygraph.DAILY] = 1000 * 86400;
786 Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY] = 1000 * 604800;
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 //
793 Dygraph.prototype.NumXTicks = function(start_time, end_time, granularity) {
794 if (granularity < Dygraph.MONTHLY) {
795 // Generate one tick mark for every fixed interval of time.
796 var spacing = Dygraph.SHORT_SPACINGS[granularity];
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;
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; }
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 //
819 Dygraph.prototype.GetXAxis = function(start_time, end_time, granularity) {
820 var ticks = [];
821 if (granularity < Dygraph.MONTHLY) {
822 // Generate one tick mark for every fixed interval of time.
823 var spacing = Dygraph.SHORT_SPACINGS[granularity];
824 var format = '%d%b'; // e.g. "1 Jan"
825 // TODO(danvk): be smarter about making sure this really hits a "nice" time.
826 if (granularity < Dygraph.HOURLY) {
827 start_time = spacing * Math.floor(0.5 + start_time / spacing);
828 }
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();
832 if (frac == 0 || granularity >= Dygraph.DAILY) {
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
846 if (granularity == Dygraph.MONTHLY) {
847 months = [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
848 } else if (granularity == Dygraph.QUARTERLY) {
849 months = [ 0, 3, 6, 9 ];
850 } else if (granularity == Dygraph.BIANNUAL) {
851 months = [ 0, 6 ];
852 } else if (granularity == Dygraph.ANNUAL) {
853 months = [ 0 ];
854 } else if (granularity == Dygraph.DECADAL) {
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();
861 var zeropad = Dygraph.zeropad;
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
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 */
884 Dygraph.dateTicker = function(startDate, endDate, self) {
885 var chosen = -1;
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')) {
889 chosen = i;
890 break;
891 }
892 }
893
894 if (chosen >= 0) {
895 return self.GetXAxis(startDate, endDate, chosen);
896 } else {
897 // TODO(danvk): signal error.
898 }
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 */
908 Dygraph.numericTicks = function(minV, maxV, self) {
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).
912 // The first spacing greater than pixelsPerYLabel is what we use.
913 var mults = [1, 2, 5];
914 var scale, low_val, high_val, nTicks;
915 // TODO(danvk): make it possible to set this for x- and y-axes independently.
916 var pixelsPerTick = self.attr_('pixelsPerYLabel');
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];
921 low_val = Math.floor(minV / scale) * scale;
922 high_val = Math.ceil(maxV / scale) * scale;
923 nTicks = (high_val - low_val) / scale;
924 var spacing = self.height_ / nTicks;
925 // wish I could break out of both loops at once...
926 if (spacing > pixelsPerTick) break;
927 }
928 if (spacing > pixelsPerTick) break;
929 }
930
931 // Construct labels for the ticks
932 var ticks = [];
933 for (var i = 0; i < nTicks; i++) {
934 var tickV = low_val + i * scale;
935 var label = self.round_(tickV, 2);
936 if (self.attr_("labelsKMB")) {
937 var k = 1000;
938 if (tickV >= k*k*k) {
939 label = self.round_(tickV/(k*k*k), 1) + "B";
940 } else if (tickV >= k*k) {
941 label = self.round_(tickV/(k*k), 1) + "M";
942 } else if (tickV >= k) {
943 label = self.round_(tickV/k, 1) + "K";
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 */
957 Dygraph.prototype.addYTicks_ = function(minY, maxY) {
958 // Set the number of ticks so that the labels are human-friendly.
959 // TODO(danvk): make this an attribute as well.
960 var ticks = Dygraph.numericTicks(minY, maxY, this);
961 this.layout_.updateOptions( { yAxis: [minY, maxY],
962 yTicks: ticks } );
963 };
964
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]
969 Dygraph.prototype.extremeValues_ = function(series) {
970 var minY = null, maxY = null;
971
972 var bars = this.attr_("errorBars") || this.attr_("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
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 */
1013 Dygraph.prototype.drawGraph_ = function(data) {
1014 var minY = null, maxY = null;
1015 this.layout_.removeAllDatasets();
1016 this.setColors_();
1017 this.attrs_['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
1018
1019 // Loop over all fields in the dataset
1020 for (var i = 1; i < data[0].length; i++) {
1021 var series = [];
1022 for (var j = 0; j < data.length; j++) {
1023 var date = data[j][0];
1024 series[j] = [date, data[j][i]];
1025 }
1026 series = this.rollingAverage(series, this.rollPeriod_);
1027
1028 // Prune down to the desired range, if necessary (for zooming)
1029 var bars = this.attr_("errorBars") || this.attr_("customBars");
1030 if (this.dateWindow_) {
1031 var low = this.dateWindow_[0];
1032 var high= this.dateWindow_[1];
1033 var pruned = [];
1034 for (var k = 0; k < series.length; k++) {
1035 if (series[k][0] >= low && series[k][0] <= high) {
1036 pruned.push(series[k]);
1037 }
1038 }
1039 series = pruned;
1040 }
1041
1042 var extremes = this.extremeValues_(series);
1043 var thisMinY = extremes[0];
1044 var thisMaxY = extremes[1];
1045 if (!minY || thisMinY < minY) minY = thisMinY;
1046 if (!maxY || thisMaxY > maxY) maxY = thisMaxY;
1047
1048 if (bars) {
1049 var vals = [];
1050 for (var j=0; j<series.length; j++)
1051 vals[j] = [series[j][0],
1052 series[j][1][0], series[j][1][1], series[j][1][2]];
1053 this.layout_.addDataset(this.attr_("labels")[i], vals);
1054 } else {
1055 this.layout_.addDataset(this.attr_("labels")[i], series);
1056 }
1057 }
1058
1059 // Use some heuristics to come up with a good maxY value, unless it's been
1060 // set explicitly by the user.
1061 if (this.valueRange_ != null) {
1062 this.addYTicks_(this.valueRange_[0], this.valueRange_[1]);
1063 } else {
1064 // Add some padding and round up to an integer to be human-friendly.
1065 var span = maxY - minY;
1066 var maxAxisY = maxY + 0.1 * span;
1067 var minAxisY = minY - 0.1 * span;
1068
1069 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
1070 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
1071 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
1072
1073 if (this.attr_("includeZero")) {
1074 if (maxY < 0) maxAxisY = 0;
1075 if (minY > 0) minAxisY = 0;
1076 }
1077
1078 this.addYTicks_(minAxisY, maxAxisY);
1079 }
1080
1081 this.addXTicks_();
1082
1083 // Tell PlotKit to use this new data and render itself
1084 this.layout_.evaluateWithError();
1085 this.plotter_.clear();
1086 this.plotter_.render();
1087 this.canvas_.getContext('2d').clearRect(0, 0,
1088 this.canvas_.width, this.canvas_.height);
1089 };
1090
1091 /**
1092 * Calculates the rolling average of a data set.
1093 * If originalData is [label, val], rolls the average of those.
1094 * If originalData is [label, [, it's interpreted as [value, stddev]
1095 * and the roll is returned in the same form, with appropriately reduced
1096 * stddev for each value.
1097 * Note that this is where fractional input (i.e. '5/10') is converted into
1098 * decimal values.
1099 * @param {Array} originalData The data in the appropriate format (see above)
1100 * @param {Number} rollPeriod The number of days over which to average the data
1101 */
1102 Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
1103 if (originalData.length < 2)
1104 return originalData;
1105 var rollPeriod = Math.min(rollPeriod, originalData.length - 1);
1106 var rollingData = [];
1107 var sigma = this.attr_("sigma");
1108
1109 if (this.fractions_) {
1110 var num = 0;
1111 var den = 0; // numerator/denominator
1112 var mult = 100.0;
1113 for (var i = 0; i < originalData.length; i++) {
1114 num += originalData[i][1][0];
1115 den += originalData[i][1][1];
1116 if (i - rollPeriod >= 0) {
1117 num -= originalData[i - rollPeriod][1][0];
1118 den -= originalData[i - rollPeriod][1][1];
1119 }
1120
1121 var date = originalData[i][0];
1122 var value = den ? num / den : 0.0;
1123 if (this.attr_("errorBars")) {
1124 if (this.wilsonInterval_) {
1125 // For more details on this confidence interval, see:
1126 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
1127 if (den) {
1128 var p = value < 0 ? 0 : value, n = den;
1129 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
1130 var denom = 1 + sigma * sigma / den;
1131 var low = (p + sigma * sigma / (2 * den) - pm) / denom;
1132 var high = (p + sigma * sigma / (2 * den) + pm) / denom;
1133 rollingData[i] = [date,
1134 [p * mult, (p - low) * mult, (high - p) * mult]];
1135 } else {
1136 rollingData[i] = [date, [0, 0, 0]];
1137 }
1138 } else {
1139 var stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
1140 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
1141 }
1142 } else {
1143 rollingData[i] = [date, mult * value];
1144 }
1145 }
1146 } else if (this.attr_("customBars")) {
1147 var low = 0;
1148 var mid = 0;
1149 var high = 0;
1150 var count = 0;
1151 for (var i = 0; i < originalData.length; i++) {
1152 var data = originalData[i][1];
1153 var y = data[1];
1154 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
1155
1156 low += data[0];
1157 mid += y;
1158 high += data[2];
1159 count += 1;
1160 if (i - rollPeriod >= 0) {
1161 var prev = originalData[i - rollPeriod];
1162 low -= prev[1][0];
1163 mid -= prev[1][1];
1164 high -= prev[1][2];
1165 count -= 1;
1166 }
1167 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
1168 1.0 * (mid - low) / count,
1169 1.0 * (high - mid) / count ]];
1170 }
1171 } else {
1172 // Calculate the rolling average for the first rollPeriod - 1 points where
1173 // there is not enough data to roll over the full number of days
1174 var num_init_points = Math.min(rollPeriod - 1, originalData.length - 2);
1175 if (!this.attr_("errorBars")){
1176 if (rollPeriod == 1) {
1177 return originalData;
1178 }
1179
1180 for (var i = 0; i < originalData.length; i++) {
1181 var sum = 0;
1182 var num_ok = 0;
1183 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
1184 var y = originalData[j][1];
1185 if (!y || isNaN(y)) continue;
1186 num_ok++;
1187 sum += originalData[j][1];
1188 }
1189 if (num_ok) {
1190 rollingData[i] = [originalData[i][0], sum / num_ok];
1191 } else {
1192 rollingData[i] = [originalData[i][0], null];
1193 }
1194 }
1195
1196 } else {
1197 for (var i = 0; i < originalData.length; i++) {
1198 var sum = 0;
1199 var variance = 0;
1200 var num_ok = 0;
1201 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
1202 var y = originalData[j][1][0];
1203 if (!y || isNaN(y)) continue;
1204 num_ok++;
1205 sum += originalData[j][1][0];
1206 variance += Math.pow(originalData[j][1][1], 2);
1207 }
1208 if (num_ok) {
1209 var stddev = Math.sqrt(variance) / num_ok;
1210 rollingData[i] = [originalData[i][0],
1211 [sum / num_ok, sigma * stddev, sigma * stddev]];
1212 } else {
1213 rollingData[i] = [originalData[i][0], [null, null, null]];
1214 }
1215 }
1216 }
1217 }
1218
1219 return rollingData;
1220 };
1221
1222 /**
1223 * Parses a date, returning the number of milliseconds since epoch. This can be
1224 * passed in as an xValueParser in the Dygraph constructor.
1225 * TODO(danvk): enumerate formats that this understands.
1226 * @param {String} A date in YYYYMMDD format.
1227 * @return {Number} Milliseconds since epoch.
1228 * @public
1229 */
1230 Dygraph.dateParser = function(dateStr, self) {
1231 var dateStrSlashed;
1232 var d;
1233 if (dateStr.length == 10 && dateStr.search("-") != -1) { // e.g. '2009-07-12'
1234 dateStrSlashed = dateStr.replace("-", "/", "g");
1235 while (dateStrSlashed.search("-") != -1) {
1236 dateStrSlashed = dateStrSlashed.replace("-", "/");
1237 }
1238 d = Date.parse(dateStrSlashed);
1239 } else if (dateStr.length == 8) { // e.g. '20090712'
1240 // TODO(danvk): remove support for this format. It's confusing.
1241 dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2)
1242 + "/" + dateStr.substr(6,2);
1243 d = Date.parse(dateStrSlashed);
1244 } else {
1245 // Any format that Date.parse will accept, e.g. "2009/07/12" or
1246 // "2009/07/12 12:34:56"
1247 d = Date.parse(dateStr);
1248 }
1249
1250 if (!d || isNaN(d)) {
1251 self.error("Couldn't parse " + dateStr + " as a date");
1252 }
1253 return d;
1254 };
1255
1256 /**
1257 * Detects the type of the str (date or numeric) and sets the various
1258 * formatting attributes in this.attrs_ based on this type.
1259 * @param {String} str An x value.
1260 * @private
1261 */
1262 Dygraph.prototype.detectTypeFromString_ = function(str) {
1263 var isDate = false;
1264 if (str.indexOf('-') >= 0 ||
1265 str.indexOf('/') >= 0 ||
1266 isNaN(parseFloat(str))) {
1267 isDate = true;
1268 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
1269 // TODO(danvk): remove support for this format.
1270 isDate = true;
1271 }
1272
1273 if (isDate) {
1274 this.attrs_.xValueFormatter = Dygraph.dateString_;
1275 this.attrs_.xValueParser = Dygraph.dateParser;
1276 this.attrs_.xTicker = Dygraph.dateTicker;
1277 } else {
1278 this.attrs_.xValueFormatter = function(x) { return x; };
1279 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
1280 this.attrs_.xTicker = Dygraph.numericTicks;
1281 }
1282 };
1283
1284 /**
1285 * Parses a string in a special csv format. We expect a csv file where each
1286 * line is a date point, and the first field in each line is the date string.
1287 * We also expect that all remaining fields represent series.
1288 * if the errorBars attribute is set, then interpret the fields as:
1289 * date, series1, stddev1, series2, stddev2, ...
1290 * @param {Array.<Object>} data See above.
1291 * @private
1292 *
1293 * @return Array.<Object> An array with one entry for each row. These entries
1294 * are an array of cells in that row. The first entry is the parsed x-value for
1295 * the row. The second, third, etc. are the y-values. These can take on one of
1296 * three forms, depending on the CSV and constructor parameters:
1297 * 1. numeric value
1298 * 2. [ value, stddev ]
1299 * 3. [ low value, center value, high value ]
1300 */
1301 Dygraph.prototype.parseCSV_ = function(data) {
1302 var ret = [];
1303 var lines = data.split("\n");
1304 var start = 0;
1305 if (this.labelsFromCSV_) {
1306 start = 1;
1307 this.attrs_.labels = lines[0].split(",");
1308 }
1309
1310 var xParser;
1311 var defaultParserSet = false; // attempt to auto-detect x value type
1312 var expectedCols = this.attr_("labels").length;
1313 for (var i = start; i < lines.length; i++) {
1314 var line = lines[i];
1315 if (line.length == 0) continue; // skip blank lines
1316 var inFields = line.split(',');
1317 if (inFields.length < 2) continue;
1318
1319 var fields = [];
1320 if (!defaultParserSet) {
1321 this.detectTypeFromString_(inFields[0]);
1322 xParser = this.attr_("xValueParser");
1323 defaultParserSet = true;
1324 }
1325 fields[0] = xParser(inFields[0], this);
1326
1327 // If fractions are expected, parse the numbers as "A/B"
1328 if (this.fractions_) {
1329 for (var j = 1; j < inFields.length; j++) {
1330 // TODO(danvk): figure out an appropriate way to flag parse errors.
1331 var vals = inFields[j].split("/");
1332 fields[j] = [parseFloat(vals[0]), parseFloat(vals[1])];
1333 }
1334 } else if (this.attr_("errorBars")) {
1335 // If there are error bars, values are (value, stddev) pairs
1336 for (var j = 1; j < inFields.length; j += 2)
1337 fields[(j + 1) / 2] = [parseFloat(inFields[j]),
1338 parseFloat(inFields[j + 1])];
1339 } else if (this.attr_("customBars")) {
1340 // Bars are a low;center;high tuple
1341 for (var j = 1; j < inFields.length; j++) {
1342 var vals = inFields[j].split(";");
1343 fields[j] = [ parseFloat(vals[0]),
1344 parseFloat(vals[1]),
1345 parseFloat(vals[2]) ];
1346 }
1347 } else {
1348 // Values are just numbers
1349 for (var j = 1; j < inFields.length; j++) {
1350 fields[j] = parseFloat(inFields[j]);
1351 }
1352 }
1353 ret.push(fields);
1354
1355 if (fields.length != expectedCols) {
1356 this.error("Number of columns in line " + i + " (" + fields.length +
1357 ") does not agree with number of labels (" + expectedCols +
1358 ") " + line);
1359 }
1360 }
1361 return ret;
1362 };
1363
1364 /**
1365 * The user has provided their data as a pre-packaged JS array. If the x values
1366 * are numeric, this is the same as dygraphs' internal format. If the x values
1367 * are dates, we need to convert them from Date objects to ms since epoch.
1368 * @param {Array.<Object>} data
1369 * @return {Array.<Object>} data with numeric x values.
1370 */
1371 Dygraph.prototype.parseArray_ = function(data) {
1372 // Peek at the first x value to see if it's numeric.
1373 if (data.length == 0) {
1374 this.error("Can't plot empty data set");
1375 return null;
1376 }
1377 if (data[0].length == 0) {
1378 this.error("Data set cannot contain an empty row");
1379 return null;
1380 }
1381
1382 if (this.attr_("labels") == null) {
1383 this.warn("Using default labels. Set labels explicitly via 'labels' " +
1384 "in the options parameter");
1385 this.attrs_.labels = [ "X" ];
1386 for (var i = 1; i < data[0].length; i++) {
1387 this.attrs_.labels.push("Y" + i);
1388 }
1389 }
1390
1391 if (MochiKit.Base.isDateLike(data[0][0])) {
1392 // Some intelligent defaults for a date x-axis.
1393 this.attrs_.xValueFormatter = Dygraph.dateString_;
1394 this.attrs_.xTicker = Dygraph.dateTicker;
1395
1396 // Assume they're all dates.
1397 var parsedData = MochiKit.Base.clone(data);
1398 for (var i = 0; i < data.length; i++) {
1399 if (parsedData[i].length == 0) {
1400 this.error("Row " << (1 + i) << " of data is empty");
1401 return null;
1402 }
1403 if (parsedData[i][0] == null
1404 || typeof(parsedData[i][0].getTime) != 'function') {
1405 this.error("x value in row " << (1 + i) << " is not a Date");
1406 return null;
1407 }
1408 parsedData[i][0] = parsedData[i][0].getTime();
1409 }
1410 return parsedData;
1411 } else {
1412 // Some intelligent defaults for a numeric x-axis.
1413 this.attrs_.xValueFormatter = function(x) { return x; };
1414 this.attrs_.xTicker = Dygraph.numericTicks;
1415 return data;
1416 }
1417 };
1418
1419 /**
1420 * Parses a DataTable object from gviz.
1421 * The data is expected to have a first column that is either a date or a
1422 * number. All subsequent columns must be numbers. If there is a clear mismatch
1423 * between this.xValueParser_ and the type of the first column, it will be
1424 * fixed. Returned value is in the same format as return value of parseCSV_.
1425 * @param {Array.<Object>} data See above.
1426 * @private
1427 */
1428 Dygraph.prototype.parseDataTable_ = function(data) {
1429 var cols = data.getNumberOfColumns();
1430 var rows = data.getNumberOfRows();
1431
1432 // Read column labels
1433 var labels = [];
1434 for (var i = 0; i < cols; i++) {
1435 labels.push(data.getColumnLabel(i));
1436 }
1437 this.attrs_.labels = labels;
1438
1439 var indepType = data.getColumnType(0);
1440 if (indepType == 'date') {
1441 this.attrs_.xValueFormatter = Dygraph.dateString_;
1442 this.attrs_.xValueParser = Dygraph.dateParser;
1443 this.attrs_.xTicker = Dygraph.dateTicker;
1444 } else if (indepType == 'number') {
1445 this.attrs_.xValueFormatter = function(x) { return x; };
1446 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
1447 this.attrs_.xTicker = Dygraph.numericTicks;
1448 } else {
1449 this.error("only 'date' and 'number' types are supported for column 1 " +
1450 "of DataTable input (Got '" + indepType + "')");
1451 return null;
1452 }
1453
1454 var ret = [];
1455 for (var i = 0; i < rows; i++) {
1456 var row = [];
1457 if (!data.getValue(i, 0)) continue;
1458 if (indepType == 'date') {
1459 row.push(data.getValue(i, 0).getTime());
1460 } else {
1461 row.push(data.getValue(i, 0));
1462 }
1463 for (var j = 1; j < cols; j++) {
1464 row.push(data.getValue(i, j));
1465 }
1466 ret.push(row);
1467 }
1468 return ret;
1469 }
1470
1471 /**
1472 * Get the CSV data. If it's in a function, call that function. If it's in a
1473 * file, do an XMLHttpRequest to get it.
1474 * @private
1475 */
1476 Dygraph.prototype.start_ = function() {
1477 if (typeof this.file_ == 'function') {
1478 // CSV string. Pretend we got it via XHR.
1479 this.loadedEvent_(this.file_());
1480 } else if (MochiKit.Base.isArrayLike(this.file_)) {
1481 this.rawData_ = this.parseArray_(this.file_);
1482 this.drawGraph_(this.rawData_);
1483 } else if (typeof this.file_ == 'object' &&
1484 typeof this.file_.getColumnRange == 'function') {
1485 // must be a DataTable from gviz.
1486 this.rawData_ = this.parseDataTable_(this.file_);
1487 this.drawGraph_(this.rawData_);
1488 } else if (typeof this.file_ == 'string') {
1489 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
1490 if (this.file_.indexOf('\n') >= 0) {
1491 this.loadedEvent_(this.file_);
1492 } else {
1493 var req = new XMLHttpRequest();
1494 var caller = this;
1495 req.onreadystatechange = function () {
1496 if (req.readyState == 4) {
1497 if (req.status == 200) {
1498 caller.loadedEvent_(req.responseText);
1499 }
1500 }
1501 };
1502
1503 req.open("GET", this.file_, true);
1504 req.send(null);
1505 }
1506 } else {
1507 this.error("Unknown data format: " + (typeof this.file_));
1508 }
1509 };
1510
1511 /**
1512 * Changes various properties of the graph. These can include:
1513 * <ul>
1514 * <li>file: changes the source data for the graph</li>
1515 * <li>errorBars: changes whether the data contains stddev</li>
1516 * </ul>
1517 * @param {Object} attrs The new properties and values
1518 */
1519 Dygraph.prototype.updateOptions = function(attrs) {
1520 // TODO(danvk): this is a mess. Rethink this function.
1521 if (attrs.rollPeriod) {
1522 this.rollPeriod_ = attrs.rollPeriod;
1523 }
1524 if (attrs.dateWindow) {
1525 this.dateWindow_ = attrs.dateWindow;
1526 }
1527 if (attrs.valueRange) {
1528 this.valueRange_ = attrs.valueRange;
1529 }
1530 MochiKit.Base.update(this.user_attrs_, attrs);
1531
1532 this.labelsFromCSV_ = (this.attr_("labels") == null);
1533
1534 // TODO(danvk): this doesn't match the constructor logic
1535 this.layout_.updateOptions({ 'errorBars': this.attr_("errorBars") });
1536 if (attrs['file'] && attrs['file'] != this.file_) {
1537 this.file_ = attrs['file'];
1538 this.start_();
1539 } else {
1540 this.drawGraph_(this.rawData_);
1541 }
1542 };
1543
1544 /**
1545 * Adjusts the number of days in the rolling average. Updates the graph to
1546 * reflect the new averaging period.
1547 * @param {Number} length Number of days over which to average the data.
1548 */
1549 Dygraph.prototype.adjustRoll = function(length) {
1550 this.rollPeriod_ = length;
1551 this.drawGraph_(this.rawData_);
1552 };
1553
1554
1555 /**
1556 * A wrapper around Dygraph that implements the gviz API.
1557 * @param {Object} container The DOM object the visualization should live in.
1558 */
1559 Dygraph.GVizChart = function(container) {
1560 this.container = container;
1561 }
1562
1563 Dygraph.GVizChart.prototype.draw = function(data, options) {
1564 this.container.innerHTML = '';
1565 this.date_graph = new Dygraph(this.container, data, options);
1566 }
1567
1568 // Older pages may still use this name.
1569 DateGraph = Dygraph;