Merge pull request #279 from danvk/datahandler-cleanup
[dygraphs.git] / dygraph-utils.js
CommitLineData
88e95c46
DV
1/**
2 * @license
3 * Copyright 2011 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
5 */
dedb4f5f 6
004b5c90
DV
7/**
8 * @fileoverview This file contains utility functions used by dygraphs. These
9 * are typically static (i.e. not related to any particular dygraph). Examples
10 * include date/time formatting functions, basic algorithms (e.g. binary
11 * search) and generic DOM-manipulation functions.
12 */
dedb4f5f 13
758a629f
DV
14/*jshint globalstrict: true */
15/*global Dygraph:false, G_vmlCanvasManager:false, Node:false, printStackTrace: false */
c0f54d4f
DV
16"use strict";
17
dedb4f5f
DV
18Dygraph.LOG_SCALE = 10;
19Dygraph.LN_TEN = Math.log(Dygraph.LOG_SCALE);
20
f11283de
DV
21/**
22 * @private
23 * @param {number} x
24 * @return {number}
25 */
dedb4f5f
DV
26Dygraph.log10 = function(x) {
27 return Math.log(x) / Dygraph.LN_TEN;
758a629f 28};
dedb4f5f
DV
29
30// Various logging levels.
31Dygraph.DEBUG = 1;
32Dygraph.INFO = 2;
33Dygraph.WARNING = 3;
34Dygraph.ERROR = 3;
35
464b5f50 36// <REMOVE_FOR_COMBINED>
00639fab
DV
37// Set this to log stack traces on warnings, etc.
38// This requires stacktrace.js, which is up to you to provide.
39// A copy can be found in the dygraphs repo, or at
40// https://github.com/eriwen/javascript-stacktrace
41Dygraph.LOG_STACK_TRACES = false;
464b5f50 42// </REMOVE_FOR_COMBINED>
00639fab 43
79253bd0 44/** A dotted line stroke pattern. */
45Dygraph.DOTTED_LINE = [2, 2];
46/** A dashed line stroke pattern. */
47Dygraph.DASHED_LINE = [7, 3];
48/** A dot dash stroke pattern. */
49Dygraph.DOT_DASH_LINE = [7, 2, 2, 2];
50
dedb4f5f 51/**
dedb4f5f 52 * Log an error on the JS console at the given severity.
f11283de
DV
53 * @param {number} severity One of Dygraph.{DEBUG,INFO,WARNING,ERROR}
54 * @param {string} message The message to log.
55 * @private
dedb4f5f
DV
56 */
57Dygraph.log = function(severity, message) {
464b5f50 58 // <REMOVE_FOR_COMBINED>
00639fab
DV
59 var st;
60 if (typeof(printStackTrace) != 'undefined') {
df21c270
DV
61 try {
62 // Remove uninteresting bits: logging functions and paths.
63 st = printStackTrace({guess:false});
64 while (st[0].indexOf("stacktrace") != -1) {
65 st.splice(0, 1);
66 }
0d319fa5 67
df21c270
DV
68 st.splice(0, 2);
69 for (var i = 0; i < st.length; i++) {
70 st[i] = st[i].replace(/\([^)]*\/(.*)\)/, '@$1')
71 .replace(/\@.*\/([^\/]*)/, '@$1')
72 .replace('[object Object].', '');
73 }
74 var top_msg = st.splice(0, 1)[0];
75 message += ' (' + top_msg.replace(/^.*@ ?/, '') + ')';
76 } catch(e) {
77 // Oh well, it was worth a shot!
00639fab 78 }
00639fab 79 }
464b5f50 80 // </REMOVE_FOR_COMBINED>
00639fab 81
f11283de 82 if (typeof(window.console) != 'undefined') {
33e96f11
DV
83 // In older versions of Firefox, only console.log is defined.
84 var console = window.console;
85 var log = function(console, method, msg) {
94ee0648 86 if (method && typeof(method) == 'function') {
33e96f11
DV
87 method.call(console, msg);
88 } else {
89 console.log(msg);
90 }
91 };
92
dedb4f5f
DV
93 switch (severity) {
94 case Dygraph.DEBUG:
33e96f11 95 log(console, console.debug, 'dygraphs: ' + message);
dedb4f5f
DV
96 break;
97 case Dygraph.INFO:
33e96f11 98 log(console, console.info, 'dygraphs: ' + message);
dedb4f5f
DV
99 break;
100 case Dygraph.WARNING:
33e96f11 101 log(console, console.warn, 'dygraphs: ' + message);
dedb4f5f
DV
102 break;
103 case Dygraph.ERROR:
33e96f11 104 log(console, console.error, 'dygraphs: ' + message);
dedb4f5f
DV
105 break;
106 }
107 }
00639fab 108
464b5f50 109 // <REMOVE_FOR_COMBINED>
00639fab 110 if (Dygraph.LOG_STACK_TRACES) {
f11283de 111 window.console.log(st.join('\n'));
00639fab 112 }
464b5f50 113 // </REMOVE_FOR_COMBINED>
dedb4f5f
DV
114};
115
f11283de
DV
116/**
117 * @param {string} message
118 * @private
119 */
dedb4f5f
DV
120Dygraph.info = function(message) {
121 Dygraph.log(Dygraph.INFO, message);
122};
dedb4f5f 123
f11283de
DV
124/**
125 * @param {string} message
126 * @private
127 */
dedb4f5f
DV
128Dygraph.warn = function(message) {
129 Dygraph.log(Dygraph.WARNING, message);
130};
dedb4f5f 131
f11283de
DV
132/**
133 * @param {string} message
f11283de 134 */
dedb4f5f
DV
135Dygraph.error = function(message) {
136 Dygraph.log(Dygraph.ERROR, message);
137};
dedb4f5f
DV
138
139/**
dedb4f5f
DV
140 * Return the 2d context for a dygraph canvas.
141 *
142 * This method is only exposed for the sake of replacing the function in
143 * automated tests, e.g.
144 *
145 * var oldFunc = Dygraph.getContext();
146 * Dygraph.getContext = function(canvas) {
147 * var realContext = oldFunc(canvas);
148 * return new Proxy(realContext);
149 * };
f11283de
DV
150 * @param {!HTMLCanvasElement} canvas
151 * @return {!CanvasRenderingContext2D}
152 * @private
dedb4f5f
DV
153 */
154Dygraph.getContext = function(canvas) {
f11283de 155 return /** @type{!CanvasRenderingContext2D}*/(canvas.getContext("2d"));
dedb4f5f
DV
156};
157
158/**
dedb4f5f
DV
159 * Add an event handler. This smooths a difference between IE and the rest of
160 * the world.
f11283de
DV
161 * @param { !Element } elem The element to add the event to.
162 * @param { string } type The type of the event, e.g. 'click' or 'mousemove'.
163 * @param { function(Event):(boolean|undefined) } fn The function to call
164 * on the event. The function takes one parameter: the event object.
165 * @private
dedb4f5f 166 */
1cc3540b 167Dygraph.addEvent = function addEvent(elem, type, fn) {
ccd9d7c2
PF
168 if (elem.addEventListener) {
169 elem.addEventListener(type, fn, false);
170 } else {
171 elem[type+fn] = function(){fn(window.event);};
172 elem.attachEvent('on'+type, elem[type+fn]);
173 }
1cc3540b
RK
174};
175
176/**
1cc3540b
RK
177 * Add an event handler. This event handler is kept until the graph is
178 * destroyed with a call to graph.destroy().
179 *
f11283de
DV
180 * @param { !Element } elem The element to add the event to.
181 * @param { string } type The type of the event, e.g. 'click' or 'mousemove'.
182 * @param { function(Event):(boolean|undefined) } fn The function to call
183 * on the event. The function takes one parameter: the event object.
184 * @private
1cc3540b 185 */
aeca29ac 186Dygraph.prototype.addAndTrackEvent = function(elem, type, fn) {
1cc3540b 187 Dygraph.addEvent(elem, type, fn);
6a4587ac 188 this.registeredEvents_.push({ elem : elem, type : type, fn : fn });
ccd9d7c2
PF
189};
190
191/**
f11283de
DV
192 * Remove an event handler. This smooths a difference between IE and the rest
193 * of the world.
194 * @param {!Element} elem The element to add the event to.
195 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
196 * @param {function(Event):(boolean|undefined)} fn The function to call
197 * on the event. The function takes one parameter: the event object.
ccd9d7c2 198 * @private
ccd9d7c2 199 */
a537fd67 200Dygraph.removeEvent = function(elem, type, fn) {
ccd9d7c2
PF
201 if (elem.removeEventListener) {
202 elem.removeEventListener(type, fn, false);
203 } else {
e2769469
DV
204 try {
205 elem.detachEvent('on'+type, elem[type+fn]);
206 } catch(e) {
207 // We only detach event listeners on a "best effort" basis in IE. See:
208 // http://stackoverflow.com/questions/2553632/detachevent-not-working-with-named-inline-functions
209 }
ccd9d7c2 210 elem[type+fn] = null;
dedb4f5f
DV
211 }
212};
213
aeca29ac
RK
214Dygraph.prototype.removeTrackedEvents_ = function() {
215 if (this.registeredEvents_) {
216 for (var idx = 0; idx < this.registeredEvents_.length; idx++) {
217 var reg = this.registeredEvents_[idx];
218 Dygraph.removeEvent(reg.elem, reg.type, reg.fn);
219 }
220 }
221
222 this.registeredEvents_ = [];
f914bed1 223};
aeca29ac 224
dedb4f5f 225/**
dedb4f5f
DV
226 * Cancels further processing of an event. This is useful to prevent default
227 * browser actions, e.g. highlighting text on a double-click.
228 * Based on the article at
229 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
f11283de
DV
230 * @param { !Event } e The event whose normal behavior should be canceled.
231 * @private
dedb4f5f
DV
232 */
233Dygraph.cancelEvent = function(e) {
234 e = e ? e : window.event;
235 if (e.stopPropagation) {
236 e.stopPropagation();
237 }
238 if (e.preventDefault) {
239 e.preventDefault();
240 }
241 e.cancelBubble = true;
242 e.cancel = true;
243 e.returnValue = false;
244 return false;
245};
246
247/**
248 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
249 * is used to generate default series colors which are evenly spaced on the
250 * color wheel.
f11283de
DV
251 * @param { number } hue Range is 0.0-1.0.
252 * @param { number } saturation Range is 0.0-1.0.
253 * @param { number } value Range is 0.0-1.0.
254 * @return { string } "rgb(r,g,b)" where r, g and b range from 0-255.
dedb4f5f
DV
255 * @private
256 */
257Dygraph.hsvToRGB = function (hue, saturation, value) {
258 var red;
259 var green;
260 var blue;
261 if (saturation === 0) {
262 red = value;
263 green = value;
264 blue = value;
265 } else {
266 var i = Math.floor(hue * 6);
267 var f = (hue * 6) - i;
268 var p = value * (1 - saturation);
269 var q = value * (1 - (saturation * f));
270 var t = value * (1 - (saturation * (1 - f)));
271 switch (i) {
272 case 1: red = q; green = value; blue = p; break;
273 case 2: red = p; green = value; blue = t; break;
274 case 3: red = p; green = q; blue = value; break;
275 case 4: red = t; green = p; blue = value; break;
276 case 5: red = value; green = p; blue = q; break;
277 case 6: // fall through
278 case 0: red = value; green = t; blue = p; break;
279 }
280 }
281 red = Math.floor(255 * red + 0.5);
282 green = Math.floor(255 * green + 0.5);
283 blue = Math.floor(255 * blue + 0.5);
284 return 'rgb(' + red + ',' + green + ',' + blue + ')';
285};
286
287// The following functions are from quirksmode.org with a modification for Safari from
288// http://blog.firetree.net/2005/07/04/javascript-find-position/
289// http://www.quirksmode.org/js/findpos.html
1bc38cbc 290// ... and modifications to support scrolling divs.
dedb4f5f 291
8442269f 292/**
464b5f50
DV
293 * Find the coordinates of an object relative to the top left of the page.
294 *
f11283de
DV
295 * TODO(danvk): change obj type from Node -&gt; !Node
296 * @param {Node} obj
464b5f50 297 * @return {{x:number,y:number}}
8442269f
RK
298 * @private
299 */
464b5f50
DV
300Dygraph.findPos = function(obj) {
301 var curleft = 0, curtop = 0;
302 if (obj.offsetParent) {
8442269f 303 var copyObj = obj;
464b5f50 304 while (1) {
ecdb6dff 305 // NOTE: the if statement here is for IE8.
464b5f50 306 var borderLeft = "0", borderTop = "0";
4ff8c62e 307 if (window.getComputedStyle) {
464b5f50
DV
308 var computedStyle = window.getComputedStyle(copyObj, null);
309 borderLeft = computedStyle.borderLeft || "0";
310 borderTop = computedStyle.borderTop || "0";
4ff8c62e 311 }
abc8c570 312 curleft += parseInt(borderLeft, 10) ;
abc8c570 313 curtop += parseInt(borderTop, 10) ;
464b5f50 314 curleft += copyObj.offsetLeft;
8442269f 315 curtop += copyObj.offsetTop;
464b5f50 316 if (!copyObj.offsetParent) {
dedb4f5f 317 break;
8442269f
RK
318 }
319 copyObj = copyObj.offsetParent;
dedb4f5f 320 }
464b5f50
DV
321 } else {
322 // TODO(danvk): why would obj ever have these properties?
323 if (obj.x) curleft += obj.x;
324 if (obj.y) curtop += obj.y;
8442269f 325 }
464b5f50 326
8442269f 327 // This handles the case where the object is inside a scrolled div.
464b5f50
DV
328 while (obj && obj != document.body) {
329 curleft -= obj.scrollLeft;
8442269f
RK
330 curtop -= obj.scrollTop;
331 obj = obj.parentNode;
332 }
464b5f50 333 return {x: curleft, y: curtop};
dedb4f5f
DV
334};
335
336/**
dedb4f5f
DV
337 * Returns the x-coordinate of the event in a coordinate system where the
338 * top-left corner of the page (not the window) is (0,0).
339 * Taken from MochiKit.Signal
f11283de
DV
340 * @param {!Event} e
341 * @return {number}
342 * @private
dedb4f5f
DV
343 */
344Dygraph.pageX = function(e) {
345 if (e.pageX) {
346 return (!e.pageX || e.pageX < 0) ? 0 : e.pageX;
347 } else {
f11283de 348 var de = document.documentElement;
dedb4f5f
DV
349 var b = document.body;
350 return e.clientX +
351 (de.scrollLeft || b.scrollLeft) -
352 (de.clientLeft || 0);
353 }
354};
355
356/**
dedb4f5f
DV
357 * Returns the y-coordinate of the event in a coordinate system where the
358 * top-left corner of the page (not the window) is (0,0).
359 * Taken from MochiKit.Signal
f11283de
DV
360 * @param {!Event} e
361 * @return {number}
362 * @private
dedb4f5f
DV
363 */
364Dygraph.pageY = function(e) {
365 if (e.pageY) {
366 return (!e.pageY || e.pageY < 0) ? 0 : e.pageY;
367 } else {
f11283de 368 var de = document.documentElement;
dedb4f5f
DV
369 var b = document.body;
370 return e.clientY +
371 (de.scrollTop || b.scrollTop) -
372 (de.clientTop || 0);
373 }
374};
375
376/**
f11283de
DV
377 * This returns true unless the parameter is 0, null, undefined or NaN.
378 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
379 *
380 * @param {number} x The number to consider.
381 * @return {boolean} Whether the number is zero or NaN.
dedb4f5f 382 * @private
dedb4f5f 383 */
dedb4f5f 384Dygraph.isOK = function(x) {
f11283de 385 return !!x && !isNaN(x);
dedb4f5f
DV
386};
387
388/**
f11283de
DV
389 * @param { {x:?number,y:?number,yval:?number} } p The point to consider, valid
390 * points are {x, y} objects
391 * @param { boolean } allowNaNY Treat point with y=NaN as valid
392 * @return { boolean } Whether the point has numeric x and y.
62c3d2fd 393 * @private
62c3d2fd 394 */
04c104d7 395Dygraph.isValidPoint = function(p, allowNaNY) {
f11283de
DV
396 if (!p) return false; // null or undefined object
397 if (p.yval === null) return false; // missing point
04c104d7
KW
398 if (p.x === null || p.x === undefined) return false;
399 if (p.y === null || p.y === undefined) return false;
400 if (isNaN(p.x) || (!allowNaNY && isNaN(p.y))) return false;
62c3d2fd
KW
401 return true;
402};
403
404/**
dedb4f5f
DV
405 * Number formatting function which mimicks the behavior of %g in printf, i.e.
406 * either exponential or fixed format (without trailing 0s) is used depending on
407 * the length of the generated string. The advantage of this format is that
408 * there is a predictable upper bound on the resulting string length,
409 * significant figures are not dropped, and normal numbers are not displayed in
410 * exponential notation.
411 *
412 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
413 * It creates strings which are too long for absolute values between 10^-4 and
414 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
415 * output examples.
416 *
f11283de
DV
417 * @param {number} x The number to format
418 * @param {number=} opt_precision The precision to use, default 2.
419 * @return {string} A string formatted like %g in printf. The max generated
dedb4f5f
DV
420 * string length should be precision + 6 (e.g 1.123e+300).
421 */
422Dygraph.floatFormat = function(x, opt_precision) {
423 // Avoid invalid precision values; [1, 21] is the valid range.
424 var p = Math.min(Math.max(1, opt_precision || 2), 21);
425
426 // This is deceptively simple. The actual algorithm comes from:
427 //
428 // Max allowed length = p + 4
429 // where 4 comes from 'e+n' and '.'.
430 //
431 // Length of fixed format = 2 + y + p
432 // where 2 comes from '0.' and y = # of leading zeroes.
433 //
434 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
435 // 1.0e-3.
436 //
437 // Since the behavior of toPrecision() is identical for larger numbers, we
438 // don't have to worry about the other bound.
439 //
440 // Finally, the argument for toExponential() is the number of trailing digits,
441 // so we take off 1 for the value before the '.'.
758a629f 442 return (Math.abs(x) < 1.0e-3 && x !== 0.0) ?
dedb4f5f
DV
443 x.toExponential(p - 1) : x.toPrecision(p);
444};
445
446/**
dedb4f5f 447 * Converts '9' to '09' (useful for dates)
f11283de
DV
448 * @param {number} x
449 * @return {string}
450 * @private
dedb4f5f
DV
451 */
452Dygraph.zeropad = function(x) {
453 if (x < 10) return "0" + x; else return "" + x;
454};
455
456/**
457 * Return a string version of the hours, minutes and seconds portion of a date.
f11283de
DV
458 *
459 * @param {number} date The JavaScript date (ms since epoch)
460 * @return {string} A time of the form "HH:MM:SS"
dedb4f5f
DV
461 * @private
462 */
463Dygraph.hmsString_ = function(date) {
464 var zeropad = Dygraph.zeropad;
465 var d = new Date(date);
466 if (d.getSeconds()) {
467 return zeropad(d.getHours()) + ":" +
468 zeropad(d.getMinutes()) + ":" +
469 zeropad(d.getSeconds());
470 } else {
471 return zeropad(d.getHours()) + ":" + zeropad(d.getMinutes());
472 }
473};
474
475/**
464b5f50
DV
476 * Convert a JS date (millis since epoch) to YYYY/MM/DD
477 * @param {number} date The JavaScript date (ms since epoch)
478 * @return {string} A date of the form "YYYY/MM/DD"
479 * @private
480 */
481Dygraph.dateString_ = function(date) {
482 var zeropad = Dygraph.zeropad;
483 var d = new Date(date);
484
485 // Get the year:
486 var year = "" + d.getFullYear();
487 // Get a 0 padded month string
488 var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh
489 // Get a 0 padded day string
490 var day = zeropad(d.getDate());
491
492 var ret = "";
493 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
494 if (frac) ret = " " + Dygraph.hmsString_(date);
495
496 return year + "/" + month + "/" + day + ret;
497};
498
499/**
dedb4f5f 500 * Round a number to the specified number of digits past the decimal point.
f11283de
DV
501 * @param {number} num The number to round
502 * @param {number} places The number of decimals to which to round
503 * @return {number} The rounded number
dedb4f5f
DV
504 * @private
505 */
506Dygraph.round_ = function(num, places) {
507 var shift = Math.pow(10, places);
508 return Math.round(num * shift)/shift;
509};
510
511/**
dedb4f5f
DV
512 * Implementation of binary search over an array.
513 * Currently does not work when val is outside the range of arry's values.
f11283de
DV
514 * @param {number} val the value to search for
515 * @param {Array.<number>} arry is the value over which to search
516 * @param {number} abs If abs > 0, find the lowest entry greater than val
517 * If abs < 0, find the highest entry less than val.
518 * If abs == 0, find the entry that equals val.
519 * @param {number=} low The first index in arry to consider (optional)
520 * @param {number=} high The last index in arry to consider (optional)
521 * @return {number} Index of the element, or -1 if it isn't found.
522 * @private
dedb4f5f
DV
523 */
524Dygraph.binarySearch = function(val, arry, abs, low, high) {
758a629f
DV
525 if (low === null || low === undefined ||
526 high === null || high === undefined) {
dedb4f5f
DV
527 low = 0;
528 high = arry.length - 1;
529 }
530 if (low > high) {
531 return -1;
532 }
758a629f 533 if (abs === null || abs === undefined) {
dedb4f5f
DV
534 abs = 0;
535 }
536 var validIndex = function(idx) {
537 return idx >= 0 && idx < arry.length;
758a629f
DV
538 };
539 var mid = parseInt((low + high) / 2, 10);
dedb4f5f 540 var element = arry[mid];
f11283de 541 var idx;
dedb4f5f
DV
542 if (element == val) {
543 return mid;
f11283de 544 } else if (element > val) {
dedb4f5f
DV
545 if (abs > 0) {
546 // Accept if element > val, but also if prior element < val.
758a629f 547 idx = mid - 1;
dedb4f5f
DV
548 if (validIndex(idx) && arry[idx] < val) {
549 return mid;
550 }
551 }
552 return Dygraph.binarySearch(val, arry, abs, low, mid - 1);
f11283de 553 } else if (element < val) {
dedb4f5f
DV
554 if (abs < 0) {
555 // Accept if element < val, but also if prior element > val.
758a629f 556 idx = mid + 1;
dedb4f5f
DV
557 if (validIndex(idx) && arry[idx] > val) {
558 return mid;
559 }
560 }
561 return Dygraph.binarySearch(val, arry, abs, mid + 1, high);
562 }
f11283de 563 return -1; // can't actually happen, but makes closure compiler happy
dedb4f5f
DV
564};
565
566/**
dedb4f5f
DV
567 * Parses a date, returning the number of milliseconds since epoch. This can be
568 * passed in as an xValueParser in the Dygraph constructor.
569 * TODO(danvk): enumerate formats that this understands.
f11283de
DV
570 *
571 * @param {string} dateStr A date in a variety of possible string formats.
572 * @return {number} Milliseconds since epoch.
573 * @private
dedb4f5f
DV
574 */
575Dygraph.dateParser = function(dateStr) {
576 var dateStrSlashed;
577 var d;
769e8bc7 578
3f675fe5
DV
579 // Let the system try the format first, with one caveat:
580 // YYYY-MM-DD[ HH:MM:SS] is interpreted as UTC by a variety of browsers.
581 // dygraphs displays dates in local time, so this will result in surprising
582 // inconsistencies. But if you specify "T" or "Z" (i.e. YYYY-MM-DDTHH:MM:SS),
583 // then you probably know what you're doing, so we'll let you go ahead.
584 // Issue: http://code.google.com/p/dygraphs/issues/detail?id=255
585 if (dateStr.search("-") == -1 ||
586 dateStr.search("T") != -1 || dateStr.search("Z") != -1) {
587 d = Dygraph.dateStrToMillis(dateStr);
588 if (d && !isNaN(d)) return d;
589 }
769e8bc7 590
dedb4f5f
DV
591 if (dateStr.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
592 dateStrSlashed = dateStr.replace("-", "/", "g");
593 while (dateStrSlashed.search("-") != -1) {
594 dateStrSlashed = dateStrSlashed.replace("-", "/");
595 }
596 d = Dygraph.dateStrToMillis(dateStrSlashed);
597 } else if (dateStr.length == 8) { // e.g. '20090712'
598 // TODO(danvk): remove support for this format. It's confusing.
758a629f
DV
599 dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
600 dateStr.substr(6,2);
dedb4f5f
DV
601 d = Dygraph.dateStrToMillis(dateStrSlashed);
602 } else {
603 // Any format that Date.parse will accept, e.g. "2009/07/12" or
604 // "2009/07/12 12:34:56"
605 d = Dygraph.dateStrToMillis(dateStr);
606 }
607
608 if (!d || isNaN(d)) {
609 Dygraph.error("Couldn't parse " + dateStr + " as a date");
610 }
611 return d;
612};
613
614/**
dedb4f5f
DV
615 * This is identical to JavaScript's built-in Date.parse() method, except that
616 * it doesn't get replaced with an incompatible method by aggressive JS
617 * libraries like MooTools or Joomla.
f11283de
DV
618 * @param {string} str The date string, e.g. "2011/05/06"
619 * @return {number} millis since epoch
620 * @private
dedb4f5f
DV
621 */
622Dygraph.dateStrToMillis = function(str) {
623 return new Date(str).getTime();
624};
625
626// These functions are all based on MochiKit.
627/**
628 * Copies all the properties from o to self.
629 *
f11283de
DV
630 * @param {!Object} self
631 * @param {!Object} o
632 * @return {!Object}
dedb4f5f 633 */
f11283de 634Dygraph.update = function(self, o) {
dedb4f5f
DV
635 if (typeof(o) != 'undefined' && o !== null) {
636 for (var k in o) {
637 if (o.hasOwnProperty(k)) {
638 self[k] = o[k];
639 }
640 }
641 }
642 return self;
643};
644
645/**
48e614ac
DV
646 * Copies all the properties from o to self.
647 *
f11283de
DV
648 * @param {!Object} self
649 * @param {!Object} o
650 * @return {!Object}
48e614ac
DV
651 * @private
652 */
653Dygraph.updateDeep = function (self, o) {
920208fb
PF
654 // Taken from http://stackoverflow.com/questions/384286/javascript-isdom-how-do-you-check-if-a-javascript-object-is-a-dom-object
655 function isNode(o) {
656 return (
657 typeof Node === "object" ? o instanceof Node :
658 typeof o === "object" && typeof o.nodeType === "number" && typeof o.nodeName==="string"
659 );
660 }
661
48e614ac
DV
662 if (typeof(o) != 'undefined' && o !== null) {
663 for (var k in o) {
664 if (o.hasOwnProperty(k)) {
758a629f 665 if (o[k] === null) {
48e614ac
DV
666 self[k] = null;
667 } else if (Dygraph.isArrayLike(o[k])) {
668 self[k] = o[k].slice();
920208fb 669 } else if (isNode(o[k])) {
66ad3609
RK
670 // DOM objects are shallowly-copied.
671 self[k] = o[k];
48e614ac 672 } else if (typeof(o[k]) == 'object') {
c1c5dfeb 673 if (typeof(self[k]) != 'object' || self[k] === null) {
48e614ac
DV
674 self[k] = {};
675 }
676 Dygraph.updateDeep(self[k], o[k]);
677 } else {
678 self[k] = o[k];
679 }
680 }
681 }
682 }
683 return self;
684};
685
686/**
f11283de
DV
687 * @param {Object} o
688 * @return {boolean}
dedb4f5f
DV
689 * @private
690 */
f11283de 691Dygraph.isArrayLike = function(o) {
dedb4f5f
DV
692 var typ = typeof(o);
693 if (
694 (typ != 'object' && !(typ == 'function' &&
695 typeof(o.item) == 'function')) ||
696 o === null ||
697 typeof(o.length) != 'number' ||
698 o.nodeType === 3
699 ) {
700 return false;
701 }
702 return true;
703};
704
705/**
f11283de
DV
706 * @param {Object} o
707 * @return {boolean}
dedb4f5f
DV
708 * @private
709 */
710Dygraph.isDateLike = function (o) {
711 if (typeof(o) != "object" || o === null ||
712 typeof(o.getTime) != 'function') {
713 return false;
714 }
715 return true;
716};
717
718/**
48e614ac 719 * Note: this only seems to work for arrays.
f11283de
DV
720 * @param {!Array} o
721 * @return {!Array}
dedb4f5f
DV
722 * @private
723 */
724Dygraph.clone = function(o) {
725 // TODO(danvk): figure out how MochiKit's version works
726 var r = [];
727 for (var i = 0; i < o.length; i++) {
728 if (Dygraph.isArrayLike(o[i])) {
729 r.push(Dygraph.clone(o[i]));
730 } else {
731 r.push(o[i]);
732 }
733 }
734 return r;
735};
736
737/**
dedb4f5f
DV
738 * Create a new canvas element. This is more complex than a simple
739 * document.createElement("canvas") because of IE and excanvas.
f11283de
DV
740 *
741 * @return {!HTMLCanvasElement}
742 * @private
dedb4f5f
DV
743 */
744Dygraph.createCanvas = function() {
745 var canvas = document.createElement("canvas");
746
c0f54d4f 747 var isIE = (/MSIE/.test(navigator.userAgent) && !window.opera);
dedb4f5f 748 if (isIE && (typeof(G_vmlCanvasManager) != 'undefined')) {
f11283de
DV
749 canvas = G_vmlCanvasManager.initElement(
750 /**@type{!HTMLCanvasElement}*/(canvas));
dedb4f5f
DV
751 }
752
753 return canvas;
754};
9ca829f2
DV
755
756/**
971870e5
DV
757 * Checks whether the user is on an Android browser.
758 * Android does not fully support the <canvas> tag, e.g. w/r/t/ clipping.
f11283de
DV
759 * @return {boolean}
760 * @private
971870e5
DV
761 */
762Dygraph.isAndroid = function() {
758a629f 763 return (/Android/).test(navigator.userAgent);
971870e5
DV
764};
765
f11283de
DV
766
767/**
768 * TODO(danvk): use @template here when it's better supported for classes.
769 * @param {!Array} array
770 * @param {number} start
771 * @param {number} length
45a8c16f 772 * @param {function(!Array,?):boolean=} predicate
f11283de
DV
773 * @constructor
774 */
a26206cf
RK
775Dygraph.Iterator = function(array, start, length, predicate) {
776 start = start || 0;
777 length = length || array.length;
ff1074cd
RK
778 this.hasNext = true; // Use to identify if there's another element.
779 this.peek = null; // Use for look-ahead
0f20de1c 780 this.start_ = start;
a26206cf
RK
781 this.array_ = array;
782 this.predicate_ = predicate;
783 this.end_ = Math.min(array.length, start + length);
ff1074cd
RK
784 this.nextIdx_ = start - 1; // use -1 so initial advance works.
785 this.next(); // ignoring result.
42a9ebb8 786};
a26206cf 787
f11283de
DV
788/**
789 * @return {Object}
790 */
a26206cf 791Dygraph.Iterator.prototype.next = function() {
ff1074cd
RK
792 if (!this.hasNext) {
793 return null;
a26206cf 794 }
ff1074cd 795 var obj = this.peek;
a26206cf 796
ff1074cd
RK
797 var nextIdx = this.nextIdx_ + 1;
798 var found = false;
799 while (nextIdx < this.end_) {
a26206cf 800 if (!this.predicate_ || this.predicate_(this.array_, nextIdx)) {
ff1074cd
RK
801 this.peek = this.array_[nextIdx];
802 found = true;
803 break;
a26206cf
RK
804 }
805 nextIdx++;
806 }
807 this.nextIdx_ = nextIdx;
ff1074cd
RK
808 if (!found) {
809 this.hasNext = false;
810 this.peek = null;
811 }
812 return obj;
42a9ebb8 813};
a26206cf 814
971870e5 815/**
222d67c9 816 * Returns a new iterator over array, between indexes start and
7d1afbb9
RK
817 * start + length, and only returns entries that pass the accept function
818 *
f11283de
DV
819 * @param {!Array} array the array to iterate over.
820 * @param {number} start the first index to iterate over, 0 if absent.
821 * @param {number} length the number of elements in the array to iterate over.
822 * This, along with start, defines a slice of the array, and so length
823 * doesn't imply the number of elements in the iterator when accept doesn't
824 * always accept all values. array.length when absent.
45a8c16f 825 * @param {function(?):boolean=} opt_predicate a function that takes
f11283de
DV
826 * parameters array and idx, which returns true when the element should be
827 * returned. If omitted, all elements are accepted.
828 * @private
7d1afbb9 829 */
f11283de
DV
830Dygraph.createIterator = function(array, start, length, opt_predicate) {
831 return new Dygraph.Iterator(array, start, length, opt_predicate);
7d1afbb9
RK
832};
833
a96b8ba3
A
834// Shim layer with setTimeout fallback.
835// From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
e9a32469
A
836// Should be called with the window context:
837// Dygraph.requestAnimFrame.call(window, function() {})
bec100ae 838Dygraph.requestAnimFrame = (function() {
a96b8ba3
A
839 return window.requestAnimationFrame ||
840 window.webkitRequestAnimationFrame ||
841 window.mozRequestAnimationFrame ||
842 window.oRequestAnimationFrame ||
843 window.msRequestAnimationFrame ||
844 function (callback) {
845 window.setTimeout(callback, 1000 / 60);
846 };
847})();
848
849/**
d91ba598
A
850 * Call a function at most maxFrames times at an attempted interval of
851 * framePeriodInMillis, then call a cleanup function once. repeatFn is called
852 * once immediately, then at most (maxFrames - 1) times asynchronously. If
853 * maxFrames==1, then cleanup_fn() is also called synchronously. This function
854 * is used to sequence animation.
855 * @param {function(number)} repeatFn Called repeatedly -- takes the frame
856 * number (from 0 to maxFrames-1) as an argument.
857 * @param {number} maxFrames The max number of times to call repeatFn
858 * @param {number} framePeriodInMillis Max requested time between frames.
859 * @param {function()} cleanupFn A function to call after all repeatFn calls.
860 * @private
861 */
862Dygraph.repeatAndCleanup = function(repeatFn, maxFrames, framePeriodInMillis,
bec100ae 863 cleanupFn) {
d91ba598
A
864 var frameNumber = 0;
865 var previousFrameNumber;
866 var startTime = new Date().getTime();
867 repeatFn(frameNumber);
868 if (maxFrames == 1) {
869 cleanupFn();
b1a3b195
DV
870 return;
871 }
d91ba598 872 var maxFrameArg = maxFrames - 1;
b1a3b195
DV
873
874 (function loop() {
d91ba598 875 if (frameNumber >= maxFrames) return;
e9a32469 876 Dygraph.requestAnimFrame.call(window, function() {
d91ba598
A
877 // Determine which frame to draw based on the delay so far. Will skip
878 // frames if necessary.
879 var currentTime = new Date().getTime();
880 var delayInMillis = currentTime - startTime;
881 previousFrameNumber = frameNumber;
882 frameNumber = Math.floor(delayInMillis / framePeriodInMillis);
883 var frameDelta = frameNumber - previousFrameNumber;
884 // If we predict that the subsequent repeatFn call will overshoot our
885 // total frame target, so our last call will cause a stutter, then jump to
886 // the last call immediately. If we're going to cause a stutter, better
887 // to do it faster than slower.
888 var predictOvershootStutter = (frameNumber + frameDelta) > maxFrameArg;
889 if (predictOvershootStutter || (frameNumber >= maxFrameArg)) {
890 repeatFn(maxFrameArg); // Ensure final call with maxFrameArg.
891 cleanupFn();
b1a3b195 892 } else {
83b0c192 893 if (frameDelta !== 0) { // Don't call repeatFn with duplicate frames.
d91ba598
A
894 repeatFn(frameNumber);
895 }
b1a3b195
DV
896 loop();
897 }
a96b8ba3 898 });
b1a3b195
DV
899 })();
900};
901
902/**
9ca829f2
DV
903 * This function will scan the option list and determine if they
904 * require us to recalculate the pixel positions of each point.
f11283de 905 * @param {!Array.<string>} labels a list of options to check.
222d67c9 906 * @param {!Object} attrs
f11283de
DV
907 * @return {boolean} true if the graph needs new points else false.
908 * @private
9ca829f2
DV
909 */
910Dygraph.isPixelChangingOptionList = function(labels, attrs) {
911 // A whitelist of options that do not change pixel positions.
912 var pixelSafeOptions = {
913 'annotationClickHandler': true,
914 'annotationDblClickHandler': true,
915 'annotationMouseOutHandler': true,
916 'annotationMouseOverHandler': true,
917 'axisLabelColor': true,
918 'axisLineColor': true,
919 'axisLineWidth': true,
920 'clickCallback': true,
9ca829f2
DV
921 'digitsAfterDecimal': true,
922 'drawCallback': true,
5879307d 923 'drawHighlightPointCallback': true,
9ca829f2 924 'drawPoints': true,
78e58af4 925 'drawPointCallback': true,
9ca829f2
DV
926 'drawXGrid': true,
927 'drawYGrid': true,
928 'fillAlpha': true,
929 'gridLineColor': true,
930 'gridLineWidth': true,
931 'hideOverlayOnMouseOut': true,
932 'highlightCallback': true,
933 'highlightCircleSize': true,
934 'interactionModel': true,
935 'isZoomedIgnoreProgrammaticZoom': true,
936 'labelsDiv': true,
937 'labelsDivStyles': true,
938 'labelsDivWidth': true,
939 'labelsKMB': true,
940 'labelsKMG2': true,
941 'labelsSeparateLines': true,
942 'labelsShowZeroValues': true,
943 'legend': true,
944 'maxNumberWidth': true,
945 'panEdgeFraction': true,
946 'pixelsPerYLabel': true,
947 'pointClickCallback': true,
948 'pointSize': true,
ccd9d7c2
PF
949 'rangeSelectorPlotFillColor': true,
950 'rangeSelectorPlotStrokeColor': true,
9ca829f2
DV
951 'showLabelsOnHighlight': true,
952 'showRoller': true,
953 'sigFigs': true,
954 'strokeWidth': true,
955 'underlayCallback': true,
956 'unhighlightCallback': true,
957 'xAxisLabelFormatter': true,
958 'xTicker': true,
959 'xValueFormatter': true,
960 'yAxisLabelFormatter': true,
961 'yValueFormatter': true,
962 'zoomCallback': true
ccd9d7c2 963 };
9ca829f2
DV
964
965 // Assume that we do not require new points.
966 // This will change to true if we actually do need new points.
967 var requiresNewPoints = false;
968
969 // Create a dictionary of series names for faster lookup.
970 // If there are no labels, then the dictionary stays empty.
971 var seriesNamesDictionary = { };
972 if (labels) {
973 for (var i = 1; i < labels.length; i++) {
974 seriesNamesDictionary[labels[i]] = true;
975 }
976 }
977
978 // Iterate through the list of updated options.
5061b42f 979 for (var property in attrs) {
9ca829f2
DV
980 // Break early if we already know we need new points from a previous option.
981 if (requiresNewPoints) {
982 break;
983 }
984 if (attrs.hasOwnProperty(property)) {
985 // Find out of this field is actually a series specific options list.
986 if (seriesNamesDictionary[property]) {
987 // This property value is a list of options for this series.
988 // If any of these sub properties are not pixel safe, set the flag.
5061b42f 989 for (var subProperty in attrs[property]) {
9ca829f2
DV
990 // Break early if we already know we need new points from a previous option.
991 if (requiresNewPoints) {
992 break;
993 }
994 if (attrs[property].hasOwnProperty(subProperty) && !pixelSafeOptions[subProperty]) {
995 requiresNewPoints = true;
996 }
997 }
998 // If this was not a series specific option list, check if its a pixel changing property.
999 } else if (!pixelSafeOptions[property]) {
1000 requiresNewPoints = true;
ccd9d7c2 1001 }
9ca829f2
DV
1002 }
1003 }
1004
1005 return requiresNewPoints;
1006};
78e58af4 1007
78e58af4
RK
1008Dygraph.Circles = {
1009 DEFAULT : function(g, name, ctx, canvasx, canvasy, color, radius) {
1010 ctx.beginPath();
1011 ctx.fillStyle = color;
1012 ctx.arc(canvasx, canvasy, radius, 0, 2 * Math.PI, false);
1013 ctx.fill();
78e58af4 1014 }
b7a1dc22 1015 // For more shapes, include extras/shapes.js
78e58af4 1016};
2bad4d92
DV
1017
1018/**
1019 * To create a "drag" interaction, you typically register a mousedown event
1020 * handler on the element where the drag begins. In that handler, you register a
1021 * mouseup handler on the window to determine when the mouse is released,
1022 * wherever that release happens. This works well, except when the user releases
1023 * the mouse over an off-domain iframe. In that case, the mouseup event is
1024 * handled by the iframe and never bubbles up to the window handler.
1025 *
1026 * To deal with this issue, we cover iframes with high z-index divs to make sure
1027 * they don't capture mouseup.
1028 *
1029 * Usage:
1030 * element.addEventListener('mousedown', function() {
1031 * var tarper = new Dygraph.IFrameTarp();
1032 * tarper.cover();
1033 * var mouseUpHandler = function() {
1034 * ...
1035 * window.removeEventListener(mouseUpHandler);
1036 * tarper.uncover();
1037 * };
1038 * window.addEventListener('mouseup', mouseUpHandler);
1039 * };
222d67c9 1040 *
2bad4d92
DV
1041 * @constructor
1042 */
1043Dygraph.IFrameTarp = function() {
f11283de 1044 /** @type {Array.<!HTMLDivElement>} */
2bad4d92
DV
1045 this.tarps = [];
1046};
1047
1048/**
1049 * Find all the iframes in the document and cover them with high z-index
1050 * transparent divs.
1051 */
1052Dygraph.IFrameTarp.prototype.cover = function() {
1053 var iframes = document.getElementsByTagName("iframe");
1054 for (var i = 0; i < iframes.length; i++) {
1055 var iframe = iframes[i];
1056 var x = Dygraph.findPosX(iframe),
1057 y = Dygraph.findPosY(iframe),
1058 width = iframe.offsetWidth,
1059 height = iframe.offsetHeight;
1060
1061 var div = document.createElement("div");
1062 div.style.position = "absolute";
1063 div.style.left = x + 'px';
1064 div.style.top = y + 'px';
1065 div.style.width = width + 'px';
1066 div.style.height = height + 'px';
1067 div.style.zIndex = 999;
1068 document.body.appendChild(div);
1069 this.tarps.push(div);
1070 }
1071};
1072
1073/**
1074 * Remove all the iframe covers. You should call this in a mouseup handler.
1075 */
1076Dygraph.IFrameTarp.prototype.uncover = function() {
1077 for (var i = 0; i < this.tarps.length; i++) {
1078 this.tarps[i].parentNode.removeChild(this.tarps[i]);
1079 }
1080 this.tarps = [];
1081};
e5763589
DV
1082
1083/**
df268bcc 1084 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
e5763589 1085 * @param {string} data
f11283de 1086 * @return {?string} the delimiter that was detected (or null on failure).
e5763589
DV
1087 */
1088Dygraph.detectLineDelimiter = function(data) {
1089 for (var i = 0; i < data.length; i++) {
df268bcc
JH
1090 var code = data.charAt(i);
1091 if (code === '\r') {
1092 // Might actually be "\r\n".
1093 if (((i + 1) < data.length) && (data.charAt(i + 1) === '\n')) {
1094 return '\r\n';
1095 }
1096 return code;
1097 }
1098 if (code === '\n') {
e5763589 1099 // Might actually be "\n\r".
df268bcc
JH
1100 if (((i + 1) < data.length) && (data.charAt(i + 1) === '\r')) {
1101 return '\n\r';
1102 }
e5763589
DV
1103 return code;
1104 }
1105 }
1106
1107 return null;
1108};
def24194
DV
1109
1110/**
bcb545f4
LB
1111 * Is one node contained by another?
1112 * @param {Node} containee The contained node.
1113 * @param {Node} container The container node.
def24194
DV
1114 * @return {boolean} Whether containee is inside (or equal to) container.
1115 * @private
1116 */
bcb545f4 1117Dygraph.isNodeContainedBy = function(containee, container) {
def24194
DV
1118 if (container === null || containee === null) {
1119 return false;
1120 }
db775859
RK
1121 var containeeNode = /** @type {Node} */ (containee);
1122 while (containeeNode && containeeNode !== container) {
1123 containeeNode = containeeNode.parentNode;
def24194 1124 }
db775859 1125 return (containeeNode === container);
def24194 1126};
2fd143d3
DV
1127
1128
1129// This masks some numeric issues in older versions of Firefox,
1130// where 1.0/Math.pow(10,2) != Math.pow(10,-2).
1131/** @type {function(number,number):number} */
1132Dygraph.pow = function(base, exp) {
1133 if (exp < 0) {
1134 return 1.0 / Math.pow(base, -exp);
1135 }
1136 return Math.pow(base, exp);
1137};
1138
9a4fd029
DV
1139// For Dygraph.setDateSameTZ, below.
1140Dygraph.dateSetters = {
1141 ms: Date.prototype.setMilliseconds,
1142 s: Date.prototype.setSeconds,
1143 m: Date.prototype.setMinutes,
1144 h: Date.prototype.setHours
1145};
1146
1147/**
1148 * This is like calling d.setSeconds(), d.setMinutes(), etc, except that it
1149 * adjusts for time zone changes to keep the date/time parts consistent.
1150 *
1151 * For example, d.getSeconds(), d.getMinutes() and d.getHours() will all be
1152 * the same before/after you call setDateSameTZ(d, {ms: 0}). The same is not
1153 * true if you call d.setMilliseconds(0).
1154 *
1155 * @type {function(!Date, Object.<number>)}
1156 */
1157Dygraph.setDateSameTZ = function(d, parts) {
1158 var tz = d.getTimezoneOffset();
1159 for (var k in parts) {
1160 if (!parts.hasOwnProperty(k)) continue;
1161 var setter = Dygraph.dateSetters[k];
1162 if (!setter) throw "Invalid setter: " + k;
1163 setter.call(d, parts[k]);
1164 if (d.getTimezoneOffset() != tz) {
1165 d.setTime(d.getTime() + (tz - d.getTimezoneOffset()) * 60 * 1000);
1166 }
1167 }
1168};
464b5f50
DV
1169
1170/**
1171 * Converts any valid CSS color (hex, rgb(), named color) to an RGB tuple.
1172 *
b7a1dc22 1173 * @param {!string} colorStr Any valid CSS color string.
464b5f50
DV
1174 * @return {{r:number,g:number,b:number}} Parsed RGB tuple.
1175 * @private
1176 */
b7a1dc22 1177Dygraph.toRGB_ = function(colorStr) {
464b5f50
DV
1178 // TODO(danvk): cache color parses to avoid repeated DOM manipulation.
1179 var div = document.createElement('div');
b7a1dc22 1180 div.style.backgroundColor = colorStr;
464b5f50
DV
1181 div.style.visibility = 'hidden';
1182 document.body.appendChild(div);
b7a1dc22 1183 var rgbStr = window.getComputedStyle(div).backgroundColor;
464b5f50 1184 document.body.removeChild(div);
b7a1dc22 1185 var bits = /^rgb\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)$/.exec(rgbStr);
464b5f50
DV
1186 return {
1187 r: parseInt(bits[1], 10),
1188 g: parseInt(bits[2], 10),
1189 b: parseInt(bits[3], 10)
1190 };
1191};