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