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