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