Fix pointClickCallback and resizing coordinate weirdness when inside a
[dygraphs.git] / dygraph.js
1 // Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
2 // All Rights Reserved.
3
4 /**
5 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
6 * string. Dygraph can handle multiple series with or without error bars. The
7 * date/value ranges will be automatically set. Dygraph uses the
8 * <canvas> tag, so it only works in FF1.5+.
9 * @author danvdk@gmail.com (Dan Vanderkam)
10
11 Usage:
12 <div id="graphdiv" style="width:800px; height:500px;"></div>
13 <script type="text/javascript">
14 new Dygraph(document.getElementById("graphdiv"),
15 "datafile.csv", // CSV file with headers
16 { }); // options
17 </script>
18
19 The CSV file is of the form
20
21 Date,SeriesA,SeriesB,SeriesC
22 YYYYMMDD,A1,B1,C1
23 YYYYMMDD,A2,B2,C2
24
25 If the 'errorBars' option is set in the constructor, the input should be of
26 the form
27 Date,SeriesA,SeriesB,...
28 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
29 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
30
31 If the 'fractions' option is set, the input should be of the form:
32
33 Date,SeriesA,SeriesB,...
34 YYYYMMDD,A1/B1,A2/B2,...
35 YYYYMMDD,A1/B1,A2/B2,...
36
37 And error bars will be calculated automatically using a binomial distribution.
38
39 For further documentation and examples, see http://dygraphs.com/
40
41 */
42
43 /**
44 * Creates an interactive, zoomable chart.
45 *
46 * @constructor
47 * @param {div | String} div A div or the id of a div into which to construct
48 * the chart.
49 * @param {String | Function} file A file containing CSV data or a function
50 * that returns this data. The most basic expected format for each line is
51 * "YYYY/MM/DD,val1,val2,...". For more information, see
52 * http://dygraphs.com/data.html.
53 * @param {Object} attrs Various other attributes, e.g. errorBars determines
54 * whether the input data contains error ranges. For a complete list of
55 * options, see http://dygraphs.com/options.html.
56 */
57 Dygraph = function(div, data, opts) {
58 if (arguments.length > 0) {
59 if (arguments.length == 4) {
60 // Old versions of dygraphs took in the series labels as a constructor
61 // parameter. This doesn't make sense anymore, but it's easy to continue
62 // to support this usage.
63 this.warn("Using deprecated four-argument dygraph constructor");
64 this.__old_init__(div, data, arguments[2], arguments[3]);
65 } else {
66 this.__init__(div, data, opts);
67 }
68 }
69 };
70
71 Dygraph.NAME = "Dygraph";
72 Dygraph.VERSION = "1.2";
73 Dygraph.__repr__ = function() {
74 return "[" + this.NAME + " " + this.VERSION + "]";
75 };
76
77 /**
78 * Returns information about the Dygraph class.
79 */
80 Dygraph.toString = function() {
81 return this.__repr__();
82 };
83
84 // Various default values
85 Dygraph.DEFAULT_ROLL_PERIOD = 1;
86 Dygraph.DEFAULT_WIDTH = 480;
87 Dygraph.DEFAULT_HEIGHT = 320;
88
89 // Default attribute values.
90 Dygraph.DEFAULT_ATTRS = {
91 highlightCircleSize: 3,
92 pixelsPerXLabel: 60,
93 pixelsPerYLabel: 30,
94
95 labelsDivWidth: 250,
96 labelsDivStyles: {
97 // TODO(danvk): move defaults from createStatusMessage_ here.
98 },
99 labelsSeparateLines: false,
100 labelsShowZeroValues: true,
101 labelsKMB: false,
102 labelsKMG2: false,
103 showLabelsOnHighlight: true,
104
105 yValueFormatter: function(a,b) { return Dygraph.numberFormatter(a,b); },
106 digitsAfterDecimal: 2,
107 maxNumberWidth: 6,
108 sigFigs: null,
109
110 strokeWidth: 1.0,
111
112 axisTickSize: 3,
113 axisLabelFontSize: 14,
114 xAxisLabelWidth: 50,
115 yAxisLabelWidth: 50,
116 xAxisLabelFormatter: Dygraph.dateAxisFormatter,
117 rightGap: 5,
118
119 showRoller: false,
120 xValueFormatter: Dygraph.dateString_,
121 xValueParser: Dygraph.dateParser,
122 xTicker: Dygraph.dateTicker,
123
124 delimiter: ',',
125
126 sigma: 2.0,
127 errorBars: false,
128 fractions: false,
129 wilsonInterval: true, // only relevant if fractions is true
130 customBars: false,
131 fillGraph: false,
132 fillAlpha: 0.15,
133 connectSeparatedPoints: false,
134
135 stackedGraph: false,
136 hideOverlayOnMouseOut: true,
137
138 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
139 legend: 'onmouseover', // the only relevant value at the moment is 'always'.
140
141 stepPlot: false,
142 avoidMinZero: false,
143
144 // Sizes of the various chart labels.
145 titleHeight: 28,
146 xLabelHeight: 18,
147 yLabelWidth: 18,
148
149 drawXAxis: true,
150 drawYAxis: true,
151 axisLineColor: "black",
152 axisLineWidth: 0.3,
153 gridLineWidth: 0.3,
154 axisLabelColor: "black",
155 axisLabelFont: "Arial", // TODO(danvk): is this implemented?
156 axisLabelWidth: 50,
157 drawYGrid: true,
158 drawXGrid: true,
159 gridLineColor: "rgb(128,128,128)",
160
161 interactionModel: null // will be set to Dygraph.Interaction.defaultModel
162 };
163
164 // Directions for panning and zooming. Use bit operations when combined
165 // values are possible.
166 Dygraph.HORIZONTAL = 1;
167 Dygraph.VERTICAL = 2;
168
169 // Used for initializing annotation CSS rules only once.
170 Dygraph.addedAnnotationCSS = false;
171
172 Dygraph.prototype.__old_init__ = function(div, file, labels, attrs) {
173 // Labels is no longer a constructor parameter, since it's typically set
174 // directly from the data source. It also conains a name for the x-axis,
175 // which the previous constructor form did not.
176 if (labels != null) {
177 var new_labels = ["Date"];
178 for (var i = 0; i < labels.length; i++) new_labels.push(labels[i]);
179 Dygraph.update(attrs, { 'labels': new_labels });
180 }
181 this.__init__(div, file, attrs);
182 };
183
184 /**
185 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
186 * and context &lt;canvas&gt; inside of it. See the constructor for details.
187 * on the parameters.
188 * @param {Element} div the Element to render the graph into.
189 * @param {String | Function} file Source data
190 * @param {Object} attrs Miscellaneous other options
191 * @private
192 */
193 Dygraph.prototype.__init__ = function(div, file, attrs) {
194 // Hack for IE: if we're using excanvas and the document hasn't finished
195 // loading yet (and hence may not have initialized whatever it needs to
196 // initialize), then keep calling this routine periodically until it has.
197 if (/MSIE/.test(navigator.userAgent) && !window.opera &&
198 typeof(G_vmlCanvasManager) != 'undefined' &&
199 document.readyState != 'complete') {
200 var self = this;
201 setTimeout(function() { self.__init__(div, file, attrs) }, 100);
202 }
203
204 // Support two-argument constructor
205 if (attrs == null) { attrs = {}; }
206
207 // Copy the important bits into the object
208 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
209 this.maindiv_ = div;
210 this.file_ = file;
211 this.rollPeriod_ = attrs.rollPeriod || Dygraph.DEFAULT_ROLL_PERIOD;
212 this.previousVerticalX_ = -1;
213 this.fractions_ = attrs.fractions || false;
214 this.dateWindow_ = attrs.dateWindow || null;
215
216 this.wilsonInterval_ = attrs.wilsonInterval || true;
217 this.is_initial_draw_ = true;
218 this.annotations_ = [];
219
220 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
221 this.zoomed_x_ = false;
222 this.zoomed_y_ = false;
223
224 // Clear the div. This ensure that, if multiple dygraphs are passed the same
225 // div, then only one will be drawn.
226 div.innerHTML = "";
227
228 // If the div isn't already sized then inherit from our attrs or
229 // give it a default size.
230 if (div.style.width == '') {
231 div.style.width = (attrs.width || Dygraph.DEFAULT_WIDTH) + "px";
232 }
233 if (div.style.height == '') {
234 div.style.height = (attrs.height || Dygraph.DEFAULT_HEIGHT) + "px";
235 }
236 this.width_ = parseInt(div.style.width, 10);
237 this.height_ = parseInt(div.style.height, 10);
238 // The div might have been specified as percent of the current window size,
239 // convert that to an appropriate number of pixels.
240 if (div.style.width.indexOf("%") == div.style.width.length - 1) {
241 this.width_ = div.offsetWidth;
242 }
243 if (div.style.height.indexOf("%") == div.style.height.length - 1) {
244 this.height_ = div.offsetHeight;
245 }
246
247 if (this.width_ == 0) {
248 this.error("dygraph has zero width. Please specify a width in pixels.");
249 }
250 if (this.height_ == 0) {
251 this.error("dygraph has zero height. Please specify a height in pixels.");
252 }
253
254 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
255 if (attrs['stackedGraph']) {
256 attrs['fillGraph'] = true;
257 // TODO(nikhilk): Add any other stackedGraph checks here.
258 }
259
260 // Dygraphs has many options, some of which interact with one another.
261 // To keep track of everything, we maintain two sets of options:
262 //
263 // this.user_attrs_ only options explicitly set by the user.
264 // this.attrs_ defaults, options derived from user_attrs_, data.
265 //
266 // Options are then accessed this.attr_('attr'), which first looks at
267 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
268 // defaults without overriding behavior that the user specifically asks for.
269 this.user_attrs_ = {};
270 Dygraph.update(this.user_attrs_, attrs);
271
272 this.attrs_ = {};
273 Dygraph.update(this.attrs_, Dygraph.DEFAULT_ATTRS);
274
275 this.boundaryIds_ = [];
276
277 // Create the containing DIV and other interactive elements
278 this.createInterface_();
279
280 this.start_();
281 };
282
283 /**
284 * Returns the zoomed status of the chart for one or both axes.
285 *
286 * Axis is an optional parameter. Can be set to 'x' or 'y'.
287 *
288 * The zoomed status for an axis is set whenever a user zooms using the mouse
289 * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
290 * option is also specified).
291 */
292 Dygraph.prototype.isZoomed = function(axis) {
293 if (axis == null) return this.zoomed_x_ || this.zoomed_y_;
294 if (axis == 'x') return this.zoomed_x_;
295 if (axis == 'y') return this.zoomed_y_;
296 throw "axis parameter to Dygraph.isZoomed must be missing, 'x' or 'y'.";
297 };
298
299 /**
300 * Returns information about the Dygraph object, including its containing ID.
301 */
302 Dygraph.prototype.toString = function() {
303 var maindiv = this.maindiv_;
304 var id = (maindiv && maindiv.id) ? maindiv.id : maindiv
305 return "[Dygraph " + id + "]";
306 }
307
308 /**
309 * @private
310 * Returns the value of an option. This may be set by the user (either in the
311 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
312 * per-series value.
313 * @param { String } name The name of the option, e.g. 'rollPeriod'.
314 * @param { String } [seriesName] The name of the series to which the option
315 * will be applied. If no per-series value of this option is available, then
316 * the global value is returned. This is optional.
317 * @return { ... } The value of the option.
318 */
319 Dygraph.prototype.attr_ = function(name, seriesName) {
320 // <REMOVE_FOR_COMBINED>
321 if (typeof(Dygraph.OPTIONS_REFERENCE) === 'undefined') {
322 this.error('Must include options reference JS for testing');
323 } else if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(name)) {
324 this.error('Dygraphs is using property ' + name + ', which has no entry ' +
325 'in the Dygraphs.OPTIONS_REFERENCE listing.');
326 // Only log this error once.
327 Dygraph.OPTIONS_REFERENCE[name] = true;
328 }
329 // </REMOVE_FOR_COMBINED>
330 if (seriesName &&
331 typeof(this.user_attrs_[seriesName]) != 'undefined' &&
332 this.user_attrs_[seriesName] != null &&
333 typeof(this.user_attrs_[seriesName][name]) != 'undefined') {
334 return this.user_attrs_[seriesName][name];
335 } else if (typeof(this.user_attrs_[name]) != 'undefined') {
336 return this.user_attrs_[name];
337 } else if (typeof(this.attrs_[name]) != 'undefined') {
338 return this.attrs_[name];
339 } else {
340 return null;
341 }
342 };
343
344 /**
345 * Returns the current rolling period, as set by the user or an option.
346 * @return {Number} The number of points in the rolling window
347 */
348 Dygraph.prototype.rollPeriod = function() {
349 return this.rollPeriod_;
350 };
351
352 /**
353 * Returns the currently-visible x-range. This can be affected by zooming,
354 * panning or a call to updateOptions.
355 * Returns a two-element array: [left, right].
356 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
357 */
358 Dygraph.prototype.xAxisRange = function() {
359 return this.dateWindow_ ? this.dateWindow_ : this.xAxisExtremes();
360 };
361
362 /**
363 * Returns the lower- and upper-bound x-axis values of the
364 * data set.
365 */
366 Dygraph.prototype.xAxisExtremes = function() {
367 var left = this.rawData_[0][0];
368 var right = this.rawData_[this.rawData_.length - 1][0];
369 return [left, right];
370 };
371
372 /**
373 * Returns the currently-visible y-range for an axis. This can be affected by
374 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
375 * called with no arguments, returns the range of the first axis.
376 * Returns a two-element array: [bottom, top].
377 */
378 Dygraph.prototype.yAxisRange = function(idx) {
379 if (typeof(idx) == "undefined") idx = 0;
380 if (idx < 0 || idx >= this.axes_.length) {
381 return null;
382 }
383 var axis = this.axes_[idx];
384 return [ axis.computedValueRange[0], axis.computedValueRange[1] ];
385 };
386
387 /**
388 * Returns the currently-visible y-ranges for each axis. This can be affected by
389 * zooming, panning, calls to updateOptions, etc.
390 * Returns an array of [bottom, top] pairs, one for each y-axis.
391 */
392 Dygraph.prototype.yAxisRanges = function() {
393 var ret = [];
394 for (var i = 0; i < this.axes_.length; i++) {
395 ret.push(this.yAxisRange(i));
396 }
397 return ret;
398 };
399
400 // TODO(danvk): use these functions throughout dygraphs.
401 /**
402 * Convert from data coordinates to canvas/div X/Y coordinates.
403 * If specified, do this conversion for the coordinate system of a particular
404 * axis. Uses the first axis by default.
405 * Returns a two-element array: [X, Y]
406 *
407 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
408 * instead of toDomCoords(null, y, axis).
409 */
410 Dygraph.prototype.toDomCoords = function(x, y, axis) {
411 return [ this.toDomXCoord(x), this.toDomYCoord(y, axis) ];
412 };
413
414 /**
415 * Convert from data x coordinates to canvas/div X coordinate.
416 * If specified, do this conversion for the coordinate system of a particular
417 * axis.
418 * Returns a single value or null if x is null.
419 */
420 Dygraph.prototype.toDomXCoord = function(x) {
421 if (x == null) {
422 return null;
423 };
424
425 var area = this.plotter_.area;
426 var xRange = this.xAxisRange();
427 return area.x + (x - xRange[0]) / (xRange[1] - xRange[0]) * area.w;
428 }
429
430 /**
431 * Convert from data x coordinates to canvas/div Y coordinate and optional
432 * axis. Uses the first axis by default.
433 *
434 * returns a single value or null if y is null.
435 */
436 Dygraph.prototype.toDomYCoord = function(y, axis) {
437 var pct = this.toPercentYCoord(y, axis);
438
439 if (pct == null) {
440 return null;
441 }
442 var area = this.plotter_.area;
443 return area.y + pct * area.h;
444 }
445
446 /**
447 * Convert from canvas/div coords to data coordinates.
448 * If specified, do this conversion for the coordinate system of a particular
449 * axis. Uses the first axis by default.
450 * Returns a two-element array: [X, Y].
451 *
452 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
453 * instead of toDataCoords(null, y, axis).
454 */
455 Dygraph.prototype.toDataCoords = function(x, y, axis) {
456 return [ this.toDataXCoord(x), this.toDataYCoord(y, axis) ];
457 };
458
459 /**
460 * Convert from canvas/div x coordinate to data coordinate.
461 *
462 * If x is null, this returns null.
463 */
464 Dygraph.prototype.toDataXCoord = function(x) {
465 if (x == null) {
466 return null;
467 }
468
469 var area = this.plotter_.area;
470 var xRange = this.xAxisRange();
471 return xRange[0] + (x - area.x) / area.w * (xRange[1] - xRange[0]);
472 };
473
474 /**
475 * Convert from canvas/div y coord to value.
476 *
477 * If y is null, this returns null.
478 * if axis is null, this uses the first axis.
479 */
480 Dygraph.prototype.toDataYCoord = function(y, axis) {
481 if (y == null) {
482 return null;
483 }
484
485 var area = this.plotter_.area;
486 var yRange = this.yAxisRange(axis);
487
488 if (typeof(axis) == "undefined") axis = 0;
489 if (!this.axes_[axis].logscale) {
490 return yRange[0] + (area.y + area.h - y) / area.h * (yRange[1] - yRange[0]);
491 } else {
492 // Computing the inverse of toDomCoord.
493 var pct = (y - area.y) / area.h
494
495 // Computing the inverse of toPercentYCoord. The function was arrived at with
496 // the following steps:
497 //
498 // Original calcuation:
499 // pct = (logr1 - Dygraph.log10(y)) / (logr1 - Dygraph.log10(yRange[0]));
500 //
501 // Move denominator to both sides:
502 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
503 //
504 // subtract logr1, and take the negative value.
505 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
506 //
507 // Swap both sides of the equation, and we can compute the log of the
508 // return value. Which means we just need to use that as the exponent in
509 // e^exponent.
510 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
511
512 var logr1 = Dygraph.log10(yRange[1]);
513 var exponent = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
514 var value = Math.pow(Dygraph.LOG_SCALE, exponent);
515 return value;
516 }
517 };
518
519 /**
520 * Converts a y for an axis to a percentage from the top to the
521 * bottom of the drawing area.
522 *
523 * If the coordinate represents a value visible on the canvas, then
524 * the value will be between 0 and 1, where 0 is the top of the canvas.
525 * However, this method will return values outside the range, as
526 * values can fall outside the canvas.
527 *
528 * If y is null, this returns null.
529 * if axis is null, this uses the first axis.
530 *
531 * @param { Number } y The data y-coordinate.
532 * @param { Number } [axis] The axis number on which the data coordinate lives.
533 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
534 */
535 Dygraph.prototype.toPercentYCoord = function(y, axis) {
536 if (y == null) {
537 return null;
538 }
539 if (typeof(axis) == "undefined") axis = 0;
540
541 var area = this.plotter_.area;
542 var yRange = this.yAxisRange(axis);
543
544 var pct;
545 if (!this.axes_[axis].logscale) {
546 // yRange[1] - y is unit distance from the bottom.
547 // yRange[1] - yRange[0] is the scale of the range.
548 // (yRange[1] - y) / (yRange[1] - yRange[0]) is the % from the bottom.
549 pct = (yRange[1] - y) / (yRange[1] - yRange[0]);
550 } else {
551 var logr1 = Dygraph.log10(yRange[1]);
552 pct = (logr1 - Dygraph.log10(y)) / (logr1 - Dygraph.log10(yRange[0]));
553 }
554 return pct;
555 }
556
557 /**
558 * Converts an x value to a percentage from the left to the right of
559 * the drawing area.
560 *
561 * If the coordinate represents a value visible on the canvas, then
562 * the value will be between 0 and 1, where 0 is the left of the canvas.
563 * However, this method will return values outside the range, as
564 * values can fall outside the canvas.
565 *
566 * If x is null, this returns null.
567 * @param { Number } x The data x-coordinate.
568 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
569 */
570 Dygraph.prototype.toPercentXCoord = function(x) {
571 if (x == null) {
572 return null;
573 }
574
575 var xRange = this.xAxisRange();
576 return (x - xRange[0]) / (xRange[1] - xRange[0]);
577 };
578
579 /**
580 * Returns the number of columns (including the independent variable).
581 * @return { Integer } The number of columns.
582 */
583 Dygraph.prototype.numColumns = function() {
584 return this.rawData_[0].length;
585 };
586
587 /**
588 * Returns the number of rows (excluding any header/label row).
589 * @return { Integer } The number of rows, less any header.
590 */
591 Dygraph.prototype.numRows = function() {
592 return this.rawData_.length;
593 };
594
595 /**
596 * Returns the value in the given row and column. If the row and column exceed
597 * the bounds on the data, returns null. Also returns null if the value is
598 * missing.
599 * @param { Number} row The row number of the data (0-based). Row 0 is the
600 * first row of data, not a header row.
601 * @param { Number} col The column number of the data (0-based)
602 * @return { Number } The value in the specified cell or null if the row/col
603 * were out of range.
604 */
605 Dygraph.prototype.getValue = function(row, col) {
606 if (row < 0 || row > this.rawData_.length) return null;
607 if (col < 0 || col > this.rawData_[row].length) return null;
608
609 return this.rawData_[row][col];
610 };
611
612 /**
613 * Generates interface elements for the Dygraph: a containing div, a div to
614 * display the current point, and a textbox to adjust the rolling average
615 * period. Also creates the Renderer/Layout elements.
616 * @private
617 */
618 Dygraph.prototype.createInterface_ = function() {
619 // Create the all-enclosing graph div
620 var enclosing = this.maindiv_;
621
622 this.graphDiv = document.createElement("div");
623 this.graphDiv.style.width = this.width_ + "px";
624 this.graphDiv.style.height = this.height_ + "px";
625 enclosing.appendChild(this.graphDiv);
626
627 // Create the canvas for interactive parts of the chart.
628 this.canvas_ = Dygraph.createCanvas();
629 this.canvas_.style.position = "absolute";
630 this.canvas_.width = this.width_;
631 this.canvas_.height = this.height_;
632 this.canvas_.style.width = this.width_ + "px"; // for IE
633 this.canvas_.style.height = this.height_ + "px"; // for IE
634
635 this.canvas_ctx_ = Dygraph.getContext(this.canvas_);
636
637 // ... and for static parts of the chart.
638 this.hidden_ = this.createPlotKitCanvas_(this.canvas_);
639 this.hidden_ctx_ = Dygraph.getContext(this.hidden_);
640
641 // The interactive parts of the graph are drawn on top of the chart.
642 this.graphDiv.appendChild(this.hidden_);
643 this.graphDiv.appendChild(this.canvas_);
644 this.mouseEventElement_ = this.canvas_;
645
646 var dygraph = this;
647 Dygraph.addEvent(this.mouseEventElement_, 'mousemove', function(e) {
648 dygraph.mouseMove_(e);
649 });
650 Dygraph.addEvent(this.mouseEventElement_, 'mouseout', function(e) {
651 dygraph.mouseOut_(e);
652 });
653
654 // Create the grapher
655 this.layout_ = new DygraphLayout(this);
656
657 this.createStatusMessage_();
658 this.createDragInterface_();
659 };
660
661 /**
662 * Detach DOM elements in the dygraph and null out all data references.
663 * Calling this when you're done with a dygraph can dramatically reduce memory
664 * usage. See, e.g., the tests/perf.html example.
665 */
666 Dygraph.prototype.destroy = function() {
667 var removeRecursive = function(node) {
668 while (node.hasChildNodes()) {
669 removeRecursive(node.firstChild);
670 node.removeChild(node.firstChild);
671 }
672 };
673 removeRecursive(this.maindiv_);
674
675 var nullOut = function(obj) {
676 for (var n in obj) {
677 if (typeof(obj[n]) === 'object') {
678 obj[n] = null;
679 }
680 }
681 };
682
683 // These may not all be necessary, but it can't hurt...
684 nullOut(this.layout_);
685 nullOut(this.plotter_);
686 nullOut(this);
687 };
688
689 /**
690 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
691 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
692 * or the zoom rectangles) is done on this.canvas_.
693 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
694 * @return {Object} The newly-created canvas
695 * @private
696 */
697 Dygraph.prototype.createPlotKitCanvas_ = function(canvas) {
698 var h = Dygraph.createCanvas();
699 h.style.position = "absolute";
700 // TODO(danvk): h should be offset from canvas. canvas needs to include
701 // some extra area to make it easier to zoom in on the far left and far
702 // right. h needs to be precisely the plot area, so that clipping occurs.
703 h.style.top = canvas.style.top;
704 h.style.left = canvas.style.left;
705 h.width = this.width_;
706 h.height = this.height_;
707 h.style.width = this.width_ + "px"; // for IE
708 h.style.height = this.height_ + "px"; // for IE
709 return h;
710 };
711
712 /**
713 * Generate a set of distinct colors for the data series. This is done with a
714 * color wheel. Saturation/Value are customizable, and the hue is
715 * equally-spaced around the color wheel. If a custom set of colors is
716 * specified, that is used instead.
717 * @private
718 */
719 Dygraph.prototype.setColors_ = function() {
720 var num = this.attr_("labels").length - 1;
721 this.colors_ = [];
722 var colors = this.attr_('colors');
723 if (!colors) {
724 var sat = this.attr_('colorSaturation') || 1.0;
725 var val = this.attr_('colorValue') || 0.5;
726 var half = Math.ceil(num / 2);
727 for (var i = 1; i <= num; i++) {
728 if (!this.visibility()[i-1]) continue;
729 // alternate colors for high contrast.
730 var idx = i % 2 ? Math.ceil(i / 2) : (half + i / 2);
731 var hue = (1.0 * idx/ (1 + num));
732 this.colors_.push(Dygraph.hsvToRGB(hue, sat, val));
733 }
734 } else {
735 for (var i = 0; i < num; i++) {
736 if (!this.visibility()[i]) continue;
737 var colorStr = colors[i % colors.length];
738 this.colors_.push(colorStr);
739 }
740 }
741
742 this.plotter_.setColors(this.colors_);
743 };
744
745 /**
746 * Return the list of colors. This is either the list of colors passed in the
747 * attributes or the autogenerated list of rgb(r,g,b) strings.
748 * @return {Array<string>} The list of colors.
749 */
750 Dygraph.prototype.getColors = function() {
751 return this.colors_;
752 };
753
754 /**
755 * Create the div that contains information on the selected point(s)
756 * This goes in the top right of the canvas, unless an external div has already
757 * been specified.
758 * @private
759 */
760 Dygraph.prototype.createStatusMessage_ = function() {
761 var userLabelsDiv = this.user_attrs_["labelsDiv"];
762 if (userLabelsDiv && null != userLabelsDiv
763 && (typeof(userLabelsDiv) == "string" || userLabelsDiv instanceof String)) {
764 this.user_attrs_["labelsDiv"] = document.getElementById(userLabelsDiv);
765 }
766 if (!this.attr_("labelsDiv")) {
767 var divWidth = this.attr_('labelsDivWidth');
768 var messagestyle = {
769 "position": "absolute",
770 "fontSize": "14px",
771 "zIndex": 10,
772 "width": divWidth + "px",
773 "top": "0px",
774 "left": (this.width_ - divWidth - 2) + "px",
775 "background": "white",
776 "textAlign": "left",
777 "overflow": "hidden"};
778 Dygraph.update(messagestyle, this.attr_('labelsDivStyles'));
779 var div = document.createElement("div");
780 for (var name in messagestyle) {
781 if (messagestyle.hasOwnProperty(name)) {
782 div.style[name] = messagestyle[name];
783 }
784 }
785 this.graphDiv.appendChild(div);
786 this.attrs_.labelsDiv = div;
787 }
788 };
789
790 /**
791 * Position the labels div so that:
792 * - its right edge is flush with the right edge of the charting area
793 * - its top edge is flush with the top edge of the charting area
794 * @private
795 */
796 Dygraph.prototype.positionLabelsDiv_ = function() {
797 // Don't touch a user-specified labelsDiv.
798 if (this.user_attrs_.hasOwnProperty("labelsDiv")) return;
799
800 var area = this.plotter_.area;
801 var div = this.attr_("labelsDiv");
802 div.style.left = area.x + area.w - this.attr_("labelsDivWidth") - 1 + "px";
803 div.style.top = area.y + "px";
804 };
805
806 /**
807 * Create the text box to adjust the averaging period
808 * @private
809 */
810 Dygraph.prototype.createRollInterface_ = function() {
811 // Create a roller if one doesn't exist already.
812 if (!this.roller_) {
813 this.roller_ = document.createElement("input");
814 this.roller_.type = "text";
815 this.roller_.style.display = "none";
816 this.graphDiv.appendChild(this.roller_);
817 }
818
819 var display = this.attr_('showRoller') ? 'block' : 'none';
820
821 var area = this.plotter_.area;
822 var textAttr = { "position": "absolute",
823 "zIndex": 10,
824 "top": (area.y + area.h - 25) + "px",
825 "left": (area.x + 1) + "px",
826 "display": display
827 };
828 this.roller_.size = "2";
829 this.roller_.value = this.rollPeriod_;
830 for (var name in textAttr) {
831 if (textAttr.hasOwnProperty(name)) {
832 this.roller_.style[name] = textAttr[name];
833 }
834 }
835
836 var dygraph = this;
837 this.roller_.onchange = function() { dygraph.adjustRoll(dygraph.roller_.value); };
838 };
839
840 /**
841 * @private
842 * Converts page the x-coordinate of the event to pixel x-coordinates on the
843 * canvas (i.e. DOM Coords).
844 */
845 Dygraph.prototype.dragGetX_ = function(e, context) {
846 return Dygraph.pageX(e) - context.px
847 };
848
849 /**
850 * @private
851 * Converts page the y-coordinate of the event to pixel y-coordinates on the
852 * canvas (i.e. DOM Coords).
853 */
854 Dygraph.prototype.dragGetY_ = function(e, context) {
855 return Dygraph.pageY(e) - context.py
856 };
857
858 /**
859 * Set up all the mouse handlers needed to capture dragging behavior for zoom
860 * events.
861 * @private
862 */
863 Dygraph.prototype.createDragInterface_ = function() {
864 var context = {
865 // Tracks whether the mouse is down right now
866 isZooming: false,
867 isPanning: false, // is this drag part of a pan?
868 is2DPan: false, // if so, is that pan 1- or 2-dimensional?
869 dragStartX: null, // pixel coordinates
870 dragStartY: null, // pixel coordinates
871 dragEndX: null, // pixel coordinates
872 dragEndY: null, // pixel coordinates
873 dragDirection: null,
874 prevEndX: null, // pixel coordinates
875 prevEndY: null, // pixel coordinates
876 prevDragDirection: null,
877
878 // The value on the left side of the graph when a pan operation starts.
879 initialLeftmostDate: null,
880
881 // The number of units each pixel spans. (This won't be valid for log
882 // scales)
883 xUnitsPerPixel: null,
884
885 // TODO(danvk): update this comment
886 // The range in second/value units that the viewport encompasses during a
887 // panning operation.
888 dateRange: null,
889
890 // Top-left corner of the canvas, in DOM coords
891 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
892 px: 0,
893 py: 0,
894
895 // Values for use with panEdgeFraction, which limit how far outside the
896 // graph's data boundaries it can be panned.
897 boundedDates: null, // [minDate, maxDate]
898 boundedValues: null, // [[minValue, maxValue] ...]
899
900 initializeMouseDown: function(event, g, context) {
901 // prevents mouse drags from selecting page text.
902 if (event.preventDefault) {
903 event.preventDefault(); // Firefox, Chrome, etc.
904 } else {
905 event.returnValue = false; // IE
906 event.cancelBubble = true;
907 }
908
909 context.px = Dygraph.findPosX(g.canvas_);
910 context.py = Dygraph.findPosY(g.canvas_);
911 context.dragStartX = g.dragGetX_(event, context);
912 context.dragStartY = g.dragGetY_(event, context);
913 }
914 };
915
916 var interactionModel = this.attr_("interactionModel");
917
918 // Self is the graph.
919 var self = this;
920
921 // Function that binds the graph and context to the handler.
922 var bindHandler = function(handler) {
923 return function(event) {
924 handler(event, self, context);
925 };
926 };
927
928 for (var eventName in interactionModel) {
929 if (!interactionModel.hasOwnProperty(eventName)) continue;
930 Dygraph.addEvent(this.mouseEventElement_, eventName,
931 bindHandler(interactionModel[eventName]));
932 }
933
934 // If the user releases the mouse button during a drag, but not over the
935 // canvas, then it doesn't count as a zooming action.
936 Dygraph.addEvent(document, 'mouseup', function(event) {
937 if (context.isZooming || context.isPanning) {
938 context.isZooming = false;
939 context.dragStartX = null;
940 context.dragStartY = null;
941 }
942
943 if (context.isPanning) {
944 context.isPanning = false;
945 context.draggingDate = null;
946 context.dateRange = null;
947 for (var i = 0; i < self.axes_.length; i++) {
948 delete self.axes_[i].draggingValue;
949 delete self.axes_[i].dragValueRange;
950 }
951 }
952 });
953 };
954
955
956 /**
957 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
958 * up any previous zoom rectangles that were drawn. This could be optimized to
959 * avoid extra redrawing, but it's tricky to avoid interactions with the status
960 * dots.
961 *
962 * @param {Number} direction the direction of the zoom rectangle. Acceptable
963 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
964 * @param {Number} startX The X position where the drag started, in canvas
965 * coordinates.
966 * @param {Number} endX The current X position of the drag, in canvas coords.
967 * @param {Number} startY The Y position where the drag started, in canvas
968 * coordinates.
969 * @param {Number} endY The current Y position of the drag, in canvas coords.
970 * @param {Number} prevDirection the value of direction on the previous call to
971 * this function. Used to avoid excess redrawing
972 * @param {Number} prevEndX The value of endX on the previous call to this
973 * function. Used to avoid excess redrawing
974 * @param {Number} prevEndY The value of endY on the previous call to this
975 * function. Used to avoid excess redrawing
976 * @private
977 */
978 Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY,
979 endY, prevDirection, prevEndX,
980 prevEndY) {
981 var ctx = this.canvas_ctx_;
982
983 // Clean up from the previous rect if necessary
984 if (prevDirection == Dygraph.HORIZONTAL) {
985 ctx.clearRect(Math.min(startX, prevEndX), 0,
986 Math.abs(startX - prevEndX), this.height_);
987 } else if (prevDirection == Dygraph.VERTICAL){
988 ctx.clearRect(0, Math.min(startY, prevEndY),
989 this.width_, Math.abs(startY - prevEndY));
990 }
991
992 // Draw a light-grey rectangle to show the new viewing area
993 if (direction == Dygraph.HORIZONTAL) {
994 if (endX && startX) {
995 ctx.fillStyle = "rgba(128,128,128,0.33)";
996 ctx.fillRect(Math.min(startX, endX), 0,
997 Math.abs(endX - startX), this.height_);
998 }
999 }
1000 if (direction == Dygraph.VERTICAL) {
1001 if (endY && startY) {
1002 ctx.fillStyle = "rgba(128,128,128,0.33)";
1003 ctx.fillRect(0, Math.min(startY, endY),
1004 this.width_, Math.abs(endY - startY));
1005 }
1006 }
1007 };
1008
1009 /**
1010 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1011 * the canvas. The exact zoom window may be slightly larger if there are no data
1012 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1013 * which accepts dates that match the raw data. This function redraws the graph.
1014 *
1015 * @param {Number} lowX The leftmost pixel value that should be visible.
1016 * @param {Number} highX The rightmost pixel value that should be visible.
1017 * @private
1018 */
1019 Dygraph.prototype.doZoomX_ = function(lowX, highX) {
1020 // Find the earliest and latest dates contained in this canvasx range.
1021 // Convert the call to date ranges of the raw data.
1022 var minDate = this.toDataXCoord(lowX);
1023 var maxDate = this.toDataXCoord(highX);
1024 this.doZoomXDates_(minDate, maxDate);
1025 };
1026
1027 /**
1028 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1029 * method with doZoomX which accepts pixel coordinates. This function redraws
1030 * the graph.
1031 *
1032 * @param {Number} minDate The minimum date that should be visible.
1033 * @param {Number} maxDate The maximum date that should be visible.
1034 * @private
1035 */
1036 Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
1037 this.dateWindow_ = [minDate, maxDate];
1038 this.zoomed_x_ = true;
1039 this.drawGraph_();
1040 if (this.attr_("zoomCallback")) {
1041 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1042 }
1043 };
1044
1045 /**
1046 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1047 * the canvas. This function redraws the graph.
1048 *
1049 * @param {Number} lowY The topmost pixel value that should be visible.
1050 * @param {Number} highY The lowest pixel value that should be visible.
1051 * @private
1052 */
1053 Dygraph.prototype.doZoomY_ = function(lowY, highY) {
1054 // Find the highest and lowest values in pixel range for each axis.
1055 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1056 // This is because pixels increase as you go down on the screen, whereas data
1057 // coordinates increase as you go up the screen.
1058 var valueRanges = [];
1059 for (var i = 0; i < this.axes_.length; i++) {
1060 var hi = this.toDataYCoord(lowY, i);
1061 var low = this.toDataYCoord(highY, i);
1062 this.axes_[i].valueWindow = [low, hi];
1063 valueRanges.push([low, hi]);
1064 }
1065
1066 this.zoomed_y_ = true;
1067 this.drawGraph_();
1068 if (this.attr_("zoomCallback")) {
1069 var xRange = this.xAxisRange();
1070 var yRange = this.yAxisRange();
1071 this.attr_("zoomCallback")(xRange[0], xRange[1], this.yAxisRanges());
1072 }
1073 };
1074
1075 /**
1076 * Reset the zoom to the original view coordinates. This is the same as
1077 * double-clicking on the graph.
1078 *
1079 * @private
1080 */
1081 Dygraph.prototype.doUnzoom_ = function() {
1082 var dirty = false;
1083 if (this.dateWindow_ != null) {
1084 dirty = true;
1085 this.dateWindow_ = null;
1086 }
1087
1088 for (var i = 0; i < this.axes_.length; i++) {
1089 if (this.axes_[i].valueWindow != null) {
1090 dirty = true;
1091 delete this.axes_[i].valueWindow;
1092 }
1093 }
1094
1095 // Clear any selection, since it's likely to be drawn in the wrong place.
1096 this.clearSelection();
1097
1098 if (dirty) {
1099 // Putting the drawing operation before the callback because it resets
1100 // yAxisRange.
1101 this.zoomed_x_ = false;
1102 this.zoomed_y_ = false;
1103 this.drawGraph_();
1104 if (this.attr_("zoomCallback")) {
1105 var minDate = this.rawData_[0][0];
1106 var maxDate = this.rawData_[this.rawData_.length - 1][0];
1107 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1108 }
1109 }
1110 };
1111
1112 /**
1113 * When the mouse moves in the canvas, display information about a nearby data
1114 * point and draw dots over those points in the data series. This function
1115 * takes care of cleanup of previously-drawn dots.
1116 * @param {Object} event The mousemove event from the browser.
1117 * @private
1118 */
1119 Dygraph.prototype.mouseMove_ = function(event) {
1120 // This prevents JS errors when mousing over the canvas before data loads.
1121 var points = this.layout_.points;
1122 if (points === undefined) return;
1123
1124 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
1125
1126 var lastx = -1;
1127 var lasty = -1;
1128
1129 // Loop through all the points and find the date nearest to our current
1130 // location.
1131 var minDist = 1e+100;
1132 var idx = -1;
1133 for (var i = 0; i < points.length; i++) {
1134 var point = points[i];
1135 if (point == null) continue;
1136 var dist = Math.abs(point.canvasx - canvasx);
1137 if (dist > minDist) continue;
1138 minDist = dist;
1139 idx = i;
1140 }
1141 if (idx >= 0) lastx = points[idx].xval;
1142
1143 // Extract the points we've selected
1144 this.selPoints_ = [];
1145 var l = points.length;
1146 if (!this.attr_("stackedGraph")) {
1147 for (var i = 0; i < l; i++) {
1148 if (points[i].xval == lastx) {
1149 this.selPoints_.push(points[i]);
1150 }
1151 }
1152 } else {
1153 // Need to 'unstack' points starting from the bottom
1154 var cumulative_sum = 0;
1155 for (var i = l - 1; i >= 0; i--) {
1156 if (points[i].xval == lastx) {
1157 var p = {}; // Clone the point since we modify it
1158 for (var k in points[i]) {
1159 p[k] = points[i][k];
1160 }
1161 p.yval -= cumulative_sum;
1162 cumulative_sum += p.yval;
1163 this.selPoints_.push(p);
1164 }
1165 }
1166 this.selPoints_.reverse();
1167 }
1168
1169 if (this.attr_("highlightCallback")) {
1170 var px = this.lastx_;
1171 if (px !== null && lastx != px) {
1172 // only fire if the selected point has changed.
1173 this.attr_("highlightCallback")(event, lastx, this.selPoints_, this.idxToRow_(idx));
1174 }
1175 }
1176
1177 // Save last x position for callbacks.
1178 this.lastx_ = lastx;
1179
1180 this.updateSelection_();
1181 };
1182
1183 /**
1184 * Transforms layout_.points index into data row number.
1185 * @param int layout_.points index
1186 * @return int row number, or -1 if none could be found.
1187 * @private
1188 */
1189 Dygraph.prototype.idxToRow_ = function(idx) {
1190 if (idx < 0) return -1;
1191
1192 for (var i in this.layout_.datasets) {
1193 if (idx < this.layout_.datasets[i].length) {
1194 return this.boundaryIds_[0][0]+idx;
1195 }
1196 idx -= this.layout_.datasets[i].length;
1197 }
1198 return -1;
1199 };
1200
1201 /**
1202 * @private
1203 * Generates HTML for the legend which is displayed when hovering over the
1204 * chart. If no selected points are specified, a default legend is returned
1205 * (this may just be the empty string).
1206 * @param { Number } [x] The x-value of the selected points.
1207 * @param { [Object] } [sel_points] List of selected points for the given
1208 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1209 */
1210 Dygraph.prototype.generateLegendHTML_ = function(x, sel_points) {
1211 // If no points are selected, we display a default legend. Traditionally,
1212 // this has been blank. But a better default would be a conventional legend,
1213 // which provides essential information for a non-interactive chart.
1214 if (typeof(x) === 'undefined') {
1215 if (this.attr_('legend') != 'always') return '';
1216
1217 var sepLines = this.attr_('labelsSeparateLines');
1218 var labels = this.attr_('labels');
1219 var html = '';
1220 for (var i = 1; i < labels.length; i++) {
1221 if (!this.visibility()[i - 1]) continue;
1222 var c = this.plotter_.colors[labels[i]];
1223 if (html != '') html += (sepLines ? '<br/>' : ' ');
1224 html += "<b><span style='color: " + c + ";'>&mdash;" + labels[i] +
1225 "</span></b>";
1226 }
1227 return html;
1228 }
1229
1230 var html = this.attr_('xValueFormatter')(x) + ":";
1231
1232 var fmtFunc = this.attr_('yValueFormatter');
1233 var showZeros = this.attr_("labelsShowZeroValues");
1234 var sepLines = this.attr_("labelsSeparateLines");
1235 for (var i = 0; i < this.selPoints_.length; i++) {
1236 var pt = this.selPoints_[i];
1237 if (pt.yval == 0 && !showZeros) continue;
1238 if (!Dygraph.isOK(pt.canvasy)) continue;
1239 if (sepLines) html += "<br/>";
1240
1241 var c = this.plotter_.colors[pt.name];
1242 var yval = fmtFunc(pt.yval, this);
1243 // TODO(danvk): use a template string here and make it an attribute.
1244 html += " <b><span style='color: " + c + ";'>"
1245 + pt.name + "</span></b>:"
1246 + yval;
1247 }
1248 return html;
1249 };
1250
1251 /**
1252 * @private
1253 * Displays information about the selected points in the legend. If there is no
1254 * selection, the legend will be cleared.
1255 * @param { Number } [x] The x-value of the selected points.
1256 * @param { [Object] } [sel_points] List of selected points for the given
1257 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1258 */
1259 Dygraph.prototype.setLegendHTML_ = function(x, sel_points) {
1260 var html = this.generateLegendHTML_(x, sel_points);
1261 var labelsDiv = this.attr_("labelsDiv");
1262 if (labelsDiv !== null) {
1263 labelsDiv.innerHTML = html;
1264 } else {
1265 if (typeof(this.shown_legend_error_) == 'undefined') {
1266 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1267 this.shown_legend_error_ = true;
1268 }
1269 }
1270 };
1271
1272 /**
1273 * Draw dots over the selectied points in the data series. This function
1274 * takes care of cleanup of previously-drawn dots.
1275 * @private
1276 */
1277 Dygraph.prototype.updateSelection_ = function() {
1278 // Clear the previously drawn vertical, if there is one
1279 var ctx = this.canvas_ctx_;
1280 if (this.previousVerticalX_ >= 0) {
1281 // Determine the maximum highlight circle size.
1282 var maxCircleSize = 0;
1283 var labels = this.attr_('labels');
1284 for (var i = 1; i < labels.length; i++) {
1285 var r = this.attr_('highlightCircleSize', labels[i]);
1286 if (r > maxCircleSize) maxCircleSize = r;
1287 }
1288 var px = this.previousVerticalX_;
1289 ctx.clearRect(px - maxCircleSize - 1, 0,
1290 2 * maxCircleSize + 2, this.height_);
1291 }
1292
1293 if (this.selPoints_.length > 0) {
1294 // Set the status message to indicate the selected point(s)
1295 if (this.attr_('showLabelsOnHighlight')) {
1296 this.setLegendHTML_(this.lastx_, this.selPoints_);
1297 }
1298
1299 // Draw colored circles over the center of each selected point
1300 var canvasx = this.selPoints_[0].canvasx;
1301 ctx.save();
1302 for (var i = 0; i < this.selPoints_.length; i++) {
1303 var pt = this.selPoints_[i];
1304 if (!Dygraph.isOK(pt.canvasy)) continue;
1305
1306 var circleSize = this.attr_('highlightCircleSize', pt.name);
1307 ctx.beginPath();
1308 ctx.fillStyle = this.plotter_.colors[pt.name];
1309 ctx.arc(canvasx, pt.canvasy, circleSize, 0, 2 * Math.PI, false);
1310 ctx.fill();
1311 }
1312 ctx.restore();
1313
1314 this.previousVerticalX_ = canvasx;
1315 }
1316 };
1317
1318 /**
1319 * Manually set the selected points and display information about them in the
1320 * legend. The selection can be cleared using clearSelection() and queried
1321 * using getSelection().
1322 * @param { Integer } row number that should be highlighted (i.e. appear with
1323 * hover dots on the chart). Set to false to clear any selection.
1324 */
1325 Dygraph.prototype.setSelection = function(row) {
1326 // Extract the points we've selected
1327 this.selPoints_ = [];
1328 var pos = 0;
1329
1330 if (row !== false) {
1331 row = row-this.boundaryIds_[0][0];
1332 }
1333
1334 if (row !== false && row >= 0) {
1335 for (var i in this.layout_.datasets) {
1336 if (row < this.layout_.datasets[i].length) {
1337 var point = this.layout_.points[pos+row];
1338
1339 if (this.attr_("stackedGraph")) {
1340 point = this.layout_.unstackPointAtIndex(pos+row);
1341 }
1342
1343 this.selPoints_.push(point);
1344 }
1345 pos += this.layout_.datasets[i].length;
1346 }
1347 }
1348
1349 if (this.selPoints_.length) {
1350 this.lastx_ = this.selPoints_[0].xval;
1351 this.updateSelection_();
1352 } else {
1353 this.clearSelection();
1354 }
1355
1356 };
1357
1358 /**
1359 * The mouse has left the canvas. Clear out whatever artifacts remain
1360 * @param {Object} event the mouseout event from the browser.
1361 * @private
1362 */
1363 Dygraph.prototype.mouseOut_ = function(event) {
1364 if (this.attr_("unhighlightCallback")) {
1365 this.attr_("unhighlightCallback")(event);
1366 }
1367
1368 if (this.attr_("hideOverlayOnMouseOut")) {
1369 this.clearSelection();
1370 }
1371 };
1372
1373 /**
1374 * Clears the current selection (i.e. points that were highlighted by moving
1375 * the mouse over the chart).
1376 */
1377 Dygraph.prototype.clearSelection = function() {
1378 // Get rid of the overlay data
1379 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
1380 this.setLegendHTML_();
1381 this.selPoints_ = [];
1382 this.lastx_ = -1;
1383 }
1384
1385 /**
1386 * Returns the number of the currently selected row. To get data for this row,
1387 * you can use the getValue method.
1388 * @return { Integer } row number, or -1 if nothing is selected
1389 */
1390 Dygraph.prototype.getSelection = function() {
1391 if (!this.selPoints_ || this.selPoints_.length < 1) {
1392 return -1;
1393 }
1394
1395 for (var row=0; row<this.layout_.points.length; row++ ) {
1396 if (this.layout_.points[row].x == this.selPoints_[0].x) {
1397 return row + this.boundaryIds_[0][0];
1398 }
1399 }
1400 return -1;
1401 };
1402
1403 /**
1404 * @private
1405 * Return a string version of a number. This respects the digitsAfterDecimal
1406 * and maxNumberWidth options.
1407 * @param {Number} x The number to be formatted
1408 * @param {Dygraph} g The dygraph object
1409 */
1410 Dygraph.numberFormatter = function(x, g) {
1411 var sigFigs = g.attr_('sigFigs');
1412
1413 if (sigFigs !== null) {
1414 // User has opted for a fixed number of significant figures.
1415 return Dygraph.floatFormat(x, sigFigs);
1416 }
1417
1418 var digits = g.attr_('digitsAfterDecimal');
1419 var maxNumberWidth = g.attr_('maxNumberWidth');
1420
1421 // switch to scientific notation if we underflow or overflow fixed display.
1422 if (x !== 0.0 &&
1423 (Math.abs(x) >= Math.pow(10, maxNumberWidth) ||
1424 Math.abs(x) < Math.pow(10, -digits))) {
1425 return x.toExponential(digits);
1426 } else {
1427 return '' + Dygraph.round_(x, digits);
1428 }
1429 };
1430
1431 /**
1432 * Convert a JS date to a string appropriate to display on an axis that
1433 * is displaying values at the stated granularity.
1434 * @param {Date} date The date to format
1435 * @param {Number} granularity One of the Dygraph granularity constants
1436 * @return {String} The formatted date
1437 * @private
1438 */
1439 Dygraph.dateAxisFormatter = function(date, granularity) {
1440 if (granularity >= Dygraph.DECADAL) {
1441 return date.strftime('%Y');
1442 } else if (granularity >= Dygraph.MONTHLY) {
1443 return date.strftime('%b %y');
1444 } else {
1445 var frac = date.getHours() * 3600 + date.getMinutes() * 60 + date.getSeconds() + date.getMilliseconds();
1446 if (frac == 0 || granularity >= Dygraph.DAILY) {
1447 return new Date(date.getTime() + 3600*1000).strftime('%d%b');
1448 } else {
1449 return Dygraph.hmsString_(date.getTime());
1450 }
1451 }
1452 };
1453
1454 /**
1455 * Fires when there's data available to be graphed.
1456 * @param {String} data Raw CSV data to be plotted
1457 * @private
1458 */
1459 Dygraph.prototype.loadedEvent_ = function(data) {
1460 this.rawData_ = this.parseCSV_(data);
1461 this.predraw_();
1462 };
1463
1464 Dygraph.prototype.months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
1465 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
1466 Dygraph.prototype.quarters = ["Jan", "Apr", "Jul", "Oct"];
1467
1468 /**
1469 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1470 * @private
1471 */
1472 Dygraph.prototype.addXTicks_ = function() {
1473 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1474 var range;
1475 if (this.dateWindow_) {
1476 range = [this.dateWindow_[0], this.dateWindow_[1]];
1477 } else {
1478 range = [this.rawData_[0][0], this.rawData_[this.rawData_.length - 1][0]];
1479 }
1480
1481 var xTicks = this.attr_('xTicker')(range[0], range[1], this);
1482 this.layout_.setXTicks(xTicks);
1483 };
1484
1485 // Time granularity enumeration
1486 Dygraph.SECONDLY = 0;
1487 Dygraph.TWO_SECONDLY = 1;
1488 Dygraph.FIVE_SECONDLY = 2;
1489 Dygraph.TEN_SECONDLY = 3;
1490 Dygraph.THIRTY_SECONDLY = 4;
1491 Dygraph.MINUTELY = 5;
1492 Dygraph.TWO_MINUTELY = 6;
1493 Dygraph.FIVE_MINUTELY = 7;
1494 Dygraph.TEN_MINUTELY = 8;
1495 Dygraph.THIRTY_MINUTELY = 9;
1496 Dygraph.HOURLY = 10;
1497 Dygraph.TWO_HOURLY = 11;
1498 Dygraph.SIX_HOURLY = 12;
1499 Dygraph.DAILY = 13;
1500 Dygraph.WEEKLY = 14;
1501 Dygraph.MONTHLY = 15;
1502 Dygraph.QUARTERLY = 16;
1503 Dygraph.BIANNUAL = 17;
1504 Dygraph.ANNUAL = 18;
1505 Dygraph.DECADAL = 19;
1506 Dygraph.CENTENNIAL = 20;
1507 Dygraph.NUM_GRANULARITIES = 21;
1508
1509 Dygraph.SHORT_SPACINGS = [];
1510 Dygraph.SHORT_SPACINGS[Dygraph.SECONDLY] = 1000 * 1;
1511 Dygraph.SHORT_SPACINGS[Dygraph.TWO_SECONDLY] = 1000 * 2;
1512 Dygraph.SHORT_SPACINGS[Dygraph.FIVE_SECONDLY] = 1000 * 5;
1513 Dygraph.SHORT_SPACINGS[Dygraph.TEN_SECONDLY] = 1000 * 10;
1514 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_SECONDLY] = 1000 * 30;
1515 Dygraph.SHORT_SPACINGS[Dygraph.MINUTELY] = 1000 * 60;
1516 Dygraph.SHORT_SPACINGS[Dygraph.TWO_MINUTELY] = 1000 * 60 * 2;
1517 Dygraph.SHORT_SPACINGS[Dygraph.FIVE_MINUTELY] = 1000 * 60 * 5;
1518 Dygraph.SHORT_SPACINGS[Dygraph.TEN_MINUTELY] = 1000 * 60 * 10;
1519 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_MINUTELY] = 1000 * 60 * 30;
1520 Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600;
1521 Dygraph.SHORT_SPACINGS[Dygraph.TWO_HOURLY] = 1000 * 3600 * 2;
1522 Dygraph.SHORT_SPACINGS[Dygraph.SIX_HOURLY] = 1000 * 3600 * 6;
1523 Dygraph.SHORT_SPACINGS[Dygraph.DAILY] = 1000 * 86400;
1524 Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY] = 1000 * 604800;
1525
1526 /**
1527 * @private
1528 * If we used this time granularity, how many ticks would there be?
1529 * This is only an approximation, but it's generally good enough.
1530 */
1531 Dygraph.prototype.NumXTicks = function(start_time, end_time, granularity) {
1532 if (granularity < Dygraph.MONTHLY) {
1533 // Generate one tick mark for every fixed interval of time.
1534 var spacing = Dygraph.SHORT_SPACINGS[granularity];
1535 return Math.floor(0.5 + 1.0 * (end_time - start_time) / spacing);
1536 } else {
1537 var year_mod = 1; // e.g. to only print one point every 10 years.
1538 var num_months = 12;
1539 if (granularity == Dygraph.QUARTERLY) num_months = 3;
1540 if (granularity == Dygraph.BIANNUAL) num_months = 2;
1541 if (granularity == Dygraph.ANNUAL) num_months = 1;
1542 if (granularity == Dygraph.DECADAL) { num_months = 1; year_mod = 10; }
1543 if (granularity == Dygraph.CENTENNIAL) { num_months = 1; year_mod = 100; }
1544
1545 var msInYear = 365.2524 * 24 * 3600 * 1000;
1546 var num_years = 1.0 * (end_time - start_time) / msInYear;
1547 return Math.floor(0.5 + 1.0 * num_years * num_months / year_mod);
1548 }
1549 };
1550
1551 /**
1552 * @private
1553 *
1554 * Construct an x-axis of nicely-formatted times on meaningful boundaries
1555 * (e.g. 'Jan 09' rather than 'Jan 22, 2009').
1556 *
1557 * Returns an array containing {v: millis, label: label} dictionaries.
1558 */
1559 Dygraph.prototype.GetXAxis = function(start_time, end_time, granularity) {
1560 var formatter = this.attr_("xAxisLabelFormatter");
1561 var ticks = [];
1562 if (granularity < Dygraph.MONTHLY) {
1563 // Generate one tick mark for every fixed interval of time.
1564 var spacing = Dygraph.SHORT_SPACINGS[granularity];
1565 var format = '%d%b'; // e.g. "1Jan"
1566
1567 // Find a time less than start_time which occurs on a "nice" time boundary
1568 // for this granularity.
1569 var g = spacing / 1000;
1570 var d = new Date(start_time);
1571 if (g <= 60) { // seconds
1572 var x = d.getSeconds(); d.setSeconds(x - x % g);
1573 } else {
1574 d.setSeconds(0);
1575 g /= 60;
1576 if (g <= 60) { // minutes
1577 var x = d.getMinutes(); d.setMinutes(x - x % g);
1578 } else {
1579 d.setMinutes(0);
1580 g /= 60;
1581
1582 if (g <= 24) { // days
1583 var x = d.getHours(); d.setHours(x - x % g);
1584 } else {
1585 d.setHours(0);
1586 g /= 24;
1587
1588 if (g == 7) { // one week
1589 d.setDate(d.getDate() - d.getDay());
1590 }
1591 }
1592 }
1593 }
1594 start_time = d.getTime();
1595
1596 for (var t = start_time; t <= end_time; t += spacing) {
1597 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
1598 }
1599 } else {
1600 // Display a tick mark on the first of a set of months of each year.
1601 // Years get a tick mark iff y % year_mod == 0. This is useful for
1602 // displaying a tick mark once every 10 years, say, on long time scales.
1603 var months;
1604 var year_mod = 1; // e.g. to only print one point every 10 years.
1605
1606 if (granularity == Dygraph.MONTHLY) {
1607 months = [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
1608 } else if (granularity == Dygraph.QUARTERLY) {
1609 months = [ 0, 3, 6, 9 ];
1610 } else if (granularity == Dygraph.BIANNUAL) {
1611 months = [ 0, 6 ];
1612 } else if (granularity == Dygraph.ANNUAL) {
1613 months = [ 0 ];
1614 } else if (granularity == Dygraph.DECADAL) {
1615 months = [ 0 ];
1616 year_mod = 10;
1617 } else if (granularity == Dygraph.CENTENNIAL) {
1618 months = [ 0 ];
1619 year_mod = 100;
1620 } else {
1621 this.warn("Span of dates is too long");
1622 }
1623
1624 var start_year = new Date(start_time).getFullYear();
1625 var end_year = new Date(end_time).getFullYear();
1626 var zeropad = Dygraph.zeropad;
1627 for (var i = start_year; i <= end_year; i++) {
1628 if (i % year_mod != 0) continue;
1629 for (var j = 0; j < months.length; j++) {
1630 var date_str = i + "/" + zeropad(1 + months[j]) + "/01";
1631 var t = Dygraph.dateStrToMillis(date_str);
1632 if (t < start_time || t > end_time) continue;
1633 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
1634 }
1635 }
1636 }
1637
1638 return ticks;
1639 };
1640
1641
1642 /**
1643 * Add ticks to the x-axis based on a date range.
1644 * @param {Number} startDate Start of the date window (millis since epoch)
1645 * @param {Number} endDate End of the date window (millis since epoch)
1646 * @param {Dygraph} self The dygraph object
1647 * @return { [Object] } Array of {label, value} tuples.
1648 * @public
1649 */
1650 Dygraph.dateTicker = function(startDate, endDate, self) {
1651 // TODO(danvk): why does this take 'self' as a param?
1652 var chosen = -1;
1653 for (var i = 0; i < Dygraph.NUM_GRANULARITIES; i++) {
1654 var num_ticks = self.NumXTicks(startDate, endDate, i);
1655 if (self.width_ / num_ticks >= self.attr_('pixelsPerXLabel')) {
1656 chosen = i;
1657 break;
1658 }
1659 }
1660
1661 if (chosen >= 0) {
1662 return self.GetXAxis(startDate, endDate, chosen);
1663 } else {
1664 // TODO(danvk): signal error.
1665 }
1666 };
1667
1668 /**
1669 * @private
1670 * This is a list of human-friendly values at which to show tick marks on a log
1671 * scale. It is k * 10^n, where k=1..9 and n=-39..+39, so:
1672 * ..., 1, 2, 3, 4, 5, ..., 9, 10, 20, 30, ..., 90, 100, 200, 300, ...
1673 * NOTE: this assumes that Dygraph.LOG_SCALE = 10.
1674 */
1675 Dygraph.PREFERRED_LOG_TICK_VALUES = function() {
1676 var vals = [];
1677 for (var power = -39; power <= 39; power++) {
1678 var range = Math.pow(10, power);
1679 for (var mult = 1; mult <= 9; mult++) {
1680 var val = range * mult;
1681 vals.push(val);
1682 }
1683 }
1684 return vals;
1685 }();
1686
1687 // TODO(konigsberg): Update comment.
1688 /**
1689 * Add ticks when the x axis has numbers on it (instead of dates)
1690 *
1691 * @param {Number} minV minimum value
1692 * @param {Number} maxV maximum value
1693 * @param self
1694 * @param {function} attribute accessor function.
1695 * @return {[Object]} Array of {label, value} tuples.
1696 */
1697 Dygraph.numericTicks = function(minV, maxV, self, axis_props, vals) {
1698 var attr = function(k) {
1699 if (axis_props && axis_props.hasOwnProperty(k)) return axis_props[k];
1700 return self.attr_(k);
1701 };
1702
1703 var ticks = [];
1704 if (vals) {
1705 for (var i = 0; i < vals.length; i++) {
1706 ticks.push({v: vals[i]});
1707 }
1708 } else {
1709 if (axis_props && attr("logscale")) {
1710 var pixelsPerTick = attr('pixelsPerYLabel');
1711 // NOTE(konigsberg): Dan, should self.height_ be self.plotter_.area.h?
1712 var nTicks = Math.floor(self.height_ / pixelsPerTick);
1713 var minIdx = Dygraph.binarySearch(minV, Dygraph.PREFERRED_LOG_TICK_VALUES, 1);
1714 var maxIdx = Dygraph.binarySearch(maxV, Dygraph.PREFERRED_LOG_TICK_VALUES, -1);
1715 if (minIdx == -1) {
1716 minIdx = 0;
1717 }
1718 if (maxIdx == -1) {
1719 maxIdx = Dygraph.PREFERRED_LOG_TICK_VALUES.length - 1;
1720 }
1721 // Count the number of tick values would appear, if we can get at least
1722 // nTicks / 4 accept them.
1723 var lastDisplayed = null;
1724 if (maxIdx - minIdx >= nTicks / 4) {
1725 var axisId = axis_props.yAxisId;
1726 for (var idx = maxIdx; idx >= minIdx; idx--) {
1727 var tickValue = Dygraph.PREFERRED_LOG_TICK_VALUES[idx];
1728 var domCoord = axis_props.g.toDomYCoord(tickValue, axisId);
1729 var tick = { v: tickValue };
1730 if (lastDisplayed == null) {
1731 lastDisplayed = {
1732 tickValue : tickValue,
1733 domCoord : domCoord
1734 };
1735 } else {
1736 if (domCoord - lastDisplayed.domCoord >= pixelsPerTick) {
1737 lastDisplayed = {
1738 tickValue : tickValue,
1739 domCoord : domCoord
1740 };
1741 } else {
1742 tick.label = "";
1743 }
1744 }
1745 ticks.push(tick);
1746 }
1747 // Since we went in backwards order.
1748 ticks.reverse();
1749 }
1750 }
1751
1752 // ticks.length won't be 0 if the log scale function finds values to insert.
1753 if (ticks.length == 0) {
1754 // Basic idea:
1755 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
1756 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks).
1757 // The first spacing greater than pixelsPerYLabel is what we use.
1758 // TODO(danvk): version that works on a log scale.
1759 if (attr("labelsKMG2")) {
1760 var mults = [1, 2, 4, 8];
1761 } else {
1762 var mults = [1, 2, 5];
1763 }
1764 var scale, low_val, high_val, nTicks;
1765 // TODO(danvk): make it possible to set this for x- and y-axes independently.
1766 var pixelsPerTick = attr('pixelsPerYLabel');
1767 for (var i = -10; i < 50; i++) {
1768 if (attr("labelsKMG2")) {
1769 var base_scale = Math.pow(16, i);
1770 } else {
1771 var base_scale = Math.pow(10, i);
1772 }
1773 for (var j = 0; j < mults.length; j++) {
1774 scale = base_scale * mults[j];
1775 low_val = Math.floor(minV / scale) * scale;
1776 high_val = Math.ceil(maxV / scale) * scale;
1777 nTicks = Math.abs(high_val - low_val) / scale;
1778 var spacing = self.height_ / nTicks;
1779 // wish I could break out of both loops at once...
1780 if (spacing > pixelsPerTick) break;
1781 }
1782 if (spacing > pixelsPerTick) break;
1783 }
1784
1785 // Construct the set of ticks.
1786 // Allow reverse y-axis if it's explicitly requested.
1787 if (low_val > high_val) scale *= -1;
1788 for (var i = 0; i < nTicks; i++) {
1789 var tickV = low_val + i * scale;
1790 ticks.push( {v: tickV} );
1791 }
1792 }
1793 }
1794
1795 // Add formatted labels to the ticks.
1796 var k;
1797 var k_labels = [];
1798 if (attr("labelsKMB")) {
1799 k = 1000;
1800 k_labels = [ "K", "M", "B", "T" ];
1801 }
1802 if (attr("labelsKMG2")) {
1803 if (k) self.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
1804 k = 1024;
1805 k_labels = [ "k", "M", "G", "T" ];
1806 }
1807 var formatter = attr('yAxisLabelFormatter') ?
1808 attr('yAxisLabelFormatter') : attr('yValueFormatter');
1809
1810 // Add labels to the ticks.
1811 for (var i = 0; i < ticks.length; i++) {
1812 if (ticks[i].label !== undefined) continue; // Use current label.
1813 var tickV = ticks[i].v;
1814 var absTickV = Math.abs(tickV);
1815 var label = formatter(tickV, self);
1816 if (k_labels.length > 0) {
1817 // Round up to an appropriate unit.
1818 var n = k*k*k*k;
1819 for (var j = 3; j >= 0; j--, n /= k) {
1820 if (absTickV >= n) {
1821 label = Dygraph.round_(tickV / n, attr('digitsAfterDecimal')) + k_labels[j];
1822 break;
1823 }
1824 }
1825 }
1826 ticks[i].label = label;
1827 }
1828
1829 return ticks;
1830 };
1831
1832 /**
1833 * @private
1834 * Computes the range of the data series (including confidence intervals).
1835 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
1836 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
1837 * @return [low, high]
1838 */
1839 Dygraph.prototype.extremeValues_ = function(series) {
1840 var minY = null, maxY = null;
1841
1842 var bars = this.attr_("errorBars") || this.attr_("customBars");
1843 if (bars) {
1844 // With custom bars, maxY is the max of the high values.
1845 for (var j = 0; j < series.length; j++) {
1846 var y = series[j][1][0];
1847 if (!y) continue;
1848 var low = y - series[j][1][1];
1849 var high = y + series[j][1][2];
1850 if (low > y) low = y; // this can happen with custom bars,
1851 if (high < y) high = y; // e.g. in tests/custom-bars.html
1852 if (maxY == null || high > maxY) {
1853 maxY = high;
1854 }
1855 if (minY == null || low < minY) {
1856 minY = low;
1857 }
1858 }
1859 } else {
1860 for (var j = 0; j < series.length; j++) {
1861 var y = series[j][1];
1862 if (y === null || isNaN(y)) continue;
1863 if (maxY == null || y > maxY) {
1864 maxY = y;
1865 }
1866 if (minY == null || y < minY) {
1867 minY = y;
1868 }
1869 }
1870 }
1871
1872 return [minY, maxY];
1873 };
1874
1875 /**
1876 * @private
1877 * This function is called once when the chart's data is changed or the options
1878 * dictionary is updated. It is _not_ called when the user pans or zooms. The
1879 * idea is that values derived from the chart's data can be computed here,
1880 * rather than every time the chart is drawn. This includes things like the
1881 * number of axes, rolling averages, etc.
1882 */
1883 Dygraph.prototype.predraw_ = function() {
1884 // TODO(danvk): move more computations out of drawGraph_ and into here.
1885 this.computeYAxes_();
1886
1887 // Create a new plotter.
1888 if (this.plotter_) this.plotter_.clear();
1889 this.plotter_ = new DygraphCanvasRenderer(this,
1890 this.hidden_,
1891 this.hidden_ctx_,
1892 this.layout_);
1893
1894 // The roller sits in the bottom left corner of the chart. We don't know where
1895 // this will be until the options are available, so it's positioned here.
1896 this.createRollInterface_();
1897
1898 // Same thing applies for the labelsDiv. It's right edge should be flush with
1899 // the right edge of the charting area (which may not be the same as the right
1900 // edge of the div, if we have two y-axes.
1901 this.positionLabelsDiv_();
1902
1903 // If the data or options have changed, then we'd better redraw.
1904 this.drawGraph_();
1905 };
1906
1907 /**
1908 * Update the graph with new data. This method is called when the viewing area
1909 * has changed. If the underlying data or options have changed, predraw_ will
1910 * be called before drawGraph_ is called.
1911 *
1912 * clearSelection, when undefined or true, causes this.clearSelection to be
1913 * called at the end of the draw operation. This should rarely be defined,
1914 * and never true (that is it should be undefined most of the time, and
1915 * rarely false.)
1916 *
1917 * @private
1918 */
1919 Dygraph.prototype.drawGraph_ = function(clearSelection) {
1920 if (typeof(clearSelection) === 'undefined') {
1921 clearSelection = true;
1922 }
1923
1924 var data = this.rawData_;
1925
1926 // This is used to set the second parameter to drawCallback, below.
1927 var is_initial_draw = this.is_initial_draw_;
1928 this.is_initial_draw_ = false;
1929
1930 var minY = null, maxY = null;
1931 this.layout_.removeAllDatasets();
1932 this.setColors_();
1933 this.attrs_['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
1934
1935 // Loop over the fields (series). Go from the last to the first,
1936 // because if they're stacked that's how we accumulate the values.
1937
1938 var cumulative_y = []; // For stacked series.
1939 var datasets = [];
1940
1941 var extremes = {}; // series name -> [low, high]
1942
1943 // Loop over all fields and create datasets
1944 for (var i = data[0].length - 1; i >= 1; i--) {
1945 if (!this.visibility()[i - 1]) continue;
1946
1947 var seriesName = this.attr_("labels")[i];
1948 var connectSeparatedPoints = this.attr_('connectSeparatedPoints', i);
1949 var logScale = this.attr_('logscale', i);
1950
1951 var series = [];
1952 for (var j = 0; j < data.length; j++) {
1953 var date = data[j][0];
1954 var point = data[j][i];
1955 if (logScale) {
1956 // On the log scale, points less than zero do not exist.
1957 // This will create a gap in the chart. Note that this ignores
1958 // connectSeparatedPoints.
1959 if (point <= 0) {
1960 point = null;
1961 }
1962 series.push([date, point]);
1963 } else {
1964 if (point != null || !connectSeparatedPoints) {
1965 series.push([date, point]);
1966 }
1967 }
1968 }
1969
1970 // TODO(danvk): move this into predraw_. It's insane to do it here.
1971 series = this.rollingAverage(series, this.rollPeriod_);
1972
1973 // Prune down to the desired range, if necessary (for zooming)
1974 // Because there can be lines going to points outside of the visible area,
1975 // we actually prune to visible points, plus one on either side.
1976 var bars = this.attr_("errorBars") || this.attr_("customBars");
1977 if (this.dateWindow_) {
1978 var low = this.dateWindow_[0];
1979 var high= this.dateWindow_[1];
1980 var pruned = [];
1981 // TODO(danvk): do binary search instead of linear search.
1982 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
1983 var firstIdx = null, lastIdx = null;
1984 for (var k = 0; k < series.length; k++) {
1985 if (series[k][0] >= low && firstIdx === null) {
1986 firstIdx = k;
1987 }
1988 if (series[k][0] <= high) {
1989 lastIdx = k;
1990 }
1991 }
1992 if (firstIdx === null) firstIdx = 0;
1993 if (firstIdx > 0) firstIdx--;
1994 if (lastIdx === null) lastIdx = series.length - 1;
1995 if (lastIdx < series.length - 1) lastIdx++;
1996 this.boundaryIds_[i-1] = [firstIdx, lastIdx];
1997 for (var k = firstIdx; k <= lastIdx; k++) {
1998 pruned.push(series[k]);
1999 }
2000 series = pruned;
2001 } else {
2002 this.boundaryIds_[i-1] = [0, series.length-1];
2003 }
2004
2005 var seriesExtremes = this.extremeValues_(series);
2006
2007 if (bars) {
2008 for (var j=0; j<series.length; j++) {
2009 val = [series[j][0], series[j][1][0], series[j][1][1], series[j][1][2]];
2010 series[j] = val;
2011 }
2012 } else if (this.attr_("stackedGraph")) {
2013 var l = series.length;
2014 var actual_y;
2015 for (var j = 0; j < l; j++) {
2016 // If one data set has a NaN, let all subsequent stacked
2017 // sets inherit the NaN -- only start at 0 for the first set.
2018 var x = series[j][0];
2019 if (cumulative_y[x] === undefined) {
2020 cumulative_y[x] = 0;
2021 }
2022
2023 actual_y = series[j][1];
2024 cumulative_y[x] += actual_y;
2025
2026 series[j] = [x, cumulative_y[x]]
2027
2028 if (cumulative_y[x] > seriesExtremes[1]) {
2029 seriesExtremes[1] = cumulative_y[x];
2030 }
2031 if (cumulative_y[x] < seriesExtremes[0]) {
2032 seriesExtremes[0] = cumulative_y[x];
2033 }
2034 }
2035 }
2036 extremes[seriesName] = seriesExtremes;
2037
2038 datasets[i] = series;
2039 }
2040
2041 for (var i = 1; i < datasets.length; i++) {
2042 if (!this.visibility()[i - 1]) continue;
2043 this.layout_.addDataset(this.attr_("labels")[i], datasets[i]);
2044 }
2045
2046 this.computeYAxisRanges_(extremes);
2047 this.layout_.setYAxes(this.axes_);
2048
2049 this.addXTicks_();
2050
2051 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2052 var tmp_zoomed_x = this.zoomed_x_;
2053 // Tell PlotKit to use this new data and render itself
2054 this.layout_.setDateWindow(this.dateWindow_);
2055 this.zoomed_x_ = tmp_zoomed_x;
2056 this.layout_.evaluateWithError();
2057 this.plotter_.clear();
2058 this.plotter_.render();
2059 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2060 this.canvas_.height);
2061
2062 if (is_initial_draw) {
2063 // Generate a static legend before any particular point is selected.
2064 this.setLegendHTML_();
2065 } else {
2066 if (clearSelection) {
2067 if (typeof(this.selPoints_) !== 'undefined' && this.selPoints_.length) {
2068 // We should select the point nearest the page x/y here, but it's easier
2069 // to just clear the selection. This prevents erroneous hover dots from
2070 // being displayed.
2071 this.clearSelection();
2072 } else {
2073 this.clearSelection();
2074 }
2075 }
2076 }
2077
2078 if (this.attr_("drawCallback") !== null) {
2079 this.attr_("drawCallback")(this, is_initial_draw);
2080 }
2081 };
2082
2083 /**
2084 * @private
2085 * Determine properties of the y-axes which are independent of the data
2086 * currently being displayed. This includes things like the number of axes and
2087 * the style of the axes. It does not include the range of each axis and its
2088 * tick marks.
2089 * This fills in this.axes_ and this.seriesToAxisMap_.
2090 * axes_ = [ { options } ]
2091 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2092 * indices are into the axes_ array.
2093 */
2094 Dygraph.prototype.computeYAxes_ = function() {
2095 // Preserve valueWindow settings if they exist, and if the user hasn't
2096 // specified a new valueRange.
2097 var valueWindows;
2098 if (this.axes_ != undefined && this.user_attrs_.hasOwnProperty("valueRange") == false) {
2099 valueWindows = [];
2100 for (var index = 0; index < this.axes_.length; index++) {
2101 valueWindows.push(this.axes_[index].valueWindow);
2102 }
2103 }
2104
2105
2106 this.axes_ = [{ yAxisId : 0, g : this }]; // always have at least one y-axis.
2107 this.seriesToAxisMap_ = {};
2108
2109 // Get a list of series names.
2110 var labels = this.attr_("labels");
2111 var series = {};
2112 for (var i = 1; i < labels.length; i++) series[labels[i]] = (i - 1);
2113
2114 // all options which could be applied per-axis:
2115 var axisOptions = [
2116 'includeZero',
2117 'valueRange',
2118 'labelsKMB',
2119 'labelsKMG2',
2120 'pixelsPerYLabel',
2121 'yAxisLabelWidth',
2122 'axisLabelFontSize',
2123 'axisTickSize',
2124 'logscale'
2125 ];
2126
2127 // Copy global axis options over to the first axis.
2128 for (var i = 0; i < axisOptions.length; i++) {
2129 var k = axisOptions[i];
2130 var v = this.attr_(k);
2131 if (v) this.axes_[0][k] = v;
2132 }
2133
2134 // Go through once and add all the axes.
2135 for (var seriesName in series) {
2136 if (!series.hasOwnProperty(seriesName)) continue;
2137 var axis = this.attr_("axis", seriesName);
2138 if (axis == null) {
2139 this.seriesToAxisMap_[seriesName] = 0;
2140 continue;
2141 }
2142 if (typeof(axis) == 'object') {
2143 // Add a new axis, making a copy of its per-axis options.
2144 var opts = {};
2145 Dygraph.update(opts, this.axes_[0]);
2146 Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this.
2147 var yAxisId = this.axes_.length;
2148 opts.yAxisId = yAxisId;
2149 opts.g = this;
2150 Dygraph.update(opts, axis);
2151 this.axes_.push(opts);
2152 this.seriesToAxisMap_[seriesName] = yAxisId;
2153 }
2154 }
2155
2156 // Go through one more time and assign series to an axis defined by another
2157 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2158 for (var seriesName in series) {
2159 if (!series.hasOwnProperty(seriesName)) continue;
2160 var axis = this.attr_("axis", seriesName);
2161 if (typeof(axis) == 'string') {
2162 if (!this.seriesToAxisMap_.hasOwnProperty(axis)) {
2163 this.error("Series " + seriesName + " wants to share a y-axis with " +
2164 "series " + axis + ", which does not define its own axis.");
2165 return null;
2166 }
2167 var idx = this.seriesToAxisMap_[axis];
2168 this.seriesToAxisMap_[seriesName] = idx;
2169 }
2170 }
2171
2172 // Now we remove series from seriesToAxisMap_ which are not visible. We do
2173 // this last so that hiding the first series doesn't destroy the axis
2174 // properties of the primary axis.
2175 var seriesToAxisFiltered = {};
2176 var vis = this.visibility();
2177 for (var i = 1; i < labels.length; i++) {
2178 var s = labels[i];
2179 if (vis[i - 1]) seriesToAxisFiltered[s] = this.seriesToAxisMap_[s];
2180 }
2181 this.seriesToAxisMap_ = seriesToAxisFiltered;
2182
2183 if (valueWindows != undefined) {
2184 // Restore valueWindow settings.
2185 for (var index = 0; index < valueWindows.length; index++) {
2186 this.axes_[index].valueWindow = valueWindows[index];
2187 }
2188 }
2189 };
2190
2191 /**
2192 * Returns the number of y-axes on the chart.
2193 * @return {Number} the number of axes.
2194 */
2195 Dygraph.prototype.numAxes = function() {
2196 var last_axis = 0;
2197 for (var series in this.seriesToAxisMap_) {
2198 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2199 var idx = this.seriesToAxisMap_[series];
2200 if (idx > last_axis) last_axis = idx;
2201 }
2202 return 1 + last_axis;
2203 };
2204
2205 /**
2206 * @private
2207 * Returns axis properties for the given series.
2208 * @param { String } setName The name of the series for which to get axis
2209 * properties, e.g. 'Y1'.
2210 * @return { Object } The axis properties.
2211 */
2212 Dygraph.prototype.axisPropertiesForSeries = function(series) {
2213 // TODO(danvk): handle errors.
2214 return this.axes_[this.seriesToAxisMap_[series]];
2215 };
2216
2217 /**
2218 * @private
2219 * Determine the value range and tick marks for each axis.
2220 * @param {Object} extremes A mapping from seriesName -> [low, high]
2221 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2222 */
2223 Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2224 // Build a map from axis number -> [list of series names]
2225 var seriesForAxis = [];
2226 for (var series in this.seriesToAxisMap_) {
2227 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2228 var idx = this.seriesToAxisMap_[series];
2229 while (seriesForAxis.length <= idx) seriesForAxis.push([]);
2230 seriesForAxis[idx].push(series);
2231 }
2232
2233 // Compute extreme values, a span and tick marks for each axis.
2234 for (var i = 0; i < this.axes_.length; i++) {
2235 var axis = this.axes_[i];
2236
2237 if (!seriesForAxis[i]) {
2238 // If no series are defined or visible then use a reasonable default
2239 axis.extremeRange = [0, 1];
2240 } else {
2241 // Calculate the extremes of extremes.
2242 var series = seriesForAxis[i];
2243 var minY = Infinity; // extremes[series[0]][0];
2244 var maxY = -Infinity; // extremes[series[0]][1];
2245 var extremeMinY, extremeMaxY;
2246 for (var j = 0; j < series.length; j++) {
2247 // Only use valid extremes to stop null data series' from corrupting the scale.
2248 extremeMinY = extremes[series[j]][0];
2249 if (extremeMinY != null) {
2250 minY = Math.min(extremeMinY, minY);
2251 }
2252 extremeMaxY = extremes[series[j]][1];
2253 if (extremeMaxY != null) {
2254 maxY = Math.max(extremeMaxY, maxY);
2255 }
2256 }
2257 if (axis.includeZero && minY > 0) minY = 0;
2258
2259 // Ensure we have a valid scale, otherwise defualt to zero for safety.
2260 if (minY == Infinity) minY = 0;
2261 if (maxY == -Infinity) maxY = 0;
2262
2263 // Add some padding and round up to an integer to be human-friendly.
2264 var span = maxY - minY;
2265 // special case: if we have no sense of scale, use +/-10% of the sole value.
2266 if (span == 0) { span = maxY; }
2267
2268 var maxAxisY;
2269 var minAxisY;
2270 if (axis.logscale) {
2271 var maxAxisY = maxY + 0.1 * span;
2272 var minAxisY = minY;
2273 } else {
2274 var maxAxisY = maxY + 0.1 * span;
2275 var minAxisY = minY - 0.1 * span;
2276
2277 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2278 if (!this.attr_("avoidMinZero")) {
2279 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2280 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
2281 }
2282
2283 if (this.attr_("includeZero")) {
2284 if (maxY < 0) maxAxisY = 0;
2285 if (minY > 0) minAxisY = 0;
2286 }
2287 }
2288 axis.extremeRange = [minAxisY, maxAxisY];
2289 }
2290 if (axis.valueWindow) {
2291 // This is only set if the user has zoomed on the y-axis. It is never set
2292 // by a user. It takes precedence over axis.valueRange because, if you set
2293 // valueRange, you'd still expect to be able to pan.
2294 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
2295 } else if (axis.valueRange) {
2296 // This is a user-set value range for this axis.
2297 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
2298 } else {
2299 axis.computedValueRange = axis.extremeRange;
2300 }
2301
2302 // Add ticks. By default, all axes inherit the tick positions of the
2303 // primary axis. However, if an axis is specifically marked as having
2304 // independent ticks, then that is permissible as well.
2305 if (i == 0 || axis.independentTicks) {
2306 axis.ticks =
2307 Dygraph.numericTicks(axis.computedValueRange[0],
2308 axis.computedValueRange[1],
2309 this,
2310 axis);
2311 } else {
2312 var p_axis = this.axes_[0];
2313 var p_ticks = p_axis.ticks;
2314 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
2315 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
2316 var tick_values = [];
2317 for (var k = 0; k < p_ticks.length; k++) {
2318 var y_frac = (p_ticks[k].v - p_axis.computedValueRange[0]) / p_scale;
2319 var y_val = axis.computedValueRange[0] + y_frac * scale;
2320 tick_values.push(y_val);
2321 }
2322
2323 axis.ticks =
2324 Dygraph.numericTicks(axis.computedValueRange[0],
2325 axis.computedValueRange[1],
2326 this, axis, tick_values);
2327 }
2328 }
2329 };
2330
2331 /**
2332 * @private
2333 * Calculates the rolling average of a data set.
2334 * If originalData is [label, val], rolls the average of those.
2335 * If originalData is [label, [, it's interpreted as [value, stddev]
2336 * and the roll is returned in the same form, with appropriately reduced
2337 * stddev for each value.
2338 * Note that this is where fractional input (i.e. '5/10') is converted into
2339 * decimal values.
2340 * @param {Array} originalData The data in the appropriate format (see above)
2341 * @param {Number} rollPeriod The number of points over which to average the
2342 * data
2343 */
2344 Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
2345 if (originalData.length < 2)
2346 return originalData;
2347 var rollPeriod = Math.min(rollPeriod, originalData.length - 1);
2348 var rollingData = [];
2349 var sigma = this.attr_("sigma");
2350
2351 if (this.fractions_) {
2352 var num = 0;
2353 var den = 0; // numerator/denominator
2354 var mult = 100.0;
2355 for (var i = 0; i < originalData.length; i++) {
2356 num += originalData[i][1][0];
2357 den += originalData[i][1][1];
2358 if (i - rollPeriod >= 0) {
2359 num -= originalData[i - rollPeriod][1][0];
2360 den -= originalData[i - rollPeriod][1][1];
2361 }
2362
2363 var date = originalData[i][0];
2364 var value = den ? num / den : 0.0;
2365 if (this.attr_("errorBars")) {
2366 if (this.wilsonInterval_) {
2367 // For more details on this confidence interval, see:
2368 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
2369 if (den) {
2370 var p = value < 0 ? 0 : value, n = den;
2371 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
2372 var denom = 1 + sigma * sigma / den;
2373 var low = (p + sigma * sigma / (2 * den) - pm) / denom;
2374 var high = (p + sigma * sigma / (2 * den) + pm) / denom;
2375 rollingData[i] = [date,
2376 [p * mult, (p - low) * mult, (high - p) * mult]];
2377 } else {
2378 rollingData[i] = [date, [0, 0, 0]];
2379 }
2380 } else {
2381 var stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
2382 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
2383 }
2384 } else {
2385 rollingData[i] = [date, mult * value];
2386 }
2387 }
2388 } else if (this.attr_("customBars")) {
2389 var low = 0;
2390 var mid = 0;
2391 var high = 0;
2392 var count = 0;
2393 for (var i = 0; i < originalData.length; i++) {
2394 var data = originalData[i][1];
2395 var y = data[1];
2396 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
2397
2398 if (y != null && !isNaN(y)) {
2399 low += data[0];
2400 mid += y;
2401 high += data[2];
2402 count += 1;
2403 }
2404 if (i - rollPeriod >= 0) {
2405 var prev = originalData[i - rollPeriod];
2406 if (prev[1][1] != null && !isNaN(prev[1][1])) {
2407 low -= prev[1][0];
2408 mid -= prev[1][1];
2409 high -= prev[1][2];
2410 count -= 1;
2411 }
2412 }
2413 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
2414 1.0 * (mid - low) / count,
2415 1.0 * (high - mid) / count ]];
2416 }
2417 } else {
2418 // Calculate the rolling average for the first rollPeriod - 1 points where
2419 // there is not enough data to roll over the full number of points
2420 var num_init_points = Math.min(rollPeriod - 1, originalData.length - 2);
2421 if (!this.attr_("errorBars")){
2422 if (rollPeriod == 1) {
2423 return originalData;
2424 }
2425
2426 for (var i = 0; i < originalData.length; i++) {
2427 var sum = 0;
2428 var num_ok = 0;
2429 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2430 var y = originalData[j][1];
2431 if (y == null || isNaN(y)) continue;
2432 num_ok++;
2433 sum += originalData[j][1];
2434 }
2435 if (num_ok) {
2436 rollingData[i] = [originalData[i][0], sum / num_ok];
2437 } else {
2438 rollingData[i] = [originalData[i][0], null];
2439 }
2440 }
2441
2442 } else {
2443 for (var i = 0; i < originalData.length; i++) {
2444 var sum = 0;
2445 var variance = 0;
2446 var num_ok = 0;
2447 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2448 var y = originalData[j][1][0];
2449 if (y == null || isNaN(y)) continue;
2450 num_ok++;
2451 sum += originalData[j][1][0];
2452 variance += Math.pow(originalData[j][1][1], 2);
2453 }
2454 if (num_ok) {
2455 var stddev = Math.sqrt(variance) / num_ok;
2456 rollingData[i] = [originalData[i][0],
2457 [sum / num_ok, sigma * stddev, sigma * stddev]];
2458 } else {
2459 rollingData[i] = [originalData[i][0], [null, null, null]];
2460 }
2461 }
2462 }
2463 }
2464
2465 return rollingData;
2466 };
2467
2468 /**
2469 * Detects the type of the str (date or numeric) and sets the various
2470 * formatting attributes in this.attrs_ based on this type.
2471 * @param {String} str An x value.
2472 * @private
2473 */
2474 Dygraph.prototype.detectTypeFromString_ = function(str) {
2475 var isDate = false;
2476 if (str.indexOf('-') > 0 ||
2477 str.indexOf('/') >= 0 ||
2478 isNaN(parseFloat(str))) {
2479 isDate = true;
2480 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
2481 // TODO(danvk): remove support for this format.
2482 isDate = true;
2483 }
2484
2485 if (isDate) {
2486 this.attrs_.xValueFormatter = Dygraph.dateString_;
2487 this.attrs_.xValueParser = Dygraph.dateParser;
2488 this.attrs_.xTicker = Dygraph.dateTicker;
2489 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
2490 } else {
2491 // TODO(danvk): use Dygraph.numberFormatter here?
2492 /** @private (shut up, jsdoc!) */
2493 this.attrs_.xValueFormatter = function(x) { return x; };
2494 /** @private (shut up, jsdoc!) */
2495 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2496 this.attrs_.xTicker = Dygraph.numericTicks;
2497 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
2498 }
2499 };
2500
2501 /**
2502 * Parses the value as a floating point number. This is like the parseFloat()
2503 * built-in, but with a few differences:
2504 * - the empty string is parsed as null, rather than NaN.
2505 * - if the string cannot be parsed at all, an error is logged.
2506 * If the string can't be parsed, this method returns null.
2507 * @param {String} x The string to be parsed
2508 * @param {Number} opt_line_no The line number from which the string comes.
2509 * @param {String} opt_line The text of the line from which the string comes.
2510 * @private
2511 */
2512
2513 // Parse the x as a float or return null if it's not a number.
2514 Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) {
2515 var val = parseFloat(x);
2516 if (!isNaN(val)) return val;
2517
2518 // Try to figure out what happeend.
2519 // If the value is the empty string, parse it as null.
2520 if (/^ *$/.test(x)) return null;
2521
2522 // If it was actually "NaN", return it as NaN.
2523 if (/^ *nan *$/i.test(x)) return NaN;
2524
2525 // Looks like a parsing error.
2526 var msg = "Unable to parse '" + x + "' as a number";
2527 if (opt_line !== null && opt_line_no !== null) {
2528 msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV.";
2529 }
2530 this.error(msg);
2531
2532 return null;
2533 };
2534
2535 /**
2536 * @private
2537 * Parses a string in a special csv format. We expect a csv file where each
2538 * line is a date point, and the first field in each line is the date string.
2539 * We also expect that all remaining fields represent series.
2540 * if the errorBars attribute is set, then interpret the fields as:
2541 * date, series1, stddev1, series2, stddev2, ...
2542 * @param {[Object]} data See above.
2543 *
2544 * @return [Object] An array with one entry for each row. These entries
2545 * are an array of cells in that row. The first entry is the parsed x-value for
2546 * the row. The second, third, etc. are the y-values. These can take on one of
2547 * three forms, depending on the CSV and constructor parameters:
2548 * 1. numeric value
2549 * 2. [ value, stddev ]
2550 * 3. [ low value, center value, high value ]
2551 */
2552 Dygraph.prototype.parseCSV_ = function(data) {
2553 var ret = [];
2554 var lines = data.split("\n");
2555
2556 // Use the default delimiter or fall back to a tab if that makes sense.
2557 var delim = this.attr_('delimiter');
2558 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
2559 delim = '\t';
2560 }
2561
2562 var start = 0;
2563 if (!('labels' in this.user_attrs_)) {
2564 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2565 start = 1;
2566 this.attrs_.labels = lines[0].split(delim); // NOTE: _not_ user_attrs_.
2567 }
2568 var line_no = 0;
2569
2570 var xParser;
2571 var defaultParserSet = false; // attempt to auto-detect x value type
2572 var expectedCols = this.attr_("labels").length;
2573 var outOfOrder = false;
2574 for (var i = start; i < lines.length; i++) {
2575 var line = lines[i];
2576 line_no = i;
2577 if (line.length == 0) continue; // skip blank lines
2578 if (line[0] == '#') continue; // skip comment lines
2579 var inFields = line.split(delim);
2580 if (inFields.length < 2) continue;
2581
2582 var fields = [];
2583 if (!defaultParserSet) {
2584 this.detectTypeFromString_(inFields[0]);
2585 xParser = this.attr_("xValueParser");
2586 defaultParserSet = true;
2587 }
2588 fields[0] = xParser(inFields[0], this);
2589
2590 // If fractions are expected, parse the numbers as "A/B"
2591 if (this.fractions_) {
2592 for (var j = 1; j < inFields.length; j++) {
2593 // TODO(danvk): figure out an appropriate way to flag parse errors.
2594 var vals = inFields[j].split("/");
2595 if (vals.length != 2) {
2596 this.error('Expected fractional "num/den" values in CSV data ' +
2597 "but found a value '" + inFields[j] + "' on line " +
2598 (1 + i) + " ('" + line + "') which is not of this form.");
2599 fields[j] = [0, 0];
2600 } else {
2601 fields[j] = [this.parseFloat_(vals[0], i, line),
2602 this.parseFloat_(vals[1], i, line)];
2603 }
2604 }
2605 } else if (this.attr_("errorBars")) {
2606 // If there are error bars, values are (value, stddev) pairs
2607 if (inFields.length % 2 != 1) {
2608 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2609 'but line ' + (1 + i) + ' has an odd number of values (' +
2610 (inFields.length - 1) + "): '" + line + "'");
2611 }
2612 for (var j = 1; j < inFields.length; j += 2) {
2613 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2614 this.parseFloat_(inFields[j + 1], i, line)];
2615 }
2616 } else if (this.attr_("customBars")) {
2617 // Bars are a low;center;high tuple
2618 for (var j = 1; j < inFields.length; j++) {
2619 var val = inFields[j];
2620 if (/^ *$/.test(val)) {
2621 fields[j] = [null, null, null];
2622 } else {
2623 var vals = val.split(";");
2624 if (vals.length == 3) {
2625 fields[j] = [ this.parseFloat_(vals[0], i, line),
2626 this.parseFloat_(vals[1], i, line),
2627 this.parseFloat_(vals[2], i, line) ];
2628 } else {
2629 this.warning('When using customBars, values must be either blank ' +
2630 'or "low;center;high" tuples (got "' + val +
2631 '" on line ' + (1+i));
2632 }
2633 }
2634 }
2635 } else {
2636 // Values are just numbers
2637 for (var j = 1; j < inFields.length; j++) {
2638 fields[j] = this.parseFloat_(inFields[j], i, line);
2639 }
2640 }
2641 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2642 outOfOrder = true;
2643 }
2644
2645 if (fields.length != expectedCols) {
2646 this.error("Number of columns in line " + i + " (" + fields.length +
2647 ") does not agree with number of labels (" + expectedCols +
2648 ") " + line);
2649 }
2650
2651 // If the user specified the 'labels' option and none of the cells of the
2652 // first row parsed correctly, then they probably double-specified the
2653 // labels. We go with the values set in the option, discard this row and
2654 // log a warning to the JS console.
2655 if (i == 0 && this.attr_('labels')) {
2656 var all_null = true;
2657 for (var j = 0; all_null && j < fields.length; j++) {
2658 if (fields[j]) all_null = false;
2659 }
2660 if (all_null) {
2661 this.warn("The dygraphs 'labels' option is set, but the first row of " +
2662 "CSV data ('" + line + "') appears to also contain labels. " +
2663 "Will drop the CSV labels and use the option labels.");
2664 continue;
2665 }
2666 }
2667 ret.push(fields);
2668 }
2669
2670 if (outOfOrder) {
2671 this.warn("CSV is out of order; order it correctly to speed loading.");
2672 ret.sort(function(a,b) { return a[0] - b[0] });
2673 }
2674
2675 return ret;
2676 };
2677
2678 /**
2679 * @private
2680 * The user has provided their data as a pre-packaged JS array. If the x values
2681 * are numeric, this is the same as dygraphs' internal format. If the x values
2682 * are dates, we need to convert them from Date objects to ms since epoch.
2683 * @param {[Object]} data
2684 * @return {[Object]} data with numeric x values.
2685 */
2686 Dygraph.prototype.parseArray_ = function(data) {
2687 // Peek at the first x value to see if it's numeric.
2688 if (data.length == 0) {
2689 this.error("Can't plot empty data set");
2690 return null;
2691 }
2692 if (data[0].length == 0) {
2693 this.error("Data set cannot contain an empty row");
2694 return null;
2695 }
2696
2697 if (this.attr_("labels") == null) {
2698 this.warn("Using default labels. Set labels explicitly via 'labels' " +
2699 "in the options parameter");
2700 this.attrs_.labels = [ "X" ];
2701 for (var i = 1; i < data[0].length; i++) {
2702 this.attrs_.labels.push("Y" + i);
2703 }
2704 }
2705
2706 if (Dygraph.isDateLike(data[0][0])) {
2707 // Some intelligent defaults for a date x-axis.
2708 this.attrs_.xValueFormatter = Dygraph.dateString_;
2709 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
2710 this.attrs_.xTicker = Dygraph.dateTicker;
2711
2712 // Assume they're all dates.
2713 var parsedData = Dygraph.clone(data);
2714 for (var i = 0; i < data.length; i++) {
2715 if (parsedData[i].length == 0) {
2716 this.error("Row " + (1 + i) + " of data is empty");
2717 return null;
2718 }
2719 if (parsedData[i][0] == null
2720 || typeof(parsedData[i][0].getTime) != 'function'
2721 || isNaN(parsedData[i][0].getTime())) {
2722 this.error("x value in row " + (1 + i) + " is not a Date");
2723 return null;
2724 }
2725 parsedData[i][0] = parsedData[i][0].getTime();
2726 }
2727 return parsedData;
2728 } else {
2729 // Some intelligent defaults for a numeric x-axis.
2730 /** @private (shut up, jsdoc!) */
2731 this.attrs_.xValueFormatter = function(x) { return x; };
2732 this.attrs_.xTicker = Dygraph.numericTicks;
2733 return data;
2734 }
2735 };
2736
2737 /**
2738 * Parses a DataTable object from gviz.
2739 * The data is expected to have a first column that is either a date or a
2740 * number. All subsequent columns must be numbers. If there is a clear mismatch
2741 * between this.xValueParser_ and the type of the first column, it will be
2742 * fixed. Fills out rawData_.
2743 * @param {[Object]} data See above.
2744 * @private
2745 */
2746 Dygraph.prototype.parseDataTable_ = function(data) {
2747 var cols = data.getNumberOfColumns();
2748 var rows = data.getNumberOfRows();
2749
2750 var indepType = data.getColumnType(0);
2751 if (indepType == 'date' || indepType == 'datetime') {
2752 this.attrs_.xValueFormatter = Dygraph.dateString_;
2753 this.attrs_.xValueParser = Dygraph.dateParser;
2754 this.attrs_.xTicker = Dygraph.dateTicker;
2755 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
2756 } else if (indepType == 'number') {
2757 this.attrs_.xValueFormatter = function(x) { return x; };
2758 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2759 this.attrs_.xTicker = Dygraph.numericTicks;
2760 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
2761 } else {
2762 this.error("only 'date', 'datetime' and 'number' types are supported for " +
2763 "column 1 of DataTable input (Got '" + indepType + "')");
2764 return null;
2765 }
2766
2767 // Array of the column indices which contain data (and not annotations).
2768 var colIdx = [];
2769 var annotationCols = {}; // data index -> [annotation cols]
2770 var hasAnnotations = false;
2771 for (var i = 1; i < cols; i++) {
2772 var type = data.getColumnType(i);
2773 if (type == 'number') {
2774 colIdx.push(i);
2775 } else if (type == 'string' && this.attr_('displayAnnotations')) {
2776 // This is OK -- it's an annotation column.
2777 var dataIdx = colIdx[colIdx.length - 1];
2778 if (!annotationCols.hasOwnProperty(dataIdx)) {
2779 annotationCols[dataIdx] = [i];
2780 } else {
2781 annotationCols[dataIdx].push(i);
2782 }
2783 hasAnnotations = true;
2784 } else {
2785 this.error("Only 'number' is supported as a dependent type with Gviz." +
2786 " 'string' is only supported if displayAnnotations is true");
2787 }
2788 }
2789
2790 // Read column labels
2791 // TODO(danvk): add support back for errorBars
2792 var labels = [data.getColumnLabel(0)];
2793 for (var i = 0; i < colIdx.length; i++) {
2794 labels.push(data.getColumnLabel(colIdx[i]));
2795 if (this.attr_("errorBars")) i += 1;
2796 }
2797 this.attrs_.labels = labels;
2798 cols = labels.length;
2799
2800 var ret = [];
2801 var outOfOrder = false;
2802 var annotations = [];
2803 for (var i = 0; i < rows; i++) {
2804 var row = [];
2805 if (typeof(data.getValue(i, 0)) === 'undefined' ||
2806 data.getValue(i, 0) === null) {
2807 this.warn("Ignoring row " + i +
2808 " of DataTable because of undefined or null first column.");
2809 continue;
2810 }
2811
2812 if (indepType == 'date' || indepType == 'datetime') {
2813 row.push(data.getValue(i, 0).getTime());
2814 } else {
2815 row.push(data.getValue(i, 0));
2816 }
2817 if (!this.attr_("errorBars")) {
2818 for (var j = 0; j < colIdx.length; j++) {
2819 var col = colIdx[j];
2820 row.push(data.getValue(i, col));
2821 if (hasAnnotations &&
2822 annotationCols.hasOwnProperty(col) &&
2823 data.getValue(i, annotationCols[col][0]) != null) {
2824 var ann = {};
2825 ann.series = data.getColumnLabel(col);
2826 ann.xval = row[0];
2827 ann.shortText = String.fromCharCode(65 /* A */ + annotations.length)
2828 ann.text = '';
2829 for (var k = 0; k < annotationCols[col].length; k++) {
2830 if (k) ann.text += "\n";
2831 ann.text += data.getValue(i, annotationCols[col][k]);
2832 }
2833 annotations.push(ann);
2834 }
2835 }
2836
2837 // Strip out infinities, which give dygraphs problems later on.
2838 for (var j = 0; j < row.length; j++) {
2839 if (!isFinite(row[j])) row[j] = null;
2840 }
2841 } else {
2842 for (var j = 0; j < cols - 1; j++) {
2843 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
2844 }
2845 }
2846 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
2847 outOfOrder = true;
2848 }
2849 ret.push(row);
2850 }
2851
2852 if (outOfOrder) {
2853 this.warn("DataTable is out of order; order it correctly to speed loading.");
2854 ret.sort(function(a,b) { return a[0] - b[0] });
2855 }
2856 this.rawData_ = ret;
2857
2858 if (annotations.length > 0) {
2859 this.setAnnotations(annotations, true);
2860 }
2861 }
2862
2863 /**
2864 * Get the CSV data. If it's in a function, call that function. If it's in a
2865 * file, do an XMLHttpRequest to get it.
2866 * @private
2867 */
2868 Dygraph.prototype.start_ = function() {
2869 if (typeof this.file_ == 'function') {
2870 // CSV string. Pretend we got it via XHR.
2871 this.loadedEvent_(this.file_());
2872 } else if (Dygraph.isArrayLike(this.file_)) {
2873 this.rawData_ = this.parseArray_(this.file_);
2874 this.predraw_();
2875 } else if (typeof this.file_ == 'object' &&
2876 typeof this.file_.getColumnRange == 'function') {
2877 // must be a DataTable from gviz.
2878 this.parseDataTable_(this.file_);
2879 this.predraw_();
2880 } else if (typeof this.file_ == 'string') {
2881 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
2882 if (this.file_.indexOf('\n') >= 0) {
2883 this.loadedEvent_(this.file_);
2884 } else {
2885 var req = new XMLHttpRequest();
2886 var caller = this;
2887 req.onreadystatechange = function () {
2888 if (req.readyState == 4) {
2889 if (req.status == 200 || // Normal http
2890 req.status == 0) { // Chrome w/ --allow-file-access-from-files
2891 caller.loadedEvent_(req.responseText);
2892 }
2893 }
2894 };
2895
2896 req.open("GET", this.file_, true);
2897 req.send(null);
2898 }
2899 } else {
2900 this.error("Unknown data format: " + (typeof this.file_));
2901 }
2902 };
2903
2904 /**
2905 * Changes various properties of the graph. These can include:
2906 * <ul>
2907 * <li>file: changes the source data for the graph</li>
2908 * <li>errorBars: changes whether the data contains stddev</li>
2909 * </ul>
2910 *
2911 * There's a huge variety of options that can be passed to this method. For a
2912 * full list, see http://dygraphs.com/options.html.
2913 *
2914 * @param {Object} attrs The new properties and values
2915 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
2916 * call to updateOptions(). If you know better, you can pass true to explicitly
2917 * block the redraw. This can be useful for chaining updateOptions() calls,
2918 * avoiding the occasional infinite loop and preventing redraws when it's not
2919 * necessary (e.g. when updating a callback).
2920 */
2921 Dygraph.prototype.updateOptions = function(attrs, block_redraw) {
2922 if (typeof(block_redraw) == 'undefined') block_redraw = false;
2923
2924 // TODO(danvk): this is a mess. Move these options into attr_.
2925 if ('rollPeriod' in attrs) {
2926 this.rollPeriod_ = attrs.rollPeriod;
2927 }
2928 if ('dateWindow' in attrs) {
2929 this.dateWindow_ = attrs.dateWindow;
2930 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
2931 this.zoomed_x_ = attrs.dateWindow != null;
2932 }
2933 }
2934 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
2935 this.zoomed_y_ = attrs.valueRange != null;
2936 }
2937
2938 // TODO(danvk): validate per-series options.
2939 // Supported:
2940 // strokeWidth
2941 // pointSize
2942 // drawPoints
2943 // highlightCircleSize
2944
2945 Dygraph.update(this.user_attrs_, attrs);
2946
2947 if (attrs['file']) {
2948 this.file_ = attrs['file'];
2949 if (!block_redraw) this.start_();
2950 } else {
2951 if (!block_redraw) this.predraw_();
2952 }
2953 };
2954
2955 /**
2956 * Resizes the dygraph. If no parameters are specified, resizes to fill the
2957 * containing div (which has presumably changed size since the dygraph was
2958 * instantiated. If the width/height are specified, the div will be resized.
2959 *
2960 * This is far more efficient than destroying and re-instantiating a
2961 * Dygraph, since it doesn't have to reparse the underlying data.
2962 *
2963 * @param {Number} [width] Width (in pixels)
2964 * @param {Number} [height] Height (in pixels)
2965 */
2966 Dygraph.prototype.resize = function(width, height) {
2967 if (this.resize_lock) {
2968 return;
2969 }
2970 this.resize_lock = true;
2971
2972 if ((width === null) != (height === null)) {
2973 this.warn("Dygraph.resize() should be called with zero parameters or " +
2974 "two non-NULL parameters. Pretending it was zero.");
2975 width = height = null;
2976 }
2977
2978 // TODO(danvk): there should be a clear() method.
2979 this.maindiv_.innerHTML = "";
2980 this.attrs_.labelsDiv = null;
2981
2982 if (width) {
2983 this.maindiv_.style.width = width + "px";
2984 this.maindiv_.style.height = height + "px";
2985 this.width_ = width;
2986 this.height_ = height;
2987 } else {
2988 this.width_ = this.maindiv_.offsetWidth;
2989 this.height_ = this.maindiv_.offsetHeight;
2990 }
2991
2992 this.createInterface_();
2993 this.predraw_();
2994
2995 this.resize_lock = false;
2996 };
2997
2998 /**
2999 * Adjusts the number of points in the rolling average. Updates the graph to
3000 * reflect the new averaging period.
3001 * @param {Number} length Number of points over which to average the data.
3002 */
3003 Dygraph.prototype.adjustRoll = function(length) {
3004 this.rollPeriod_ = length;
3005 this.predraw_();
3006 };
3007
3008 /**
3009 * Returns a boolean array of visibility statuses.
3010 */
3011 Dygraph.prototype.visibility = function() {
3012 // Do lazy-initialization, so that this happens after we know the number of
3013 // data series.
3014 if (!this.attr_("visibility")) {
3015 this.attrs_["visibility"] = [];
3016 }
3017 while (this.attr_("visibility").length < this.rawData_[0].length - 1) {
3018 this.attr_("visibility").push(true);
3019 }
3020 return this.attr_("visibility");
3021 };
3022
3023 /**
3024 * Changes the visiblity of a series.
3025 */
3026 Dygraph.prototype.setVisibility = function(num, value) {
3027 var x = this.visibility();
3028 if (num < 0 || num >= x.length) {
3029 this.warn("invalid series number in setVisibility: " + num);
3030 } else {
3031 x[num] = value;
3032 this.predraw_();
3033 }
3034 };
3035
3036 /**
3037 * Update the list of annotations and redraw the chart.
3038 */
3039 Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3040 // Only add the annotation CSS rule once we know it will be used.
3041 Dygraph.addAnnotationRule();
3042 this.annotations_ = ann;
3043 this.layout_.setAnnotations(this.annotations_);
3044 if (!suppressDraw) {
3045 this.predraw_();
3046 }
3047 };
3048
3049 /**
3050 * Return the list of annotations.
3051 */
3052 Dygraph.prototype.annotations = function() {
3053 return this.annotations_;
3054 };
3055
3056 /**
3057 * Get the index of a series (column) given its name. The first column is the
3058 * x-axis, so the data series start with index 1.
3059 */
3060 Dygraph.prototype.indexFromSetName = function(name) {
3061 var labels = this.attr_("labels");
3062 for (var i = 0; i < labels.length; i++) {
3063 if (labels[i] == name) return i;
3064 }
3065 return null;
3066 };
3067
3068 /**
3069 * @private
3070 * Adds a default style for the annotation CSS classes to the document. This is
3071 * only executed when annotations are actually used. It is designed to only be
3072 * called once -- all calls after the first will return immediately.
3073 */
3074 Dygraph.addAnnotationRule = function() {
3075 if (Dygraph.addedAnnotationCSS) return;
3076
3077 var rule = "border: 1px solid black; " +
3078 "background-color: white; " +
3079 "text-align: center;";
3080
3081 var styleSheetElement = document.createElement("style");
3082 styleSheetElement.type = "text/css";
3083 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3084
3085 // Find the first style sheet that we can access.
3086 // We may not add a rule to a style sheet from another domain for security
3087 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3088 // adds its own style sheets from google.com.
3089 for (var i = 0; i < document.styleSheets.length; i++) {
3090 if (document.styleSheets[i].disabled) continue;
3091 var mysheet = document.styleSheets[i];
3092 try {
3093 if (mysheet.insertRule) { // Firefox
3094 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3095 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3096 } else if (mysheet.addRule) { // IE
3097 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3098 }
3099 Dygraph.addedAnnotationCSS = true;
3100 return;
3101 } catch(err) {
3102 // Was likely a security exception.
3103 }
3104 }
3105
3106 this.warn("Unable to add default annotation CSS rule; display may be off.");
3107 }
3108
3109 // Older pages may still use this name.
3110 DateGraph = Dygraph;