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