Changes based on danvk's review:
[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 highlightSeriesBackgroundFade: 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 div.style[name] = messagestyle[name];
1025 }
1026 }
1027 this.graphDiv.appendChild(div);
1028 this.attrs_.labelsDiv = div;
1029 }
1030 };
1031
1032 /**
1033 * Position the labels div so that:
1034 * - its right edge is flush with the right edge of the charting area
1035 * - its top edge is flush with the top edge of the charting area
1036 * @private
1037 */
1038 Dygraph.prototype.positionLabelsDiv_ = function() {
1039 // Don't touch a user-specified labelsDiv.
1040 if (this.user_attrs_.hasOwnProperty("labelsDiv")) return;
1041
1042 var area = this.plotter_.area;
1043 var div = this.attr_("labelsDiv");
1044 div.style.left = area.x + area.w - this.attr_("labelsDivWidth") - 1 + "px";
1045 div.style.top = area.y + "px";
1046 };
1047
1048 /**
1049 * Create the text box to adjust the averaging period
1050 * @private
1051 */
1052 Dygraph.prototype.createRollInterface_ = function() {
1053 // Create a roller if one doesn't exist already.
1054 if (!this.roller_) {
1055 this.roller_ = document.createElement("input");
1056 this.roller_.type = "text";
1057 this.roller_.style.display = "none";
1058 this.graphDiv.appendChild(this.roller_);
1059 }
1060
1061 var display = this.attr_('showRoller') ? 'block' : 'none';
1062
1063 var area = this.plotter_.area;
1064 var textAttr = { "position": "absolute",
1065 "zIndex": 10,
1066 "top": (area.y + area.h - 25) + "px",
1067 "left": (area.x + 1) + "px",
1068 "display": display
1069 };
1070 this.roller_.size = "2";
1071 this.roller_.value = this.rollPeriod_;
1072 for (var name in textAttr) {
1073 if (textAttr.hasOwnProperty(name)) {
1074 this.roller_.style[name] = textAttr[name];
1075 }
1076 }
1077
1078 var dygraph = this;
1079 this.roller_.onchange = function() { dygraph.adjustRoll(dygraph.roller_.value); };
1080 };
1081
1082 /**
1083 * @private
1084 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1085 * canvas (i.e. DOM Coords).
1086 */
1087 Dygraph.prototype.dragGetX_ = function(e, context) {
1088 return Dygraph.pageX(e) - context.px;
1089 };
1090
1091 /**
1092 * @private
1093 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1094 * canvas (i.e. DOM Coords).
1095 */
1096 Dygraph.prototype.dragGetY_ = function(e, context) {
1097 return Dygraph.pageY(e) - context.py;
1098 };
1099
1100 /**
1101 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1102 * events.
1103 * @private
1104 */
1105 Dygraph.prototype.createDragInterface_ = function() {
1106 var context = {
1107 // Tracks whether the mouse is down right now
1108 isZooming: false,
1109 isPanning: false, // is this drag part of a pan?
1110 is2DPan: false, // if so, is that pan 1- or 2-dimensional?
1111 dragStartX: null, // pixel coordinates
1112 dragStartY: null, // pixel coordinates
1113 dragEndX: null, // pixel coordinates
1114 dragEndY: null, // pixel coordinates
1115 dragDirection: null,
1116 prevEndX: null, // pixel coordinates
1117 prevEndY: null, // pixel coordinates
1118 prevDragDirection: null,
1119
1120 // The value on the left side of the graph when a pan operation starts.
1121 initialLeftmostDate: null,
1122
1123 // The number of units each pixel spans. (This won't be valid for log
1124 // scales)
1125 xUnitsPerPixel: null,
1126
1127 // TODO(danvk): update this comment
1128 // The range in second/value units that the viewport encompasses during a
1129 // panning operation.
1130 dateRange: null,
1131
1132 // Top-left corner of the canvas, in DOM coords
1133 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1134 px: 0,
1135 py: 0,
1136
1137 // Values for use with panEdgeFraction, which limit how far outside the
1138 // graph's data boundaries it can be panned.
1139 boundedDates: null, // [minDate, maxDate]
1140 boundedValues: null, // [[minValue, maxValue] ...]
1141
1142 initializeMouseDown: function(event, g, context) {
1143 // prevents mouse drags from selecting page text.
1144 if (event.preventDefault) {
1145 event.preventDefault(); // Firefox, Chrome, etc.
1146 } else {
1147 event.returnValue = false; // IE
1148 event.cancelBubble = true;
1149 }
1150
1151 context.px = Dygraph.findPosX(g.canvas_);
1152 context.py = Dygraph.findPosY(g.canvas_);
1153 context.dragStartX = g.dragGetX_(event, context);
1154 context.dragStartY = g.dragGetY_(event, context);
1155 }
1156 };
1157
1158 var interactionModel = this.attr_("interactionModel");
1159
1160 // Self is the graph.
1161 var self = this;
1162
1163 // Function that binds the graph and context to the handler.
1164 var bindHandler = function(handler) {
1165 return function(event) {
1166 handler(event, self, context);
1167 };
1168 };
1169
1170 for (var eventName in interactionModel) {
1171 if (!interactionModel.hasOwnProperty(eventName)) continue;
1172 Dygraph.addEvent(this.mouseEventElement_, eventName,
1173 bindHandler(interactionModel[eventName]));
1174 }
1175
1176 // If the user releases the mouse button during a drag, but not over the
1177 // canvas, then it doesn't count as a zooming action.
1178 Dygraph.addEvent(document, 'mouseup', function(event) {
1179 if (context.isZooming || context.isPanning) {
1180 context.isZooming = false;
1181 context.dragStartX = null;
1182 context.dragStartY = null;
1183 }
1184
1185 if (context.isPanning) {
1186 context.isPanning = false;
1187 context.draggingDate = null;
1188 context.dateRange = null;
1189 for (var i = 0; i < self.axes_.length; i++) {
1190 delete self.axes_[i].draggingValue;
1191 delete self.axes_[i].dragValueRange;
1192 }
1193 }
1194 });
1195 };
1196
1197 /**
1198 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1199 * up any previous zoom rectangles that were drawn. This could be optimized to
1200 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1201 * dots.
1202 *
1203 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1204 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1205 * @param {Number} startX The X position where the drag started, in canvas
1206 * coordinates.
1207 * @param {Number} endX The current X position of the drag, in canvas coords.
1208 * @param {Number} startY The Y position where the drag started, in canvas
1209 * coordinates.
1210 * @param {Number} endY The current Y position of the drag, in canvas coords.
1211 * @param {Number} prevDirection the value of direction on the previous call to
1212 * this function. Used to avoid excess redrawing
1213 * @param {Number} prevEndX The value of endX on the previous call to this
1214 * function. Used to avoid excess redrawing
1215 * @param {Number} prevEndY The value of endY on the previous call to this
1216 * function. Used to avoid excess redrawing
1217 * @private
1218 */
1219 Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY,
1220 endY, prevDirection, prevEndX,
1221 prevEndY) {
1222 var ctx = this.canvas_ctx_;
1223
1224 // Clean up from the previous rect if necessary
1225 if (prevDirection == Dygraph.HORIZONTAL) {
1226 ctx.clearRect(Math.min(startX, prevEndX), this.layout_.getPlotArea().y,
1227 Math.abs(startX - prevEndX), this.layout_.getPlotArea().h);
1228 } else if (prevDirection == Dygraph.VERTICAL){
1229 ctx.clearRect(this.layout_.getPlotArea().x, Math.min(startY, prevEndY),
1230 this.layout_.getPlotArea().w, Math.abs(startY - prevEndY));
1231 }
1232
1233 // Draw a light-grey rectangle to show the new viewing area
1234 if (direction == Dygraph.HORIZONTAL) {
1235 if (endX && startX) {
1236 ctx.fillStyle = "rgba(128,128,128,0.33)";
1237 ctx.fillRect(Math.min(startX, endX), this.layout_.getPlotArea().y,
1238 Math.abs(endX - startX), this.layout_.getPlotArea().h);
1239 }
1240 } else if (direction == Dygraph.VERTICAL) {
1241 if (endY && startY) {
1242 ctx.fillStyle = "rgba(128,128,128,0.33)";
1243 ctx.fillRect(this.layout_.getPlotArea().x, Math.min(startY, endY),
1244 this.layout_.getPlotArea().w, Math.abs(endY - startY));
1245 }
1246 }
1247
1248 if (this.isUsingExcanvas_) {
1249 this.currentZoomRectArgs_ = [direction, startX, endX, startY, endY, 0, 0, 0];
1250 }
1251 };
1252
1253 /**
1254 * Clear the zoom rectangle (and perform no zoom).
1255 * @private
1256 */
1257 Dygraph.prototype.clearZoomRect_ = function() {
1258 this.currentZoomRectArgs_ = null;
1259 this.canvas_ctx_.clearRect(0, 0, this.canvas_.width, this.canvas_.height);
1260 };
1261
1262 /**
1263 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1264 * the canvas. The exact zoom window may be slightly larger if there are no data
1265 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1266 * which accepts dates that match the raw data. This function redraws the graph.
1267 *
1268 * @param {Number} lowX The leftmost pixel value that should be visible.
1269 * @param {Number} highX The rightmost pixel value that should be visible.
1270 * @private
1271 */
1272 Dygraph.prototype.doZoomX_ = function(lowX, highX) {
1273 this.currentZoomRectArgs_ = null;
1274 // Find the earliest and latest dates contained in this canvasx range.
1275 // Convert the call to date ranges of the raw data.
1276 var minDate = this.toDataXCoord(lowX);
1277 var maxDate = this.toDataXCoord(highX);
1278 this.doZoomXDates_(minDate, maxDate);
1279 };
1280
1281 /**
1282 * Transition function to use in animations. Returns values between 0.0
1283 * (totally old values) and 1.0 (totally new values) for each frame.
1284 * @private
1285 */
1286 Dygraph.zoomAnimationFunction = function(frame, numFrames) {
1287 var k = 1.5;
1288 return (1.0 - Math.pow(k, -frame)) / (1.0 - Math.pow(k, -numFrames));
1289 };
1290
1291 /**
1292 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1293 * method with doZoomX which accepts pixel coordinates. This function redraws
1294 * the graph.
1295 *
1296 * @param {Number} minDate The minimum date that should be visible.
1297 * @param {Number} maxDate The maximum date that should be visible.
1298 * @private
1299 */
1300 Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
1301 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1302 // can produce strange effects. Rather than the y-axis transitioning slowly
1303 // between values, it can jerk around.)
1304 var old_window = this.xAxisRange();
1305 var new_window = [minDate, maxDate];
1306 this.zoomed_x_ = true;
1307 var that = this;
1308 this.doAnimatedZoom(old_window, new_window, null, null, function() {
1309 if (that.attr_("zoomCallback")) {
1310 that.attr_("zoomCallback")(minDate, maxDate, that.yAxisRanges());
1311 }
1312 });
1313 };
1314
1315 /**
1316 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1317 * the canvas. This function redraws the graph.
1318 *
1319 * @param {Number} lowY The topmost pixel value that should be visible.
1320 * @param {Number} highY The lowest pixel value that should be visible.
1321 * @private
1322 */
1323 Dygraph.prototype.doZoomY_ = function(lowY, highY) {
1324 this.currentZoomRectArgs_ = null;
1325 // Find the highest and lowest values in pixel range for each axis.
1326 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1327 // This is because pixels increase as you go down on the screen, whereas data
1328 // coordinates increase as you go up the screen.
1329 var oldValueRanges = this.yAxisRanges();
1330 var newValueRanges = [];
1331 for (var i = 0; i < this.axes_.length; i++) {
1332 var hi = this.toDataYCoord(lowY, i);
1333 var low = this.toDataYCoord(highY, i);
1334 newValueRanges.push([low, hi]);
1335 }
1336
1337 this.zoomed_y_ = true;
1338 var that = this;
1339 this.doAnimatedZoom(null, null, oldValueRanges, newValueRanges, function() {
1340 if (that.attr_("zoomCallback")) {
1341 var xRange = that.xAxisRange();
1342 that.attr_("zoomCallback")(xRange[0], xRange[1], that.yAxisRanges());
1343 }
1344 });
1345 };
1346
1347 /**
1348 * Reset the zoom to the original view coordinates. This is the same as
1349 * double-clicking on the graph.
1350 *
1351 * @private
1352 */
1353 Dygraph.prototype.doUnzoom_ = function() {
1354 var dirty = false, dirtyX = false, dirtyY = false;
1355 if (this.dateWindow_ !== null) {
1356 dirty = true;
1357 dirtyX = true;
1358 }
1359
1360 for (var i = 0; i < this.axes_.length; i++) {
1361 if (typeof(this.axes_[i].valueWindow) !== 'undefined' && this.axes_[i].valueWindow !== null) {
1362 dirty = true;
1363 dirtyY = true;
1364 }
1365 }
1366
1367 // Clear any selection, since it's likely to be drawn in the wrong place.
1368 this.clearSelection();
1369
1370 if (dirty) {
1371 this.zoomed_x_ = false;
1372 this.zoomed_y_ = false;
1373
1374 var minDate = this.rawData_[0][0];
1375 var maxDate = this.rawData_[this.rawData_.length - 1][0];
1376
1377 // With only one frame, don't bother calculating extreme ranges.
1378 // TODO(danvk): merge this block w/ the code below.
1379 if (!this.attr_("animatedZooms")) {
1380 this.dateWindow_ = null;
1381 for (i = 0; i < this.axes_.length; i++) {
1382 if (this.axes_[i].valueWindow !== null) {
1383 delete this.axes_[i].valueWindow;
1384 }
1385 }
1386 this.drawGraph_();
1387 if (this.attr_("zoomCallback")) {
1388 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1389 }
1390 return;
1391 }
1392
1393 var oldWindow=null, newWindow=null, oldValueRanges=null, newValueRanges=null;
1394 if (dirtyX) {
1395 oldWindow = this.xAxisRange();
1396 newWindow = [minDate, maxDate];
1397 }
1398
1399 if (dirtyY) {
1400 oldValueRanges = this.yAxisRanges();
1401 // TODO(danvk): this is pretty inefficient
1402 var packed = this.gatherDatasets_(this.rolledSeries_, null);
1403 var extremes = packed[1];
1404
1405 // this has the side-effect of modifying this.axes_.
1406 // this doesn't make much sense in this context, but it's convenient (we
1407 // need this.axes_[*].extremeValues) and not harmful since we'll be
1408 // calling drawGraph_ shortly, which clobbers these values.
1409 this.computeYAxisRanges_(extremes);
1410
1411 newValueRanges = [];
1412 for (i = 0; i < this.axes_.length; i++) {
1413 var axis = this.axes_[i];
1414 newValueRanges.push(axis.valueRange != null ? axis.valueRange : axis.extremeRange);
1415 }
1416 }
1417
1418 var that = this;
1419 this.doAnimatedZoom(oldWindow, newWindow, oldValueRanges, newValueRanges,
1420 function() {
1421 that.dateWindow_ = null;
1422 for (var i = 0; i < that.axes_.length; i++) {
1423 if (that.axes_[i].valueWindow !== null) {
1424 delete that.axes_[i].valueWindow;
1425 }
1426 }
1427 if (that.attr_("zoomCallback")) {
1428 that.attr_("zoomCallback")(minDate, maxDate, that.yAxisRanges());
1429 }
1430 });
1431 }
1432 };
1433
1434 /**
1435 * Combined animation logic for all zoom functions.
1436 * either the x parameters or y parameters may be null.
1437 * @private
1438 */
1439 Dygraph.prototype.doAnimatedZoom = function(oldXRange, newXRange, oldYRanges, newYRanges, callback) {
1440 var steps = this.attr_("animatedZooms") ? Dygraph.ANIMATION_STEPS : 1;
1441
1442 var windows = [];
1443 var valueRanges = [];
1444 var step, frac;
1445
1446 if (oldXRange !== null && newXRange !== null) {
1447 for (step = 1; step <= steps; step++) {
1448 frac = Dygraph.zoomAnimationFunction(step, steps);
1449 windows[step-1] = [oldXRange[0]*(1-frac) + frac*newXRange[0],
1450 oldXRange[1]*(1-frac) + frac*newXRange[1]];
1451 }
1452 }
1453
1454 if (oldYRanges !== null && newYRanges !== null) {
1455 for (step = 1; step <= steps; step++) {
1456 frac = Dygraph.zoomAnimationFunction(step, steps);
1457 var thisRange = [];
1458 for (var j = 0; j < this.axes_.length; j++) {
1459 thisRange.push([oldYRanges[j][0]*(1-frac) + frac*newYRanges[j][0],
1460 oldYRanges[j][1]*(1-frac) + frac*newYRanges[j][1]]);
1461 }
1462 valueRanges[step-1] = thisRange;
1463 }
1464 }
1465
1466 var that = this;
1467 Dygraph.repeatAndCleanup(function(step) {
1468 if (valueRanges.length) {
1469 for (var i = 0; i < that.axes_.length; i++) {
1470 var w = valueRanges[step][i];
1471 that.axes_[i].valueWindow = [w[0], w[1]];
1472 }
1473 }
1474 if (windows.length) {
1475 that.dateWindow_ = windows[step];
1476 }
1477 that.drawGraph_();
1478 }, steps, Dygraph.ANIMATION_DURATION / steps, callback);
1479 };
1480
1481 /**
1482 * Get the current graph's area object.
1483 *
1484 * Returns: {x, y, w, h}
1485 */
1486 Dygraph.prototype.getArea = function() {
1487 return this.plotter_.area;
1488 };
1489
1490 /**
1491 * Convert a mouse event to DOM coordinates relative to the graph origin.
1492 *
1493 * Returns a two-element array: [X, Y].
1494 */
1495 Dygraph.prototype.eventToDomCoords = function(event) {
1496 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
1497 var canvasy = Dygraph.pageY(event) - Dygraph.findPosY(this.mouseEventElement_);
1498 return [canvasx, canvasy];
1499 };
1500
1501 /**
1502 * Given a canvas X coordinate, find the closest row.
1503 * @param {Number} domX graph-relative DOM X coordinate
1504 * Returns: row number, integer
1505 * @private
1506 */
1507 Dygraph.prototype.findClosestRow = function(domX) {
1508 var minDistX = null;
1509 var idx = -1;
1510 var points = this.layout_.points;
1511 var l = points.length;
1512 for (var i = 0; i < l; i++) {
1513 var point = points[i];
1514 if (point === null) continue;
1515 var dist = Math.abs(point.canvasx - domX);
1516 if (minDistX !== null && dist >= minDistX) continue;
1517 minDistX = dist;
1518 idx = i;
1519 }
1520 return this.idxToRow_(idx);
1521 };
1522
1523 /**
1524 * Given canvas X,Y coordinates, find the closest point.
1525 *
1526 * This finds the individual data point across all visible series
1527 * that's closest to the supplied DOM coordinates using the standard
1528 * Euclidean X,Y distance.
1529 *
1530 * @param {Number} domX graph-relative DOM X coordinate
1531 * @param {Number} domY graph-relative DOM Y coordinate
1532 * Returns: {row, seriesName, point}
1533 * @private
1534 */
1535 Dygraph.prototype.findClosestPoint = function(domX, domY) {
1536 var minDist = null;
1537 var idx = -1;
1538 var points = this.layout_.points;
1539 var dist, dx, dy, point, closestPoint, closestSeries;
1540 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1541 var first = this.layout_.setPointsOffsets[setIdx];
1542 var len = this.layout_.setPointsLengths[setIdx];
1543 for (var i = 0; i < len; ++i) {
1544 var point = points[first + i];
1545 if (point === null) continue;
1546 dx = point.canvasx - domX;
1547 dy = point.canvasy - domY;
1548 dist = dx * dx + dy * dy;
1549 if (minDist !== null && dist >= minDist) continue;
1550 minDist = dist;
1551 closestPoint = point;
1552 closestSeries = setIdx;
1553 idx = i;
1554 }
1555 }
1556 var name = this.layout_.setNames[closestSeries];
1557 return {
1558 row: idx,
1559 seriesName: name,
1560 point: closestPoint
1561 };
1562 };
1563
1564 /**
1565 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1566 *
1567 * This first finds the X data point closest to the supplied DOM X coordinate,
1568 * then finds the series which puts the Y coordinate on top of its filled area,
1569 * using linear interpolation between adjacent point pairs.
1570 *
1571 * @param {Number} domX graph-relative DOM X coordinate
1572 * @param {Number} domY graph-relative DOM Y coordinate
1573 * Returns: {row, seriesName, point}
1574 * @private
1575 */
1576 Dygraph.prototype.findStackedPoint = function(domX, domY) {
1577 var row = this.findClosestRow(domX);
1578 var points = this.layout_.points;
1579 var closestPoint, closestSeries;
1580 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1581 var first = this.layout_.setPointsOffsets[setIdx];
1582 var len = this.layout_.setPointsLengths[setIdx];
1583 if (row >= len) continue;
1584 var p1 = points[first + row];
1585 var py = p1.canvasy;
1586 if (domX > p1.canvasx && row + 1 < len) {
1587 // interpolate series Y value using next point
1588 var p2 = points[first + row + 1];
1589 var dx = p2.canvasx - p1.canvasx;
1590 if (dx > 0) {
1591 var r = (domX - p1.canvasx) / dx;
1592 py += r * (p2.canvasy - p1.canvasy);
1593 }
1594 } else if (domX < p1.canvasx && row > 0) {
1595 // interpolate series Y value using previous point
1596 var p0 = points[first + row - 1];
1597 var dx = p1.canvasx - p0.canvasx;
1598 if (dx > 0) {
1599 var r = (p1.canvasx - domX) / dx;
1600 py += r * (p0.canvasy - p1.canvasy);
1601 }
1602 }
1603 // Stop if the point (domX, py) is above this series' upper edge
1604 if (setIdx > 0 && py >= domY) break;
1605 closestPoint = p1;
1606 closestSeries = setIdx;
1607 }
1608 var name = this.layout_.setNames[closestSeries];
1609 return {
1610 row: row,
1611 seriesName: name,
1612 point: closestPoint
1613 };
1614 };
1615
1616 /**
1617 * When the mouse moves in the canvas, display information about a nearby data
1618 * point and draw dots over those points in the data series. This function
1619 * takes care of cleanup of previously-drawn dots.
1620 * @param {Object} event The mousemove event from the browser.
1621 * @private
1622 */
1623 Dygraph.prototype.mouseMove_ = function(event) {
1624 // This prevents JS errors when mousing over the canvas before data loads.
1625 var points = this.layout_.points;
1626 if (points === undefined) return;
1627
1628 var canvasCoords = this.eventToDomCoords(event);
1629 var canvasx = canvasCoords[0];
1630 var canvasy = canvasCoords[1];
1631
1632 var highlightSeriesOpts = this.attr_("highlightSeriesOpts");
1633 var selectionChanged = false;
1634 if (highlightSeriesOpts) {
1635 var closest;
1636 if (this.attr_("stackedGraph")) {
1637 closest = this.findStackedPoint(canvasx, canvasy);
1638 } else {
1639 closest = this.findClosestPoint(canvasx, canvasy);
1640 }
1641 selectionChanged = this.setSelection(closest.row, closest.seriesName);
1642 } else {
1643 var idx = this.findClosestRow(canvasx);
1644 selectionChanged = this.setSelection(idx);
1645 }
1646
1647 var callback = this.attr_("highlightCallback");
1648 if (callback && selectionChanged) {
1649 callback(event, this.lastx_, this.selPoints_, this.lastRow_, this.highlightSet_);
1650 }
1651 };
1652
1653 /**
1654 * Transforms layout_.points index into data row number.
1655 * @param int layout_.points index
1656 * @return int row number, or -1 if none could be found.
1657 * @private
1658 */
1659 Dygraph.prototype.idxToRow_ = function(idx) {
1660 if (idx < 0) return -1;
1661
1662 // make sure that you get the boundaryIds record which is also defined (see bug #236)
1663 var boundaryIdx = -1;
1664 for (var i = 0; i < this.boundaryIds_.length; i++) {
1665 if (this.boundaryIds_[i] !== undefined) {
1666 boundaryIdx = i;
1667 break;
1668 }
1669 }
1670 if (boundaryIdx < 0) return -1;
1671 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1672 var set = this.layout_.datasets[setIdx];
1673 if (idx < set.length) {
1674 return this.boundaryIds_[boundaryIdx][0] + idx;
1675 }
1676 idx -= set.length;
1677 }
1678 return -1;
1679 };
1680
1681 /**
1682 * @private
1683 * Generates legend html dash for any stroke pattern. It will try to scale the
1684 * pattern to fit in 1em width. Or if small enough repeat the partern for 1em
1685 * width.
1686 * @param strokePattern The pattern
1687 * @param color The color of the series.
1688 * @param oneEmWidth The width in pixels of 1em in the legend.
1689 */
1690 Dygraph.prototype.generateLegendDashHTML_ = function(strokePattern, color, oneEmWidth) {
1691 var dash = "";
1692 var i, j, paddingLeft, marginRight;
1693 var strokePixelLength = 0, segmentLoop = 0;
1694 var normalizedPattern = [];
1695 var loop;
1696 // IE 7,8 fail at these divs, so they get boring legend, have not tested 9.
1697 var isIE = (/MSIE/.test(navigator.userAgent) && !window.opera);
1698 if(isIE) {
1699 return "&mdash;";
1700 }
1701 if (!strokePattern || strokePattern.length <= 1) {
1702 // Solid line
1703 dash = "<div style=\"display: inline-block; position: relative; " +
1704 "bottom: .5ex; padding-left: 1em; height: 1px; " +
1705 "border-bottom: 2px solid " + color + ";\"></div>";
1706 } else {
1707 // Compute the length of the pixels including the first segment twice,
1708 // since we repeat it.
1709 for (i = 0; i <= strokePattern.length; i++) {
1710 strokePixelLength += strokePattern[i%strokePattern.length];
1711 }
1712
1713 // See if we can loop the pattern by itself at least twice.
1714 loop = Math.floor(oneEmWidth/(strokePixelLength-strokePattern[0]));
1715 if (loop > 1) {
1716 // This pattern fits at least two times, no scaling just convert to em;
1717 for (i = 0; i < strokePattern.length; i++) {
1718 normalizedPattern[i] = strokePattern[i]/oneEmWidth;
1719 }
1720 // Since we are repeating the pattern, we don't worry about repeating the
1721 // first segment in one draw.
1722 segmentLoop = normalizedPattern.length;
1723 } else {
1724 // If the pattern doesn't fit in the legend we scale it to fit.
1725 loop = 1;
1726 for (i = 0; i < strokePattern.length; i++) {
1727 normalizedPattern[i] = strokePattern[i]/strokePixelLength;
1728 }
1729 // For the scaled patterns we do redraw the first segment.
1730 segmentLoop = normalizedPattern.length+1;
1731 }
1732 // Now make the pattern.
1733 for (j = 0; j < loop; j++) {
1734 for (i = 0; i < segmentLoop; i+=2) {
1735 // The padding is the drawn segment.
1736 paddingLeft = normalizedPattern[i%normalizedPattern.length];
1737 if (i < strokePattern.length) {
1738 // The margin is the space segment.
1739 marginRight = normalizedPattern[(i+1)%normalizedPattern.length];
1740 } else {
1741 // The repeated first segment has no right margin.
1742 marginRight = 0;
1743 }
1744 dash += "<div style=\"display: inline-block; position: relative; " +
1745 "bottom: .5ex; margin-right: " + marginRight + "em; padding-left: " +
1746 paddingLeft + "em; height: 1px; border-bottom: 2px solid " + color +
1747 ";\"></div>";
1748 }
1749 }
1750 }
1751 return dash;
1752 };
1753
1754 /**
1755 * @private
1756 * Generates HTML for the legend which is displayed when hovering over the
1757 * chart. If no selected points are specified, a default legend is returned
1758 * (this may just be the empty string).
1759 * @param { Number } [x] The x-value of the selected points.
1760 * @param { [Object] } [sel_points] List of selected points for the given
1761 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1762 * @param { Number } [oneEmWidth] The pixel width for 1em in the legend.
1763 */
1764 Dygraph.prototype.generateLegendHTML_ = function(x, sel_points, oneEmWidth) {
1765 // If no points are selected, we display a default legend. Traditionally,
1766 // this has been blank. But a better default would be a conventional legend,
1767 // which provides essential information for a non-interactive chart.
1768 var html, sepLines, i, c, dash, strokePattern;
1769 if (typeof(x) === 'undefined') {
1770 if (this.attr_('legend') != 'always') return '';
1771
1772 sepLines = this.attr_('labelsSeparateLines');
1773 var labels = this.attr_('labels');
1774 html = '';
1775 for (i = 1; i < labels.length; i++) {
1776 if (!this.visibility()[i - 1]) continue;
1777 c = this.plotter_.colors[labels[i]];
1778 if (html !== '') html += (sepLines ? '<br/>' : ' ');
1779 strokePattern = this.attr_("strokePattern", labels[i]);
1780 dash = this.generateLegendDashHTML_(strokePattern, c, oneEmWidth);
1781 html += "<span style='font-weight: bold; color: " + c + ";'>" + dash +
1782 " " + labels[i] + "</span>";
1783 }
1784 return html;
1785 }
1786
1787 var xOptView = this.optionsViewForAxis_('x');
1788 var xvf = xOptView('valueFormatter');
1789 html = xvf(x, xOptView, this.attr_('labels')[0], this) + ":";
1790
1791 var yOptViews = [];
1792 var num_axes = this.numAxes();
1793 for (i = 0; i < num_axes; i++) {
1794 yOptViews[i] = this.optionsViewForAxis_('y' + (i ? 1 + i : ''));
1795 }
1796 var showZeros = this.attr_("labelsShowZeroValues");
1797 sepLines = this.attr_("labelsSeparateLines");
1798 for (i = 0; i < this.selPoints_.length; i++) {
1799 var pt = this.selPoints_[i];
1800 if (pt.yval === 0 && !showZeros) continue;
1801 if (!Dygraph.isOK(pt.canvasy)) continue;
1802 if (sepLines) html += "<br/>";
1803
1804 var yOptView = yOptViews[this.seriesToAxisMap_[pt.name]];
1805 var fmtFunc = yOptView('valueFormatter');
1806 c = this.plotter_.colors[pt.name];
1807 var yval = fmtFunc(pt.yval, yOptView, pt.name, this);
1808
1809 var cls = (pt.name == this.highlightSet_) ? " class='highlight'" : "";
1810 // TODO(danvk): use a template string here and make it an attribute.
1811 html += "<span" + cls + ">" + " <b><span style='color: " + c + ";'>" + pt.name +
1812 "</span></b>:" + yval + "</span>";
1813 }
1814 return html;
1815 };
1816
1817 /**
1818 * @private
1819 * Displays information about the selected points in the legend. If there is no
1820 * selection, the legend will be cleared.
1821 * @param { Number } [x] The x-value of the selected points.
1822 * @param { [Object] } [sel_points] List of selected points for the given
1823 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1824 */
1825 Dygraph.prototype.setLegendHTML_ = function(x, sel_points) {
1826 var labelsDiv = this.attr_("labelsDiv");
1827 var sizeSpan = document.createElement('span');
1828 // Calculates the width of 1em in pixels for the legend.
1829 sizeSpan.setAttribute('style', 'margin: 0; padding: 0 0 0 1em; border: 0;');
1830 labelsDiv.appendChild(sizeSpan);
1831 var oneEmWidth=sizeSpan.offsetWidth;
1832
1833 var html = this.generateLegendHTML_(x, sel_points, oneEmWidth);
1834 if (labelsDiv !== null) {
1835 labelsDiv.innerHTML = html;
1836 } else {
1837 if (typeof(this.shown_legend_error_) == 'undefined') {
1838 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1839 this.shown_legend_error_ = true;
1840 }
1841 }
1842 };
1843
1844 Dygraph.prototype.animateSelection_ = function(direction) {
1845 var totalSteps = 10;
1846 var millis = 30;
1847 if (this.fadeLevel === undefined) {
1848 this.fadeLevel = 0;
1849 this.animateId = 0;
1850 }
1851 var start = this.fadeLevel;
1852 var steps = direction < 0 ? start : totalSteps - start;
1853 if (steps <= 0) {
1854 if (this.fadeLevel) {
1855 this.updateSelection_(1.0);
1856 }
1857 return;
1858 }
1859
1860 var thisId = ++this.animateId;
1861 var that = this;
1862 Dygraph.repeatAndCleanup(
1863 function(n) {
1864 // ignore simultaneous animations
1865 if (that.animateId != thisId) return;
1866
1867 that.fadeLevel += direction;
1868 if (that.fadeLevel === 0) {
1869 that.clearSelection();
1870 } else {
1871 that.updateSelection_(that.fadeLevel / totalSteps);
1872 }
1873 },
1874 steps, millis, function() {});
1875 };
1876
1877 /**
1878 * Draw dots over the selectied points in the data series. This function
1879 * takes care of cleanup of previously-drawn dots.
1880 * @private
1881 */
1882 Dygraph.prototype.updateSelection_ = function(opt_animFraction) {
1883 // Clear the previously drawn vertical, if there is one
1884 var i;
1885 var ctx = this.canvas_ctx_;
1886 if (this.attr_('highlightSeriesOpts')) {
1887 ctx.clearRect(0, 0, this.width_, this.height_);
1888 var alpha = this.attr_('highlightSeriesBackgroundFade');
1889 if (alpha) {
1890 // Activating background fade includes an animation effect for a gradual
1891 // fade. TODO(klausw): make this independently configurable if it causes
1892 // issues? Use a shared preference to control animations?
1893 var animateBackgroundFade = true;
1894 if (animateBackgroundFade) {
1895 if (opt_animFraction === undefined) {
1896 // start a new animation
1897 this.animateSelection_(1);
1898 return;
1899 }
1900 alpha *= opt_animFraction;
1901 }
1902 ctx.fillStyle = 'rgba(255,255,255,' + alpha + ')';
1903 ctx.fillRect(0, 0, this.width_, this.height_);
1904 }
1905 var setIdx = this.datasetIndexFromSetName_(this.highlightSet_);
1906 this.plotter_._drawLine(ctx, setIdx);
1907 } else if (this.previousVerticalX_ >= 0) {
1908 // Determine the maximum highlight circle size.
1909 var maxCircleSize = 0;
1910 var labels = this.attr_('labels');
1911 for (i = 1; i < labels.length; i++) {
1912 var r = this.attr_('highlightCircleSize', labels[i]);
1913 if (r > maxCircleSize) maxCircleSize = r;
1914 }
1915 var px = this.previousVerticalX_;
1916 ctx.clearRect(px - maxCircleSize - 1, 0,
1917 2 * maxCircleSize + 2, this.height_);
1918 }
1919
1920 if (this.isUsingExcanvas_ && this.currentZoomRectArgs_) {
1921 Dygraph.prototype.drawZoomRect_.apply(this, this.currentZoomRectArgs_);
1922 }
1923
1924 if (this.selPoints_.length > 0) {
1925 // Set the status message to indicate the selected point(s)
1926 if (this.attr_('showLabelsOnHighlight')) {
1927 this.setLegendHTML_(this.lastx_, this.selPoints_);
1928 }
1929
1930 // Draw colored circles over the center of each selected point
1931 var canvasx = this.selPoints_[0].canvasx;
1932 ctx.save();
1933 for (i = 0; i < this.selPoints_.length; i++) {
1934 var pt = this.selPoints_[i];
1935 if (!Dygraph.isOK(pt.canvasy)) continue;
1936
1937 var circleSize = this.attr_('highlightCircleSize', pt.name);
1938 var callback = this.attr_("drawHighlightPointCallback", pt.name);
1939 if (!callback) {
1940 callback = Dygraph.Circles.DEFAULT;
1941 }
1942 callback(this.g, pt.name, ctx, canvasx, pt.canvasy,
1943 this.plotter_.colors[pt.name], circleSize);
1944 }
1945 ctx.restore();
1946
1947 this.previousVerticalX_ = canvasx;
1948 }
1949 };
1950
1951 /**
1952 * Manually set the selected points and display information about them in the
1953 * legend. The selection can be cleared using clearSelection() and queried
1954 * using getSelection().
1955 * @param { Integer } row number that should be highlighted (i.e. appear with
1956 * hover dots on the chart). Set to false to clear any selection.
1957 * @param { seriesName } optional series name to highlight that series with the
1958 * the highlightSeriesOpts setting.
1959 */
1960 Dygraph.prototype.setSelection = function(row, opt_seriesName) {
1961 // Extract the points we've selected
1962 this.selPoints_ = [];
1963 var pos = 0;
1964
1965 if (row !== false) {
1966 for (var i = 0; i < this.boundaryIds_.length; i++) {
1967 if (this.boundaryIds_[i] !== undefined) {
1968 row -= this.boundaryIds_[i][0];
1969 break;
1970 }
1971 }
1972 }
1973
1974 var changed = false;
1975 if (row !== false && row >= 0) {
1976 if (row != this.lastRow_) changed = true;
1977 this.lastRow_ = row;
1978 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1979 var set = this.layout_.datasets[setIdx];
1980 if (row < set.length) {
1981 var point = this.layout_.points[pos+row];
1982
1983 if (this.attr_("stackedGraph")) {
1984 point = this.layout_.unstackPointAtIndex(pos+row);
1985 }
1986
1987 this.selPoints_.push(point);
1988 }
1989 pos += set.length;
1990 }
1991 } else {
1992 if (this.lastRow_ >= 0) changed = true;
1993 this.lastRow_ = -1;
1994 }
1995
1996 if (this.selPoints_.length) {
1997 this.lastx_ = this.selPoints_[0].xval;
1998 } else {
1999 this.lastx_ = -1;
2000 }
2001
2002 if (opt_seriesName !== undefined) {
2003 if (this.highlightSet_ !== opt_seriesName) changed = true;
2004 this.highlightSet_ = opt_seriesName;
2005 }
2006
2007 if (changed) {
2008 this.updateSelection_(undefined);
2009 }
2010 return changed;
2011 };
2012
2013 /**
2014 * The mouse has left the canvas. Clear out whatever artifacts remain
2015 * @param {Object} event the mouseout event from the browser.
2016 * @private
2017 */
2018 Dygraph.prototype.mouseOut_ = function(event) {
2019 if (this.attr_("unhighlightCallback")) {
2020 this.attr_("unhighlightCallback")(event);
2021 }
2022
2023 if (this.attr_("hideOverlayOnMouseOut")) {
2024 this.clearSelection();
2025 }
2026 };
2027
2028 /**
2029 * Clears the current selection (i.e. points that were highlighted by moving
2030 * the mouse over the chart).
2031 */
2032 Dygraph.prototype.clearSelection = function() {
2033 // Get rid of the overlay data
2034 if (this.fadeLevel) {
2035 this.animateSelection_(-1);
2036 return;
2037 }
2038 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
2039 this.fadeLevel = 0;
2040 this.setLegendHTML_();
2041 this.selPoints_ = [];
2042 this.lastx_ = -1;
2043 this.lastRow_ = -1;
2044 this.highlightSet_ = null;
2045 };
2046
2047 /**
2048 * Returns the number of the currently selected row. To get data for this row,
2049 * you can use the getValue method.
2050 * @return { Integer } row number, or -1 if nothing is selected
2051 */
2052 Dygraph.prototype.getSelection = function() {
2053 if (!this.selPoints_ || this.selPoints_.length < 1) {
2054 return -1;
2055 }
2056
2057 for (var row=0; row<this.layout_.points.length; row++ ) {
2058 if (this.layout_.points[row].x == this.selPoints_[0].x) {
2059 return row + this.boundaryIds_[0][0];
2060 }
2061 }
2062 return -1;
2063 };
2064
2065 Dygraph.prototype.getHighlightSeries = function() {
2066 return this.highlightSet_;
2067 };
2068
2069 /**
2070 * Fires when there's data available to be graphed.
2071 * @param {String} data Raw CSV data to be plotted
2072 * @private
2073 */
2074 Dygraph.prototype.loadedEvent_ = function(data) {
2075 this.rawData_ = this.parseCSV_(data);
2076 this.predraw_();
2077 };
2078
2079 /**
2080 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2081 * @private
2082 */
2083 Dygraph.prototype.addXTicks_ = function() {
2084 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2085 var range;
2086 if (this.dateWindow_) {
2087 range = [this.dateWindow_[0], this.dateWindow_[1]];
2088 } else {
2089 range = this.fullXRange_();
2090 }
2091
2092 var xAxisOptionsView = this.optionsViewForAxis_('x');
2093 var xTicks = xAxisOptionsView('ticker')(
2094 range[0],
2095 range[1],
2096 this.width_, // TODO(danvk): should be area.width
2097 xAxisOptionsView,
2098 this);
2099 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2100 // console.log(msg);
2101 this.layout_.setXTicks(xTicks);
2102 };
2103
2104 /**
2105 * @private
2106 * Computes the range of the data series (including confidence intervals).
2107 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2108 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2109 * @return [low, high]
2110 */
2111 Dygraph.prototype.extremeValues_ = function(series) {
2112 var minY = null, maxY = null, j, y;
2113
2114 var bars = this.attr_("errorBars") || this.attr_("customBars");
2115 if (bars) {
2116 // With custom bars, maxY is the max of the high values.
2117 for (j = 0; j < series.length; j++) {
2118 y = series[j][1][0];
2119 if (!y) continue;
2120 var low = y - series[j][1][1];
2121 var high = y + series[j][1][2];
2122 if (low > y) low = y; // this can happen with custom bars,
2123 if (high < y) high = y; // e.g. in tests/custom-bars.html
2124 if (maxY === null || high > maxY) {
2125 maxY = high;
2126 }
2127 if (minY === null || low < minY) {
2128 minY = low;
2129 }
2130 }
2131 } else {
2132 for (j = 0; j < series.length; j++) {
2133 y = series[j][1];
2134 if (y === null || isNaN(y)) continue;
2135 if (maxY === null || y > maxY) {
2136 maxY = y;
2137 }
2138 if (minY === null || y < minY) {
2139 minY = y;
2140 }
2141 }
2142 }
2143
2144 return [minY, maxY];
2145 };
2146
2147 /**
2148 * @private
2149 * This function is called once when the chart's data is changed or the options
2150 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2151 * idea is that values derived from the chart's data can be computed here,
2152 * rather than every time the chart is drawn. This includes things like the
2153 * number of axes, rolling averages, etc.
2154 */
2155 Dygraph.prototype.predraw_ = function() {
2156 var start = new Date();
2157
2158 // TODO(danvk): move more computations out of drawGraph_ and into here.
2159 this.computeYAxes_();
2160
2161 // Create a new plotter.
2162 if (this.plotter_) this.plotter_.clear();
2163 this.plotter_ = new DygraphCanvasRenderer(this,
2164 this.hidden_,
2165 this.hidden_ctx_,
2166 this.layout_);
2167
2168 // The roller sits in the bottom left corner of the chart. We don't know where
2169 // this will be until the options are available, so it's positioned here.
2170 this.createRollInterface_();
2171
2172 // Same thing applies for the labelsDiv. It's right edge should be flush with
2173 // the right edge of the charting area (which may not be the same as the right
2174 // edge of the div, if we have two y-axes.
2175 this.positionLabelsDiv_();
2176
2177 if (this.rangeSelector_) {
2178 this.rangeSelector_.renderStaticLayer();
2179 }
2180
2181 // Convert the raw data (a 2D array) into the internal format and compute
2182 // rolling averages.
2183 this.rolledSeries_ = [null]; // x-axis is the first series and it's special
2184 for (var i = 1; i < this.numColumns(); i++) {
2185 var connectSeparatedPoints = this.attr_('connectSeparatedPoints', i);
2186 var logScale = this.attr_('logscale', i);
2187 var series = this.extractSeries_(this.rawData_, i, logScale, connectSeparatedPoints);
2188 series = this.rollingAverage(series, this.rollPeriod_);
2189 this.rolledSeries_.push(series);
2190 }
2191
2192 // If the data or options have changed, then we'd better redraw.
2193 this.drawGraph_();
2194
2195 // This is used to determine whether to do various animations.
2196 var end = new Date();
2197 this.drawingTimeMs_ = (end - start);
2198 };
2199
2200 /**
2201 * Loop over all fields and create datasets, calculating extreme y-values for
2202 * each series and extreme x-indices as we go.
2203 *
2204 * dateWindow is passed in as an explicit parameter so that we can compute
2205 * extreme values "speculatively", i.e. without actually setting state on the
2206 * dygraph.
2207 *
2208 * TODO(danvk): make this more of a true function
2209 * @return [ datasets, seriesExtremes, boundaryIds ]
2210 * @private
2211 */
2212 Dygraph.prototype.gatherDatasets_ = function(rolledSeries, dateWindow) {
2213 var boundaryIds = [];
2214 var cumulative_y = []; // For stacked series.
2215 var datasets = [];
2216 var extremes = {}; // series name -> [low, high]
2217 var i, j, k;
2218
2219 // Loop over the fields (series). Go from the last to the first,
2220 // because if they're stacked that's how we accumulate the values.
2221 var num_series = rolledSeries.length - 1;
2222 for (i = num_series; i >= 1; i--) {
2223 if (!this.visibility()[i - 1]) continue;
2224
2225 // TODO(danvk): is this copy really necessary?
2226 var series = [];
2227 for (j = 0; j < rolledSeries[i].length; j++) {
2228 series.push(rolledSeries[i][j]);
2229 }
2230
2231 // Prune down to the desired range, if necessary (for zooming)
2232 // Because there can be lines going to points outside of the visible area,
2233 // we actually prune to visible points, plus one on either side.
2234 var bars = this.attr_("errorBars") || this.attr_("customBars");
2235 if (dateWindow) {
2236 var low = dateWindow[0];
2237 var high = dateWindow[1];
2238 var pruned = [];
2239 // TODO(danvk): do binary search instead of linear search.
2240 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2241 var firstIdx = null, lastIdx = null;
2242 for (k = 0; k < series.length; k++) {
2243 if (series[k][0] >= low && firstIdx === null) {
2244 firstIdx = k;
2245 }
2246 if (series[k][0] <= high) {
2247 lastIdx = k;
2248 }
2249 }
2250 if (firstIdx === null) firstIdx = 0;
2251 if (firstIdx > 0) firstIdx--;
2252 if (lastIdx === null) lastIdx = series.length - 1;
2253 if (lastIdx < series.length - 1) lastIdx++;
2254 boundaryIds[i-1] = [firstIdx, lastIdx];
2255 for (k = firstIdx; k <= lastIdx; k++) {
2256 pruned.push(series[k]);
2257 }
2258 series = pruned;
2259 } else {
2260 boundaryIds[i-1] = [0, series.length-1];
2261 }
2262
2263 var seriesExtremes = this.extremeValues_(series);
2264
2265 if (bars) {
2266 for (j=0; j<series.length; j++) {
2267 series[j] = [series[j][0],
2268 series[j][1][0],
2269 series[j][1][1],
2270 series[j][1][2]];
2271 }
2272 } else if (this.attr_("stackedGraph")) {
2273 var l = series.length;
2274 var actual_y;
2275 for (j = 0; j < l; j++) {
2276 // If one data set has a NaN, let all subsequent stacked
2277 // sets inherit the NaN -- only start at 0 for the first set.
2278 var x = series[j][0];
2279 if (cumulative_y[x] === undefined) {
2280 cumulative_y[x] = 0;
2281 }
2282
2283 actual_y = series[j][1];
2284 cumulative_y[x] += actual_y;
2285
2286 series[j] = [x, cumulative_y[x]];
2287
2288 if (cumulative_y[x] > seriesExtremes[1]) {
2289 seriesExtremes[1] = cumulative_y[x];
2290 }
2291 if (cumulative_y[x] < seriesExtremes[0]) {
2292 seriesExtremes[0] = cumulative_y[x];
2293 }
2294 }
2295 }
2296
2297 var seriesName = this.attr_("labels")[i];
2298 extremes[seriesName] = seriesExtremes;
2299 datasets[i] = series;
2300 }
2301
2302 return [ datasets, extremes, boundaryIds ];
2303 };
2304
2305 /**
2306 * Update the graph with new data. This method is called when the viewing area
2307 * has changed. If the underlying data or options have changed, predraw_ will
2308 * be called before drawGraph_ is called.
2309 *
2310 * clearSelection, when undefined or true, causes this.clearSelection to be
2311 * called at the end of the draw operation. This should rarely be defined,
2312 * and never true (that is it should be undefined most of the time, and
2313 * rarely false.)
2314 *
2315 * @private
2316 */
2317 Dygraph.prototype.drawGraph_ = function(clearSelection) {
2318 var start = new Date();
2319
2320 if (typeof(clearSelection) === 'undefined') {
2321 clearSelection = true;
2322 }
2323
2324 // This is used to set the second parameter to drawCallback, below.
2325 var is_initial_draw = this.is_initial_draw_;
2326 this.is_initial_draw_ = false;
2327
2328 this.layout_.removeAllDatasets();
2329 this.setColors_();
2330 this.attrs_.pointSize = 0.5 * this.attr_('highlightCircleSize');
2331
2332 var packed = this.gatherDatasets_(this.rolledSeries_, this.dateWindow_);
2333 var datasets = packed[0];
2334 var extremes = packed[1];
2335 this.boundaryIds_ = packed[2];
2336
2337 this.setIndexByName_ = {};
2338 var labels = this.attr_("labels");
2339 if (labels.length > 0) {
2340 this.setIndexByName_[labels[0]] = 0;
2341 }
2342 var dataIdx = 0;
2343 for (var i = 1; i < datasets.length; i++) {
2344 this.setIndexByName_[labels[i]] = i;
2345 if (!this.visibility()[i - 1]) continue;
2346 this.layout_.addDataset(labels[i], datasets[i]);
2347 this.datasetIndex_[i] = dataIdx++;
2348 }
2349
2350 this.computeYAxisRanges_(extremes);
2351 this.layout_.setYAxes(this.axes_);
2352
2353 this.addXTicks_();
2354
2355 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2356 var tmp_zoomed_x = this.zoomed_x_;
2357 // Tell PlotKit to use this new data and render itself
2358 this.layout_.setDateWindow(this.dateWindow_);
2359 this.zoomed_x_ = tmp_zoomed_x;
2360 this.layout_.evaluateWithError();
2361 this.renderGraph_(is_initial_draw, false);
2362
2363 if (this.attr_("timingName")) {
2364 var end = new Date();
2365 if (console) {
2366 console.log(this.attr_("timingName") + " - drawGraph: " + (end - start) + "ms");
2367 }
2368 }
2369 };
2370
2371 Dygraph.prototype.renderGraph_ = function(is_initial_draw, clearSelection) {
2372 this.plotter_.clear();
2373 this.plotter_.render();
2374 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2375 this.canvas_.height);
2376
2377 // Generate a static legend before any particular point is selected.
2378 this.setLegendHTML_();
2379
2380 if (!is_initial_draw) {
2381 if (clearSelection) {
2382 if (typeof(this.selPoints_) !== 'undefined' && this.selPoints_.length) {
2383 // We should select the point nearest the page x/y here, but it's easier
2384 // to just clear the selection. This prevents erroneous hover dots from
2385 // being displayed.
2386 this.clearSelection();
2387 } else {
2388 this.clearSelection();
2389 }
2390 }
2391 }
2392
2393 if (this.rangeSelector_) {
2394 this.rangeSelector_.renderInteractiveLayer();
2395 }
2396
2397 if (this.attr_("drawCallback") !== null) {
2398 this.attr_("drawCallback")(this, is_initial_draw);
2399 }
2400 };
2401
2402 /**
2403 * @private
2404 * Determine properties of the y-axes which are independent of the data
2405 * currently being displayed. This includes things like the number of axes and
2406 * the style of the axes. It does not include the range of each axis and its
2407 * tick marks.
2408 * This fills in this.axes_ and this.seriesToAxisMap_.
2409 * axes_ = [ { options } ]
2410 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2411 * indices are into the axes_ array.
2412 */
2413 Dygraph.prototype.computeYAxes_ = function() {
2414 // Preserve valueWindow settings if they exist, and if the user hasn't
2415 // specified a new valueRange.
2416 var i, valueWindows, seriesName, axis, index, opts, v;
2417 if (this.axes_ !== undefined && this.user_attrs_.hasOwnProperty("valueRange") === false) {
2418 valueWindows = [];
2419 for (index = 0; index < this.axes_.length; index++) {
2420 valueWindows.push(this.axes_[index].valueWindow);
2421 }
2422 }
2423
2424 this.axes_ = [{ yAxisId : 0, g : this }]; // always have at least one y-axis.
2425 this.seriesToAxisMap_ = {};
2426
2427 // Get a list of series names.
2428 var labels = this.attr_("labels");
2429 var series = {};
2430 for (i = 1; i < labels.length; i++) series[labels[i]] = (i - 1);
2431
2432 // all options which could be applied per-axis:
2433 var axisOptions = [
2434 'includeZero',
2435 'valueRange',
2436 'labelsKMB',
2437 'labelsKMG2',
2438 'pixelsPerYLabel',
2439 'yAxisLabelWidth',
2440 'axisLabelFontSize',
2441 'axisTickSize',
2442 'logscale'
2443 ];
2444
2445 // Copy global axis options over to the first axis.
2446 for (i = 0; i < axisOptions.length; i++) {
2447 var k = axisOptions[i];
2448 v = this.attr_(k);
2449 if (v) this.axes_[0][k] = v;
2450 }
2451
2452 // Go through once and add all the axes.
2453 for (seriesName in series) {
2454 if (!series.hasOwnProperty(seriesName)) continue;
2455 axis = this.attr_("axis", seriesName);
2456 if (axis === null) {
2457 this.seriesToAxisMap_[seriesName] = 0;
2458 continue;
2459 }
2460 if (typeof(axis) == 'object') {
2461 // Add a new axis, making a copy of its per-axis options.
2462 opts = {};
2463 Dygraph.update(opts, this.axes_[0]);
2464 Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this.
2465 var yAxisId = this.axes_.length;
2466 opts.yAxisId = yAxisId;
2467 opts.g = this;
2468 Dygraph.update(opts, axis);
2469 this.axes_.push(opts);
2470 this.seriesToAxisMap_[seriesName] = yAxisId;
2471 }
2472 }
2473
2474 // Go through one more time and assign series to an axis defined by another
2475 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2476 for (seriesName in series) {
2477 if (!series.hasOwnProperty(seriesName)) continue;
2478 axis = this.attr_("axis", seriesName);
2479 if (typeof(axis) == 'string') {
2480 if (!this.seriesToAxisMap_.hasOwnProperty(axis)) {
2481 this.error("Series " + seriesName + " wants to share a y-axis with " +
2482 "series " + axis + ", which does not define its own axis.");
2483 return null;
2484 }
2485 var idx = this.seriesToAxisMap_[axis];
2486 this.seriesToAxisMap_[seriesName] = idx;
2487 }
2488 }
2489
2490 if (valueWindows !== undefined) {
2491 // Restore valueWindow settings.
2492 for (index = 0; index < valueWindows.length; index++) {
2493 this.axes_[index].valueWindow = valueWindows[index];
2494 }
2495 }
2496
2497 // New axes options
2498 for (axis = 0; axis < this.axes_.length; axis++) {
2499 if (axis === 0) {
2500 opts = this.optionsViewForAxis_('y' + (axis ? '2' : ''));
2501 v = opts("valueRange");
2502 if (v) this.axes_[axis].valueRange = v;
2503 } else { // To keep old behavior
2504 var axes = this.user_attrs_.axes;
2505 if (axes && axes.y2) {
2506 v = axes.y2.valueRange;
2507 if (v) this.axes_[axis].valueRange = v;
2508 }
2509 }
2510 }
2511
2512 };
2513
2514 /**
2515 * Returns the number of y-axes on the chart.
2516 * @return {Number} the number of axes.
2517 */
2518 Dygraph.prototype.numAxes = function() {
2519 var last_axis = 0;
2520 for (var series in this.seriesToAxisMap_) {
2521 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2522 var idx = this.seriesToAxisMap_[series];
2523 if (idx > last_axis) last_axis = idx;
2524 }
2525 return 1 + last_axis;
2526 };
2527
2528 /**
2529 * @private
2530 * Returns axis properties for the given series.
2531 * @param { String } setName The name of the series for which to get axis
2532 * properties, e.g. 'Y1'.
2533 * @return { Object } The axis properties.
2534 */
2535 Dygraph.prototype.axisPropertiesForSeries = function(series) {
2536 // TODO(danvk): handle errors.
2537 return this.axes_[this.seriesToAxisMap_[series]];
2538 };
2539
2540 /**
2541 * @private
2542 * Determine the value range and tick marks for each axis.
2543 * @param {Object} extremes A mapping from seriesName -> [low, high]
2544 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2545 */
2546 Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2547 // Build a map from axis number -> [list of series names]
2548 var seriesForAxis = [], series;
2549 for (series in this.seriesToAxisMap_) {
2550 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2551 var idx = this.seriesToAxisMap_[series];
2552 while (seriesForAxis.length <= idx) seriesForAxis.push([]);
2553 seriesForAxis[idx].push(series);
2554 }
2555
2556 // Compute extreme values, a span and tick marks for each axis.
2557 for (var i = 0; i < this.axes_.length; i++) {
2558 var axis = this.axes_[i];
2559
2560 if (!seriesForAxis[i]) {
2561 // If no series are defined or visible then use a reasonable default
2562 axis.extremeRange = [0, 1];
2563 } else {
2564 // Calculate the extremes of extremes.
2565 series = seriesForAxis[i];
2566 var minY = Infinity; // extremes[series[0]][0];
2567 var maxY = -Infinity; // extremes[series[0]][1];
2568 var extremeMinY, extremeMaxY;
2569
2570 for (var j = 0; j < series.length; j++) {
2571 // this skips invisible series
2572 if (!extremes.hasOwnProperty(series[j])) continue;
2573
2574 // Only use valid extremes to stop null data series' from corrupting the scale.
2575 extremeMinY = extremes[series[j]][0];
2576 if (extremeMinY !== null) {
2577 minY = Math.min(extremeMinY, minY);
2578 }
2579 extremeMaxY = extremes[series[j]][1];
2580 if (extremeMaxY !== null) {
2581 maxY = Math.max(extremeMaxY, maxY);
2582 }
2583 }
2584 if (axis.includeZero && minY > 0) minY = 0;
2585
2586 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2587 if (minY == Infinity) minY = 0;
2588 if (maxY == -Infinity) maxY = 1;
2589
2590 // Add some padding and round up to an integer to be human-friendly.
2591 var span = maxY - minY;
2592 // special case: if we have no sense of scale, use +/-10% of the sole value.
2593 if (span === 0) { span = maxY; }
2594
2595 var maxAxisY, minAxisY;
2596 if (axis.logscale) {
2597 maxAxisY = maxY + 0.1 * span;
2598 minAxisY = minY;
2599 } else {
2600 maxAxisY = maxY + 0.1 * span;
2601 minAxisY = minY - 0.1 * span;
2602
2603 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2604 if (!this.attr_("avoidMinZero")) {
2605 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2606 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
2607 }
2608
2609 if (this.attr_("includeZero")) {
2610 if (maxY < 0) maxAxisY = 0;
2611 if (minY > 0) minAxisY = 0;
2612 }
2613 }
2614 axis.extremeRange = [minAxisY, maxAxisY];
2615 }
2616 if (axis.valueWindow) {
2617 // This is only set if the user has zoomed on the y-axis. It is never set
2618 // by a user. It takes precedence over axis.valueRange because, if you set
2619 // valueRange, you'd still expect to be able to pan.
2620 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
2621 } else if (axis.valueRange) {
2622 // This is a user-set value range for this axis.
2623 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
2624 } else {
2625 axis.computedValueRange = axis.extremeRange;
2626 }
2627
2628 // Add ticks. By default, all axes inherit the tick positions of the
2629 // primary axis. However, if an axis is specifically marked as having
2630 // independent ticks, then that is permissible as well.
2631 var opts = this.optionsViewForAxis_('y' + (i ? '2' : ''));
2632 var ticker = opts('ticker');
2633 if (i === 0 || axis.independentTicks) {
2634 axis.ticks = ticker(axis.computedValueRange[0],
2635 axis.computedValueRange[1],
2636 this.height_, // TODO(danvk): should be area.height
2637 opts,
2638 this);
2639 } else {
2640 var p_axis = this.axes_[0];
2641 var p_ticks = p_axis.ticks;
2642 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
2643 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
2644 var tick_values = [];
2645 for (var k = 0; k < p_ticks.length; k++) {
2646 var y_frac = (p_ticks[k].v - p_axis.computedValueRange[0]) / p_scale;
2647 var y_val = axis.computedValueRange[0] + y_frac * scale;
2648 tick_values.push(y_val);
2649 }
2650
2651 axis.ticks = ticker(axis.computedValueRange[0],
2652 axis.computedValueRange[1],
2653 this.height_, // TODO(danvk): should be area.height
2654 opts,
2655 this,
2656 tick_values);
2657 }
2658 }
2659 };
2660
2661 /**
2662 * Extracts one series from the raw data (a 2D array) into an array of (date,
2663 * value) tuples.
2664 *
2665 * This is where undesirable points (i.e. negative values on log scales and
2666 * missing values through which we wish to connect lines) are dropped.
2667 *
2668 * @private
2669 */
2670 Dygraph.prototype.extractSeries_ = function(rawData, i, logScale, connectSeparatedPoints) {
2671 var series = [];
2672 for (var j = 0; j < rawData.length; j++) {
2673 var x = rawData[j][0];
2674 var point = rawData[j][i];
2675 if (logScale) {
2676 // On the log scale, points less than zero do not exist.
2677 // This will create a gap in the chart. Note that this ignores
2678 // connectSeparatedPoints.
2679 if (point <= 0) {
2680 point = null;
2681 }
2682 series.push([x, point]);
2683 } else {
2684 if (point !== null || !connectSeparatedPoints) {
2685 series.push([x, point]);
2686 }
2687 }
2688 }
2689 return series;
2690 };
2691
2692 /**
2693 * @private
2694 * Calculates the rolling average of a data set.
2695 * If originalData is [label, val], rolls the average of those.
2696 * If originalData is [label, [, it's interpreted as [value, stddev]
2697 * and the roll is returned in the same form, with appropriately reduced
2698 * stddev for each value.
2699 * Note that this is where fractional input (i.e. '5/10') is converted into
2700 * decimal values.
2701 * @param {Array} originalData The data in the appropriate format (see above)
2702 * @param {Number} rollPeriod The number of points over which to average the
2703 * data
2704 */
2705 Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
2706 if (originalData.length < 2)
2707 return originalData;
2708 rollPeriod = Math.min(rollPeriod, originalData.length);
2709 var rollingData = [];
2710 var sigma = this.attr_("sigma");
2711
2712 var low, high, i, j, y, sum, num_ok, stddev;
2713 if (this.fractions_) {
2714 var num = 0;
2715 var den = 0; // numerator/denominator
2716 var mult = 100.0;
2717 for (i = 0; i < originalData.length; i++) {
2718 num += originalData[i][1][0];
2719 den += originalData[i][1][1];
2720 if (i - rollPeriod >= 0) {
2721 num -= originalData[i - rollPeriod][1][0];
2722 den -= originalData[i - rollPeriod][1][1];
2723 }
2724
2725 var date = originalData[i][0];
2726 var value = den ? num / den : 0.0;
2727 if (this.attr_("errorBars")) {
2728 if (this.attr_("wilsonInterval")) {
2729 // For more details on this confidence interval, see:
2730 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
2731 if (den) {
2732 var p = value < 0 ? 0 : value, n = den;
2733 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
2734 var denom = 1 + sigma * sigma / den;
2735 low = (p + sigma * sigma / (2 * den) - pm) / denom;
2736 high = (p + sigma * sigma / (2 * den) + pm) / denom;
2737 rollingData[i] = [date,
2738 [p * mult, (p - low) * mult, (high - p) * mult]];
2739 } else {
2740 rollingData[i] = [date, [0, 0, 0]];
2741 }
2742 } else {
2743 stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
2744 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
2745 }
2746 } else {
2747 rollingData[i] = [date, mult * value];
2748 }
2749 }
2750 } else if (this.attr_("customBars")) {
2751 low = 0;
2752 var mid = 0;
2753 high = 0;
2754 var count = 0;
2755 for (i = 0; i < originalData.length; i++) {
2756 var data = originalData[i][1];
2757 y = data[1];
2758 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
2759
2760 if (y !== null && !isNaN(y)) {
2761 low += data[0];
2762 mid += y;
2763 high += data[2];
2764 count += 1;
2765 }
2766 if (i - rollPeriod >= 0) {
2767 var prev = originalData[i - rollPeriod];
2768 if (prev[1][1] !== null && !isNaN(prev[1][1])) {
2769 low -= prev[1][0];
2770 mid -= prev[1][1];
2771 high -= prev[1][2];
2772 count -= 1;
2773 }
2774 }
2775 if (count) {
2776 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
2777 1.0 * (mid - low) / count,
2778 1.0 * (high - mid) / count ]];
2779 } else {
2780 rollingData[i] = [originalData[i][0], [null, null, null]];
2781 }
2782 }
2783 } else {
2784 // Calculate the rolling average for the first rollPeriod - 1 points where
2785 // there is not enough data to roll over the full number of points
2786 if (!this.attr_("errorBars")){
2787 if (rollPeriod == 1) {
2788 return originalData;
2789 }
2790
2791 for (i = 0; i < originalData.length; i++) {
2792 sum = 0;
2793 num_ok = 0;
2794 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2795 y = originalData[j][1];
2796 if (y === null || isNaN(y)) continue;
2797 num_ok++;
2798 sum += originalData[j][1];
2799 }
2800 if (num_ok) {
2801 rollingData[i] = [originalData[i][0], sum / num_ok];
2802 } else {
2803 rollingData[i] = [originalData[i][0], null];
2804 }
2805 }
2806
2807 } else {
2808 for (i = 0; i < originalData.length; i++) {
2809 sum = 0;
2810 var variance = 0;
2811 num_ok = 0;
2812 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2813 y = originalData[j][1][0];
2814 if (y === null || isNaN(y)) continue;
2815 num_ok++;
2816 sum += originalData[j][1][0];
2817 variance += Math.pow(originalData[j][1][1], 2);
2818 }
2819 if (num_ok) {
2820 stddev = Math.sqrt(variance) / num_ok;
2821 rollingData[i] = [originalData[i][0],
2822 [sum / num_ok, sigma * stddev, sigma * stddev]];
2823 } else {
2824 rollingData[i] = [originalData[i][0], [null, null, null]];
2825 }
2826 }
2827 }
2828 }
2829
2830 return rollingData;
2831 };
2832
2833 /**
2834 * Detects the type of the str (date or numeric) and sets the various
2835 * formatting attributes in this.attrs_ based on this type.
2836 * @param {String} str An x value.
2837 * @private
2838 */
2839 Dygraph.prototype.detectTypeFromString_ = function(str) {
2840 var isDate = false;
2841 var dashPos = str.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2842 if ((dashPos > 0 && (str[dashPos-1] != 'e' && str[dashPos-1] != 'E')) ||
2843 str.indexOf('/') >= 0 ||
2844 isNaN(parseFloat(str))) {
2845 isDate = true;
2846 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
2847 // TODO(danvk): remove support for this format.
2848 isDate = true;
2849 }
2850
2851 if (isDate) {
2852 this.attrs_.xValueParser = Dygraph.dateParser;
2853 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2854 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2855 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
2856 } else {
2857 /** @private (shut up, jsdoc!) */
2858 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2859 // TODO(danvk): use Dygraph.numberValueFormatter here?
2860 /** @private (shut up, jsdoc!) */
2861 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
2862 this.attrs_.axes.x.ticker = Dygraph.numericTicks;
2863 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
2864 }
2865 };
2866
2867 /**
2868 * Parses the value as a floating point number. This is like the parseFloat()
2869 * built-in, but with a few differences:
2870 * - the empty string is parsed as null, rather than NaN.
2871 * - if the string cannot be parsed at all, an error is logged.
2872 * If the string can't be parsed, this method returns null.
2873 * @param {String} x The string to be parsed
2874 * @param {Number} opt_line_no The line number from which the string comes.
2875 * @param {String} opt_line The text of the line from which the string comes.
2876 * @private
2877 */
2878
2879 // Parse the x as a float or return null if it's not a number.
2880 Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) {
2881 var val = parseFloat(x);
2882 if (!isNaN(val)) return val;
2883
2884 // Try to figure out what happeend.
2885 // If the value is the empty string, parse it as null.
2886 if (/^ *$/.test(x)) return null;
2887
2888 // If it was actually "NaN", return it as NaN.
2889 if (/^ *nan *$/i.test(x)) return NaN;
2890
2891 // Looks like a parsing error.
2892 var msg = "Unable to parse '" + x + "' as a number";
2893 if (opt_line !== null && opt_line_no !== null) {
2894 msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV.";
2895 }
2896 this.error(msg);
2897
2898 return null;
2899 };
2900
2901 /**
2902 * @private
2903 * Parses a string in a special csv format. We expect a csv file where each
2904 * line is a date point, and the first field in each line is the date string.
2905 * We also expect that all remaining fields represent series.
2906 * if the errorBars attribute is set, then interpret the fields as:
2907 * date, series1, stddev1, series2, stddev2, ...
2908 * @param {[Object]} data See above.
2909 *
2910 * @return [Object] An array with one entry for each row. These entries
2911 * are an array of cells in that row. The first entry is the parsed x-value for
2912 * the row. The second, third, etc. are the y-values. These can take on one of
2913 * three forms, depending on the CSV and constructor parameters:
2914 * 1. numeric value
2915 * 2. [ value, stddev ]
2916 * 3. [ low value, center value, high value ]
2917 */
2918 Dygraph.prototype.parseCSV_ = function(data) {
2919 var ret = [];
2920 var lines = data.split("\n");
2921 var vals, j;
2922
2923 // Use the default delimiter or fall back to a tab if that makes sense.
2924 var delim = this.attr_('delimiter');
2925 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
2926 delim = '\t';
2927 }
2928
2929 var start = 0;
2930 if (!('labels' in this.user_attrs_)) {
2931 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2932 start = 1;
2933 this.attrs_.labels = lines[0].split(delim); // NOTE: _not_ user_attrs_.
2934 }
2935 var line_no = 0;
2936
2937 var xParser;
2938 var defaultParserSet = false; // attempt to auto-detect x value type
2939 var expectedCols = this.attr_("labels").length;
2940 var outOfOrder = false;
2941 for (var i = start; i < lines.length; i++) {
2942 var line = lines[i];
2943 line_no = i;
2944 if (line.length === 0) continue; // skip blank lines
2945 if (line[0] == '#') continue; // skip comment lines
2946 var inFields = line.split(delim);
2947 if (inFields.length < 2) continue;
2948
2949 var fields = [];
2950 if (!defaultParserSet) {
2951 this.detectTypeFromString_(inFields[0]);
2952 xParser = this.attr_("xValueParser");
2953 defaultParserSet = true;
2954 }
2955 fields[0] = xParser(inFields[0], this);
2956
2957 // If fractions are expected, parse the numbers as "A/B"
2958 if (this.fractions_) {
2959 for (j = 1; j < inFields.length; j++) {
2960 // TODO(danvk): figure out an appropriate way to flag parse errors.
2961 vals = inFields[j].split("/");
2962 if (vals.length != 2) {
2963 this.error('Expected fractional "num/den" values in CSV data ' +
2964 "but found a value '" + inFields[j] + "' on line " +
2965 (1 + i) + " ('" + line + "') which is not of this form.");
2966 fields[j] = [0, 0];
2967 } else {
2968 fields[j] = [this.parseFloat_(vals[0], i, line),
2969 this.parseFloat_(vals[1], i, line)];
2970 }
2971 }
2972 } else if (this.attr_("errorBars")) {
2973 // If there are error bars, values are (value, stddev) pairs
2974 if (inFields.length % 2 != 1) {
2975 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2976 'but line ' + (1 + i) + ' has an odd number of values (' +
2977 (inFields.length - 1) + "): '" + line + "'");
2978 }
2979 for (j = 1; j < inFields.length; j += 2) {
2980 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2981 this.parseFloat_(inFields[j + 1], i, line)];
2982 }
2983 } else if (this.attr_("customBars")) {
2984 // Bars are a low;center;high tuple
2985 for (j = 1; j < inFields.length; j++) {
2986 var val = inFields[j];
2987 if (/^ *$/.test(val)) {
2988 fields[j] = [null, null, null];
2989 } else {
2990 vals = val.split(";");
2991 if (vals.length == 3) {
2992 fields[j] = [ this.parseFloat_(vals[0], i, line),
2993 this.parseFloat_(vals[1], i, line),
2994 this.parseFloat_(vals[2], i, line) ];
2995 } else {
2996 this.warn('When using customBars, values must be either blank ' +
2997 'or "low;center;high" tuples (got "' + val +
2998 '" on line ' + (1+i));
2999 }
3000 }
3001 }
3002 } else {
3003 // Values are just numbers
3004 for (j = 1; j < inFields.length; j++) {
3005 fields[j] = this.parseFloat_(inFields[j], i, line);
3006 }
3007 }
3008 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3009 outOfOrder = true;
3010 }
3011
3012 if (fields.length != expectedCols) {
3013 this.error("Number of columns in line " + i + " (" + fields.length +
3014 ") does not agree with number of labels (" + expectedCols +
3015 ") " + line);
3016 }
3017
3018 // If the user specified the 'labels' option and none of the cells of the
3019 // first row parsed correctly, then they probably double-specified the
3020 // labels. We go with the values set in the option, discard this row and
3021 // log a warning to the JS console.
3022 if (i === 0 && this.attr_('labels')) {
3023 var all_null = true;
3024 for (j = 0; all_null && j < fields.length; j++) {
3025 if (fields[j]) all_null = false;
3026 }
3027 if (all_null) {
3028 this.warn("The dygraphs 'labels' option is set, but the first row of " +
3029 "CSV data ('" + line + "') appears to also contain labels. " +
3030 "Will drop the CSV labels and use the option labels.");
3031 continue;
3032 }
3033 }
3034 ret.push(fields);
3035 }
3036
3037 if (outOfOrder) {
3038 this.warn("CSV is out of order; order it correctly to speed loading.");
3039 ret.sort(function(a,b) { return a[0] - b[0]; });
3040 }
3041
3042 return ret;
3043 };
3044
3045 /**
3046 * @private
3047 * The user has provided their data as a pre-packaged JS array. If the x values
3048 * are numeric, this is the same as dygraphs' internal format. If the x values
3049 * are dates, we need to convert them from Date objects to ms since epoch.
3050 * @param {[Object]} data
3051 * @return {[Object]} data with numeric x values.
3052 */
3053 Dygraph.prototype.parseArray_ = function(data) {
3054 // Peek at the first x value to see if it's numeric.
3055 if (data.length === 0) {
3056 this.error("Can't plot empty data set");
3057 return null;
3058 }
3059 if (data[0].length === 0) {
3060 this.error("Data set cannot contain an empty row");
3061 return null;
3062 }
3063
3064 var i;
3065 if (this.attr_("labels") === null) {
3066 this.warn("Using default labels. Set labels explicitly via 'labels' " +
3067 "in the options parameter");
3068 this.attrs_.labels = [ "X" ];
3069 for (i = 1; i < data[0].length; i++) {
3070 this.attrs_.labels.push("Y" + i);
3071 }
3072 }
3073
3074 if (Dygraph.isDateLike(data[0][0])) {
3075 // Some intelligent defaults for a date x-axis.
3076 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3077 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3078 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3079
3080 // Assume they're all dates.
3081 var parsedData = Dygraph.clone(data);
3082 for (i = 0; i < data.length; i++) {
3083 if (parsedData[i].length === 0) {
3084 this.error("Row " + (1 + i) + " of data is empty");
3085 return null;
3086 }
3087 if (parsedData[i][0] === null ||
3088 typeof(parsedData[i][0].getTime) != 'function' ||
3089 isNaN(parsedData[i][0].getTime())) {
3090 this.error("x value in row " + (1 + i) + " is not a Date");
3091 return null;
3092 }
3093 parsedData[i][0] = parsedData[i][0].getTime();
3094 }
3095 return parsedData;
3096 } else {
3097 // Some intelligent defaults for a numeric x-axis.
3098 /** @private (shut up, jsdoc!) */
3099 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
3100 this.attrs_.axes.x.axisLabelFormatter = Dygraph.numberAxisLabelFormatter;
3101 this.attrs_.axes.x.ticker = Dygraph.numericTicks;
3102 return data;
3103 }
3104 };
3105
3106 /**
3107 * Parses a DataTable object from gviz.
3108 * The data is expected to have a first column that is either a date or a
3109 * number. All subsequent columns must be numbers. If there is a clear mismatch
3110 * between this.xValueParser_ and the type of the first column, it will be
3111 * fixed. Fills out rawData_.
3112 * @param {[Object]} data See above.
3113 * @private
3114 */
3115 Dygraph.prototype.parseDataTable_ = function(data) {
3116 var shortTextForAnnotationNum = function(num) {
3117 // converts [0-9]+ [A-Z][a-z]*
3118 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3119 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3120 var shortText = String.fromCharCode(65 /* A */ + num % 26);
3121 num = Math.floor(num / 26);
3122 while ( num > 0 ) {
3123 shortText = String.fromCharCode(65 /* A */ + (num - 1) % 26 ) + shortText.toLowerCase();
3124 num = Math.floor((num - 1) / 26);
3125 }
3126 return shortText;
3127 }
3128
3129 var cols = data.getNumberOfColumns();
3130 var rows = data.getNumberOfRows();
3131
3132 var indepType = data.getColumnType(0);
3133 if (indepType == 'date' || indepType == 'datetime') {
3134 this.attrs_.xValueParser = Dygraph.dateParser;
3135 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3136 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3137 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3138 } else if (indepType == 'number') {
3139 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
3140 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
3141 this.attrs_.axes.x.ticker = Dygraph.numericTicks;
3142 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
3143 } else {
3144 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3145 "column 1 of DataTable input (Got '" + indepType + "')");
3146 return null;
3147 }
3148
3149 // Array of the column indices which contain data (and not annotations).
3150 var colIdx = [];
3151 var annotationCols = {}; // data index -> [annotation cols]
3152 var hasAnnotations = false;
3153 var i, j;
3154 for (i = 1; i < cols; i++) {
3155 var type = data.getColumnType(i);
3156 if (type == 'number') {
3157 colIdx.push(i);
3158 } else if (type == 'string' && this.attr_('displayAnnotations')) {
3159 // This is OK -- it's an annotation column.
3160 var dataIdx = colIdx[colIdx.length - 1];
3161 if (!annotationCols.hasOwnProperty(dataIdx)) {
3162 annotationCols[dataIdx] = [i];
3163 } else {
3164 annotationCols[dataIdx].push(i);
3165 }
3166 hasAnnotations = true;
3167 } else {
3168 this.error("Only 'number' is supported as a dependent type with Gviz." +
3169 " 'string' is only supported if displayAnnotations is true");
3170 }
3171 }
3172
3173 // Read column labels
3174 // TODO(danvk): add support back for errorBars
3175 var labels = [data.getColumnLabel(0)];
3176 for (i = 0; i < colIdx.length; i++) {
3177 labels.push(data.getColumnLabel(colIdx[i]));
3178 if (this.attr_("errorBars")) i += 1;
3179 }
3180 this.attrs_.labels = labels;
3181 cols = labels.length;
3182
3183 var ret = [];
3184 var outOfOrder = false;
3185 var annotations = [];
3186 for (i = 0; i < rows; i++) {
3187 var row = [];
3188 if (typeof(data.getValue(i, 0)) === 'undefined' ||
3189 data.getValue(i, 0) === null) {
3190 this.warn("Ignoring row " + i +
3191 " of DataTable because of undefined or null first column.");
3192 continue;
3193 }
3194
3195 if (indepType == 'date' || indepType == 'datetime') {
3196 row.push(data.getValue(i, 0).getTime());
3197 } else {
3198 row.push(data.getValue(i, 0));
3199 }
3200 if (!this.attr_("errorBars")) {
3201 for (j = 0; j < colIdx.length; j++) {
3202 var col = colIdx[j];
3203 row.push(data.getValue(i, col));
3204 if (hasAnnotations &&
3205 annotationCols.hasOwnProperty(col) &&
3206 data.getValue(i, annotationCols[col][0]) !== null) {
3207 var ann = {};
3208 ann.series = data.getColumnLabel(col);
3209 ann.xval = row[0];
3210 ann.shortText = shortTextForAnnotationNum(annotations.length);
3211 ann.text = '';
3212 for (var k = 0; k < annotationCols[col].length; k++) {
3213 if (k) ann.text += "\n";
3214 ann.text += data.getValue(i, annotationCols[col][k]);
3215 }
3216 annotations.push(ann);
3217 }
3218 }
3219
3220 // Strip out infinities, which give dygraphs problems later on.
3221 for (j = 0; j < row.length; j++) {
3222 if (!isFinite(row[j])) row[j] = null;
3223 }
3224 } else {
3225 for (j = 0; j < cols - 1; j++) {
3226 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
3227 }
3228 }
3229 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
3230 outOfOrder = true;
3231 }
3232 ret.push(row);
3233 }
3234
3235 if (outOfOrder) {
3236 this.warn("DataTable is out of order; order it correctly to speed loading.");
3237 ret.sort(function(a,b) { return a[0] - b[0]; });
3238 }
3239 this.rawData_ = ret;
3240
3241 if (annotations.length > 0) {
3242 this.setAnnotations(annotations, true);
3243 }
3244 };
3245
3246 /**
3247 * Get the CSV data. If it's in a function, call that function. If it's in a
3248 * file, do an XMLHttpRequest to get it.
3249 * @private
3250 */
3251 Dygraph.prototype.start_ = function() {
3252 var data = this.file_;
3253
3254 // Functions can return references of all other types.
3255 if (typeof data == 'function') {
3256 data = data();
3257 }
3258
3259 if (Dygraph.isArrayLike(data)) {
3260 this.rawData_ = this.parseArray_(data);
3261 this.predraw_();
3262 } else if (typeof data == 'object' &&
3263 typeof data.getColumnRange == 'function') {
3264 // must be a DataTable from gviz.
3265 this.parseDataTable_(data);
3266 this.predraw_();
3267 } else if (typeof data == 'string') {
3268 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3269 if (data.indexOf('\n') >= 0) {
3270 this.loadedEvent_(data);
3271 } else {
3272 var req = new XMLHttpRequest();
3273 var caller = this;
3274 req.onreadystatechange = function () {
3275 if (req.readyState == 4) {
3276 if (req.status === 200 || // Normal http
3277 req.status === 0) { // Chrome w/ --allow-file-access-from-files
3278 caller.loadedEvent_(req.responseText);
3279 }
3280 }
3281 };
3282
3283 req.open("GET", data, true);
3284 req.send(null);
3285 }
3286 } else {
3287 this.error("Unknown data format: " + (typeof data));
3288 }
3289 };
3290
3291 /**
3292 * Changes various properties of the graph. These can include:
3293 * <ul>
3294 * <li>file: changes the source data for the graph</li>
3295 * <li>errorBars: changes whether the data contains stddev</li>
3296 * </ul>
3297 *
3298 * There's a huge variety of options that can be passed to this method. For a
3299 * full list, see http://dygraphs.com/options.html.
3300 *
3301 * @param {Object} attrs The new properties and values
3302 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3303 * call to updateOptions(). If you know better, you can pass true to explicitly
3304 * block the redraw. This can be useful for chaining updateOptions() calls,
3305 * avoiding the occasional infinite loop and preventing redraws when it's not
3306 * necessary (e.g. when updating a callback).
3307 */
3308 Dygraph.prototype.updateOptions = function(input_attrs, block_redraw) {
3309 if (typeof(block_redraw) == 'undefined') block_redraw = false;
3310
3311 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3312 var file = input_attrs.file;
3313 var attrs = Dygraph.mapLegacyOptions_(input_attrs);
3314
3315 // TODO(danvk): this is a mess. Move these options into attr_.
3316 if ('rollPeriod' in attrs) {
3317 this.rollPeriod_ = attrs.rollPeriod;
3318 }
3319 if ('dateWindow' in attrs) {
3320 this.dateWindow_ = attrs.dateWindow;
3321 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
3322 this.zoomed_x_ = (attrs.dateWindow !== null);
3323 }
3324 }
3325 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
3326 this.zoomed_y_ = (attrs.valueRange !== null);
3327 }
3328
3329 // TODO(danvk): validate per-series options.
3330 // Supported:
3331 // strokeWidth
3332 // pointSize
3333 // drawPoints
3334 // highlightCircleSize
3335
3336 // Check if this set options will require new points.
3337 var requiresNewPoints = Dygraph.isPixelChangingOptionList(this.attr_("labels"), attrs);
3338
3339 Dygraph.updateDeep(this.user_attrs_, attrs);
3340
3341 if (file) {
3342 this.file_ = file;
3343 if (!block_redraw) this.start_();
3344 } else {
3345 if (!block_redraw) {
3346 if (requiresNewPoints) {
3347 this.predraw_();
3348 } else {
3349 this.renderGraph_(false, false);
3350 }
3351 }
3352 }
3353 };
3354
3355 /**
3356 * Returns a copy of the options with deprecated names converted into current
3357 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3358 * interested in that, they should save a copy before calling this.
3359 * @private
3360 */
3361 Dygraph.mapLegacyOptions_ = function(attrs) {
3362 var my_attrs = {};
3363 for (var k in attrs) {
3364 if (k == 'file') continue;
3365 if (attrs.hasOwnProperty(k)) my_attrs[k] = attrs[k];
3366 }
3367
3368 var set = function(axis, opt, value) {
3369 if (!my_attrs.axes) my_attrs.axes = {};
3370 if (!my_attrs.axes[axis]) my_attrs.axes[axis] = {};
3371 my_attrs.axes[axis][opt] = value;
3372 };
3373 var map = function(opt, axis, new_opt) {
3374 if (typeof(attrs[opt]) != 'undefined') {
3375 set(axis, new_opt, attrs[opt]);
3376 delete my_attrs[opt];
3377 }
3378 };
3379
3380 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3381 map('xValueFormatter', 'x', 'valueFormatter');
3382 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3383 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3384 map('xTicker', 'x', 'ticker');
3385 map('yValueFormatter', 'y', 'valueFormatter');
3386 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3387 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3388 map('yTicker', 'y', 'ticker');
3389 return my_attrs;
3390 };
3391
3392 /**
3393 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3394 * containing div (which has presumably changed size since the dygraph was
3395 * instantiated. If the width/height are specified, the div will be resized.
3396 *
3397 * This is far more efficient than destroying and re-instantiating a
3398 * Dygraph, since it doesn't have to reparse the underlying data.
3399 *
3400 * @param {Number} [width] Width (in pixels)
3401 * @param {Number} [height] Height (in pixels)
3402 */
3403 Dygraph.prototype.resize = function(width, height) {
3404 if (this.resize_lock) {
3405 return;
3406 }
3407 this.resize_lock = true;
3408
3409 if ((width === null) != (height === null)) {
3410 this.warn("Dygraph.resize() should be called with zero parameters or " +
3411 "two non-NULL parameters. Pretending it was zero.");
3412 width = height = null;
3413 }
3414
3415 var old_width = this.width_;
3416 var old_height = this.height_;
3417
3418 if (width) {
3419 this.maindiv_.style.width = width + "px";
3420 this.maindiv_.style.height = height + "px";
3421 this.width_ = width;
3422 this.height_ = height;
3423 } else {
3424 this.width_ = this.maindiv_.clientWidth;
3425 this.height_ = this.maindiv_.clientHeight;
3426 }
3427
3428 if (old_width != this.width_ || old_height != this.height_) {
3429 // TODO(danvk): there should be a clear() method.
3430 this.maindiv_.innerHTML = "";
3431 this.roller_ = null;
3432 this.attrs_.labelsDiv = null;
3433 this.createInterface_();
3434 if (this.annotations_.length) {
3435 // createInterface_ reset the layout, so we need to do this.
3436 this.layout_.setAnnotations(this.annotations_);
3437 }
3438 this.predraw_();
3439 }
3440
3441 this.resize_lock = false;
3442 };
3443
3444 /**
3445 * Adjusts the number of points in the rolling average. Updates the graph to
3446 * reflect the new averaging period.
3447 * @param {Number} length Number of points over which to average the data.
3448 */
3449 Dygraph.prototype.adjustRoll = function(length) {
3450 this.rollPeriod_ = length;
3451 this.predraw_();
3452 };
3453
3454 /**
3455 * Returns a boolean array of visibility statuses.
3456 */
3457 Dygraph.prototype.visibility = function() {
3458 // Do lazy-initialization, so that this happens after we know the number of
3459 // data series.
3460 if (!this.attr_("visibility")) {
3461 this.attrs_.visibility = [];
3462 }
3463 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs.
3464 while (this.attr_("visibility").length < this.numColumns() - 1) {
3465 this.attrs_.visibility.push(true);
3466 }
3467 return this.attr_("visibility");
3468 };
3469
3470 /**
3471 * Changes the visiblity of a series.
3472 */
3473 Dygraph.prototype.setVisibility = function(num, value) {
3474 var x = this.visibility();
3475 if (num < 0 || num >= x.length) {
3476 this.warn("invalid series number in setVisibility: " + num);
3477 } else {
3478 x[num] = value;
3479 this.predraw_();
3480 }
3481 };
3482
3483 /**
3484 * How large of an area will the dygraph render itself in?
3485 * This is used for testing.
3486 * @return A {width: w, height: h} object.
3487 * @private
3488 */
3489 Dygraph.prototype.size = function() {
3490 return { width: this.width_, height: this.height_ };
3491 };
3492
3493 /**
3494 * Update the list of annotations and redraw the chart.
3495 * See dygraphs.com/annotations.html for more info on how to use annotations.
3496 * @param ann {Array} An array of annotation objects.
3497 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3498 */
3499 Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3500 // Only add the annotation CSS rule once we know it will be used.
3501 Dygraph.addAnnotationRule();
3502 this.annotations_ = ann;
3503 this.layout_.setAnnotations(this.annotations_);
3504 if (!suppressDraw) {
3505 this.predraw_();
3506 }
3507 };
3508
3509 /**
3510 * Return the list of annotations.
3511 */
3512 Dygraph.prototype.annotations = function() {
3513 return this.annotations_;
3514 };
3515
3516 /**
3517 * Get the list of label names for this graph. The first column is the
3518 * x-axis, so the data series names start at index 1.
3519 */
3520 Dygraph.prototype.getLabels = function(name) {
3521 return this.attr_("labels").slice();
3522 };
3523
3524 /**
3525 * Get the index of a series (column) given its name. The first column is the
3526 * x-axis, so the data series start with index 1.
3527 */
3528 Dygraph.prototype.indexFromSetName = function(name) {
3529 return this.setIndexByName_[name];
3530 };
3531
3532 /**
3533 * Get the internal dataset index given its name. These are numbered starting from 0,
3534 * and only count visible sets.
3535 * @private
3536 */
3537 Dygraph.prototype.datasetIndexFromSetName_ = function(name) {
3538 return this.datasetIndex_[this.indexFromSetName(name)];
3539 };
3540
3541 /**
3542 * @private
3543 * Adds a default style for the annotation CSS classes to the document. This is
3544 * only executed when annotations are actually used. It is designed to only be
3545 * called once -- all calls after the first will return immediately.
3546 */
3547 Dygraph.addAnnotationRule = function() {
3548 if (Dygraph.addedAnnotationCSS) return;
3549
3550 var rule = "border: 1px solid black; " +
3551 "background-color: white; " +
3552 "text-align: center;";
3553
3554 var styleSheetElement = document.createElement("style");
3555 styleSheetElement.type = "text/css";
3556 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3557
3558 // Find the first style sheet that we can access.
3559 // We may not add a rule to a style sheet from another domain for security
3560 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3561 // adds its own style sheets from google.com.
3562 for (var i = 0; i < document.styleSheets.length; i++) {
3563 if (document.styleSheets[i].disabled) continue;
3564 var mysheet = document.styleSheets[i];
3565 try {
3566 if (mysheet.insertRule) { // Firefox
3567 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3568 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3569 } else if (mysheet.addRule) { // IE
3570 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3571 }
3572 Dygraph.addedAnnotationCSS = true;
3573 return;
3574 } catch(err) {
3575 // Was likely a security exception.
3576 }
3577 }
3578
3579 this.warn("Unable to add default annotation CSS rule; display may be off.");
3580 };
3581
3582 // Older pages may still use this name.
3583 var DateGraph = Dygraph;