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