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