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