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