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