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