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 // <REMOVE_FOR_COMBINED>
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
41 Dygraph
.LOG_STACK_TRACES
= false;
42 // </REMOVE_FOR_COMBINED
>
44 /** A dotted line stroke pattern. */
45 Dygraph
.DOTTED_LINE
= [2, 2];
46 /** A dashed line stroke pattern. */
47 Dygraph
.DASHED_LINE
= [7, 3];
48 /** A dot dash stroke pattern. */
49 Dygraph
.DOT_DASH_LINE
= [7, 2, 2, 2];
52 * Log an error on the JS console at the given severity.
53 * @param {number} severity One of Dygraph.{DEBUG,INFO,WARNING,ERROR}
54 * @param {string} message The message to log.
57 Dygraph
.log
= function(severity
, message
) {
58 // <REMOVE_FOR_COMBINED>
60 if (typeof(printStackTrace
) != 'undefined') {
62 // Remove uninteresting bits: logging functions and paths.
63 st
= printStackTrace({guess
:false});
64 while (st
[0].indexOf("stacktrace") != -1) {
69 for (var i
= 0; i
< st
.length
; i
++) {
70 st
[i
] = st
[i
].replace(/\([^)]*\/(.*)\)/, '@$1')
71 .replace(/\@.*\/([^\/]*)/, '@$1')
72 .replace('[object Object].', '');
74 var top_msg
= st
.splice(0, 1)[0];
75 message
+= ' (' + top_msg
.replace(/^.*@ ?/, '') + ')';
77 // Oh well, it was worth a shot!
80 // </REMOVE_FOR_COMBINED
>
82 if (typeof(window
.console
) != 'undefined') {
83 // In older versions of Firefox, only console.log is defined.
84 var console
= window
.console
;
85 var log
= function(console
, method
, msg
) {
86 if (method
&& typeof(method
) == 'function') {
87 method
.call(console
, msg
);
95 log(console
, console
.debug
, 'dygraphs: ' + message
);
98 log(console
, console
.info
, 'dygraphs: ' + message
);
100 case Dygraph
.WARNING
:
101 log(console
, console
.warn
, 'dygraphs: ' + message
);
104 log(console
, console
.error
, 'dygraphs: ' + message
);
109 // <REMOVE_FOR_COMBINED>
110 if (Dygraph
.LOG_STACK_TRACES
) {
111 window
.console
.log(st
.join('\n'));
113 // </REMOVE_FOR_COMBINED
>
117 * @param {string} message
120 Dygraph
.info
= function(message
) {
121 Dygraph
.log(Dygraph
.INFO
, message
);
125 * @param {string} message
128 Dygraph
.warn
= function(message
) {
129 Dygraph
.log(Dygraph
.WARNING
, message
);
133 * @param {string} message
135 Dygraph
.error
= function(message
) {
136 Dygraph
.log(Dygraph
.ERROR
, message
);
140 * Return the 2d context for a dygraph canvas.
142 * This method is only exposed for the sake of replacing the function in
143 * automated tests, e.g.
145 * var oldFunc = Dygraph.getContext();
146 * Dygraph.getContext = function(canvas) {
147 * var realContext = oldFunc(canvas);
148 * return new Proxy(realContext);
150 * @param {!HTMLCanvasElement} canvas
151 * @return {!CanvasRenderingContext2D}
154 Dygraph
.getContext
= function(canvas
) {
155 return /** @type{!CanvasRenderingContext2D}*/(canvas
.getContext("2d"));
159 * Add an event handler. This smooths a difference between IE and the rest of
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.
167 Dygraph
.addEvent
= function addEvent(elem
, type
, fn
) {
168 if (elem
.addEventListener
) {
169 elem
.addEventListener(type
, fn
, false);
171 elem
[type
+fn
] = function(){fn(window
.event
);};
172 elem
.attachEvent('on'+type
, elem
[type
+fn
]);
177 * Add an event handler. This event handler is kept until the graph is
178 * destroyed with a call to graph.destroy().
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.
186 Dygraph
.prototype.addAndTrackEvent
= function(elem
, type
, fn
) {
187 Dygraph
.addEvent(elem
, type
, fn
);
188 this.registeredEvents_
.push({ elem
: elem
, type
: type
, fn
: fn
});
192 * Remove an event handler. This smooths a difference between IE and the rest
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.
200 Dygraph
.removeEvent
= function(elem
, type
, fn
) {
201 if (elem
.removeEventListener
) {
202 elem
.removeEventListener(type
, fn
, false);
205 elem
.detachEvent('on'+type
, elem
[type
+fn
]);
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
210 elem
[type
+fn
] = null;
214 Dygraph
.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
);
222 this.registeredEvents_
= [];
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
230 * @param { !Event } e The event whose normal behavior should be canceled.
233 Dygraph
.cancelEvent
= function(e
) {
234 e
= e
? e
: window
.event
;
235 if (e
.stopPropagation
) {
238 if (e
.preventDefault
) {
241 e
.cancelBubble
= true;
243 e
.returnValue
= false;
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
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.
257 Dygraph
.hsvToRGB
= function (hue
, saturation
, value
) {
261 if (saturation
=== 0) {
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
)));
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;
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
+ ')';
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
290 // ... and modifications to support scrolling divs.
293 * Find the coordinates of an object relative to the top left of the page.
295 * TODO(danvk): change obj type from Node -> !Node
297 * @return {{x:number,y:number}}
300 Dygraph
.findPos
= function(obj
) {
301 var curleft
= 0, curtop
= 0;
302 if (obj
.offsetParent
) {
305 // NOTE: the if statement here is for IE8.
306 var borderLeft
= "0", borderTop
= "0";
307 if (window
.getComputedStyle
) {
308 var computedStyle
= window
.getComputedStyle(copyObj
, null);
309 borderLeft
= computedStyle
.borderLeft
|| "0";
310 borderTop
= computedStyle
.borderTop
|| "0";
312 curleft
+= parseInt(borderLeft
, 10) ;
313 curtop
+= parseInt(borderTop
, 10) ;
314 curleft
+= copyObj
.offsetLeft
;
315 curtop
+= copyObj
.offsetTop
;
316 if (!copyObj
.offsetParent
) {
319 copyObj
= copyObj
.offsetParent
;
322 // TODO(danvk): why would obj ever have these properties?
323 if (obj
.x
) curleft
+= obj
.x
;
324 if (obj
.y
) curtop
+= obj
.y
;
327 // This handles the case where the object is inside a scrolled div.
328 while (obj
&& obj
!= document
.body
) {
329 curleft
-= obj
.scrollLeft
;
330 curtop
-= obj
.scrollTop
;
331 obj
= obj
.parentNode
;
333 return {x
: curleft
, y
: curtop
};
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
344 Dygraph
.pageX
= function(e
) {
346 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
348 var de
= document
.documentElement
;
349 var b
= document
.body
;
351 (de
.scrollLeft
|| b
.scrollLeft
) -
352 (de
.clientLeft
|| 0);
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
364 Dygraph
.pageY
= function(e
) {
366 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
368 var de
= document
.documentElement
;
369 var b
= document
.body
;
371 (de
.scrollTop
|| b
.scrollTop
) -
377 * This returns true unless the parameter is 0, null, undefined or NaN.
378 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
380 * @param {number} x The number to consider.
381 * @return {boolean} Whether the number is zero or NaN.
384 Dygraph
.isOK
= function(x
) {
385 return !!x
&& !isNaN(x
);
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.
395 Dygraph
.isValidPoint
= function(p
, allowNaNY
) {
396 if (!p
) return false; // null or undefined object
397 if (p
.yval
=== null) return false; // missing point
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;
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.
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
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
420 * string length should be precision + 6 (e.g 1.123e+300).
422 Dygraph
.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);
426 // This is deceptively simple. The actual algorithm comes from:
428 // Max allowed length = p + 4
429 // where 4 comes from 'e+n' and '.'.
431 // Length of fixed format = 2 + y + p
432 // where 2 comes from '0.' and y = # of leading zeroes.
434 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
437 // Since the behavior of toPrecision() is identical for larger numbers, we
438 // don't have to worry about the other bound.
440 // Finally, the argument for toExponential() is the number of trailing digits,
441 // so we take off 1 for the value before the '.'.
442 return (Math
.abs(x
) < 1.0e-3 && x
!== 0.0) ?
443 x
.toExponential(p
- 1) : x
.toPrecision(p
);
447 * Converts '9' to '09' (useful for dates)
452 Dygraph
.zeropad
= function(x
) {
453 if (x
< 10) return "0" + x
; else return "" + x
;
457 * Return a string version of the hours, minutes and seconds portion of a date.
459 * @param {number} date The JavaScript date (ms since epoch)
460 * @return {string} A time of the form "HH:MM:SS"
463 Dygraph
.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());
471 return zeropad(d
.getHours()) + ":" + zeropad(d
.getMinutes());
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"
481 Dygraph
.dateString_
= function(date
) {
482 var zeropad
= Dygraph
.zeropad
;
483 var d
= new Date(date
);
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());
493 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
494 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
496 return year
+ "/" + month + "/" + day
+ ret
;
500 * Round a number to the specified number of digits past the decimal point.
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
506 Dygraph
.round_
= function(num
, places
) {
507 var shift
= Math
.pow(10, places
);
508 return Math
.round(num
* shift
)/shift
;
512 * Implementation of binary search over an array.
513 * Currently does not work when val is outside the range of arry's values.
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.
524 Dygraph
.binarySearch
= function(val
, arry
, abs
, low
, high
) {
525 if (low
=== null || low
=== undefined
||
526 high
=== null || high
=== undefined
) {
528 high
= arry
.length
- 1;
533 if (abs
=== null || abs
=== undefined
) {
536 var validIndex
= function(idx
) {
537 return idx
>= 0 && idx
< arry
.length
;
539 var mid
= parseInt((low
+ high
) / 2, 10);
540 var element
= arry
[mid
];
542 if (element
== val
) {
544 } else if (element
> val
) {
546 // Accept if element > val, but also if prior element < val.
548 if (validIndex(idx
) && arry
[idx
] < val
) {
552 return Dygraph
.binarySearch(val
, arry
, abs
, low
, mid
- 1);
553 } else if (element
< val
) {
555 // Accept if element < val, but also if prior element > val.
557 if (validIndex(idx
) && arry
[idx
] > val
) {
561 return Dygraph
.binarySearch(val
, arry
, abs
, mid
+ 1, high
);
563 return -1; // can't actually happen, but makes closure compiler happy
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.
571 * @param {string} dateStr A date in a variety of possible string formats.
572 * @return {number} Milliseconds since epoch.
575 Dygraph
.dateParser
= function(dateStr
) {
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
;
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("-", "/");
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.
599 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
601 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
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
);
608 if (!d
|| isNaN(d
)) {
609 Dygraph
.error("Couldn't parse " + dateStr
+ " as a date");
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.
618 * @param {string} str The date string, e.g. "2011/05/06"
619 * @return {number} millis since epoch
622 Dygraph
.dateStrToMillis
= function(str
) {
623 return new Date(str
).getTime();
626 // These functions are all based on MochiKit.
628 * Copies all the properties from o to self.
630 * @param {!Object} self
634 Dygraph
.update
= function(self
, o
) {
635 if (typeof(o
) != 'undefined' && o
!== null) {
637 if (o
.hasOwnProperty(k
)) {
646 * Copies all the properties from o to self.
648 * @param {!Object} self
653 Dygraph
.updateDeep
= function (self
, o
) {
654 // Taken from http://stackoverflow.com/questions
/384286/javascript
-isdom
-how
-do-you
-check
-if-a
-javascript
-object
-is
-a
-dom
-object
657 typeof Node
=== "object" ? o
instanceof Node
:
658 typeof o
=== "object" && typeof o
.nodeType
=== "number" && typeof o
.nodeName
==="string"
662 if (typeof(o
) != 'undefined' && o
!== null) {
664 if (o
.hasOwnProperty(k
)) {
667 } else if (Dygraph
.isArrayLike(o
[k
])) {
668 self
[k
] = o
[k
].slice();
669 } else if (isNode(o
[k
])) {
670 // DOM objects are shallowly-copied.
672 } else if (typeof(o
[k
]) == 'object') {
673 if (typeof(self
[k
]) != 'object' || self
[k
] === null) {
676 Dygraph
.updateDeep(self
[k
], o
[k
]);
691 Dygraph
.isArrayLike
= function(o
) {
694 (typ
!= 'object' && !(typ
== 'function' &&
695 typeof(o
.item
) == 'function')) ||
697 typeof(o
.length
) != 'number' ||
710 Dygraph
.isDateLike
= function (o
) {
711 if (typeof(o
) != "object" || o
=== null ||
712 typeof(o
.getTime
) != 'function') {
719 * Note: this only seems to work for arrays.
724 Dygraph
.clone
= function(o
) {
725 // TODO(danvk): figure out how MochiKit's version works
727 for (var i
= 0; i
< o
.length
; i
++) {
728 if (Dygraph
.isArrayLike(o
[i
])) {
729 r
.push(Dygraph
.clone(o
[i
]));
738 * Create a new canvas element. This is more complex than a simple
739 * document.createElement("canvas") because of IE and excanvas.
741 * @return {!HTMLCanvasElement}
744 Dygraph
.createCanvas
= function() {
745 var canvas
= document
.createElement("canvas");
747 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
748 if (isIE
&& (typeof(G_vmlCanvasManager
) != 'undefined')) {
749 canvas
= G_vmlCanvasManager
.initElement(
750 /**@type{!HTMLCanvasElement}*/(canvas
));
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.
762 Dygraph
.isAndroid
= function() {
763 return (/Android/).test(navigator
.userAgent
);
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
772 * @param {function(!Array,?):boolean=} predicate
775 Dygraph
.Iterator
= function(array
, start
, length
, predicate
) {
777 length
= length
|| array
.length
;
778 this.hasNext
= true; // Use to identify if there's another element.
779 this.peek
= null; // Use for look-ahead
782 this.predicate_
= predicate
;
783 this.end_
= Math
.min(array
.length
, start
+ length
);
784 this.nextIdx_
= start
- 1; // use -1 so initial advance works.
785 this.next(); // ignoring result.
791 Dygraph
.Iterator
.prototype.next
= function() {
797 var nextIdx
= this.nextIdx_
+ 1;
799 while (nextIdx
< this.end_
) {
800 if (!this.predicate_
|| this.predicate_(this.array_
, nextIdx
)) {
801 this.peek
= this.array_
[nextIdx
];
807 this.nextIdx_
= nextIdx
;
809 this.hasNext
= false;
816 * Returns a new iterator over array, between indexes start and
817 * start + length, and only returns entries that pass the accept function
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.
825 * @param {function(?):boolean=} opt_predicate a function that takes
826 * parameters array and idx, which returns true when the element should be
827 * returned. If omitted, all elements are accepted.
830 Dygraph
.createIterator
= function(array
, start
, length
, opt_predicate
) {
831 return new Dygraph
.Iterator(array
, start
, length
, opt_predicate
);
834 // Shim layer with setTimeout fallback.
835 // From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
836 // Should be called with the window context:
837 // Dygraph.requestAnimFrame.call(window, function() {})
838 Dygraph
.requestAnimFrame
= (function() {
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);
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.
862 Dygraph
.repeatAndCleanup
= function(repeatFn
, maxFrames
, framePeriodInMillis
,
865 var previousFrameNumber
;
866 var startTime
= new Date().getTime();
867 repeatFn(frameNumber
);
868 if (maxFrames
== 1) {
872 var maxFrameArg
= maxFrames
- 1;
875 if (frameNumber
>= maxFrames
) return;
876 Dygraph
.requestAnimFrame
.call(window
, function() {
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.
893 if (frameDelta
!== 0) { // Don't call repeatFn with duplicate frames.
894 repeatFn(frameNumber
);
903 * This function will scan the option list and determine if they
904 * require us to recalculate the pixel positions of each point.
905 * @param {!Array.<string>} labels a list of options to check.
906 * @param {!Object} attrs
907 * @return {boolean} true if the graph needs new points else false.
910 Dygraph
.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,
921 'digitsAfterDecimal': true,
922 'drawCallback': true,
923 'drawHighlightPointCallback': true,
925 'drawPointCallback': true,
929 'gridLineColor': true,
930 'gridLineWidth': true,
931 'hideOverlayOnMouseOut': true,
932 'highlightCallback': true,
933 'highlightCircleSize': true,
934 'interactionModel': true,
935 'isZoomedIgnoreProgrammaticZoom': true,
937 'labelsDivStyles': true,
938 'labelsDivWidth': true,
941 'labelsSeparateLines': true,
942 'labelsShowZeroValues': true,
944 'maxNumberWidth': true,
945 'panEdgeFraction': true,
946 'pixelsPerYLabel': true,
947 'pointClickCallback': true,
949 'rangeSelectorPlotFillColor': true,
950 'rangeSelectorPlotStrokeColor': true,
951 'showLabelsOnHighlight': true,
955 'underlayCallback': true,
956 'unhighlightCallback': true,
957 'xAxisLabelFormatter': true,
959 'xValueFormatter': true,
960 'yAxisLabelFormatter': true,
961 'yValueFormatter': true,
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;
969 // Create a dictionary of series names for faster lookup.
970 // If there are no labels, then the dictionary stays empty.
971 var seriesNamesDictionary
= { };
973 for (var i
= 1; i
< labels
.length
; i
++) {
974 seriesNamesDictionary
[labels
[i
]] = true;
978 // Iterate through the list of updated options.
979 for (var property
in attrs
) {
980 // Break early if we already know we need new points from a previous option.
981 if (requiresNewPoints
) {
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.
989 for (var subProperty
in attrs
[property
]) {
990 // Break early if we already know we need new points from a previous option.
991 if (requiresNewPoints
) {
994 if (attrs
[property
].hasOwnProperty(subProperty
) && !pixelSafeOptions
[subProperty
]) {
995 requiresNewPoints
= true;
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;
1005 return requiresNewPoints
;
1009 DEFAULT
: function(g
, name
, ctx
, canvasx
, canvasy
, color
, radius
) {
1011 ctx
.fillStyle
= color
;
1012 ctx
.arc(canvasx
, canvasy
, radius
, 0, 2 * Math
.PI
, false);
1015 // For more shapes, include extras/shapes.js
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.
1026 * To deal with this issue, we cover iframes with high z-index divs to make sure
1027 * they don't capture mouseup.
1030 * element.addEventListener('mousedown', function() {
1031 * var tarper = new Dygraph.IFrameTarp();
1033 * var mouseUpHandler = function() {
1035 * window.removeEventListener(mouseUpHandler);
1038 * window.addEventListener('mouseup', mouseUpHandler);
1043 Dygraph
.IFrameTarp
= function() {
1044 /** @type {Array.<!HTMLDivElement>} */
1049 * Find all the iframes in the document and cover them with high z-index
1052 Dygraph
.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
;
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
);
1074 * Remove all the iframe covers. You should call this in a mouseup handler.
1076 Dygraph
.IFrameTarp
.prototype.uncover
= function() {
1077 for (var i
= 0; i
< this.tarps
.length
; i
++) {
1078 this.tarps
[i
].parentNode
.removeChild(this.tarps
[i
]);
1084 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
1085 * @param {string} data
1086 * @return {?string} the delimiter that was detected (or null on failure).
1088 Dygraph
.detectLineDelimiter
= function(data
) {
1089 for (var i
= 0; i
< data
.length
; i
++) {
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')) {
1098 if (code
=== '\n') {
1099 // Might actually be "\n\r".
1100 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\r')) {
1111 * Is one node contained by another?
1112 * @param {Node} containee The contained node.
1113 * @param {Node} container The container node.
1114 * @return {boolean} Whether containee is inside (or equal to) container.
1117 Dygraph
.isNodeContainedBy
= function(containee
, container
) {
1118 if (container
=== null || containee
=== null) {
1121 var containeeNode
= /** @type {Node} */ (containee
);
1122 while (containeeNode
&& containeeNode
!== container
) {
1123 containeeNode
= containeeNode
.parentNode
;
1125 return (containeeNode
=== container
);
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} */
1132 Dygraph
.pow
= function(base
, exp
) {
1134 return 1.0 / Math
.pow(base
, -exp
);
1136 return Math
.pow(base
, exp
);
1139 // For Dygraph.setDateSameTZ, below.
1140 Dygraph
.dateSetters
= {
1141 ms
: Date
.prototype.setMilliseconds
,
1142 s
: Date
.prototype.setSeconds
,
1143 m
: Date
.prototype.setMinutes
,
1144 h
: Date
.prototype.setHours
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.
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).
1155 * @type {function(!Date, Object.<number>)}
1157 Dygraph
.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);
1171 * Converts any valid CSS color (hex, rgb(), named color) to an RGB tuple.
1173 * @param {!string} colorStr Any valid CSS color string.
1174 * @return {{r:number,g:number,b:number}} Parsed RGB tuple.
1177 Dygraph
.toRGB_
= function(colorStr
) {
1178 // TODO(danvk): cache color parses to avoid repeated DOM manipulation.
1179 var div
= document
.createElement('div');
1180 div
.style
.backgroundColor
= colorStr
;
1181 div
.style
.visibility
= 'hidden';
1182 document
.body
.appendChild(div
);
1183 var rgbStr
= window
.getComputedStyle(div
).backgroundColor
;
1184 document
.body
.removeChild(div
);
1185 var bits
= /^rgb\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)$/.exec(rgbStr
);
1187 r
: parseInt(bits
[1], 10),
1188 g
: parseInt(bits
[2], 10),
1189 b
: parseInt(bits
[3], 10)