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