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