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