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