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