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