3 * Copyright 2011 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
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.
14 /*jshint globalstrict: true */
15 /*global Dygraph:false, G_vmlCanvasManager:false, Node:false, printStackTrace: false */
18 Dygraph
.LOG_SCALE
= 10;
19 Dygraph
.LN_TEN
= Math
.log(Dygraph
.LOG_SCALE
);
26 Dygraph
.log10
= function(x
) {
27 return Math
.log(x
) / Dygraph
.LN_TEN
;
30 // Various logging levels.
36 // Set this to log stack traces on warnings, etc.
37 // This requires stacktrace.js, which is up to you to provide.
38 // A copy can be found in the dygraphs repo, or at
39 // https://github.com/eriwen
/javascript
-stacktrace
40 Dygraph
.LOG_STACK_TRACES
= false;
42 /** A dotted line stroke pattern. */
43 Dygraph
.DOTTED_LINE
= [2, 2];
44 /** A dashed line stroke pattern. */
45 Dygraph
.DASHED_LINE
= [7, 3];
46 /** A dot dash stroke pattern. */
47 Dygraph
.DOT_DASH_LINE
= [7, 2, 2, 2];
50 * Log an error on the JS console at the given severity.
51 * @param {number} severity One of Dygraph.{DEBUG,INFO,WARNING,ERROR}
52 * @param {string} message The message to log.
55 Dygraph
.log
= function(severity
, message
) {
57 if (typeof(printStackTrace
) != 'undefined') {
59 // Remove uninteresting bits: logging functions and paths.
60 st
= printStackTrace({guess
:false});
61 while (st
[0].indexOf("stacktrace") != -1) {
66 for (var i
= 0; i
< st
.length
; i
++) {
67 st
[i
] = st
[i
].replace(/\([^)]*\/(.*)\)/, '@$1')
68 .replace(/\@.*\/([^\/]*)/, '@$1')
69 .replace('[object Object].', '');
71 var top_msg
= st
.splice(0, 1)[0];
72 message
+= ' (' + top_msg
.replace(/^.*@ ?/, '') + ')';
74 // Oh well, it was worth a shot!
78 if (typeof(window
.console
) != 'undefined') {
79 // In older versions of Firefox, only console.log is defined.
80 var console
= window
.console
;
81 var log
= function(console
, method
, msg
) {
82 if (method
&& typeof(method
) == 'function') {
83 method
.call(console
, msg
);
91 log(console
, console
.debug
, 'dygraphs: ' + message
);
94 log(console
, console
.info
, 'dygraphs: ' + message
);
97 log(console
, console
.warn
, 'dygraphs: ' + message
);
100 log(console
, console
.error
, 'dygraphs: ' + message
);
105 if (Dygraph
.LOG_STACK_TRACES
) {
106 window
.console
.log(st
.join('\n'));
111 * @param {string} message
114 Dygraph
.info
= function(message
) {
115 Dygraph
.log(Dygraph
.INFO
, message
);
118 * @param {string} message
121 Dygraph
.prototype.info
= Dygraph
.info
;
124 * @param {string} message
127 Dygraph
.warn
= function(message
) {
128 Dygraph
.log(Dygraph
.WARNING
, message
);
131 * @param {string} message
134 Dygraph
.prototype.warn
= Dygraph
.warn
;
137 * @param {string} message
140 Dygraph
.error
= function(message
) {
141 Dygraph
.log(Dygraph
.ERROR
, message
);
144 * @param {string} message
147 Dygraph
.prototype.error
= Dygraph
.error
;
150 * Return the 2d context for a dygraph canvas.
152 * This method is only exposed for the sake of replacing the function in
153 * automated tests, e.g.
155 * var oldFunc = Dygraph.getContext();
156 * Dygraph.getContext = function(canvas) {
157 * var realContext = oldFunc(canvas);
158 * return new Proxy(realContext);
160 * @param {!HTMLCanvasElement} canvas
161 * @return {!CanvasRenderingContext2D}
164 Dygraph
.getContext
= function(canvas
) {
165 return /** @type{!CanvasRenderingContext2D}*/(canvas
.getContext("2d"));
169 * Add an event handler. This smooths a difference between IE and the rest of
171 * @param { !Element } elem The element to add the event to.
172 * @param { string } type The type of the event, e.g. 'click' or 'mousemove'.
173 * @param { function(Event):(boolean|undefined) } fn The function to call
174 * on the event. The function takes one parameter: the event object.
177 Dygraph
.addEvent
= function addEvent(elem
, type
, fn
) {
178 if (elem
.addEventListener
) {
179 elem
.addEventListener(type
, fn
, false);
181 elem
[type
+fn
] = function(){fn(window
.event
);};
182 elem
.attachEvent('on'+type
, elem
[type
+fn
]);
187 * Add an event handler. This event handler is kept until the graph is
188 * destroyed with a call to graph.destroy().
190 * @param { !Element } elem The element to add the event to.
191 * @param { string } type The type of the event, e.g. 'click' or 'mousemove'.
192 * @param { function(Event):(boolean|undefined) } fn The function to call
193 * on the event. The function takes one parameter: the event object.
196 Dygraph
.prototype.addEvent
= function(elem
, type
, fn
) {
197 Dygraph
.addEvent(elem
, type
, fn
);
198 this.registeredEvents_
.push({ elem
: elem
, type
: type
, fn
: fn
});
202 * Remove an event handler. This smooths a difference between IE and the rest
204 * @param {!Element} elem The element to add the event to.
205 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
206 * @param {function(Event):(boolean|undefined)} fn The function to call
207 * on the event. The function takes one parameter: the event object.
210 Dygraph
.removeEvent
= function(elem
, type
, fn
) {
211 if (elem
.removeEventListener
) {
212 elem
.removeEventListener(type
, fn
, false);
215 elem
.detachEvent('on'+type
, elem
[type
+fn
]);
217 // We only detach event listeners on a "best effort" basis in IE. See:
218 // http://stackoverflow.com/questions
/2553632/detachevent-not
-working
-with-named
-inline
-functions
220 elem
[type
+fn
] = null;
225 * Cancels further processing of an event. This is useful to prevent default
226 * browser actions, e.g. highlighting text on a double-click.
227 * Based on the article at
228 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
229 * @param { !Event } e The event whose normal behavior should be canceled.
232 Dygraph
.cancelEvent
= function(e
) {
233 e
= e
? e
: window
.event
;
234 if (e
.stopPropagation
) {
237 if (e
.preventDefault
) {
240 e
.cancelBubble
= true;
242 e
.returnValue
= false;
247 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
248 * is used to generate default series colors which are evenly spaced on the
250 * @param { number } hue Range is 0.0-1.0.
251 * @param { number } saturation Range is 0.0-1.0.
252 * @param { number } value Range is 0.0-1.0.
253 * @return { string } "rgb(r,g,b)" where r, g and b range from 0-255.
256 Dygraph
.hsvToRGB
= function (hue
, saturation
, value
) {
260 if (saturation
=== 0) {
265 var i
= Math
.floor(hue
* 6);
266 var f
= (hue
* 6) - i
;
267 var p
= value
* (1 - saturation
);
268 var q
= value
* (1 - (saturation
* f
));
269 var t
= value
* (1 - (saturation
* (1 - f
)));
271 case 1: red
= q
; green
= value
; blue
= p
; break;
272 case 2: red
= p
; green
= value
; blue
= t
; break;
273 case 3: red
= p
; green
= q
; blue
= value
; break;
274 case 4: red
= t
; green
= p
; blue
= value
; break;
275 case 5: red
= value
; green
= p
; blue
= q
; break;
276 case 6: // fall through
277 case 0: red
= value
; green
= t
; blue
= p
; break;
280 red
= Math
.floor(255 * red
+ 0.5);
281 green
= Math
.floor(255 * green
+ 0.5);
282 blue
= Math
.floor(255 * blue
+ 0.5);
283 return 'rgb(' + red
+ ',' + green
+ ',' + blue
+ ')';
286 // The following functions are from quirksmode.org with a modification for Safari from
287 // http://blog.firetree.net/2005/07/04/javascript-find-position/
288 // http://www.quirksmode.org/js
/findpos
.html
289 // ... and modifications to support scrolling divs.
292 * Find the x-coordinate of the supplied object relative to the left side
294 * TODO(danvk): change obj type from Node -> !Node
299 Dygraph
.findPosX
= function(obj
) {
301 if(obj
.offsetParent
) {
304 // NOTE: the if statement here is for IE8.
305 var borderLeft
= "0";
306 if (window
.getComputedStyle
) {
307 borderLeft
= window
.getComputedStyle(copyObj
, null).borderLeft
|| "0";
309 curleft
+= parseInt(borderLeft
, 10) ;
310 curleft
+= copyObj
.offsetLeft
;
311 if(!copyObj
.offsetParent
) {
314 copyObj
= copyObj
.offsetParent
;
319 // This handles the case where the object is inside a scrolled div.
320 while(obj
&& obj
!= document
.body
) {
321 curleft
-= obj
.scrollLeft
;
322 obj
= obj
.parentNode
;
328 * Find the y-coordinate of the supplied object relative to the top of the
330 * TODO(danvk): change obj type from Node -> !Node
331 * TODO(danvk): consolidate with findPosX and return an {x, y} object.
336 Dygraph
.findPosY
= function(obj
) {
338 if(obj
.offsetParent
) {
341 // NOTE: the if statement here is for IE8.
343 if (window
.getComputedStyle
) {
344 borderTop
= window
.getComputedStyle(copyObj
, null).borderTop
|| "0";
346 curtop
+= parseInt(borderTop
, 10) ;
347 curtop
+= copyObj
.offsetTop
;
348 if(!copyObj
.offsetParent
) {
351 copyObj
= copyObj
.offsetParent
;
356 // This handles the case where the object is inside a scrolled div.
357 while(obj
&& obj
!= document
.body
) {
358 curtop
-= obj
.scrollTop
;
359 obj
= obj
.parentNode
;
365 * Returns the x-coordinate of the event in a coordinate system where the
366 * top-left corner of the page (not the window) is (0,0).
367 * Taken from MochiKit.Signal
372 Dygraph
.pageX
= function(e
) {
374 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
376 var de
= document
.documentElement
;
377 var b
= document
.body
;
379 (de
.scrollLeft
|| b
.scrollLeft
) -
380 (de
.clientLeft
|| 0);
385 * Returns the y-coordinate of the event in a coordinate system where the
386 * top-left corner of the page (not the window) is (0,0).
387 * Taken from MochiKit.Signal
392 Dygraph
.pageY
= function(e
) {
394 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
396 var de
= document
.documentElement
;
397 var b
= document
.body
;
399 (de
.scrollTop
|| b
.scrollTop
) -
405 * This returns true unless the parameter is 0, null, undefined or NaN.
406 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
408 * @param {number} x The number to consider.
409 * @return {boolean} Whether the number is zero or NaN.
412 Dygraph
.isOK
= function(x
) {
413 return !!x
&& !isNaN(x
);
417 * @param { {x:?number,y:?number,yval:?number} } p The point to consider, valid
418 * points are {x, y} objects
419 * @param { boolean } allowNaNY Treat point with y=NaN as valid
420 * @return { boolean } Whether the point has numeric x and y.
423 Dygraph
.isValidPoint
= function(p
, allowNaNY
) {
424 if (!p
) return false; // null or undefined object
425 if (p
.yval
=== null) return false; // missing point
426 if (p
.x
=== null || p
.x
=== undefined
) return false;
427 if (p
.y
=== null || p
.y
=== undefined
) return false;
428 if (isNaN(p
.x
) || (!allowNaNY
&& isNaN(p
.y
))) return false;
433 * Number formatting function which mimicks the behavior of %g in printf, i.e.
434 * either exponential or fixed format (without trailing 0s) is used depending on
435 * the length of the generated string. The advantage of this format is that
436 * there is a predictable upper bound on the resulting string length,
437 * significant figures are not dropped, and normal numbers are not displayed in
438 * exponential notation.
440 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
441 * It creates strings which are too long for absolute values between 10^-4 and
442 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
445 * @param {number} x The number to format
446 * @param {number=} opt_precision The precision to use, default 2.
447 * @return {string} A string formatted like %g in printf. The max generated
448 * string length should be precision + 6 (e.g 1.123e+300).
450 Dygraph
.floatFormat
= function(x
, opt_precision
) {
451 // Avoid invalid precision values; [1, 21] is the valid range.
452 var p
= Math
.min(Math
.max(1, opt_precision
|| 2), 21);
454 // This is deceptively simple. The actual algorithm comes from:
456 // Max allowed length = p + 4
457 // where 4 comes from 'e+n' and '.'.
459 // Length of fixed format = 2 + y + p
460 // where 2 comes from '0.' and y = # of leading zeroes.
462 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
465 // Since the behavior of toPrecision() is identical for larger numbers, we
466 // don't have to worry about the other bound.
468 // Finally, the argument for toExponential() is the number of trailing digits,
469 // so we take off 1 for the value before the '.'.
470 return (Math
.abs(x
) < 1.0e-3 && x
!== 0.0) ?
471 x
.toExponential(p
- 1) : x
.toPrecision(p
);
475 * Converts '9' to '09' (useful for dates)
480 Dygraph
.zeropad
= function(x
) {
481 if (x
< 10) return "0" + x
; else return "" + x
;
485 * Return a string version of the hours, minutes and seconds portion of a date.
487 * @param {number} date The JavaScript date (ms since epoch)
488 * @return {string} A time of the form "HH:MM:SS"
491 Dygraph
.hmsString_
= function(date
) {
492 var zeropad
= Dygraph
.zeropad
;
493 var d
= new Date(date
);
494 if (d
.getSeconds()) {
495 return zeropad(d
.getHours()) + ":" +
496 zeropad(d
.getMinutes()) + ":" +
497 zeropad(d
.getSeconds());
499 return zeropad(d
.getHours()) + ":" + zeropad(d
.getMinutes());
504 * Round a number to the specified number of digits past the decimal point.
505 * @param {number} num The number to round
506 * @param {number} places The number of decimals to which to round
507 * @return {number} The rounded number
510 Dygraph
.round_
= function(num
, places
) {
511 var shift
= Math
.pow(10, places
);
512 return Math
.round(num
* shift
)/shift
;
516 * Implementation of binary search over an array.
517 * Currently does not work when val is outside the range of arry's values.
518 * @param {number} val the value to search for
519 * @param {Array.<number>} arry is the value over which to search
520 * @param {number} abs If abs > 0, find the lowest entry greater than val
521 * If abs < 0, find the highest entry less than val.
522 * If abs == 0, find the entry that equals val.
523 * @param {number=} low The first index in arry to consider (optional)
524 * @param {number=} high The last index in arry to consider (optional)
525 * @return {number} Index of the element, or -1 if it isn't found.
528 Dygraph
.binarySearch
= function(val
, arry
, abs
, low
, high
) {
529 if (low
=== null || low
=== undefined
||
530 high
=== null || high
=== undefined
) {
532 high
= arry
.length
- 1;
537 if (abs
=== null || abs
=== undefined
) {
540 var validIndex
= function(idx
) {
541 return idx
>= 0 && idx
< arry
.length
;
543 var mid
= parseInt((low
+ high
) / 2, 10);
544 var element
= arry
[mid
];
546 if (element
== val
) {
548 } else if (element
> val
) {
550 // Accept if element > val, but also if prior element < val.
552 if (validIndex(idx
) && arry
[idx
] < val
) {
556 return Dygraph
.binarySearch(val
, arry
, abs
, low
, mid
- 1);
557 } else if (element
< val
) {
559 // Accept if element < val, but also if prior element > val.
561 if (validIndex(idx
) && arry
[idx
] > val
) {
565 return Dygraph
.binarySearch(val
, arry
, abs
, mid
+ 1, high
);
567 return -1; // can't actually happen, but makes closure compiler happy
571 * Parses a date, returning the number of milliseconds since epoch. This can be
572 * passed in as an xValueParser in the Dygraph constructor.
573 * TODO(danvk): enumerate formats that this understands.
575 * @param {string} dateStr A date in a variety of possible string formats.
576 * @return {number} Milliseconds since epoch.
579 Dygraph
.dateParser
= function(dateStr
) {
583 // Let the system try the format first, with one caveat:
584 // YYYY-MM-DD[ HH:MM:SS] is interpreted as UTC by a variety of browsers.
585 // dygraphs displays dates in local time, so this will result in surprising
586 // inconsistencies. But if you specify "T" or "Z" (i.e. YYYY-MM-DDTHH:MM:SS),
587 // then you probably know what you're doing, so we'll let you go ahead.
588 // Issue: http://code.google.com/p/dygraphs/issues/detail
?id
=255
589 if (dateStr
.search("-") == -1 ||
590 dateStr
.search("T") != -1 || dateStr
.search("Z") != -1) {
591 d
= Dygraph
.dateStrToMillis(dateStr
);
592 if (d
&& !isNaN(d
)) return d
;
595 if (dateStr
.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
596 dateStrSlashed
= dateStr
.replace("-", "/", "g");
597 while (dateStrSlashed
.search("-") != -1) {
598 dateStrSlashed
= dateStrSlashed
.replace("-", "/");
600 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
601 } else if (dateStr
.length
== 8) { // e.g. '20090712'
602 // TODO(danvk): remove support for this format. It's confusing.
603 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
605 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
607 // Any format that Date.parse will accept, e.g. "2009/07/12" or
608 // "2009/07/12 12:34:56"
609 d
= Dygraph
.dateStrToMillis(dateStr
);
612 if (!d
|| isNaN(d
)) {
613 Dygraph
.error("Couldn't parse " + dateStr
+ " as a date");
619 * This is identical to JavaScript's built-in Date.parse() method, except that
620 * it doesn't get replaced with an incompatible method by aggressive JS
621 * libraries like MooTools or Joomla.
622 * @param {string} str The date string, e.g. "2011/05/06"
623 * @return {number} millis since epoch
626 Dygraph
.dateStrToMillis
= function(str
) {
627 return new Date(str
).getTime();
630 // These functions are all based on MochiKit.
632 * Copies all the properties from o to self.
634 * @param {!Object} self
639 Dygraph
.update
= function(self
, o
) {
640 if (typeof(o
) != 'undefined' && o
!== null) {
642 if (o
.hasOwnProperty(k
)) {
651 * Copies all the properties from o to self.
653 * @param {!Object} self
658 Dygraph
.updateDeep
= function (self
, o
) {
659 // Taken from http://stackoverflow.com/questions
/384286/javascript
-isdom
-how
-do-you
-check
-if-a
-javascript
-object
-is
-a
-dom
-object
662 typeof Node
=== "object" ? o
instanceof Node
:
663 typeof o
=== "object" && typeof o
.nodeType
=== "number" && typeof o
.nodeName
==="string"
667 if (typeof(o
) != 'undefined' && o
!== null) {
669 if (o
.hasOwnProperty(k
)) {
672 } else if (Dygraph
.isArrayLike(o
[k
])) {
673 self
[k
] = o
[k
].slice();
674 } else if (isNode(o
[k
])) {
675 // DOM objects are shallowly-copied.
677 } else if (typeof(o
[k
]) == 'object') {
678 if (typeof(self
[k
]) != 'object' || self
[k
] === null) {
681 Dygraph
.updateDeep(self
[k
], o
[k
]);
696 Dygraph
.isArrayLike
= function(o
) {
699 (typ
!= 'object' && !(typ
== 'function' &&
700 typeof(o
.item
) == 'function')) ||
702 typeof(o
.length
) != 'number' ||
715 Dygraph
.isDateLike
= function (o
) {
716 if (typeof(o
) != "object" || o
=== null ||
717 typeof(o
.getTime
) != 'function') {
724 * Note: this only seems to work for arrays.
729 Dygraph
.clone
= function(o
) {
730 // TODO(danvk): figure out how MochiKit's version works
732 for (var i
= 0; i
< o
.length
; i
++) {
733 if (Dygraph
.isArrayLike(o
[i
])) {
734 r
.push(Dygraph
.clone(o
[i
]));
743 * Create a new canvas element. This is more complex than a simple
744 * document.createElement("canvas") because of IE and excanvas.
746 * @return {!HTMLCanvasElement}
749 Dygraph
.createCanvas
= function() {
750 var canvas
= document
.createElement("canvas");
752 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
753 if (isIE
&& (typeof(G_vmlCanvasManager
) != 'undefined')) {
754 canvas
= G_vmlCanvasManager
.initElement(
755 /**@type{!HTMLCanvasElement}*/(canvas
));
762 * Checks whether the user is on an Android browser.
763 * Android does not fully support the <canvas> tag, e.g. w/r/t/ clipping.
767 Dygraph
.isAndroid
= function() {
768 return (/Android/).test(navigator
.userAgent
);
773 * TODO(danvk): use @template here when it's better supported for classes.
774 * @param {!Array} array
775 * @param {number} start
776 * @param {number} length
777 * @param {function(!Array,?):boolean=} predicate
780 Dygraph
.Iterator
= function(array
, start
, length
, predicate
) {
782 length
= length
|| array
.length
;
783 this.hasNext
= true; // Use to identify if there's another element.
784 this.peek
= null; // Use for look-ahead
787 this.predicate_
= predicate
;
788 this.end_
= Math
.min(array
.length
, start
+ length
);
789 this.nextIdx_
= start
- 1; // use -1 so initial advance works.
790 this.next(); // ignoring result.
796 Dygraph
.Iterator
.prototype.next
= function() {
802 var nextIdx
= this.nextIdx_
+ 1;
804 while (nextIdx
< this.end_
) {
805 if (!this.predicate_
|| this.predicate_(this.array_
, nextIdx
)) {
806 this.peek
= this.array_
[nextIdx
];
812 this.nextIdx_
= nextIdx
;
814 this.hasNext
= false;
821 * Returns a new iterator over array, between indexes start and
822 * start + length, and only returns entries that pass the accept function
824 * @param {!Array} array the array to iterate over.
825 * @param {number} start the first index to iterate over, 0 if absent.
826 * @param {number} length the number of elements in the array to iterate over.
827 * This, along with start, defines a slice of the array, and so length
828 * doesn't imply the number of elements in the iterator when accept doesn't
829 * always accept all values. array.length when absent.
830 * @param {function(?):boolean=} opt_predicate a function that takes
831 * parameters array and idx, which returns true when the element should be
832 * returned. If omitted, all elements are accepted.
835 Dygraph
.createIterator
= function(array
, start
, length
, opt_predicate
) {
836 return new Dygraph
.Iterator(array
, start
, length
, opt_predicate
);
839 // Shim layer with setTimeout fallback.
840 // From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
841 // Should be called with the window context:
842 // Dygraph.requestAnimFrame.call(window, function() {})
843 Dygraph
.requestAnimFrame
= (function() {
844 return window
.requestAnimationFrame
||
845 window
.webkitRequestAnimationFrame
||
846 window
.mozRequestAnimationFrame
||
847 window
.oRequestAnimationFrame
||
848 window
.msRequestAnimationFrame
||
849 function (callback
) {
850 window
.setTimeout(callback
, 1000 / 60);
855 * Call a function at most maxFrames times at an attempted interval of
856 * framePeriodInMillis, then call a cleanup function once. repeatFn is called
857 * once immediately, then at most (maxFrames - 1) times asynchronously. If
858 * maxFrames==1, then cleanup_fn() is also called synchronously. This function
859 * is used to sequence animation.
860 * @param {function(number)} repeatFn Called repeatedly -- takes the frame
861 * number (from 0 to maxFrames-1) as an argument.
862 * @param {number} maxFrames The max number of times to call repeatFn
863 * @param {number} framePeriodInMillis Max requested time between frames.
864 * @param {function()} cleanupFn A function to call after all repeatFn calls.
867 Dygraph
.repeatAndCleanup
= function(repeatFn
, maxFrames
, framePeriodInMillis
,
870 var previousFrameNumber
;
871 var startTime
= new Date().getTime();
872 repeatFn(frameNumber
);
873 if (maxFrames
== 1) {
877 var maxFrameArg
= maxFrames
- 1;
880 if (frameNumber
>= maxFrames
) return;
881 Dygraph
.requestAnimFrame
.call(window
, function() {
882 // Determine which frame to draw based on the delay so far. Will skip
883 // frames if necessary.
884 var currentTime
= new Date().getTime();
885 var delayInMillis
= currentTime
- startTime
;
886 previousFrameNumber
= frameNumber
;
887 frameNumber
= Math
.floor(delayInMillis
/ framePeriodInMillis
);
888 var frameDelta
= frameNumber
- previousFrameNumber
;
889 // If we predict that the subsequent repeatFn call will overshoot our
890 // total frame target, so our last call will cause a stutter, then jump to
891 // the last call immediately. If we're going to cause a stutter, better
892 // to do it faster than slower.
893 var predictOvershootStutter
= (frameNumber
+ frameDelta
) > maxFrameArg
;
894 if (predictOvershootStutter
|| (frameNumber
>= maxFrameArg
)) {
895 repeatFn(maxFrameArg
); // Ensure final call with maxFrameArg.
898 if (frameDelta
!== 0) { // Don't call repeatFn with duplicate frames.
899 repeatFn(frameNumber
);
908 * This function will scan the option list and determine if they
909 * require us to recalculate the pixel positions of each point.
910 * @param {!Array.<string>} labels a list of options to check.
911 * @param {!Object} attrs
912 * @return {boolean} true if the graph needs new points else false.
915 Dygraph
.isPixelChangingOptionList
= function(labels
, attrs
) {
916 // A whitelist of options that do not change pixel positions.
917 var pixelSafeOptions
= {
918 'annotationClickHandler': true,
919 'annotationDblClickHandler': true,
920 'annotationMouseOutHandler': true,
921 'annotationMouseOverHandler': true,
922 'axisLabelColor': true,
923 'axisLineColor': true,
924 'axisLineWidth': true,
925 'clickCallback': true,
926 'digitsAfterDecimal': true,
927 'drawCallback': true,
928 'drawHighlightPointCallback': true,
930 'drawPointCallback': true,
934 'gridLineColor': true,
935 'gridLineWidth': true,
936 'hideOverlayOnMouseOut': true,
937 'highlightCallback': true,
938 'highlightCircleSize': true,
939 'interactionModel': true,
940 'isZoomedIgnoreProgrammaticZoom': true,
942 'labelsDivStyles': true,
943 'labelsDivWidth': true,
946 'labelsSeparateLines': true,
947 'labelsShowZeroValues': true,
949 'maxNumberWidth': true,
950 'panEdgeFraction': true,
951 'pixelsPerYLabel': true,
952 'pointClickCallback': true,
954 'rangeSelectorPlotFillColor': true,
955 'rangeSelectorPlotStrokeColor': true,
956 'showLabelsOnHighlight': true,
960 'underlayCallback': true,
961 'unhighlightCallback': true,
962 'xAxisLabelFormatter': true,
964 'xValueFormatter': true,
965 'yAxisLabelFormatter': true,
966 'yValueFormatter': true,
970 // Assume that we do not require new points.
971 // This will change to true if we actually do need new points.
972 var requiresNewPoints
= false;
974 // Create a dictionary of series names for faster lookup.
975 // If there are no labels, then the dictionary stays empty.
976 var seriesNamesDictionary
= { };
978 for (var i
= 1; i
< labels
.length
; i
++) {
979 seriesNamesDictionary
[labels
[i
]] = true;
983 // Iterate through the list of updated options.
984 for (var property
in attrs
) {
985 // Break early if we already know we need new points from a previous option.
986 if (requiresNewPoints
) {
989 if (attrs
.hasOwnProperty(property
)) {
990 // Find out of this field is actually a series specific options list.
991 if (seriesNamesDictionary
[property
]) {
992 // This property value is a list of options for this series.
993 // If any of these sub properties are not pixel safe, set the flag.
994 for (var subProperty
in attrs
[property
]) {
995 // Break early if we already know we need new points from a previous option.
996 if (requiresNewPoints
) {
999 if (attrs
[property
].hasOwnProperty(subProperty
) && !pixelSafeOptions
[subProperty
]) {
1000 requiresNewPoints
= true;
1003 // If this was not a series specific option list, check if its a pixel changing property.
1004 } else if (!pixelSafeOptions
[property
]) {
1005 requiresNewPoints
= true;
1010 return requiresNewPoints
;
1014 * Compares two arrays to see if they are equal. If either parameter is not an
1015 * array it will return false. Does a shallow compare
1016 * Dygraph.compareArrays([[1,2], [3, 4]], [[1,2], [3,4]]) === false.
1017 * @param {!Array.<T>} array1 first array
1018 * @param {!Array.<T>} array2 second array
1019 * @return {boolean} True if both parameters are arrays, and contents are equal.
1022 Dygraph
.compareArrays
= function(array1
, array2
) {
1023 if (!Dygraph
.isArrayLike(array1
) || !Dygraph
.isArrayLike(array2
)) {
1026 if (array1
.length
!== array2
.length
) {
1029 for (var i
= 0; i
< array1
.length
; i
++) {
1030 if (array1
[i
] !== array2
[i
]) {
1038 * @param {!CanvasRenderingContext2D} ctx the canvas context
1039 * @param {number} sides the number of sides in the shape.
1040 * @param {number} radius the radius of the image.
1041 * @param {number} cx center x coordate
1042 * @param {number} cy center y coordinate
1043 * @param {number=} rotationRadians the shift of the initial angle, in radians.
1044 * @param {number=} delta the angle shift for each line. If missing, creates a
1048 Dygraph
.regularShape_
= function(
1049 ctx
, sides
, radius
, cx
, cy
, rotationRadians
, delta
) {
1050 rotationRadians
= rotationRadians
|| 0;
1051 delta
= delta
|| Math
.PI
* 2 / sides
;
1054 var initialAngle
= rotationRadians
;
1055 var angle
= initialAngle
;
1057 var computeCoordinates
= function() {
1058 var x
= cx
+ (Math
.sin(angle
) * radius
);
1059 var y
= cy
+ (-Math
.cos(angle
) * radius
);
1063 var initialCoordinates
= computeCoordinates();
1064 var x
= initialCoordinates
[0];
1065 var y
= initialCoordinates
[1];
1068 for (var idx
= 0; idx
< sides
; idx
++) {
1069 angle
= (idx
== sides
- 1) ? initialAngle
: (angle
+ delta
);
1070 var coords
= computeCoordinates();
1071 ctx
.lineTo(coords
[0], coords
[1]);
1078 * TODO(danvk): be more specific on the return type.
1079 * @param {number} sides
1080 * @param {number=} rotationRadians
1081 * @param {number=} delta
1082 * @return {Function}
1085 Dygraph
.shapeFunction_
= function(sides
, rotationRadians
, delta
) {
1086 return function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1087 ctx
.strokeStyle
= color
;
1088 ctx
.fillStyle
= "white";
1089 Dygraph
.regularShape_(ctx
, sides
, radius
, cx
, cy
, rotationRadians
, delta
);
1094 DEFAULT
: function(g
, name
, ctx
, canvasx
, canvasy
, color
, radius
) {
1096 ctx
.fillStyle
= color
;
1097 ctx
.arc(canvasx
, canvasy
, radius
, 0, 2 * Math
.PI
, false);
1100 TRIANGLE
: Dygraph
.shapeFunction_(3),
1101 SQUARE
: Dygraph
.shapeFunction_(4, Math
.PI
/ 4),
1102 DIAMOND
: Dygraph
.shapeFunction_(4),
1103 PENTAGON
: Dygraph
.shapeFunction_(5),
1104 HEXAGON
: Dygraph
.shapeFunction_(6),
1105 CIRCLE
: function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1107 ctx
.strokeStyle
= color
;
1108 ctx
.fillStyle
= "white";
1109 ctx
.arc(cx
, cy
, radius
, 0, 2 * Math
.PI
, false);
1113 STAR
: Dygraph
.shapeFunction_(5, 0, 4 * Math
.PI
/ 5),
1114 PLUS
: function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1115 ctx
.strokeStyle
= color
;
1118 ctx
.moveTo(cx
+ radius
, cy
);
1119 ctx
.lineTo(cx
- radius
, cy
);
1124 ctx
.moveTo(cx
, cy
+ radius
);
1125 ctx
.lineTo(cx
, cy
- radius
);
1129 EX
: function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1130 ctx
.strokeStyle
= color
;
1133 ctx
.moveTo(cx
+ radius
, cy
+ radius
);
1134 ctx
.lineTo(cx
- radius
, cy
- radius
);
1139 ctx
.moveTo(cx
+ radius
, cy
- radius
);
1140 ctx
.lineTo(cx
- radius
, cy
+ radius
);
1147 * To create a "drag" interaction, you typically register a mousedown event
1148 * handler on the element where the drag begins. In that handler, you register a
1149 * mouseup handler on the window to determine when the mouse is released,
1150 * wherever that release happens. This works well, except when the user releases
1151 * the mouse over an off-domain iframe. In that case, the mouseup event is
1152 * handled by the iframe and never bubbles up to the window handler.
1154 * To deal with this issue, we cover iframes with high z-index divs to make sure
1155 * they don't capture mouseup.
1158 * element.addEventListener('mousedown', function() {
1159 * var tarper = new Dygraph.IFrameTarp();
1161 * var mouseUpHandler = function() {
1163 * window.removeEventListener(mouseUpHandler);
1166 * window.addEventListener('mouseup', mouseUpHandler);
1171 Dygraph
.IFrameTarp
= function() {
1172 /** @type {Array.<!HTMLDivElement>} */
1177 * Find all the iframes in the document and cover them with high z-index
1180 Dygraph
.IFrameTarp
.prototype.cover
= function() {
1181 var iframes
= document
.getElementsByTagName("iframe");
1182 for (var i
= 0; i
< iframes
.length
; i
++) {
1183 var iframe
= iframes
[i
];
1184 var x
= Dygraph
.findPosX(iframe
),
1185 y
= Dygraph
.findPosY(iframe
),
1186 width
= iframe
.offsetWidth
,
1187 height
= iframe
.offsetHeight
;
1189 var div
= document
.createElement("div");
1190 div
.style
.position
= "absolute";
1191 div
.style
.left
= x
+ 'px';
1192 div
.style
.top
= y
+ 'px';
1193 div
.style
.width
= width
+ 'px';
1194 div
.style
.height
= height
+ 'px';
1195 div
.style
.zIndex
= 999;
1196 document
.body
.appendChild(div
);
1197 this.tarps
.push(div
);
1202 * Remove all the iframe covers. You should call this in a mouseup handler.
1204 Dygraph
.IFrameTarp
.prototype.uncover
= function() {
1205 for (var i
= 0; i
< this.tarps
.length
; i
++) {
1206 this.tarps
[i
].parentNode
.removeChild(this.tarps
[i
]);
1212 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
1213 * @param {string} data
1214 * @return {?string} the delimiter that was detected (or null on failure).
1216 Dygraph
.detectLineDelimiter
= function(data
) {
1217 for (var i
= 0; i
< data
.length
; i
++) {
1218 var code
= data
.charAt(i
);
1219 if (code
=== '\r') {
1220 // Might actually be "\r\n".
1221 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\n')) {
1226 if (code
=== '\n') {
1227 // Might actually be "\n\r".
1228 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\r')) {
1239 * Is one element contained by another?
1240 * @param {Element} containee The contained element.
1241 * @param {Element} container The container element.
1242 * @return {boolean} Whether containee is inside (or equal to) container.
1245 Dygraph
.isElementContainedBy
= function(containee
, container
) {
1246 if (container
=== null || containee
=== null) {
1249 while (containee
&& containee
!== container
) {
1250 containee
= containee
.parentNode
;
1252 return (containee
=== container
);
1256 // This masks some numeric issues in older versions of Firefox,
1257 // where 1.0/Math
.pow(10,2) != Math
.pow(10,-2).
1258 /** @type {function(number,number):number} */
1259 Dygraph
.pow
= function(base
, exp
) {
1261 return 1.0 / Math
.pow(base
, -exp
);
1263 return Math
.pow(base
, exp
);
1266 // For Dygraph.setDateSameTZ, below.
1267 Dygraph
.dateSetters
= {
1268 ms
: Date
.prototype.setMilliseconds
,
1269 s
: Date
.prototype.setSeconds
,
1270 m
: Date
.prototype.setMinutes
,
1271 h
: Date
.prototype.setHours
1275 * This is like calling d.setSeconds(), d.setMinutes(), etc, except that it
1276 * adjusts for time zone changes to keep the date/time parts consistent.
1278 * For example, d.getSeconds(), d.getMinutes() and d.getHours() will all be
1279 * the same before/after you call setDateSameTZ(d, {ms: 0}). The same is not
1280 * true if you call d.setMilliseconds(0).
1282 * @type {function(!Date, Object.<number>)}
1284 Dygraph
.setDateSameTZ
= function(d
, parts
) {
1285 var tz
= d
.getTimezoneOffset();
1286 for (var k
in parts
) {
1287 if (!parts
.hasOwnProperty(k
)) continue;
1288 var setter
= Dygraph
.dateSetters
[k
];
1289 if (!setter
) throw "Invalid setter: " + k
;
1290 setter
.call(d
, parts
[k
]);
1291 if (d
.getTimezoneOffset() != tz
) {
1292 d
.setTime(d
.getTime() + (tz
- d
.getTimezoneOffset()) * 60 * 1000);