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