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