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