Address code review comments
[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";
932 enclosing.appendChild(this.graphDiv);
933
934 // Create the canvas for interactive parts of the chart.
f8cfec73 935 this.canvas_ = Dygraph.createCanvas();
b0c3b730
DV
936 this.canvas_.style.position = "absolute";
937 this.canvas_.width = this.width_;
938 this.canvas_.height = this.height_;
f8cfec73
DV
939 this.canvas_.style.width = this.width_ + "px"; // for IE
940 this.canvas_.style.height = this.height_ + "px"; // for IE
b0c3b730 941
2cf95fff
RK
942 this.canvas_ctx_ = Dygraph.getContext(this.canvas_);
943
b0c3b730 944 // ... and for static parts of the chart.
6a1aa64f 945 this.hidden_ = this.createPlotKitCanvas_(this.canvas_);
2cf95fff 946 this.hidden_ctx_ = Dygraph.getContext(this.hidden_);
76171648 947
eb7bf005
EC
948 // The interactive parts of the graph are drawn on top of the chart.
949 this.graphDiv.appendChild(this.hidden_);
950 this.graphDiv.appendChild(this.canvas_);
920208fb
PF
951 this.mouseEventElement_ = this.createMouseEventElement_();
952
953 // Create the grapher
954 this.layout_ = new DygraphLayout(this);
955
76171648 956 var dygraph = this;
de8f284f 957
9fd9bbbb 958 this.mouseMoveHandler_ = function(e) {
959 dygraph.mouseMove_(e);
960 };
de8f284f 961
9fd9bbbb 962 this.mouseOutHandler_ = function(e) {
963 dygraph.mouseOut_(e);
964 };
965
966 this.addEvent(this.mouseEventElement_, 'mousemove', this.mouseMoveHandler_);
967 this.addEvent(this.mouseEventElement_, 'mouseout', this.mouseOutHandler_);
697e70b2 968
9fd9bbbb 969 // Don't recreate and register the resize handler on subsequent calls.
970 // This happens when the graph is resized.
971 if (!this.resizeHandler_) {
e0b3afad
RK
972 this.resizeHandler_ = function(e) {
973 dygraph.resize();
974 };
1c6b239c 975
e0b3afad
RK
976 // Update when the window is resized.
977 // TODO(danvk): drop frames depending on complexity of the chart.
978 this.addEvent(window, 'resize', this.resizeHandler_);
979 }
4cfcc38c
DV
980};
981
982/**
983 * Detach DOM elements in the dygraph and null out all data references.
984 * Calling this when you're done with a dygraph can dramatically reduce memory
985 * usage. See, e.g., the tests/perf.html example.
986 */
987Dygraph.prototype.destroy = function() {
988 var removeRecursive = function(node) {
989 while (node.hasChildNodes()) {
990 removeRecursive(node.firstChild);
991 node.removeChild(node.firstChild);
992 }
993 };
de8f284f 994
f82e5caf 995 if (this.registeredEvents_) {
996 for (var idx = 0; idx < this.registeredEvents_.length; idx++) {
997 var reg = this.registeredEvents_[idx];
998 Dygraph.removeEvent(reg.elem, reg.type, reg.fn);
999 }
6a4587ac 1000 }
f82e5caf 1001
6a4587ac
RK
1002 this.registeredEvents_ = [];
1003
1004 // remove mouse event handlers (This may not be necessary anymore)
7d6df48d
RK
1005 Dygraph.removeEvent(this.mouseEventElement_, 'mouseout', this.mouseOutHandler_);
1006 Dygraph.removeEvent(this.mouseEventElement_, 'mousemove', this.mouseMoveHandler_);
1cc3540b 1007 Dygraph.removeEvent(this.mouseEventElement_, 'mousemove', this.mouseUpHandler_);
7d6df48d
RK
1008
1009 // remove window handlers
1010 Dygraph.removeEvent(window,'resize',this.resizeHandler_);
1011 this.resizeHandler_ = null;
1012
4cfcc38c
DV
1013 removeRecursive(this.maindiv_);
1014
1015 var nullOut = function(obj) {
1016 for (var n in obj) {
1017 if (typeof(obj[n]) === 'object') {
1018 obj[n] = null;
1019 }
1020 }
1021 };
4cfcc38c
DV
1022 // These may not all be necessary, but it can't hurt...
1023 nullOut(this.layout_);
1024 nullOut(this.plotter_);
1025 nullOut(this);
1026};
6a1aa64f
DV
1027
1028/**
629a09ae
DV
1029 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1030 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1031 * or the zoom rectangles) is done on this.canvas_.
8846615a 1032 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
6a1aa64f
DV
1033 * @return {Object} The newly-created canvas
1034 * @private
1035 */
285a6bda 1036Dygraph.prototype.createPlotKitCanvas_ = function(canvas) {
f8cfec73 1037 var h = Dygraph.createCanvas();
6a1aa64f 1038 h.style.position = "absolute";
9ac5e4ae
DV
1039 // TODO(danvk): h should be offset from canvas. canvas needs to include
1040 // some extra area to make it easier to zoom in on the far left and far
1041 // right. h needs to be precisely the plot area, so that clipping occurs.
6a1aa64f
DV
1042 h.style.top = canvas.style.top;
1043 h.style.left = canvas.style.left;
1044 h.width = this.width_;
1045 h.height = this.height_;
f8cfec73
DV
1046 h.style.width = this.width_ + "px"; // for IE
1047 h.style.height = this.height_ + "px"; // for IE
6a1aa64f
DV
1048 return h;
1049};
1050
629a09ae 1051/**
920208fb
PF
1052 * Creates an overlay element used to handle mouse events.
1053 * @return {Object} The mouse event element.
1054 * @private
1055 */
1056Dygraph.prototype.createMouseEventElement_ = function() {
1057 if (this.isUsingExcanvas_) {
1058 var elem = document.createElement("div");
1059 elem.style.position = 'absolute';
1060 elem.style.backgroundColor = 'white';
1061 elem.style.filter = 'alpha(opacity=0)';
1062 elem.style.width = this.width_ + "px";
1063 elem.style.height = this.height_ + "px";
1064 this.graphDiv.appendChild(elem);
1065 return elem;
1066 } else {
1067 return this.canvas_;
1068 }
1069};
1070
1071/**
6a1aa64f
DV
1072 * Generate a set of distinct colors for the data series. This is done with a
1073 * color wheel. Saturation/Value are customizable, and the hue is
1074 * equally-spaced around the color wheel. If a custom set of colors is
1075 * specified, that is used instead.
6a1aa64f
DV
1076 * @private
1077 */
285a6bda 1078Dygraph.prototype.setColors_ = function() {
ee53deb9
DV
1079 var labels = this.getLabels();
1080 var num = labels.length - 1;
6a1aa64f 1081 this.colors_ = [];
ee53deb9 1082 this.colorsMap_ = {};
285a6bda 1083 var colors = this.attr_('colors');
758a629f 1084 var i;
285a6bda
DV
1085 if (!colors) {
1086 var sat = this.attr_('colorSaturation') || 1.0;
1087 var val = this.attr_('colorValue') || 0.5;
2aa21213 1088 var half = Math.ceil(num / 2);
758a629f 1089 for (i = 1; i <= num; i++) {
ec1959eb 1090 if (!this.visibility()[i-1]) continue;
43af96e7 1091 // alternate colors for high contrast.
2aa21213 1092 var idx = i % 2 ? Math.ceil(i / 2) : (half + i / 2);
43af96e7 1093 var hue = (1.0 * idx/ (1 + num));
ee53deb9
DV
1094 var colorStr = Dygraph.hsvToRGB(hue, sat, val);
1095 this.colors_.push(colorStr);
1096 this.colorsMap_[labels[i]] = colorStr;
6a1aa64f
DV
1097 }
1098 } else {
758a629f 1099 for (i = 0; i < num; i++) {
ec1959eb 1100 if (!this.visibility()[i]) continue;
285a6bda 1101 var colorStr = colors[i % colors.length];
f474c2a3 1102 this.colors_.push(colorStr);
ee53deb9 1103 this.colorsMap_[labels[1 + i]] = colorStr;
6a1aa64f
DV
1104 }
1105 }
629a09ae 1106};
6a1aa64f 1107
43af96e7
NK
1108/**
1109 * Return the list of colors. This is either the list of colors passed in the
629a09ae 1110 * attributes or the autogenerated list of rgb(r,g,b) strings.
e2c21500 1111 * This does not return colors for invisible series.
43af96e7
NK
1112 * @return {Array<string>} The list of colors.
1113 */
1114Dygraph.prototype.getColors = function() {
1115 return this.colors_;
1116};
1117
6a1aa64f 1118/**
e2c21500
DV
1119 * Returns a few attributes of a series, i.e. its color, its visibility, which
1120 * axis it's assigned to, and its column in the original data.
1121 * Returns null if the series does not exist.
1122 * Otherwise, returns an object with column, visibility, color and axis properties.
1123 * The "axis" property will be set to 1 for y1 and 2 for y2.
1124 * The "column" property can be fed back into getValue(row, column) to get
1125 * values for this series.
6a1aa64f 1126 */
e2c21500
DV
1127Dygraph.prototype.getPropertiesForSeries = function(series_name) {
1128 var idx = -1;
1129 var labels = this.getLabels();
1130 for (var i = 1; i < labels.length; i++) {
1131 if (labels[i] == series_name) {
1132 idx = i;
1133 break;
b0c3b730 1134 }
6a1aa64f 1135 }
e2c21500 1136 if (idx == -1) return null;
0abfbd7e 1137
e2c21500
DV
1138 return {
1139 name: series_name,
1140 column: idx,
1141 visible: this.visibility()[idx - 1],
189f8030 1142 color: this.colorsMap_[series_name],
16f00742 1143 axis: 1 + this.attributes_.axisForSeries(series_name)
e2c21500 1144 };
0abfbd7e
DV
1145};
1146
1147/**
6a1aa64f 1148 * Create the text box to adjust the averaging period
6a1aa64f
DV
1149 * @private
1150 */
285a6bda 1151Dygraph.prototype.createRollInterface_ = function() {
8c69de65
DV
1152 // Create a roller if one doesn't exist already.
1153 if (!this.roller_) {
1154 this.roller_ = document.createElement("input");
1155 this.roller_.type = "text";
1156 this.roller_.style.display = "none";
1157 this.graphDiv.appendChild(this.roller_);
1158 }
1159
1160 var display = this.attr_('showRoller') ? 'block' : 'none';
26ca7938 1161
0c38f187 1162 var area = this.plotter_.area;
b0c3b730
DV
1163 var textAttr = { "position": "absolute",
1164 "zIndex": 10,
0c38f187
DV
1165 "top": (area.y + area.h - 25) + "px",
1166 "left": (area.x + 1) + "px",
b0c3b730 1167 "display": display
6a1aa64f 1168 };
8c69de65
DV
1169 this.roller_.size = "2";
1170 this.roller_.value = this.rollPeriod_;
b0c3b730 1171 for (var name in textAttr) {
85b99f0b 1172 if (textAttr.hasOwnProperty(name)) {
8c69de65 1173 this.roller_.style[name] = textAttr[name];
85b99f0b 1174 }
b0c3b730
DV
1175 }
1176
76171648 1177 var dygraph = this;
8c69de65 1178 this.roller_.onchange = function() { dygraph.adjustRoll(dygraph.roller_.value); };
76171648
DV
1179};
1180
629a09ae
DV
1181/**
1182 * @private
629a09ae
DV
1183 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1184 * canvas (i.e. DOM Coords).
1185 */
062ef401 1186Dygraph.prototype.dragGetX_ = function(e, context) {
758a629f 1187 return Dygraph.pageX(e) - context.px;
062ef401 1188};
bce01b0f 1189
629a09ae
DV
1190/**
1191 * @private
1192 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1193 * canvas (i.e. DOM Coords).
1194 */
062ef401 1195Dygraph.prototype.dragGetY_ = function(e, context) {
758a629f 1196 return Dygraph.pageY(e) - context.py;
062ef401 1197};
ee672584 1198
629a09ae 1199/**
062ef401
JB
1200 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1201 * events.
1202 * @private
1203 */
1204Dygraph.prototype.createDragInterface_ = function() {
1205 var context = {
1206 // Tracks whether the mouse is down right now
1207 isZooming: false,
1208 isPanning: false, // is this drag part of a pan?
1209 is2DPan: false, // if so, is that pan 1- or 2-dimensional?
8442269f
RK
1210 dragStartX: null, // pixel coordinates
1211 dragStartY: null, // pixel coordinates
1212 dragEndX: null, // pixel coordinates
1213 dragEndY: null, // pixel coordinates
062ef401 1214 dragDirection: null,
8442269f
RK
1215 prevEndX: null, // pixel coordinates
1216 prevEndY: null, // pixel coordinates
062ef401 1217 prevDragDirection: null,
421f1773 1218 cancelNextDblclick: false, // see comment in dygraph-interaction-model.js
062ef401 1219
ec291cbe
RK
1220 // The value on the left side of the graph when a pan operation starts.
1221 initialLeftmostDate: null,
1222
1223 // The number of units each pixel spans. (This won't be valid for log
1224 // scales)
1225 xUnitsPerPixel: null,
062ef401
JB
1226
1227 // TODO(danvk): update this comment
1228 // The range in second/value units that the viewport encompasses during a
1229 // panning operation.
1230 dateRange: null,
1231
8442269f
RK
1232 // Top-left corner of the canvas, in DOM coords
1233 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
062ef401
JB
1234 px: 0,
1235 py: 0,
1236
965a030e 1237 // Values for use with panEdgeFraction, which limit how far outside the
4cac8c7a
RK
1238 // graph's data boundaries it can be panned.
1239 boundedDates: null, // [minDate, maxDate]
1240 boundedValues: null, // [[minValue, maxValue] ...]
1241
2bad4d92
DV
1242 // We cover iframes during mouse interactions. See comments in
1243 // dygraph-utils.js for more info on why this is a good idea.
1244 tarp: new Dygraph.IFrameTarp(),
1245
6a4587ac
RK
1246 // contextB is the same thing as this context object but renamed.
1247 initializeMouseDown: function(event, g, contextB) {
062ef401
JB
1248 // prevents mouse drags from selecting page text.
1249 if (event.preventDefault) {
1250 event.preventDefault(); // Firefox, Chrome, etc.
6a1aa64f 1251 } else {
062ef401
JB
1252 event.returnValue = false; // IE
1253 event.cancelBubble = true;
6a1aa64f
DV
1254 }
1255
6a4587ac
RK
1256 contextB.px = Dygraph.findPosX(g.canvas_);
1257 contextB.py = Dygraph.findPosY(g.canvas_);
1258 contextB.dragStartX = g.dragGetX_(event, contextB);
1259 contextB.dragStartY = g.dragGetY_(event, contextB);
1260 contextB.cancelNextDblclick = false;
2bad4d92 1261 contextB.tarp.cover();
6a1aa64f 1262 }
062ef401 1263 };
2b188b3d 1264
062ef401 1265 var interactionModel = this.attr_("interactionModel");
8b83c6cc 1266
062ef401
JB
1267 // Self is the graph.
1268 var self = this;
6faebb69 1269
062ef401
JB
1270 // Function that binds the graph and context to the handler.
1271 var bindHandler = function(handler) {
1272 return function(event) {
1273 handler(event, self, context);
1274 };
1275 };
1276
1277 for (var eventName in interactionModel) {
1278 if (!interactionModel.hasOwnProperty(eventName)) continue;
6a4587ac 1279 this.addEvent(this.mouseEventElement_, eventName,
062ef401
JB
1280 bindHandler(interactionModel[eventName]));
1281 }
1282
8d970428 1283 // unregister the handler on subsequent calls.
1284 // This happens when the graph is resized.
1285 if (this.mouseUpHandler_) {
1286 Dygraph.removeEvent(document, 'mouseup', this.mouseUpHandler_);
81ce4529 1287 }
8d970428 1288
062ef401
JB
1289 // If the user releases the mouse button during a drag, but not over the
1290 // canvas, then it doesn't count as a zooming action.
cb1261cb 1291 this.mouseUpHandler_ = function(event) {
062ef401
JB
1292 if (context.isZooming || context.isPanning) {
1293 context.isZooming = false;
1294 context.dragStartX = null;
1295 context.dragStartY = null;
1296 }
1297
1298 if (context.isPanning) {
1299 context.isPanning = false;
1300 context.draggingDate = null;
1301 context.dateRange = null;
1302 for (var i = 0; i < self.axes_.length; i++) {
1303 delete self.axes_[i].draggingValue;
1304 delete self.axes_[i].dragValueRange;
1305 }
1306 }
2bad4d92
DV
1307
1308 context.tarp.uncover();
cb1261cb
DV
1309 };
1310
bc3e2c5d 1311 this.addEvent(document, 'mouseup', this.mouseUpHandler_);
6a1aa64f
DV
1312};
1313
1314/**
1315 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1316 * up any previous zoom rectangles that were drawn. This could be optimized to
1317 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1318 * dots.
ccd9d7c2 1319 *
39b0e098
RK
1320 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1321 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
6a1aa64f
DV
1322 * @param {Number} startX The X position where the drag started, in canvas
1323 * coordinates.
1324 * @param {Number} endX The current X position of the drag, in canvas coords.
8b83c6cc
RK
1325 * @param {Number} startY The Y position where the drag started, in canvas
1326 * coordinates.
1327 * @param {Number} endY The current Y position of the drag, in canvas coords.
39b0e098 1328 * @param {Number} prevDirection the value of direction on the previous call to
8b83c6cc 1329 * this function. Used to avoid excess redrawing
6a1aa64f
DV
1330 * @param {Number} prevEndX The value of endX on the previous call to this
1331 * function. Used to avoid excess redrawing
8b83c6cc
RK
1332 * @param {Number} prevEndY The value of endY on the previous call to this
1333 * function. Used to avoid excess redrawing
6a1aa64f
DV
1334 * @private
1335 */
7201b11e
JB
1336Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY,
1337 endY, prevDirection, prevEndX,
1338 prevEndY) {
2cf95fff 1339 var ctx = this.canvas_ctx_;
6a1aa64f
DV
1340
1341 // Clean up from the previous rect if necessary
39b0e098 1342 if (prevDirection == Dygraph.HORIZONTAL) {
fa54c193
FXB
1343 ctx.clearRect(Math.min(startX, prevEndX), this.layout_.getPlotArea().y,
1344 Math.abs(startX - prevEndX), this.layout_.getPlotArea().h);
39b0e098 1345 } else if (prevDirection == Dygraph.VERTICAL){
fa54c193
FXB
1346 ctx.clearRect(this.layout_.getPlotArea().x, Math.min(startY, prevEndY),
1347 this.layout_.getPlotArea().w, Math.abs(startY - prevEndY));
6a1aa64f
DV
1348 }
1349
1350 // Draw a light-grey rectangle to show the new viewing area
39b0e098 1351 if (direction == Dygraph.HORIZONTAL) {
8b83c6cc
RK
1352 if (endX && startX) {
1353 ctx.fillStyle = "rgba(128,128,128,0.33)";
fa54c193
FXB
1354 ctx.fillRect(Math.min(startX, endX), this.layout_.getPlotArea().y,
1355 Math.abs(endX - startX), this.layout_.getPlotArea().h);
8b83c6cc 1356 }
920208fb 1357 } else if (direction == Dygraph.VERTICAL) {
8b83c6cc
RK
1358 if (endY && startY) {
1359 ctx.fillStyle = "rgba(128,128,128,0.33)";
fa54c193
FXB
1360 ctx.fillRect(this.layout_.getPlotArea().x, Math.min(startY, endY),
1361 this.layout_.getPlotArea().w, Math.abs(endY - startY));
8b83c6cc 1362 }
6a1aa64f 1363 }
920208fb
PF
1364
1365 if (this.isUsingExcanvas_) {
1366 this.currentZoomRectArgs_ = [direction, startX, endX, startY, endY, 0, 0, 0];
1367 }
1368};
1369
1370/**
1371 * Clear the zoom rectangle (and perform no zoom).
1372 * @private
1373 */
1374Dygraph.prototype.clearZoomRect_ = function() {
1375 this.currentZoomRectArgs_ = null;
1376 this.canvas_ctx_.clearRect(0, 0, this.canvas_.width, this.canvas_.height);
6a1aa64f
DV
1377};
1378
1379/**
8b83c6cc
RK
1380 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1381 * the canvas. The exact zoom window may be slightly larger if there are no data
1382 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1383 * which accepts dates that match the raw data. This function redraws the graph.
d58ae307 1384 *
6a1aa64f
DV
1385 * @param {Number} lowX The leftmost pixel value that should be visible.
1386 * @param {Number} highX The rightmost pixel value that should be visible.
1387 * @private
1388 */
8b83c6cc 1389Dygraph.prototype.doZoomX_ = function(lowX, highX) {
920208fb 1390 this.currentZoomRectArgs_ = null;
6a1aa64f 1391 // Find the earliest and latest dates contained in this canvasx range.
8b83c6cc 1392 // Convert the call to date ranges of the raw data.
ff022deb
RK
1393 var minDate = this.toDataXCoord(lowX);
1394 var maxDate = this.toDataXCoord(highX);
8b83c6cc
RK
1395 this.doZoomXDates_(minDate, maxDate);
1396};
6a1aa64f 1397
8b83c6cc 1398/**
b1a3b195
DV
1399 * Transition function to use in animations. Returns values between 0.0
1400 * (totally old values) and 1.0 (totally new values) for each frame.
1401 * @private
1402 */
1403Dygraph.zoomAnimationFunction = function(frame, numFrames) {
1404 var k = 1.5;
1405 return (1.0 - Math.pow(k, -frame)) / (1.0 - Math.pow(k, -numFrames));
1406};
1407
1408/**
8b83c6cc
RK
1409 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1410 * method with doZoomX which accepts pixel coordinates. This function redraws
1411 * the graph.
d58ae307 1412 *
8b83c6cc
RK
1413 * @param {Number} minDate The minimum date that should be visible.
1414 * @param {Number} maxDate The maximum date that should be visible.
1415 * @private
1416 */
1417Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
b1a3b195
DV
1418 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1419 // can produce strange effects. Rather than the y-axis transitioning slowly
1420 // between values, it can jerk around.)
1421 var old_window = this.xAxisRange();
1422 var new_window = [minDate, maxDate];
57baab03 1423 this.zoomed_x_ = true;
b1a3b195
DV
1424 var that = this;
1425 this.doAnimatedZoom(old_window, new_window, null, null, function() {
1426 if (that.attr_("zoomCallback")) {
1427 that.attr_("zoomCallback")(minDate, maxDate, that.yAxisRanges());
1428 }
1429 });
8b83c6cc
RK
1430};
1431
1432/**
1433 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
d58ae307
DV
1434 * the canvas. This function redraws the graph.
1435 *
8b83c6cc
RK
1436 * @param {Number} lowY The topmost pixel value that should be visible.
1437 * @param {Number} highY The lowest pixel value that should be visible.
1438 * @private
1439 */
1440Dygraph.prototype.doZoomY_ = function(lowY, highY) {
920208fb 1441 this.currentZoomRectArgs_ = null;
d58ae307
DV
1442 // Find the highest and lowest values in pixel range for each axis.
1443 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1444 // This is because pixels increase as you go down on the screen, whereas data
1445 // coordinates increase as you go up the screen.
b1a3b195
DV
1446 var oldValueRanges = this.yAxisRanges();
1447 var newValueRanges = [];
d58ae307 1448 for (var i = 0; i < this.axes_.length; i++) {
ff022deb
RK
1449 var hi = this.toDataYCoord(lowY, i);
1450 var low = this.toDataYCoord(highY, i);
b1a3b195 1451 newValueRanges.push([low, hi]);
d58ae307 1452 }
8b83c6cc 1453
57baab03 1454 this.zoomed_y_ = true;
b1a3b195
DV
1455 var that = this;
1456 this.doAnimatedZoom(null, null, oldValueRanges, newValueRanges, function() {
1457 if (that.attr_("zoomCallback")) {
1458 var xRange = that.xAxisRange();
b1a3b195
DV
1459 that.attr_("zoomCallback")(xRange[0], xRange[1], that.yAxisRanges());
1460 }
1461 });
8b83c6cc
RK
1462};
1463
1464/**
1465 * Reset the zoom to the original view coordinates. This is the same as
1466 * double-clicking on the graph.
8b83c6cc 1467 */
e4f6e11a 1468Dygraph.prototype.resetZoom = function() {
b1a3b195 1469 var dirty = false, dirtyX = false, dirtyY = false;
758a629f 1470 if (this.dateWindow_ !== null) {
d58ae307 1471 dirty = true;
b1a3b195 1472 dirtyX = true;
8b83c6cc 1473 }
d58ae307
DV
1474
1475 for (var i = 0; i < this.axes_.length; i++) {
1f6a6254 1476 if (typeof(this.axes_[i].valueWindow) !== 'undefined' && this.axes_[i].valueWindow !== null) {
d58ae307 1477 dirty = true;
b1a3b195 1478 dirtyY = true;
d58ae307 1479 }
8b83c6cc
RK
1480 }
1481
da1369a5
DV
1482 // Clear any selection, since it's likely to be drawn in the wrong place.
1483 this.clearSelection();
1484
8b83c6cc 1485 if (dirty) {
57baab03
NN
1486 this.zoomed_x_ = false;
1487 this.zoomed_y_ = false;
b1a3b195
DV
1488
1489 var minDate = this.rawData_[0][0];
1490 var maxDate = this.rawData_[this.rawData_.length - 1][0];
1491
1492 // With only one frame, don't bother calculating extreme ranges.
1493 // TODO(danvk): merge this block w/ the code below.
1494 if (!this.attr_("animatedZooms")) {
1495 this.dateWindow_ = null;
758a629f
DV
1496 for (i = 0; i < this.axes_.length; i++) {
1497 if (this.axes_[i].valueWindow !== null) {
b1a3b195
DV
1498 delete this.axes_[i].valueWindow;
1499 }
1500 }
1501 this.drawGraph_();
1502 if (this.attr_("zoomCallback")) {
1503 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1504 }
1505 return;
1506 }
1507
1508 var oldWindow=null, newWindow=null, oldValueRanges=null, newValueRanges=null;
1509 if (dirtyX) {
1510 oldWindow = this.xAxisRange();
1511 newWindow = [minDate, maxDate];
1512 }
1513
1514 if (dirtyY) {
1515 oldValueRanges = this.yAxisRanges();
1516 // TODO(danvk): this is pretty inefficient
1517 var packed = this.gatherDatasets_(this.rolledSeries_, null);
1518 var extremes = packed[1];
1519
1520 // this has the side-effect of modifying this.axes_.
1521 // this doesn't make much sense in this context, but it's convenient (we
1522 // need this.axes_[*].extremeValues) and not harmful since we'll be
1523 // calling drawGraph_ shortly, which clobbers these values.
1524 this.computeYAxisRanges_(extremes);
1525
1526 newValueRanges = [];
758a629f 1527 for (i = 0; i < this.axes_.length; i++) {
1f6a6254 1528 var axis = this.axes_[i];
681a215e
DV
1529 newValueRanges.push((axis.valueRange !== null &&
1530 axis.valueRange !== undefined) ?
42a9ebb8 1531 axis.valueRange : axis.extremeRange);
b1a3b195
DV
1532 }
1533 }
1534
1535 var that = this;
1536 this.doAnimatedZoom(oldWindow, newWindow, oldValueRanges, newValueRanges,
1537 function() {
1538 that.dateWindow_ = null;
1539 for (var i = 0; i < that.axes_.length; i++) {
758a629f 1540 if (that.axes_[i].valueWindow !== null) {
b1a3b195
DV
1541 delete that.axes_[i].valueWindow;
1542 }
1543 }
1544 if (that.attr_("zoomCallback")) {
1545 that.attr_("zoomCallback")(minDate, maxDate, that.yAxisRanges());
1546 }
1547 });
1548 }
1549};
1550
1551/**
1552 * Combined animation logic for all zoom functions.
1553 * either the x parameters or y parameters may be null.
1554 * @private
1555 */
1556Dygraph.prototype.doAnimatedZoom = function(oldXRange, newXRange, oldYRanges, newYRanges, callback) {
1557 var steps = this.attr_("animatedZooms") ? Dygraph.ANIMATION_STEPS : 1;
1558
1559 var windows = [];
1560 var valueRanges = [];
758a629f 1561 var step, frac;
b1a3b195 1562
758a629f
DV
1563 if (oldXRange !== null && newXRange !== null) {
1564 for (step = 1; step <= steps; step++) {
1565 frac = Dygraph.zoomAnimationFunction(step, steps);
b1a3b195
DV
1566 windows[step-1] = [oldXRange[0]*(1-frac) + frac*newXRange[0],
1567 oldXRange[1]*(1-frac) + frac*newXRange[1]];
8b83c6cc 1568 }
67e650dc 1569 }
b1a3b195 1570
758a629f
DV
1571 if (oldYRanges !== null && newYRanges !== null) {
1572 for (step = 1; step <= steps; step++) {
1573 frac = Dygraph.zoomAnimationFunction(step, steps);
b1a3b195
DV
1574 var thisRange = [];
1575 for (var j = 0; j < this.axes_.length; j++) {
1576 thisRange.push([oldYRanges[j][0]*(1-frac) + frac*newYRanges[j][0],
1577 oldYRanges[j][1]*(1-frac) + frac*newYRanges[j][1]]);
1578 }
1579 valueRanges[step-1] = thisRange;
1580 }
1581 }
1582
1583 var that = this;
1584 Dygraph.repeatAndCleanup(function(step) {
1585 if (valueRanges.length) {
1586 for (var i = 0; i < that.axes_.length; i++) {
1587 var w = valueRanges[step][i];
1588 that.axes_[i].valueWindow = [w[0], w[1]];
1589 }
1590 }
1591 if (windows.length) {
1592 that.dateWindow_ = windows[step];
1593 }
1594 that.drawGraph_();
1595 }, steps, Dygraph.ANIMATION_DURATION / steps, callback);
6a1aa64f
DV
1596};
1597
1598/**
857a6931
KW
1599 * Get the current graph's area object.
1600 *
1601 * Returns: {x, y, w, h}
6a1aa64f 1602 */
857a6931
KW
1603Dygraph.prototype.getArea = function() {
1604 return this.plotter_.area;
1605};
e863a17d 1606
857a6931
KW
1607/**
1608 * Convert a mouse event to DOM coordinates relative to the graph origin.
1609 *
1610 * Returns a two-element array: [X, Y].
1611 */
1612Dygraph.prototype.eventToDomCoords = function(event) {
4cac8c7a 1613 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
857a6931
KW
1614 var canvasy = Dygraph.pageY(event) - Dygraph.findPosY(this.mouseEventElement_);
1615 return [canvasx, canvasy];
1616};
4cac8c7a 1617
857a6931
KW
1618/**
1619 * Given a canvas X coordinate, find the closest row.
1620 * @param {Number} domX graph-relative DOM X coordinate
1621 * Returns: row number, integer
1622 * @private
1623 */
1624Dygraph.prototype.findClosestRow = function(domX) {
81cb07d6 1625 var minDistX = Infinity;
a12a78ae
DV
1626 var pointIdx = -1, setIdx = -1;
1627 var sets = this.layout_.points;
1628 for (var i = 0; i < sets.length; i++) {
1629 var points = sets[i];
1630 var len = points.length;
1631 for (var j = 0; j < len; j++) {
1632 var point = points[j];
1633 if (!Dygraph.isValidPoint(point, true)) continue;
1634 var dist = Math.abs(point.canvasx - domX);
1635 if (dist < minDistX) {
1636 minDistX = dist;
1637 setIdx = i;
1638 pointIdx = j;
1639 }
a937d031 1640 }
6a1aa64f 1641 }
a12a78ae
DV
1642
1643 // TODO(danvk): remove this function; it's trivial and has only one use.
1644 return this.idxToRow_(setIdx, pointIdx);
857a6931 1645};
6a1aa64f 1646
857a6931 1647/**
2a02e5dd
KW
1648 * Given canvas X,Y coordinates, find the closest point.
1649 *
1650 * This finds the individual data point across all visible series
1651 * that's closest to the supplied DOM coordinates using the standard
1652 * Euclidean X,Y distance.
1653 *
857a6931
KW
1654 * @param {Number} domX graph-relative DOM X coordinate
1655 * @param {Number} domY graph-relative DOM Y coordinate
1656 * Returns: {row, seriesName, point}
1657 * @private
1658 */
1659Dygraph.prototype.findClosestPoint = function(domX, domY) {
81cb07d6 1660 var minDist = Infinity;
857a6931 1661 var idx = -1;
857a6931 1662 var dist, dx, dy, point, closestPoint, closestSeries;
cc825c7b 1663 for ( var setIdx = this.layout_.datasets.length - 1 ; setIdx >= 0 ; --setIdx ) {
a12a78ae
DV
1664 var points = this.layout_.points[setIdx];
1665 for (var i = 0; i < points.length; ++i) {
1666 var point = points[i];
62c3d2fd 1667 if (!Dygraph.isValidPoint(point)) continue;
857a6931
KW
1668 dx = point.canvasx - domX;
1669 dy = point.canvasy - domY;
1670 dist = dx * dx + dy * dy;
81cb07d6 1671 if (dist < minDist) {
62c3d2fd 1672 minDist = dist;
a937d031
KW
1673 closestPoint = point;
1674 closestSeries = setIdx;
1675 idx = i;
1676 }
857a6931
KW
1677 }
1678 }
1679 var name = this.layout_.setNames[closestSeries];
1680 return {
81cb07d6 1681 row: idx + this.getLeftBoundary_(),
857a6931
KW
1682 seriesName: name,
1683 point: closestPoint
1684 };
1685};
1686
1687/**
1688 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
2a02e5dd
KW
1689 *
1690 * This first finds the X data point closest to the supplied DOM X coordinate,
1691 * then finds the series which puts the Y coordinate on top of its filled area,
1692 * using linear interpolation between adjacent point pairs.
1693 *
857a6931
KW
1694 * @param {Number} domX graph-relative DOM X coordinate
1695 * @param {Number} domY graph-relative DOM Y coordinate
1696 * Returns: {row, seriesName, point}
1697 * @private
1698 */
1699Dygraph.prototype.findStackedPoint = function(domX, domY) {
1700 var row = this.findClosestRow(domX);
81cb07d6
KW
1701 var boundary = this.getLeftBoundary_();
1702 var rowIdx = row - boundary;
857a6931
KW
1703 var closestPoint, closestSeries;
1704 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
a12a78ae
DV
1705 var points = this.layout_.points[setIdx];
1706 if (rowIdx >= points.length) continue;
1707 var p1 = points[rowIdx];
62c3d2fd 1708 if (!Dygraph.isValidPoint(p1)) continue;
857a6931 1709 var py = p1.canvasy;
a12a78ae 1710 if (domX > p1.canvasx && rowIdx + 1 < points.length) {
857a6931 1711 // interpolate series Y value using next point
a12a78ae 1712 var p2 = points[rowIdx + 1];
62c3d2fd
KW
1713 if (Dygraph.isValidPoint(p2)) {
1714 var dx = p2.canvasx - p1.canvasx;
1715 if (dx > 0) {
1716 var r = (domX - p1.canvasx) / dx;
1717 py += r * (p2.canvasy - p1.canvasy);
1718 }
416b05ad 1719 }
81cb07d6 1720 } else if (domX < p1.canvasx && rowIdx > 0) {
857a6931 1721 // interpolate series Y value using previous point
a12a78ae 1722 var p0 = points[rowIdx - 1];
62c3d2fd
KW
1723 if (Dygraph.isValidPoint(p0)) {
1724 var dx = p1.canvasx - p0.canvasx;
1725 if (dx > 0) {
1726 var r = (p1.canvasx - domX) / dx;
1727 py += r * (p0.canvasy - p1.canvasy);
1728 }
12e4c741 1729 }
6a1aa64f 1730 }
857a6931 1731 // Stop if the point (domX, py) is above this series' upper edge
42a9ebb8 1732 if (setIdx === 0 || py < domY) {
a937d031
KW
1733 closestPoint = p1;
1734 closestSeries = setIdx;
1735 }
6a1aa64f 1736 }
857a6931
KW
1737 var name = this.layout_.setNames[closestSeries];
1738 return {
1739 row: row,
1740 seriesName: name,
1741 point: closestPoint
1742 };
1743};
6a1aa64f 1744
857a6931 1745/**
6a1aa64f
DV
1746 * When the mouse moves in the canvas, display information about a nearby data
1747 * point and draw dots over those points in the data series. This function
1748 * takes care of cleanup of previously-drawn dots.
1749 * @param {Object} event The mousemove event from the browser.
1750 * @private
1751 */
285a6bda 1752Dygraph.prototype.mouseMove_ = function(event) {
e863a17d 1753 // This prevents JS errors when mousing over the canvas before data loads.
4cac8c7a 1754 var points = this.layout_.points;
a12a78ae 1755 if (points === undefined || points === null) return;
e863a17d 1756
857a6931
KW
1757 var canvasCoords = this.eventToDomCoords(event);
1758 var canvasx = canvasCoords[0];
1759 var canvasy = canvasCoords[1];
6a1aa64f 1760
857a6931
KW
1761 var highlightSeriesOpts = this.attr_("highlightSeriesOpts");
1762 var selectionChanged = false;
3f55b813 1763 if (highlightSeriesOpts && !this.isSeriesLocked()) {
857a6931
KW
1764 var closest;
1765 if (this.attr_("stackedGraph")) {
1766 closest = this.findStackedPoint(canvasx, canvasy);
1767 } else {
1768 closest = this.findClosestPoint(canvasx, canvasy);
43af96e7 1769 }
857a6931 1770 selectionChanged = this.setSelection(closest.row, closest.seriesName);
416b05ad 1771 } else {
857a6931
KW
1772 var idx = this.findClosestRow(canvasx);
1773 selectionChanged = this.setSelection(idx);
12e4c741 1774 }
43af96e7 1775
857a6931
KW
1776 var callback = this.attr_("highlightCallback");
1777 if (callback && selectionChanged) {
1778 callback(event, this.lastx_, this.selPoints_, this.lastRow_, this.highlightSet_);
12e4c741 1779 }
239c712d 1780};
b258a3da 1781
239c712d 1782/**
81cb07d6 1783 * Fetch left offset from first defined boundaryIds record (see bug #236).
e2c21500 1784 * @private
81cb07d6
KW
1785 */
1786Dygraph.prototype.getLeftBoundary_ = function() {
1787 for (var i = 0; i < this.boundaryIds_.length; i++) {
1788 if (this.boundaryIds_[i] !== undefined) {
1789 return this.boundaryIds_[i][0];
1790 }
1791 }
1792 return 0;
1793};
1794
1795/**
1903f1e4 1796 * Transforms layout_.points index into data row number.
2ddb1197 1797 * @param int layout_.points index
1903f1e4 1798 * @return int row number, or -1 if none could be found.
2ddb1197
SC
1799 * @private
1800 */
a12a78ae
DV
1801Dygraph.prototype.idxToRow_ = function(setIdx, rowIdx) {
1802 if (rowIdx < 0) return -1;
2ddb1197 1803
81cb07d6 1804 var boundary = this.getLeftBoundary_();
a12a78ae
DV
1805 return boundary + rowIdx;
1806 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1807 // var set = this.layout_.datasets[setIdx];
1808 // if (idx < set.length) {
1809 // return boundary + idx;
1810 // }
1811 // idx -= set.length;
1812 // }
1813 // return -1;
1903f1e4 1814};
2ddb1197 1815
857a6931
KW
1816Dygraph.prototype.animateSelection_ = function(direction) {
1817 var totalSteps = 10;
1818 var millis = 30;
1d44ee5e
KW
1819 if (this.fadeLevel === undefined) this.fadeLevel = 0;
1820 if (this.animateId === undefined) this.animateId = 0;
857a6931
KW
1821 var start = this.fadeLevel;
1822 var steps = direction < 0 ? start : totalSteps - start;
1823 if (steps <= 0) {
1824 if (this.fadeLevel) {
1825 this.updateSelection_(1.0);
1826 }
1827 return;
1828 }
1829
1830 var thisId = ++this.animateId;
1831 var that = this;
475f7420
KW
1832 Dygraph.repeatAndCleanup(
1833 function(n) {
1834 // ignore simultaneous animations
1835 if (that.animateId != thisId) return;
1836
1837 that.fadeLevel += direction;
1838 if (that.fadeLevel === 0) {
1839 that.clearSelection();
1840 } else {
1841 that.updateSelection_(that.fadeLevel / totalSteps);
1842 }
1843 },
1844 steps, millis, function() {});
857a6931
KW
1845};
1846
2ddb1197 1847/**
239c712d
NAG
1848 * Draw dots over the selectied points in the data series. This function
1849 * takes care of cleanup of previously-drawn dots.
1850 * @private
1851 */
857a6931 1852Dygraph.prototype.updateSelection_ = function(opt_animFraction) {
0cd1ad15
DV
1853 /*var defaultPrevented = */
1854 this.cascadeEvents_('select', {
e2c21500
DV
1855 selectedX: this.lastx_,
1856 selectedPoints: this.selPoints_
1857 });
1858 // TODO(danvk): use defaultPrevented here?
1859
6a1aa64f 1860 // Clear the previously drawn vertical, if there is one
758a629f 1861 var i;
2cf95fff 1862 var ctx = this.canvas_ctx_;
857a6931
KW
1863 if (this.attr_('highlightSeriesOpts')) {
1864 ctx.clearRect(0, 0, this.width_, this.height_);
afdb20d8 1865 var alpha = 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
857a6931 1866 if (alpha) {
2a02e5dd
KW
1867 // Activating background fade includes an animation effect for a gradual
1868 // fade. TODO(klausw): make this independently configurable if it causes
1869 // issues? Use a shared preference to control animations?
1870 var animateBackgroundFade = true;
1871 if (animateBackgroundFade) {
857a6931
KW
1872 if (opt_animFraction === undefined) {
1873 // start a new animation
1874 this.animateSelection_(1);
1875 return;
1876 }
1877 alpha *= opt_animFraction;
1878 }
1879 ctx.fillStyle = 'rgba(255,255,255,' + alpha + ')';
1880 ctx.fillRect(0, 0, this.width_, this.height_);
1881 }
38e3d209
DV
1882
1883 // Redraw only the highlighted series in the interactive canvas (not the
1884 // static plot canvas, which is where series are usually drawn).
1885 this.plotter_._renderLineChart(this.highlightSet_, ctx);
857a6931 1886 } else if (this.previousVerticalX_ >= 0) {
46dde5f9
DV
1887 // Determine the maximum highlight circle size.
1888 var maxCircleSize = 0;
227b93cc 1889 var labels = this.attr_('labels');
758a629f 1890 for (i = 1; i < labels.length; i++) {
227b93cc 1891 var r = this.attr_('highlightCircleSize', labels[i]);
46dde5f9
DV
1892 if (r > maxCircleSize) maxCircleSize = r;
1893 }
6a1aa64f 1894 var px = this.previousVerticalX_;
46dde5f9
DV
1895 ctx.clearRect(px - maxCircleSize - 1, 0,
1896 2 * maxCircleSize + 2, this.height_);
6a1aa64f
DV
1897 }
1898
920208fb
PF
1899 if (this.isUsingExcanvas_ && this.currentZoomRectArgs_) {
1900 Dygraph.prototype.drawZoomRect_.apply(this, this.currentZoomRectArgs_);
1901 }
1902
d160cc3b 1903 if (this.selPoints_.length > 0) {
6a1aa64f 1904 // Draw colored circles over the center of each selected point
e9fe4a2f 1905 var canvasx = this.selPoints_[0].canvasx;
43af96e7 1906 ctx.save();
758a629f 1907 for (i = 0; i < this.selPoints_.length; i++) {
e9fe4a2f
DV
1908 var pt = this.selPoints_[i];
1909 if (!Dygraph.isOK(pt.canvasy)) continue;
1910
1911 var circleSize = this.attr_('highlightCircleSize', pt.name);
5879307d 1912 var callback = this.attr_("drawHighlightPointCallback", pt.name);
a8ef67a8 1913 var color = this.plotter_.colors[pt.name];
78e58af4
RK
1914 if (!callback) {
1915 callback = Dygraph.Circles.DEFAULT;
1916 }
a8ef67a8
KW
1917 ctx.lineWidth = this.attr_('strokeWidth', pt.name);
1918 ctx.strokeStyle = color;
1919 ctx.fillStyle = color;
78e58af4 1920 callback(this.g, pt.name, ctx, canvasx, pt.canvasy,
a8ef67a8 1921 color, circleSize);
6a1aa64f
DV
1922 }
1923 ctx.restore();
1924
1925 this.previousVerticalX_ = canvasx;
1926 }
1927};
1928
1929/**
629a09ae
DV
1930 * Manually set the selected points and display information about them in the
1931 * legend. The selection can be cleared using clearSelection() and queried
1932 * using getSelection().
1933 * @param { Integer } row number that should be highlighted (i.e. appear with
1934 * hover dots on the chart). Set to false to clear any selection.
857a6931
KW
1935 * @param { seriesName } optional series name to highlight that series with the
1936 * the highlightSeriesOpts setting.
b9a3ece4
KW
1937 * @param { locked } optional If true, keep seriesName selected when mousing
1938 * over the graph, disabling closest-series highlighting. Call clearSelection()
1939 * to unlock it.
239c712d 1940 */
b9a3ece4 1941Dygraph.prototype.setSelection = function(row, opt_seriesName, opt_locked) {
239c712d
NAG
1942 // Extract the points we've selected
1943 this.selPoints_ = [];
50360fd0 1944
239c712d 1945 if (row !== false) {
81cb07d6 1946 row -= this.getLeftBoundary_();
16269f6e 1947 }
50360fd0 1948
857a6931 1949 var changed = false;
16269f6e 1950 if (row !== false && row >= 0) {
857a6931
KW
1951 if (row != this.lastRow_) changed = true;
1952 this.lastRow_ = row;
82c6fe4d
KW
1953 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1954 var set = this.layout_.datasets[setIdx];
1955 if (row < set.length) {
a12a78ae 1956 var point = this.layout_.points[setIdx][row];
ccd9d7c2 1957
38f33a44 1958 if (this.attr_("stackedGraph")) {
a12a78ae 1959 point = this.layout_.unstackPointAtIndex(setIdx, row);
38f33a44 1960 }
ccd9d7c2 1961
42a9ebb8 1962 if (point.yval !== null) this.selPoints_.push(point);
16269f6e 1963 }
239c712d 1964 }
857a6931
KW
1965 } else {
1966 if (this.lastRow_ >= 0) changed = true;
1967 this.lastRow_ = -1;
16269f6e 1968 }
50360fd0 1969
16269f6e 1970 if (this.selPoints_.length) {
239c712d 1971 this.lastx_ = this.selPoints_[0].xval;
239c712d 1972 } else {
857a6931 1973 this.lastx_ = -1;
239c712d
NAG
1974 }
1975
857a6931
KW
1976 if (opt_seriesName !== undefined) {
1977 if (this.highlightSet_ !== opt_seriesName) changed = true;
1978 this.highlightSet_ = opt_seriesName;
239c712d
NAG
1979 }
1980
b9a3ece4
KW
1981 if (opt_locked !== undefined) {
1982 this.lockedSet_ = opt_locked;
1983 }
1984
857a6931
KW
1985 if (changed) {
1986 this.updateSelection_(undefined);
1987 }
1988 return changed;
239c712d
NAG
1989};
1990
1991/**
6a1aa64f
DV
1992 * The mouse has left the canvas. Clear out whatever artifacts remain
1993 * @param {Object} event the mouseout event from the browser.
1994 * @private
1995 */
285a6bda 1996Dygraph.prototype.mouseOut_ = function(event) {
a4c6a67c
AV
1997 if (this.attr_("unhighlightCallback")) {
1998 this.attr_("unhighlightCallback")(event);
1999 }
2000
b9a3ece4 2001 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_) {
239c712d 2002 this.clearSelection();
43af96e7 2003 }
6a1aa64f
DV
2004};
2005
239c712d 2006/**
629a09ae
DV
2007 * Clears the current selection (i.e. points that were highlighted by moving
2008 * the mouse over the chart).
239c712d
NAG
2009 */
2010Dygraph.prototype.clearSelection = function() {
e2c21500
DV
2011 this.cascadeEvents_('deselect', {});
2012
b9a3ece4 2013 this.lockedSet_ = false;
239c712d 2014 // Get rid of the overlay data
857a6931
KW
2015 if (this.fadeLevel) {
2016 this.animateSelection_(-1);
2017 return;
2018 }
2cf95fff 2019 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
857a6931 2020 this.fadeLevel = 0;
239c712d
NAG
2021 this.selPoints_ = [];
2022 this.lastx_ = -1;
857a6931
KW
2023 this.lastRow_ = -1;
2024 this.highlightSet_ = null;
758a629f 2025};
239c712d 2026
103b7292 2027/**
629a09ae
DV
2028 * Returns the number of the currently selected row. To get data for this row,
2029 * you can use the getValue method.
2030 * @return { Integer } row number, or -1 if nothing is selected
103b7292
NAG
2031 */
2032Dygraph.prototype.getSelection = function() {
2033 if (!this.selPoints_ || this.selPoints_.length < 1) {
2034 return -1;
2035 }
50360fd0 2036
a12a78ae
DV
2037 for (var setIdx = 0; setIdx < this.layout_.points.length; setIdx++) {
2038 var points = this.layout_.points[setIdx];
2039 for (var row = 0; row < points.length; row++) {
2040 if (points[row].x == this.selPoints_[0].x) {
2041 return row + this.getLeftBoundary_();
2042 }
103b7292
NAG
2043 }
2044 }
2045 return -1;
2e1fcf1a 2046};
103b7292 2047
e2c21500
DV
2048/**
2049 * Returns the name of the currently-highlighted series.
2050 * Only available when the highlightSeriesOpts option is in use.
2051 */
857a6931
KW
2052Dygraph.prototype.getHighlightSeries = function() {
2053 return this.highlightSet_;
2054};
2055
19589a3e 2056/**
3f55b813
KW
2057 * Returns true if the currently-highlighted series was locked
2058 * via setSelection(..., seriesName, true).
2059 */
2060Dygraph.prototype.isSeriesLocked = function() {
2061 return this.lockedSet_;
2062};
2063
2064/**
6a1aa64f
DV
2065 * Fires when there's data available to be graphed.
2066 * @param {String} data Raw CSV data to be plotted
2067 * @private
2068 */
285a6bda 2069Dygraph.prototype.loadedEvent_ = function(data) {
6a1aa64f 2070 this.rawData_ = this.parseCSV_(data);
26ca7938 2071 this.predraw_();
6a1aa64f
DV
2072};
2073
6a1aa64f
DV
2074/**
2075 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2076 * @private
2077 */
285a6bda 2078Dygraph.prototype.addXTicks_ = function() {
6a1aa64f 2079 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
7201b11e 2080 var range;
6a1aa64f 2081 if (this.dateWindow_) {
7201b11e 2082 range = [this.dateWindow_[0], this.dateWindow_[1]];
6a1aa64f 2083 } else {
ccecde93 2084 range = this.xAxisExtremes();
7201b11e
JB
2085 }
2086
48e614ac
DV
2087 var xAxisOptionsView = this.optionsViewForAxis_('x');
2088 var xTicks = xAxisOptionsView('ticker')(
2089 range[0],
2090 range[1],
2091 this.width_, // TODO(danvk): should be area.width
2092 xAxisOptionsView,
2093 this);
2094 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2095 // console.log(msg);
b2c9222a 2096 this.layout_.setXTicks(xTicks);
32988383
DV
2097};
2098
629a09ae
DV
2099/**
2100 * @private
2101 * Computes the range of the data series (including confidence intervals).
2102 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2103 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2104 * @return [low, high]
2105 */
5011e7a1 2106Dygraph.prototype.extremeValues_ = function(series) {
758a629f 2107 var minY = null, maxY = null, j, y;
5011e7a1 2108
9922b78b 2109 var bars = this.attr_("errorBars") || this.attr_("customBars");
5011e7a1
DV
2110 if (bars) {
2111 // With custom bars, maxY is the max of the high values.
758a629f
DV
2112 for (j = 0; j < series.length; j++) {
2113 y = series[j][1][0];
44477387 2114 if (y === null || isNaN(y)) continue;
5011e7a1
DV
2115 var low = y - series[j][1][1];
2116 var high = y + series[j][1][2];
2117 if (low > y) low = y; // this can happen with custom bars,
2118 if (high < y) high = y; // e.g. in tests/custom-bars.html
758a629f 2119 if (maxY === null || high > maxY) {
5011e7a1
DV
2120 maxY = high;
2121 }
758a629f 2122 if (minY === null || low < minY) {
5011e7a1
DV
2123 minY = low;
2124 }
2125 }
2126 } else {
758a629f
DV
2127 for (j = 0; j < series.length; j++) {
2128 y = series[j][1];
d12999d3 2129 if (y === null || isNaN(y)) continue;
758a629f 2130 if (maxY === null || y > maxY) {
5011e7a1
DV
2131 maxY = y;
2132 }
758a629f 2133 if (minY === null || y < minY) {
5011e7a1
DV
2134 minY = y;
2135 }
2136 }
2137 }
2138
2139 return [minY, maxY];
2140};
2141
6a1aa64f 2142/**
629a09ae 2143 * @private
26ca7938
DV
2144 * This function is called once when the chart's data is changed or the options
2145 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2146 * idea is that values derived from the chart's data can be computed here,
2147 * rather than every time the chart is drawn. This includes things like the
2148 * number of axes, rolling averages, etc.
2149 */
2150Dygraph.prototype.predraw_ = function() {
7153e001
DV
2151 var start = new Date();
2152
0d216a60
PF
2153 this.layout_.computePlotArea();
2154
26ca7938
DV
2155 // TODO(danvk): move more computations out of drawGraph_ and into here.
2156 this.computeYAxes_();
2157
2158 // Create a new plotter.
f417e3d3 2159 if (this.plotter_) {
1748a51c 2160 this.cascadeEvents_('clearChart');
f417e3d3
DV
2161 this.plotter_.clear();
2162 }
26ca7938 2163 this.plotter_ = new DygraphCanvasRenderer(this,
2cf95fff
RK
2164 this.hidden_,
2165 this.hidden_ctx_,
0e23cfc6 2166 this.layout_);
26ca7938 2167
0abfbd7e
DV
2168 // The roller sits in the bottom left corner of the chart. We don't know where
2169 // this will be until the options are available, so it's positioned here.
8c69de65 2170 this.createRollInterface_();
26ca7938 2171
e2c21500 2172 this.cascadeEvents_('predraw');
0abfbd7e 2173
b1a3b195
DV
2174 // Convert the raw data (a 2D array) into the internal format and compute
2175 // rolling averages.
2176 this.rolledSeries_ = [null]; // x-axis is the first series and it's special
395e98a3 2177 for (var i = 1; i < this.numColumns(); i++) {
c1780ad0
RK
2178 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too.
2179 var logScale = this.attr_('logscale');
04c104d7 2180 var series = this.extractSeries_(this.rawData_, i, logScale);
b1a3b195
DV
2181 series = this.rollingAverage(series, this.rollPeriod_);
2182 this.rolledSeries_.push(series);
2183 }
2184
26ca7938
DV
2185 // If the data or options have changed, then we'd better redraw.
2186 this.drawGraph_();
4b4d1a63
DV
2187
2188 // This is used to determine whether to do various animations.
2189 var end = new Date();
2190 this.drawingTimeMs_ = (end - start);
26ca7938
DV
2191};
2192
2193/**
b1a3b195
DV
2194 * Loop over all fields and create datasets, calculating extreme y-values for
2195 * each series and extreme x-indices as we go.
fc4e84fa 2196 *
b1a3b195
DV
2197 * dateWindow is passed in as an explicit parameter so that we can compute
2198 * extreme values "speculatively", i.e. without actually setting state on the
2199 * dygraph.
fc4e84fa 2200 *
b1a3b195
DV
2201 * TODO(danvk): make this more of a true function
2202 * @return [ datasets, seriesExtremes, boundaryIds ]
6a1aa64f
DV
2203 * @private
2204 */
b1a3b195
DV
2205Dygraph.prototype.gatherDatasets_ = function(rolledSeries, dateWindow) {
2206 var boundaryIds = [];
354e15ab
DE
2207 var cumulative_y = []; // For stacked series.
2208 var datasets = [];
f09fc545 2209 var extremes = {}; // series name -> [low, high]
758a629f 2210 var i, j, k;
f09fc545 2211
b1a3b195
DV
2212 // Loop over the fields (series). Go from the last to the first,
2213 // because if they're stacked that's how we accumulate the values.
2214 var num_series = rolledSeries.length - 1;
758a629f 2215 for (i = num_series; i >= 1; i--) {
1cf11047
DV
2216 if (!this.visibility()[i - 1]) continue;
2217
16879a6b
DV
2218 // Note: this copy _is_ necessary at the moment.
2219 // If you remove it, it breaks zooming with error bars on.
2220 // TODO(danvk): investigate further & write a test for this.
2221 var series = [];
2222 for (j = 0; j < rolledSeries[i].length; j++) {
2223 series.push(rolledSeries[i][j]);
2224 }
2f5e7e1a 2225
6a1aa64f 2226 // Prune down to the desired range, if necessary (for zooming)
1a26f3fb
DV
2227 // Because there can be lines going to points outside of the visible area,
2228 // we actually prune to visible points, plus one on either side.
9922b78b 2229 var bars = this.attr_("errorBars") || this.attr_("customBars");
b1a3b195
DV
2230 if (dateWindow) {
2231 var low = dateWindow[0];
2232 var high = dateWindow[1];
6a1aa64f 2233 var pruned = [];
1a26f3fb
DV
2234 // TODO(danvk): do binary search instead of linear search.
2235 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2236 var firstIdx = null, lastIdx = null;
758a629f 2237 for (k = 0; k < series.length; k++) {
1a26f3fb
DV
2238 if (series[k][0] >= low && firstIdx === null) {
2239 firstIdx = k;
2240 }
2241 if (series[k][0] <= high) {
2242 lastIdx = k;
6a1aa64f
DV
2243 }
2244 }
1a26f3fb
DV
2245 if (firstIdx === null) firstIdx = 0;
2246 if (firstIdx > 0) firstIdx--;
2247 if (lastIdx === null) lastIdx = series.length - 1;
2248 if (lastIdx < series.length - 1) lastIdx++;
b1a3b195 2249 boundaryIds[i-1] = [firstIdx, lastIdx];
758a629f 2250 for (k = firstIdx; k <= lastIdx; k++) {
1a26f3fb 2251 pruned.push(series[k]);
6a1aa64f
DV
2252 }
2253 series = pruned;
16269f6e 2254 } else {
b1a3b195 2255 boundaryIds[i-1] = [0, series.length-1];
6a1aa64f
DV
2256 }
2257
f09fc545 2258 var seriesExtremes = this.extremeValues_(series);
5011e7a1 2259
6a1aa64f 2260 if (bars) {
758a629f 2261 for (j=0; j<series.length; j++) {
5061b42f
DV
2262 series[j] = [series[j][0],
2263 series[j][1][0],
2264 series[j][1][1],
2265 series[j][1][2]];
354e15ab 2266 }
43af96e7 2267 } else if (this.attr_("stackedGraph")) {
43af96e7
NK
2268 var l = series.length;
2269 var actual_y;
758a629f 2270 for (j = 0; j < l; j++) {
354e15ab
DE
2271 // If one data set has a NaN, let all subsequent stacked
2272 // sets inherit the NaN -- only start at 0 for the first set.
2273 var x = series[j][0];
41b0f691 2274 if (cumulative_y[x] === undefined) {
354e15ab 2275 cumulative_y[x] = 0;
41b0f691 2276 }
43af96e7
NK
2277
2278 actual_y = series[j][1];
04c104d7
KW
2279 if (actual_y === null) {
2280 series[j] = [x, null];
2281 continue;
2282 }
2283
354e15ab 2284 cumulative_y[x] += actual_y;
43af96e7 2285
758a629f 2286 series[j] = [x, cumulative_y[x]];
43af96e7 2287
41b0f691
DV
2288 if (cumulative_y[x] > seriesExtremes[1]) {
2289 seriesExtremes[1] = cumulative_y[x];
2290 }
2291 if (cumulative_y[x] < seriesExtremes[0]) {
2292 seriesExtremes[0] = cumulative_y[x];
2293 }
43af96e7 2294 }
6a1aa64f 2295 }
354e15ab 2296
b1a3b195
DV
2297 var seriesName = this.attr_("labels")[i];
2298 extremes[seriesName] = seriesExtremes;
354e15ab 2299 datasets[i] = series;
6a1aa64f
DV
2300 }
2301
7d463f49
KW
2302 // For stacked graphs, a NaN value for any point in the sum should create a
2303 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2304 if (this.attr_("stackedGraph")) {
2305 for (k = datasets.length - 1; k >= 0; --k) {
2306 // Use the first nonempty dataset to get X values.
2307 if (!datasets[k]) continue;
2308 for (j = 0; j < datasets[k].length; j++) {
2309 var x = datasets[k][j][0];
2310 if (isNaN(cumulative_y[x])) {
2311 // Set all Y values to NaN at that X value.
2312 for (i = datasets.length - 1; i >= 0; i--) {
2313 if (!datasets[i]) continue;
2314 datasets[i][j][1] = NaN;
2315 }
2316 }
2317 }
2318 break;
2319 }
2320 }
2321
b1a3b195
DV
2322 return [ datasets, extremes, boundaryIds ];
2323};
2324
2325/**
2326 * Update the graph with new data. This method is called when the viewing area
2327 * has changed. If the underlying data or options have changed, predraw_ will
2328 * be called before drawGraph_ is called.
2329 *
b1a3b195
DV
2330 * @private
2331 */
e2c21500 2332Dygraph.prototype.drawGraph_ = function() {
b1a3b195
DV
2333 var start = new Date();
2334
b1a3b195
DV
2335 // This is used to set the second parameter to drawCallback, below.
2336 var is_initial_draw = this.is_initial_draw_;
2337 this.is_initial_draw_ = false;
2338
b1a3b195
DV
2339 this.layout_.removeAllDatasets();
2340 this.setColors_();
758a629f 2341 this.attrs_.pointSize = 0.5 * this.attr_('highlightCircleSize');
b1a3b195
DV
2342
2343 var packed = this.gatherDatasets_(this.rolledSeries_, this.dateWindow_);
2344 var datasets = packed[0];
2345 var extremes = packed[1];
2346 this.boundaryIds_ = packed[2];
2347
82c6fe4d
KW
2348 this.setIndexByName_ = {};
2349 var labels = this.attr_("labels");
2350 if (labels.length > 0) {
2351 this.setIndexByName_[labels[0]] = 0;
2352 }
857a6931 2353 var dataIdx = 0;
354e15ab 2354 for (var i = 1; i < datasets.length; i++) {
82c6fe4d 2355 this.setIndexByName_[labels[i]] = i;
4523c1f6 2356 if (!this.visibility()[i - 1]) continue;
82c6fe4d 2357 this.layout_.addDataset(labels[i], datasets[i]);
857a6931 2358 this.datasetIndex_[i] = dataIdx++;
43af96e7
NK
2359 }
2360
6faebb69 2361 this.computeYAxisRanges_(extremes);
b2c9222a
DV
2362 this.layout_.setYAxes(this.axes_);
2363
6a1aa64f
DV
2364 this.addXTicks_();
2365
b2c9222a 2366 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
81856f70 2367 var tmp_zoomed_x = this.zoomed_x_;
6a1aa64f 2368 // Tell PlotKit to use this new data and render itself
b2c9222a 2369 this.layout_.setDateWindow(this.dateWindow_);
81856f70 2370 this.zoomed_x_ = tmp_zoomed_x;
6a1aa64f 2371 this.layout_.evaluateWithError();
e2c21500 2372 this.renderGraph_(is_initial_draw);
9ca829f2
DV
2373
2374 if (this.attr_("timingName")) {
2375 var end = new Date();
d4cb4d24 2376 Dygraph.info(this.attr_("timingName") + " - drawGraph: " + (end - start) + "ms");
9ca829f2
DV
2377 }
2378};
2379
e2c21500
DV
2380/**
2381 * This does the work of drawing the chart. It assumes that the layout and axis
2382 * scales have already been set (e.g. by predraw_).
2383 *
2384 * @private
2385 */
2386Dygraph.prototype.renderGraph_ = function(is_initial_draw) {
1748a51c 2387 this.cascadeEvents_('clearChart');
6a1aa64f 2388 this.plotter_.clear();
f417e3d3 2389
98eb4713
DV
2390 if (this.attr_('underlayCallback')) {
2391 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2392 // users who expect a deprecated form of this callback.
2393 this.attr_('underlayCallback')(
2394 this.hidden_ctx_, this.layout_.getPlotArea(), this, this);
2395 }
2396
2397 var e = {
189f8030 2398 canvas: this.hidden_,
2de7166c 2399 drawingContext: this.hidden_ctx_
98eb4713
DV
2400 };
2401 this.cascadeEvents_('willDrawChart', e);
6a1aa64f 2402 this.plotter_.render();
98eb4713 2403 this.cascadeEvents_('didDrawChart', e);
8cfe592f
DV
2404
2405 // TODO(danvk): is this a performance bottleneck when panning?
2406 // The interaction canvas should already be empty in that situation.
f6401bf6 2407 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2f5e7e1a 2408 this.canvas_.height);
599fb4ad
DV
2409
2410 if (this.attr_("drawCallback") !== null) {
fe0b7c03 2411 this.attr_("drawCallback")(this, is_initial_draw);
599fb4ad 2412 }
6a1aa64f
DV
2413};
2414
2415/**
629a09ae 2416 * @private
26ca7938
DV
2417 * Determine properties of the y-axes which are independent of the data
2418 * currently being displayed. This includes things like the number of axes and
2419 * the style of the axes. It does not include the range of each axis and its
2420 * tick marks.
16f00742 2421 * This fills in this.axes_.
26ca7938 2422 * axes_ = [ { options } ]
26ca7938 2423 * indices are into the axes_ array.
f09fc545 2424 */
26ca7938 2425Dygraph.prototype.computeYAxes_ = function() {
d64b8fea
RK
2426 // Preserve valueWindow settings if they exist, and if the user hasn't
2427 // specified a new valueRange.
0cd1ad15 2428 var valueWindows, axis, index, opts, v;
758a629f 2429 if (this.axes_ !== undefined && this.user_attrs_.hasOwnProperty("valueRange") === false) {
d64b8fea 2430 valueWindows = [];
758a629f 2431 for (index = 0; index < this.axes_.length; index++) {
d64b8fea
RK
2432 valueWindows.push(this.axes_[index].valueWindow);
2433 }
2434 }
2435
6ad8b6a4
RK
2436 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2437 // data computation as well as options storage.
f09fc545 2438 // Go through once and add all the axes.
02c93ff5 2439 this.axes_ = [];
0d216a60 2440
02c93ff5 2441 for (axis = 0; axis < this.attributes_.numAxes(); axis++) {
6ad8b6a4 2442 // Add a new axis, making a copy of its per-axis options.
02c93ff5 2443 opts = { g : this };
6ad8b6a4
RK
2444 Dygraph.update(opts, this.attributes_.axisOptions(axis));
2445 this.axes_[axis] = opts;
f09fc545 2446 }
1c77a3a1 2447
7740dd00
RK
2448
2449 // Copy global valueRange option over to the first axis.
2450 // NOTE(konigsberg): Are these two statements necessary?
2451 // I tried removing it. The automated tests pass, and manually
2452 // messing with tests/zoom.html showed no trouble.
2453 v = this.attr_('valueRange');
2454 if (v) this.axes_[0].valueRange = v;
478b866b 2455
758a629f 2456 if (valueWindows !== undefined) {
d64b8fea 2457 // Restore valueWindow settings.
758a629f 2458 for (index = 0; index < valueWindows.length; index++) {
d64b8fea
RK
2459 this.axes_[index].valueWindow = valueWindows[index];
2460 }
2461 }
4dd0ac55 2462
4dd0ac55
RV
2463 for (axis = 0; axis < this.axes_.length; axis++) {
2464 if (axis === 0) {
2465 opts = this.optionsViewForAxis_('y' + (axis ? '2' : ''));
2466 v = opts("valueRange");
2467 if (v) this.axes_[axis].valueRange = v;
2468 } else { // To keep old behavior
2469 var axes = this.user_attrs_.axes;
2470 if (axes && axes.y2) {
2471 v = axes.y2.valueRange;
2472 if (v) this.axes_[axis].valueRange = v;
2473 }
2474 }
2475 }
26ca7938
DV
2476};
2477
2478/**
2479 * Returns the number of y-axes on the chart.
2480 * @return {Number} the number of axes.
2481 */
2482Dygraph.prototype.numAxes = function() {
16f00742 2483 return this.attributes_.numAxes();
26ca7938
DV
2484};
2485
2486/**
629a09ae 2487 * @private
b2c9222a
DV
2488 * Returns axis properties for the given series.
2489 * @param { String } setName The name of the series for which to get axis
2490 * properties, e.g. 'Y1'.
2491 * @return { Object } The axis properties.
2492 */
2493Dygraph.prototype.axisPropertiesForSeries = function(series) {
2494 // TODO(danvk): handle errors.
16f00742 2495 return this.axes_[this.attributes_.axisForSeries(series)];
b2c9222a
DV
2496};
2497
2498/**
2499 * @private
26ca7938
DV
2500 * Determine the value range and tick marks for each axis.
2501 * @param {Object} extremes A mapping from seriesName -> [low, high]
2502 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2503 */
2504Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
6b05851c 2505
9adc2c33 2506 var isNullUndefinedOrNaN = function(num) {
126bf1e3 2507 return isNaN(parseFloat(num));
6b05851c 2508 };
16f00742
RK
2509 var series;
2510 var numAxes = this.attributes_.numAxes();
f09fc545
DV
2511
2512 // Compute extreme values, a span and tick marks for each axis.
16f00742 2513 for (var i = 0; i < numAxes; i++) {
26ca7938 2514 var axis = this.axes_[i];
ec40f67c
RK
2515 var logscale = this.attributes_.getForAxis("logscale", i);
2516 var includeZero = this.attributes_.getForAxis("includeZero", i);
6ad8b6a4
RK
2517 series = this.attributes_.seriesForAxis(i);
2518
83b0c192 2519 if (series.length === 0) {
06fc69b6
AV
2520 // If no series are defined or visible then use a reasonable default
2521 axis.extremeRange = [0, 1];
2522 } else {
1c77a3a1 2523 // Calculate the extremes of extremes.
f09fc545
DV
2524 var minY = Infinity; // extremes[series[0]][0];
2525 var maxY = -Infinity; // extremes[series[0]][1];
ba049b89 2526 var extremeMinY, extremeMaxY;
a2da3777 2527
f09fc545 2528 for (var j = 0; j < series.length; j++) {
a2da3777
DV
2529 // this skips invisible series
2530 if (!extremes.hasOwnProperty(series[j])) continue;
2531
ba049b89
NN
2532 // Only use valid extremes to stop null data series' from corrupting the scale.
2533 extremeMinY = extremes[series[j]][0];
758a629f 2534 if (extremeMinY !== null) {
36dfa958 2535 minY = Math.min(extremeMinY, minY);
ba049b89
NN
2536 }
2537 extremeMaxY = extremes[series[j]][1];
758a629f 2538 if (extremeMaxY !== null) {
36dfa958 2539 maxY = Math.max(extremeMaxY, maxY);
ba049b89 2540 }
f09fc545 2541 }
fa460473
KW
2542
2543 // Include zero if requested by the user.
2544 if (includeZero && !logscale) {
2545 if (minY > 0) minY = 0;
2546 if (maxY < 0) maxY = 0;
2547 }
f09fc545 2548
a2da3777 2549 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
36dfa958 2550 if (minY == Infinity) minY = 0;
a2da3777 2551 if (maxY == -Infinity) maxY = 1;
ba049b89 2552
f09fc545 2553 var span = maxY - minY;
fa460473
KW
2554 // special case: if we have no sense of scale, center on the sole value.
2555 if (span === 0) {
2556 if (maxY !== 0) {
2557 span = Math.abs(maxY);
2558 } else {
2559 // ... and if the sole value is zero, use range 0-1.
2560 maxY = 1;
2561 span = 1;
2562 }
2563 }
2564
2565 // Add some padding. This supports two Y padding operation modes:
2566 //
2567 // - backwards compatible (yRangePad not set):
2568 // 10% padding for automatic Y ranges, but not for user-supplied
2569 // ranges, and move a close-to-zero edge to zero except if
2570 // avoidMinZero is set, since drawing at the edge results in
2571 // invisible lines. Unfortunately lines drawn at the edge of a
2572 // user-supplied range will still be invisible. If logscale is
2573 // set, add a variable amount of padding at the top but
2574 // none at the bottom.
2575 //
2576 // - new-style (yRangePad set by the user):
2577 // always add the specified Y padding.
2578 //
2579 var ypadCompat = true;
2580 var ypad = 0.1; // add 10%
2581 if (this.attr_('yRangePad') !== null) {
2582 ypadCompat = false;
2583 // Convert pixel padding to ratio
2584 ypad = this.attr_('yRangePad') / this.plotter_.area.h;
2585 }
f09fc545 2586
758a629f 2587 var maxAxisY, minAxisY;
ec40f67c 2588 if (logscale) {
fa460473
KW
2589 if (ypadCompat) {
2590 maxAxisY = maxY + ypad * span;
2591 minAxisY = minY;
2592 } else {
2593 var logpad = Math.exp(Math.log(span) * ypad);
2594 maxAxisY = maxY * logpad;
2595 minAxisY = minY / logpad;
2596 }
ff022deb 2597 } else {
fa460473
KW
2598 maxAxisY = maxY + ypad * span;
2599 minAxisY = minY - ypad * span;
f09fc545 2600
fa460473
KW
2601 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2602 // close to zero, but not if avoidMinZero is set.
2603 if (ypadCompat && !this.attr_("avoidMinZero")) {
ff022deb
RK
2604 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2605 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
2606 }
f09fc545 2607 }
4cac8c7a
RK
2608 axis.extremeRange = [minAxisY, maxAxisY];
2609 }
2610 if (axis.valueWindow) {
2611 // This is only set if the user has zoomed on the y-axis. It is never set
2612 // by a user. It takes precedence over axis.valueRange because, if you set
2613 // valueRange, you'd still expect to be able to pan.
2614 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
2615 } else if (axis.valueRange) {
2616 // This is a user-set value range for this axis.
fa460473
KW
2617 var y0 = isNullUndefinedOrNaN(axis.valueRange[0]) ? axis.extremeRange[0] : axis.valueRange[0];
2618 var y1 = isNullUndefinedOrNaN(axis.valueRange[1]) ? axis.extremeRange[1] : axis.valueRange[1];
2619 if (!ypadCompat) {
2620 if (axis.logscale) {
2621 var logpad = Math.exp(Math.log(span) * ypad);
2622 y0 *= logpad;
2623 y1 /= logpad;
2624 } else {
2625 var span = y1 - y0;
2626 y0 -= span * ypad;
2627 y1 += span * ypad;
2628 }
2629 }
2630 axis.computedValueRange = [y0, y1];
4cac8c7a
RK
2631 } else {
2632 axis.computedValueRange = axis.extremeRange;
f09fc545
DV
2633 }
2634
0d64e596
DV
2635 // Add ticks. By default, all axes inherit the tick positions of the
2636 // primary axis. However, if an axis is specifically marked as having
2637 // independent ticks, then that is permissible as well.
48e614ac
DV
2638 var opts = this.optionsViewForAxis_('y' + (i ? '2' : ''));
2639 var ticker = opts('ticker');
758a629f 2640 if (i === 0 || axis.independentTicks) {
48e614ac
DV
2641 axis.ticks = ticker(axis.computedValueRange[0],
2642 axis.computedValueRange[1],
2643 this.height_, // TODO(danvk): should be area.height
2644 opts,
2645 this);
0d64e596
DV
2646 } else {
2647 var p_axis = this.axes_[0];
2648 var p_ticks = p_axis.ticks;
2649 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
2650 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
2651 var tick_values = [];
25f76ae3
DV
2652 for (var k = 0; k < p_ticks.length; k++) {
2653 var y_frac = (p_ticks[k].v - p_axis.computedValueRange[0]) / p_scale;
0d64e596
DV
2654 var y_val = axis.computedValueRange[0] + y_frac * scale;
2655 tick_values.push(y_val);
2656 }
2657
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,
2663 tick_values);
0d64e596 2664 }
f09fc545 2665 }
f09fc545 2666};
25f76ae3 2667
f09fc545 2668/**
b1a3b195
DV
2669 * Extracts one series from the raw data (a 2D array) into an array of (date,
2670 * value) tuples.
2671 *
2672 * This is where undesirable points (i.e. negative values on log scales and
2673 * missing values through which we wish to connect lines) are dropped.
0604287e 2674 * TODO(danvk): the "missing values" bit above doesn't seem right.
de8f284f 2675 *
b1a3b195
DV
2676 * @private
2677 */
04c104d7 2678Dygraph.prototype.extractSeries_ = function(rawData, i, logScale) {
0604287e 2679 // TODO(danvk): pre-allocate series here.
b1a3b195
DV
2680 var series = [];
2681 for (var j = 0; j < rawData.length; j++) {
2682 var x = rawData[j][0];
2683 var point = rawData[j][i];
2684 if (logScale) {
2685 // On the log scale, points less than zero do not exist.
04c104d7 2686 // This will create a gap in the chart.
b1a3b195
DV
2687 if (point <= 0) {
2688 point = null;
2689 }
b1a3b195 2690 }
04c104d7 2691 series.push([x, point]);
b1a3b195
DV
2692 }
2693 return series;
2694};
2695
2696/**
629a09ae 2697 * @private
6a1aa64f
DV
2698 * Calculates the rolling average of a data set.
2699 * If originalData is [label, val], rolls the average of those.
2700 * If originalData is [label, [, it's interpreted as [value, stddev]
2701 * and the roll is returned in the same form, with appropriately reduced
2702 * stddev for each value.
2703 * Note that this is where fractional input (i.e. '5/10') is converted into
2704 * decimal values.
2705 * @param {Array} originalData The data in the appropriate format (see above)
6faebb69
JB
2706 * @param {Number} rollPeriod The number of points over which to average the
2707 * data
6a1aa64f 2708 */
285a6bda 2709Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
6a1aa64f
DV
2710 if (originalData.length < 2)
2711 return originalData;
758a629f 2712 rollPeriod = Math.min(rollPeriod, originalData.length);
6a1aa64f 2713 var rollingData = [];
285a6bda 2714 var sigma = this.attr_("sigma");
6a1aa64f 2715
758a629f 2716 var low, high, i, j, y, sum, num_ok, stddev;
6a1aa64f
DV
2717 if (this.fractions_) {
2718 var num = 0;
2719 var den = 0; // numerator/denominator
2720 var mult = 100.0;
758a629f 2721 for (i = 0; i < originalData.length; i++) {
6a1aa64f
DV
2722 num += originalData[i][1][0];
2723 den += originalData[i][1][1];
2724 if (i - rollPeriod >= 0) {
2725 num -= originalData[i - rollPeriod][1][0];
2726 den -= originalData[i - rollPeriod][1][1];
2727 }
2728
2729 var date = originalData[i][0];
2730 var value = den ? num / den : 0.0;
285a6bda 2731 if (this.attr_("errorBars")) {
395e98a3 2732 if (this.attr_("wilsonInterval")) {
6a1aa64f
DV
2733 // For more details on this confidence interval, see:
2734 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
2735 if (den) {
2736 var p = value < 0 ? 0 : value, n = den;
2737 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
2738 var denom = 1 + sigma * sigma / den;
758a629f
DV
2739 low = (p + sigma * sigma / (2 * den) - pm) / denom;
2740 high = (p + sigma * sigma / (2 * den) + pm) / denom;
6a1aa64f
DV
2741 rollingData[i] = [date,
2742 [p * mult, (p - low) * mult, (high - p) * mult]];
2743 } else {
2744 rollingData[i] = [date, [0, 0, 0]];
2745 }
2746 } else {
758a629f 2747 stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
6a1aa64f
DV
2748 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
2749 }
2750 } else {
2751 rollingData[i] = [date, mult * value];
2752 }
2753 }
9922b78b 2754 } else if (this.attr_("customBars")) {
758a629f 2755 low = 0;
f6885d6a 2756 var mid = 0;
758a629f 2757 high = 0;
f6885d6a 2758 var count = 0;
758a629f 2759 for (i = 0; i < originalData.length; i++) {
6a1aa64f 2760 var data = originalData[i][1];
758a629f 2761 y = data[1];
6a1aa64f 2762 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
f6885d6a 2763
758a629f 2764 if (y !== null && !isNaN(y)) {
49a7d0d5
DV
2765 low += data[0];
2766 mid += y;
2767 high += data[2];
2768 count += 1;
2769 }
f6885d6a
DV
2770 if (i - rollPeriod >= 0) {
2771 var prev = originalData[i - rollPeriod];
758a629f 2772 if (prev[1][1] !== null && !isNaN(prev[1][1])) {
49a7d0d5
DV
2773 low -= prev[1][0];
2774 mid -= prev[1][1];
2775 high -= prev[1][2];
2776 count -= 1;
2777 }
f6885d6a 2778 }
502d5996
DV
2779 if (count) {
2780 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
2781 1.0 * (mid - low) / count,
2782 1.0 * (high - mid) / count ]];
2783 } else {
2784 rollingData[i] = [originalData[i][0], [null, null, null]];
2785 }
2769de62 2786 }
6a1aa64f
DV
2787 } else {
2788 // Calculate the rolling average for the first rollPeriod - 1 points where
6faebb69 2789 // there is not enough data to roll over the full number of points
285a6bda 2790 if (!this.attr_("errorBars")){
5011e7a1
DV
2791 if (rollPeriod == 1) {
2792 return originalData;
2793 }
2794
758a629f
DV
2795 for (i = 0; i < originalData.length; i++) {
2796 sum = 0;
2797 num_ok = 0;
2798 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2799 y = originalData[j][1];
2800 if (y === null || isNaN(y)) continue;
5011e7a1 2801 num_ok++;
2847c1cf 2802 sum += originalData[j][1];
6a1aa64f 2803 }
5011e7a1 2804 if (num_ok) {
2847c1cf 2805 rollingData[i] = [originalData[i][0], sum / num_ok];
5011e7a1 2806 } else {
2847c1cf 2807 rollingData[i] = [originalData[i][0], null];
5011e7a1 2808 }
6a1aa64f 2809 }
2847c1cf
DV
2810
2811 } else {
758a629f
DV
2812 for (i = 0; i < originalData.length; i++) {
2813 sum = 0;
6a1aa64f 2814 var variance = 0;
758a629f
DV
2815 num_ok = 0;
2816 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2817 y = originalData[j][1][0];
2818 if (y === null || isNaN(y)) continue;
5011e7a1 2819 num_ok++;
6a1aa64f
DV
2820 sum += originalData[j][1][0];
2821 variance += Math.pow(originalData[j][1][1], 2);
2822 }
5011e7a1 2823 if (num_ok) {
758a629f 2824 stddev = Math.sqrt(variance) / num_ok;
5011e7a1
DV
2825 rollingData[i] = [originalData[i][0],
2826 [sum / num_ok, sigma * stddev, sigma * stddev]];
2827 } else {
2828 rollingData[i] = [originalData[i][0], [null, null, null]];
2829 }
6a1aa64f
DV
2830 }
2831 }
2832 }
2833
2834 return rollingData;
2835};
2836
2837/**
285a6bda
DV
2838 * Detects the type of the str (date or numeric) and sets the various
2839 * formatting attributes in this.attrs_ based on this type.
2840 * @param {String} str An x value.
2841 * @private
2842 */
2843Dygraph.prototype.detectTypeFromString_ = function(str) {
2844 var isDate = false;
0842b24b
DV
2845 var dashPos = str.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2846 if ((dashPos > 0 && (str[dashPos-1] != 'e' && str[dashPos-1] != 'E')) ||
285a6bda
DV
2847 str.indexOf('/') >= 0 ||
2848 isNaN(parseFloat(str))) {
2849 isDate = true;
2850 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
2851 // TODO(danvk): remove support for this format.
2852 isDate = true;
2853 }
2854
a716aff2
RK
2855 this.setXAxisOptions_(isDate);
2856};
2857
2858Dygraph.prototype.setXAxisOptions_ = function(isDate) {
285a6bda 2859 if (isDate) {
285a6bda 2860 this.attrs_.xValueParser = Dygraph.dateParser;
48e614ac
DV
2861 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2862 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2863 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
285a6bda 2864 } else {
c39e1d93 2865 /** @private (shut up, jsdoc!) */
285a6bda 2866 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
48e614ac
DV
2867 // TODO(danvk): use Dygraph.numberValueFormatter here?
2868 /** @private (shut up, jsdoc!) */
2869 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
44462ba3 2870 this.attrs_.axes.x.ticker = Dygraph.numericLinearTicks;
48e614ac 2871 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
6a1aa64f 2872 }
83b0c192 2873};
6a1aa64f
DV
2874
2875/**
5cd7ac68
DV
2876 * Parses the value as a floating point number. This is like the parseFloat()
2877 * built-in, but with a few differences:
2878 * - the empty string is parsed as null, rather than NaN.
2879 * - if the string cannot be parsed at all, an error is logged.
2880 * If the string can't be parsed, this method returns null.
2881 * @param {String} x The string to be parsed
2882 * @param {Number} opt_line_no The line number from which the string comes.
2883 * @param {String} opt_line The text of the line from which the string comes.
2884 * @private
2885 */
2886
2887// Parse the x as a float or return null if it's not a number.
2888Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) {
2889 var val = parseFloat(x);
2890 if (!isNaN(val)) return val;
2891
2892 // Try to figure out what happeend.
2893 // If the value is the empty string, parse it as null.
2894 if (/^ *$/.test(x)) return null;
2895
2896 // If it was actually "NaN", return it as NaN.
2897 if (/^ *nan *$/i.test(x)) return NaN;
2898
2899 // Looks like a parsing error.
2900 var msg = "Unable to parse '" + x + "' as a number";
2901 if (opt_line !== null && opt_line_no !== null) {
2902 msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV.";
2903 }
2904 this.error(msg);
2905
2906 return null;
2907};
2908
2909/**
629a09ae 2910 * @private
6a1aa64f
DV
2911 * Parses a string in a special csv format. We expect a csv file where each
2912 * line is a date point, and the first field in each line is the date string.
2913 * We also expect that all remaining fields represent series.
285a6bda 2914 * if the errorBars attribute is set, then interpret the fields as:
6a1aa64f 2915 * date, series1, stddev1, series2, stddev2, ...
629a09ae 2916 * @param {[Object]} data See above.
285a6bda 2917 *
629a09ae 2918 * @return [Object] An array with one entry for each row. These entries
285a6bda
DV
2919 * are an array of cells in that row. The first entry is the parsed x-value for
2920 * the row. The second, third, etc. are the y-values. These can take on one of
2921 * three forms, depending on the CSV and constructor parameters:
2922 * 1. numeric value
2923 * 2. [ value, stddev ]
2924 * 3. [ low value, center value, high value ]
6a1aa64f 2925 */
285a6bda 2926Dygraph.prototype.parseCSV_ = function(data) {
6a1aa64f 2927 var ret = [];
e5763589
DV
2928 var line_delimiter = Dygraph.detectLineDelimiter(data);
2929 var lines = data.split(line_delimiter || "\n");
758a629f 2930 var vals, j;
3d67f03b
DV
2931
2932 // Use the default delimiter or fall back to a tab if that makes sense.
2933 var delim = this.attr_('delimiter');
2934 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
2935 delim = '\t';
2936 }
2937
285a6bda 2938 var start = 0;
d7beab6b
DV
2939 if (!('labels' in this.user_attrs_)) {
2940 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
285a6bda 2941 start = 1;
d7beab6b 2942 this.attrs_.labels = lines[0].split(delim); // NOTE: _not_ user_attrs_.
34825ef5 2943 this.attributes_.reparseSeries();
6a1aa64f 2944 }
5cd7ac68 2945 var line_no = 0;
03b522a4 2946
285a6bda
DV
2947 var xParser;
2948 var defaultParserSet = false; // attempt to auto-detect x value type
2949 var expectedCols = this.attr_("labels").length;
987840a2 2950 var outOfOrder = false;
6a1aa64f
DV
2951 for (var i = start; i < lines.length; i++) {
2952 var line = lines[i];
5cd7ac68 2953 line_no = i;
758a629f 2954 if (line.length === 0) continue; // skip blank lines
3d67f03b
DV
2955 if (line[0] == '#') continue; // skip comment lines
2956 var inFields = line.split(delim);
285a6bda 2957 if (inFields.length < 2) continue;
6a1aa64f
DV
2958
2959 var fields = [];
285a6bda
DV
2960 if (!defaultParserSet) {
2961 this.detectTypeFromString_(inFields[0]);
2962 xParser = this.attr_("xValueParser");
2963 defaultParserSet = true;
2964 }
2965 fields[0] = xParser(inFields[0], this);
6a1aa64f
DV
2966
2967 // If fractions are expected, parse the numbers as "A/B"
2968 if (this.fractions_) {
758a629f 2969 for (j = 1; j < inFields.length; j++) {
6a1aa64f 2970 // TODO(danvk): figure out an appropriate way to flag parse errors.
758a629f 2971 vals = inFields[j].split("/");
7219edb3
DV
2972 if (vals.length != 2) {
2973 this.error('Expected fractional "num/den" values in CSV data ' +
2974 "but found a value '" + inFields[j] + "' on line " +
2975 (1 + i) + " ('" + line + "') which is not of this form.");
2976 fields[j] = [0, 0];
2977 } else {
2978 fields[j] = [this.parseFloat_(vals[0], i, line),
2979 this.parseFloat_(vals[1], i, line)];
2980 }
6a1aa64f 2981 }
285a6bda 2982 } else if (this.attr_("errorBars")) {
6a1aa64f 2983 // If there are error bars, values are (value, stddev) pairs
7219edb3
DV
2984 if (inFields.length % 2 != 1) {
2985 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2986 'but line ' + (1 + i) + ' has an odd number of values (' +
2987 (inFields.length - 1) + "): '" + line + "'");
2988 }
758a629f 2989 for (j = 1; j < inFields.length; j += 2) {
5cd7ac68
DV
2990 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2991 this.parseFloat_(inFields[j + 1], i, line)];
7219edb3 2992 }
9922b78b 2993 } else if (this.attr_("customBars")) {
6a1aa64f 2994 // Bars are a low;center;high tuple
758a629f 2995 for (j = 1; j < inFields.length; j++) {
327a9279
DV
2996 var val = inFields[j];
2997 if (/^ *$/.test(val)) {
2998 fields[j] = [null, null, null];
2999 } else {
758a629f 3000 vals = val.split(";");
327a9279
DV
3001 if (vals.length == 3) {
3002 fields[j] = [ this.parseFloat_(vals[0], i, line),
3003 this.parseFloat_(vals[1], i, line),
3004 this.parseFloat_(vals[2], i, line) ];
3005 } else {
1a5dc2af
RK
3006 this.warn('When using customBars, values must be either blank ' +
3007 'or "low;center;high" tuples (got "' + val +
3008 '" on line ' + (1+i));
327a9279
DV
3009 }
3010 }
6a1aa64f
DV
3011 }
3012 } else {
3013 // Values are just numbers
758a629f 3014 for (j = 1; j < inFields.length; j++) {
5cd7ac68 3015 fields[j] = this.parseFloat_(inFields[j], i, line);
285a6bda 3016 }
6a1aa64f 3017 }
987840a2
DV
3018 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3019 outOfOrder = true;
3020 }
285a6bda
DV
3021
3022 if (fields.length != expectedCols) {
3023 this.error("Number of columns in line " + i + " (" + fields.length +
3024 ") does not agree with number of labels (" + expectedCols +
3025 ") " + line);
3026 }
6d0aaa09
DV
3027
3028 // If the user specified the 'labels' option and none of the cells of the
3029 // first row parsed correctly, then they probably double-specified the
3030 // labels. We go with the values set in the option, discard this row and
3031 // log a warning to the JS console.
758a629f 3032 if (i === 0 && this.attr_('labels')) {
6d0aaa09 3033 var all_null = true;
758a629f 3034 for (j = 0; all_null && j < fields.length; j++) {
6d0aaa09
DV
3035 if (fields[j]) all_null = false;
3036 }
3037 if (all_null) {
3038 this.warn("The dygraphs 'labels' option is set, but the first row of " +
3039 "CSV data ('" + line + "') appears to also contain labels. " +
3040 "Will drop the CSV labels and use the option labels.");
3041 continue;
3042 }
3043 }
3044 ret.push(fields);
6a1aa64f 3045 }
987840a2
DV
3046
3047 if (outOfOrder) {
3048 this.warn("CSV is out of order; order it correctly to speed loading.");
758a629f 3049 ret.sort(function(a,b) { return a[0] - b[0]; });
987840a2
DV
3050 }
3051
6a1aa64f
DV
3052 return ret;
3053};
3054
3055/**
629a09ae 3056 * @private
285a6bda
DV
3057 * The user has provided their data as a pre-packaged JS array. If the x values
3058 * are numeric, this is the same as dygraphs' internal format. If the x values
3059 * are dates, we need to convert them from Date objects to ms since epoch.
629a09ae
DV
3060 * @param {[Object]} data
3061 * @return {[Object]} data with numeric x values.
285a6bda
DV
3062 */
3063Dygraph.prototype.parseArray_ = function(data) {
3064 // Peek at the first x value to see if it's numeric.
758a629f 3065 if (data.length === 0) {
285a6bda
DV
3066 this.error("Can't plot empty data set");
3067 return null;
3068 }
758a629f 3069 if (data[0].length === 0) {
285a6bda
DV
3070 this.error("Data set cannot contain an empty row");
3071 return null;
3072 }
3073
758a629f
DV
3074 var i;
3075 if (this.attr_("labels") === null) {
285a6bda
DV
3076 this.warn("Using default labels. Set labels explicitly via 'labels' " +
3077 "in the options parameter");
3078 this.attrs_.labels = [ "X" ];
758a629f 3079 for (i = 1; i < data[0].length; i++) {
77812e0e 3080 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
285a6bda 3081 }
77812e0e 3082 this.attributes_.reparseSeries();
debdb88d
DV
3083 } else {
3084 var num_labels = this.attr_("labels");
3085 if (num_labels.length != data[0].length) {
3086 this.error("Mismatch between number of labels (" + num_labels +
3087 ") and number of columns in array (" + data[0].length + ")");
3088 return null;
3089 }
285a6bda
DV
3090 }
3091
2dda3850 3092 if (Dygraph.isDateLike(data[0][0])) {
285a6bda 3093 // Some intelligent defaults for a date x-axis.
48e614ac 3094 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
48e614ac 3095 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
a716aff2 3096 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
285a6bda
DV
3097
3098 // Assume they're all dates.
e3ab7b40 3099 var parsedData = Dygraph.clone(data);
758a629f
DV
3100 for (i = 0; i < data.length; i++) {
3101 if (parsedData[i].length === 0) {
a323ff4a 3102 this.error("Row " + (1 + i) + " of data is empty");
285a6bda
DV
3103 return null;
3104 }
758a629f
DV
3105 if (parsedData[i][0] === null ||
3106 typeof(parsedData[i][0].getTime) != 'function' ||
3107 isNaN(parsedData[i][0].getTime())) {
be96a1f5 3108 this.error("x value in row " + (1 + i) + " is not a Date");
285a6bda
DV
3109 return null;
3110 }
3111 parsedData[i][0] = parsedData[i][0].getTime();
3112 }
3113 return parsedData;
3114 } else {
3115 // Some intelligent defaults for a numeric x-axis.
c39e1d93 3116 /** @private (shut up, jsdoc!) */
48e614ac 3117 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
44462ba3 3118 this.attrs_.axes.x.ticker = Dygraph.numericLinearTicks;
a716aff2 3119 this.attrs_.axes.x.axisLabelFormatter = Dygraph.numberAxisLabelFormatter;
285a6bda
DV
3120 return data;
3121 }
3122};
3123
3124/**
79420a1e
DV
3125 * Parses a DataTable object from gviz.
3126 * The data is expected to have a first column that is either a date or a
3127 * number. All subsequent columns must be numbers. If there is a clear mismatch
3128 * between this.xValueParser_ and the type of the first column, it will be
a685723c 3129 * fixed. Fills out rawData_.
629a09ae 3130 * @param {[Object]} data See above.
79420a1e
DV
3131 * @private
3132 */
285a6bda 3133Dygraph.prototype.parseDataTable_ = function(data) {
5829af3d 3134 var shortTextForAnnotationNum = function(num) {
3135 // converts [0-9]+ [A-Z][a-z]*
3136 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3137 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3138 var shortText = String.fromCharCode(65 /* A */ + num % 26);
3139 num = Math.floor(num / 26);
3140 while ( num > 0 ) {
3141 shortText = String.fromCharCode(65 /* A */ + (num - 1) % 26 ) + shortText.toLowerCase();
3142 num = Math.floor((num - 1) / 26);
3143 }
3144 return shortText;
42a9ebb8 3145 };
5829af3d 3146
79420a1e
DV
3147 var cols = data.getNumberOfColumns();
3148 var rows = data.getNumberOfRows();
3149
d955e223 3150 var indepType = data.getColumnType(0);
4440f6c8 3151 if (indepType == 'date' || indepType == 'datetime') {
285a6bda 3152 this.attrs_.xValueParser = Dygraph.dateParser;
48e614ac
DV
3153 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3154 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3155 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
33127159 3156 } else if (indepType == 'number') {
285a6bda 3157 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
48e614ac 3158 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
44462ba3 3159 this.attrs_.axes.x.ticker = Dygraph.numericLinearTicks;
48e614ac 3160 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
285a6bda 3161 } else {
987840a2
DV
3162 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3163 "column 1 of DataTable input (Got '" + indepType + "')");
79420a1e
DV
3164 return null;
3165 }
3166
a685723c
DV
3167 // Array of the column indices which contain data (and not annotations).
3168 var colIdx = [];
3169 var annotationCols = {}; // data index -> [annotation cols]
3170 var hasAnnotations = false;
758a629f
DV
3171 var i, j;
3172 for (i = 1; i < cols; i++) {
a685723c
DV
3173 var type = data.getColumnType(i);
3174 if (type == 'number') {
3175 colIdx.push(i);
3176 } else if (type == 'string' && this.attr_('displayAnnotations')) {
3177 // This is OK -- it's an annotation column.
3178 var dataIdx = colIdx[colIdx.length - 1];
3179 if (!annotationCols.hasOwnProperty(dataIdx)) {
3180 annotationCols[dataIdx] = [i];
3181 } else {
3182 annotationCols[dataIdx].push(i);
3183 }
3184 hasAnnotations = true;
3185 } else {
3186 this.error("Only 'number' is supported as a dependent type with Gviz." +
3187 " 'string' is only supported if displayAnnotations is true");
3188 }
3189 }
3190
3191 // Read column labels
3192 // TODO(danvk): add support back for errorBars
3193 var labels = [data.getColumnLabel(0)];
758a629f 3194 for (i = 0; i < colIdx.length; i++) {
a685723c 3195 labels.push(data.getColumnLabel(colIdx[i]));
f9348814 3196 if (this.attr_("errorBars")) i += 1;
a685723c
DV
3197 }
3198 this.attrs_.labels = labels;
3199 cols = labels.length;
3200
79420a1e 3201 var ret = [];
987840a2 3202 var outOfOrder = false;
a685723c 3203 var annotations = [];
758a629f 3204 for (i = 0; i < rows; i++) {
79420a1e 3205 var row = [];
debe4434
DV
3206 if (typeof(data.getValue(i, 0)) === 'undefined' ||
3207 data.getValue(i, 0) === null) {
129569a5
FD
3208 this.warn("Ignoring row " + i +
3209 " of DataTable because of undefined or null first column.");
debe4434
DV
3210 continue;
3211 }
3212
c21d2c2d 3213 if (indepType == 'date' || indepType == 'datetime') {
d955e223
DV
3214 row.push(data.getValue(i, 0).getTime());
3215 } else {
3216 row.push(data.getValue(i, 0));
3217 }
3e3f84e4 3218 if (!this.attr_("errorBars")) {
758a629f 3219 for (j = 0; j < colIdx.length; j++) {
a685723c
DV
3220 var col = colIdx[j];
3221 row.push(data.getValue(i, col));
3222 if (hasAnnotations &&
3223 annotationCols.hasOwnProperty(col) &&
758a629f 3224 data.getValue(i, annotationCols[col][0]) !== null) {
a685723c
DV
3225 var ann = {};
3226 ann.series = data.getColumnLabel(col);
3227 ann.xval = row[0];
5829af3d 3228 ann.shortText = shortTextForAnnotationNum(annotations.length);
a685723c
DV
3229 ann.text = '';
3230 for (var k = 0; k < annotationCols[col].length; k++) {
3231 if (k) ann.text += "\n";
3232 ann.text += data.getValue(i, annotationCols[col][k]);
3233 }
3234 annotations.push(ann);
3235 }
3e3f84e4 3236 }
92fd68d8
DV
3237
3238 // Strip out infinities, which give dygraphs problems later on.
758a629f 3239 for (j = 0; j < row.length; j++) {
92fd68d8
DV
3240 if (!isFinite(row[j])) row[j] = null;
3241 }
3e3f84e4 3242 } else {
758a629f 3243 for (j = 0; j < cols - 1; j++) {
3e3f84e4
DV
3244 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
3245 }
79420a1e 3246 }
987840a2
DV
3247 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
3248 outOfOrder = true;
3249 }
243d96e8 3250 ret.push(row);
79420a1e 3251 }
987840a2
DV
3252
3253 if (outOfOrder) {
3254 this.warn("DataTable is out of order; order it correctly to speed loading.");
758a629f 3255 ret.sort(function(a,b) { return a[0] - b[0]; });
987840a2 3256 }
a685723c
DV
3257 this.rawData_ = ret;
3258
3259 if (annotations.length > 0) {
3260 this.setAnnotations(annotations, true);
3261 }
0fa724fd 3262 this.attributes_.reparseSeries();
758a629f 3263};
79420a1e 3264
629a09ae 3265/**
6a1aa64f
DV
3266 * Get the CSV data. If it's in a function, call that function. If it's in a
3267 * file, do an XMLHttpRequest to get it.
3268 * @private
3269 */
285a6bda 3270Dygraph.prototype.start_ = function() {
36d4fabf
RK
3271 var data = this.file_;
3272
3273 // Functions can return references of all other types.
3274 if (typeof data == 'function') {
3275 data = data();
3276 }
3277
3278 if (Dygraph.isArrayLike(data)) {
3279 this.rawData_ = this.parseArray_(data);
26ca7938 3280 this.predraw_();
36d4fabf
RK
3281 } else if (typeof data == 'object' &&
3282 typeof data.getColumnRange == 'function') {
79420a1e 3283 // must be a DataTable from gviz.
36d4fabf 3284 this.parseDataTable_(data);
26ca7938 3285 this.predraw_();
36d4fabf 3286 } else if (typeof data == 'string') {
285a6bda 3287 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
e5763589
DV
3288 var line_delimiter = Dygraph.detectLineDelimiter(data);
3289 if (line_delimiter) {
36d4fabf 3290 this.loadedEvent_(data);
285a6bda
DV
3291 } else {
3292 var req = new XMLHttpRequest();
3293 var caller = this;
3294 req.onreadystatechange = function () {
3295 if (req.readyState == 4) {
758a629f
DV
3296 if (req.status === 200 || // Normal http
3297 req.status === 0) { // Chrome w/ --allow-file-access-from-files
285a6bda
DV
3298 caller.loadedEvent_(req.responseText);
3299 }
6a1aa64f 3300 }
285a6bda 3301 };
6a1aa64f 3302
36d4fabf 3303 req.open("GET", data, true);
285a6bda
DV
3304 req.send(null);
3305 }
3306 } else {
36d4fabf 3307 this.error("Unknown data format: " + (typeof data));
6a1aa64f
DV
3308 }
3309};
3310
3311/**
3312 * Changes various properties of the graph. These can include:
3313 * <ul>
3314 * <li>file: changes the source data for the graph</li>
3315 * <li>errorBars: changes whether the data contains stddev</li>
3316 * </ul>
dcb25130 3317 *
ccfcc169
DV
3318 * There's a huge variety of options that can be passed to this method. For a
3319 * full list, see http://dygraphs.com/options.html.
3320 *
6a1aa64f 3321 * @param {Object} attrs The new properties and values
ccfcc169
DV
3322 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3323 * call to updateOptions(). If you know better, you can pass true to explicitly
3324 * block the redraw. This can be useful for chaining updateOptions() calls,
3325 * avoiding the occasional infinite loop and preventing redraws when it's not
3326 * necessary (e.g. when updating a callback).
6a1aa64f 3327 */
48e614ac 3328Dygraph.prototype.updateOptions = function(input_attrs, block_redraw) {
ccfcc169
DV
3329 if (typeof(block_redraw) == 'undefined') block_redraw = false;
3330
48e614ac 3331 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
758a629f 3332 var file = input_attrs.file;
48e614ac
DV
3333 var attrs = Dygraph.mapLegacyOptions_(input_attrs);
3334
ccfcc169 3335 // TODO(danvk): this is a mess. Move these options into attr_.
c65f2303 3336 if ('rollPeriod' in attrs) {
6a1aa64f
DV
3337 this.rollPeriod_ = attrs.rollPeriod;
3338 }
c65f2303 3339 if ('dateWindow' in attrs) {
6a1aa64f 3340 this.dateWindow_ = attrs.dateWindow;
e5152598 3341 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
758a629f 3342 this.zoomed_x_ = (attrs.dateWindow !== null);
81856f70 3343 }
b7e5862d 3344 }
e5152598 3345 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
758a629f 3346 this.zoomed_y_ = (attrs.valueRange !== null);
6a1aa64f 3347 }
450fe64b
DV
3348
3349 // TODO(danvk): validate per-series options.
46dde5f9
DV
3350 // Supported:
3351 // strokeWidth
3352 // pointSize
3353 // drawPoints
3354 // highlightCircleSize
450fe64b 3355
9ca829f2
DV
3356 // Check if this set options will require new points.
3357 var requiresNewPoints = Dygraph.isPixelChangingOptionList(this.attr_("labels"), attrs);
3358
48e614ac 3359 Dygraph.updateDeep(this.user_attrs_, attrs);
285a6bda 3360
b635457c
RK
3361 this.attributes_.reparseSeries();
3362
48e614ac
DV
3363 if (file) {
3364 this.file_ = file;
ccfcc169 3365 if (!block_redraw) this.start_();
6a1aa64f 3366 } else {
9ca829f2
DV
3367 if (!block_redraw) {
3368 if (requiresNewPoints) {
48e614ac 3369 this.predraw_();
9ca829f2 3370 } else {
e2c21500 3371 this.renderGraph_(false);
9ca829f2
DV
3372 }
3373 }
6a1aa64f
DV
3374 }
3375};
3376
3377/**
48e614ac
DV
3378 * Returns a copy of the options with deprecated names converted into current
3379 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3380 * interested in that, they should save a copy before calling this.
3381 * @private
3382 */
3383Dygraph.mapLegacyOptions_ = function(attrs) {
3384 var my_attrs = {};
3385 for (var k in attrs) {
3386 if (k == 'file') continue;
3387 if (attrs.hasOwnProperty(k)) my_attrs[k] = attrs[k];
3388 }
3389
3390 var set = function(axis, opt, value) {
3391 if (!my_attrs.axes) my_attrs.axes = {};
3392 if (!my_attrs.axes[axis]) my_attrs.axes[axis] = {};
3393 my_attrs.axes[axis][opt] = value;
3394 };
3395 var map = function(opt, axis, new_opt) {
3396 if (typeof(attrs[opt]) != 'undefined') {
a9172eb1
RK
3397 Dygraph.warn("Option " + opt + " is deprecated. Use the " +
3398 new_opt + " option for the " + axis + " axis instead. " +
33a10307
RK
3399 "(e.g. { axes : { " + axis + " : { " + new_opt + " : ... } } } " +
3400 "(see http://dygraphs.com/per-axis.html for more information.");
48e614ac
DV
3401 set(axis, new_opt, attrs[opt]);
3402 delete my_attrs[opt];
3403 }
3404 };
3405
3406 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3407 map('xValueFormatter', 'x', 'valueFormatter');
3408 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3409 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3410 map('xTicker', 'x', 'ticker');
3411 map('yValueFormatter', 'y', 'valueFormatter');
3412 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3413 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3414 map('yTicker', 'y', 'ticker');
3415 return my_attrs;
3416};
3417
3418/**
697e70b2
DV
3419 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3420 * containing div (which has presumably changed size since the dygraph was
3421 * instantiated. If the width/height are specified, the div will be resized.
964f30c6
DV
3422 *
3423 * This is far more efficient than destroying and re-instantiating a
3424 * Dygraph, since it doesn't have to reparse the underlying data.
3425 *
629a09ae
DV
3426 * @param {Number} [width] Width (in pixels)
3427 * @param {Number} [height] Height (in pixels)
697e70b2
DV
3428 */
3429Dygraph.prototype.resize = function(width, height) {
e8c7ef86
DV
3430 if (this.resize_lock) {
3431 return;
3432 }
3433 this.resize_lock = true;
3434
697e70b2
DV
3435 if ((width === null) != (height === null)) {
3436 this.warn("Dygraph.resize() should be called with zero parameters or " +
3437 "two non-NULL parameters. Pretending it was zero.");
3438 width = height = null;
3439 }
3440
4b4d1a63
DV
3441 var old_width = this.width_;
3442 var old_height = this.height_;
b16e6369 3443
697e70b2
DV
3444 if (width) {
3445 this.maindiv_.style.width = width + "px";
3446 this.maindiv_.style.height = height + "px";
3447 this.width_ = width;
3448 this.height_ = height;
3449 } else {
ccd9d7c2
PF
3450 this.width_ = this.maindiv_.clientWidth;
3451 this.height_ = this.maindiv_.clientHeight;
697e70b2
DV
3452 }
3453
4b4d1a63
DV
3454 if (old_width != this.width_ || old_height != this.height_) {
3455 // TODO(danvk): there should be a clear() method.
3456 this.maindiv_.innerHTML = "";
77b5e09d 3457 this.roller_ = null;
4b4d1a63
DV
3458 this.attrs_.labelsDiv = null;
3459 this.createInterface_();
c9faeafd
DV
3460 if (this.annotations_.length) {
3461 // createInterface_ reset the layout, so we need to do this.
3462 this.layout_.setAnnotations(this.annotations_);
3463 }
487f5523 3464 this.createDragInterface_();
4b4d1a63
DV
3465 this.predraw_();
3466 }
e8c7ef86
DV
3467
3468 this.resize_lock = false;
697e70b2
DV
3469};
3470
3471/**
6faebb69 3472 * Adjusts the number of points in the rolling average. Updates the graph to
6a1aa64f 3473 * reflect the new averaging period.
6faebb69 3474 * @param {Number} length Number of points over which to average the data.
6a1aa64f 3475 */
285a6bda 3476Dygraph.prototype.adjustRoll = function(length) {
6a1aa64f 3477 this.rollPeriod_ = length;
26ca7938 3478 this.predraw_();
6a1aa64f 3479};
540d00f1 3480
f8cfec73 3481/**
1cf11047
DV
3482 * Returns a boolean array of visibility statuses.
3483 */
3484Dygraph.prototype.visibility = function() {
3485 // Do lazy-initialization, so that this happens after we know the number of
3486 // data series.
3487 if (!this.attr_("visibility")) {
758a629f 3488 this.attrs_.visibility = [];
1cf11047 3489 }
758a629f 3490 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs.
395e98a3 3491 while (this.attr_("visibility").length < this.numColumns() - 1) {
758a629f 3492 this.attrs_.visibility.push(true);
1cf11047
DV
3493 }
3494 return this.attr_("visibility");
3495};
3496
3497/**
3498 * Changes the visiblity of a series.
3499 */
3500Dygraph.prototype.setVisibility = function(num, value) {
3501 var x = this.visibility();
a6c109c1 3502 if (num < 0 || num >= x.length) {
1cf11047
DV
3503 this.warn("invalid series number in setVisibility: " + num);
3504 } else {
3505 x[num] = value;
26ca7938 3506 this.predraw_();
1cf11047
DV
3507 }
3508};
3509
3510/**
0cb9bd91
DV
3511 * How large of an area will the dygraph render itself in?
3512 * This is used for testing.
3513 * @return A {width: w, height: h} object.
3514 * @private
3515 */
3516Dygraph.prototype.size = function() {
3517 return { width: this.width_, height: this.height_ };
3518};
3519
3520/**
5c528fa2 3521 * Update the list of annotations and redraw the chart.
41ee764f
DV
3522 * See dygraphs.com/annotations.html for more info on how to use annotations.
3523 * @param ann {Array} An array of annotation objects.
3524 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
5c528fa2 3525 */
a685723c 3526Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3c51ab74
DV
3527 // Only add the annotation CSS rule once we know it will be used.
3528 Dygraph.addAnnotationRule();
5c528fa2
DV
3529 this.annotations_ = ann;
3530 this.layout_.setAnnotations(this.annotations_);
a685723c 3531 if (!suppressDraw) {
26ca7938 3532 this.predraw_();
a685723c 3533 }
5c528fa2
DV
3534};
3535
3536/**
3537 * Return the list of annotations.
3538 */
3539Dygraph.prototype.annotations = function() {
3540 return this.annotations_;
3541};
3542
46dde5f9 3543/**
82c6fe4d
KW
3544 * Get the list of label names for this graph. The first column is the
3545 * x-axis, so the data series names start at index 1.
3546 */
e2c21500 3547Dygraph.prototype.getLabels = function() {
82c6fe4d
KW
3548 return this.attr_("labels").slice();
3549};
3550
3551/**
46dde5f9
DV
3552 * Get the index of a series (column) given its name. The first column is the
3553 * x-axis, so the data series start with index 1.
3554 */
3555Dygraph.prototype.indexFromSetName = function(name) {
82c6fe4d 3556 return this.setIndexByName_[name];
46dde5f9
DV
3557};
3558
629a09ae 3559/**
857a6931
KW
3560 * Get the internal dataset index given its name. These are numbered starting from 0,
3561 * and only count visible sets.
3562 * @private
3563 */
3564Dygraph.prototype.datasetIndexFromSetName_ = function(name) {
3565 return this.datasetIndex_[this.indexFromSetName(name)];
3566};
3567
3568/**
629a09ae
DV
3569 * @private
3570 * Adds a default style for the annotation CSS classes to the document. This is
3571 * only executed when annotations are actually used. It is designed to only be
3572 * called once -- all calls after the first will return immediately.
3573 */
5c528fa2 3574Dygraph.addAnnotationRule = function() {
d38c6191 3575 // TODO(danvk): move this function into plugins/annotations.js?
5c528fa2
DV
3576 if (Dygraph.addedAnnotationCSS) return;
3577
5c528fa2
DV
3578 var rule = "border: 1px solid black; " +
3579 "background-color: white; " +
3580 "text-align: center;";
22186871
DV
3581
3582 var styleSheetElement = document.createElement("style");
3583 styleSheetElement.type = "text/css";
3584 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3585
3586 // Find the first style sheet that we can access.
3587 // We may not add a rule to a style sheet from another domain for security
3588 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3589 // adds its own style sheets from google.com.
3590 for (var i = 0; i < document.styleSheets.length; i++) {
3591 if (document.styleSheets[i].disabled) continue;
3592 var mysheet = document.styleSheets[i];
3593 try {
3594 if (mysheet.insertRule) { // Firefox
3595 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3596 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3597 } else if (mysheet.addRule) { // IE
3598 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3599 }
3600 Dygraph.addedAnnotationCSS = true;
3601 return;
3602 } catch(err) {
3603 // Was likely a security exception.
3604 }
5c528fa2
DV
3605 }
3606
22186871 3607 this.warn("Unable to add default annotation CSS rule; display may be off.");
758a629f 3608};
5c528fa2 3609
285a6bda 3610// Older pages may still use this name.
c0f54d4f 3611var DateGraph = Dygraph;