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