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 /*global Dygraph:false, Node:false */
17 import * as DygraphTickers from
'./dygraph-tickers';
19 export var LOG_SCALE
= 10;
20 export var LN_TEN
= Math
.log(LOG_SCALE
);
27 export var log10
= function(x
) {
28 return Math
.log(x
) / LN_TEN
;
38 export var logRangeFraction
= function(r0
, r1
, pct
) {
39 // Computing the inverse of toPercentXCoord. The function was arrived at with
40 // the following steps:
42 // Original calcuation:
43 // pct = (log(x) - log(xRange[0])) / (log(xRange
[1]) - log(xRange
[0])));
45 // Multiply both sides by the right-side demoninator.
46 // pct * (log(xRange[1] - log(xRange[0]))) = log(x) - log(xRange[0])
48 // add log(xRange[0]) to both sides
49 // log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])) = log(x);
51 // Swap both sides of the equation,
52 // log(x) = log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0]))
54 // Use both sides as the exponent in 10^exp and we're done.
55 // x = 10 ^ (log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])))
57 var logr0
= log10(r0
);
58 var logr1
= log10(r1
);
59 var exponent
= logr0
+ (pct
* (logr1
- logr0
));
60 var value
= Math
.pow(LOG_SCALE
, exponent
);
64 /** A dotted line stroke pattern. */
65 export var DOTTED_LINE
= [2, 2];
66 /** A dashed line stroke pattern. */
67 export var DASHED_LINE
= [7, 3];
68 /** A dot dash stroke pattern. */
69 export var DOT_DASH_LINE
= [7, 2, 2, 2];
71 // Directions for panning and zooming. Use bit operations when combined
72 // values are possible.
73 export var HORIZONTAL
= 1;
74 export var VERTICAL
= 2;
77 * Return the 2d context for a dygraph canvas.
79 * This method is only exposed for the sake of replacing the function in
82 * @param {!HTMLCanvasElement} canvas
83 * @return {!CanvasRenderingContext2D}
86 export var getContext
= function(canvas
) {
87 return /** @type{!CanvasRenderingContext2D}*/(canvas
.getContext("2d"));
91 * Add an event handler.
92 * @param {!Node} elem The element to add the event to.
93 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
94 * @param {function(Event):(boolean|undefined)} fn The function to call
95 * on the event. The function takes one parameter: the event object.
98 export var addEvent
= function addEvent(elem
, type
, fn
) {
99 elem
.addEventListener(type
, fn
, false);
103 * Remove an event handler.
104 * @param {!Node} elem The element to remove the event from.
105 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
106 * @param {function(Event):(boolean|undefined)} fn The function to call
107 * on the event. The function takes one parameter: the event object.
109 export function removeEvent(elem
, type
, fn
) {
110 elem
.removeEventListener(type
, fn
, false);
114 * Cancels further processing of an event. This is useful to prevent default
115 * browser actions, e.g. highlighting text on a double-click.
116 * Based on the article at
117 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
118 * @param {!Event} e The event whose normal behavior should be canceled.
121 export function cancelEvent(e
) {
122 e
= e
? e
: window
.event
;
123 if (e
.stopPropagation
) {
126 if (e
.preventDefault
) {
129 e
.cancelBubble
= true;
131 e
.returnValue
= false;
136 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
137 * is used to generate default series colors which are evenly spaced on the
139 * @param { number } hue Range is 0.0-1.0.
140 * @param { number } saturation Range is 0.0-1.0.
141 * @param { number } value Range is 0.0-1.0.
142 * @return { string } "rgb(r,g,b)" where r, g and b range from 0-255.
145 export function hsvToRGB(hue
, saturation
, value
) {
149 if (saturation
=== 0) {
154 var i
= Math
.floor(hue
* 6);
155 var f
= (hue
* 6) - i
;
156 var p
= value
* (1 - saturation
);
157 var q
= value
* (1 - (saturation
* f
));
158 var t
= value
* (1 - (saturation
* (1 - f
)));
160 case 1: red
= q
; green
= value
; blue
= p
; break;
161 case 2: red
= p
; green
= value
; blue
= t
; break;
162 case 3: red
= p
; green
= q
; blue
= value
; break;
163 case 4: red
= t
; green
= p
; blue
= value
; break;
164 case 5: red
= value
; green
= p
; blue
= q
; break;
165 case 6: // fall through
166 case 0: red
= value
; green
= t
; blue
= p
; break;
169 red
= Math
.floor(255 * red
+ 0.5);
170 green
= Math
.floor(255 * green
+ 0.5);
171 blue
= Math
.floor(255 * blue
+ 0.5);
172 return 'rgb(' + red
+ ',' + green
+ ',' + blue
+ ')';
176 * Find the coordinates of an object relative to the top left of the page.
179 * @return {{x:number,y:number}}
182 export function findPos(obj
) {
183 var p
= obj
.getBoundingClientRect(),
185 d
= document
.documentElement
;
188 x
: p
.left
+ (w
.pageXOffset
|| d
.scrollLeft
),
189 y
: p
.top
+ (w
.pageYOffset
|| d
.scrollTop
)
194 * Returns the x-coordinate of the event in a coordinate system where the
195 * top-left corner of the page (not the window) is (0,0).
196 * Taken from MochiKit.Signal
201 export function pageX(e
) {
202 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
206 * Returns the y-coordinate of the event in a coordinate system where the
207 * top-left corner of the page (not the window) is (0,0).
208 * Taken from MochiKit.Signal
213 export function pageY(e
) {
214 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
218 * Converts page the x-coordinate of the event to pixel x-coordinates on the
219 * canvas (i.e. DOM Coords).
220 * @param {!Event} e Drag event.
221 * @param {!DygraphInteractionContext} context Interaction context object.
222 * @return {number} The amount by which the drag has moved to the right.
224 export function dragGetX_(e
, context
) {
225 return pageX(e
) - context
.px
;
229 * Converts page the y-coordinate of the event to pixel y-coordinates on the
230 * canvas (i.e. DOM Coords).
231 * @param {!Event} e Drag event.
232 * @param {!DygraphInteractionContext} context Interaction context object.
233 * @return {number} The amount by which the drag has moved down.
235 export function dragGetY_(e
, context
) {
236 return pageY(e
) - context
.py
;
240 * This returns true unless the parameter is 0, null, undefined or NaN.
241 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
243 * @param {number} x The number to consider.
244 * @return {boolean} Whether the number is zero or NaN.
247 export function isOK(x
) {
248 return !!x
&& !isNaN(x
);
252 * @param {{x:?number,y:?number,yval:?number}} p The point to consider, valid
253 * points are {x, y} objects
254 * @param {boolean=} opt_allowNaNY Treat point with y=NaN as valid
255 * @return {boolean} Whether the point has numeric x and y.
258 export function isValidPoint(p
, opt_allowNaNY
) {
259 if (!p
) return false; // null or undefined object
260 if (p
.yval
=== null) return false; // missing point
261 if (p
.x
=== null || p
.x
=== undefined
) return false;
262 if (p
.y
=== null || p
.y
=== undefined
) return false;
263 if (isNaN(p
.x
) || (!opt_allowNaNY
&& isNaN(p
.y
))) return false;
268 * Number formatting function which mimicks the behavior of %g in printf, i.e.
269 * either exponential or fixed format (without trailing 0s) is used depending on
270 * the length of the generated string. The advantage of this format is that
271 * there is a predictable upper bound on the resulting string length,
272 * significant figures are not dropped, and normal numbers are not displayed in
273 * exponential notation.
275 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
276 * It creates strings which are too long for absolute values between 10^-4 and
277 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
280 * @param {number} x The number to format
281 * @param {number=} opt_precision The precision to use, default 2.
282 * @return {string} A string formatted like %g in printf. The max generated
283 * string length should be precision + 6 (e.g 1.123e+300).
285 export function floatFormat(x
, opt_precision
) {
286 // Avoid invalid precision values; [1, 21] is the valid range.
287 var p
= Math
.min(Math
.max(1, opt_precision
|| 2), 21);
289 // This is deceptively simple. The actual algorithm comes from:
291 // Max allowed length = p + 4
292 // where 4 comes from 'e+n' and '.'.
294 // Length of fixed format = 2 + y + p
295 // where 2 comes from '0.' and y = # of leading zeroes.
297 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
300 // Since the behavior of toPrecision() is identical for larger numbers, we
301 // don't have to worry about the other bound.
303 // Finally, the argument for toExponential() is the number of trailing digits,
304 // so we take off 1 for the value before the '.'.
305 return (Math
.abs(x
) < 1.0e-3 && x
!== 0.0) ?
306 x
.toExponential(p
- 1) : x
.toPrecision(p
);
310 * Converts '9' to '09' (useful for dates)
315 export function zeropad(x
) {
316 if (x
< 10) return "0" + x
; else return "" + x
;
320 * Date accessors to get the parts of a calendar date (year, month,
321 * day, hour, minute, second and millisecond) according to local time,
322 * and factory method to call the Date constructor with an array of arguments.
324 export var DateAccessorsLocal
= {
325 getFullYear
: d
=> d
.getFullYear(),
326 getMonth
: d
=> d
.getMonth(),
327 getDate
: d
=> d
.getDate(),
328 getHours
: d
=> d
.getHours(),
329 getMinutes
: d
=> d
.getMinutes(),
330 getSeconds
: d
=> d
.getSeconds(),
331 getMilliseconds
: d
=> d
.getMilliseconds(),
332 getDay
: d
=> d
.getDay(),
333 makeDate
: function(y
, m
, d
, hh
, mm
, ss
, ms
) {
334 return new Date(y
, m
, d
, hh
, mm
, ss
, ms
);
339 * Date accessors to get the parts of a calendar date (year, month,
340 * day of month, hour, minute, second and millisecond) according to UTC time,
341 * and factory method to call the Date constructor with an array of arguments.
343 export var DateAccessorsUTC
= {
344 getFullYear
: d
=> d
.getUTCFullYear(),
345 getMonth
: d
=> d
.getUTCMonth(),
346 getDate
: d
=> d
.getUTCDate(),
347 getHours
: d
=> d
.getUTCHours(),
348 getMinutes
: d
=> d
.getUTCMinutes(),
349 getSeconds
: d
=> d
.getUTCSeconds(),
350 getMilliseconds
: d
=> d
.getUTCMilliseconds(),
351 getDay
: d
=> d
.getUTCDay(),
352 makeDate
: function(y
, m
, d
, hh
, mm
, ss
, ms
) {
353 return new Date(Date
.UTC(y
, m
, d
, hh
, mm
, ss
, ms
));
358 * Return a string version of the hours, minutes and seconds portion of a date.
359 * @param {number} hh The hours (from 0-23)
360 * @param {number} mm The minutes (from 0-59)
361 * @param {number} ss The seconds (from 0-59)
362 * @return {string} A time of the form "HH:MM" or "HH:MM:SS"
365 export function hmsString_(hh
, mm
, ss
) {
366 var ret
= zeropad(hh
) + ":" + zeropad(mm
);
368 ret
+= ":" + zeropad(ss
);
374 * Convert a JS date (millis since epoch) to a formatted string.
375 * @param {number} time The JavaScript time value (ms since epoch)
376 * @param {boolean} utc Wether output UTC or local time
377 * @return {string} A date of one of these forms:
378 * "YYYY/MM/DD", "YYYY/MM/DD HH:MM" or "YYYY/MM/DD HH:MM:SS"
381 export function dateString_(time
, utc
) {
382 var accessors
= utc
? DateAccessorsUTC
: DateAccessorsLocal
;
383 var date
= new Date(time
);
384 var y
= accessors
.getFullYear(date
);
385 var m
= accessors
.getMonth(date
);
386 var d
= accessors
.getDate(date
);
387 var hh
= accessors
.getHours(date
);
388 var mm
= accessors
.getMinutes(date
);
389 var ss
= accessors
.getSeconds(date
);
390 // Get a year string:
392 // Get a 0 padded month string
393 var month
= zeropad(m
+ 1); //months are 0-offset, sigh
394 // Get a 0 padded day string
395 var day
= zeropad(d
);
396 var frac
= hh
* 3600 + mm
* 60 + ss
;
397 var ret
= year
+ "/" + month + "/" + day
;
399 ret
+= " " + hmsString_(hh
, mm
, ss
);
405 * Round a number to the specified number of digits past the decimal point.
406 * @param {number} num The number to round
407 * @param {number} places The number of decimals to which to round
408 * @return {number} The rounded number
411 export function round_(num
, places
) {
412 var shift
= Math
.pow(10, places
);
413 return Math
.round(num
* shift
)/shift
;
417 * Implementation of binary search over an array.
418 * Currently does not work when val is outside the range of arry's values.
419 * @param {number} val the value to search for
420 * @param {Array.<number>} arry is the value over which to search
421 * @param {number} abs If abs > 0, find the lowest entry greater than val
422 * If abs < 0, find the highest entry less than val.
423 * If abs == 0, find the entry that equals val.
424 * @param {number=} low The first index in arry to consider (optional)
425 * @param {number=} high The last index in arry to consider (optional)
426 * @return {number} Index of the element, or -1 if it isn't found.
429 export function binarySearch(val
, arry
, abs
, low
, high
) {
430 if (low
=== null || low
=== undefined
||
431 high
=== null || high
=== undefined
) {
433 high
= arry
.length
- 1;
438 if (abs
=== null || abs
=== undefined
) {
441 var validIndex
= function(idx
) {
442 return idx
>= 0 && idx
< arry
.length
;
444 var mid
= parseInt((low
+ high
) / 2, 10);
445 var element
= arry
[mid
];
447 if (element
== val
) {
449 } else if (element
> val
) {
451 // Accept if element > val, but also if prior element < val.
453 if (validIndex(idx
) && arry
[idx
] < val
) {
457 return binarySearch(val
, arry
, abs
, low
, mid
- 1);
458 } else if (element
< val
) {
460 // Accept if element < val, but also if prior element > val.
462 if (validIndex(idx
) && arry
[idx
] > val
) {
466 return binarySearch(val
, arry
, abs
, mid
+ 1, high
);
468 return -1; // can't actually happen, but makes closure compiler happy
472 * Parses a date, returning the number of milliseconds since epoch. This can be
473 * passed in as an xValueParser in the Dygraph constructor.
474 * TODO(danvk): enumerate formats that this understands.
476 * @param {string} dateStr A date in a variety of possible string formats.
477 * @return {number} Milliseconds since epoch.
480 export function dateParser(dateStr
) {
484 // Let the system try the format first, with one caveat:
485 // YYYY-MM-DD[ HH:MM:SS] is interpreted as UTC by a variety of browsers.
486 // dygraphs displays dates in local time, so this will result in surprising
487 // inconsistencies. But if you specify "T" or "Z" (i.e. YYYY-MM-DDTHH:MM:SS),
488 // then you probably know what you're doing, so we'll let you go ahead.
489 // Issue: http://code.google.com/p/dygraphs/issues/detail
?id
=255
490 if (dateStr
.search("-") == -1 ||
491 dateStr
.search("T") != -1 || dateStr
.search("Z") != -1) {
492 d
= dateStrToMillis(dateStr
);
493 if (d
&& !isNaN(d
)) return d
;
496 if (dateStr
.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
497 dateStrSlashed
= dateStr
.replace("-", "/", "g");
498 while (dateStrSlashed
.search("-") != -1) {
499 dateStrSlashed
= dateStrSlashed
.replace("-", "/");
501 d
= dateStrToMillis(dateStrSlashed
);
502 } else if (dateStr
.length
== 8) { // e.g. '20090712'
503 // TODO(danvk): remove support for this format. It's confusing.
504 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
506 d
= dateStrToMillis(dateStrSlashed
);
508 // Any format that Date.parse will accept, e.g. "2009/07/12" or
509 // "2009/07/12 12:34:56"
510 d
= dateStrToMillis(dateStr
);
513 if (!d
|| isNaN(d
)) {
514 console
.error("Couldn't parse " + dateStr
+ " as a date");
520 * This is identical to JavaScript's built-in Date.parse() method, except that
521 * it doesn't get replaced with an incompatible method by aggressive JS
522 * libraries like MooTools or Joomla.
523 * @param {string} str The date string, e.g. "2011/05/06"
524 * @return {number} millis since epoch
527 export function dateStrToMillis(str
) {
528 return new Date(str
).getTime();
531 // These functions are all based on MochiKit.
533 * Copies all the properties from o to self.
535 * @param {!Object} self
539 export function update(self
, o
) {
540 if (typeof(o
) != 'undefined' && o
!== null) {
542 if (o
.hasOwnProperty(k
)) {
551 * Copies all the properties from o to self.
553 * @param {!Object} self
558 export function updateDeep(self
, o
) {
559 // Taken from http://stackoverflow.com/questions
/384286/javascript
-isdom
-how
-do-you
-check
-if-a
-javascript
-object
-is
-a
-dom
-object
562 typeof Node
=== "object" ? o
instanceof Node
:
563 typeof o
=== "object" && typeof o
.nodeType
=== "number" && typeof o
.nodeName
==="string"
567 if (typeof(o
) != 'undefined' && o
!== null) {
569 if (o
.hasOwnProperty(k
)) {
572 } else if (isArrayLike(o
[k
])) {
573 self
[k
] = o
[k
].slice();
574 } else if (isNode(o
[k
])) {
575 // DOM objects are shallowly-copied.
577 } else if (typeof(o
[k
]) == 'object') {
578 if (typeof(self
[k
]) != 'object' || self
[k
] === null) {
581 updateDeep(self
[k
], o
[k
]);
596 export function isArrayLike(o
) {
599 (typ
!= 'object' && !(typ
== 'function' &&
600 typeof(o
.item
) == 'function')) ||
602 typeof(o
.length
) != 'number' ||
615 export function isDateLike(o
) {
616 if (typeof(o
) != "object" || o
=== null ||
617 typeof(o
.getTime
) != 'function') {
624 * Note: this only seems to work for arrays.
629 export function clone(o
) {
630 // TODO(danvk): figure out how MochiKit's version works
632 for (var i
= 0; i
< o
.length
; i
++) {
633 if (isArrayLike(o
[i
])) {
643 * Create a new canvas element.
645 * @return {!HTMLCanvasElement}
648 export function createCanvas() {
649 return document
.createElement('canvas');
653 * Returns the context's pixel ratio, which is the ratio between the device
654 * pixel ratio and the backing store ratio. Typically this is 1 for conventional
655 * displays, and > 1 for HiDPI displays (such as the Retina MBP).
656 * See http://www.html5rocks.com/en/tutorials/canvas/hidpi/ for more details.
658 * @param {!CanvasRenderingContext2D} context The canvas's 2d context.
659 * @return {number} The ratio of the device pixel ratio and the backing store
660 * ratio for the specified context.
662 export function getContextPixelRatio(context
) {
664 var devicePixelRatio
= window
.devicePixelRatio
;
665 var backingStoreRatio
= context
.webkitBackingStorePixelRatio
||
666 context
.mozBackingStorePixelRatio
||
667 context
.msBackingStorePixelRatio
||
668 context
.oBackingStorePixelRatio
||
669 context
.backingStorePixelRatio
|| 1;
670 if (devicePixelRatio
!== undefined
) {
671 return devicePixelRatio
/ backingStoreRatio
;
673 // At least devicePixelRatio must be defined for this ratio to make sense.
674 // We default backingStoreRatio to 1: this does not exist on some browsers
675 // (i.e. desktop Chrome).
684 * Checks whether the user is on an Android browser.
685 * Android does not fully support the <canvas> tag, e.g. w/r/t/ clipping.
689 export function isAndroid() {
690 return (/Android/).test(navigator
.userAgent
);
695 * TODO(danvk): use @template here when it's better supported for classes.
696 * @param {!Array} array
697 * @param {number} start
698 * @param {number} length
699 * @param {function(!Array,?):boolean=} predicate
702 export function Iterator(array
, start
, length
, predicate
) {
704 length
= length
|| array
.length
;
705 this.hasNext
= true; // Use to identify if there's another element.
706 this.peek
= null; // Use for look-ahead
709 this.predicate_
= predicate
;
710 this.end_
= Math
.min(array
.length
, start
+ length
);
711 this.nextIdx_
= start
- 1; // use -1 so initial advance works.
712 this.next(); // ignoring result.
718 Iterator
.prototype.next
= function() {
724 var nextIdx
= this.nextIdx_
+ 1;
726 while (nextIdx
< this.end_
) {
727 if (!this.predicate_
|| this.predicate_(this.array_
, nextIdx
)) {
728 this.peek
= this.array_
[nextIdx
];
734 this.nextIdx_
= nextIdx
;
736 this.hasNext
= false;
743 * Returns a new iterator over array, between indexes start and
744 * start + length, and only returns entries that pass the accept function
746 * @param {!Array} array the array to iterate over.
747 * @param {number} start the first index to iterate over, 0 if absent.
748 * @param {number} length the number of elements in the array to iterate over.
749 * This, along with start, defines a slice of the array, and so length
750 * doesn't imply the number of elements in the iterator when accept doesn't
751 * always accept all values. array.length when absent.
752 * @param {function(?):boolean=} opt_predicate a function that takes
753 * parameters array and idx, which returns true when the element should be
754 * returned. If omitted, all elements are accepted.
757 export function createIterator(array
, start
, length
, opt_predicate
) {
758 return new Iterator(array
, start
, length
, opt_predicate
);
761 // Shim layer with setTimeout fallback.
762 // From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
763 // Should be called with the window context:
764 // Dygraph.requestAnimFrame.call(window, function() {})
765 export var requestAnimFrame
= (function() {
766 return window
.requestAnimationFrame
||
767 window
.webkitRequestAnimationFrame
||
768 window
.mozRequestAnimationFrame
||
769 window
.oRequestAnimationFrame
||
770 window
.msRequestAnimationFrame
||
771 function (callback
) {
772 window
.setTimeout(callback
, 1000 / 60);
777 * Call a function at most maxFrames times at an attempted interval of
778 * framePeriodInMillis, then call a cleanup function once. repeatFn is called
779 * once immediately, then at most (maxFrames - 1) times asynchronously. If
780 * maxFrames==1, then cleanup_fn() is also called synchronously. This function
781 * is used to sequence animation.
782 * @param {function(number)} repeatFn Called repeatedly -- takes the frame
783 * number (from 0 to maxFrames-1) as an argument.
784 * @param {number} maxFrames The max number of times to call repeatFn
785 * @param {number} framePeriodInMillis Max requested time between frames.
786 * @param {function()} cleanupFn A function to call after all repeatFn calls.
789 export function repeatAndCleanup(repeatFn
, maxFrames
, framePeriodInMillis
,
792 var previousFrameNumber
;
793 var startTime
= new Date().getTime();
794 repeatFn(frameNumber
);
795 if (maxFrames
== 1) {
799 var maxFrameArg
= maxFrames
- 1;
802 if (frameNumber
>= maxFrames
) return;
803 requestAnimFrame
.call(window
, function() {
804 // Determine which frame to draw based on the delay so far. Will skip
805 // frames if necessary.
806 var currentTime
= new Date().getTime();
807 var delayInMillis
= currentTime
- startTime
;
808 previousFrameNumber
= frameNumber
;
809 frameNumber
= Math
.floor(delayInMillis
/ framePeriodInMillis
);
810 var frameDelta
= frameNumber
- previousFrameNumber
;
811 // If we predict that the subsequent repeatFn call will overshoot our
812 // total frame target, so our last call will cause a stutter, then jump to
813 // the last call immediately. If we're going to cause a stutter, better
814 // to do it faster than slower.
815 var predictOvershootStutter
= (frameNumber
+ frameDelta
) > maxFrameArg
;
816 if (predictOvershootStutter
|| (frameNumber
>= maxFrameArg
)) {
817 repeatFn(maxFrameArg
); // Ensure final call with maxFrameArg.
820 if (frameDelta
!== 0) { // Don't call repeatFn with duplicate frames.
821 repeatFn(frameNumber
);
829 // A whitelist of options that do not change pixel positions.
830 var pixelSafeOptions
= {
831 'annotationClickHandler': true,
832 'annotationDblClickHandler': true,
833 'annotationMouseOutHandler': true,
834 'annotationMouseOverHandler': true,
835 'axisLabelColor': true,
836 'axisLineColor': true,
837 'axisLineWidth': true,
838 'clickCallback': true,
839 'drawCallback': true,
840 'drawHighlightPointCallback': true,
842 'drawPointCallback': true,
845 'gridLineColor': true,
846 'gridLineWidth': true,
847 'hideOverlayOnMouseOut': true,
848 'highlightCallback': true,
849 'highlightCircleSize': true,
850 'interactionModel': true,
851 'isZoomedIgnoreProgrammaticZoom': true,
853 'labelsDivStyles': true,
854 'labelsDivWidth': true,
857 'labelsSeparateLines': true,
858 'labelsShowZeroValues': true,
860 'panEdgeFraction': true,
861 'pixelsPerYLabel': true,
862 'pointClickCallback': true,
864 'rangeSelectorPlotFillColor': true,
865 'rangeSelectorPlotFillGradientColor': true,
866 'rangeSelectorPlotStrokeColor': true,
867 'rangeSelectorBackgroundStrokeColor': true,
868 'rangeSelectorBackgroundLineWidth': true,
869 'rangeSelectorPlotLineWidth': true,
870 'rangeSelectorForegroundStrokeColor': true,
871 'rangeSelectorForegroundLineWidth': true,
872 'rangeSelectorAlpha': true,
873 'showLabelsOnHighlight': true,
876 'underlayCallback': true,
877 'unhighlightCallback': true,
882 * This function will scan the option list and determine if they
883 * require us to recalculate the pixel positions of each point.
884 * TODO: move this into dygraph-options.js
885 * @param {!Array.<string>} labels a list of options to check.
886 * @param {!Object} attrs
887 * @return {boolean} true if the graph needs new points else false.
890 export function isPixelChangingOptionList(labels
, attrs
) {
891 // Assume that we do not require new points.
892 // This will change to true if we actually do need new points.
894 // Create a dictionary of series names for faster lookup.
895 // If there are no labels, then the dictionary stays empty.
896 var seriesNamesDictionary
= { };
898 for (var i
= 1; i
< labels
.length
; i
++) {
899 seriesNamesDictionary
[labels
[i
]] = true;
903 // Scan through a flat (i.e. non-nested) object of options.
904 // Returns true/false depending on whether
new points are needed
.
905 var scanFlatOptions
= function(options
) {
906 for (var property
in options
) {
907 if (options
.hasOwnProperty(property
) &&
908 !pixelSafeOptions
[property
]) {
915 // Iterate through the list of updated options.
916 for (var property
in attrs
) {
917 if (!attrs
.hasOwnProperty(property
)) continue;
919 // Find out of this field is actually a series specific options list.
920 if (property
== 'highlightSeriesOpts' ||
921 (seriesNamesDictionary
[property
] && !attrs
.series
)) {
922 // This property value is a list of options for this series.
923 if (scanFlatOptions(attrs
[property
])) return true;
924 } else if (property
== 'series' || property
== 'axes') {
925 // This is twice-nested options list.
926 var perSeries
= attrs
[property
];
927 for (var series
in perSeries
) {
928 if (perSeries
.hasOwnProperty(series
) &&
929 scanFlatOptions(perSeries
[series
])) {
934 // If this was not a series specific option list, check if it's a pixel
935 // changing property.
936 if (!pixelSafeOptions
[property
]) return true;
943 export var Circles
= {
944 DEFAULT
: function(g
, name
, ctx
, canvasx
, canvasy
, color
, radius
) {
946 ctx
.fillStyle
= color
;
947 ctx
.arc(canvasx
, canvasy
, radius
, 0, 2 * Math
.PI
, false);
950 // For more shapes, include extras/shapes.js
954 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
955 * @param {string} data
956 * @return {?string} the delimiter that was detected (or null on failure).
958 export function detectLineDelimiter(data
) {
959 for (var i
= 0; i
< data
.length
; i
++) {
960 var code
= data
.charAt(i
);
962 // Might actually be "\r\n".
963 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\n')) {
969 // Might actually be "\n\r".
970 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\r')) {
981 * Is one node contained by another?
982 * @param {Node} containee The contained node.
983 * @param {Node} container The container node.
984 * @return {boolean} Whether containee is inside (or equal to) container.
987 export function isNodeContainedBy(containee
, container
) {
988 if (container
=== null || containee
=== null) {
991 var containeeNode
= /** @type {Node} */ (containee
);
992 while (containeeNode
&& containeeNode
!== container
) {
993 containeeNode
= containeeNode
.parentNode
;
995 return (containeeNode
=== container
);
998 // This masks some numeric issues in older versions of Firefox,
999 // where 1.0/Math
.pow(10,2) != Math
.pow(10,-2).
1000 /** @type {function(number,number):number} */
1001 export function pow(base
, exp
) {
1003 return 1.0 / Math
.pow(base
, -exp
);
1005 return Math
.pow(base
, exp
);
1008 var RGBA_RE
= /^rgba?\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})(?:,\s*([01](?:\.\d+)?))?\)$/;
1011 * Helper for toRGB_ which parses strings of the form:
1013 * rgba(123, 45, 67, 0.5)
1014 * @return parsed {r,g,b,a?} tuple or null.
1016 function parseRGBA(rgbStr
) {
1017 var bits
= RGBA_RE
.exec(rgbStr
);
1018 if (!bits
) return null;
1019 var r
= parseInt(bits
[1], 10),
1020 g
= parseInt(bits
[2], 10),
1021 b
= parseInt(bits
[3], 10);
1023 return {r
: r
, g
: g
, b
: b
, a
: parseFloat(bits
[4])};
1025 return {r
: r
, g
: g
, b
: b
};
1030 * Converts any valid CSS color (hex, rgb(), named color) to an RGB tuple.
1032 * @param {!string} colorStr Any valid CSS color string.
1033 * @return {{r:number,g:number,b:number,a:number?}} Parsed RGB tuple.
1036 export function toRGB_(colorStr
) {
1037 // Strategy: First try to parse colorStr directly. This is fast & avoids DOM
1038 // manipulation. If that fails (e.g. for named colors like 'red'), then
1039 // create a hidden DOM element and parse its computed color.
1040 var rgb
= parseRGBA(colorStr
);
1041 if (rgb
) return rgb
;
1043 var div
= document
.createElement('div');
1044 div
.style
.backgroundColor
= colorStr
;
1045 div
.style
.visibility
= 'hidden';
1046 document
.body
.appendChild(div
);
1047 var rgbStr
= window
.getComputedStyle(div
, null).backgroundColor
;
1048 document
.body
.removeChild(div
);
1049 return parseRGBA(rgbStr
);
1053 * Checks whether the browser supports the <canvas> tag.
1054 * @param {HTMLCanvasElement=} opt_canvasElement Pass a canvas element as an
1055 * optimization if you have one.
1056 * @return {boolean} Whether the browser supports canvas.
1058 export function isCanvasSupported(opt_canvasElement
) {
1060 var canvas
= opt_canvasElement
|| document
.createElement("canvas");
1061 canvas
.getContext("2d");
1069 * Parses the value as a floating point number. This is like the parseFloat()
1070 * built-in, but with a few differences:
1071 * - the empty string is parsed as null, rather than NaN.
1072 * - if the string cannot be parsed at all, an error is logged.
1073 * If the string can't be parsed, this method returns null.
1074 * @param {string} x The string to be parsed
1075 * @param {number=} opt_line_no The line number from which the string comes.
1076 * @param {string=} opt_line The text of the line from which the string comes.
1078 export function parseFloat_(x
, opt_line_no
, opt_line
) {
1079 var val
= parseFloat(x
);
1080 if (!isNaN(val
)) return val
;
1082 // Try to figure out what happeend.
1083 // If the value is the empty string, parse it as null.
1084 if (/^ *$/.test(x
)) return null;
1086 // If it was actually "NaN", return it as NaN.
1087 if (/^ *nan *$/i.test(x
)) return NaN
;
1089 // Looks like a parsing error.
1090 var msg
= "Unable to parse '" + x
+ "' as a number";
1091 if (opt_line
!== undefined
&& opt_line_no
!== undefined
) {
1092 msg
+= " on line " + (1+(opt_line_no
||0)) + " ('" + opt_line
+ "') of CSV.";
1100 // Label constants for the labelsKMB and labelsKMG2 options.
1101 // (i.e. '100000' -> '100K')
1102 var KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
1103 var KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
1104 var KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
1108 * Return a string version of a number. This respects the digitsAfterDecimal
1109 * and maxNumberWidth options.
1110 * @param {number} x The number to be formatted
1111 * @param {Dygraph} opts An options view
1113 export function numberValueFormatter(x
, opts
) {
1114 var sigFigs
= opts('sigFigs');
1116 if (sigFigs
!== null) {
1117 // User has opted for a fixed number of significant figures.
1118 return floatFormat(x
, sigFigs
);
1121 var digits
= opts('digitsAfterDecimal');
1122 var maxNumberWidth
= opts('maxNumberWidth');
1124 var kmb
= opts('labelsKMB');
1125 var kmg2
= opts('labelsKMG2');
1129 // switch to scientific notation if we underflow or overflow fixed display.
1131 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
1132 Math
.abs(x
) < Math
.pow(10, -digits
))) {
1133 label
= x
.toExponential(digits
);
1135 label
= '' + round_(x
, digits
);
1144 k_labels
= KMB_LABELS
;
1147 if (kmb
) console
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
1149 k_labels
= KMG2_BIG_LABELS
;
1150 m_labels
= KMG2_SMALL_LABELS
;
1153 var absx
= Math
.abs(x
);
1154 var n
= pow(k
, k_labels
.length
);
1155 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
1157 label
= round_(x
/ n
, digits
) + k_labels
[j
];
1162 // TODO(danvk): clean up this logic. Why so different than kmb?
1163 var x_parts
= String(x
.toExponential()).split('e-');
1164 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
1165 if (x_parts
[1] % 3 > 0) {
1166 label
= round_(x_parts
[0] /
1167 pow(10, (x_parts
[1] % 3)),
1170 label
= Number(x_parts
[0]).toFixed(2);
1172 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
1181 * variant for use as an axisLabelFormatter.
1184 export function numberAxisLabelFormatter(x
, granularity
, opts
) {
1185 return numberValueFormatter
.call(this, x
, opts
);
1189 * @type {!Array.<string>}
1193 var SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
1197 * Convert a JS date to a string appropriate to display on an axis that
1198 * is displaying values at the stated granularity. This respects the
1200 * @param {Date} date The date to format
1201 * @param {number} granularity One of the Dygraph granularity constants
1202 * @param {Dygraph} opts An options view
1203 * @return {string} The date formatted as local time
1206 export function dateAxisLabelFormatter(date
, granularity
, opts
) {
1207 var utc
= opts('labelsUTC');
1208 var accessors
= utc
? DateAccessorsUTC
: DateAccessorsLocal
;
1210 var year
= accessors
.getFullYear(date
),
1211 month
= accessors
.getMonth(date
),
1212 day
= accessors
.getDate(date
),
1213 hours
= accessors
.getHours(date
),
1214 mins
= accessors
.getMinutes(date
),
1215 secs
= accessors
.getSeconds(date
),
1216 millis
= accessors
.getSeconds(date
);
1218 if (granularity
>= DygraphTickers
.Granularity
.DECADAL
) {
1220 } else if (granularity
>= DygraphTickers
.Granularity
.MONTHLY
) {
1221 return SHORT_MONTH_NAMES_
[month
] + ' ' + year
;
1223 var frac
= hours
* 3600 + mins
* 60 + secs
+ 1e-3 * millis
;
1224 if (frac
=== 0 || granularity
>= DygraphTickers
.Granularity
.DAILY
) {
1225 // e.g. '21 Jan' (%d%b)
1226 return zeropad(day
) + ' ' + SHORT_MONTH_NAMES_
[month
];
1228 return hmsString_(hours
, mins
, secs
);
1232 // alias in case anyone is referencing the old method.
1233 // Dygraph.dateAxisFormatter = Dygraph.dateAxisLabelFormatter;
1236 * Return a string version of a JS date for a value label. This respects the
1238 * @param {Date} date The date to be formatted
1239 * @param {Dygraph} opts An options view
1242 export function dateValueFormatter(d
, opts
) {
1243 return dateString_(d
, opts('labelsUTC'));