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