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