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