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