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