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