Move doUnzoom_ to the public API.
[dygraphs.git] / dygraph.js
CommitLineData
88e95c46
DV
1/**
2 * @license
3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
5 */
6a1aa64f
DV
6
7/**
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
285a6bda
DV
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
6a1aa64f
DV
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
13
14 Usage:
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
285a6bda
DV
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
19 { }); // options
6a1aa64f
DV
20 </script>
21
22 The CSV file is of the form
23
285a6bda 24 Date,SeriesA,SeriesB,SeriesC
6a1aa64f
DV
25 YYYYMMDD,A1,B1,C1
26 YYYYMMDD,A2,B2,C2
27
6a1aa64f
DV
28 If the 'errorBars' option is set in the constructor, the input should be of
29 the form
285a6bda 30 Date,SeriesA,SeriesB,...
6a1aa64f
DV
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
33
34 If the 'fractions' option is set, the input should be of the form:
35
285a6bda 36 Date,SeriesA,SeriesB,...
6a1aa64f
DV
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
39
40 And error bars will be calculated automatically using a binomial distribution.
41
727439b4 42 For further documentation and examples, see http://dygraphs.com/
6a1aa64f
DV
43
44 */
45
758a629f
DV
46/*jshint globalstrict: true */
47/*global DygraphRangeSelector:false, DygraphLayout:false, DygraphCanvasRenderer:false, G_vmlCanvasManager:false */
c0f54d4f
DV
48"use strict";
49
6a1aa64f 50/**
629a09ae
DV
51 * Creates an interactive, zoomable chart.
52 *
53 * @constructor
54 * @param {div | String} div A div or the id of a div into which to construct
55 * the chart.
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
6a1aa64f 60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
629a09ae
DV
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
6a1aa64f 63 */
86a3e64f
DV
64var Dygraph = function(div, data, opts, opt_fourth_param) {
65 if (opt_fourth_param !== undefined) {
66 // Old versions of dygraphs took in the series labels as a constructor
67 // parameter. This doesn't make sense anymore, but it's easy to continue
68 // to support this usage.
69 this.warn("Using deprecated four-argument dygraph constructor");
70 this.__old_init__(div, data, opts, opt_fourth_param);
71 } else {
72 this.__init__(div, data, opts);
285a6bda 73 }
6a1aa64f
DV
74};
75
285a6bda
DV
76Dygraph.NAME = "Dygraph";
77Dygraph.VERSION = "1.2";
78Dygraph.__repr__ = function() {
6a1aa64f
DV
79 return "[" + this.NAME + " " + this.VERSION + "]";
80};
629a09ae
DV
81
82/**
83 * Returns information about the Dygraph class.
84 */
285a6bda 85Dygraph.toString = function() {
6a1aa64f
DV
86 return this.__repr__();
87};
88
89// Various default values
285a6bda
DV
90Dygraph.DEFAULT_ROLL_PERIOD = 1;
91Dygraph.DEFAULT_WIDTH = 480;
92Dygraph.DEFAULT_HEIGHT = 320;
6a1aa64f 93
a96b8ba3
A
94// For max 60 Hz. animation:
95Dygraph.ANIMATION_STEPS = 12;
b1a3b195
DV
96Dygraph.ANIMATION_DURATION = 200;
97
48e614ac
DV
98// These are defined before DEFAULT_ATTRS so that it can refer to them.
99/**
100 * @private
101 * Return a string version of a number. This respects the digitsAfterDecimal
102 * and maxNumberWidth options.
103 * @param {Number} x The number to be formatted
104 * @param {Dygraph} opts An options view
105 * @param {String} name The name of the point's data series
106 * @param {Dygraph} g The dygraph object
107 */
108Dygraph.numberValueFormatter = function(x, opts, pt, g) {
109 var sigFigs = opts('sigFigs');
110
111 if (sigFigs !== null) {
112 // User has opted for a fixed number of significant figures.
113 return Dygraph.floatFormat(x, sigFigs);
114 }
115
116 var digits = opts('digitsAfterDecimal');
117 var maxNumberWidth = opts('maxNumberWidth');
118
119 // switch to scientific notation if we underflow or overflow fixed display.
120 if (x !== 0.0 &&
121 (Math.abs(x) >= Math.pow(10, maxNumberWidth) ||
122 Math.abs(x) < Math.pow(10, -digits))) {
123 return x.toExponential(digits);
124 } else {
125 return '' + Dygraph.round_(x, digits);
126 }
127};
128
129/**
130 * variant for use as an axisLabelFormatter.
131 * @private
132 */
133Dygraph.numberAxisLabelFormatter = function(x, granularity, opts, g) {
134 return Dygraph.numberValueFormatter(x, opts, g);
135};
136
137/**
138 * Convert a JS date (millis since epoch) to YYYY/MM/DD
139 * @param {Number} date The JavaScript date (ms since epoch)
140 * @return {String} A date of the form "YYYY/MM/DD"
141 * @private
142 */
143Dygraph.dateString_ = function(date) {
144 var zeropad = Dygraph.zeropad;
145 var d = new Date(date);
146
147 // Get the year:
148 var year = "" + d.getFullYear();
149 // Get a 0 padded month string
150 var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh
151 // Get a 0 padded day string
152 var day = zeropad(d.getDate());
153
154 var ret = "";
155 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
156 if (frac) ret = " " + Dygraph.hmsString_(date);
157
158 return year + "/" + month + "/" + day + ret;
159};
160
161/**
162 * Convert a JS date to a string appropriate to display on an axis that
163 * is displaying values at the stated granularity.
164 * @param {Date} date The date to format
165 * @param {Number} granularity One of the Dygraph granularity constants
166 * @return {String} The formatted date
167 * @private
168 */
169Dygraph.dateAxisFormatter = function(date, granularity) {
170 if (granularity >= Dygraph.DECADAL) {
171 return date.strftime('%Y');
172 } else if (granularity >= Dygraph.MONTHLY) {
173 return date.strftime('%b %y');
174 } else {
175 var frac = date.getHours() * 3600 + date.getMinutes() * 60 + date.getSeconds() + date.getMilliseconds();
758a629f 176 if (frac === 0 || granularity >= Dygraph.DAILY) {
48e614ac
DV
177 return new Date(date.getTime() + 3600*1000).strftime('%d%b');
178 } else {
179 return Dygraph.hmsString_(date.getTime());
180 }
181 }
182};
183
38e3d209
DV
184/**
185 * Standard plotters. These may be used by clients.
186 * Available plotters are:
187 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
188 * - Dygraph.Plotters.errorPlotter: draws error bars
189 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
190 *
191 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
192 * This causes all the lines to be drawn over all the fills/error bars.
193 */
194Dygraph.Plotters = DygraphCanvasRenderer._Plotters;
195
48e614ac 196
8e4a6af3 197// Default attribute values.
285a6bda 198Dygraph.DEFAULT_ATTRS = {
a9fc39ab 199 highlightCircleSize: 3,
857a6931 200 highlightSeriesOpts: null,
afdb20d8 201 highlightSeriesBackgroundAlpha: 0.5,
285a6bda 202
8e4a6af3
DV
203 labelsDivWidth: 250,
204 labelsDivStyles: {
205 // TODO(danvk): move defaults from createStatusMessage_ here.
285a6bda
DV
206 },
207 labelsSeparateLines: false,
bcd3ebf0 208 labelsShowZeroValues: true,
285a6bda 209 labelsKMB: false,
afefbcdb 210 labelsKMG2: false,
d160cc3b 211 showLabelsOnHighlight: true,
12e4c741 212
2e1fcf1a
DV
213 digitsAfterDecimal: 2,
214 maxNumberWidth: 6,
19589a3e 215 sigFigs: null,
285a6bda
DV
216
217 strokeWidth: 1.0,
857a6931
KW
218 strokeBorderWidth: 0,
219 strokeBorderColor: "white",
8e4a6af3 220
8846615a
DV
221 axisTickSize: 3,
222 axisLabelFontSize: 14,
223 xAxisLabelWidth: 50,
224 yAxisLabelWidth: 50,
225 rightGap: 5,
285a6bda
DV
226
227 showRoller: false,
285a6bda 228 xValueParser: Dygraph.dateParser,
285a6bda 229
3d67f03b
DV
230 delimiter: ',',
231
285a6bda
DV
232 sigma: 2.0,
233 errorBars: false,
234 fractions: false,
235 wilsonInterval: true, // only relevant if fractions is true
5954ef32 236 customBars: false,
43af96e7
NK
237 fillGraph: false,
238 fillAlpha: 0.15,
f032c51d 239 connectSeparatedPoints: false,
43af96e7
NK
240
241 stackedGraph: false,
afdc483f
NN
242 hideOverlayOnMouseOut: true,
243
2fccd3dc
DV
244 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
245 legend: 'onmouseover', // the only relevant value at the moment is 'always'.
246
00c281d4 247 stepPlot: false,
062ef401 248 avoidMinZero: false,
f4b87da2 249 drawAxesAtZero: false,
062ef401 250
ad1798c2 251 // Sizes of the various chart labels.
b4202b3d 252 titleHeight: 28,
86cce9e8
DV
253 xLabelHeight: 18,
254 yLabelWidth: 18,
ad1798c2 255
423f5ed3
DV
256 drawXAxis: true,
257 drawYAxis: true,
258 axisLineColor: "black",
990d6a35
DV
259 axisLineWidth: 0.3,
260 gridLineWidth: 0.3,
261 axisLabelColor: "black",
262 axisLabelFont: "Arial", // TODO(danvk): is this implemented?
263 axisLabelWidth: 50,
264 drawYGrid: true,
265 drawXGrid: true,
266 gridLineColor: "rgb(128,128,128)",
423f5ed3 267
48e614ac 268 interactionModel: null, // will be set to Dygraph.Interaction.defaultModel
b1a3b195 269 animatedZooms: false, // (for now)
48e614ac 270
ccd9d7c2
PF
271 // Range selector options
272 showRangeSelector: false,
273 rangeSelectorHeight: 40,
274 rangeSelectorPlotStrokeColor: "#808FAB",
275 rangeSelectorPlotFillColor: "#A7B1C4",
276
38e3d209
DV
277 // The ordering here ensures that central lines always appear above any
278 // fill bars/error bars.
279 plotter: [
280 Dygraph.Plotters.fillPlotter,
281 Dygraph.Plotters.errorPlotter,
282 Dygraph.Plotters.linePlotter
283 ],
284
48e614ac
DV
285 // per-axis options
286 axes: {
287 x: {
288 pixelsPerLabel: 60,
289 axisLabelFormatter: Dygraph.dateAxisFormatter,
290 valueFormatter: Dygraph.dateString_,
291 ticker: null // will be set in dygraph-tickers.js
292 },
293 y: {
294 pixelsPerLabel: 30,
295 valueFormatter: Dygraph.numberValueFormatter,
296 axisLabelFormatter: Dygraph.numberAxisLabelFormatter,
297 ticker: null // will be set in dygraph-tickers.js
298 },
299 y2: {
300 pixelsPerLabel: 30,
301 valueFormatter: Dygraph.numberValueFormatter,
302 axisLabelFormatter: Dygraph.numberAxisLabelFormatter,
303 ticker: null // will be set in dygraph-tickers.js
304 }
305 }
285a6bda
DV
306};
307
39b0e098
RK
308// Directions for panning and zooming. Use bit operations when combined
309// values are possible.
310Dygraph.HORIZONTAL = 1;
311Dygraph.VERTICAL = 2;
312
e2c21500
DV
313// Installed plugins, in order of precedence (most-general to most-specific).
314// Plugins are installed after they are defined, in plugins/install.js.
315Dygraph.PLUGINS = [
316];
317
5c528fa2
DV
318// Used for initializing annotation CSS rules only once.
319Dygraph.addedAnnotationCSS = false;
320
285a6bda
DV
321Dygraph.prototype.__old_init__ = function(div, file, labels, attrs) {
322 // Labels is no longer a constructor parameter, since it's typically set
323 // directly from the data source. It also conains a name for the x-axis,
324 // which the previous constructor form did not.
758a629f 325 if (labels !== null) {
285a6bda
DV
326 var new_labels = ["Date"];
327 for (var i = 0; i < labels.length; i++) new_labels.push(labels[i]);
fc80a396 328 Dygraph.update(attrs, { 'labels': new_labels });
285a6bda
DV
329 }
330 this.__init__(div, file, attrs);
8e4a6af3
DV
331};
332
6a1aa64f 333/**
285a6bda 334 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
7aedf6fe 335 * and context &lt;canvas&gt; inside of it. See the constructor for details.
6a1aa64f 336 * on the parameters.
12e4c741 337 * @param {Element} div the Element to render the graph into.
6a1aa64f 338 * @param {String | Function} file Source data
6a1aa64f
DV
339 * @param {Object} attrs Miscellaneous other options
340 * @private
341 */
285a6bda 342Dygraph.prototype.__init__ = function(div, file, attrs) {
a2c8fff4
DV
343 // Hack for IE: if we're using excanvas and the document hasn't finished
344 // loading yet (and hence may not have initialized whatever it needs to
345 // initialize), then keep calling this routine periodically until it has.
346 if (/MSIE/.test(navigator.userAgent) && !window.opera &&
347 typeof(G_vmlCanvasManager) != 'undefined' &&
348 document.readyState != 'complete') {
349 var self = this;
758a629f 350 setTimeout(function() { self.__init__(div, file, attrs); }, 100);
ccd9d7c2 351 return;
a2c8fff4
DV
352 }
353
285a6bda 354 // Support two-argument constructor
758a629f 355 if (attrs === null || attrs === undefined) { attrs = {}; }
285a6bda 356
48e614ac
DV
357 attrs = Dygraph.mapLegacyOptions_(attrs);
358
8a870376
RK
359 if (typeof(div) == 'string') {
360 div = document.getElementById(div);
361 }
362
48e614ac
DV
363 if (!div) {
364 Dygraph.error("Constructing dygraph with a non-existent div!");
365 return;
366 }
367
920208fb
PF
368 this.isUsingExcanvas_ = typeof(G_vmlCanvasManager) != 'undefined';
369
6a1aa64f 370 // Copy the important bits into the object
32988383 371 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
6a1aa64f 372 this.maindiv_ = div;
6a1aa64f 373 this.file_ = file;
285a6bda 374 this.rollPeriod_ = attrs.rollPeriod || Dygraph.DEFAULT_ROLL_PERIOD;
6a1aa64f 375 this.previousVerticalX_ = -1;
6a1aa64f 376 this.fractions_ = attrs.fractions || false;
6a1aa64f 377 this.dateWindow_ = attrs.dateWindow || null;
8b83c6cc 378
fe0b7c03 379 this.is_initial_draw_ = true;
5c528fa2 380 this.annotations_ = [];
7aedf6fe 381
45f2c689 382 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
57baab03
NN
383 this.zoomed_x_ = false;
384 this.zoomed_y_ = false;
45f2c689 385
f7d6278e
DV
386 // Clear the div. This ensure that, if multiple dygraphs are passed the same
387 // div, then only one will be drawn.
388 div.innerHTML = "";
389
0cb9bd91
DV
390 // For historical reasons, the 'width' and 'height' options trump all CSS
391 // rules _except_ for an explicit 'width' or 'height' on the div.
392 // As an added convenience, if the div has zero height (like <div></div> does
393 // without any styles), then we use a default height/width.
758a629f 394 if (div.style.width === '' && attrs.width) {
0cb9bd91 395 div.style.width = attrs.width + "px";
285a6bda 396 }
758a629f 397 if (div.style.height === '' && attrs.height) {
0cb9bd91 398 div.style.height = attrs.height + "px";
32988383 399 }
758a629f 400 if (div.style.height === '' && div.clientHeight === 0) {
0cb9bd91 401 div.style.height = Dygraph.DEFAULT_HEIGHT + "px";
758a629f 402 if (div.style.width === '') {
0cb9bd91
DV
403 div.style.width = Dygraph.DEFAULT_WIDTH + "px";
404 }
c21d2c2d 405 }
fffad740 406 // these will be zero if the dygraph's div is hidden.
ccd9d7c2
PF
407 this.width_ = div.clientWidth;
408 this.height_ = div.clientHeight;
32988383 409
344ba8c0 410 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
758a629f
DV
411 if (attrs.stackedGraph) {
412 attrs.fillGraph = true;
43af96e7
NK
413 // TODO(nikhilk): Add any other stackedGraph checks here.
414 }
415
e71332d6
DV
416 // These two options have a bad interaction. See issue 359.
417 if (attrs.showRangeSelector && attrs.animatedZooms) {
418 this.warn('You should not set animatedZooms=true when using the range selector.');
419 attrs.animatedZooms = false;
420 }
421
a9172eb1
RK
422 // DEPRECATION WARNING: All option processing should be moved from
423 // attrs_ and user_attrs_ to options_, which holds all this information.
424 //
285a6bda
DV
425 // Dygraphs has many options, some of which interact with one another.
426 // To keep track of everything, we maintain two sets of options:
427 //
c21d2c2d 428 // this.user_attrs_ only options explicitly set by the user.
285a6bda
DV
429 // this.attrs_ defaults, options derived from user_attrs_, data.
430 //
431 // Options are then accessed this.attr_('attr'), which first looks at
432 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
433 // defaults without overriding behavior that the user specifically asks for.
434 this.user_attrs_ = {};
fc80a396 435 Dygraph.update(this.user_attrs_, attrs);
6a1aa64f 436
48e614ac 437 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
285a6bda 438 this.attrs_ = {};
48e614ac 439 Dygraph.updateDeep(this.attrs_, Dygraph.DEFAULT_ATTRS);
6a1aa64f 440
16269f6e 441 this.boundaryIds_ = [];
82c6fe4d 442 this.setIndexByName_ = {};
857a6931 443 this.datasetIndex_ = [];
6a1aa64f 444
6a4587ac 445 this.registeredEvents_ = [];
de8f284f 446 this.eventListeners_ = {};
6a4587ac 447
c1780ad0
RK
448 this.attributes_ = new DygraphOptions(this);
449
6a1aa64f
DV
450 // Create the containing DIV and other interactive elements
451 this.createInterface_();
452
e2c21500
DV
453 // Activate plugins.
454 this.plugins_ = [];
455 for (var i = 0; i < Dygraph.PLUGINS.length; i++) {
42a9ebb8
DV
456 var Plugin = Dygraph.PLUGINS[i];
457 var pluginInstance = new Plugin();
e2c21500
DV
458 var pluginDict = {
459 plugin: pluginInstance,
460 events: {},
461 options: {},
462 pluginOptions: {}
463 };
464
6a4457b4
KW
465 var handlers = pluginInstance.activate(this);
466 for (var eventName in handlers) {
28aa77ac 467 // TODO(danvk): validate eventName.
6a4457b4
KW
468 pluginDict.events[eventName] = handlers[eventName];
469 }
e2c21500
DV
470
471 this.plugins_.push(pluginDict);
472 }
473
474 // At this point, plugins can no longer register event handlers.
475 // Construct a map from event -> ordered list of [callback, plugin].
e2c21500
DV
476 for (var i = 0; i < this.plugins_.length; i++) {
477 var plugin_dict = this.plugins_[i];
478 for (var eventName in plugin_dict.events) {
479 if (!plugin_dict.events.hasOwnProperty(eventName)) continue;
480 var callback = plugin_dict.events[eventName];
481
482 var pair = [plugin_dict.plugin, callback];
483 if (!(eventName in this.eventListeners_)) {
484 this.eventListeners_[eventName] = [pair];
485 } else {
486 this.eventListeners_[eventName].push(pair);
487 }
488 }
489 }
490
738fc797 491 this.start_();
6a1aa64f
DV
492};
493
dcb25130 494/**
e2c21500
DV
495 * Triggers a cascade of events to the various plugins which are interested in them.
496 * Returns true if the "default behavior" should be performed, i.e. if none of
497 * the event listeners called event.preventDefault().
498 * @private
499 */
500Dygraph.prototype.cascadeEvents_ = function(name, extra_props) {
42a9ebb8 501 if (!(name in this.eventListeners_)) return true;
e2c21500
DV
502
503 // QUESTION: can we use objects & prototypes to speed this up?
504 var e = {
505 dygraph: this,
506 cancelable: false,
507 defaultPrevented: false,
508 preventDefault: function() {
509 if (!e.cancelable) throw "Cannot call preventDefault on non-cancelable event.";
510 e.defaultPrevented = true;
511 },
512 propagationStopped: false,
513 stopPropagation: function() {
5bd29cf4 514 e.propagationStopped = true;
e2c21500
DV
515 }
516 };
517 Dygraph.update(e, extra_props);
518
519 var callback_plugin_pairs = this.eventListeners_[name];
da1c187b
KW
520 if (callback_plugin_pairs) {
521 for (var i = callback_plugin_pairs.length - 1; i >= 0; i--) {
522 var plugin = callback_plugin_pairs[i][0];
523 var callback = callback_plugin_pairs[i][1];
524 callback.call(plugin, e);
525 if (e.propagationStopped) break;
526 }
e2c21500
DV
527 }
528 return e.defaultPrevented;
529};
530
531/**
dcb25130
NN
532 * Returns the zoomed status of the chart for one or both axes.
533 *
534 * Axis is an optional parameter. Can be set to 'x' or 'y'.
535 *
536 * The zoomed status for an axis is set whenever a user zooms using the mouse
42a9ebb8
DV
537 * or when the dateWindow or valueRange are updated (unless the
538 * isZoomedIgnoreProgrammaticZoom option is also specified).
dcb25130 539 */
57baab03 540Dygraph.prototype.isZoomed = function(axis) {
42a9ebb8
DV
541 if (axis === null || axis === undefined) {
542 return this.zoomed_x_ || this.zoomed_y_;
543 }
758a629f
DV
544 if (axis === 'x') return this.zoomed_x_;
545 if (axis === 'y') return this.zoomed_y_;
94ea5744 546 throw "axis parameter is [" + axis + "] must be null, 'x' or 'y'.";
57baab03
NN
547};
548
629a09ae
DV
549/**
550 * Returns information about the Dygraph object, including its containing ID.
551 */
22bd1dfb
RK
552Dygraph.prototype.toString = function() {
553 var maindiv = this.maindiv_;
758a629f 554 var id = (maindiv && maindiv.id) ? maindiv.id : maindiv;
22bd1dfb 555 return "[Dygraph " + id + "]";
758a629f 556};
22bd1dfb 557
629a09ae
DV
558/**
559 * @private
560 * Returns the value of an option. This may be set by the user (either in the
561 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
562 * per-series value.
563 * @param { String } name The name of the option, e.g. 'rollPeriod'.
564 * @param { String } [seriesName] The name of the series to which the option
565 * will be applied. If no per-series value of this option is available, then
566 * the global value is returned. This is optional.
567 * @return { ... } The value of the option.
568 */
227b93cc 569Dygraph.prototype.attr_ = function(name, seriesName) {
028ddf8a
DV
570// <REMOVE_FOR_COMBINED>
571 if (typeof(Dygraph.OPTIONS_REFERENCE) === 'undefined') {
572 this.error('Must include options reference JS for testing');
573 } else if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(name)) {
574 this.error('Dygraphs is using property ' + name + ', which has no entry ' +
575 'in the Dygraphs.OPTIONS_REFERENCE listing.');
576 // Only log this error once.
577 Dygraph.OPTIONS_REFERENCE[name] = true;
578 }
579// </REMOVE_FOR_COMBINED>
5daa462d 580 return seriesName ? this.attributes_.getForSeries(name, seriesName) : this.attributes_.get(name);
285a6bda
DV
581};
582
6a1aa64f 583/**
e2c21500
DV
584 * Returns the current value for an option, as set in the constructor or via
585 * updateOptions. You may pass in an (optional) series name to get per-series
586 * values for the option.
587 *
588 * All values returned by this method should be considered immutable. If you
589 * modify them, there is no guarantee that the changes will be honored or that
590 * dygraphs will remain in a consistent state. If you want to modify an option,
591 * use updateOptions() instead.
592 *
593 * @param { String } name The name of the option (e.g. 'strokeWidth')
594 * @param { String } [opt_seriesName] Series name to get per-series values.
595 * @return { ... } The value of the option.
596 */
597Dygraph.prototype.getOption = function(name, opt_seriesName) {
598 return this.attr_(name, opt_seriesName);
599};
600
48dc3815
RK
601Dygraph.prototype.getOptionForAxis = function(name, axis) {
602 return this.attributes_.getForAxis(name, axis);
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
ccd9d7c2
PF
949 if (this.attr_('showRangeSelector')) {
950 // The range selector must be created here so that its canvases and contexts get created here.
951 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
ccd9d7c2
PF
952 this.rangeSelector_ = new DygraphRangeSelector(this);
953 }
954
eb7bf005
EC
955 // The interactive parts of the graph are drawn on top of the chart.
956 this.graphDiv.appendChild(this.hidden_);
957 this.graphDiv.appendChild(this.canvas_);
920208fb
PF
958 this.mouseEventElement_ = this.createMouseEventElement_();
959
960 // Create the grapher
961 this.layout_ = new DygraphLayout(this);
962
963 if (this.rangeSelector_) {
964 // This needs to happen after the graph canvases are added to the div and the layout object is created.
965 this.rangeSelector_.addToGraph(this.graphDiv, this.layout_);
966 }
eb7bf005 967
76171648 968 var dygraph = this;
de8f284f 969
d7eddd78 970 this.mouseMoveHandler = function(e) {
421f1773 971 dygraph.mouseMove_(e);
d7eddd78 972 };
6a4587ac 973 this.addEvent(this.mouseEventElement_, 'mousemove', this.mouseMoveHandler);
de8f284f 974
d7eddd78 975 this.mouseOutHandler = function(e) {
421f1773 976 dygraph.mouseOut_(e);
d7eddd78 977 };
6a4587ac 978 this.addEvent(this.mouseEventElement_, 'mouseout', this.mouseOutHandler);
697e70b2 979
697e70b2 980 this.createDragInterface_();
4b4d1a63 981
1c6b239c 982 this.resizeHandler = function(e) {
983 dygraph.resize();
d7eddd78 984 };
1c6b239c 985
4b4d1a63
DV
986 // Update when the window is resized.
987 // TODO(danvk): drop frames depending on complexity of the chart.
6a4587ac 988 this.addEvent(window, 'resize', this.resizeHandler);
4cfcc38c
DV
989};
990
991/**
992 * Detach DOM elements in the dygraph and null out all data references.
993 * Calling this when you're done with a dygraph can dramatically reduce memory
994 * usage. See, e.g., the tests/perf.html example.
995 */
996Dygraph.prototype.destroy = function() {
997 var removeRecursive = function(node) {
998 while (node.hasChildNodes()) {
999 removeRecursive(node.firstChild);
1000 node.removeChild(node.firstChild);
1001 }
1002 };
de8f284f 1003
6a4587ac
RK
1004 for (var idx = 0; idx < this.registeredEvents_.length; idx++) {
1005 var reg = this.registeredEvents_[idx];
1cc3540b 1006 Dygraph.removeEvent(reg.elem, reg.type, reg.fn);
6a4587ac
RK
1007 }
1008 this.registeredEvents_ = [];
1009
1010 // remove mouse event handlers (This may not be necessary anymore)
1cc3540b
RK
1011 Dygraph.removeEvent(this.mouseEventElement_, 'mouseout', this.mouseOutHandler);
1012 Dygraph.removeEvent(this.mouseEventElement_, 'mousemove', this.mouseMoveHandler);
1013 Dygraph.removeEvent(this.mouseEventElement_, 'mousemove', this.mouseUpHandler_);
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 };
1c6b239c 1023 // remove event handlers
1cc3540b 1024 Dygraph.removeEvent(window,'resize',this.resizeHandler);
1c6b239c 1025 this.resizeHandler = null;
4cfcc38c
DV
1026 // These may not all be necessary, but it can't hurt...
1027 nullOut(this.layout_);
1028 nullOut(this.plotter_);
1029 nullOut(this);
1030};
6a1aa64f
DV
1031
1032/**
629a09ae
DV
1033 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1034 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1035 * or the zoom rectangles) is done on this.canvas_.
8846615a 1036 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
6a1aa64f
DV
1037 * @return {Object} The newly-created canvas
1038 * @private
1039 */
285a6bda 1040Dygraph.prototype.createPlotKitCanvas_ = function(canvas) {
f8cfec73 1041 var h = Dygraph.createCanvas();
6a1aa64f 1042 h.style.position = "absolute";
9ac5e4ae
DV
1043 // TODO(danvk): h should be offset from canvas. canvas needs to include
1044 // some extra area to make it easier to zoom in on the far left and far
1045 // right. h needs to be precisely the plot area, so that clipping occurs.
6a1aa64f
DV
1046 h.style.top = canvas.style.top;
1047 h.style.left = canvas.style.left;
1048 h.width = this.width_;
1049 h.height = this.height_;
f8cfec73
DV
1050 h.style.width = this.width_ + "px"; // for IE
1051 h.style.height = this.height_ + "px"; // for IE
6a1aa64f
DV
1052 return h;
1053};
1054
629a09ae 1055/**
920208fb
PF
1056 * Creates an overlay element used to handle mouse events.
1057 * @return {Object} The mouse event element.
1058 * @private
1059 */
1060Dygraph.prototype.createMouseEventElement_ = function() {
1061 if (this.isUsingExcanvas_) {
1062 var elem = document.createElement("div");
1063 elem.style.position = 'absolute';
1064 elem.style.backgroundColor = 'white';
1065 elem.style.filter = 'alpha(opacity=0)';
1066 elem.style.width = this.width_ + "px";
1067 elem.style.height = this.height_ + "px";
1068 this.graphDiv.appendChild(elem);
1069 return elem;
1070 } else {
1071 return this.canvas_;
1072 }
1073};
1074
1075/**
6a1aa64f
DV
1076 * Generate a set of distinct colors for the data series. This is done with a
1077 * color wheel. Saturation/Value are customizable, and the hue is
1078 * equally-spaced around the color wheel. If a custom set of colors is
1079 * specified, that is used instead.
6a1aa64f
DV
1080 * @private
1081 */
285a6bda 1082Dygraph.prototype.setColors_ = function() {
ee53deb9
DV
1083 var labels = this.getLabels();
1084 var num = labels.length - 1;
6a1aa64f 1085 this.colors_ = [];
ee53deb9 1086 this.colorsMap_ = {};
285a6bda 1087 var colors = this.attr_('colors');
758a629f 1088 var i;
285a6bda
DV
1089 if (!colors) {
1090 var sat = this.attr_('colorSaturation') || 1.0;
1091 var val = this.attr_('colorValue') || 0.5;
2aa21213 1092 var half = Math.ceil(num / 2);
758a629f 1093 for (i = 1; i <= num; i++) {
ec1959eb 1094 if (!this.visibility()[i-1]) continue;
43af96e7 1095 // alternate colors for high contrast.
2aa21213 1096 var idx = i % 2 ? Math.ceil(i / 2) : (half + i / 2);
43af96e7 1097 var hue = (1.0 * idx/ (1 + num));
ee53deb9
DV
1098 var colorStr = Dygraph.hsvToRGB(hue, sat, val);
1099 this.colors_.push(colorStr);
1100 this.colorsMap_[labels[i]] = colorStr;
6a1aa64f
DV
1101 }
1102 } else {
758a629f 1103 for (i = 0; i < num; i++) {
ec1959eb 1104 if (!this.visibility()[i]) continue;
285a6bda 1105 var colorStr = colors[i % colors.length];
f474c2a3 1106 this.colors_.push(colorStr);
ee53deb9 1107 this.colorsMap_[labels[1 + i]] = colorStr;
6a1aa64f
DV
1108 }
1109 }
629a09ae 1110};
6a1aa64f 1111
43af96e7
NK
1112/**
1113 * Return the list of colors. This is either the list of colors passed in the
629a09ae 1114 * attributes or the autogenerated list of rgb(r,g,b) strings.
e2c21500 1115 * This does not return colors for invisible series.
43af96e7
NK
1116 * @return {Array<string>} The list of colors.
1117 */
1118Dygraph.prototype.getColors = function() {
1119 return this.colors_;
1120};
1121
6a1aa64f 1122/**
e2c21500
DV
1123 * Returns a few attributes of a series, i.e. its color, its visibility, which
1124 * axis it's assigned to, and its column in the original data.
1125 * Returns null if the series does not exist.
1126 * Otherwise, returns an object with column, visibility, color and axis properties.
1127 * The "axis" property will be set to 1 for y1 and 2 for y2.
1128 * The "column" property can be fed back into getValue(row, column) to get
1129 * values for this series.
6a1aa64f 1130 */
e2c21500
DV
1131Dygraph.prototype.getPropertiesForSeries = function(series_name) {
1132 var idx = -1;
1133 var labels = this.getLabels();
1134 for (var i = 1; i < labels.length; i++) {
1135 if (labels[i] == series_name) {
1136 idx = i;
1137 break;
b0c3b730 1138 }
6a1aa64f 1139 }
e2c21500 1140 if (idx == -1) return null;
0abfbd7e 1141
e2c21500
DV
1142 return {
1143 name: series_name,
1144 column: idx,
1145 visible: this.visibility()[idx - 1],
189f8030 1146 color: this.colorsMap_[series_name],
16f00742 1147 axis: 1 + this.attributes_.axisForSeries(series_name)
e2c21500 1148 };
0abfbd7e
DV
1149};
1150
1151/**
6a1aa64f 1152 * Create the text box to adjust the averaging period
6a1aa64f
DV
1153 * @private
1154 */
285a6bda 1155Dygraph.prototype.createRollInterface_ = function() {
8c69de65
DV
1156 // Create a roller if one doesn't exist already.
1157 if (!this.roller_) {
1158 this.roller_ = document.createElement("input");
1159 this.roller_.type = "text";
1160 this.roller_.style.display = "none";
1161 this.graphDiv.appendChild(this.roller_);
1162 }
1163
1164 var display = this.attr_('showRoller') ? 'block' : 'none';
26ca7938 1165
0c38f187 1166 var area = this.plotter_.area;
b0c3b730
DV
1167 var textAttr = { "position": "absolute",
1168 "zIndex": 10,
0c38f187
DV
1169 "top": (area.y + area.h - 25) + "px",
1170 "left": (area.x + 1) + "px",
b0c3b730 1171 "display": display
6a1aa64f 1172 };
8c69de65
DV
1173 this.roller_.size = "2";
1174 this.roller_.value = this.rollPeriod_;
b0c3b730 1175 for (var name in textAttr) {
85b99f0b 1176 if (textAttr.hasOwnProperty(name)) {
8c69de65 1177 this.roller_.style[name] = textAttr[name];
85b99f0b 1178 }
b0c3b730
DV
1179 }
1180
76171648 1181 var dygraph = this;
8c69de65 1182 this.roller_.onchange = function() { dygraph.adjustRoll(dygraph.roller_.value); };
76171648
DV
1183};
1184
629a09ae
DV
1185/**
1186 * @private
629a09ae
DV
1187 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1188 * canvas (i.e. DOM Coords).
1189 */
062ef401 1190Dygraph.prototype.dragGetX_ = function(e, context) {
758a629f 1191 return Dygraph.pageX(e) - context.px;
062ef401 1192};
bce01b0f 1193
629a09ae
DV
1194/**
1195 * @private
1196 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1197 * canvas (i.e. DOM Coords).
1198 */
062ef401 1199Dygraph.prototype.dragGetY_ = function(e, context) {
758a629f 1200 return Dygraph.pageY(e) - context.py;
062ef401 1201};
ee672584 1202
629a09ae 1203/**
062ef401
JB
1204 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1205 * events.
1206 * @private
1207 */
1208Dygraph.prototype.createDragInterface_ = function() {
1209 var context = {
1210 // Tracks whether the mouse is down right now
1211 isZooming: false,
1212 isPanning: false, // is this drag part of a pan?
1213 is2DPan: false, // if so, is that pan 1- or 2-dimensional?
8442269f
RK
1214 dragStartX: null, // pixel coordinates
1215 dragStartY: null, // pixel coordinates
1216 dragEndX: null, // pixel coordinates
1217 dragEndY: null, // pixel coordinates
062ef401 1218 dragDirection: null,
8442269f
RK
1219 prevEndX: null, // pixel coordinates
1220 prevEndY: null, // pixel coordinates
062ef401 1221 prevDragDirection: null,
421f1773 1222 cancelNextDblclick: false, // see comment in dygraph-interaction-model.js
062ef401 1223
ec291cbe
RK
1224 // The value on the left side of the graph when a pan operation starts.
1225 initialLeftmostDate: null,
1226
1227 // The number of units each pixel spans. (This won't be valid for log
1228 // scales)
1229 xUnitsPerPixel: null,
062ef401
JB
1230
1231 // TODO(danvk): update this comment
1232 // The range in second/value units that the viewport encompasses during a
1233 // panning operation.
1234 dateRange: null,
1235
8442269f
RK
1236 // Top-left corner of the canvas, in DOM coords
1237 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
062ef401
JB
1238 px: 0,
1239 py: 0,
1240
965a030e 1241 // Values for use with panEdgeFraction, which limit how far outside the
4cac8c7a
RK
1242 // graph's data boundaries it can be panned.
1243 boundedDates: null, // [minDate, maxDate]
1244 boundedValues: null, // [[minValue, maxValue] ...]
1245
2bad4d92
DV
1246 // We cover iframes during mouse interactions. See comments in
1247 // dygraph-utils.js for more info on why this is a good idea.
1248 tarp: new Dygraph.IFrameTarp(),
1249
6a4587ac
RK
1250 // contextB is the same thing as this context object but renamed.
1251 initializeMouseDown: function(event, g, contextB) {
062ef401
JB
1252 // prevents mouse drags from selecting page text.
1253 if (event.preventDefault) {
1254 event.preventDefault(); // Firefox, Chrome, etc.
6a1aa64f 1255 } else {
062ef401
JB
1256 event.returnValue = false; // IE
1257 event.cancelBubble = true;
6a1aa64f
DV
1258 }
1259
6a4587ac
RK
1260 contextB.px = Dygraph.findPosX(g.canvas_);
1261 contextB.py = Dygraph.findPosY(g.canvas_);
1262 contextB.dragStartX = g.dragGetX_(event, contextB);
1263 contextB.dragStartY = g.dragGetY_(event, contextB);
1264 contextB.cancelNextDblclick = false;
2bad4d92 1265 contextB.tarp.cover();
6a1aa64f 1266 }
062ef401 1267 };
2b188b3d 1268
062ef401 1269 var interactionModel = this.attr_("interactionModel");
8b83c6cc 1270
062ef401
JB
1271 // Self is the graph.
1272 var self = this;
6faebb69 1273
062ef401
JB
1274 // Function that binds the graph and context to the handler.
1275 var bindHandler = function(handler) {
1276 return function(event) {
1277 handler(event, self, context);
1278 };
1279 };
1280
1281 for (var eventName in interactionModel) {
1282 if (!interactionModel.hasOwnProperty(eventName)) continue;
6a4587ac 1283 this.addEvent(this.mouseEventElement_, eventName,
062ef401
JB
1284 bindHandler(interactionModel[eventName]));
1285 }
1286
1287 // If the user releases the mouse button during a drag, but not over the
1288 // canvas, then it doesn't count as a zooming action.
cb1261cb 1289 this.mouseUpHandler_ = function(event) {
062ef401
JB
1290 if (context.isZooming || context.isPanning) {
1291 context.isZooming = false;
1292 context.dragStartX = null;
1293 context.dragStartY = null;
1294 }
1295
1296 if (context.isPanning) {
1297 context.isPanning = false;
1298 context.draggingDate = null;
1299 context.dateRange = null;
1300 for (var i = 0; i < self.axes_.length; i++) {
1301 delete self.axes_[i].draggingValue;
1302 delete self.axes_[i].dragValueRange;
1303 }
1304 }
2bad4d92
DV
1305
1306 context.tarp.uncover();
cb1261cb
DV
1307 };
1308
bc3e2c5d 1309 this.addEvent(document, 'mouseup', this.mouseUpHandler_);
6a1aa64f
DV
1310};
1311
1312/**
1313 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1314 * up any previous zoom rectangles that were drawn. This could be optimized to
1315 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1316 * dots.
ccd9d7c2 1317 *
39b0e098
RK
1318 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1319 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
6a1aa64f
DV
1320 * @param {Number} startX The X position where the drag started, in canvas
1321 * coordinates.
1322 * @param {Number} endX The current X position of the drag, in canvas coords.
8b83c6cc
RK
1323 * @param {Number} startY The Y position where the drag started, in canvas
1324 * coordinates.
1325 * @param {Number} endY The current Y position of the drag, in canvas coords.
39b0e098 1326 * @param {Number} prevDirection the value of direction on the previous call to
8b83c6cc 1327 * this function. Used to avoid excess redrawing
6a1aa64f
DV
1328 * @param {Number} prevEndX The value of endX on the previous call to this
1329 * function. Used to avoid excess redrawing
8b83c6cc
RK
1330 * @param {Number} prevEndY The value of endY on the previous call to this
1331 * function. Used to avoid excess redrawing
6a1aa64f
DV
1332 * @private
1333 */
7201b11e
JB
1334Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY,
1335 endY, prevDirection, prevEndX,
1336 prevEndY) {
2cf95fff 1337 var ctx = this.canvas_ctx_;
6a1aa64f
DV
1338
1339 // Clean up from the previous rect if necessary
39b0e098 1340 if (prevDirection == Dygraph.HORIZONTAL) {
fa54c193
FXB
1341 ctx.clearRect(Math.min(startX, prevEndX), this.layout_.getPlotArea().y,
1342 Math.abs(startX - prevEndX), this.layout_.getPlotArea().h);
39b0e098 1343 } else if (prevDirection == Dygraph.VERTICAL){
fa54c193
FXB
1344 ctx.clearRect(this.layout_.getPlotArea().x, Math.min(startY, prevEndY),
1345 this.layout_.getPlotArea().w, Math.abs(startY - prevEndY));
6a1aa64f
DV
1346 }
1347
1348 // Draw a light-grey rectangle to show the new viewing area
39b0e098 1349 if (direction == Dygraph.HORIZONTAL) {
8b83c6cc
RK
1350 if (endX && startX) {
1351 ctx.fillStyle = "rgba(128,128,128,0.33)";
fa54c193
FXB
1352 ctx.fillRect(Math.min(startX, endX), this.layout_.getPlotArea().y,
1353 Math.abs(endX - startX), this.layout_.getPlotArea().h);
8b83c6cc 1354 }
920208fb 1355 } else if (direction == Dygraph.VERTICAL) {
8b83c6cc
RK
1356 if (endY && startY) {
1357 ctx.fillStyle = "rgba(128,128,128,0.33)";
fa54c193
FXB
1358 ctx.fillRect(this.layout_.getPlotArea().x, Math.min(startY, endY),
1359 this.layout_.getPlotArea().w, Math.abs(endY - startY));
8b83c6cc 1360 }
6a1aa64f 1361 }
920208fb
PF
1362
1363 if (this.isUsingExcanvas_) {
1364 this.currentZoomRectArgs_ = [direction, startX, endX, startY, endY, 0, 0, 0];
1365 }
1366};
1367
1368/**
1369 * Clear the zoom rectangle (and perform no zoom).
1370 * @private
1371 */
1372Dygraph.prototype.clearZoomRect_ = function() {
1373 this.currentZoomRectArgs_ = null;
1374 this.canvas_ctx_.clearRect(0, 0, this.canvas_.width, this.canvas_.height);
6a1aa64f
DV
1375};
1376
1377/**
8b83c6cc
RK
1378 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1379 * the canvas. The exact zoom window may be slightly larger if there are no data
1380 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1381 * which accepts dates that match the raw data. This function redraws the graph.
d58ae307 1382 *
6a1aa64f
DV
1383 * @param {Number} lowX The leftmost pixel value that should be visible.
1384 * @param {Number} highX The rightmost pixel value that should be visible.
1385 * @private
1386 */
8b83c6cc 1387Dygraph.prototype.doZoomX_ = function(lowX, highX) {
920208fb 1388 this.currentZoomRectArgs_ = null;
6a1aa64f 1389 // Find the earliest and latest dates contained in this canvasx range.
8b83c6cc 1390 // Convert the call to date ranges of the raw data.
ff022deb
RK
1391 var minDate = this.toDataXCoord(lowX);
1392 var maxDate = this.toDataXCoord(highX);
8b83c6cc
RK
1393 this.doZoomXDates_(minDate, maxDate);
1394};
6a1aa64f 1395
8b83c6cc 1396/**
b1a3b195
DV
1397 * Transition function to use in animations. Returns values between 0.0
1398 * (totally old values) and 1.0 (totally new values) for each frame.
1399 * @private
1400 */
1401Dygraph.zoomAnimationFunction = function(frame, numFrames) {
1402 var k = 1.5;
1403 return (1.0 - Math.pow(k, -frame)) / (1.0 - Math.pow(k, -numFrames));
1404};
1405
1406/**
8b83c6cc
RK
1407 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1408 * method with doZoomX which accepts pixel coordinates. This function redraws
1409 * the graph.
d58ae307 1410 *
8b83c6cc
RK
1411 * @param {Number} minDate The minimum date that should be visible.
1412 * @param {Number} maxDate The maximum date that should be visible.
1413 * @private
1414 */
1415Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
b1a3b195
DV
1416 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1417 // can produce strange effects. Rather than the y-axis transitioning slowly
1418 // between values, it can jerk around.)
1419 var old_window = this.xAxisRange();
1420 var new_window = [minDate, maxDate];
57baab03 1421 this.zoomed_x_ = true;
b1a3b195
DV
1422 var that = this;
1423 this.doAnimatedZoom(old_window, new_window, null, null, function() {
1424 if (that.attr_("zoomCallback")) {
1425 that.attr_("zoomCallback")(minDate, maxDate, that.yAxisRanges());
1426 }
1427 });
8b83c6cc
RK
1428};
1429
1430/**
1431 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
d58ae307
DV
1432 * the canvas. This function redraws the graph.
1433 *
8b83c6cc
RK
1434 * @param {Number} lowY The topmost pixel value that should be visible.
1435 * @param {Number} highY The lowest pixel value that should be visible.
1436 * @private
1437 */
1438Dygraph.prototype.doZoomY_ = function(lowY, highY) {
920208fb 1439 this.currentZoomRectArgs_ = null;
d58ae307
DV
1440 // Find the highest and lowest values in pixel range for each axis.
1441 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1442 // This is because pixels increase as you go down on the screen, whereas data
1443 // coordinates increase as you go up the screen.
b1a3b195
DV
1444 var oldValueRanges = this.yAxisRanges();
1445 var newValueRanges = [];
d58ae307 1446 for (var i = 0; i < this.axes_.length; i++) {
ff022deb
RK
1447 var hi = this.toDataYCoord(lowY, i);
1448 var low = this.toDataYCoord(highY, i);
b1a3b195 1449 newValueRanges.push([low, hi]);
d58ae307 1450 }
8b83c6cc 1451
57baab03 1452 this.zoomed_y_ = true;
b1a3b195
DV
1453 var that = this;
1454 this.doAnimatedZoom(null, null, oldValueRanges, newValueRanges, function() {
1455 if (that.attr_("zoomCallback")) {
1456 var xRange = that.xAxisRange();
b1a3b195
DV
1457 that.attr_("zoomCallback")(xRange[0], xRange[1], that.yAxisRanges());
1458 }
1459 });
8b83c6cc
RK
1460};
1461
1462/**
1463 * Reset the zoom to the original view coordinates. This is the same as
1464 * double-clicking on the graph.
8b83c6cc 1465 */
e70e19ab 1466Dygraph.prototype.restoreZoom = function() {
b1a3b195 1467 var dirty = false, dirtyX = false, dirtyY = false;
758a629f 1468 if (this.dateWindow_ !== null) {
d58ae307 1469 dirty = true;
b1a3b195 1470 dirtyX = true;
8b83c6cc 1471 }
d58ae307
DV
1472
1473 for (var i = 0; i < this.axes_.length; i++) {
1f6a6254 1474 if (typeof(this.axes_[i].valueWindow) !== 'undefined' && this.axes_[i].valueWindow !== null) {
d58ae307 1475 dirty = true;
b1a3b195 1476 dirtyY = true;
d58ae307 1477 }
8b83c6cc
RK
1478 }
1479
da1369a5
DV
1480 // Clear any selection, since it's likely to be drawn in the wrong place.
1481 this.clearSelection();
1482
8b83c6cc 1483 if (dirty) {
57baab03
NN
1484 this.zoomed_x_ = false;
1485 this.zoomed_y_ = false;
b1a3b195
DV
1486
1487 var minDate = this.rawData_[0][0];
1488 var maxDate = this.rawData_[this.rawData_.length - 1][0];
1489
1490 // With only one frame, don't bother calculating extreme ranges.
1491 // TODO(danvk): merge this block w/ the code below.
1492 if (!this.attr_("animatedZooms")) {
1493 this.dateWindow_ = null;
758a629f
DV
1494 for (i = 0; i < this.axes_.length; i++) {
1495 if (this.axes_[i].valueWindow !== null) {
b1a3b195
DV
1496 delete this.axes_[i].valueWindow;
1497 }
1498 }
1499 this.drawGraph_();
1500 if (this.attr_("zoomCallback")) {
1501 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1502 }
1503 return;
1504 }
1505
1506 var oldWindow=null, newWindow=null, oldValueRanges=null, newValueRanges=null;
1507 if (dirtyX) {
1508 oldWindow = this.xAxisRange();
1509 newWindow = [minDate, maxDate];
1510 }
1511
1512 if (dirtyY) {
1513 oldValueRanges = this.yAxisRanges();
1514 // TODO(danvk): this is pretty inefficient
1515 var packed = this.gatherDatasets_(this.rolledSeries_, null);
1516 var extremes = packed[1];
1517
1518 // this has the side-effect of modifying this.axes_.
1519 // this doesn't make much sense in this context, but it's convenient (we
1520 // need this.axes_[*].extremeValues) and not harmful since we'll be
1521 // calling drawGraph_ shortly, which clobbers these values.
1522 this.computeYAxisRanges_(extremes);
1523
1524 newValueRanges = [];
758a629f 1525 for (i = 0; i < this.axes_.length; i++) {
1f6a6254 1526 var axis = this.axes_[i];
681a215e
DV
1527 newValueRanges.push((axis.valueRange !== null &&
1528 axis.valueRange !== undefined) ?
42a9ebb8 1529 axis.valueRange : axis.extremeRange);
b1a3b195
DV
1530 }
1531 }
1532
1533 var that = this;
1534 this.doAnimatedZoom(oldWindow, newWindow, oldValueRanges, newValueRanges,
1535 function() {
1536 that.dateWindow_ = null;
1537 for (var i = 0; i < that.axes_.length; i++) {
758a629f 1538 if (that.axes_[i].valueWindow !== null) {
b1a3b195
DV
1539 delete that.axes_[i].valueWindow;
1540 }
1541 }
1542 if (that.attr_("zoomCallback")) {
1543 that.attr_("zoomCallback")(minDate, maxDate, that.yAxisRanges());
1544 }
1545 });
1546 }
1547};
1548
1549/**
1550 * Combined animation logic for all zoom functions.
1551 * either the x parameters or y parameters may be null.
1552 * @private
1553 */
1554Dygraph.prototype.doAnimatedZoom = function(oldXRange, newXRange, oldYRanges, newYRanges, callback) {
1555 var steps = this.attr_("animatedZooms") ? Dygraph.ANIMATION_STEPS : 1;
1556
1557 var windows = [];
1558 var valueRanges = [];
758a629f 1559 var step, frac;
b1a3b195 1560
758a629f
DV
1561 if (oldXRange !== null && newXRange !== null) {
1562 for (step = 1; step <= steps; step++) {
1563 frac = Dygraph.zoomAnimationFunction(step, steps);
b1a3b195
DV
1564 windows[step-1] = [oldXRange[0]*(1-frac) + frac*newXRange[0],
1565 oldXRange[1]*(1-frac) + frac*newXRange[1]];
8b83c6cc 1566 }
67e650dc 1567 }
b1a3b195 1568
758a629f
DV
1569 if (oldYRanges !== null && newYRanges !== null) {
1570 for (step = 1; step <= steps; step++) {
1571 frac = Dygraph.zoomAnimationFunction(step, steps);
b1a3b195
DV
1572 var thisRange = [];
1573 for (var j = 0; j < this.axes_.length; j++) {
1574 thisRange.push([oldYRanges[j][0]*(1-frac) + frac*newYRanges[j][0],
1575 oldYRanges[j][1]*(1-frac) + frac*newYRanges[j][1]]);
1576 }
1577 valueRanges[step-1] = thisRange;
1578 }
1579 }
1580
1581 var that = this;
1582 Dygraph.repeatAndCleanup(function(step) {
1583 if (valueRanges.length) {
1584 for (var i = 0; i < that.axes_.length; i++) {
1585 var w = valueRanges[step][i];
1586 that.axes_[i].valueWindow = [w[0], w[1]];
1587 }
1588 }
1589 if (windows.length) {
1590 that.dateWindow_ = windows[step];
1591 }
1592 that.drawGraph_();
1593 }, steps, Dygraph.ANIMATION_DURATION / steps, callback);
6a1aa64f
DV
1594};
1595
1596/**
857a6931
KW
1597 * Get the current graph's area object.
1598 *
1599 * Returns: {x, y, w, h}
6a1aa64f 1600 */
857a6931
KW
1601Dygraph.prototype.getArea = function() {
1602 return this.plotter_.area;
1603};
e863a17d 1604
857a6931
KW
1605/**
1606 * Convert a mouse event to DOM coordinates relative to the graph origin.
1607 *
1608 * Returns a two-element array: [X, Y].
1609 */
1610Dygraph.prototype.eventToDomCoords = function(event) {
4cac8c7a 1611 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
857a6931
KW
1612 var canvasy = Dygraph.pageY(event) - Dygraph.findPosY(this.mouseEventElement_);
1613 return [canvasx, canvasy];
1614};
4cac8c7a 1615
857a6931
KW
1616/**
1617 * Given a canvas X coordinate, find the closest row.
1618 * @param {Number} domX graph-relative DOM X coordinate
1619 * Returns: row number, integer
1620 * @private
1621 */
1622Dygraph.prototype.findClosestRow = function(domX) {
81cb07d6 1623 var minDistX = Infinity;
a12a78ae
DV
1624 var pointIdx = -1, setIdx = -1;
1625 var sets = this.layout_.points;
1626 for (var i = 0; i < sets.length; i++) {
1627 var points = sets[i];
1628 var len = points.length;
1629 for (var j = 0; j < len; j++) {
1630 var point = points[j];
1631 if (!Dygraph.isValidPoint(point, true)) continue;
1632 var dist = Math.abs(point.canvasx - domX);
1633 if (dist < minDistX) {
1634 minDistX = dist;
1635 setIdx = i;
1636 pointIdx = j;
1637 }
a937d031 1638 }
6a1aa64f 1639 }
a12a78ae
DV
1640
1641 // TODO(danvk): remove this function; it's trivial and has only one use.
1642 return this.idxToRow_(setIdx, pointIdx);
857a6931 1643};
6a1aa64f 1644
857a6931 1645/**
2a02e5dd
KW
1646 * Given canvas X,Y coordinates, find the closest point.
1647 *
1648 * This finds the individual data point across all visible series
1649 * that's closest to the supplied DOM coordinates using the standard
1650 * Euclidean X,Y distance.
1651 *
857a6931
KW
1652 * @param {Number} domX graph-relative DOM X coordinate
1653 * @param {Number} domY graph-relative DOM Y coordinate
1654 * Returns: {row, seriesName, point}
1655 * @private
1656 */
1657Dygraph.prototype.findClosestPoint = function(domX, domY) {
81cb07d6 1658 var minDist = Infinity;
857a6931 1659 var idx = -1;
857a6931 1660 var dist, dx, dy, point, closestPoint, closestSeries;
cc825c7b 1661 for ( var setIdx = this.layout_.datasets.length - 1 ; setIdx >= 0 ; --setIdx ) {
a12a78ae
DV
1662 var points = this.layout_.points[setIdx];
1663 for (var i = 0; i < points.length; ++i) {
1664 var point = points[i];
62c3d2fd 1665 if (!Dygraph.isValidPoint(point)) continue;
857a6931
KW
1666 dx = point.canvasx - domX;
1667 dy = point.canvasy - domY;
1668 dist = dx * dx + dy * dy;
81cb07d6 1669 if (dist < minDist) {
62c3d2fd 1670 minDist = dist;
a937d031
KW
1671 closestPoint = point;
1672 closestSeries = setIdx;
1673 idx = i;
1674 }
857a6931
KW
1675 }
1676 }
1677 var name = this.layout_.setNames[closestSeries];
1678 return {
81cb07d6 1679 row: idx + this.getLeftBoundary_(),
857a6931
KW
1680 seriesName: name,
1681 point: closestPoint
1682 };
1683};
1684
1685/**
1686 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
2a02e5dd
KW
1687 *
1688 * This first finds the X data point closest to the supplied DOM X coordinate,
1689 * then finds the series which puts the Y coordinate on top of its filled area,
1690 * using linear interpolation between adjacent point pairs.
1691 *
857a6931
KW
1692 * @param {Number} domX graph-relative DOM X coordinate
1693 * @param {Number} domY graph-relative DOM Y coordinate
1694 * Returns: {row, seriesName, point}
1695 * @private
1696 */
1697Dygraph.prototype.findStackedPoint = function(domX, domY) {
1698 var row = this.findClosestRow(domX);
81cb07d6
KW
1699 var boundary = this.getLeftBoundary_();
1700 var rowIdx = row - boundary;
a12a78ae 1701 var sets = this.layout_.points;
857a6931
KW
1702 var closestPoint, closestSeries;
1703 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
a12a78ae
DV
1704 var points = this.layout_.points[setIdx];
1705 if (rowIdx >= points.length) continue;
1706 var p1 = points[rowIdx];
62c3d2fd 1707 if (!Dygraph.isValidPoint(p1)) continue;
857a6931 1708 var py = p1.canvasy;
a12a78ae 1709 if (domX > p1.canvasx && rowIdx + 1 < points.length) {
857a6931 1710 // interpolate series Y value using next point
a12a78ae 1711 var p2 = points[rowIdx + 1];
62c3d2fd
KW
1712 if (Dygraph.isValidPoint(p2)) {
1713 var dx = p2.canvasx - p1.canvasx;
1714 if (dx > 0) {
1715 var r = (domX - p1.canvasx) / dx;
1716 py += r * (p2.canvasy - p1.canvasy);
1717 }
416b05ad 1718 }
81cb07d6 1719 } else if (domX < p1.canvasx && rowIdx > 0) {
857a6931 1720 // interpolate series Y value using previous point
a12a78ae 1721 var p0 = points[rowIdx - 1];
62c3d2fd
KW
1722 if (Dygraph.isValidPoint(p0)) {
1723 var dx = p1.canvasx - p0.canvasx;
1724 if (dx > 0) {
1725 var r = (p1.canvasx - domX) / dx;
1726 py += r * (p0.canvasy - p1.canvasy);
1727 }
12e4c741 1728 }
6a1aa64f 1729 }
857a6931 1730 // Stop if the point (domX, py) is above this series' upper edge
42a9ebb8 1731 if (setIdx === 0 || py < domY) {
a937d031
KW
1732 closestPoint = p1;
1733 closestSeries = setIdx;
1734 }
6a1aa64f 1735 }
857a6931
KW
1736 var name = this.layout_.setNames[closestSeries];
1737 return {
1738 row: row,
1739 seriesName: name,
1740 point: closestPoint
1741 };
1742};
6a1aa64f 1743
857a6931 1744/**
6a1aa64f
DV
1745 * When the mouse moves in the canvas, display information about a nearby data
1746 * point and draw dots over those points in the data series. This function
1747 * takes care of cleanup of previously-drawn dots.
1748 * @param {Object} event The mousemove event from the browser.
1749 * @private
1750 */
285a6bda 1751Dygraph.prototype.mouseMove_ = function(event) {
e863a17d 1752 // This prevents JS errors when mousing over the canvas before data loads.
4cac8c7a 1753 var points = this.layout_.points;
a12a78ae 1754 if (points === undefined || points === null) return;
e863a17d 1755
857a6931
KW
1756 var canvasCoords = this.eventToDomCoords(event);
1757 var canvasx = canvasCoords[0];
1758 var canvasy = canvasCoords[1];
6a1aa64f 1759
857a6931
KW
1760 var highlightSeriesOpts = this.attr_("highlightSeriesOpts");
1761 var selectionChanged = false;
3f55b813 1762 if (highlightSeriesOpts && !this.isSeriesLocked()) {
857a6931
KW
1763 var closest;
1764 if (this.attr_("stackedGraph")) {
1765 closest = this.findStackedPoint(canvasx, canvasy);
1766 } else {
1767 closest = this.findClosestPoint(canvasx, canvasy);
43af96e7 1768 }
857a6931 1769 selectionChanged = this.setSelection(closest.row, closest.seriesName);
416b05ad 1770 } else {
857a6931
KW
1771 var idx = this.findClosestRow(canvasx);
1772 selectionChanged = this.setSelection(idx);
12e4c741 1773 }
43af96e7 1774
857a6931
KW
1775 var callback = this.attr_("highlightCallback");
1776 if (callback && selectionChanged) {
1777 callback(event, this.lastx_, this.selPoints_, this.lastRow_, this.highlightSet_);
12e4c741 1778 }
239c712d 1779};
b258a3da 1780
239c712d 1781/**
81cb07d6 1782 * Fetch left offset from first defined boundaryIds record (see bug #236).
e2c21500 1783 * @private
81cb07d6
KW
1784 */
1785Dygraph.prototype.getLeftBoundary_ = function() {
1786 for (var i = 0; i < this.boundaryIds_.length; i++) {
1787 if (this.boundaryIds_[i] !== undefined) {
1788 return this.boundaryIds_[i][0];
1789 }
1790 }
1791 return 0;
1792};
1793
1794/**
1903f1e4 1795 * Transforms layout_.points index into data row number.
2ddb1197 1796 * @param int layout_.points index
1903f1e4 1797 * @return int row number, or -1 if none could be found.
2ddb1197
SC
1798 * @private
1799 */
a12a78ae
DV
1800Dygraph.prototype.idxToRow_ = function(setIdx, rowIdx) {
1801 if (rowIdx < 0) return -1;
2ddb1197 1802
81cb07d6 1803 var boundary = this.getLeftBoundary_();
a12a78ae
DV
1804 return boundary + rowIdx;
1805 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1806 // var set = this.layout_.datasets[setIdx];
1807 // if (idx < set.length) {
1808 // return boundary + idx;
1809 // }
1810 // idx -= set.length;
1811 // }
1812 // return -1;
1903f1e4 1813};
2ddb1197 1814
857a6931
KW
1815Dygraph.prototype.animateSelection_ = function(direction) {
1816 var totalSteps = 10;
1817 var millis = 30;
1d44ee5e
KW
1818 if (this.fadeLevel === undefined) this.fadeLevel = 0;
1819 if (this.animateId === undefined) this.animateId = 0;
857a6931
KW
1820 var start = this.fadeLevel;
1821 var steps = direction < 0 ? start : totalSteps - start;
1822 if (steps <= 0) {
1823 if (this.fadeLevel) {
1824 this.updateSelection_(1.0);
1825 }
1826 return;
1827 }
1828
1829 var thisId = ++this.animateId;
1830 var that = this;
475f7420
KW
1831 Dygraph.repeatAndCleanup(
1832 function(n) {
1833 // ignore simultaneous animations
1834 if (that.animateId != thisId) return;
1835
1836 that.fadeLevel += direction;
1837 if (that.fadeLevel === 0) {
1838 that.clearSelection();
1839 } else {
1840 that.updateSelection_(that.fadeLevel / totalSteps);
1841 }
1842 },
1843 steps, millis, function() {});
857a6931
KW
1844};
1845
2ddb1197 1846/**
239c712d
NAG
1847 * Draw dots over the selectied points in the data series. This function
1848 * takes care of cleanup of previously-drawn dots.
1849 * @private
1850 */
857a6931 1851Dygraph.prototype.updateSelection_ = function(opt_animFraction) {
e2c21500
DV
1852 var defaultPrevented = this.cascadeEvents_('select', {
1853 selectedX: this.lastx_,
1854 selectedPoints: this.selPoints_
1855 });
1856 // TODO(danvk): use defaultPrevented here?
1857
6a1aa64f 1858 // Clear the previously drawn vertical, if there is one
758a629f 1859 var i;
2cf95fff 1860 var ctx = this.canvas_ctx_;
857a6931
KW
1861 if (this.attr_('highlightSeriesOpts')) {
1862 ctx.clearRect(0, 0, this.width_, this.height_);
afdb20d8 1863 var alpha = 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
857a6931 1864 if (alpha) {
2a02e5dd
KW
1865 // Activating background fade includes an animation effect for a gradual
1866 // fade. TODO(klausw): make this independently configurable if it causes
1867 // issues? Use a shared preference to control animations?
1868 var animateBackgroundFade = true;
1869 if (animateBackgroundFade) {
857a6931
KW
1870 if (opt_animFraction === undefined) {
1871 // start a new animation
1872 this.animateSelection_(1);
1873 return;
1874 }
1875 alpha *= opt_animFraction;
1876 }
1877 ctx.fillStyle = 'rgba(255,255,255,' + alpha + ')';
1878 ctx.fillRect(0, 0, this.width_, this.height_);
1879 }
38e3d209
DV
1880
1881 // Redraw only the highlighted series in the interactive canvas (not the
1882 // static plot canvas, which is where series are usually drawn).
1883 this.plotter_._renderLineChart(this.highlightSet_, ctx);
857a6931 1884 } else if (this.previousVerticalX_ >= 0) {
46dde5f9
DV
1885 // Determine the maximum highlight circle size.
1886 var maxCircleSize = 0;
227b93cc 1887 var labels = this.attr_('labels');
758a629f 1888 for (i = 1; i < labels.length; i++) {
227b93cc 1889 var r = this.attr_('highlightCircleSize', labels[i]);
46dde5f9
DV
1890 if (r > maxCircleSize) maxCircleSize = r;
1891 }
6a1aa64f 1892 var px = this.previousVerticalX_;
46dde5f9
DV
1893 ctx.clearRect(px - maxCircleSize - 1, 0,
1894 2 * maxCircleSize + 2, this.height_);
6a1aa64f
DV
1895 }
1896
920208fb
PF
1897 if (this.isUsingExcanvas_ && this.currentZoomRectArgs_) {
1898 Dygraph.prototype.drawZoomRect_.apply(this, this.currentZoomRectArgs_);
1899 }
1900
d160cc3b 1901 if (this.selPoints_.length > 0) {
6a1aa64f 1902 // Draw colored circles over the center of each selected point
e9fe4a2f 1903 var canvasx = this.selPoints_[0].canvasx;
43af96e7 1904 ctx.save();
758a629f 1905 for (i = 0; i < this.selPoints_.length; i++) {
e9fe4a2f
DV
1906 var pt = this.selPoints_[i];
1907 if (!Dygraph.isOK(pt.canvasy)) continue;
1908
1909 var circleSize = this.attr_('highlightCircleSize', pt.name);
5879307d 1910 var callback = this.attr_("drawHighlightPointCallback", pt.name);
a8ef67a8 1911 var color = this.plotter_.colors[pt.name];
78e58af4
RK
1912 if (!callback) {
1913 callback = Dygraph.Circles.DEFAULT;
1914 }
a8ef67a8
KW
1915 ctx.lineWidth = this.attr_('strokeWidth', pt.name);
1916 ctx.strokeStyle = color;
1917 ctx.fillStyle = color;
78e58af4 1918 callback(this.g, pt.name, ctx, canvasx, pt.canvasy,
a8ef67a8 1919 color, circleSize);
6a1aa64f
DV
1920 }
1921 ctx.restore();
1922
1923 this.previousVerticalX_ = canvasx;
1924 }
1925};
1926
1927/**
629a09ae
DV
1928 * Manually set the selected points and display information about them in the
1929 * legend. The selection can be cleared using clearSelection() and queried
1930 * using getSelection().
1931 * @param { Integer } row number that should be highlighted (i.e. appear with
1932 * hover dots on the chart). Set to false to clear any selection.
857a6931
KW
1933 * @param { seriesName } optional series name to highlight that series with the
1934 * the highlightSeriesOpts setting.
b9a3ece4
KW
1935 * @param { locked } optional If true, keep seriesName selected when mousing
1936 * over the graph, disabling closest-series highlighting. Call clearSelection()
1937 * to unlock it.
239c712d 1938 */
b9a3ece4 1939Dygraph.prototype.setSelection = function(row, opt_seriesName, opt_locked) {
239c712d
NAG
1940 // Extract the points we've selected
1941 this.selPoints_ = [];
50360fd0 1942
239c712d 1943 if (row !== false) {
81cb07d6 1944 row -= this.getLeftBoundary_();
16269f6e 1945 }
50360fd0 1946
857a6931 1947 var changed = false;
16269f6e 1948 if (row !== false && row >= 0) {
857a6931
KW
1949 if (row != this.lastRow_) changed = true;
1950 this.lastRow_ = row;
82c6fe4d
KW
1951 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1952 var set = this.layout_.datasets[setIdx];
1953 if (row < set.length) {
a12a78ae 1954 var point = this.layout_.points[setIdx][row];
ccd9d7c2 1955
38f33a44 1956 if (this.attr_("stackedGraph")) {
a12a78ae 1957 point = this.layout_.unstackPointAtIndex(setIdx, row);
38f33a44 1958 }
ccd9d7c2 1959
42a9ebb8 1960 if (point.yval !== null) this.selPoints_.push(point);
16269f6e 1961 }
239c712d 1962 }
857a6931
KW
1963 } else {
1964 if (this.lastRow_ >= 0) changed = true;
1965 this.lastRow_ = -1;
16269f6e 1966 }
50360fd0 1967
16269f6e 1968 if (this.selPoints_.length) {
239c712d 1969 this.lastx_ = this.selPoints_[0].xval;
239c712d 1970 } else {
857a6931 1971 this.lastx_ = -1;
239c712d
NAG
1972 }
1973
857a6931
KW
1974 if (opt_seriesName !== undefined) {
1975 if (this.highlightSet_ !== opt_seriesName) changed = true;
1976 this.highlightSet_ = opt_seriesName;
239c712d
NAG
1977 }
1978
b9a3ece4
KW
1979 if (opt_locked !== undefined) {
1980 this.lockedSet_ = opt_locked;
1981 }
1982
857a6931
KW
1983 if (changed) {
1984 this.updateSelection_(undefined);
1985 }
1986 return changed;
239c712d
NAG
1987};
1988
1989/**
6a1aa64f
DV
1990 * The mouse has left the canvas. Clear out whatever artifacts remain
1991 * @param {Object} event the mouseout event from the browser.
1992 * @private
1993 */
285a6bda 1994Dygraph.prototype.mouseOut_ = function(event) {
a4c6a67c
AV
1995 if (this.attr_("unhighlightCallback")) {
1996 this.attr_("unhighlightCallback")(event);
1997 }
1998
b9a3ece4 1999 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_) {
239c712d 2000 this.clearSelection();
43af96e7 2001 }
6a1aa64f
DV
2002};
2003
239c712d 2004/**
629a09ae
DV
2005 * Clears the current selection (i.e. points that were highlighted by moving
2006 * the mouse over the chart).
239c712d
NAG
2007 */
2008Dygraph.prototype.clearSelection = function() {
e2c21500
DV
2009 this.cascadeEvents_('deselect', {});
2010
b9a3ece4 2011 this.lockedSet_ = false;
239c712d 2012 // Get rid of the overlay data
857a6931
KW
2013 if (this.fadeLevel) {
2014 this.animateSelection_(-1);
2015 return;
2016 }
2cf95fff 2017 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
857a6931 2018 this.fadeLevel = 0;
239c712d
NAG
2019 this.selPoints_ = [];
2020 this.lastx_ = -1;
857a6931
KW
2021 this.lastRow_ = -1;
2022 this.highlightSet_ = null;
758a629f 2023};
239c712d 2024
103b7292 2025/**
629a09ae
DV
2026 * Returns the number of the currently selected row. To get data for this row,
2027 * you can use the getValue method.
2028 * @return { Integer } row number, or -1 if nothing is selected
103b7292
NAG
2029 */
2030Dygraph.prototype.getSelection = function() {
2031 if (!this.selPoints_ || this.selPoints_.length < 1) {
2032 return -1;
2033 }
50360fd0 2034
a12a78ae
DV
2035 for (var setIdx = 0; setIdx < this.layout_.points.length; setIdx++) {
2036 var points = this.layout_.points[setIdx];
2037 for (var row = 0; row < points.length; row++) {
2038 if (points[row].x == this.selPoints_[0].x) {
2039 return row + this.getLeftBoundary_();
2040 }
103b7292
NAG
2041 }
2042 }
2043 return -1;
2e1fcf1a 2044};
103b7292 2045
e2c21500
DV
2046/**
2047 * Returns the name of the currently-highlighted series.
2048 * Only available when the highlightSeriesOpts option is in use.
2049 */
857a6931
KW
2050Dygraph.prototype.getHighlightSeries = function() {
2051 return this.highlightSet_;
2052};
2053
19589a3e 2054/**
3f55b813
KW
2055 * Returns true if the currently-highlighted series was locked
2056 * via setSelection(..., seriesName, true).
2057 */
2058Dygraph.prototype.isSeriesLocked = function() {
2059 return this.lockedSet_;
2060};
2061
2062/**
6a1aa64f
DV
2063 * Fires when there's data available to be graphed.
2064 * @param {String} data Raw CSV data to be plotted
2065 * @private
2066 */
285a6bda 2067Dygraph.prototype.loadedEvent_ = function(data) {
6a1aa64f 2068 this.rawData_ = this.parseCSV_(data);
26ca7938 2069 this.predraw_();
6a1aa64f
DV
2070};
2071
6a1aa64f
DV
2072/**
2073 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2074 * @private
2075 */
285a6bda 2076Dygraph.prototype.addXTicks_ = function() {
6a1aa64f 2077 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
7201b11e 2078 var range;
6a1aa64f 2079 if (this.dateWindow_) {
7201b11e 2080 range = [this.dateWindow_[0], this.dateWindow_[1]];
6a1aa64f 2081 } else {
395e98a3 2082 range = this.fullXRange_();
7201b11e
JB
2083 }
2084
48e614ac
DV
2085 var xAxisOptionsView = this.optionsViewForAxis_('x');
2086 var xTicks = xAxisOptionsView('ticker')(
2087 range[0],
2088 range[1],
2089 this.width_, // TODO(danvk): should be area.width
2090 xAxisOptionsView,
2091 this);
2092 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2093 // console.log(msg);
b2c9222a 2094 this.layout_.setXTicks(xTicks);
32988383
DV
2095};
2096
629a09ae
DV
2097/**
2098 * @private
2099 * Computes the range of the data series (including confidence intervals).
2100 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2101 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2102 * @return [low, high]
2103 */
5011e7a1 2104Dygraph.prototype.extremeValues_ = function(series) {
758a629f 2105 var minY = null, maxY = null, j, y;
5011e7a1 2106
9922b78b 2107 var bars = this.attr_("errorBars") || this.attr_("customBars");
5011e7a1
DV
2108 if (bars) {
2109 // With custom bars, maxY is the max of the high values.
758a629f
DV
2110 for (j = 0; j < series.length; j++) {
2111 y = series[j][1][0];
44477387 2112 if (y === null || isNaN(y)) continue;
5011e7a1
DV
2113 var low = y - series[j][1][1];
2114 var high = y + series[j][1][2];
2115 if (low > y) low = y; // this can happen with custom bars,
2116 if (high < y) high = y; // e.g. in tests/custom-bars.html
758a629f 2117 if (maxY === null || high > maxY) {
5011e7a1
DV
2118 maxY = high;
2119 }
758a629f 2120 if (minY === null || low < minY) {
5011e7a1
DV
2121 minY = low;
2122 }
2123 }
2124 } else {
758a629f
DV
2125 for (j = 0; j < series.length; j++) {
2126 y = series[j][1];
d12999d3 2127 if (y === null || isNaN(y)) continue;
758a629f 2128 if (maxY === null || y > maxY) {
5011e7a1
DV
2129 maxY = y;
2130 }
758a629f 2131 if (minY === null || y < minY) {
5011e7a1
DV
2132 minY = y;
2133 }
2134 }
2135 }
2136
2137 return [minY, maxY];
2138};
2139
6a1aa64f 2140/**
629a09ae 2141 * @private
26ca7938
DV
2142 * This function is called once when the chart's data is changed or the options
2143 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2144 * idea is that values derived from the chart's data can be computed here,
2145 * rather than every time the chart is drawn. This includes things like the
2146 * number of axes, rolling averages, etc.
2147 */
2148Dygraph.prototype.predraw_ = function() {
7153e001
DV
2149 var start = new Date();
2150
26ca7938
DV
2151 // TODO(danvk): move more computations out of drawGraph_ and into here.
2152 this.computeYAxes_();
2153
2154 // Create a new plotter.
f417e3d3 2155 if (this.plotter_) {
1748a51c 2156 this.cascadeEvents_('clearChart');
f417e3d3
DV
2157 this.plotter_.clear();
2158 }
26ca7938 2159 this.plotter_ = new DygraphCanvasRenderer(this,
2cf95fff
RK
2160 this.hidden_,
2161 this.hidden_ctx_,
0e23cfc6 2162 this.layout_);
26ca7938 2163
0abfbd7e
DV
2164 // The roller sits in the bottom left corner of the chart. We don't know where
2165 // this will be until the options are available, so it's positioned here.
8c69de65 2166 this.createRollInterface_();
26ca7938 2167
e2c21500 2168 this.cascadeEvents_('predraw');
0abfbd7e 2169
ccd9d7c2
PF
2170 if (this.rangeSelector_) {
2171 this.rangeSelector_.renderStaticLayer();
2172 }
2173
b1a3b195
DV
2174 // Convert the raw data (a 2D array) into the internal format and compute
2175 // rolling averages.
2176 this.rolledSeries_ = [null]; // x-axis is the first series and it's special
395e98a3 2177 for (var i = 1; i < this.numColumns(); i++) {
c1780ad0
RK
2178 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too.
2179 var logScale = this.attr_('logscale');
04c104d7 2180 var series = this.extractSeries_(this.rawData_, i, logScale);
b1a3b195
DV
2181 series = this.rollingAverage(series, this.rollPeriod_);
2182 this.rolledSeries_.push(series);
2183 }
2184
26ca7938
DV
2185 // If the data or options have changed, then we'd better redraw.
2186 this.drawGraph_();
4b4d1a63
DV
2187
2188 // This is used to determine whether to do various animations.
2189 var end = new Date();
2190 this.drawingTimeMs_ = (end - start);
26ca7938
DV
2191};
2192
2193/**
b1a3b195
DV
2194 * Loop over all fields and create datasets, calculating extreme y-values for
2195 * each series and extreme x-indices as we go.
fc4e84fa 2196 *
b1a3b195
DV
2197 * dateWindow is passed in as an explicit parameter so that we can compute
2198 * extreme values "speculatively", i.e. without actually setting state on the
2199 * dygraph.
fc4e84fa 2200 *
b1a3b195
DV
2201 * TODO(danvk): make this more of a true function
2202 * @return [ datasets, seriesExtremes, boundaryIds ]
6a1aa64f
DV
2203 * @private
2204 */
b1a3b195
DV
2205Dygraph.prototype.gatherDatasets_ = function(rolledSeries, dateWindow) {
2206 var boundaryIds = [];
354e15ab
DE
2207 var cumulative_y = []; // For stacked series.
2208 var datasets = [];
f09fc545 2209 var extremes = {}; // series name -> [low, high]
758a629f 2210 var i, j, k;
f09fc545 2211
b1a3b195
DV
2212 // Loop over the fields (series). Go from the last to the first,
2213 // because if they're stacked that's how we accumulate the values.
2214 var num_series = rolledSeries.length - 1;
758a629f 2215 for (i = num_series; i >= 1; i--) {
1cf11047
DV
2216 if (!this.visibility()[i - 1]) continue;
2217
16879a6b
DV
2218 // Note: this copy _is_ necessary at the moment.
2219 // If you remove it, it breaks zooming with error bars on.
2220 // TODO(danvk): investigate further & write a test for this.
2221 var series = [];
2222 for (j = 0; j < rolledSeries[i].length; j++) {
2223 series.push(rolledSeries[i][j]);
2224 }
2f5e7e1a 2225
6a1aa64f 2226 // Prune down to the desired range, if necessary (for zooming)
1a26f3fb
DV
2227 // Because there can be lines going to points outside of the visible area,
2228 // we actually prune to visible points, plus one on either side.
9922b78b 2229 var bars = this.attr_("errorBars") || this.attr_("customBars");
b1a3b195
DV
2230 if (dateWindow) {
2231 var low = dateWindow[0];
2232 var high = dateWindow[1];
6a1aa64f 2233 var pruned = [];
1a26f3fb
DV
2234 // TODO(danvk): do binary search instead of linear search.
2235 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2236 var firstIdx = null, lastIdx = null;
758a629f 2237 for (k = 0; k < series.length; k++) {
1a26f3fb
DV
2238 if (series[k][0] >= low && firstIdx === null) {
2239 firstIdx = k;
2240 }
2241 if (series[k][0] <= high) {
2242 lastIdx = k;
6a1aa64f
DV
2243 }
2244 }
1a26f3fb
DV
2245 if (firstIdx === null) firstIdx = 0;
2246 if (firstIdx > 0) firstIdx--;
2247 if (lastIdx === null) lastIdx = series.length - 1;
2248 if (lastIdx < series.length - 1) lastIdx++;
b1a3b195 2249 boundaryIds[i-1] = [firstIdx, lastIdx];
758a629f 2250 for (k = firstIdx; k <= lastIdx; k++) {
1a26f3fb 2251 pruned.push(series[k]);
6a1aa64f
DV
2252 }
2253 series = pruned;
16269f6e 2254 } else {
b1a3b195 2255 boundaryIds[i-1] = [0, series.length-1];
6a1aa64f
DV
2256 }
2257
f09fc545 2258 var seriesExtremes = this.extremeValues_(series);
5011e7a1 2259
6a1aa64f 2260 if (bars) {
758a629f 2261 for (j=0; j<series.length; j++) {
5061b42f
DV
2262 series[j] = [series[j][0],
2263 series[j][1][0],
2264 series[j][1][1],
2265 series[j][1][2]];
354e15ab 2266 }
43af96e7 2267 } else if (this.attr_("stackedGraph")) {
43af96e7
NK
2268 var l = series.length;
2269 var actual_y;
758a629f 2270 for (j = 0; j < l; j++) {
354e15ab
DE
2271 // If one data set has a NaN, let all subsequent stacked
2272 // sets inherit the NaN -- only start at 0 for the first set.
2273 var x = series[j][0];
41b0f691 2274 if (cumulative_y[x] === undefined) {
354e15ab 2275 cumulative_y[x] = 0;
41b0f691 2276 }
43af96e7
NK
2277
2278 actual_y = series[j][1];
04c104d7
KW
2279 if (actual_y === null) {
2280 series[j] = [x, null];
2281 continue;
2282 }
2283
354e15ab 2284 cumulative_y[x] += actual_y;
43af96e7 2285
758a629f 2286 series[j] = [x, cumulative_y[x]];
43af96e7 2287
41b0f691
DV
2288 if (cumulative_y[x] > seriesExtremes[1]) {
2289 seriesExtremes[1] = cumulative_y[x];
2290 }
2291 if (cumulative_y[x] < seriesExtremes[0]) {
2292 seriesExtremes[0] = cumulative_y[x];
2293 }
43af96e7 2294 }
6a1aa64f 2295 }
354e15ab 2296
b1a3b195
DV
2297 var seriesName = this.attr_("labels")[i];
2298 extremes[seriesName] = seriesExtremes;
354e15ab 2299 datasets[i] = series;
6a1aa64f
DV
2300 }
2301
7d463f49
KW
2302 // For stacked graphs, a NaN value for any point in the sum should create a
2303 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2304 if (this.attr_("stackedGraph")) {
2305 for (k = datasets.length - 1; k >= 0; --k) {
2306 // Use the first nonempty dataset to get X values.
2307 if (!datasets[k]) continue;
2308 for (j = 0; j < datasets[k].length; j++) {
2309 var x = datasets[k][j][0];
2310 if (isNaN(cumulative_y[x])) {
2311 // Set all Y values to NaN at that X value.
2312 for (i = datasets.length - 1; i >= 0; i--) {
2313 if (!datasets[i]) continue;
2314 datasets[i][j][1] = NaN;
2315 }
2316 }
2317 }
2318 break;
2319 }
2320 }
2321
b1a3b195
DV
2322 return [ datasets, extremes, boundaryIds ];
2323};
2324
2325/**
2326 * Update the graph with new data. This method is called when the viewing area
2327 * has changed. If the underlying data or options have changed, predraw_ will
2328 * be called before drawGraph_ is called.
2329 *
b1a3b195
DV
2330 * @private
2331 */
e2c21500 2332Dygraph.prototype.drawGraph_ = function() {
b1a3b195
DV
2333 var start = new Date();
2334
b1a3b195
DV
2335 // This is used to set the second parameter to drawCallback, below.
2336 var is_initial_draw = this.is_initial_draw_;
2337 this.is_initial_draw_ = false;
2338
b1a3b195
DV
2339 this.layout_.removeAllDatasets();
2340 this.setColors_();
758a629f 2341 this.attrs_.pointSize = 0.5 * this.attr_('highlightCircleSize');
b1a3b195
DV
2342
2343 var packed = this.gatherDatasets_(this.rolledSeries_, this.dateWindow_);
2344 var datasets = packed[0];
2345 var extremes = packed[1];
2346 this.boundaryIds_ = packed[2];
2347
82c6fe4d
KW
2348 this.setIndexByName_ = {};
2349 var labels = this.attr_("labels");
2350 if (labels.length > 0) {
2351 this.setIndexByName_[labels[0]] = 0;
2352 }
857a6931 2353 var dataIdx = 0;
354e15ab 2354 for (var i = 1; i < datasets.length; i++) {
82c6fe4d 2355 this.setIndexByName_[labels[i]] = i;
4523c1f6 2356 if (!this.visibility()[i - 1]) continue;
82c6fe4d 2357 this.layout_.addDataset(labels[i], datasets[i]);
857a6931 2358 this.datasetIndex_[i] = dataIdx++;
43af96e7
NK
2359 }
2360
6faebb69 2361 this.computeYAxisRanges_(extremes);
b2c9222a
DV
2362 this.layout_.setYAxes(this.axes_);
2363
6a1aa64f
DV
2364 this.addXTicks_();
2365
b2c9222a 2366 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
81856f70 2367 var tmp_zoomed_x = this.zoomed_x_;
6a1aa64f 2368 // Tell PlotKit to use this new data and render itself
b2c9222a 2369 this.layout_.setDateWindow(this.dateWindow_);
81856f70 2370 this.zoomed_x_ = tmp_zoomed_x;
6a1aa64f 2371 this.layout_.evaluateWithError();
e2c21500 2372 this.renderGraph_(is_initial_draw);
9ca829f2
DV
2373
2374 if (this.attr_("timingName")) {
2375 var end = new Date();
2376 if (console) {
758a629f 2377 console.log(this.attr_("timingName") + " - drawGraph: " + (end - start) + "ms");
9ca829f2
DV
2378 }
2379 }
2380};
2381
e2c21500
DV
2382/**
2383 * This does the work of drawing the chart. It assumes that the layout and axis
2384 * scales have already been set (e.g. by predraw_).
2385 *
2386 * @private
2387 */
2388Dygraph.prototype.renderGraph_ = function(is_initial_draw) {
1748a51c 2389 this.cascadeEvents_('clearChart');
6a1aa64f 2390 this.plotter_.clear();
f417e3d3 2391
98eb4713
DV
2392 if (this.attr_('underlayCallback')) {
2393 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2394 // users who expect a deprecated form of this callback.
2395 this.attr_('underlayCallback')(
2396 this.hidden_ctx_, this.layout_.getPlotArea(), this, this);
2397 }
2398
2399 var e = {
189f8030 2400 canvas: this.hidden_,
2de7166c 2401 drawingContext: this.hidden_ctx_
98eb4713
DV
2402 };
2403 this.cascadeEvents_('willDrawChart', e);
6a1aa64f 2404 this.plotter_.render();
98eb4713 2405 this.cascadeEvents_('didDrawChart', e);
8cfe592f
DV
2406
2407 // TODO(danvk): is this a performance bottleneck when panning?
2408 // The interaction canvas should already be empty in that situation.
f6401bf6 2409 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2f5e7e1a 2410 this.canvas_.height);
599fb4ad 2411
4a0cb9c4 2412 // Generate a static legend before any particular point is selected.
2fccd3dc 2413
ccd9d7c2
PF
2414 if (this.rangeSelector_) {
2415 this.rangeSelector_.renderInteractiveLayer();
2416 }
599fb4ad 2417 if (this.attr_("drawCallback") !== null) {
fe0b7c03 2418 this.attr_("drawCallback")(this, is_initial_draw);
599fb4ad 2419 }
6a1aa64f
DV
2420};
2421
2422/**
629a09ae 2423 * @private
26ca7938
DV
2424 * Determine properties of the y-axes which are independent of the data
2425 * currently being displayed. This includes things like the number of axes and
2426 * the style of the axes. It does not include the range of each axis and its
2427 * tick marks.
16f00742 2428 * This fills in this.axes_.
26ca7938 2429 * axes_ = [ { options } ]
26ca7938 2430 * indices are into the axes_ array.
f09fc545 2431 */
26ca7938 2432Dygraph.prototype.computeYAxes_ = function() {
478b866b 2433
d64b8fea
RK
2434 // Preserve valueWindow settings if they exist, and if the user hasn't
2435 // specified a new valueRange.
4dd0ac55 2436 var i, valueWindows, seriesName, axis, index, opts, v;
758a629f 2437 if (this.axes_ !== undefined && this.user_attrs_.hasOwnProperty("valueRange") === false) {
d64b8fea 2438 valueWindows = [];
758a629f 2439 for (index = 0; index < this.axes_.length; index++) {
d64b8fea
RK
2440 valueWindows.push(this.axes_[index].valueWindow);
2441 }
2442 }
2443
6ad8b6a4
RK
2444 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2445 // data computation as well as options storage.
f09fc545 2446 // Go through once and add all the axes.
02c93ff5 2447 this.axes_ = [];
6ad8b6a4 2448
02c93ff5 2449 for (axis = 0; axis < this.attributes_.numAxes(); axis++) {
6ad8b6a4 2450 // Add a new axis, making a copy of its per-axis options.
02c93ff5 2451 opts = { g : this };
6ad8b6a4
RK
2452 Dygraph.update(opts, this.attributes_.axisOptions(axis));
2453 this.axes_[axis] = opts;
f09fc545 2454 }
1c77a3a1 2455
7740dd00
RK
2456
2457 // Copy global valueRange option over to the first axis.
2458 // NOTE(konigsberg): Are these two statements necessary?
2459 // I tried removing it. The automated tests pass, and manually
2460 // messing with tests/zoom.html showed no trouble.
2461 v = this.attr_('valueRange');
2462 if (v) this.axes_[0].valueRange = v;
478b866b 2463
758a629f 2464 if (valueWindows !== undefined) {
d64b8fea 2465 // Restore valueWindow settings.
758a629f 2466 for (index = 0; index < valueWindows.length; index++) {
d64b8fea
RK
2467 this.axes_[index].valueWindow = valueWindows[index];
2468 }
2469 }
4dd0ac55 2470
4dd0ac55
RV
2471 for (axis = 0; axis < this.axes_.length; axis++) {
2472 if (axis === 0) {
2473 opts = this.optionsViewForAxis_('y' + (axis ? '2' : ''));
2474 v = opts("valueRange");
2475 if (v) this.axes_[axis].valueRange = v;
2476 } else { // To keep old behavior
2477 var axes = this.user_attrs_.axes;
2478 if (axes && axes.y2) {
2479 v = axes.y2.valueRange;
2480 if (v) this.axes_[axis].valueRange = v;
2481 }
2482 }
2483 }
26ca7938
DV
2484};
2485
2486/**
2487 * Returns the number of y-axes on the chart.
2488 * @return {Number} the number of axes.
2489 */
2490Dygraph.prototype.numAxes = function() {
16f00742 2491 return this.attributes_.numAxes();
26ca7938
DV
2492};
2493
2494/**
629a09ae 2495 * @private
b2c9222a
DV
2496 * Returns axis properties for the given series.
2497 * @param { String } setName The name of the series for which to get axis
2498 * properties, e.g. 'Y1'.
2499 * @return { Object } The axis properties.
2500 */
2501Dygraph.prototype.axisPropertiesForSeries = function(series) {
2502 // TODO(danvk): handle errors.
16f00742 2503 return this.axes_[this.attributes_.axisForSeries(series)];
b2c9222a
DV
2504};
2505
2506/**
2507 * @private
26ca7938
DV
2508 * Determine the value range and tick marks for each axis.
2509 * @param {Object} extremes A mapping from seriesName -> [low, high]
2510 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2511 */
2512Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
16f00742
RK
2513 var series;
2514 var numAxes = this.attributes_.numAxes();
f09fc545
DV
2515
2516 // Compute extreme values, a span and tick marks for each axis.
16f00742 2517 for (var i = 0; i < numAxes; i++) {
26ca7938 2518 var axis = this.axes_[i];
ec40f67c
RK
2519 var logscale = this.attributes_.getForAxis("logscale", i);
2520 var includeZero = this.attributes_.getForAxis("includeZero", i);
6ad8b6a4
RK
2521 series = this.attributes_.seriesForAxis(i);
2522
2523 if (series.length == 0) {
06fc69b6
AV
2524 // If no series are defined or visible then use a reasonable default
2525 axis.extremeRange = [0, 1];
2526 } else {
1c77a3a1 2527 // Calculate the extremes of extremes.
f09fc545
DV
2528 var minY = Infinity; // extremes[series[0]][0];
2529 var maxY = -Infinity; // extremes[series[0]][1];
ba049b89 2530 var extremeMinY, extremeMaxY;
a2da3777 2531
f09fc545 2532 for (var j = 0; j < series.length; j++) {
a2da3777
DV
2533 // this skips invisible series
2534 if (!extremes.hasOwnProperty(series[j])) continue;
2535
ba049b89
NN
2536 // Only use valid extremes to stop null data series' from corrupting the scale.
2537 extremeMinY = extremes[series[j]][0];
758a629f 2538 if (extremeMinY !== null) {
36dfa958 2539 minY = Math.min(extremeMinY, minY);
ba049b89
NN
2540 }
2541 extremeMaxY = extremes[series[j]][1];
758a629f 2542 if (extremeMaxY !== null) {
36dfa958 2543 maxY = Math.max(extremeMaxY, maxY);
ba049b89 2544 }
f09fc545 2545 }
ec40f67c 2546 if (includeZero && minY > 0) minY = 0;
f09fc545 2547
a2da3777 2548 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
36dfa958 2549 if (minY == Infinity) minY = 0;
a2da3777 2550 if (maxY == -Infinity) maxY = 1;
ba049b89 2551
f09fc545
DV
2552 // Add some padding and round up to an integer to be human-friendly.
2553 var span = maxY - minY;
2554 // special case: if we have no sense of scale, use +/-10% of the sole value.
758a629f 2555 if (span === 0) { span = maxY; }
f09fc545 2556
758a629f 2557 var maxAxisY, minAxisY;
ec40f67c 2558 if (logscale) {
758a629f
DV
2559 maxAxisY = maxY + 0.1 * span;
2560 minAxisY = minY;
ff022deb 2561 } else {
758a629f
DV
2562 maxAxisY = maxY + 0.1 * span;
2563 minAxisY = minY - 0.1 * span;
f09fc545 2564
ff022deb
RK
2565 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2566 if (!this.attr_("avoidMinZero")) {
2567 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2568 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
2569 }
f09fc545 2570
ff022deb
RK
2571 if (this.attr_("includeZero")) {
2572 if (maxY < 0) maxAxisY = 0;
2573 if (minY > 0) minAxisY = 0;
2574 }
f09fc545 2575 }
4cac8c7a
RK
2576 axis.extremeRange = [minAxisY, maxAxisY];
2577 }
2578 if (axis.valueWindow) {
2579 // This is only set if the user has zoomed on the y-axis. It is never set
2580 // by a user. It takes precedence over axis.valueRange because, if you set
2581 // valueRange, you'd still expect to be able to pan.
2582 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
2583 } else if (axis.valueRange) {
2584 // This is a user-set value range for this axis.
2585 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
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 }
a716aff2 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 }
4b4d1a63
DV
3419 this.predraw_();
3420 }
e8c7ef86
DV
3421
3422 this.resize_lock = false;
697e70b2
DV
3423};
3424
3425/**
6faebb69 3426 * Adjusts the number of points in the rolling average. Updates the graph to
6a1aa64f 3427 * reflect the new averaging period.
6faebb69 3428 * @param {Number} length Number of points over which to average the data.
6a1aa64f 3429 */
285a6bda 3430Dygraph.prototype.adjustRoll = function(length) {
6a1aa64f 3431 this.rollPeriod_ = length;
26ca7938 3432 this.predraw_();
6a1aa64f 3433};
540d00f1 3434
f8cfec73 3435/**
1cf11047
DV
3436 * Returns a boolean array of visibility statuses.
3437 */
3438Dygraph.prototype.visibility = function() {
3439 // Do lazy-initialization, so that this happens after we know the number of
3440 // data series.
3441 if (!this.attr_("visibility")) {
758a629f 3442 this.attrs_.visibility = [];
1cf11047 3443 }
758a629f 3444 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs.
395e98a3 3445 while (this.attr_("visibility").length < this.numColumns() - 1) {
758a629f 3446 this.attrs_.visibility.push(true);
1cf11047
DV
3447 }
3448 return this.attr_("visibility");
3449};
3450
3451/**
3452 * Changes the visiblity of a series.
3453 */
3454Dygraph.prototype.setVisibility = function(num, value) {
3455 var x = this.visibility();
a6c109c1 3456 if (num < 0 || num >= x.length) {
1cf11047
DV
3457 this.warn("invalid series number in setVisibility: " + num);
3458 } else {
3459 x[num] = value;
26ca7938 3460 this.predraw_();
1cf11047
DV
3461 }
3462};
3463
3464/**
0cb9bd91
DV
3465 * How large of an area will the dygraph render itself in?
3466 * This is used for testing.
3467 * @return A {width: w, height: h} object.
3468 * @private
3469 */
3470Dygraph.prototype.size = function() {
3471 return { width: this.width_, height: this.height_ };
3472};
3473
3474/**
5c528fa2 3475 * Update the list of annotations and redraw the chart.
41ee764f
DV
3476 * See dygraphs.com/annotations.html for more info on how to use annotations.
3477 * @param ann {Array} An array of annotation objects.
3478 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
5c528fa2 3479 */
a685723c 3480Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3c51ab74
DV
3481 // Only add the annotation CSS rule once we know it will be used.
3482 Dygraph.addAnnotationRule();
5c528fa2
DV
3483 this.annotations_ = ann;
3484 this.layout_.setAnnotations(this.annotations_);
a685723c 3485 if (!suppressDraw) {
26ca7938 3486 this.predraw_();
a685723c 3487 }
5c528fa2
DV
3488};
3489
3490/**
3491 * Return the list of annotations.
3492 */
3493Dygraph.prototype.annotations = function() {
3494 return this.annotations_;
3495};
3496
46dde5f9 3497/**
82c6fe4d
KW
3498 * Get the list of label names for this graph. The first column is the
3499 * x-axis, so the data series names start at index 1.
3500 */
e2c21500 3501Dygraph.prototype.getLabels = function() {
82c6fe4d
KW
3502 return this.attr_("labels").slice();
3503};
3504
3505/**
46dde5f9
DV
3506 * Get the index of a series (column) given its name. The first column is the
3507 * x-axis, so the data series start with index 1.
3508 */
3509Dygraph.prototype.indexFromSetName = function(name) {
82c6fe4d 3510 return this.setIndexByName_[name];
46dde5f9
DV
3511};
3512
629a09ae 3513/**
857a6931
KW
3514 * Get the internal dataset index given its name. These are numbered starting from 0,
3515 * and only count visible sets.
3516 * @private
3517 */
3518Dygraph.prototype.datasetIndexFromSetName_ = function(name) {
3519 return this.datasetIndex_[this.indexFromSetName(name)];
3520};
3521
3522/**
629a09ae
DV
3523 * @private
3524 * Adds a default style for the annotation CSS classes to the document. This is
3525 * only executed when annotations are actually used. It is designed to only be
3526 * called once -- all calls after the first will return immediately.
3527 */
5c528fa2 3528Dygraph.addAnnotationRule = function() {
d38c6191 3529 // TODO(danvk): move this function into plugins/annotations.js?
5c528fa2
DV
3530 if (Dygraph.addedAnnotationCSS) return;
3531
5c528fa2
DV
3532 var rule = "border: 1px solid black; " +
3533 "background-color: white; " +
3534 "text-align: center;";
22186871
DV
3535
3536 var styleSheetElement = document.createElement("style");
3537 styleSheetElement.type = "text/css";
3538 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3539
3540 // Find the first style sheet that we can access.
3541 // We may not add a rule to a style sheet from another domain for security
3542 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3543 // adds its own style sheets from google.com.
3544 for (var i = 0; i < document.styleSheets.length; i++) {
3545 if (document.styleSheets[i].disabled) continue;
3546 var mysheet = document.styleSheets[i];
3547 try {
3548 if (mysheet.insertRule) { // Firefox
3549 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3550 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3551 } else if (mysheet.addRule) { // IE
3552 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3553 }
3554 Dygraph.addedAnnotationCSS = true;
3555 return;
3556 } catch(err) {
3557 // Was likely a security exception.
3558 }
5c528fa2
DV
3559 }
3560
22186871 3561 this.warn("Unable to add default annotation CSS rule; display may be off.");
758a629f 3562};
5c528fa2 3563
285a6bda 3564// Older pages may still use this name.
c0f54d4f 3565var DateGraph = Dygraph;