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