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