Merge pull request #121 from wimme/patch-1
[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 ctx.beginPath();
1765 ctx.fillStyle = this.plotter_.colors[pt.name];
1766 ctx.arc(canvasx, pt.canvasy, circleSize, 0, 2 * Math.PI, false);
1767 ctx.fill();
1768 }
1769 ctx.restore();
1770
1771 this.previousVerticalX_ = canvasx;
1772 }
1773};
1774
1775/**
1776 * Manually set the selected points and display information about them in the
1777 * legend. The selection can be cleared using clearSelection() and queried
1778 * using getSelection().
1779 * @param { Integer } row number that should be highlighted (i.e. appear with
1780 * hover dots on the chart). Set to false to clear any selection.
1781 */
1782Dygraph.prototype.setSelection = function(row) {
1783 // Extract the points we've selected
1784 this.selPoints_ = [];
1785 var pos = 0;
1786
1787 if (row !== false) {
1788 row = row - this.boundaryIds_[0][0];
1789 }
1790
1791 if (row !== false && row >= 0) {
1792 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1793 var set = this.layout_.datasets[setIdx];
1794 if (row < set.length) {
1795 var point = this.layout_.points[pos+row];
1796
1797 if (this.attr_("stackedGraph")) {
1798 point = this.layout_.unstackPointAtIndex(pos+row);
1799 }
1800
1801 this.selPoints_.push(point);
1802 }
1803 pos += set.length;
1804 }
1805 }
1806
1807 if (this.selPoints_.length) {
1808 this.lastx_ = this.selPoints_[0].xval;
1809 this.updateSelection_();
1810 } else {
1811 this.clearSelection();
1812 }
1813
1814};
1815
1816/**
1817 * The mouse has left the canvas. Clear out whatever artifacts remain
1818 * @param {Object} event the mouseout event from the browser.
1819 * @private
1820 */
1821Dygraph.prototype.mouseOut_ = function(event) {
1822 if (this.attr_("unhighlightCallback")) {
1823 this.attr_("unhighlightCallback")(event);
1824 }
1825
1826 if (this.attr_("hideOverlayOnMouseOut")) {
1827 this.clearSelection();
1828 }
1829};
1830
1831/**
1832 * Clears the current selection (i.e. points that were highlighted by moving
1833 * the mouse over the chart).
1834 */
1835Dygraph.prototype.clearSelection = function() {
1836 // Get rid of the overlay data
1837 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
1838 this.setLegendHTML_();
1839 this.selPoints_ = [];
1840 this.lastx_ = -1;
1841};
1842
1843/**
1844 * Returns the number of the currently selected row. To get data for this row,
1845 * you can use the getValue method.
1846 * @return { Integer } row number, or -1 if nothing is selected
1847 */
1848Dygraph.prototype.getSelection = function() {
1849 if (!this.selPoints_ || this.selPoints_.length < 1) {
1850 return -1;
1851 }
1852
1853 for (var row=0; row<this.layout_.points.length; row++ ) {
1854 if (this.layout_.points[row].x == this.selPoints_[0].x) {
1855 return row + this.boundaryIds_[0][0];
1856 }
1857 }
1858 return -1;
1859};
1860
1861/**
1862 * Fires when there's data available to be graphed.
1863 * @param {String} data Raw CSV data to be plotted
1864 * @private
1865 */
1866Dygraph.prototype.loadedEvent_ = function(data) {
1867 this.rawData_ = this.parseCSV_(data);
1868 this.predraw_();
1869};
1870
1871/**
1872 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1873 * @private
1874 */
1875Dygraph.prototype.addXTicks_ = function() {
1876 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1877 var range;
1878 if (this.dateWindow_) {
1879 range = [this.dateWindow_[0], this.dateWindow_[1]];
1880 } else {
1881 range = this.fullXRange_();
1882 }
1883
1884 var xAxisOptionsView = this.optionsViewForAxis_('x');
1885 var xTicks = xAxisOptionsView('ticker')(
1886 range[0],
1887 range[1],
1888 this.width_, // TODO(danvk): should be area.width
1889 xAxisOptionsView,
1890 this);
1891 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
1892 // console.log(msg);
1893 this.layout_.setXTicks(xTicks);
1894};
1895
1896/**
1897 * @private
1898 * Computes the range of the data series (including confidence intervals).
1899 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
1900 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
1901 * @return [low, high]
1902 */
1903Dygraph.prototype.extremeValues_ = function(series) {
1904 var minY = null, maxY = null, j, y;
1905
1906 var bars = this.attr_("errorBars") || this.attr_("customBars");
1907 if (bars) {
1908 // With custom bars, maxY is the max of the high values.
1909 for (j = 0; j < series.length; j++) {
1910 y = series[j][1][0];
1911 if (!y) continue;
1912 var low = y - series[j][1][1];
1913 var high = y + series[j][1][2];
1914 if (low > y) low = y; // this can happen with custom bars,
1915 if (high < y) high = y; // e.g. in tests/custom-bars.html
1916 if (maxY === null || high > maxY) {
1917 maxY = high;
1918 }
1919 if (minY === null || low < minY) {
1920 minY = low;
1921 }
1922 }
1923 } else {
1924 for (j = 0; j < series.length; j++) {
1925 y = series[j][1];
1926 if (y === null || isNaN(y)) continue;
1927 if (maxY === null || y > maxY) {
1928 maxY = y;
1929 }
1930 if (minY === null || y < minY) {
1931 minY = y;
1932 }
1933 }
1934 }
1935
1936 return [minY, maxY];
1937};
1938
1939/**
1940 * @private
1941 * This function is called once when the chart's data is changed or the options
1942 * dictionary is updated. It is _not_ called when the user pans or zooms. The
1943 * idea is that values derived from the chart's data can be computed here,
1944 * rather than every time the chart is drawn. This includes things like the
1945 * number of axes, rolling averages, etc.
1946 */
1947Dygraph.prototype.predraw_ = function() {
1948 var start = new Date();
1949
1950 // TODO(danvk): move more computations out of drawGraph_ and into here.
1951 this.computeYAxes_();
1952
1953 // Create a new plotter.
1954 if (this.plotter_) this.plotter_.clear();
1955 this.plotter_ = new DygraphCanvasRenderer(this,
1956 this.hidden_,
1957 this.hidden_ctx_,
1958 this.layout_);
1959
1960 // The roller sits in the bottom left corner of the chart. We don't know where
1961 // this will be until the options are available, so it's positioned here.
1962 this.createRollInterface_();
1963
1964 // Same thing applies for the labelsDiv. It's right edge should be flush with
1965 // the right edge of the charting area (which may not be the same as the right
1966 // edge of the div, if we have two y-axes.
1967 this.positionLabelsDiv_();
1968
1969 if (this.rangeSelector_) {
1970 this.rangeSelector_.renderStaticLayer();
1971 }
1972
1973 // Convert the raw data (a 2D array) into the internal format and compute
1974 // rolling averages.
1975 this.rolledSeries_ = [null]; // x-axis is the first series and it's special
1976 for (var i = 1; i < this.numColumns(); i++) {
1977 var connectSeparatedPoints = this.attr_('connectSeparatedPoints', i);
1978 var logScale = this.attr_('logscale', i);
1979 var series = this.extractSeries_(this.rawData_, i, logScale, connectSeparatedPoints);
1980 series = this.rollingAverage(series, this.rollPeriod_);
1981 this.rolledSeries_.push(series);
1982 }
1983
1984 // If the data or options have changed, then we'd better redraw.
1985 this.drawGraph_();
1986
1987 // This is used to determine whether to do various animations.
1988 var end = new Date();
1989 this.drawingTimeMs_ = (end - start);
1990};
1991
1992/**
1993 * Loop over all fields and create datasets, calculating extreme y-values for
1994 * each series and extreme x-indices as we go.
1995 *
1996 * dateWindow is passed in as an explicit parameter so that we can compute
1997 * extreme values "speculatively", i.e. without actually setting state on the
1998 * dygraph.
1999 *
2000 * TODO(danvk): make this more of a true function
2001 * @return [ datasets, seriesExtremes, boundaryIds ]
2002 * @private
2003 */
2004Dygraph.prototype.gatherDatasets_ = function(rolledSeries, dateWindow) {
2005 var boundaryIds = [];
2006 var cumulative_y = []; // For stacked series.
2007 var datasets = [];
2008 var extremes = {}; // series name -> [low, high]
2009 var i, j, k;
2010
2011 // Loop over the fields (series). Go from the last to the first,
2012 // because if they're stacked that's how we accumulate the values.
2013 var num_series = rolledSeries.length - 1;
2014 for (i = num_series; i >= 1; i--) {
2015 if (!this.visibility()[i - 1]) continue;
2016
2017 // TODO(danvk): is this copy really necessary?
2018 var series = [];
2019 for (j = 0; j < rolledSeries[i].length; j++) {
2020 series.push(rolledSeries[i][j]);
2021 }
2022
2023 // Prune down to the desired range, if necessary (for zooming)
2024 // Because there can be lines going to points outside of the visible area,
2025 // we actually prune to visible points, plus one on either side.
2026 var bars = this.attr_("errorBars") || this.attr_("customBars");
2027 if (dateWindow) {
2028 var low = dateWindow[0];
2029 var high = dateWindow[1];
2030 var pruned = [];
2031 // TODO(danvk): do binary search instead of linear search.
2032 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2033 var firstIdx = null, lastIdx = null;
2034 for (k = 0; k < series.length; k++) {
2035 if (series[k][0] >= low && firstIdx === null) {
2036 firstIdx = k;
2037 }
2038 if (series[k][0] <= high) {
2039 lastIdx = k;
2040 }
2041 }
2042 if (firstIdx === null) firstIdx = 0;
2043 if (firstIdx > 0) firstIdx--;
2044 if (lastIdx === null) lastIdx = series.length - 1;
2045 if (lastIdx < series.length - 1) lastIdx++;
2046 boundaryIds[i-1] = [firstIdx, lastIdx];
2047 for (k = firstIdx; k <= lastIdx; k++) {
2048 pruned.push(series[k]);
2049 }
2050 series = pruned;
2051 } else {
2052 boundaryIds[i-1] = [0, series.length-1];
2053 }
2054
2055 var seriesExtremes = this.extremeValues_(series);
2056
2057 if (bars) {
2058 for (j=0; j<series.length; j++) {
2059 series[j] = [series[j][0],
2060 series[j][1][0],
2061 series[j][1][1],
2062 series[j][1][2]];
2063 }
2064 } else if (this.attr_("stackedGraph")) {
2065 var l = series.length;
2066 var actual_y;
2067 for (j = 0; j < l; j++) {
2068 // If one data set has a NaN, let all subsequent stacked
2069 // sets inherit the NaN -- only start at 0 for the first set.
2070 var x = series[j][0];
2071 if (cumulative_y[x] === undefined) {
2072 cumulative_y[x] = 0;
2073 }
2074
2075 actual_y = series[j][1];
2076 cumulative_y[x] += actual_y;
2077
2078 series[j] = [x, cumulative_y[x]];
2079
2080 if (cumulative_y[x] > seriesExtremes[1]) {
2081 seriesExtremes[1] = cumulative_y[x];
2082 }
2083 if (cumulative_y[x] < seriesExtremes[0]) {
2084 seriesExtremes[0] = cumulative_y[x];
2085 }
2086 }
2087 }
2088
2089 var seriesName = this.attr_("labels")[i];
2090 extremes[seriesName] = seriesExtremes;
2091 datasets[i] = series;
2092 }
2093
2094 return [ datasets, extremes, boundaryIds ];
2095};
2096
2097/**
2098 * Update the graph with new data. This method is called when the viewing area
2099 * has changed. If the underlying data or options have changed, predraw_ will
2100 * be called before drawGraph_ is called.
2101 *
2102 * clearSelection, when undefined or true, causes this.clearSelection to be
2103 * called at the end of the draw operation. This should rarely be defined,
2104 * and never true (that is it should be undefined most of the time, and
2105 * rarely false.)
2106 *
2107 * @private
2108 */
2109Dygraph.prototype.drawGraph_ = function(clearSelection) {
2110 var start = new Date();
2111
2112 if (typeof(clearSelection) === 'undefined') {
2113 clearSelection = true;
2114 }
2115
2116 // This is used to set the second parameter to drawCallback, below.
2117 var is_initial_draw = this.is_initial_draw_;
2118 this.is_initial_draw_ = false;
2119
2120 this.layout_.removeAllDatasets();
2121 this.setColors_();
2122 this.attrs_.pointSize = 0.5 * this.attr_('highlightCircleSize');
2123
2124 var packed = this.gatherDatasets_(this.rolledSeries_, this.dateWindow_);
2125 var datasets = packed[0];
2126 var extremes = packed[1];
2127 this.boundaryIds_ = packed[2];
2128
2129 this.setIndexByName_ = {};
2130 var labels = this.attr_("labels");
2131 if (labels.length > 0) {
2132 this.setIndexByName_[labels[0]] = 0;
2133 }
2134 for (var i = 1; i < datasets.length; i++) {
2135 this.setIndexByName_[labels[i]] = i;
2136 if (!this.visibility()[i - 1]) continue;
2137 this.layout_.addDataset(labels[i], datasets[i]);
2138 }
2139
2140 this.computeYAxisRanges_(extremes);
2141 this.layout_.setYAxes(this.axes_);
2142
2143 this.addXTicks_();
2144
2145 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2146 var tmp_zoomed_x = this.zoomed_x_;
2147 // Tell PlotKit to use this new data and render itself
2148 this.layout_.setDateWindow(this.dateWindow_);
2149 this.zoomed_x_ = tmp_zoomed_x;
2150 this.layout_.evaluateWithError();
2151 this.renderGraph_(is_initial_draw, false);
2152
2153 if (this.attr_("timingName")) {
2154 var end = new Date();
2155 if (console) {
2156 console.log(this.attr_("timingName") + " - drawGraph: " + (end - start) + "ms");
2157 }
2158 }
2159};
2160
2161Dygraph.prototype.renderGraph_ = function(is_initial_draw, clearSelection) {
2162 this.plotter_.clear();
2163 this.plotter_.render();
2164 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2165 this.canvas_.height);
2166
2167 // Generate a static legend before any particular point is selected.
2168 this.setLegendHTML_();
2169
2170 if (!is_initial_draw) {
2171 if (clearSelection) {
2172 if (typeof(this.selPoints_) !== 'undefined' && this.selPoints_.length) {
2173 // We should select the point nearest the page x/y here, but it's easier
2174 // to just clear the selection. This prevents erroneous hover dots from
2175 // being displayed.
2176 this.clearSelection();
2177 } else {
2178 this.clearSelection();
2179 }
2180 }
2181 }
2182
2183 if (this.rangeSelector_) {
2184 this.rangeSelector_.renderInteractiveLayer();
2185 }
2186
2187 if (this.attr_("drawCallback") !== null) {
2188 this.attr_("drawCallback")(this, is_initial_draw);
2189 }
2190};
2191
2192/**
2193 * @private
2194 * Determine properties of the y-axes which are independent of the data
2195 * currently being displayed. This includes things like the number of axes and
2196 * the style of the axes. It does not include the range of each axis and its
2197 * tick marks.
2198 * This fills in this.axes_ and this.seriesToAxisMap_.
2199 * axes_ = [ { options } ]
2200 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2201 * indices are into the axes_ array.
2202 */
2203Dygraph.prototype.computeYAxes_ = function() {
2204 // Preserve valueWindow settings if they exist, and if the user hasn't
2205 // specified a new valueRange.
2206 var i, valueWindows, seriesName, axis, index, opts, v;
2207 if (this.axes_ !== undefined && this.user_attrs_.hasOwnProperty("valueRange") === false) {
2208 valueWindows = [];
2209 for (index = 0; index < this.axes_.length; index++) {
2210 valueWindows.push(this.axes_[index].valueWindow);
2211 }
2212 }
2213
2214 this.axes_ = [{ yAxisId : 0, g : this }]; // always have at least one y-axis.
2215 this.seriesToAxisMap_ = {};
2216
2217 // Get a list of series names.
2218 var labels = this.attr_("labels");
2219 var series = {};
2220 for (i = 1; i < labels.length; i++) series[labels[i]] = (i - 1);
2221
2222 // all options which could be applied per-axis:
2223 var axisOptions = [
2224 'includeZero',
2225 'valueRange',
2226 'labelsKMB',
2227 'labelsKMG2',
2228 'pixelsPerYLabel',
2229 'yAxisLabelWidth',
2230 'axisLabelFontSize',
2231 'axisTickSize',
2232 'logscale'
2233 ];
2234
2235 // Copy global axis options over to the first axis.
2236 for (i = 0; i < axisOptions.length; i++) {
2237 var k = axisOptions[i];
2238 v = this.attr_(k);
2239 if (v) this.axes_[0][k] = v;
2240 }
2241
2242 // Go through once and add all the axes.
2243 for (seriesName in series) {
2244 if (!series.hasOwnProperty(seriesName)) continue;
2245 axis = this.attr_("axis", seriesName);
2246 if (axis === null) {
2247 this.seriesToAxisMap_[seriesName] = 0;
2248 continue;
2249 }
2250 if (typeof(axis) == 'object') {
2251 // Add a new axis, making a copy of its per-axis options.
2252 opts = {};
2253 Dygraph.update(opts, this.axes_[0]);
2254 Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this.
2255 var yAxisId = this.axes_.length;
2256 opts.yAxisId = yAxisId;
2257 opts.g = this;
2258 Dygraph.update(opts, axis);
2259 this.axes_.push(opts);
2260 this.seriesToAxisMap_[seriesName] = yAxisId;
2261 }
2262 }
2263
2264 // Go through one more time and assign series to an axis defined by another
2265 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2266 for (seriesName in series) {
2267 if (!series.hasOwnProperty(seriesName)) continue;
2268 axis = this.attr_("axis", seriesName);
2269 if (typeof(axis) == 'string') {
2270 if (!this.seriesToAxisMap_.hasOwnProperty(axis)) {
2271 this.error("Series " + seriesName + " wants to share a y-axis with " +
2272 "series " + axis + ", which does not define its own axis.");
2273 return null;
2274 }
2275 var idx = this.seriesToAxisMap_[axis];
2276 this.seriesToAxisMap_[seriesName] = idx;
2277 }
2278 }
2279
2280 if (valueWindows !== undefined) {
2281 // Restore valueWindow settings.
2282 for (index = 0; index < valueWindows.length; index++) {
2283 this.axes_[index].valueWindow = valueWindows[index];
2284 }
2285 }
2286
2287 // New axes options
2288 for (axis = 0; axis < this.axes_.length; axis++) {
2289 if (axis === 0) {
2290 opts = this.optionsViewForAxis_('y' + (axis ? '2' : ''));
2291 v = opts("valueRange");
2292 if (v) this.axes_[axis].valueRange = v;
2293 } else { // To keep old behavior
2294 var axes = this.user_attrs_.axes;
2295 if (axes && axes.y2) {
2296 v = axes.y2.valueRange;
2297 if (v) this.axes_[axis].valueRange = v;
2298 }
2299 }
2300 }
2301
2302};
2303
2304/**
2305 * Returns the number of y-axes on the chart.
2306 * @return {Number} the number of axes.
2307 */
2308Dygraph.prototype.numAxes = function() {
2309 var last_axis = 0;
2310 for (var series in this.seriesToAxisMap_) {
2311 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2312 var idx = this.seriesToAxisMap_[series];
2313 if (idx > last_axis) last_axis = idx;
2314 }
2315 return 1 + last_axis;
2316};
2317
2318/**
2319 * @private
2320 * Returns axis properties for the given series.
2321 * @param { String } setName The name of the series for which to get axis
2322 * properties, e.g. 'Y1'.
2323 * @return { Object } The axis properties.
2324 */
2325Dygraph.prototype.axisPropertiesForSeries = function(series) {
2326 // TODO(danvk): handle errors.
2327 return this.axes_[this.seriesToAxisMap_[series]];
2328};
2329
2330/**
2331 * @private
2332 * Determine the value range and tick marks for each axis.
2333 * @param {Object} extremes A mapping from seriesName -> [low, high]
2334 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2335 */
2336Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2337 // Build a map from axis number -> [list of series names]
2338 var seriesForAxis = [], series;
2339 for (series in this.seriesToAxisMap_) {
2340 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2341 var idx = this.seriesToAxisMap_[series];
2342 while (seriesForAxis.length <= idx) seriesForAxis.push([]);
2343 seriesForAxis[idx].push(series);
2344 }
2345
2346 // Compute extreme values, a span and tick marks for each axis.
2347 for (var i = 0; i < this.axes_.length; i++) {
2348 var axis = this.axes_[i];
2349
2350 if (!seriesForAxis[i]) {
2351 // If no series are defined or visible then use a reasonable default
2352 axis.extremeRange = [0, 1];
2353 } else {
2354 // Calculate the extremes of extremes.
2355 series = seriesForAxis[i];
2356 var minY = Infinity; // extremes[series[0]][0];
2357 var maxY = -Infinity; // extremes[series[0]][1];
2358 var extremeMinY, extremeMaxY;
2359
2360 for (var j = 0; j < series.length; j++) {
2361 // this skips invisible series
2362 if (!extremes.hasOwnProperty(series[j])) continue;
2363
2364 // Only use valid extremes to stop null data series' from corrupting the scale.
2365 extremeMinY = extremes[series[j]][0];
2366 if (extremeMinY !== null) {
2367 minY = Math.min(extremeMinY, minY);
2368 }
2369 extremeMaxY = extremes[series[j]][1];
2370 if (extremeMaxY !== null) {
2371 maxY = Math.max(extremeMaxY, maxY);
2372 }
2373 }
2374 if (axis.includeZero && minY > 0) minY = 0;
2375
2376 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2377 if (minY == Infinity) minY = 0;
2378 if (maxY == -Infinity) maxY = 1;
2379
2380 // Add some padding and round up to an integer to be human-friendly.
2381 var span = maxY - minY;
2382 // special case: if we have no sense of scale, use +/-10% of the sole value.
2383 if (span === 0) { span = maxY; }
2384
2385 var maxAxisY, minAxisY;
2386 if (axis.logscale) {
2387 maxAxisY = maxY + 0.1 * span;
2388 minAxisY = minY;
2389 } else {
2390 maxAxisY = maxY + 0.1 * span;
2391 minAxisY = minY - 0.1 * span;
2392
2393 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2394 if (!this.attr_("avoidMinZero")) {
2395 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2396 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
2397 }
2398
2399 if (this.attr_("includeZero")) {
2400 if (maxY < 0) maxAxisY = 0;
2401 if (minY > 0) minAxisY = 0;
2402 }
2403 }
2404 axis.extremeRange = [minAxisY, maxAxisY];
2405 }
2406 if (axis.valueWindow) {
2407 // This is only set if the user has zoomed on the y-axis. It is never set
2408 // by a user. It takes precedence over axis.valueRange because, if you set
2409 // valueRange, you'd still expect to be able to pan.
2410 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
2411 } else if (axis.valueRange) {
2412 // This is a user-set value range for this axis.
2413 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
2414 } else {
2415 axis.computedValueRange = axis.extremeRange;
2416 }
2417
2418 // Add ticks. By default, all axes inherit the tick positions of the
2419 // primary axis. However, if an axis is specifically marked as having
2420 // independent ticks, then that is permissible as well.
2421 var opts = this.optionsViewForAxis_('y' + (i ? '2' : ''));
2422 var ticker = opts('ticker');
2423 if (i === 0 || axis.independentTicks) {
2424 axis.ticks = ticker(axis.computedValueRange[0],
2425 axis.computedValueRange[1],
2426 this.height_, // TODO(danvk): should be area.height
2427 opts,
2428 this);
2429 } else {
2430 var p_axis = this.axes_[0];
2431 var p_ticks = p_axis.ticks;
2432 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
2433 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
2434 var tick_values = [];
2435 for (var k = 0; k < p_ticks.length; k++) {
2436 var y_frac = (p_ticks[k].v - p_axis.computedValueRange[0]) / p_scale;
2437 var y_val = axis.computedValueRange[0] + y_frac * scale;
2438 tick_values.push(y_val);
2439 }
2440
2441 axis.ticks = ticker(axis.computedValueRange[0],
2442 axis.computedValueRange[1],
2443 this.height_, // TODO(danvk): should be area.height
2444 opts,
2445 this,
2446 tick_values);
2447 }
2448 }
2449};
2450
2451/**
2452 * Extracts one series from the raw data (a 2D array) into an array of (date,
2453 * value) tuples.
2454 *
2455 * This is where undesirable points (i.e. negative values on log scales and
2456 * missing values through which we wish to connect lines) are dropped.
2457 *
2458 * @private
2459 */
2460Dygraph.prototype.extractSeries_ = function(rawData, i, logScale, connectSeparatedPoints) {
2461 var series = [];
2462 for (var j = 0; j < rawData.length; j++) {
2463 var x = rawData[j][0];
2464 var point = rawData[j][i];
2465 if (logScale) {
2466 // On the log scale, points less than zero do not exist.
2467 // This will create a gap in the chart. Note that this ignores
2468 // connectSeparatedPoints.
2469 if (point <= 0) {
2470 point = null;
2471 }
2472 series.push([x, point]);
2473 } else {
2474 if (point !== null || !connectSeparatedPoints) {
2475 series.push([x, point]);
2476 }
2477 }
2478 }
2479 return series;
2480};
2481
2482/**
2483 * @private
2484 * Calculates the rolling average of a data set.
2485 * If originalData is [label, val], rolls the average of those.
2486 * If originalData is [label, [, it's interpreted as [value, stddev]
2487 * and the roll is returned in the same form, with appropriately reduced
2488 * stddev for each value.
2489 * Note that this is where fractional input (i.e. '5/10') is converted into
2490 * decimal values.
2491 * @param {Array} originalData The data in the appropriate format (see above)
2492 * @param {Number} rollPeriod The number of points over which to average the
2493 * data
2494 */
2495Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
2496 if (originalData.length < 2)
2497 return originalData;
2498 rollPeriod = Math.min(rollPeriod, originalData.length);
2499 var rollingData = [];
2500 var sigma = this.attr_("sigma");
2501
2502 var low, high, i, j, y, sum, num_ok, stddev;
2503 if (this.fractions_) {
2504 var num = 0;
2505 var den = 0; // numerator/denominator
2506 var mult = 100.0;
2507 for (i = 0; i < originalData.length; i++) {
2508 num += originalData[i][1][0];
2509 den += originalData[i][1][1];
2510 if (i - rollPeriod >= 0) {
2511 num -= originalData[i - rollPeriod][1][0];
2512 den -= originalData[i - rollPeriod][1][1];
2513 }
2514
2515 var date = originalData[i][0];
2516 var value = den ? num / den : 0.0;
2517 if (this.attr_("errorBars")) {
2518 if (this.attr_("wilsonInterval")) {
2519 // For more details on this confidence interval, see:
2520 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
2521 if (den) {
2522 var p = value < 0 ? 0 : value, n = den;
2523 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
2524 var denom = 1 + sigma * sigma / den;
2525 low = (p + sigma * sigma / (2 * den) - pm) / denom;
2526 high = (p + sigma * sigma / (2 * den) + pm) / denom;
2527 rollingData[i] = [date,
2528 [p * mult, (p - low) * mult, (high - p) * mult]];
2529 } else {
2530 rollingData[i] = [date, [0, 0, 0]];
2531 }
2532 } else {
2533 stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
2534 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
2535 }
2536 } else {
2537 rollingData[i] = [date, mult * value];
2538 }
2539 }
2540 } else if (this.attr_("customBars")) {
2541 low = 0;
2542 var mid = 0;
2543 high = 0;
2544 var count = 0;
2545 for (i = 0; i < originalData.length; i++) {
2546 var data = originalData[i][1];
2547 y = data[1];
2548 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
2549
2550 if (y !== null && !isNaN(y)) {
2551 low += data[0];
2552 mid += y;
2553 high += data[2];
2554 count += 1;
2555 }
2556 if (i - rollPeriod >= 0) {
2557 var prev = originalData[i - rollPeriod];
2558 if (prev[1][1] !== null && !isNaN(prev[1][1])) {
2559 low -= prev[1][0];
2560 mid -= prev[1][1];
2561 high -= prev[1][2];
2562 count -= 1;
2563 }
2564 }
2565 if (count) {
2566 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
2567 1.0 * (mid - low) / count,
2568 1.0 * (high - mid) / count ]];
2569 } else {
2570 rollingData[i] = [originalData[i][0], [null, null, null]];
2571 }
2572 }
2573 } else {
2574 // Calculate the rolling average for the first rollPeriod - 1 points where
2575 // there is not enough data to roll over the full number of points
2576 if (!this.attr_("errorBars")){
2577 if (rollPeriod == 1) {
2578 return originalData;
2579 }
2580
2581 for (i = 0; i < originalData.length; i++) {
2582 sum = 0;
2583 num_ok = 0;
2584 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2585 y = originalData[j][1];
2586 if (y === null || isNaN(y)) continue;
2587 num_ok++;
2588 sum += originalData[j][1];
2589 }
2590 if (num_ok) {
2591 rollingData[i] = [originalData[i][0], sum / num_ok];
2592 } else {
2593 rollingData[i] = [originalData[i][0], null];
2594 }
2595 }
2596
2597 } else {
2598 for (i = 0; i < originalData.length; i++) {
2599 sum = 0;
2600 var variance = 0;
2601 num_ok = 0;
2602 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2603 y = originalData[j][1][0];
2604 if (y === null || isNaN(y)) continue;
2605 num_ok++;
2606 sum += originalData[j][1][0];
2607 variance += Math.pow(originalData[j][1][1], 2);
2608 }
2609 if (num_ok) {
2610 stddev = Math.sqrt(variance) / num_ok;
2611 rollingData[i] = [originalData[i][0],
2612 [sum / num_ok, sigma * stddev, sigma * stddev]];
2613 } else {
2614 rollingData[i] = [originalData[i][0], [null, null, null]];
2615 }
2616 }
2617 }
2618 }
2619
2620 return rollingData;
2621};
2622
2623/**
2624 * Detects the type of the str (date or numeric) and sets the various
2625 * formatting attributes in this.attrs_ based on this type.
2626 * @param {String} str An x value.
2627 * @private
2628 */
2629Dygraph.prototype.detectTypeFromString_ = function(str) {
2630 var isDate = false;
2631 var dashPos = str.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2632 if ((dashPos > 0 && (str[dashPos-1] != 'e' && str[dashPos-1] != 'E')) ||
2633 str.indexOf('/') >= 0 ||
2634 isNaN(parseFloat(str))) {
2635 isDate = true;
2636 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
2637 // TODO(danvk): remove support for this format.
2638 isDate = true;
2639 }
2640
2641 if (isDate) {
2642 this.attrs_.xValueParser = Dygraph.dateParser;
2643 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2644 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2645 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
2646 } else {
2647 /** @private (shut up, jsdoc!) */
2648 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2649 // TODO(danvk): use Dygraph.numberValueFormatter here?
2650 /** @private (shut up, jsdoc!) */
2651 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
2652 this.attrs_.axes.x.ticker = Dygraph.numericTicks;
2653 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
2654 }
2655};
2656
2657/**
2658 * Parses the value as a floating point number. This is like the parseFloat()
2659 * built-in, but with a few differences:
2660 * - the empty string is parsed as null, rather than NaN.
2661 * - if the string cannot be parsed at all, an error is logged.
2662 * If the string can't be parsed, this method returns null.
2663 * @param {String} x The string to be parsed
2664 * @param {Number} opt_line_no The line number from which the string comes.
2665 * @param {String} opt_line The text of the line from which the string comes.
2666 * @private
2667 */
2668
2669// Parse the x as a float or return null if it's not a number.
2670Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) {
2671 var val = parseFloat(x);
2672 if (!isNaN(val)) return val;
2673
2674 // Try to figure out what happeend.
2675 // If the value is the empty string, parse it as null.
2676 if (/^ *$/.test(x)) return null;
2677
2678 // If it was actually "NaN", return it as NaN.
2679 if (/^ *nan *$/i.test(x)) return NaN;
2680
2681 // Looks like a parsing error.
2682 var msg = "Unable to parse '" + x + "' as a number";
2683 if (opt_line !== null && opt_line_no !== null) {
2684 msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV.";
2685 }
2686 this.error(msg);
2687
2688 return null;
2689};
2690
2691/**
2692 * @private
2693 * Parses a string in a special csv format. We expect a csv file where each
2694 * line is a date point, and the first field in each line is the date string.
2695 * We also expect that all remaining fields represent series.
2696 * if the errorBars attribute is set, then interpret the fields as:
2697 * date, series1, stddev1, series2, stddev2, ...
2698 * @param {[Object]} data See above.
2699 *
2700 * @return [Object] An array with one entry for each row. These entries
2701 * are an array of cells in that row. The first entry is the parsed x-value for
2702 * the row. The second, third, etc. are the y-values. These can take on one of
2703 * three forms, depending on the CSV and constructor parameters:
2704 * 1. numeric value
2705 * 2. [ value, stddev ]
2706 * 3. [ low value, center value, high value ]
2707 */
2708Dygraph.prototype.parseCSV_ = function(data) {
2709 var ret = [];
2710 var lines = data.split("\n");
2711 var vals, j;
2712
2713 // Use the default delimiter or fall back to a tab if that makes sense.
2714 var delim = this.attr_('delimiter');
2715 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
2716 delim = '\t';
2717 }
2718
2719 var start = 0;
2720 if (!('labels' in this.user_attrs_)) {
2721 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2722 start = 1;
2723 this.attrs_.labels = lines[0].split(delim); // NOTE: _not_ user_attrs_.
2724 }
2725 var line_no = 0;
2726
2727 var xParser;
2728 var defaultParserSet = false; // attempt to auto-detect x value type
2729 var expectedCols = this.attr_("labels").length;
2730 var outOfOrder = false;
2731 for (var i = start; i < lines.length; i++) {
2732 var line = lines[i];
2733 line_no = i;
2734 if (line.length === 0) continue; // skip blank lines
2735 if (line[0] == '#') continue; // skip comment lines
2736 var inFields = line.split(delim);
2737 if (inFields.length < 2) continue;
2738
2739 var fields = [];
2740 if (!defaultParserSet) {
2741 this.detectTypeFromString_(inFields[0]);
2742 xParser = this.attr_("xValueParser");
2743 defaultParserSet = true;
2744 }
2745 fields[0] = xParser(inFields[0], this);
2746
2747 // If fractions are expected, parse the numbers as "A/B"
2748 if (this.fractions_) {
2749 for (j = 1; j < inFields.length; j++) {
2750 // TODO(danvk): figure out an appropriate way to flag parse errors.
2751 vals = inFields[j].split("/");
2752 if (vals.length != 2) {
2753 this.error('Expected fractional "num/den" values in CSV data ' +
2754 "but found a value '" + inFields[j] + "' on line " +
2755 (1 + i) + " ('" + line + "') which is not of this form.");
2756 fields[j] = [0, 0];
2757 } else {
2758 fields[j] = [this.parseFloat_(vals[0], i, line),
2759 this.parseFloat_(vals[1], i, line)];
2760 }
2761 }
2762 } else if (this.attr_("errorBars")) {
2763 // If there are error bars, values are (value, stddev) pairs
2764 if (inFields.length % 2 != 1) {
2765 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2766 'but line ' + (1 + i) + ' has an odd number of values (' +
2767 (inFields.length - 1) + "): '" + line + "'");
2768 }
2769 for (j = 1; j < inFields.length; j += 2) {
2770 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2771 this.parseFloat_(inFields[j + 1], i, line)];
2772 }
2773 } else if (this.attr_("customBars")) {
2774 // Bars are a low;center;high tuple
2775 for (j = 1; j < inFields.length; j++) {
2776 var val = inFields[j];
2777 if (/^ *$/.test(val)) {
2778 fields[j] = [null, null, null];
2779 } else {
2780 vals = val.split(";");
2781 if (vals.length == 3) {
2782 fields[j] = [ this.parseFloat_(vals[0], i, line),
2783 this.parseFloat_(vals[1], i, line),
2784 this.parseFloat_(vals[2], i, line) ];
2785 } else {
2786 this.warn('When using customBars, values must be either blank ' +
2787 'or "low;center;high" tuples (got "' + val +
2788 '" on line ' + (1+i));
2789 }
2790 }
2791 }
2792 } else {
2793 // Values are just numbers
2794 for (j = 1; j < inFields.length; j++) {
2795 fields[j] = this.parseFloat_(inFields[j], i, line);
2796 }
2797 }
2798 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2799 outOfOrder = true;
2800 }
2801
2802 if (fields.length != expectedCols) {
2803 this.error("Number of columns in line " + i + " (" + fields.length +
2804 ") does not agree with number of labels (" + expectedCols +
2805 ") " + line);
2806 }
2807
2808 // If the user specified the 'labels' option and none of the cells of the
2809 // first row parsed correctly, then they probably double-specified the
2810 // labels. We go with the values set in the option, discard this row and
2811 // log a warning to the JS console.
2812 if (i === 0 && this.attr_('labels')) {
2813 var all_null = true;
2814 for (j = 0; all_null && j < fields.length; j++) {
2815 if (fields[j]) all_null = false;
2816 }
2817 if (all_null) {
2818 this.warn("The dygraphs 'labels' option is set, but the first row of " +
2819 "CSV data ('" + line + "') appears to also contain labels. " +
2820 "Will drop the CSV labels and use the option labels.");
2821 continue;
2822 }
2823 }
2824 ret.push(fields);
2825 }
2826
2827 if (outOfOrder) {
2828 this.warn("CSV is out of order; order it correctly to speed loading.");
2829 ret.sort(function(a,b) { return a[0] - b[0]; });
2830 }
2831
2832 return ret;
2833};
2834
2835/**
2836 * @private
2837 * The user has provided their data as a pre-packaged JS array. If the x values
2838 * are numeric, this is the same as dygraphs' internal format. If the x values
2839 * are dates, we need to convert them from Date objects to ms since epoch.
2840 * @param {[Object]} data
2841 * @return {[Object]} data with numeric x values.
2842 */
2843Dygraph.prototype.parseArray_ = function(data) {
2844 // Peek at the first x value to see if it's numeric.
2845 if (data.length === 0) {
2846 this.error("Can't plot empty data set");
2847 return null;
2848 }
2849 if (data[0].length === 0) {
2850 this.error("Data set cannot contain an empty row");
2851 return null;
2852 }
2853
2854 var i;
2855 if (this.attr_("labels") === null) {
2856 this.warn("Using default labels. Set labels explicitly via 'labels' " +
2857 "in the options parameter");
2858 this.attrs_.labels = [ "X" ];
2859 for (i = 1; i < data[0].length; i++) {
2860 this.attrs_.labels.push("Y" + i);
2861 }
2862 }
2863
2864 if (Dygraph.isDateLike(data[0][0])) {
2865 // Some intelligent defaults for a date x-axis.
2866 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2867 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
2868 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2869
2870 // Assume they're all dates.
2871 var parsedData = Dygraph.clone(data);
2872 for (i = 0; i < data.length; i++) {
2873 if (parsedData[i].length === 0) {
2874 this.error("Row " + (1 + i) + " of data is empty");
2875 return null;
2876 }
2877 if (parsedData[i][0] === null ||
2878 typeof(parsedData[i][0].getTime) != 'function' ||
2879 isNaN(parsedData[i][0].getTime())) {
2880 this.error("x value in row " + (1 + i) + " is not a Date");
2881 return null;
2882 }
2883 parsedData[i][0] = parsedData[i][0].getTime();
2884 }
2885 return parsedData;
2886 } else {
2887 // Some intelligent defaults for a numeric x-axis.
2888 /** @private (shut up, jsdoc!) */
2889 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
2890 this.attrs_.axes.x.axisLabelFormatter = Dygraph.numberAxisLabelFormatter;
2891 this.attrs_.axes.x.ticker = Dygraph.numericTicks;
2892 return data;
2893 }
2894};
2895
2896/**
2897 * Parses a DataTable object from gviz.
2898 * The data is expected to have a first column that is either a date or a
2899 * number. All subsequent columns must be numbers. If there is a clear mismatch
2900 * between this.xValueParser_ and the type of the first column, it will be
2901 * fixed. Fills out rawData_.
2902 * @param {[Object]} data See above.
2903 * @private
2904 */
2905Dygraph.prototype.parseDataTable_ = function(data) {
2906 var shortTextForAnnotationNum = function(num) {
2907 // converts [0-9]+ [A-Z][a-z]*
2908 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
2909 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
2910 var shortText = String.fromCharCode(65 /* A */ + num % 26);
2911 num = Math.floor(num / 26);
2912 while ( num > 0 ) {
2913 shortText = String.fromCharCode(65 /* A */ + (num - 1) % 26 ) + shortText.toLowerCase();
2914 num = Math.floor((num - 1) / 26);
2915 }
2916 return shortText;
2917 }
2918
2919 var cols = data.getNumberOfColumns();
2920 var rows = data.getNumberOfRows();
2921
2922 var indepType = data.getColumnType(0);
2923 if (indepType == 'date' || indepType == 'datetime') {
2924 this.attrs_.xValueParser = Dygraph.dateParser;
2925 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2926 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2927 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
2928 } else if (indepType == 'number') {
2929 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2930 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
2931 this.attrs_.axes.x.ticker = Dygraph.numericTicks;
2932 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
2933 } else {
2934 this.error("only 'date', 'datetime' and 'number' types are supported for " +
2935 "column 1 of DataTable input (Got '" + indepType + "')");
2936 return null;
2937 }
2938
2939 // Array of the column indices which contain data (and not annotations).
2940 var colIdx = [];
2941 var annotationCols = {}; // data index -> [annotation cols]
2942 var hasAnnotations = false;
2943 var i, j;
2944 for (i = 1; i < cols; i++) {
2945 var type = data.getColumnType(i);
2946 if (type == 'number') {
2947 colIdx.push(i);
2948 } else if (type == 'string' && this.attr_('displayAnnotations')) {
2949 // This is OK -- it's an annotation column.
2950 var dataIdx = colIdx[colIdx.length - 1];
2951 if (!annotationCols.hasOwnProperty(dataIdx)) {
2952 annotationCols[dataIdx] = [i];
2953 } else {
2954 annotationCols[dataIdx].push(i);
2955 }
2956 hasAnnotations = true;
2957 } else {
2958 this.error("Only 'number' is supported as a dependent type with Gviz." +
2959 " 'string' is only supported if displayAnnotations is true");
2960 }
2961 }
2962
2963 // Read column labels
2964 // TODO(danvk): add support back for errorBars
2965 var labels = [data.getColumnLabel(0)];
2966 for (i = 0; i < colIdx.length; i++) {
2967 labels.push(data.getColumnLabel(colIdx[i]));
2968 if (this.attr_("errorBars")) i += 1;
2969 }
2970 this.attrs_.labels = labels;
2971 cols = labels.length;
2972
2973 var ret = [];
2974 var outOfOrder = false;
2975 var annotations = [];
2976 for (i = 0; i < rows; i++) {
2977 var row = [];
2978 if (typeof(data.getValue(i, 0)) === 'undefined' ||
2979 data.getValue(i, 0) === null) {
2980 this.warn("Ignoring row " + i +
2981 " of DataTable because of undefined or null first column.");
2982 continue;
2983 }
2984
2985 if (indepType == 'date' || indepType == 'datetime') {
2986 row.push(data.getValue(i, 0).getTime());
2987 } else {
2988 row.push(data.getValue(i, 0));
2989 }
2990 if (!this.attr_("errorBars")) {
2991 for (j = 0; j < colIdx.length; j++) {
2992 var col = colIdx[j];
2993 row.push(data.getValue(i, col));
2994 if (hasAnnotations &&
2995 annotationCols.hasOwnProperty(col) &&
2996 data.getValue(i, annotationCols[col][0]) !== null) {
2997 var ann = {};
2998 ann.series = data.getColumnLabel(col);
2999 ann.xval = row[0];
3000 ann.shortText = shortTextForAnnotationNum(annotations.length);
3001 ann.text = '';
3002 for (var k = 0; k < annotationCols[col].length; k++) {
3003 if (k) ann.text += "\n";
3004 ann.text += data.getValue(i, annotationCols[col][k]);
3005 }
3006 annotations.push(ann);
3007 }
3008 }
3009
3010 // Strip out infinities, which give dygraphs problems later on.
3011 for (j = 0; j < row.length; j++) {
3012 if (!isFinite(row[j])) row[j] = null;
3013 }
3014 } else {
3015 for (j = 0; j < cols - 1; j++) {
3016 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
3017 }
3018 }
3019 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
3020 outOfOrder = true;
3021 }
3022 ret.push(row);
3023 }
3024
3025 if (outOfOrder) {
3026 this.warn("DataTable is out of order; order it correctly to speed loading.");
3027 ret.sort(function(a,b) { return a[0] - b[0]; });
3028 }
3029 this.rawData_ = ret;
3030
3031 if (annotations.length > 0) {
3032 this.setAnnotations(annotations, true);
3033 }
3034};
3035
3036/**
3037 * Get the CSV data. If it's in a function, call that function. If it's in a
3038 * file, do an XMLHttpRequest to get it.
3039 * @private
3040 */
3041Dygraph.prototype.start_ = function() {
3042 var data = this.file_;
3043
3044 // Functions can return references of all other types.
3045 if (typeof data == 'function') {
3046 data = data();
3047 }
3048
3049 if (Dygraph.isArrayLike(data)) {
3050 this.rawData_ = this.parseArray_(data);
3051 this.predraw_();
3052 } else if (typeof data == 'object' &&
3053 typeof data.getColumnRange == 'function') {
3054 // must be a DataTable from gviz.
3055 this.parseDataTable_(data);
3056 this.predraw_();
3057 } else if (typeof data == 'string') {
3058 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3059 if (data.indexOf('\n') >= 0) {
3060 this.loadedEvent_(data);
3061 } else {
3062 var req = new XMLHttpRequest();
3063 var caller = this;
3064 req.onreadystatechange = function () {
3065 if (req.readyState == 4) {
3066 if (req.status === 200 || // Normal http
3067 req.status === 0) { // Chrome w/ --allow-file-access-from-files
3068 caller.loadedEvent_(req.responseText);
3069 }
3070 }
3071 };
3072
3073 req.open("GET", data, true);
3074 req.send(null);
3075 }
3076 } else {
3077 this.error("Unknown data format: " + (typeof data));
3078 }
3079};
3080
3081/**
3082 * Changes various properties of the graph. These can include:
3083 * <ul>
3084 * <li>file: changes the source data for the graph</li>
3085 * <li>errorBars: changes whether the data contains stddev</li>
3086 * </ul>
3087 *
3088 * There's a huge variety of options that can be passed to this method. For a
3089 * full list, see http://dygraphs.com/options.html.
3090 *
3091 * @param {Object} attrs The new properties and values
3092 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3093 * call to updateOptions(). If you know better, you can pass true to explicitly
3094 * block the redraw. This can be useful for chaining updateOptions() calls,
3095 * avoiding the occasional infinite loop and preventing redraws when it's not
3096 * necessary (e.g. when updating a callback).
3097 */
3098Dygraph.prototype.updateOptions = function(input_attrs, block_redraw) {
3099 if (typeof(block_redraw) == 'undefined') block_redraw = false;
3100
3101 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3102 var file = input_attrs.file;
3103 var attrs = Dygraph.mapLegacyOptions_(input_attrs);
3104
3105 // TODO(danvk): this is a mess. Move these options into attr_.
3106 if ('rollPeriod' in attrs) {
3107 this.rollPeriod_ = attrs.rollPeriod;
3108 }
3109 if ('dateWindow' in attrs) {
3110 this.dateWindow_ = attrs.dateWindow;
3111 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
3112 this.zoomed_x_ = (attrs.dateWindow !== null);
3113 }
3114 }
3115 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
3116 this.zoomed_y_ = (attrs.valueRange !== null);
3117 }
3118
3119 // TODO(danvk): validate per-series options.
3120 // Supported:
3121 // strokeWidth
3122 // pointSize
3123 // drawPoints
3124 // highlightCircleSize
3125
3126 // Check if this set options will require new points.
3127 var requiresNewPoints = Dygraph.isPixelChangingOptionList(this.attr_("labels"), attrs);
3128
3129 Dygraph.updateDeep(this.user_attrs_, attrs);
3130
3131 if (file) {
3132 this.file_ = file;
3133 if (!block_redraw) this.start_();
3134 } else {
3135 if (!block_redraw) {
3136 if (requiresNewPoints) {
3137 this.predraw_();
3138 } else {
3139 this.renderGraph_(false, false);
3140 }
3141 }
3142 }
3143};
3144
3145/**
3146 * Returns a copy of the options with deprecated names converted into current
3147 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3148 * interested in that, they should save a copy before calling this.
3149 * @private
3150 */
3151Dygraph.mapLegacyOptions_ = function(attrs) {
3152 var my_attrs = {};
3153 for (var k in attrs) {
3154 if (k == 'file') continue;
3155 if (attrs.hasOwnProperty(k)) my_attrs[k] = attrs[k];
3156 }
3157
3158 var set = function(axis, opt, value) {
3159 if (!my_attrs.axes) my_attrs.axes = {};
3160 if (!my_attrs.axes[axis]) my_attrs.axes[axis] = {};
3161 my_attrs.axes[axis][opt] = value;
3162 };
3163 var map = function(opt, axis, new_opt) {
3164 if (typeof(attrs[opt]) != 'undefined') {
3165 set(axis, new_opt, attrs[opt]);
3166 delete my_attrs[opt];
3167 }
3168 };
3169
3170 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3171 map('xValueFormatter', 'x', 'valueFormatter');
3172 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3173 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3174 map('xTicker', 'x', 'ticker');
3175 map('yValueFormatter', 'y', 'valueFormatter');
3176 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3177 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3178 map('yTicker', 'y', 'ticker');
3179 return my_attrs;
3180};
3181
3182/**
3183 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3184 * containing div (which has presumably changed size since the dygraph was
3185 * instantiated. If the width/height are specified, the div will be resized.
3186 *
3187 * This is far more efficient than destroying and re-instantiating a
3188 * Dygraph, since it doesn't have to reparse the underlying data.
3189 *
3190 * @param {Number} [width] Width (in pixels)
3191 * @param {Number} [height] Height (in pixels)
3192 */
3193Dygraph.prototype.resize = function(width, height) {
3194 if (this.resize_lock) {
3195 return;
3196 }
3197 this.resize_lock = true;
3198
3199 if ((width === null) != (height === null)) {
3200 this.warn("Dygraph.resize() should be called with zero parameters or " +
3201 "two non-NULL parameters. Pretending it was zero.");
3202 width = height = null;
3203 }
3204
3205 var old_width = this.width_;
3206 var old_height = this.height_;
3207
3208 if (width) {
3209 this.maindiv_.style.width = width + "px";
3210 this.maindiv_.style.height = height + "px";
3211 this.width_ = width;
3212 this.height_ = height;
3213 } else {
3214 this.width_ = this.maindiv_.clientWidth;
3215 this.height_ = this.maindiv_.clientHeight;
3216 }
3217
3218 if (old_width != this.width_ || old_height != this.height_) {
3219 // TODO(danvk): there should be a clear() method.
3220 this.maindiv_.innerHTML = "";
3221 this.roller_ = null;
3222 this.attrs_.labelsDiv = null;
3223 this.createInterface_();
3224 if (this.annotations_.length) {
3225 // createInterface_ reset the layout, so we need to do this.
3226 this.layout_.setAnnotations(this.annotations_);
3227 }
3228 this.predraw_();
3229 }
3230
3231 this.resize_lock = false;
3232};
3233
3234/**
3235 * Adjusts the number of points in the rolling average. Updates the graph to
3236 * reflect the new averaging period.
3237 * @param {Number} length Number of points over which to average the data.
3238 */
3239Dygraph.prototype.adjustRoll = function(length) {
3240 this.rollPeriod_ = length;
3241 this.predraw_();
3242};
3243
3244/**
3245 * Returns a boolean array of visibility statuses.
3246 */
3247Dygraph.prototype.visibility = function() {
3248 // Do lazy-initialization, so that this happens after we know the number of
3249 // data series.
3250 if (!this.attr_("visibility")) {
3251 this.attrs_.visibility = [];
3252 }
3253 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs.
3254 while (this.attr_("visibility").length < this.numColumns() - 1) {
3255 this.attrs_.visibility.push(true);
3256 }
3257 return this.attr_("visibility");
3258};
3259
3260/**
3261 * Changes the visiblity of a series.
3262 */
3263Dygraph.prototype.setVisibility = function(num, value) {
3264 var x = this.visibility();
3265 if (num < 0 || num >= x.length) {
3266 this.warn("invalid series number in setVisibility: " + num);
3267 } else {
3268 x[num] = value;
3269 this.predraw_();
3270 }
3271};
3272
3273/**
3274 * How large of an area will the dygraph render itself in?
3275 * This is used for testing.
3276 * @return A {width: w, height: h} object.
3277 * @private
3278 */
3279Dygraph.prototype.size = function() {
3280 return { width: this.width_, height: this.height_ };
3281};
3282
3283/**
3284 * Update the list of annotations and redraw the chart.
3285 * See dygraphs.com/annotations.html for more info on how to use annotations.
3286 * @param ann {Array} An array of annotation objects.
3287 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3288 */
3289Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3290 // Only add the annotation CSS rule once we know it will be used.
3291 Dygraph.addAnnotationRule();
3292 this.annotations_ = ann;
3293 this.layout_.setAnnotations(this.annotations_);
3294 if (!suppressDraw) {
3295 this.predraw_();
3296 }
3297};
3298
3299/**
3300 * Return the list of annotations.
3301 */
3302Dygraph.prototype.annotations = function() {
3303 return this.annotations_;
3304};
3305
3306/**
3307 * Get the list of label names for this graph. The first column is the
3308 * x-axis, so the data series names start at index 1.
3309 */
3310Dygraph.prototype.getLabels = function(name) {
3311 return this.attr_("labels").slice();
3312};
3313
3314/**
3315 * Get the index of a series (column) given its name. The first column is the
3316 * x-axis, so the data series start with index 1.
3317 */
3318Dygraph.prototype.indexFromSetName = function(name) {
3319 return this.setIndexByName_[name];
3320};
3321
3322/**
3323 * @private
3324 * Adds a default style for the annotation CSS classes to the document. This is
3325 * only executed when annotations are actually used. It is designed to only be
3326 * called once -- all calls after the first will return immediately.
3327 */
3328Dygraph.addAnnotationRule = function() {
3329 if (Dygraph.addedAnnotationCSS) return;
3330
3331 var rule = "border: 1px solid black; " +
3332 "background-color: white; " +
3333 "text-align: center;";
3334
3335 var styleSheetElement = document.createElement("style");
3336 styleSheetElement.type = "text/css";
3337 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3338
3339 // Find the first style sheet that we can access.
3340 // We may not add a rule to a style sheet from another domain for security
3341 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3342 // adds its own style sheets from google.com.
3343 for (var i = 0; i < document.styleSheets.length; i++) {
3344 if (document.styleSheets[i].disabled) continue;
3345 var mysheet = document.styleSheets[i];
3346 try {
3347 if (mysheet.insertRule) { // Firefox
3348 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3349 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3350 } else if (mysheet.addRule) { // IE
3351 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3352 }
3353 Dygraph.addedAnnotationCSS = true;
3354 return;
3355 } catch(err) {
3356 // Was likely a security exception.
3357 }
3358 }
3359
3360 this.warn("Unable to add default annotation CSS rule; display may be off.");
3361};
3362
3363// Older pages may still use this name.
3364var DateGraph = Dygraph;