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