Add yAxisLabelFormatter option and make it's default value yValueFormatter.
[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 labelsKMG2: false,
95 showLabelsOnHighlight: true,
96
97 yValueFormatter: function(x) { return Dygraph.round_(x, 2); },
98
99 strokeWidth: 1.0,
100
101 axisTickSize: 3,
102 axisLabelFontSize: 14,
103 xAxisLabelWidth: 50,
104 yAxisLabelWidth: 50,
105 xAxisLabelFormatter: Dygraph.dateAxisFormatter,
106 rightGap: 5,
107
108 showRoller: false,
109 xValueFormatter: Dygraph.dateString_,
110 xValueParser: Dygraph.dateParser,
111 xTicker: Dygraph.dateTicker,
112
113 delimiter: ',',
114
115 logScale: false,
116 sigma: 2.0,
117 errorBars: false,
118 fractions: false,
119 wilsonInterval: true, // only relevant if fractions is true
120 customBars: false,
121 fillGraph: false,
122 fillAlpha: 0.15,
123 connectSeparatedPoints: false,
124
125 stackedGraph: false,
126 hideOverlayOnMouseOut: true,
127
128 stepPlot: false
129 };
130
131 // Various logging levels.
132 Dygraph.DEBUG = 1;
133 Dygraph.INFO = 2;
134 Dygraph.WARNING = 3;
135 Dygraph.ERROR = 3;
136
137 Dygraph.prototype.__old_init__ = function(div, file, labels, attrs) {
138 // Labels is no longer a constructor parameter, since it's typically set
139 // directly from the data source. It also conains a name for the x-axis,
140 // which the previous constructor form did not.
141 if (labels != null) {
142 var new_labels = ["Date"];
143 for (var i = 0; i < labels.length; i++) new_labels.push(labels[i]);
144 Dygraph.update(attrs, { 'labels': new_labels });
145 }
146 this.__init__(div, file, attrs);
147 };
148
149 /**
150 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
151 * and interaction &lt;canvas&gt; inside of it. See the constructor for details
152 * on the parameters.
153 * @param {Element} div the Element to render the graph into.
154 * @param {String | Function} file Source data
155 * @param {Object} attrs Miscellaneous other options
156 * @private
157 */
158 Dygraph.prototype.__init__ = function(div, file, attrs) {
159 // Support two-argument constructor
160 if (attrs == null) { attrs = {}; }
161
162 // Copy the important bits into the object
163 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
164 this.maindiv_ = div;
165 this.file_ = file;
166 this.rollPeriod_ = attrs.rollPeriod || Dygraph.DEFAULT_ROLL_PERIOD;
167 this.previousVerticalX_ = -1;
168 this.fractions_ = attrs.fractions || false;
169 this.dateWindow_ = attrs.dateWindow || null;
170 this.valueRange_ = attrs.valueRange || null;
171 this.wilsonInterval_ = attrs.wilsonInterval || true;
172 this.is_initial_draw_ = true;
173
174 // Clear the div. This ensure that, if multiple dygraphs are passed the same
175 // div, then only one will be drawn.
176 div.innerHTML = "";
177
178 // If the div isn't already sized then inherit from our attrs or
179 // give it a default size.
180 if (div.style.width == '') {
181 div.style.width = attrs.width || Dygraph.DEFAULT_WIDTH + "px";
182 }
183 if (div.style.height == '') {
184 div.style.height = attrs.height || Dygraph.DEFAULT_HEIGHT + "px";
185 }
186 this.width_ = parseInt(div.style.width, 10);
187 this.height_ = parseInt(div.style.height, 10);
188 // The div might have been specified as percent of the current window size,
189 // convert that to an appropriate number of pixels.
190 if (div.style.width.indexOf("%") == div.style.width.length - 1) {
191 this.width_ = div.offsetWidth;
192 }
193 if (div.style.height.indexOf("%") == div.style.height.length - 1) {
194 this.height_ = div.offsetHeight;
195 }
196
197 if (this.width_ == 0) {
198 this.error("dygraph has zero width. Please specify a width in pixels.");
199 }
200 if (this.height_ == 0) {
201 this.error("dygraph has zero height. Please specify a height in pixels.");
202 }
203
204 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
205 if (attrs['stackedGraph']) {
206 attrs['fillGraph'] = true;
207 // TODO(nikhilk): Add any other stackedGraph checks here.
208 }
209
210 // Dygraphs has many options, some of which interact with one another.
211 // To keep track of everything, we maintain two sets of options:
212 //
213 // this.user_attrs_ only options explicitly set by the user.
214 // this.attrs_ defaults, options derived from user_attrs_, data.
215 //
216 // Options are then accessed this.attr_('attr'), which first looks at
217 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
218 // defaults without overriding behavior that the user specifically asks for.
219 this.user_attrs_ = {};
220 Dygraph.update(this.user_attrs_, attrs);
221
222 this.attrs_ = {};
223 Dygraph.update(this.attrs_, Dygraph.DEFAULT_ATTRS);
224
225 this.boundaryIds_ = [];
226
227 // Make a note of whether labels will be pulled from the CSV file.
228 this.labelsFromCSV_ = (this.attr_("labels") == null);
229
230 // Create the containing DIV and other interactive elements
231 this.createInterface_();
232
233 this.start_();
234 };
235
236 Dygraph.prototype.attr_ = function(name) {
237 if (typeof(this.user_attrs_[name]) != 'undefined') {
238 return this.user_attrs_[name];
239 } else if (typeof(this.attrs_[name]) != 'undefined') {
240 return this.attrs_[name];
241 } else {
242 return null;
243 }
244 };
245
246 // TODO(danvk): any way I can get the line numbers to be this.warn call?
247 Dygraph.prototype.log = function(severity, message) {
248 if (typeof(console) != 'undefined') {
249 switch (severity) {
250 case Dygraph.DEBUG:
251 console.debug('dygraphs: ' + message);
252 break;
253 case Dygraph.INFO:
254 console.info('dygraphs: ' + message);
255 break;
256 case Dygraph.WARNING:
257 console.warn('dygraphs: ' + message);
258 break;
259 case Dygraph.ERROR:
260 console.error('dygraphs: ' + message);
261 break;
262 }
263 }
264 }
265 Dygraph.prototype.info = function(message) {
266 this.log(Dygraph.INFO, message);
267 }
268 Dygraph.prototype.warn = function(message) {
269 this.log(Dygraph.WARNING, message);
270 }
271 Dygraph.prototype.error = function(message) {
272 this.log(Dygraph.ERROR, message);
273 }
274
275 /**
276 * Returns the current rolling period, as set by the user or an option.
277 * @return {Number} The number of days in the rolling window
278 */
279 Dygraph.prototype.rollPeriod = function() {
280 return this.rollPeriod_;
281 };
282
283 /**
284 * Returns the currently-visible x-range. This can be affected by zooming,
285 * panning or a call to updateOptions.
286 * Returns a two-element array: [left, right].
287 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
288 */
289 Dygraph.prototype.xAxisRange = function() {
290 if (this.dateWindow_) return this.dateWindow_;
291
292 // The entire chart is visible.
293 var left = this.rawData_[0][0];
294 var right = this.rawData_[this.rawData_.length - 1][0];
295 return [left, right];
296 };
297
298 /**
299 * Returns the currently-visible y-range. This can be affected by zooming,
300 * panning or a call to updateOptions.
301 * Returns a two-element array: [bottom, top].
302 */
303 Dygraph.prototype.yAxisRange = function() {
304 return this.displayedYRange_;
305 };
306
307 /**
308 * Convert from data coordinates to canvas/div X/Y coordinates.
309 * Returns a two-element array: [X, Y]
310 */
311 Dygraph.prototype.toDomCoords = function(x, y) {
312 var ret = [null, null];
313 var area = this.plotter_.area;
314 if (x !== null) {
315 var xRange = this.xAxisRange();
316 ret[0] = area.x + (x - xRange[0]) / (xRange[1] - xRange[0]) * area.w;
317 }
318
319 if (y !== null) {
320 var yRange = this.yAxisRange();
321 ret[1] = area.y + (yRange[1] - y) / (yRange[1] - yRange[0]) * area.h;
322 }
323
324 return ret;
325 };
326
327 // TODO(danvk): use these functions throughout dygraphs.
328 /**
329 * Convert from canvas/div coords to data coordinates.
330 * Returns a two-element array: [X, Y]
331 */
332 Dygraph.prototype.toDataCoords = function(x, y) {
333 var ret = [null, null];
334 var area = this.plotter_.area;
335 if (x !== null) {
336 var xRange = this.xAxisRange();
337 ret[0] = xRange[0] + (x - area.x) / area.w * (xRange[1] - xRange[0]);
338 }
339
340 if (y !== null) {
341 var yRange = this.yAxisRange();
342 ret[1] = yRange[0] + (area.h - y) / area.h * (yRange[1] - yRange[0]);
343 }
344
345 return ret;
346 };
347
348 Dygraph.addEvent = function(el, evt, fn) {
349 var normed_fn = function(e) {
350 if (!e) var e = window.event;
351 fn(e);
352 };
353 if (window.addEventListener) { // Mozilla, Netscape, Firefox
354 el.addEventListener(evt, normed_fn, false);
355 } else { // IE
356 el.attachEvent('on' + evt, normed_fn);
357 }
358 };
359
360 Dygraph.clipCanvas_ = function(cnv, clip) {
361 var ctx = cnv.getContext("2d");
362 ctx.beginPath();
363 ctx.rect(clip.left, clip.top, clip.width, clip.height);
364 ctx.clip();
365 };
366
367 /**
368 * Generates interface elements for the Dygraph: a containing div, a div to
369 * display the current point, and a textbox to adjust the rolling average
370 * period. Also creates the Renderer/Layout elements.
371 * @private
372 */
373 Dygraph.prototype.createInterface_ = function() {
374 // Create the all-enclosing graph div
375 var enclosing = this.maindiv_;
376
377 this.graphDiv = document.createElement("div");
378 this.graphDiv.style.width = this.width_ + "px";
379 this.graphDiv.style.height = this.height_ + "px";
380 enclosing.appendChild(this.graphDiv);
381
382 var clip = {
383 top: 0,
384 left: this.attr_("yAxisLabelWidth") + 2 * this.attr_("axisTickSize")
385 };
386 clip.width = this.width_ - clip.left - this.attr_("rightGap");
387 clip.height = this.height_ - this.attr_("axisLabelFontSize")
388 - 2 * this.attr_("axisTickSize");
389 this.clippingArea_ = clip;
390
391 // Create the canvas for interactive parts of the chart.
392 this.canvas_ = Dygraph.createCanvas();
393 this.canvas_.style.position = "absolute";
394 this.canvas_.width = this.width_;
395 this.canvas_.height = this.height_;
396 this.canvas_.style.width = this.width_ + "px"; // for IE
397 this.canvas_.style.height = this.height_ + "px"; // for IE
398
399 // ... and for static parts of the chart.
400 this.hidden_ = this.createPlotKitCanvas_(this.canvas_);
401
402 // The interactive parts of the graph are drawn on top of the chart.
403 this.graphDiv.appendChild(this.hidden_);
404 this.graphDiv.appendChild(this.canvas_);
405 this.mouseEventElement_ = this.canvas_;
406
407 // Make sure we don't overdraw.
408 Dygraph.clipCanvas_(this.hidden_, this.clippingArea_);
409 Dygraph.clipCanvas_(this.canvas_, this.clippingArea_);
410
411 var dygraph = this;
412 Dygraph.addEvent(this.mouseEventElement_, 'mousemove', function(e) {
413 dygraph.mouseMove_(e);
414 });
415 Dygraph.addEvent(this.mouseEventElement_, 'mouseout', function(e) {
416 dygraph.mouseOut_(e);
417 });
418
419 // Create the grapher
420 // TODO(danvk): why does the Layout need its own set of options?
421 this.layoutOptions_ = { 'xOriginIsZero': false };
422 Dygraph.update(this.layoutOptions_, this.attrs_);
423 Dygraph.update(this.layoutOptions_, this.user_attrs_);
424 Dygraph.update(this.layoutOptions_, {
425 'errorBars': (this.attr_("errorBars") || this.attr_("customBars")) });
426
427 this.layout_ = new DygraphLayout(this, this.layoutOptions_);
428
429 // TODO(danvk): why does the Renderer need its own set of options?
430 this.renderOptions_ = { colorScheme: this.colors_,
431 strokeColor: null,
432 axisLineWidth: Dygraph.AXIS_LINE_WIDTH };
433 Dygraph.update(this.renderOptions_, this.attrs_);
434 Dygraph.update(this.renderOptions_, this.user_attrs_);
435 this.plotter_ = new DygraphCanvasRenderer(this,
436 this.hidden_, this.layout_,
437 this.renderOptions_);
438
439 this.createStatusMessage_();
440 this.createRollInterface_();
441 this.createDragInterface_();
442 };
443
444 /**
445 * Detach DOM elements in the dygraph and null out all data references.
446 * Calling this when you're done with a dygraph can dramatically reduce memory
447 * usage. See, e.g., the tests/perf.html example.
448 */
449 Dygraph.prototype.destroy = function() {
450 var removeRecursive = function(node) {
451 while (node.hasChildNodes()) {
452 removeRecursive(node.firstChild);
453 node.removeChild(node.firstChild);
454 }
455 };
456 removeRecursive(this.maindiv_);
457
458 var nullOut = function(obj) {
459 for (var n in obj) {
460 if (typeof(obj[n]) === 'object') {
461 obj[n] = null;
462 }
463 }
464 };
465
466 // These may not all be necessary, but it can't hurt...
467 nullOut(this.layout_);
468 nullOut(this.plotter_);
469 nullOut(this);
470 };
471
472 /**
473 * Creates the canvas containing the PlotKit graph. Only plotkit ever draws on
474 * this particular canvas. All Dygraph work is done on this.canvas_.
475 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
476 * @return {Object} The newly-created canvas
477 * @private
478 */
479 Dygraph.prototype.createPlotKitCanvas_ = function(canvas) {
480 var h = Dygraph.createCanvas();
481 h.style.position = "absolute";
482 // TODO(danvk): h should be offset from canvas. canvas needs to include
483 // some extra area to make it easier to zoom in on the far left and far
484 // right. h needs to be precisely the plot area, so that clipping occurs.
485 h.style.top = canvas.style.top;
486 h.style.left = canvas.style.left;
487 h.width = this.width_;
488 h.height = this.height_;
489 h.style.width = this.width_ + "px"; // for IE
490 h.style.height = this.height_ + "px"; // for IE
491 return h;
492 };
493
494 // Taken from MochiKit.Color
495 Dygraph.hsvToRGB = function (hue, saturation, value) {
496 var red;
497 var green;
498 var blue;
499 if (saturation === 0) {
500 red = value;
501 green = value;
502 blue = value;
503 } else {
504 var i = Math.floor(hue * 6);
505 var f = (hue * 6) - i;
506 var p = value * (1 - saturation);
507 var q = value * (1 - (saturation * f));
508 var t = value * (1 - (saturation * (1 - f)));
509 switch (i) {
510 case 1: red = q; green = value; blue = p; break;
511 case 2: red = p; green = value; blue = t; break;
512 case 3: red = p; green = q; blue = value; break;
513 case 4: red = t; green = p; blue = value; break;
514 case 5: red = value; green = p; blue = q; break;
515 case 6: // fall through
516 case 0: red = value; green = t; blue = p; break;
517 }
518 }
519 red = Math.floor(255 * red + 0.5);
520 green = Math.floor(255 * green + 0.5);
521 blue = Math.floor(255 * blue + 0.5);
522 return 'rgb(' + red + ',' + green + ',' + blue + ')';
523 };
524
525
526 /**
527 * Generate a set of distinct colors for the data series. This is done with a
528 * color wheel. Saturation/Value are customizable, and the hue is
529 * equally-spaced around the color wheel. If a custom set of colors is
530 * specified, that is used instead.
531 * @private
532 */
533 Dygraph.prototype.setColors_ = function() {
534 // TODO(danvk): compute this directly into this.attrs_['colorScheme'] and do
535 // away with this.renderOptions_.
536 var num = this.attr_("labels").length - 1;
537 this.colors_ = [];
538 var colors = this.attr_('colors');
539 if (!colors) {
540 var sat = this.attr_('colorSaturation') || 1.0;
541 var val = this.attr_('colorValue') || 0.5;
542 var half = Math.ceil(num / 2);
543 for (var i = 1; i <= num; i++) {
544 if (!this.visibility()[i-1]) continue;
545 // alternate colors for high contrast.
546 var idx = i % 2 ? Math.ceil(i / 2) : (half + i / 2);
547 var hue = (1.0 * idx/ (1 + num));
548 this.colors_.push(Dygraph.hsvToRGB(hue, sat, val));
549 }
550 } else {
551 for (var i = 0; i < num; i++) {
552 if (!this.visibility()[i]) continue;
553 var colorStr = colors[i % colors.length];
554 this.colors_.push(colorStr);
555 }
556 }
557
558 // TODO(danvk): update this w/r/t/ the new options system.
559 this.renderOptions_.colorScheme = this.colors_;
560 Dygraph.update(this.plotter_.options, this.renderOptions_);
561 Dygraph.update(this.layoutOptions_, this.user_attrs_);
562 Dygraph.update(this.layoutOptions_, this.attrs_);
563 }
564
565 /**
566 * Return the list of colors. This is either the list of colors passed in the
567 * attributes, or the autogenerated list of rgb(r,g,b) strings.
568 * @return {Array<string>} The list of colors.
569 */
570 Dygraph.prototype.getColors = function() {
571 return this.colors_;
572 };
573
574 // The following functions are from quirksmode.org with a modification for Safari from
575 // http://blog.firetree.net/2005/07/04/javascript-find-position/
576 // http://www.quirksmode.org/js/findpos.html
577 Dygraph.findPosX = function(obj) {
578 var curleft = 0;
579 if(obj.offsetParent)
580 while(1)
581 {
582 curleft += obj.offsetLeft;
583 if(!obj.offsetParent)
584 break;
585 obj = obj.offsetParent;
586 }
587 else if(obj.x)
588 curleft += obj.x;
589 return curleft;
590 };
591
592 Dygraph.findPosY = function(obj) {
593 var curtop = 0;
594 if(obj.offsetParent)
595 while(1)
596 {
597 curtop += obj.offsetTop;
598 if(!obj.offsetParent)
599 break;
600 obj = obj.offsetParent;
601 }
602 else if(obj.y)
603 curtop += obj.y;
604 return curtop;
605 };
606
607
608
609 /**
610 * Create the div that contains information on the selected point(s)
611 * This goes in the top right of the canvas, unless an external div has already
612 * been specified.
613 * @private
614 */
615 Dygraph.prototype.createStatusMessage_ = function(){
616 if (!this.attr_("labelsDiv")) {
617 var divWidth = this.attr_('labelsDivWidth');
618 var messagestyle = {
619 "position": "absolute",
620 "fontSize": "14px",
621 "zIndex": 10,
622 "width": divWidth + "px",
623 "top": "0px",
624 "left": (this.width_ - divWidth - 2) + "px",
625 "background": "white",
626 "textAlign": "left",
627 "overflow": "hidden"};
628 Dygraph.update(messagestyle, this.attr_('labelsDivStyles'));
629 var div = document.createElement("div");
630 for (var name in messagestyle) {
631 if (messagestyle.hasOwnProperty(name)) {
632 div.style[name] = messagestyle[name];
633 }
634 }
635 this.graphDiv.appendChild(div);
636 this.attrs_.labelsDiv = div;
637 }
638 };
639
640 /**
641 * Create the text box to adjust the averaging period
642 * @return {Object} The newly-created text box
643 * @private
644 */
645 Dygraph.prototype.createRollInterface_ = function() {
646 var display = this.attr_('showRoller') ? "block" : "none";
647 var textAttr = { "position": "absolute",
648 "zIndex": 10,
649 "top": (this.plotter_.area.h - 25) + "px",
650 "left": (this.plotter_.area.x + 1) + "px",
651 "display": display
652 };
653 var roller = document.createElement("input");
654 roller.type = "text";
655 roller.size = "2";
656 roller.value = this.rollPeriod_;
657 for (var name in textAttr) {
658 if (textAttr.hasOwnProperty(name)) {
659 roller.style[name] = textAttr[name];
660 }
661 }
662
663 var pa = this.graphDiv;
664 pa.appendChild(roller);
665 var dygraph = this;
666 roller.onchange = function() { dygraph.adjustRoll(roller.value); };
667 return roller;
668 };
669
670 // These functions are taken from MochiKit.Signal
671 Dygraph.pageX = function(e) {
672 if (e.pageX) {
673 return (!e.pageX || e.pageX < 0) ? 0 : e.pageX;
674 } else {
675 var de = document;
676 var b = document.body;
677 return e.clientX +
678 (de.scrollLeft || b.scrollLeft) -
679 (de.clientLeft || 0);
680 }
681 };
682
683 Dygraph.pageY = function(e) {
684 if (e.pageY) {
685 return (!e.pageY || e.pageY < 0) ? 0 : e.pageY;
686 } else {
687 var de = document;
688 var b = document.body;
689 return e.clientY +
690 (de.scrollTop || b.scrollTop) -
691 (de.clientTop || 0);
692 }
693 };
694
695 /**
696 * Set up all the mouse handlers needed to capture dragging behavior for zoom
697 * events.
698 * @private
699 */
700 Dygraph.prototype.createDragInterface_ = function() {
701 var self = this;
702
703 // Tracks whether the mouse is down right now
704 var isZooming = false;
705 var isPanning = false;
706 var dragStartX = null;
707 var dragStartY = null;
708 var dragEndX = null;
709 var dragEndY = null;
710 var prevEndX = null;
711 var draggingDate = null;
712 var dateRange = null;
713
714 // Utility function to convert page-wide coordinates to canvas coords
715 var px = 0;
716 var py = 0;
717 var getX = function(e) { return Dygraph.pageX(e) - px };
718 var getY = function(e) { return Dygraph.pageX(e) - py };
719
720 // Draw zoom rectangles when the mouse is down and the user moves around
721 Dygraph.addEvent(this.mouseEventElement_, 'mousemove', function(event) {
722 if (isZooming) {
723 dragEndX = getX(event);
724 dragEndY = getY(event);
725
726 self.drawZoomRect_(dragStartX, dragEndX, prevEndX);
727 prevEndX = dragEndX;
728 } else if (isPanning) {
729 dragEndX = getX(event);
730 dragEndY = getY(event);
731
732 // Want to have it so that:
733 // 1. draggingDate appears at dragEndX
734 // 2. daterange = (dateWindow_[1] - dateWindow_[0]) is unaltered.
735
736 self.dateWindow_[0] = draggingDate - (dragEndX / self.width_) * dateRange;
737 self.dateWindow_[1] = self.dateWindow_[0] + dateRange;
738 self.drawGraph_(self.rawData_);
739 }
740 });
741
742 // Track the beginning of drag events
743 Dygraph.addEvent(this.mouseEventElement_, 'mousedown', function(event) {
744 px = Dygraph.findPosX(self.canvas_);
745 py = Dygraph.findPosY(self.canvas_);
746 dragStartX = getX(event);
747 dragStartY = getY(event);
748
749 if (event.altKey || event.shiftKey) {
750 if (!self.dateWindow_) return; // have to be zoomed in to pan.
751 isPanning = true;
752 dateRange = self.dateWindow_[1] - self.dateWindow_[0];
753 draggingDate = (dragStartX / self.width_) * dateRange +
754 self.dateWindow_[0];
755 } else {
756 isZooming = true;
757 }
758 });
759
760 // If the user releases the mouse button during a drag, but not over the
761 // canvas, then it doesn't count as a zooming action.
762 Dygraph.addEvent(document, 'mouseup', function(event) {
763 if (isZooming || isPanning) {
764 isZooming = false;
765 dragStartX = null;
766 dragStartY = null;
767 }
768
769 if (isPanning) {
770 isPanning = false;
771 draggingDate = null;
772 dateRange = null;
773 }
774 });
775
776 // Temporarily cancel the dragging event when the mouse leaves the graph
777 Dygraph.addEvent(this.mouseEventElement_, 'mouseout', function(event) {
778 if (isZooming) {
779 dragEndX = null;
780 dragEndY = null;
781 }
782 });
783
784 // If the mouse is released on the canvas during a drag event, then it's a
785 // zoom. Only do the zoom if it's over a large enough area (>= 10 pixels)
786 Dygraph.addEvent(this.mouseEventElement_, 'mouseup', function(event) {
787 if (isZooming) {
788 isZooming = false;
789 dragEndX = getX(event);
790 dragEndY = getY(event);
791 var regionWidth = Math.abs(dragEndX - dragStartX);
792 var regionHeight = Math.abs(dragEndY - dragStartY);
793
794 if (regionWidth < 2 && regionHeight < 2 &&
795 self.attr_('clickCallback') != null &&
796 self.lastx_ != undefined) {
797 // TODO(danvk): pass along more info about the points.
798 self.attr_('clickCallback')(event, self.lastx_, self.selPoints_);
799 }
800
801 if (regionWidth >= 10) {
802 self.doZoom_(Math.min(dragStartX, dragEndX),
803 Math.max(dragStartX, dragEndX));
804 } else {
805 self.canvas_.getContext("2d").clearRect(0, 0,
806 self.canvas_.width,
807 self.canvas_.height);
808 }
809
810 dragStartX = null;
811 dragStartY = null;
812 }
813
814 if (isPanning) {
815 isPanning = false;
816 draggingDate = null;
817 dateRange = null;
818 }
819 });
820
821 // Double-clicking zooms back out
822 Dygraph.addEvent(this.mouseEventElement_, 'dblclick', function(event) {
823 if (self.dateWindow_ == null) return;
824 self.dateWindow_ = null;
825 self.drawGraph_(self.rawData_);
826 var minDate = self.rawData_[0][0];
827 var maxDate = self.rawData_[self.rawData_.length - 1][0];
828 if (self.attr_("zoomCallback")) {
829 self.attr_("zoomCallback")(minDate, maxDate);
830 }
831 });
832 };
833
834 /**
835 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
836 * up any previous zoom rectangles that were drawn. This could be optimized to
837 * avoid extra redrawing, but it's tricky to avoid interactions with the status
838 * dots.
839 * @param {Number} startX The X position where the drag started, in canvas
840 * coordinates.
841 * @param {Number} endX The current X position of the drag, in canvas coords.
842 * @param {Number} prevEndX The value of endX on the previous call to this
843 * function. Used to avoid excess redrawing
844 * @private
845 */
846 Dygraph.prototype.drawZoomRect_ = function(startX, endX, prevEndX) {
847 var ctx = this.canvas_.getContext("2d");
848
849 // Clean up from the previous rect if necessary
850 if (prevEndX) {
851 ctx.clearRect(Math.min(startX, prevEndX), 0,
852 Math.abs(startX - prevEndX), this.height_);
853 }
854
855 // Draw a light-grey rectangle to show the new viewing area
856 if (endX && startX) {
857 ctx.fillStyle = "rgba(128,128,128,0.33)";
858 ctx.fillRect(Math.min(startX, endX), 0,
859 Math.abs(endX - startX), this.height_);
860 }
861 };
862
863 /**
864 * Zoom to something containing [lowX, highX]. These are pixel coordinates
865 * in the canvas. The exact zoom window may be slightly larger if there are no
866 * data points near lowX or highX. This function redraws the graph.
867 * @param {Number} lowX The leftmost pixel value that should be visible.
868 * @param {Number} highX The rightmost pixel value that should be visible.
869 * @private
870 */
871 Dygraph.prototype.doZoom_ = function(lowX, highX) {
872 // Find the earliest and latest dates contained in this canvasx range.
873 var r = this.toDataCoords(lowX, null);
874 var minDate = r[0];
875 r = this.toDataCoords(highX, null);
876 var maxDate = r[0];
877
878 this.dateWindow_ = [minDate, maxDate];
879 this.drawGraph_(this.rawData_);
880 if (this.attr_("zoomCallback")) {
881 this.attr_("zoomCallback")(minDate, maxDate);
882 }
883 };
884
885 /**
886 * When the mouse moves in the canvas, display information about a nearby data
887 * point and draw dots over those points in the data series. This function
888 * takes care of cleanup of previously-drawn dots.
889 * @param {Object} event The mousemove event from the browser.
890 * @private
891 */
892 Dygraph.prototype.mouseMove_ = function(event) {
893 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
894 var points = this.layout_.points;
895
896 var lastx = -1;
897 var lasty = -1;
898
899 // Loop through all the points and find the date nearest to our current
900 // location.
901 var minDist = 1e+100;
902 var idx = -1;
903 for (var i = 0; i < points.length; i++) {
904 var dist = Math.abs(points[i].canvasx - canvasx);
905 if (dist > minDist) continue;
906 minDist = dist;
907 idx = i;
908 }
909 if (idx >= 0) lastx = points[idx].xval;
910 // Check that you can really highlight the last day's data
911 if (canvasx > points[points.length-1].canvasx)
912 lastx = points[points.length-1].xval;
913
914 // Extract the points we've selected
915 this.selPoints_ = [];
916 var l = points.length;
917 if (!this.attr_("stackedGraph")) {
918 for (var i = 0; i < l; i++) {
919 if (points[i].xval == lastx) {
920 this.selPoints_.push(points[i]);
921 }
922 }
923 } else {
924 // Need to 'unstack' points starting from the bottom
925 var cumulative_sum = 0;
926 for (var i = l - 1; i >= 0; i--) {
927 if (points[i].xval == lastx) {
928 var p = {}; // Clone the point since we modify it
929 for (var k in points[i]) {
930 p[k] = points[i][k];
931 }
932 p.yval -= cumulative_sum;
933 cumulative_sum += p.yval;
934 this.selPoints_.push(p);
935 }
936 }
937 this.selPoints_.reverse();
938 }
939
940 if (this.attr_("highlightCallback")) {
941 var px = this.lastx_;
942 if (px !== null && lastx != px) {
943 // only fire if the selected point has changed.
944 this.attr_("highlightCallback")(event, lastx, this.selPoints_);
945 }
946 }
947
948 // Save last x position for callbacks.
949 this.lastx_ = lastx;
950
951 this.updateSelection_();
952 };
953
954 /**
955 * Draw dots over the selectied points in the data series. This function
956 * takes care of cleanup of previously-drawn dots.
957 * @private
958 */
959 Dygraph.prototype.updateSelection_ = function() {
960 // Clear the previously drawn vertical, if there is one
961 var circleSize = this.attr_('highlightCircleSize');
962 var ctx = this.canvas_.getContext("2d");
963 if (this.previousVerticalX_ >= 0) {
964 var px = this.previousVerticalX_;
965 ctx.clearRect(px - circleSize - 1, 0, 2 * circleSize + 2, this.height_);
966 }
967
968 var isOK = function(x) { return x && !isNaN(x); };
969
970 if (this.selPoints_.length > 0) {
971 var canvasx = this.selPoints_[0].canvasx;
972
973 // Set the status message to indicate the selected point(s)
974 var replace = this.attr_('xValueFormatter')(this.lastx_, this) + ":";
975 var fmtFunc = this.attr_('yValueFormatter');
976 var clen = this.colors_.length;
977
978 if (this.attr_('showLabelsOnHighlight')) {
979 // Set the status message to indicate the selected point(s)
980 for (var i = 0; i < this.selPoints_.length; i++) {
981 if (!isOK(this.selPoints_[i].canvasy)) continue;
982 if (this.attr_("labelsSeparateLines")) {
983 replace += "<br/>";
984 }
985 var point = this.selPoints_[i];
986 var c = new RGBColor(this.colors_[i%clen]);
987 var yval = fmtFunc(point.yval);
988 replace += " <b><font color='" + c.toHex() + "'>"
989 + point.name + "</font></b>:"
990 + yval;
991 }
992
993 this.attr_("labelsDiv").innerHTML = replace;
994 }
995
996 // Draw colored circles over the center of each selected point
997 ctx.save();
998 for (var i = 0; i < this.selPoints_.length; i++) {
999 if (!isOK(this.selPoints_[i].canvasy)) continue;
1000 ctx.beginPath();
1001 ctx.fillStyle = this.plotter_.colors[this.selPoints_[i].name];
1002 ctx.arc(canvasx, this.selPoints_[i].canvasy, circleSize,
1003 0, 2 * Math.PI, false);
1004 ctx.fill();
1005 }
1006 ctx.restore();
1007
1008 this.previousVerticalX_ = canvasx;
1009 }
1010 };
1011
1012 /**
1013 * Set manually set selected dots, and display information about them
1014 * @param int row number that should by highlighted
1015 * false value clears the selection
1016 * @public
1017 */
1018 Dygraph.prototype.setSelection = function(row) {
1019 // Extract the points we've selected
1020 this.selPoints_ = [];
1021 var pos = 0;
1022
1023 if (row !== false) {
1024 row = row-this.boundaryIds_[0][0];
1025 }
1026
1027 if (row !== false && row >= 0) {
1028 for (var i in this.layout_.datasets) {
1029 if (row < this.layout_.datasets[i].length) {
1030 this.selPoints_.push(this.layout_.points[pos+row]);
1031 }
1032 pos += this.layout_.datasets[i].length;
1033 }
1034 }
1035
1036 if (this.selPoints_.length) {
1037 this.lastx_ = this.selPoints_[0].xval;
1038 this.updateSelection_();
1039 } else {
1040 this.lastx_ = -1;
1041 this.clearSelection();
1042 }
1043
1044 };
1045
1046 /**
1047 * The mouse has left the canvas. Clear out whatever artifacts remain
1048 * @param {Object} event the mouseout event from the browser.
1049 * @private
1050 */
1051 Dygraph.prototype.mouseOut_ = function(event) {
1052 if (this.attr_("unhighlightCallback")) {
1053 this.attr_("unhighlightCallback")(event);
1054 }
1055
1056 if (this.attr_("hideOverlayOnMouseOut")) {
1057 this.clearSelection();
1058 }
1059 };
1060
1061 /**
1062 * Remove all selection from the canvas
1063 * @public
1064 */
1065 Dygraph.prototype.clearSelection = function() {
1066 // Get rid of the overlay data
1067 var ctx = this.canvas_.getContext("2d");
1068 ctx.clearRect(0, 0, this.width_, this.height_);
1069 this.attr_("labelsDiv").innerHTML = "";
1070 this.selPoints_ = [];
1071 this.lastx_ = -1;
1072 }
1073
1074 /**
1075 * Returns the number of the currently selected row
1076 * @return int row number, of -1 if nothing is selected
1077 * @public
1078 */
1079 Dygraph.prototype.getSelection = function() {
1080 if (!this.selPoints_ || this.selPoints_.length < 1) {
1081 return -1;
1082 }
1083
1084 for (var row=0; row<this.layout_.points.length; row++ ) {
1085 if (this.layout_.points[row].x == this.selPoints_[0].x) {
1086 return row + this.boundaryIds_[0][0];
1087 }
1088 }
1089 return -1;
1090 }
1091
1092 Dygraph.zeropad = function(x) {
1093 if (x < 10) return "0" + x; else return "" + x;
1094 }
1095
1096 /**
1097 * Return a string version of the hours, minutes and seconds portion of a date.
1098 * @param {Number} date The JavaScript date (ms since epoch)
1099 * @return {String} A time of the form "HH:MM:SS"
1100 * @private
1101 */
1102 Dygraph.hmsString_ = function(date) {
1103 var zeropad = Dygraph.zeropad;
1104 var d = new Date(date);
1105 if (d.getSeconds()) {
1106 return zeropad(d.getHours()) + ":" +
1107 zeropad(d.getMinutes()) + ":" +
1108 zeropad(d.getSeconds());
1109 } else {
1110 return zeropad(d.getHours()) + ":" + zeropad(d.getMinutes());
1111 }
1112 }
1113
1114 /**
1115 * Convert a JS date to a string appropriate to display on an axis that
1116 * is displaying values at the stated granularity.
1117 * @param {Date} date The date to format
1118 * @param {Number} granularity One of the Dygraph granularity constants
1119 * @return {String} The formatted date
1120 * @private
1121 */
1122 Dygraph.dateAxisFormatter = function(date, granularity) {
1123 if (granularity >= Dygraph.MONTHLY) {
1124 return date.strftime('%b %y');
1125 } else {
1126 var frac = date.getHours() * 3600 + date.getMinutes() * 60 + date.getSeconds() + date.getMilliseconds();
1127 if (frac == 0 || granularity >= Dygraph.DAILY) {
1128 return new Date(date.getTime() + 3600*1000).strftime('%d%b');
1129 } else {
1130 return Dygraph.hmsString_(date.getTime());
1131 }
1132 }
1133 }
1134
1135 /**
1136 * Convert a JS date (millis since epoch) to YYYY/MM/DD
1137 * @param {Number} date The JavaScript date (ms since epoch)
1138 * @return {String} A date of the form "YYYY/MM/DD"
1139 * @private
1140 */
1141 Dygraph.dateString_ = function(date, self) {
1142 var zeropad = Dygraph.zeropad;
1143 var d = new Date(date);
1144
1145 // Get the year:
1146 var year = "" + d.getFullYear();
1147 // Get a 0 padded month string
1148 var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh
1149 // Get a 0 padded day string
1150 var day = zeropad(d.getDate());
1151
1152 var ret = "";
1153 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
1154 if (frac) ret = " " + Dygraph.hmsString_(date);
1155
1156 return year + "/" + month + "/" + day + ret;
1157 };
1158
1159 /**
1160 * Round a number to the specified number of digits past the decimal point.
1161 * @param {Number} num The number to round
1162 * @param {Number} places The number of decimals to which to round
1163 * @return {Number} The rounded number
1164 * @private
1165 */
1166 Dygraph.round_ = function(num, places) {
1167 var shift = Math.pow(10, places);
1168 return Math.round(num * shift)/shift;
1169 };
1170
1171 /**
1172 * Fires when there's data available to be graphed.
1173 * @param {String} data Raw CSV data to be plotted
1174 * @private
1175 */
1176 Dygraph.prototype.loadedEvent_ = function(data) {
1177 this.rawData_ = this.parseCSV_(data);
1178 this.drawGraph_(this.rawData_);
1179 };
1180
1181 Dygraph.prototype.months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
1182 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
1183 Dygraph.prototype.quarters = ["Jan", "Apr", "Jul", "Oct"];
1184
1185 /**
1186 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1187 * @private
1188 */
1189 Dygraph.prototype.addXTicks_ = function() {
1190 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1191 var startDate, endDate;
1192 if (this.dateWindow_) {
1193 startDate = this.dateWindow_[0];
1194 endDate = this.dateWindow_[1];
1195 } else {
1196 startDate = this.rawData_[0][0];
1197 endDate = this.rawData_[this.rawData_.length - 1][0];
1198 }
1199
1200 var xTicks = this.attr_('xTicker')(startDate, endDate, this);
1201 this.layout_.updateOptions({xTicks: xTicks});
1202 };
1203
1204 // Time granularity enumeration
1205 Dygraph.SECONDLY = 0;
1206 Dygraph.TWO_SECONDLY = 1;
1207 Dygraph.FIVE_SECONDLY = 2;
1208 Dygraph.TEN_SECONDLY = 3;
1209 Dygraph.THIRTY_SECONDLY = 4;
1210 Dygraph.MINUTELY = 5;
1211 Dygraph.TWO_MINUTELY = 6;
1212 Dygraph.FIVE_MINUTELY = 7;
1213 Dygraph.TEN_MINUTELY = 8;
1214 Dygraph.THIRTY_MINUTELY = 9;
1215 Dygraph.HOURLY = 10;
1216 Dygraph.TWO_HOURLY = 11;
1217 Dygraph.SIX_HOURLY = 12;
1218 Dygraph.DAILY = 13;
1219 Dygraph.WEEKLY = 14;
1220 Dygraph.MONTHLY = 15;
1221 Dygraph.QUARTERLY = 16;
1222 Dygraph.BIANNUAL = 17;
1223 Dygraph.ANNUAL = 18;
1224 Dygraph.DECADAL = 19;
1225 Dygraph.NUM_GRANULARITIES = 20;
1226
1227 Dygraph.SHORT_SPACINGS = [];
1228 Dygraph.SHORT_SPACINGS[Dygraph.SECONDLY] = 1000 * 1;
1229 Dygraph.SHORT_SPACINGS[Dygraph.TWO_SECONDLY] = 1000 * 2;
1230 Dygraph.SHORT_SPACINGS[Dygraph.FIVE_SECONDLY] = 1000 * 5;
1231 Dygraph.SHORT_SPACINGS[Dygraph.TEN_SECONDLY] = 1000 * 10;
1232 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_SECONDLY] = 1000 * 30;
1233 Dygraph.SHORT_SPACINGS[Dygraph.MINUTELY] = 1000 * 60;
1234 Dygraph.SHORT_SPACINGS[Dygraph.TWO_MINUTELY] = 1000 * 60 * 2;
1235 Dygraph.SHORT_SPACINGS[Dygraph.FIVE_MINUTELY] = 1000 * 60 * 5;
1236 Dygraph.SHORT_SPACINGS[Dygraph.TEN_MINUTELY] = 1000 * 60 * 10;
1237 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_MINUTELY] = 1000 * 60 * 30;
1238 Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600;
1239 Dygraph.SHORT_SPACINGS[Dygraph.TWO_HOURLY] = 1000 * 3600 * 2;
1240 Dygraph.SHORT_SPACINGS[Dygraph.SIX_HOURLY] = 1000 * 3600 * 6;
1241 Dygraph.SHORT_SPACINGS[Dygraph.DAILY] = 1000 * 86400;
1242 Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY] = 1000 * 604800;
1243
1244 // NumXTicks()
1245 //
1246 // If we used this time granularity, how many ticks would there be?
1247 // This is only an approximation, but it's generally good enough.
1248 //
1249 Dygraph.prototype.NumXTicks = function(start_time, end_time, granularity) {
1250 if (granularity < Dygraph.MONTHLY) {
1251 // Generate one tick mark for every fixed interval of time.
1252 var spacing = Dygraph.SHORT_SPACINGS[granularity];
1253 return Math.floor(0.5 + 1.0 * (end_time - start_time) / spacing);
1254 } else {
1255 var year_mod = 1; // e.g. to only print one point every 10 years.
1256 var num_months = 12;
1257 if (granularity == Dygraph.QUARTERLY) num_months = 3;
1258 if (granularity == Dygraph.BIANNUAL) num_months = 2;
1259 if (granularity == Dygraph.ANNUAL) num_months = 1;
1260 if (granularity == Dygraph.DECADAL) { num_months = 1; year_mod = 10; }
1261
1262 var msInYear = 365.2524 * 24 * 3600 * 1000;
1263 var num_years = 1.0 * (end_time - start_time) / msInYear;
1264 return Math.floor(0.5 + 1.0 * num_years * num_months / year_mod);
1265 }
1266 };
1267
1268 // GetXAxis()
1269 //
1270 // Construct an x-axis of nicely-formatted times on meaningful boundaries
1271 // (e.g. 'Jan 09' rather than 'Jan 22, 2009').
1272 //
1273 // Returns an array containing {v: millis, label: label} dictionaries.
1274 //
1275 Dygraph.prototype.GetXAxis = function(start_time, end_time, granularity) {
1276 var formatter = this.attr_("xAxisLabelFormatter");
1277 var ticks = [];
1278 if (granularity < Dygraph.MONTHLY) {
1279 // Generate one tick mark for every fixed interval of time.
1280 var spacing = Dygraph.SHORT_SPACINGS[granularity];
1281 var format = '%d%b'; // e.g. "1Jan"
1282
1283 // Find a time less than start_time which occurs on a "nice" time boundary
1284 // for this granularity.
1285 var g = spacing / 1000;
1286 var d = new Date(start_time);
1287 if (g <= 60) { // seconds
1288 var x = d.getSeconds(); d.setSeconds(x - x % g);
1289 } else {
1290 d.setSeconds(0);
1291 g /= 60;
1292 if (g <= 60) { // minutes
1293 var x = d.getMinutes(); d.setMinutes(x - x % g);
1294 } else {
1295 d.setMinutes(0);
1296 g /= 60;
1297
1298 if (g <= 24) { // days
1299 var x = d.getHours(); d.setHours(x - x % g);
1300 } else {
1301 d.setHours(0);
1302 g /= 24;
1303
1304 if (g == 7) { // one week
1305 d.setDate(d.getDate() - d.getDay());
1306 }
1307 }
1308 }
1309 }
1310 start_time = d.getTime();
1311
1312 for (var t = start_time; t <= end_time; t += spacing) {
1313 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
1314 }
1315 } else {
1316 // Display a tick mark on the first of a set of months of each year.
1317 // Years get a tick mark iff y % year_mod == 0. This is useful for
1318 // displaying a tick mark once every 10 years, say, on long time scales.
1319 var months;
1320 var year_mod = 1; // e.g. to only print one point every 10 years.
1321
1322 if (granularity == Dygraph.MONTHLY) {
1323 months = [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
1324 } else if (granularity == Dygraph.QUARTERLY) {
1325 months = [ 0, 3, 6, 9 ];
1326 } else if (granularity == Dygraph.BIANNUAL) {
1327 months = [ 0, 6 ];
1328 } else if (granularity == Dygraph.ANNUAL) {
1329 months = [ 0 ];
1330 } else if (granularity == Dygraph.DECADAL) {
1331 months = [ 0 ];
1332 year_mod = 10;
1333 }
1334
1335 var start_year = new Date(start_time).getFullYear();
1336 var end_year = new Date(end_time).getFullYear();
1337 var zeropad = Dygraph.zeropad;
1338 for (var i = start_year; i <= end_year; i++) {
1339 if (i % year_mod != 0) continue;
1340 for (var j = 0; j < months.length; j++) {
1341 var date_str = i + "/" + zeropad(1 + months[j]) + "/01";
1342 var t = Date.parse(date_str);
1343 if (t < start_time || t > end_time) continue;
1344 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
1345 }
1346 }
1347 }
1348
1349 return ticks;
1350 };
1351
1352
1353 /**
1354 * Add ticks to the x-axis based on a date range.
1355 * @param {Number} startDate Start of the date window (millis since epoch)
1356 * @param {Number} endDate End of the date window (millis since epoch)
1357 * @return {Array.<Object>} Array of {label, value} tuples.
1358 * @public
1359 */
1360 Dygraph.dateTicker = function(startDate, endDate, self) {
1361 var chosen = -1;
1362 for (var i = 0; i < Dygraph.NUM_GRANULARITIES; i++) {
1363 var num_ticks = self.NumXTicks(startDate, endDate, i);
1364 if (self.width_ / num_ticks >= self.attr_('pixelsPerXLabel')) {
1365 chosen = i;
1366 break;
1367 }
1368 }
1369
1370 if (chosen >= 0) {
1371 return self.GetXAxis(startDate, endDate, chosen);
1372 } else {
1373 // TODO(danvk): signal error.
1374 }
1375 };
1376
1377 /**
1378 * Add ticks when the x axis has numbers on it (instead of dates)
1379 * @param {Number} startDate Start of the date window (millis since epoch)
1380 * @param {Number} endDate End of the date window (millis since epoch)
1381 * @param self
1382 * @param {function} formatter: Optional formatter to use for each tick value
1383 * @return {Array.<Object>} Array of {label, value} tuples.
1384 * @public
1385 */
1386 Dygraph.numericTicks = function(minV, maxV, self, formatter) {
1387 // Basic idea:
1388 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
1389 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks).
1390 // The first spacing greater than pixelsPerYLabel is what we use.
1391 // TODO(danvk): version that works on a log scale.
1392 if (self.attr_("labelsKMG2")) {
1393 var mults = [1, 2, 4, 8];
1394 } else {
1395 var mults = [1, 2, 5];
1396 }
1397 var scale, low_val, high_val, nTicks;
1398 // TODO(danvk): make it possible to set this for x- and y-axes independently.
1399 var pixelsPerTick = self.attr_('pixelsPerYLabel');
1400 for (var i = -10; i < 50; i++) {
1401 if (self.attr_("labelsKMG2")) {
1402 var base_scale = Math.pow(16, i);
1403 } else {
1404 var base_scale = Math.pow(10, i);
1405 }
1406 for (var j = 0; j < mults.length; j++) {
1407 scale = base_scale * mults[j];
1408 low_val = Math.floor(minV / scale) * scale;
1409 high_val = Math.ceil(maxV / scale) * scale;
1410 nTicks = Math.abs(high_val - low_val) / scale;
1411 var spacing = self.height_ / nTicks;
1412 // wish I could break out of both loops at once...
1413 if (spacing > pixelsPerTick) break;
1414 }
1415 if (spacing > pixelsPerTick) break;
1416 }
1417
1418 // Construct labels for the ticks
1419 var ticks = [];
1420 var k;
1421 var k_labels = [];
1422 if (self.attr_("labelsKMB")) {
1423 k = 1000;
1424 k_labels = [ "K", "M", "B", "T" ];
1425 }
1426 if (self.attr_("labelsKMG2")) {
1427 if (k) self.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
1428 k = 1024;
1429 k_labels = [ "k", "M", "G", "T" ];
1430 }
1431
1432 // Allow reverse y-axis if it's explicitly requested.
1433 if (low_val > high_val) scale *= -1;
1434
1435 for (var i = 0; i < nTicks; i++) {
1436 var tickV = low_val + i * scale;
1437 var absTickV = Math.abs(tickV);
1438 var label;
1439 if (formatter != undefined) {
1440 label = formatter(tickV);
1441 } else {
1442 label = Dygraph.round_(tickV, 2);
1443 }
1444 if (k_labels.length) {
1445 // Round up to an appropriate unit.
1446 var n = k*k*k*k;
1447 for (var j = 3; j >= 0; j--, n /= k) {
1448 if (absTickV >= n) {
1449 label = Dygraph.round_(tickV / n, 1) + k_labels[j];
1450 break;
1451 }
1452 }
1453 }
1454 ticks.push( {label: label, v: tickV} );
1455 }
1456 return ticks;
1457 };
1458
1459 /**
1460 * Adds appropriate ticks on the y-axis
1461 * @param {Number} minY The minimum Y value in the data set
1462 * @param {Number} maxY The maximum Y value in the data set
1463 * @private
1464 */
1465 Dygraph.prototype.addYTicks_ = function(minY, maxY) {
1466 // Set the number of ticks so that the labels are human-friendly.
1467 // TODO(danvk): make this an attribute as well.
1468 var formatter = this.attr_('yAxisLabelFormatter') ? this.attr_('yAxisLabelFormatter') : this.attr_('yValueFormatter');
1469 var ticks = Dygraph.numericTicks(minY, maxY, this, formatter);
1470 this.layout_.updateOptions( { yAxis: [minY, maxY],
1471 yTicks: ticks } );
1472 };
1473
1474 // Computes the range of the data series (including confidence intervals).
1475 // series is either [ [x1, y1], [x2, y2], ... ] or
1476 // [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
1477 // Returns [low, high]
1478 Dygraph.prototype.extremeValues_ = function(series) {
1479 var minY = null, maxY = null;
1480
1481 var bars = this.attr_("errorBars") || this.attr_("customBars");
1482 if (bars) {
1483 // With custom bars, maxY is the max of the high values.
1484 for (var j = 0; j < series.length; j++) {
1485 var y = series[j][1][0];
1486 if (!y) continue;
1487 var low = y - series[j][1][1];
1488 var high = y + series[j][1][2];
1489 if (low > y) low = y; // this can happen with custom bars,
1490 if (high < y) high = y; // e.g. in tests/custom-bars.html
1491 if (maxY == null || high > maxY) {
1492 maxY = high;
1493 }
1494 if (minY == null || low < minY) {
1495 minY = low;
1496 }
1497 }
1498 } else {
1499 for (var j = 0; j < series.length; j++) {
1500 var y = series[j][1];
1501 if (y === null || isNaN(y)) continue;
1502 if (maxY == null || y > maxY) {
1503 maxY = y;
1504 }
1505 if (minY == null || y < minY) {
1506 minY = y;
1507 }
1508 }
1509 }
1510
1511 return [minY, maxY];
1512 };
1513
1514 /**
1515 * Update the graph with new data. Data is in the format
1516 * [ [date1, val1, val2, ...], [date2, val1, val2, ...] if errorBars=false
1517 * or, if errorBars=true,
1518 * [ [date1, [val1,stddev1], [val2,stddev2], ...], [date2, ...], ...]
1519 * @param {Array.<Object>} data The data (see above)
1520 * @private
1521 */
1522 Dygraph.prototype.drawGraph_ = function(data) {
1523 // This is used to set the second parameter to drawCallback, below.
1524 var is_initial_draw = this.is_initial_draw_;
1525 this.is_initial_draw_ = false;
1526
1527 var minY = null, maxY = null;
1528 this.layout_.removeAllDatasets();
1529 this.setColors_();
1530 this.attrs_['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
1531
1532 var connectSeparatedPoints = this.attr_('connectSeparatedPoints');
1533
1534 // Loop over the fields (series). Go from the last to the first,
1535 // because if they're stacked that's how we accumulate the values.
1536
1537 var cumulative_y = []; // For stacked series.
1538 var datasets = [];
1539
1540 // Loop over all fields and create datasets
1541 for (var i = data[0].length - 1; i >= 1; i--) {
1542 if (!this.visibility()[i - 1]) continue;
1543
1544 var series = [];
1545 for (var j = 0; j < data.length; j++) {
1546 if (data[j][i] != null || !connectSeparatedPoints) {
1547 var date = data[j][0];
1548 series.push([date, data[j][i]]);
1549 }
1550 }
1551 series = this.rollingAverage(series, this.rollPeriod_);
1552
1553 // Prune down to the desired range, if necessary (for zooming)
1554 // Because there can be lines going to points outside of the visible area,
1555 // we actually prune to visible points, plus one on either side.
1556 var bars = this.attr_("errorBars") || this.attr_("customBars");
1557 if (this.dateWindow_) {
1558 var low = this.dateWindow_[0];
1559 var high= this.dateWindow_[1];
1560 var pruned = [];
1561 // TODO(danvk): do binary search instead of linear search.
1562 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
1563 var firstIdx = null, lastIdx = null;
1564 for (var k = 0; k < series.length; k++) {
1565 if (series[k][0] >= low && firstIdx === null) {
1566 firstIdx = k;
1567 }
1568 if (series[k][0] <= high) {
1569 lastIdx = k;
1570 }
1571 }
1572 if (firstIdx === null) firstIdx = 0;
1573 if (firstIdx > 0) firstIdx--;
1574 if (lastIdx === null) lastIdx = series.length - 1;
1575 if (lastIdx < series.length - 1) lastIdx++;
1576 this.boundaryIds_[i-1] = [firstIdx, lastIdx];
1577 for (var k = firstIdx; k <= lastIdx; k++) {
1578 pruned.push(series[k]);
1579 }
1580 series = pruned;
1581 } else {
1582 this.boundaryIds_[i-1] = [0, series.length-1];
1583 }
1584
1585 var extremes = this.extremeValues_(series);
1586 var thisMinY = extremes[0];
1587 var thisMaxY = extremes[1];
1588 if (minY === null || thisMinY < minY) minY = thisMinY;
1589 if (maxY === null || thisMaxY > maxY) maxY = thisMaxY;
1590
1591 if (bars) {
1592 for (var j=0; j<series.length; j++) {
1593 val = [series[j][0], series[j][1][0], series[j][1][1], series[j][1][2]];
1594 series[j] = val;
1595 }
1596 } else if (this.attr_("stackedGraph")) {
1597 var l = series.length;
1598 var actual_y;
1599 for (var j = 0; j < l; j++) {
1600 // If one data set has a NaN, let all subsequent stacked
1601 // sets inherit the NaN -- only start at 0 for the first set.
1602 var x = series[j][0];
1603 if (cumulative_y[x] === undefined)
1604 cumulative_y[x] = 0;
1605
1606 actual_y = series[j][1];
1607 cumulative_y[x] += actual_y;
1608
1609 series[j] = [x, cumulative_y[x]]
1610
1611 if (!maxY || cumulative_y[x] > maxY)
1612 maxY = cumulative_y[x];
1613 }
1614 }
1615
1616 datasets[i] = series;
1617 }
1618
1619 for (var i = 1; i < datasets.length; i++) {
1620 this.layout_.addDataset(this.attr_("labels")[i], datasets[i]);
1621 }
1622
1623 // Use some heuristics to come up with a good maxY value, unless it's been
1624 // set explicitly by the user.
1625 if (this.valueRange_ != null) {
1626 this.addYTicks_(this.valueRange_[0], this.valueRange_[1]);
1627 this.displayedYRange_ = this.valueRange_;
1628 } else {
1629 // This affects the calculation of span, below.
1630 if (this.attr_("includeZero") && minY > 0) {
1631 minY = 0;
1632 }
1633
1634 // Add some padding and round up to an integer to be human-friendly.
1635 var span = maxY - minY;
1636 // special case: if we have no sense of scale, use +/-10% of the sole value.
1637 if (span == 0) { span = maxY; }
1638 var maxAxisY = maxY + 0.1 * span;
1639 var minAxisY = minY - 0.1 * span;
1640
1641 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
1642 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
1643 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
1644
1645 if (this.attr_("includeZero")) {
1646 if (maxY < 0) maxAxisY = 0;
1647 if (minY > 0) minAxisY = 0;
1648 }
1649
1650 this.addYTicks_(minAxisY, maxAxisY);
1651 this.displayedYRange_ = [minAxisY, maxAxisY];
1652 }
1653
1654 this.addXTicks_();
1655
1656 // Tell PlotKit to use this new data and render itself
1657 this.layout_.updateOptions({dateWindow: this.dateWindow_});
1658 this.layout_.evaluateWithError();
1659 this.plotter_.clear();
1660 this.plotter_.render();
1661 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
1662 this.canvas_.height);
1663
1664 if (this.attr_("drawCallback") !== null) {
1665 this.attr_("drawCallback")(this, is_initial_draw);
1666 }
1667 };
1668
1669 /**
1670 * Calculates the rolling average of a data set.
1671 * If originalData is [label, val], rolls the average of those.
1672 * If originalData is [label, [, it's interpreted as [value, stddev]
1673 * and the roll is returned in the same form, with appropriately reduced
1674 * stddev for each value.
1675 * Note that this is where fractional input (i.e. '5/10') is converted into
1676 * decimal values.
1677 * @param {Array} originalData The data in the appropriate format (see above)
1678 * @param {Number} rollPeriod The number of days over which to average the data
1679 */
1680 Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
1681 if (originalData.length < 2)
1682 return originalData;
1683 var rollPeriod = Math.min(rollPeriod, originalData.length - 1);
1684 var rollingData = [];
1685 var sigma = this.attr_("sigma");
1686
1687 if (this.fractions_) {
1688 var num = 0;
1689 var den = 0; // numerator/denominator
1690 var mult = 100.0;
1691 for (var i = 0; i < originalData.length; i++) {
1692 num += originalData[i][1][0];
1693 den += originalData[i][1][1];
1694 if (i - rollPeriod >= 0) {
1695 num -= originalData[i - rollPeriod][1][0];
1696 den -= originalData[i - rollPeriod][1][1];
1697 }
1698
1699 var date = originalData[i][0];
1700 var value = den ? num / den : 0.0;
1701 if (this.attr_("errorBars")) {
1702 if (this.wilsonInterval_) {
1703 // For more details on this confidence interval, see:
1704 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
1705 if (den) {
1706 var p = value < 0 ? 0 : value, n = den;
1707 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
1708 var denom = 1 + sigma * sigma / den;
1709 var low = (p + sigma * sigma / (2 * den) - pm) / denom;
1710 var high = (p + sigma * sigma / (2 * den) + pm) / denom;
1711 rollingData[i] = [date,
1712 [p * mult, (p - low) * mult, (high - p) * mult]];
1713 } else {
1714 rollingData[i] = [date, [0, 0, 0]];
1715 }
1716 } else {
1717 var stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
1718 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
1719 }
1720 } else {
1721 rollingData[i] = [date, mult * value];
1722 }
1723 }
1724 } else if (this.attr_("customBars")) {
1725 var low = 0;
1726 var mid = 0;
1727 var high = 0;
1728 var count = 0;
1729 for (var i = 0; i < originalData.length; i++) {
1730 var data = originalData[i][1];
1731 var y = data[1];
1732 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
1733
1734 if (y != null && !isNaN(y)) {
1735 low += data[0];
1736 mid += y;
1737 high += data[2];
1738 count += 1;
1739 }
1740 if (i - rollPeriod >= 0) {
1741 var prev = originalData[i - rollPeriod];
1742 if (prev[1][1] != null && !isNaN(prev[1][1])) {
1743 low -= prev[1][0];
1744 mid -= prev[1][1];
1745 high -= prev[1][2];
1746 count -= 1;
1747 }
1748 }
1749 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
1750 1.0 * (mid - low) / count,
1751 1.0 * (high - mid) / count ]];
1752 }
1753 } else {
1754 // Calculate the rolling average for the first rollPeriod - 1 points where
1755 // there is not enough data to roll over the full number of days
1756 var num_init_points = Math.min(rollPeriod - 1, originalData.length - 2);
1757 if (!this.attr_("errorBars")){
1758 if (rollPeriod == 1) {
1759 return originalData;
1760 }
1761
1762 for (var i = 0; i < originalData.length; i++) {
1763 var sum = 0;
1764 var num_ok = 0;
1765 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
1766 var y = originalData[j][1];
1767 if (y == null || isNaN(y)) continue;
1768 num_ok++;
1769 sum += originalData[j][1];
1770 }
1771 if (num_ok) {
1772 rollingData[i] = [originalData[i][0], sum / num_ok];
1773 } else {
1774 rollingData[i] = [originalData[i][0], null];
1775 }
1776 }
1777
1778 } else {
1779 for (var i = 0; i < originalData.length; i++) {
1780 var sum = 0;
1781 var variance = 0;
1782 var num_ok = 0;
1783 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
1784 var y = originalData[j][1][0];
1785 if (y == null || isNaN(y)) continue;
1786 num_ok++;
1787 sum += originalData[j][1][0];
1788 variance += Math.pow(originalData[j][1][1], 2);
1789 }
1790 if (num_ok) {
1791 var stddev = Math.sqrt(variance) / num_ok;
1792 rollingData[i] = [originalData[i][0],
1793 [sum / num_ok, sigma * stddev, sigma * stddev]];
1794 } else {
1795 rollingData[i] = [originalData[i][0], [null, null, null]];
1796 }
1797 }
1798 }
1799 }
1800
1801 return rollingData;
1802 };
1803
1804 /**
1805 * Parses a date, returning the number of milliseconds since epoch. This can be
1806 * passed in as an xValueParser in the Dygraph constructor.
1807 * TODO(danvk): enumerate formats that this understands.
1808 * @param {String} A date in YYYYMMDD format.
1809 * @return {Number} Milliseconds since epoch.
1810 * @public
1811 */
1812 Dygraph.dateParser = function(dateStr, self) {
1813 var dateStrSlashed;
1814 var d;
1815 if (dateStr.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
1816 dateStrSlashed = dateStr.replace("-", "/", "g");
1817 while (dateStrSlashed.search("-") != -1) {
1818 dateStrSlashed = dateStrSlashed.replace("-", "/");
1819 }
1820 d = Date.parse(dateStrSlashed);
1821 } else if (dateStr.length == 8) { // e.g. '20090712'
1822 // TODO(danvk): remove support for this format. It's confusing.
1823 dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2)
1824 + "/" + dateStr.substr(6,2);
1825 d = Date.parse(dateStrSlashed);
1826 } else {
1827 // Any format that Date.parse will accept, e.g. "2009/07/12" or
1828 // "2009/07/12 12:34:56"
1829 d = Date.parse(dateStr);
1830 }
1831
1832 if (!d || isNaN(d)) {
1833 self.error("Couldn't parse " + dateStr + " as a date");
1834 }
1835 return d;
1836 };
1837
1838 /**
1839 * Detects the type of the str (date or numeric) and sets the various
1840 * formatting attributes in this.attrs_ based on this type.
1841 * @param {String} str An x value.
1842 * @private
1843 */
1844 Dygraph.prototype.detectTypeFromString_ = function(str) {
1845 var isDate = false;
1846 if (str.indexOf('-') >= 0 ||
1847 str.indexOf('/') >= 0 ||
1848 isNaN(parseFloat(str))) {
1849 isDate = true;
1850 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
1851 // TODO(danvk): remove support for this format.
1852 isDate = true;
1853 }
1854
1855 if (isDate) {
1856 this.attrs_.xValueFormatter = Dygraph.dateString_;
1857 this.attrs_.xValueParser = Dygraph.dateParser;
1858 this.attrs_.xTicker = Dygraph.dateTicker;
1859 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
1860 } else {
1861 this.attrs_.xValueFormatter = function(x) { return x; };
1862 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
1863 this.attrs_.xTicker = Dygraph.numericTicks;
1864 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
1865 }
1866 };
1867
1868 /**
1869 * Parses a string in a special csv format. We expect a csv file where each
1870 * line is a date point, and the first field in each line is the date string.
1871 * We also expect that all remaining fields represent series.
1872 * if the errorBars attribute is set, then interpret the fields as:
1873 * date, series1, stddev1, series2, stddev2, ...
1874 * @param {Array.<Object>} data See above.
1875 * @private
1876 *
1877 * @return Array.<Object> An array with one entry for each row. These entries
1878 * are an array of cells in that row. The first entry is the parsed x-value for
1879 * the row. The second, third, etc. are the y-values. These can take on one of
1880 * three forms, depending on the CSV and constructor parameters:
1881 * 1. numeric value
1882 * 2. [ value, stddev ]
1883 * 3. [ low value, center value, high value ]
1884 */
1885 Dygraph.prototype.parseCSV_ = function(data) {
1886 var ret = [];
1887 var lines = data.split("\n");
1888
1889 // Use the default delimiter or fall back to a tab if that makes sense.
1890 var delim = this.attr_('delimiter');
1891 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
1892 delim = '\t';
1893 }
1894
1895 var start = 0;
1896 if (this.labelsFromCSV_) {
1897 start = 1;
1898 this.attrs_.labels = lines[0].split(delim);
1899 }
1900
1901 var xParser;
1902 var defaultParserSet = false; // attempt to auto-detect x value type
1903 var expectedCols = this.attr_("labels").length;
1904 var outOfOrder = false;
1905 for (var i = start; i < lines.length; i++) {
1906 var line = lines[i];
1907 if (line.length == 0) continue; // skip blank lines
1908 if (line[0] == '#') continue; // skip comment lines
1909 var inFields = line.split(delim);
1910 if (inFields.length < 2) continue;
1911
1912 var fields = [];
1913 if (!defaultParserSet) {
1914 this.detectTypeFromString_(inFields[0]);
1915 xParser = this.attr_("xValueParser");
1916 defaultParserSet = true;
1917 }
1918 fields[0] = xParser(inFields[0], this);
1919
1920 // If fractions are expected, parse the numbers as "A/B"
1921 if (this.fractions_) {
1922 for (var j = 1; j < inFields.length; j++) {
1923 // TODO(danvk): figure out an appropriate way to flag parse errors.
1924 var vals = inFields[j].split("/");
1925 fields[j] = [parseFloat(vals[0]), parseFloat(vals[1])];
1926 }
1927 } else if (this.attr_("errorBars")) {
1928 // If there are error bars, values are (value, stddev) pairs
1929 for (var j = 1; j < inFields.length; j += 2)
1930 fields[(j + 1) / 2] = [parseFloat(inFields[j]),
1931 parseFloat(inFields[j + 1])];
1932 } else if (this.attr_("customBars")) {
1933 // Bars are a low;center;high tuple
1934 for (var j = 1; j < inFields.length; j++) {
1935 var vals = inFields[j].split(";");
1936 fields[j] = [ parseFloat(vals[0]),
1937 parseFloat(vals[1]),
1938 parseFloat(vals[2]) ];
1939 }
1940 } else {
1941 // Values are just numbers
1942 for (var j = 1; j < inFields.length; j++) {
1943 fields[j] = parseFloat(inFields[j]);
1944 }
1945 }
1946 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
1947 outOfOrder = true;
1948 }
1949 ret.push(fields);
1950
1951 if (fields.length != expectedCols) {
1952 this.error("Number of columns in line " + i + " (" + fields.length +
1953 ") does not agree with number of labels (" + expectedCols +
1954 ") " + line);
1955 }
1956 }
1957
1958 if (outOfOrder) {
1959 this.warn("CSV is out of order; order it correctly to speed loading.");
1960 ret.sort(function(a,b) { return a[0] - b[0] });
1961 }
1962
1963 return ret;
1964 };
1965
1966 /**
1967 * The user has provided their data as a pre-packaged JS array. If the x values
1968 * are numeric, this is the same as dygraphs' internal format. If the x values
1969 * are dates, we need to convert them from Date objects to ms since epoch.
1970 * @param {Array.<Object>} data
1971 * @return {Array.<Object>} data with numeric x values.
1972 */
1973 Dygraph.prototype.parseArray_ = function(data) {
1974 // Peek at the first x value to see if it's numeric.
1975 if (data.length == 0) {
1976 this.error("Can't plot empty data set");
1977 return null;
1978 }
1979 if (data[0].length == 0) {
1980 this.error("Data set cannot contain an empty row");
1981 return null;
1982 }
1983
1984 if (this.attr_("labels") == null) {
1985 this.warn("Using default labels. Set labels explicitly via 'labels' " +
1986 "in the options parameter");
1987 this.attrs_.labels = [ "X" ];
1988 for (var i = 1; i < data[0].length; i++) {
1989 this.attrs_.labels.push("Y" + i);
1990 }
1991 }
1992
1993 if (Dygraph.isDateLike(data[0][0])) {
1994 // Some intelligent defaults for a date x-axis.
1995 this.attrs_.xValueFormatter = Dygraph.dateString_;
1996 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
1997 this.attrs_.xTicker = Dygraph.dateTicker;
1998
1999 // Assume they're all dates.
2000 var parsedData = Dygraph.clone(data);
2001 for (var i = 0; i < data.length; i++) {
2002 if (parsedData[i].length == 0) {
2003 this.error("Row " << (1 + i) << " of data is empty");
2004 return null;
2005 }
2006 if (parsedData[i][0] == null
2007 || typeof(parsedData[i][0].getTime) != 'function'
2008 || isNaN(parsedData[i][0].getTime())) {
2009 this.error("x value in row " + (1 + i) + " is not a Date");
2010 return null;
2011 }
2012 parsedData[i][0] = parsedData[i][0].getTime();
2013 }
2014 return parsedData;
2015 } else {
2016 // Some intelligent defaults for a numeric x-axis.
2017 this.attrs_.xValueFormatter = function(x) { return x; };
2018 this.attrs_.xTicker = Dygraph.numericTicks;
2019 return data;
2020 }
2021 };
2022
2023 /**
2024 * Parses a DataTable object from gviz.
2025 * The data is expected to have a first column that is either a date or a
2026 * number. All subsequent columns must be numbers. If there is a clear mismatch
2027 * between this.xValueParser_ and the type of the first column, it will be
2028 * fixed. Returned value is in the same format as return value of parseCSV_.
2029 * @param {Array.<Object>} data See above.
2030 * @private
2031 */
2032 Dygraph.prototype.parseDataTable_ = function(data) {
2033 var cols = data.getNumberOfColumns();
2034 var rows = data.getNumberOfRows();
2035
2036 // Read column labels
2037 var labels = [];
2038 for (var i = 0; i < cols; i++) {
2039 labels.push(data.getColumnLabel(i));
2040 if (i != 0 && this.attr_("errorBars")) i += 1;
2041 }
2042 this.attrs_.labels = labels;
2043 cols = labels.length;
2044
2045 var indepType = data.getColumnType(0);
2046 if (indepType == 'date' || indepType == 'datetime') {
2047 this.attrs_.xValueFormatter = Dygraph.dateString_;
2048 this.attrs_.xValueParser = Dygraph.dateParser;
2049 this.attrs_.xTicker = Dygraph.dateTicker;
2050 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
2051 } else if (indepType == 'number') {
2052 this.attrs_.xValueFormatter = function(x) { return x; };
2053 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2054 this.attrs_.xTicker = Dygraph.numericTicks;
2055 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
2056 } else {
2057 this.error("only 'date', 'datetime' and 'number' types are supported for " +
2058 "column 1 of DataTable input (Got '" + indepType + "')");
2059 return null;
2060 }
2061
2062 var ret = [];
2063 var outOfOrder = false;
2064 for (var i = 0; i < rows; i++) {
2065 var row = [];
2066 if (typeof(data.getValue(i, 0)) === 'undefined' ||
2067 data.getValue(i, 0) === null) {
2068 this.warning("Ignoring row " + i +
2069 " of DataTable because of undefined or null first column.");
2070 continue;
2071 }
2072
2073 if (indepType == 'date' || indepType == 'datetime') {
2074 row.push(data.getValue(i, 0).getTime());
2075 } else {
2076 row.push(data.getValue(i, 0));
2077 }
2078 if (!this.attr_("errorBars")) {
2079 for (var j = 1; j < cols; j++) {
2080 row.push(data.getValue(i, j));
2081 }
2082 } else {
2083 for (var j = 0; j < cols - 1; j++) {
2084 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
2085 }
2086 }
2087 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
2088 outOfOrder = true;
2089 }
2090 ret.push(row);
2091 }
2092
2093 if (outOfOrder) {
2094 this.warn("DataTable is out of order; order it correctly to speed loading.");
2095 ret.sort(function(a,b) { return a[0] - b[0] });
2096 }
2097 return ret;
2098 }
2099
2100 // These functions are all based on MochiKit.
2101 Dygraph.update = function (self, o) {
2102 if (typeof(o) != 'undefined' && o !== null) {
2103 for (var k in o) {
2104 if (o.hasOwnProperty(k)) {
2105 self[k] = o[k];
2106 }
2107 }
2108 }
2109 return self;
2110 };
2111
2112 Dygraph.isArrayLike = function (o) {
2113 var typ = typeof(o);
2114 if (
2115 (typ != 'object' && !(typ == 'function' &&
2116 typeof(o.item) == 'function')) ||
2117 o === null ||
2118 typeof(o.length) != 'number' ||
2119 o.nodeType === 3
2120 ) {
2121 return false;
2122 }
2123 return true;
2124 };
2125
2126 Dygraph.isDateLike = function (o) {
2127 if (typeof(o) != "object" || o === null ||
2128 typeof(o.getTime) != 'function') {
2129 return false;
2130 }
2131 return true;
2132 };
2133
2134 Dygraph.clone = function(o) {
2135 // TODO(danvk): figure out how MochiKit's version works
2136 var r = [];
2137 for (var i = 0; i < o.length; i++) {
2138 if (Dygraph.isArrayLike(o[i])) {
2139 r.push(Dygraph.clone(o[i]));
2140 } else {
2141 r.push(o[i]);
2142 }
2143 }
2144 return r;
2145 };
2146
2147
2148 /**
2149 * Get the CSV data. If it's in a function, call that function. If it's in a
2150 * file, do an XMLHttpRequest to get it.
2151 * @private
2152 */
2153 Dygraph.prototype.start_ = function() {
2154 if (typeof this.file_ == 'function') {
2155 // CSV string. Pretend we got it via XHR.
2156 this.loadedEvent_(this.file_());
2157 } else if (Dygraph.isArrayLike(this.file_)) {
2158 this.rawData_ = this.parseArray_(this.file_);
2159 this.drawGraph_(this.rawData_);
2160 } else if (typeof this.file_ == 'object' &&
2161 typeof this.file_.getColumnRange == 'function') {
2162 // must be a DataTable from gviz.
2163 this.rawData_ = this.parseDataTable_(this.file_);
2164 this.drawGraph_(this.rawData_);
2165 } else if (typeof this.file_ == 'string') {
2166 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
2167 if (this.file_.indexOf('\n') >= 0) {
2168 this.loadedEvent_(this.file_);
2169 } else {
2170 var req = new XMLHttpRequest();
2171 var caller = this;
2172 req.onreadystatechange = function () {
2173 if (req.readyState == 4) {
2174 if (req.status == 200) {
2175 caller.loadedEvent_(req.responseText);
2176 }
2177 }
2178 };
2179
2180 req.open("GET", this.file_, true);
2181 req.send(null);
2182 }
2183 } else {
2184 this.error("Unknown data format: " + (typeof this.file_));
2185 }
2186 };
2187
2188 /**
2189 * Changes various properties of the graph. These can include:
2190 * <ul>
2191 * <li>file: changes the source data for the graph</li>
2192 * <li>errorBars: changes whether the data contains stddev</li>
2193 * </ul>
2194 * @param {Object} attrs The new properties and values
2195 */
2196 Dygraph.prototype.updateOptions = function(attrs) {
2197 // TODO(danvk): this is a mess. Rethink this function.
2198 if (attrs.rollPeriod) {
2199 this.rollPeriod_ = attrs.rollPeriod;
2200 }
2201 if (attrs.dateWindow) {
2202 this.dateWindow_ = attrs.dateWindow;
2203 }
2204 if (attrs.valueRange) {
2205 this.valueRange_ = attrs.valueRange;
2206 }
2207 Dygraph.update(this.user_attrs_, attrs);
2208
2209 this.labelsFromCSV_ = (this.attr_("labels") == null);
2210
2211 // TODO(danvk): this doesn't match the constructor logic
2212 this.layout_.updateOptions({ 'errorBars': this.attr_("errorBars") });
2213 if (attrs['file']) {
2214 this.file_ = attrs['file'];
2215 this.start_();
2216 } else {
2217 this.drawGraph_(this.rawData_);
2218 }
2219 };
2220
2221 /**
2222 * Resizes the dygraph. If no parameters are specified, resizes to fill the
2223 * containing div (which has presumably changed size since the dygraph was
2224 * instantiated. If the width/height are specified, the div will be resized.
2225 *
2226 * This is far more efficient than destroying and re-instantiating a
2227 * Dygraph, since it doesn't have to reparse the underlying data.
2228 *
2229 * @param {Number} width Width (in pixels)
2230 * @param {Number} height Height (in pixels)
2231 */
2232 Dygraph.prototype.resize = function(width, height) {
2233 if (this.resize_lock) {
2234 return;
2235 }
2236 this.resize_lock = true;
2237
2238 if ((width === null) != (height === null)) {
2239 this.warn("Dygraph.resize() should be called with zero parameters or " +
2240 "two non-NULL parameters. Pretending it was zero.");
2241 width = height = null;
2242 }
2243
2244 // TODO(danvk): there should be a clear() method.
2245 this.maindiv_.innerHTML = "";
2246 this.attrs_.labelsDiv = null;
2247
2248 if (width) {
2249 this.maindiv_.style.width = width + "px";
2250 this.maindiv_.style.height = height + "px";
2251 this.width_ = width;
2252 this.height_ = height;
2253 } else {
2254 this.width_ = this.maindiv_.offsetWidth;
2255 this.height_ = this.maindiv_.offsetHeight;
2256 }
2257
2258 this.createInterface_();
2259 this.drawGraph_(this.rawData_);
2260
2261 this.resize_lock = false;
2262 };
2263
2264 /**
2265 * Adjusts the number of days in the rolling average. Updates the graph to
2266 * reflect the new averaging period.
2267 * @param {Number} length Number of days over which to average the data.
2268 */
2269 Dygraph.prototype.adjustRoll = function(length) {
2270 this.rollPeriod_ = length;
2271 this.drawGraph_(this.rawData_);
2272 };
2273
2274 /**
2275 * Returns a boolean array of visibility statuses.
2276 */
2277 Dygraph.prototype.visibility = function() {
2278 // Do lazy-initialization, so that this happens after we know the number of
2279 // data series.
2280 if (!this.attr_("visibility")) {
2281 this.attrs_["visibility"] = [];
2282 }
2283 while (this.attr_("visibility").length < this.rawData_[0].length - 1) {
2284 this.attr_("visibility").push(true);
2285 }
2286 return this.attr_("visibility");
2287 };
2288
2289 /**
2290 * Changes the visiblity of a series.
2291 */
2292 Dygraph.prototype.setVisibility = function(num, value) {
2293 var x = this.visibility();
2294 if (num < 0 && num >= x.length) {
2295 this.warn("invalid series number in setVisibility: " + num);
2296 } else {
2297 x[num] = value;
2298 this.drawGraph_(this.rawData_);
2299 }
2300 };
2301
2302 /**
2303 * Create a new canvas element. This is more complex than a simple
2304 * document.createElement("canvas") because of IE and excanvas.
2305 */
2306 Dygraph.createCanvas = function() {
2307 var canvas = document.createElement("canvas");
2308
2309 isIE = (/MSIE/.test(navigator.userAgent) && !window.opera);
2310 if (isIE) {
2311 canvas = G_vmlCanvasManager.initElement(canvas);
2312 }
2313
2314 return canvas;
2315 };
2316
2317
2318 /**
2319 * A wrapper around Dygraph that implements the gviz API.
2320 * @param {Object} container The DOM object the visualization should live in.
2321 */
2322 Dygraph.GVizChart = function(container) {
2323 this.container = container;
2324 }
2325
2326 Dygraph.GVizChart.prototype.draw = function(data, options) {
2327 this.container.innerHTML = '';
2328 this.date_graph = new Dygraph(this.container, data, options);
2329 }
2330
2331 /**
2332 * Google charts compatible setSelection
2333 * Only row selection is supported, all points in the row will be highlighted
2334 * @param {Array} array of the selected cells
2335 * @public
2336 */
2337 Dygraph.GVizChart.prototype.setSelection = function(selection_array) {
2338 var row = false;
2339 if (selection_array.length) {
2340 row = selection_array[0].row;
2341 }
2342 this.date_graph.setSelection(row);
2343 }
2344
2345 /**
2346 * Google charts compatible getSelection implementation
2347 * @return {Array} array of the selected cells
2348 * @public
2349 */
2350 Dygraph.GVizChart.prototype.getSelection = function() {
2351 var selection = [];
2352
2353 var row = this.date_graph.getSelection();
2354
2355 if (row < 0) return selection;
2356
2357 col = 1;
2358 for (var i in this.date_graph.layout_.datasets) {
2359 selection.push({row: row, column: col});
2360 col++;
2361 }
2362
2363 return selection;
2364 }
2365
2366 // Older pages may still use this name.
2367 DateGraph = Dygraph;