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