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