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