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