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.addAndTrackEvent
= 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;
224 Dygraph
.prototype.removeTrackedEvents_
= function() {
225 if (this.registeredEvents_
) {
226 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
227 var reg
= this.registeredEvents_
[idx
];
228 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
232 this.registeredEvents_
= [];
236 * Cancels further processing of an event. This is useful to prevent default
237 * browser actions, e.g. highlighting text on a double-click.
238 * Based on the article at
239 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
240 * @param { !Event } e The event whose normal behavior should be canceled.
243 Dygraph
.cancelEvent
= function(e
) {
244 e
= e
? e
: window
.event
;
245 if (e
.stopPropagation
) {
248 if (e
.preventDefault
) {
251 e
.cancelBubble
= true;
253 e
.returnValue
= false;
258 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
259 * is used to generate default series colors which are evenly spaced on the
261 * @param { number } hue Range is 0.0-1.0.
262 * @param { number } saturation Range is 0.0-1.0.
263 * @param { number } value Range is 0.0-1.0.
264 * @return { string } "rgb(r,g,b)" where r, g and b range from 0-255.
267 Dygraph
.hsvToRGB
= function (hue
, saturation
, value
) {
271 if (saturation
=== 0) {
276 var i
= Math
.floor(hue
* 6);
277 var f
= (hue
* 6) - i
;
278 var p
= value
* (1 - saturation
);
279 var q
= value
* (1 - (saturation
* f
));
280 var t
= value
* (1 - (saturation
* (1 - f
)));
282 case 1: red
= q
; green
= value
; blue
= p
; break;
283 case 2: red
= p
; green
= value
; blue
= t
; break;
284 case 3: red
= p
; green
= q
; blue
= value
; break;
285 case 4: red
= t
; green
= p
; blue
= value
; break;
286 case 5: red
= value
; green
= p
; blue
= q
; break;
287 case 6: // fall through
288 case 0: red
= value
; green
= t
; blue
= p
; break;
291 red
= Math
.floor(255 * red
+ 0.5);
292 green
= Math
.floor(255 * green
+ 0.5);
293 blue
= Math
.floor(255 * blue
+ 0.5);
294 return 'rgb(' + red
+ ',' + green
+ ',' + blue
+ ')';
297 // The following functions are from quirksmode.org with a modification for Safari from
298 // http://blog.firetree.net/2005/07/04/javascript-find-position/
299 // http://www.quirksmode.org/js
/findpos
.html
300 // ... and modifications to support scrolling divs.
303 * Find the x-coordinate of the supplied object relative to the left side
305 * TODO(danvk): change obj type from Node -> !Node
310 Dygraph
.findPosX
= function(obj
) {
312 if(obj
.offsetParent
) {
315 // NOTE: the if statement here is for IE8.
316 var borderLeft
= "0";
317 if (window
.getComputedStyle
) {
318 borderLeft
= window
.getComputedStyle(copyObj
, null).borderLeft
|| "0";
320 curleft
+= parseInt(borderLeft
, 10) ;
321 curleft
+= copyObj
.offsetLeft
;
322 if(!copyObj
.offsetParent
) {
325 copyObj
= copyObj
.offsetParent
;
330 // This handles the case where the object is inside a scrolled div.
331 while(obj
&& obj
!= document
.body
) {
332 curleft
-= obj
.scrollLeft
;
333 obj
= obj
.parentNode
;
339 * Find the y-coordinate of the supplied object relative to the top of the
341 * TODO(danvk): change obj type from Node -> !Node
342 * TODO(danvk): consolidate with findPosX and return an {x, y} object.
347 Dygraph
.findPosY
= function(obj
) {
349 if(obj
.offsetParent
) {
352 // NOTE: the if statement here is for IE8.
354 if (window
.getComputedStyle
) {
355 borderTop
= window
.getComputedStyle(copyObj
, null).borderTop
|| "0";
357 curtop
+= parseInt(borderTop
, 10) ;
358 curtop
+= copyObj
.offsetTop
;
359 if(!copyObj
.offsetParent
) {
362 copyObj
= copyObj
.offsetParent
;
367 // This handles the case where the object is inside a scrolled div.
368 while(obj
&& obj
!= document
.body
) {
369 curtop
-= obj
.scrollTop
;
370 obj
= obj
.parentNode
;
376 * Returns the x-coordinate of the event in a coordinate system where the
377 * top-left corner of the page (not the window) is (0,0).
378 * Taken from MochiKit.Signal
383 Dygraph
.pageX
= function(e
) {
385 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
387 var de
= document
.documentElement
;
388 var b
= document
.body
;
390 (de
.scrollLeft
|| b
.scrollLeft
) -
391 (de
.clientLeft
|| 0);
396 * Returns the y-coordinate of the event in a coordinate system where the
397 * top-left corner of the page (not the window) is (0,0).
398 * Taken from MochiKit.Signal
403 Dygraph
.pageY
= function(e
) {
405 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
407 var de
= document
.documentElement
;
408 var b
= document
.body
;
410 (de
.scrollTop
|| b
.scrollTop
) -
416 * This returns true unless the parameter is 0, null, undefined or NaN.
417 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
419 * @param {number} x The number to consider.
420 * @return {boolean} Whether the number is zero or NaN.
423 Dygraph
.isOK
= function(x
) {
424 return !!x
&& !isNaN(x
);
428 * @param { {x:?number,y:?number,yval:?number} } p The point to consider, valid
429 * points are {x, y} objects
430 * @param { boolean } allowNaNY Treat point with y=NaN as valid
431 * @return { boolean } Whether the point has numeric x and y.
434 Dygraph
.isValidPoint
= function(p
, allowNaNY
) {
435 if (!p
) return false; // null or undefined object
436 if (p
.yval
=== null) return false; // missing point
437 if (p
.x
=== null || p
.x
=== undefined
) return false;
438 if (p
.y
=== null || p
.y
=== undefined
) return false;
439 if (isNaN(p
.x
) || (!allowNaNY
&& isNaN(p
.y
))) return false;
444 * Number formatting function which mimicks the behavior of %g in printf, i.e.
445 * either exponential or fixed format (without trailing 0s) is used depending on
446 * the length of the generated string. The advantage of this format is that
447 * there is a predictable upper bound on the resulting string length,
448 * significant figures are not dropped, and normal numbers are not displayed in
449 * exponential notation.
451 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
452 * It creates strings which are too long for absolute values between 10^-4 and
453 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
456 * @param {number} x The number to format
457 * @param {number=} opt_precision The precision to use, default 2.
458 * @return {string} A string formatted like %g in printf. The max generated
459 * string length should be precision + 6 (e.g 1.123e+300).
461 Dygraph
.floatFormat
= function(x
, opt_precision
) {
462 // Avoid invalid precision values; [1, 21] is the valid range.
463 var p
= Math
.min(Math
.max(1, opt_precision
|| 2), 21);
465 // This is deceptively simple. The actual algorithm comes from:
467 // Max allowed length = p + 4
468 // where 4 comes from 'e+n' and '.'.
470 // Length of fixed format = 2 + y + p
471 // where 2 comes from '0.' and y = # of leading zeroes.
473 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
476 // Since the behavior of toPrecision() is identical for larger numbers, we
477 // don't have to worry about the other bound.
479 // Finally, the argument for toExponential() is the number of trailing digits,
480 // so we take off 1 for the value before the '.'.
481 return (Math
.abs(x
) < 1.0e-3 && x
!== 0.0) ?
482 x
.toExponential(p
- 1) : x
.toPrecision(p
);
486 * Converts '9' to '09' (useful for dates)
491 Dygraph
.zeropad
= function(x
) {
492 if (x
< 10) return "0" + x
; else return "" + x
;
496 * Return a string version of the hours, minutes and seconds portion of a date.
498 * @param {number} date The JavaScript date (ms since epoch)
499 * @return {string} A time of the form "HH:MM:SS"
502 Dygraph
.hmsString_
= function(date
) {
503 var zeropad
= Dygraph
.zeropad
;
504 var d
= new Date(date
);
505 if (d
.getSeconds()) {
506 return zeropad(d
.getHours()) + ":" +
507 zeropad(d
.getMinutes()) + ":" +
508 zeropad(d
.getSeconds());
510 return zeropad(d
.getHours()) + ":" + zeropad(d
.getMinutes());
515 * Round a number to the specified number of digits past the decimal point.
516 * @param {number} num The number to round
517 * @param {number} places The number of decimals to which to round
518 * @return {number} The rounded number
521 Dygraph
.round_
= function(num
, places
) {
522 var shift
= Math
.pow(10, places
);
523 return Math
.round(num
* shift
)/shift
;
527 * Implementation of binary search over an array.
528 * Currently does not work when val is outside the range of arry's values.
529 * @param {number} val the value to search for
530 * @param {Array.<number>} arry is the value over which to search
531 * @param {number} abs If abs > 0, find the lowest entry greater than val
532 * If abs < 0, find the highest entry less than val.
533 * If abs == 0, find the entry that equals val.
534 * @param {number=} low The first index in arry to consider (optional)
535 * @param {number=} high The last index in arry to consider (optional)
536 * @return {number} Index of the element, or -1 if it isn't found.
539 Dygraph
.binarySearch
= function(val
, arry
, abs
, low
, high
) {
540 if (low
=== null || low
=== undefined
||
541 high
=== null || high
=== undefined
) {
543 high
= arry
.length
- 1;
548 if (abs
=== null || abs
=== undefined
) {
551 var validIndex
= function(idx
) {
552 return idx
>= 0 && idx
< arry
.length
;
554 var mid
= parseInt((low
+ high
) / 2, 10);
555 var element
= arry
[mid
];
557 if (element
== val
) {
559 } else if (element
> val
) {
561 // Accept if element > val, but also if prior element < val.
563 if (validIndex(idx
) && arry
[idx
] < val
) {
567 return Dygraph
.binarySearch(val
, arry
, abs
, low
, mid
- 1);
568 } else if (element
< val
) {
570 // Accept if element < val, but also if prior element > val.
572 if (validIndex(idx
) && arry
[idx
] > val
) {
576 return Dygraph
.binarySearch(val
, arry
, abs
, mid
+ 1, high
);
578 return -1; // can't actually happen, but makes closure compiler happy
582 * Parses a date, returning the number of milliseconds since epoch. This can be
583 * passed in as an xValueParser in the Dygraph constructor.
584 * TODO(danvk): enumerate formats that this understands.
586 * @param {string} dateStr A date in a variety of possible string formats.
587 * @return {number} Milliseconds since epoch.
590 Dygraph
.dateParser
= function(dateStr
) {
594 // Let the system try the format first, with one caveat:
595 // YYYY-MM-DD[ HH:MM:SS] is interpreted as UTC by a variety of browsers.
596 // dygraphs displays dates in local time, so this will result in surprising
597 // inconsistencies. But if you specify "T" or "Z" (i.e. YYYY-MM-DDTHH:MM:SS),
598 // then you probably know what you're doing, so we'll let you go ahead.
599 // Issue: http://code.google.com/p/dygraphs/issues/detail
?id
=255
600 if (dateStr
.search("-") == -1 ||
601 dateStr
.search("T") != -1 || dateStr
.search("Z") != -1) {
602 d
= Dygraph
.dateStrToMillis(dateStr
);
603 if (d
&& !isNaN(d
)) return d
;
606 if (dateStr
.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
607 dateStrSlashed
= dateStr
.replace("-", "/", "g");
608 while (dateStrSlashed
.search("-") != -1) {
609 dateStrSlashed
= dateStrSlashed
.replace("-", "/");
611 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
612 } else if (dateStr
.length
== 8) { // e.g. '20090712'
613 // TODO(danvk): remove support for this format. It's confusing.
614 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
616 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
618 // Any format that Date.parse will accept, e.g. "2009/07/12" or
619 // "2009/07/12 12:34:56"
620 d
= Dygraph
.dateStrToMillis(dateStr
);
623 if (!d
|| isNaN(d
)) {
624 Dygraph
.error("Couldn't parse " + dateStr
+ " as a date");
630 * This is identical to JavaScript's built-in Date.parse() method, except that
631 * it doesn't get replaced with an incompatible method by aggressive JS
632 * libraries like MooTools or Joomla.
633 * @param {string} str The date string, e.g. "2011/05/06"
634 * @return {number} millis since epoch
637 Dygraph
.dateStrToMillis
= function(str
) {
638 return new Date(str
).getTime();
641 // These functions are all based on MochiKit.
643 * Copies all the properties from o to self.
645 * @param {!Object} self
650 Dygraph
.update
= function(self
, o
) {
651 if (typeof(o
) != 'undefined' && o
!== null) {
653 if (o
.hasOwnProperty(k
)) {
662 * Copies all the properties from o to self.
664 * @param {!Object} self
669 Dygraph
.updateDeep
= function (self
, o
) {
670 // Taken from http://stackoverflow.com/questions
/384286/javascript
-isdom
-how
-do-you
-check
-if-a
-javascript
-object
-is
-a
-dom
-object
673 typeof Node
=== "object" ? o
instanceof Node
:
674 typeof o
=== "object" && typeof o
.nodeType
=== "number" && typeof o
.nodeName
==="string"
678 if (typeof(o
) != 'undefined' && o
!== null) {
680 if (o
.hasOwnProperty(k
)) {
683 } else if (Dygraph
.isArrayLike(o
[k
])) {
684 self
[k
] = o
[k
].slice();
685 } else if (isNode(o
[k
])) {
686 // DOM objects are shallowly-copied.
688 } else if (typeof(o
[k
]) == 'object') {
689 if (typeof(self
[k
]) != 'object' || self
[k
] === null) {
692 Dygraph
.updateDeep(self
[k
], o
[k
]);
707 Dygraph
.isArrayLike
= function(o
) {
710 (typ
!= 'object' && !(typ
== 'function' &&
711 typeof(o
.item
) == 'function')) ||
713 typeof(o
.length
) != 'number' ||
726 Dygraph
.isDateLike
= function (o
) {
727 if (typeof(o
) != "object" || o
=== null ||
728 typeof(o
.getTime
) != 'function') {
735 * Note: this only seems to work for arrays.
740 Dygraph
.clone
= function(o
) {
741 // TODO(danvk): figure out how MochiKit's version works
743 for (var i
= 0; i
< o
.length
; i
++) {
744 if (Dygraph
.isArrayLike(o
[i
])) {
745 r
.push(Dygraph
.clone(o
[i
]));
754 * Create a new canvas element. This is more complex than a simple
755 * document.createElement("canvas") because of IE and excanvas.
757 * @return {!HTMLCanvasElement}
760 Dygraph
.createCanvas
= function() {
761 var canvas
= document
.createElement("canvas");
763 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
764 if (isIE
&& (typeof(G_vmlCanvasManager
) != 'undefined')) {
765 canvas
= G_vmlCanvasManager
.initElement(
766 /**@type{!HTMLCanvasElement}*/(canvas
));
773 * Checks whether the user is on an Android browser.
774 * Android does not fully support the <canvas> tag, e.g. w/r/t/ clipping.
778 Dygraph
.isAndroid
= function() {
779 return (/Android/).test(navigator
.userAgent
);
784 * TODO(danvk): use @template here when it's better supported for classes.
785 * @param {!Array} array
786 * @param {number} start
787 * @param {number} length
788 * @param {function(!Array,?):boolean=} predicate
791 Dygraph
.Iterator
= function(array
, start
, length
, predicate
) {
793 length
= length
|| array
.length
;
794 this.hasNext
= true; // Use to identify if there's another element.
795 this.peek
= null; // Use for look-ahead
798 this.predicate_
= predicate
;
799 this.end_
= Math
.min(array
.length
, start
+ length
);
800 this.nextIdx_
= start
- 1; // use -1 so initial advance works.
801 this.next(); // ignoring result.
807 Dygraph
.Iterator
.prototype.next
= function() {
813 var nextIdx
= this.nextIdx_
+ 1;
815 while (nextIdx
< this.end_
) {
816 if (!this.predicate_
|| this.predicate_(this.array_
, nextIdx
)) {
817 this.peek
= this.array_
[nextIdx
];
823 this.nextIdx_
= nextIdx
;
825 this.hasNext
= false;
832 * Returns a new iterator over array, between indexes start and
833 * start + length, and only returns entries that pass the accept function
835 * @param {!Array} array the array to iterate over.
836 * @param {number} start the first index to iterate over, 0 if absent.
837 * @param {number} length the number of elements in the array to iterate over.
838 * This, along with start, defines a slice of the array, and so length
839 * doesn't imply the number of elements in the iterator when accept doesn't
840 * always accept all values. array.length when absent.
841 * @param {function(?):boolean=} opt_predicate a function that takes
842 * parameters array and idx, which returns true when the element should be
843 * returned. If omitted, all elements are accepted.
846 Dygraph
.createIterator
= function(array
, start
, length
, opt_predicate
) {
847 return new Dygraph
.Iterator(array
, start
, length
, opt_predicate
);
850 // Shim layer with setTimeout fallback.
851 // From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
852 // Should be called with the window context:
853 // Dygraph.requestAnimFrame.call(window, function() {})
854 Dygraph
.requestAnimFrame
= (function() {
855 return window
.requestAnimationFrame
||
856 window
.webkitRequestAnimationFrame
||
857 window
.mozRequestAnimationFrame
||
858 window
.oRequestAnimationFrame
||
859 window
.msRequestAnimationFrame
||
860 function (callback
) {
861 window
.setTimeout(callback
, 1000 / 60);
866 * Call a function at most maxFrames times at an attempted interval of
867 * framePeriodInMillis, then call a cleanup function once. repeatFn is called
868 * once immediately, then at most (maxFrames - 1) times asynchronously. If
869 * maxFrames==1, then cleanup_fn() is also called synchronously. This function
870 * is used to sequence animation.
871 * @param {function(number)} repeatFn Called repeatedly -- takes the frame
872 * number (from 0 to maxFrames-1) as an argument.
873 * @param {number} maxFrames The max number of times to call repeatFn
874 * @param {number} framePeriodInMillis Max requested time between frames.
875 * @param {function()} cleanupFn A function to call after all repeatFn calls.
878 Dygraph
.repeatAndCleanup
= function(repeatFn
, maxFrames
, framePeriodInMillis
,
881 var previousFrameNumber
;
882 var startTime
= new Date().getTime();
883 repeatFn(frameNumber
);
884 if (maxFrames
== 1) {
888 var maxFrameArg
= maxFrames
- 1;
891 if (frameNumber
>= maxFrames
) return;
892 Dygraph
.requestAnimFrame
.call(window
, function() {
893 // Determine which frame to draw based on the delay so far. Will skip
894 // frames if necessary.
895 var currentTime
= new Date().getTime();
896 var delayInMillis
= currentTime
- startTime
;
897 previousFrameNumber
= frameNumber
;
898 frameNumber
= Math
.floor(delayInMillis
/ framePeriodInMillis
);
899 var frameDelta
= frameNumber
- previousFrameNumber
;
900 // If we predict that the subsequent repeatFn call will overshoot our
901 // total frame target, so our last call will cause a stutter, then jump to
902 // the last call immediately. If we're going to cause a stutter, better
903 // to do it faster than slower.
904 var predictOvershootStutter
= (frameNumber
+ frameDelta
) > maxFrameArg
;
905 if (predictOvershootStutter
|| (frameNumber
>= maxFrameArg
)) {
906 repeatFn(maxFrameArg
); // Ensure final call with maxFrameArg.
909 if (frameDelta
!== 0) { // Don't call repeatFn with duplicate frames.
910 repeatFn(frameNumber
);
919 * This function will scan the option list and determine if they
920 * require us to recalculate the pixel positions of each point.
921 * @param {!Array.<string>} labels a list of options to check.
922 * @param {!Object} attrs
923 * @return {boolean} true if the graph needs new points else false.
926 Dygraph
.isPixelChangingOptionList
= function(labels
, attrs
) {
927 // A whitelist of options that do not change pixel positions.
928 var pixelSafeOptions
= {
929 'annotationClickHandler': true,
930 'annotationDblClickHandler': true,
931 'annotationMouseOutHandler': true,
932 'annotationMouseOverHandler': true,
933 'axisLabelColor': true,
934 'axisLineColor': true,
935 'axisLineWidth': true,
936 'clickCallback': true,
937 'digitsAfterDecimal': true,
938 'drawCallback': true,
939 'drawHighlightPointCallback': true,
941 'drawPointCallback': true,
945 'gridLineColor': true,
946 'gridLineWidth': true,
947 'hideOverlayOnMouseOut': true,
948 'highlightCallback': true,
949 'highlightCircleSize': true,
950 'interactionModel': true,
951 'isZoomedIgnoreProgrammaticZoom': true,
953 'labelsDivStyles': true,
954 'labelsDivWidth': true,
957 'labelsSeparateLines': true,
958 'labelsShowZeroValues': true,
960 'maxNumberWidth': true,
961 'panEdgeFraction': true,
962 'pixelsPerYLabel': true,
963 'pointClickCallback': true,
965 'rangeSelectorPlotFillColor': true,
966 'rangeSelectorPlotStrokeColor': true,
967 'showLabelsOnHighlight': true,
971 'underlayCallback': true,
972 'unhighlightCallback': true,
973 'xAxisLabelFormatter': true,
975 'xValueFormatter': true,
976 'yAxisLabelFormatter': true,
977 'yValueFormatter': true,
981 // Assume that we do not require new points.
982 // This will change to true if we actually do need new points.
983 var requiresNewPoints
= false;
985 // Create a dictionary of series names for faster lookup.
986 // If there are no labels, then the dictionary stays empty.
987 var seriesNamesDictionary
= { };
989 for (var i
= 1; i
< labels
.length
; i
++) {
990 seriesNamesDictionary
[labels
[i
]] = true;
994 // Iterate through the list of updated options.
995 for (var property
in attrs
) {
996 // Break early if we already know we need new points from a previous option.
997 if (requiresNewPoints
) {
1000 if (attrs
.hasOwnProperty(property
)) {
1001 // Find out of this field is actually a series specific options list.
1002 if (seriesNamesDictionary
[property
]) {
1003 // This property value is a list of options for this series.
1004 // If any of these sub properties are not pixel safe, set the flag.
1005 for (var subProperty
in attrs
[property
]) {
1006 // Break early if we already know we need new points from a previous option.
1007 if (requiresNewPoints
) {
1010 if (attrs
[property
].hasOwnProperty(subProperty
) && !pixelSafeOptions
[subProperty
]) {
1011 requiresNewPoints
= true;
1014 // If this was not a series specific option list, check if its a pixel changing property.
1015 } else if (!pixelSafeOptions
[property
]) {
1016 requiresNewPoints
= true;
1021 return requiresNewPoints
;
1025 * Compares two arrays to see if they are equal. If either parameter is not an
1026 * array it will return false. Does a shallow compare
1027 * Dygraph.compareArrays([[1,2], [3, 4]], [[1,2], [3,4]]) === false.
1028 * @param {!Array.<T>} array1 first array
1029 * @param {!Array.<T>} array2 second array
1030 * @return {boolean} True if both parameters are arrays, and contents are equal.
1033 Dygraph
.compareArrays
= function(array1
, array2
) {
1034 if (!Dygraph
.isArrayLike(array1
) || !Dygraph
.isArrayLike(array2
)) {
1037 if (array1
.length
!== array2
.length
) {
1040 for (var i
= 0; i
< array1
.length
; i
++) {
1041 if (array1
[i
] !== array2
[i
]) {
1049 * @param {!CanvasRenderingContext2D} ctx the canvas context
1050 * @param {number} sides the number of sides in the shape.
1051 * @param {number} radius the radius of the image.
1052 * @param {number} cx center x coordate
1053 * @param {number} cy center y coordinate
1054 * @param {number=} rotationRadians the shift of the initial angle, in radians.
1055 * @param {number=} delta the angle shift for each line. If missing, creates a
1059 Dygraph
.regularShape_
= function(
1060 ctx
, sides
, radius
, cx
, cy
, rotationRadians
, delta
) {
1061 rotationRadians
= rotationRadians
|| 0;
1062 delta
= delta
|| Math
.PI
* 2 / sides
;
1065 var initialAngle
= rotationRadians
;
1066 var angle
= initialAngle
;
1068 var computeCoordinates
= function() {
1069 var x
= cx
+ (Math
.sin(angle
) * radius
);
1070 var y
= cy
+ (-Math
.cos(angle
) * radius
);
1074 var initialCoordinates
= computeCoordinates();
1075 var x
= initialCoordinates
[0];
1076 var y
= initialCoordinates
[1];
1079 for (var idx
= 0; idx
< sides
; idx
++) {
1080 angle
= (idx
== sides
- 1) ? initialAngle
: (angle
+ delta
);
1081 var coords
= computeCoordinates();
1082 ctx
.lineTo(coords
[0], coords
[1]);
1089 * TODO(danvk): be more specific on the return type.
1090 * @param {number} sides
1091 * @param {number=} rotationRadians
1092 * @param {number=} delta
1093 * @return {Function}
1096 Dygraph
.shapeFunction_
= function(sides
, rotationRadians
, delta
) {
1097 return function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1098 ctx
.strokeStyle
= color
;
1099 ctx
.fillStyle
= "white";
1100 Dygraph
.regularShape_(ctx
, sides
, radius
, cx
, cy
, rotationRadians
, delta
);
1105 DEFAULT
: function(g
, name
, ctx
, canvasx
, canvasy
, color
, radius
) {
1107 ctx
.fillStyle
= color
;
1108 ctx
.arc(canvasx
, canvasy
, radius
, 0, 2 * Math
.PI
, false);
1111 TRIANGLE
: Dygraph
.shapeFunction_(3),
1112 SQUARE
: Dygraph
.shapeFunction_(4, Math
.PI
/ 4),
1113 DIAMOND
: Dygraph
.shapeFunction_(4),
1114 PENTAGON
: Dygraph
.shapeFunction_(5),
1115 HEXAGON
: Dygraph
.shapeFunction_(6),
1116 CIRCLE
: function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1118 ctx
.strokeStyle
= color
;
1119 ctx
.fillStyle
= "white";
1120 ctx
.arc(cx
, cy
, radius
, 0, 2 * Math
.PI
, false);
1124 STAR
: Dygraph
.shapeFunction_(5, 0, 4 * Math
.PI
/ 5),
1125 PLUS
: function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1126 ctx
.strokeStyle
= color
;
1129 ctx
.moveTo(cx
+ radius
, cy
);
1130 ctx
.lineTo(cx
- radius
, cy
);
1135 ctx
.moveTo(cx
, cy
+ radius
);
1136 ctx
.lineTo(cx
, cy
- radius
);
1140 EX
: function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1141 ctx
.strokeStyle
= color
;
1144 ctx
.moveTo(cx
+ radius
, cy
+ radius
);
1145 ctx
.lineTo(cx
- radius
, cy
- radius
);
1150 ctx
.moveTo(cx
+ radius
, cy
- radius
);
1151 ctx
.lineTo(cx
- radius
, cy
+ radius
);
1158 * To create a "drag" interaction, you typically register a mousedown event
1159 * handler on the element where the drag begins. In that handler, you register a
1160 * mouseup handler on the window to determine when the mouse is released,
1161 * wherever that release happens. This works well, except when the user releases
1162 * the mouse over an off-domain iframe. In that case, the mouseup event is
1163 * handled by the iframe and never bubbles up to the window handler.
1165 * To deal with this issue, we cover iframes with high z-index divs to make sure
1166 * they don't capture mouseup.
1169 * element.addEventListener('mousedown', function() {
1170 * var tarper = new Dygraph.IFrameTarp();
1172 * var mouseUpHandler = function() {
1174 * window.removeEventListener(mouseUpHandler);
1177 * window.addEventListener('mouseup', mouseUpHandler);
1182 Dygraph
.IFrameTarp
= function() {
1183 /** @type {Array.<!HTMLDivElement>} */
1188 * Find all the iframes in the document and cover them with high z-index
1191 Dygraph
.IFrameTarp
.prototype.cover
= function() {
1192 var iframes
= document
.getElementsByTagName("iframe");
1193 for (var i
= 0; i
< iframes
.length
; i
++) {
1194 var iframe
= iframes
[i
];
1195 var x
= Dygraph
.findPosX(iframe
),
1196 y
= Dygraph
.findPosY(iframe
),
1197 width
= iframe
.offsetWidth
,
1198 height
= iframe
.offsetHeight
;
1200 var div
= document
.createElement("div");
1201 div
.style
.position
= "absolute";
1202 div
.style
.left
= x
+ 'px';
1203 div
.style
.top
= y
+ 'px';
1204 div
.style
.width
= width
+ 'px';
1205 div
.style
.height
= height
+ 'px';
1206 div
.style
.zIndex
= 999;
1207 document
.body
.appendChild(div
);
1208 this.tarps
.push(div
);
1213 * Remove all the iframe covers. You should call this in a mouseup handler.
1215 Dygraph
.IFrameTarp
.prototype.uncover
= function() {
1216 for (var i
= 0; i
< this.tarps
.length
; i
++) {
1217 this.tarps
[i
].parentNode
.removeChild(this.tarps
[i
]);
1223 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
1224 * @param {string} data
1225 * @return {?string} the delimiter that was detected (or null on failure).
1227 Dygraph
.detectLineDelimiter
= function(data
) {
1228 for (var i
= 0; i
< data
.length
; i
++) {
1229 var code
= data
.charAt(i
);
1230 if (code
=== '\r') {
1231 // Might actually be "\r\n".
1232 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\n')) {
1237 if (code
=== '\n') {
1238 // Might actually be "\n\r".
1239 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\r')) {
1250 * Is one element contained by another?
1251 * @param {Element} containee The contained element.
1252 * @param {Element} container The container element.
1253 * @return {boolean} Whether containee is inside (or equal to) container.
1256 Dygraph
.isElementContainedBy
= function(containee
, container
) {
1257 if (container
=== null || containee
=== null) {
1260 while (containee
&& containee
!== container
) {
1261 containee
= containee
.parentNode
;
1263 return (containee
=== container
);
1267 // This masks some numeric issues in older versions of Firefox,
1268 // where 1.0/Math
.pow(10,2) != Math
.pow(10,-2).
1269 /** @type {function(number,number):number} */
1270 Dygraph
.pow
= function(base
, exp
) {
1272 return 1.0 / Math
.pow(base
, -exp
);
1274 return Math
.pow(base
, exp
);
1277 // For Dygraph.setDateSameTZ, below.
1278 Dygraph
.dateSetters
= {
1279 ms
: Date
.prototype.setMilliseconds
,
1280 s
: Date
.prototype.setSeconds
,
1281 m
: Date
.prototype.setMinutes
,
1282 h
: Date
.prototype.setHours
1286 * This is like calling d.setSeconds(), d.setMinutes(), etc, except that it
1287 * adjusts for time zone changes to keep the date/time parts consistent.
1289 * For example, d.getSeconds(), d.getMinutes() and d.getHours() will all be
1290 * the same before/after you call setDateSameTZ(d, {ms: 0}). The same is not
1291 * true if you call d.setMilliseconds(0).
1293 * @type {function(!Date, Object.<number>)}
1295 Dygraph
.setDateSameTZ
= function(d
, parts
) {
1296 var tz
= d
.getTimezoneOffset();
1297 for (var k
in parts
) {
1298 if (!parts
.hasOwnProperty(k
)) continue;
1299 var setter
= Dygraph
.dateSetters
[k
];
1300 if (!setter
) throw "Invalid setter: " + k
;
1301 setter
.call(d
, parts
[k
]);
1302 if (d
.getTimezoneOffset() != tz
) {
1303 d
.setTime(d
.getTime() + (tz
- d
.getTimezoneOffset()) * 60 * 1000);