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