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