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