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