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