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