2732 lines
72 KiB
JavaScript
2732 lines
72 KiB
JavaScript
/* *
|
|
*
|
|
* (c) 2010-2018 Torstein Honsi
|
|
*
|
|
* License: www.highcharts.com/license
|
|
*
|
|
* */
|
|
|
|
/**
|
|
* Reference to the global SVGElement class as a workaround for a name conflict
|
|
* in the Highcharts namespace.
|
|
*
|
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/SVGElement
|
|
*
|
|
* @global
|
|
* @typedef {global.SVGElement} GlobalSVGElement
|
|
*/
|
|
|
|
/**
|
|
* An animation configuration. Animation configurations can also be defined as
|
|
* booleans, where `false` turns off animation and `true` defaults to a duration
|
|
* of 500ms.
|
|
*
|
|
* @interface Highcharts.AnimationOptionsObject
|
|
*//**
|
|
* A callback function to exectute when the animation finishes.
|
|
* @name Highcharts.AnimationOptionsObject#complete
|
|
* @type {Function|undefined}
|
|
*//**
|
|
* The animation duration in milliseconds.
|
|
* @name Highcharts.AnimationOptionsObject#duration
|
|
* @type {number}
|
|
*//**
|
|
* The name of an easing function as defined on the `Math` object.
|
|
* @name Highcharts.AnimationOptionsObject#easing
|
|
* @type {string|undefined}
|
|
*//**
|
|
* A callback function to execute on each step of each attribute or CSS property
|
|
* that's being animated. The first argument contains information about the
|
|
* animation and progress.
|
|
* @name Highcharts.AnimationOptionsObject#step
|
|
* @type {Function|undefined}
|
|
*/
|
|
|
|
/**
|
|
* A style object with camel case property names to define visual appearance of
|
|
* a SVG element or HTML element. The properties can be whatever styles are
|
|
* supported on the given SVG or HTML element.
|
|
*
|
|
* @example
|
|
* {
|
|
* fontFamily: 'monospace',
|
|
* fontSize: '1.2em'
|
|
* }
|
|
*
|
|
* @interface Highcharts.CSSObject
|
|
*//**
|
|
* @name Highcharts.CSSObject#[key:string]
|
|
* @type {boolean|number|string|undefined}
|
|
*//**
|
|
* Background style for the element.
|
|
* @name Highcharts.CSSObject#background
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Background color of the element.
|
|
* @name Highcharts.CSSObject#backgroundColor
|
|
* @type {Highcharts.ColorString|undefined}
|
|
*//**
|
|
* Border style for the element.
|
|
* @name Highcharts.CSSObject#border
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Radius of the element border.
|
|
* @name Highcharts.CSSObject#borderRadius
|
|
* @type {number|undefined}
|
|
*//**
|
|
* Color used in the element. The "contrast" option is a Highcharts custom
|
|
* property that results in black or white, depending on the background of the
|
|
* element.
|
|
* @name Highcharts.CSSObject#color
|
|
* @type {"contrast"|Highcharts.ColorString|undefined}
|
|
*//**
|
|
* Style of the mouse cursor when resting over the element.
|
|
* @name Highcharts.CSSObject#cursor
|
|
* @type {Highcharts.CursorType|undefined}
|
|
*//**
|
|
* Font family of the element text. Multiple values have to be in decreasing
|
|
* preference order and separated by comma.
|
|
* @name Highcharts.CSSObject#fontFamily
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Font size of the element text.
|
|
* @name Highcharts.CSSObject#fontSize
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Font weight of the element text.
|
|
* @name Highcharts.CSSObject#fontWeight
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Height of the element.
|
|
* @name Highcharts.CSSObject#height
|
|
* @type {number|undefined}
|
|
*//**
|
|
* Width of the element border.
|
|
* @name Highcharts.CSSObject#lineWidth
|
|
* @type {number|undefined}
|
|
*//**
|
|
* Opacity of the element.
|
|
* @name Highcharts.CSSObject#opacity
|
|
* @type {number|undefined}
|
|
*//**
|
|
* Space around the element content.
|
|
* @name Highcharts.CSSObject#padding
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Behaviour of the element when the mouse cursor rests over it.
|
|
* @name Highcharts.CSSObject#pointerEvents
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Positioning of the element.
|
|
* @name Highcharts.CSSObject#position
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Alignment of the element text.
|
|
* @name Highcharts.CSSObject#textAlign
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Outline style of the element text.
|
|
* @name Highcharts.CSSObject#textOutline
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Additional decoration of the element text.
|
|
* @name Highcharts.CSSObject#textDecoration
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Line break style of the element text. Highcharts SVG elements support
|
|
* `ellipsis` when a `width` is set.
|
|
* @name Highcharts.CSSObject#textOverflow
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Top spacing of the element relative to the parent element.
|
|
* @name Highcharts.CSSObject#top
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Animated transition of selected element properties.
|
|
* @name Highcharts.CSSObject#transition
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Line break style of the element text.
|
|
* @name Highcharts.CSSObject#whiteSpace
|
|
* @type {string|undefined}
|
|
*//**
|
|
* Width of the element.
|
|
* @name Highcharts.CSSObject#width
|
|
* @type {number|undefined}
|
|
*/
|
|
|
|
/**
|
|
* All possible cursor styles.
|
|
*
|
|
* @typedef {"alias"|"all-scroll"|"auto"|"cell"|"col-resize"|"context-menu"|"copy"|"crosshair"|"default"|"e-resize"|"ew-resize"|"grab"|"grabbing"|"help"|"move"|"n-resize"|"ne-resize"|"nesw-resize"|"no-drop"|"none"|"not-allowed"|"ns-resize"|"nw-resize"|"nwse-resize"|"pointer"|"progress"|"row-resize"|"s-resize"|"se-resize"|"sw-resize"|"text"|"vertical-text"|"w-resize"|"wait"|"zoom-in"|"zoom-out"} Highcharts.CursorType
|
|
*/
|
|
|
|
/**
|
|
* Generic dictionary in TypeScript notation.
|
|
*
|
|
* @interface Highcharts.Dictionary<T>
|
|
*//**
|
|
* @name Highcharts.Dictionary<T>#[key:string]
|
|
* @type {T}
|
|
*/
|
|
|
|
/**
|
|
* The function callback to execute when the event is fired. The `this` context
|
|
* contains the instance, that fired the event.
|
|
*
|
|
* @callback Highcharts.EventCallbackFunction<T>
|
|
*
|
|
* @param {T} this
|
|
*
|
|
* @param {Highcharts.Dictionary<*>} [eventArguments]
|
|
* Event arguments.
|
|
*/
|
|
|
|
/**
|
|
* Formats data as a string. Usually the data is accessible throught the `this`
|
|
* keyword.
|
|
*
|
|
* @callback Highcharts.FormatterCallbackFunction<T>
|
|
*
|
|
* @param {T} this
|
|
*
|
|
* @return {string}
|
|
*/
|
|
|
|
/**
|
|
* An object of key-value pairs for HTML attributes.
|
|
*
|
|
* @typedef {Highcharts.Dictionary<boolean|number|string>} Highcharts.HTMLAttributes
|
|
*/
|
|
|
|
/**
|
|
* An HTML DOM element. The type is a reference to the regular HTMLElement in
|
|
* the global scope.
|
|
*
|
|
* @typedef {global.HTMLElement} Highcharts.HTMLDOMElement
|
|
*
|
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement
|
|
*/
|
|
|
|
/**
|
|
* The iterator callback.
|
|
*
|
|
* @callback Highcharts.ObjectEachCallbackFunction
|
|
*
|
|
* @param {*} value
|
|
* The property value.
|
|
*
|
|
* @param {string} key
|
|
* The property key.
|
|
*
|
|
* @param {*} obj
|
|
* The object that objectEach is being applied to.
|
|
*/
|
|
|
|
/**
|
|
* An object containing `left` and `top` properties for the position in the
|
|
* page.
|
|
*
|
|
* @interface Highcharts.OffsetObject
|
|
*//**
|
|
* Left distance to the page border.
|
|
* @name Highcharts.OffsetObject#left
|
|
* @type {number}
|
|
*//**
|
|
* Top distance to the page border.
|
|
* @name Highcharts.OffsetObject#top
|
|
* @type {number}
|
|
*/
|
|
|
|
/**
|
|
* An object containing `x` and `y` properties for the position of an element.
|
|
*
|
|
* @interface Highcharts.PositionObject
|
|
*//**
|
|
* X position of the element.
|
|
* @name Highcharts.PositionObject#x
|
|
* @type {number}
|
|
*//**
|
|
* Y position of the element.
|
|
* @name Highcharts.PositionObject#y
|
|
* @type {number}
|
|
*/
|
|
|
|
/**
|
|
* If a number is given, it defines the pixel length. If a percentage string is
|
|
* given, like for example `'50%'`, the setting defines a length relative to a
|
|
* base size, for example the size of a container.
|
|
*
|
|
* @typedef {number|string} Highcharts.RelativeSize
|
|
*/
|
|
|
|
/**
|
|
* An object of key-value pairs for SVG attributes. Attributes in Highcharts
|
|
* elements for the most parts correspond to SVG, but some are specific to
|
|
* Highcharts, like `zIndex`, `rotation`, `rotationOriginX`,
|
|
* `rotationOriginY`, `translateX`, `translateY`, `scaleX` and `scaleY`. SVG
|
|
* attributes containing a hyphen are _not_ camel-cased, they should be
|
|
* quoted to preserve the hyphen.
|
|
*
|
|
* @example
|
|
* {
|
|
* 'stroke': '#ff0000', // basic
|
|
* 'stroke-width': 2, // hyphenated
|
|
* 'rotation': 45 // custom
|
|
* 'd': ['M', 10, 10, 'L', 30, 30, 'z'] // path definition, note format
|
|
* }
|
|
*
|
|
* @interface Highcharts.SVGAttributes
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#[key:string]
|
|
* @type {boolean|number|string|Array<number|string>|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#d
|
|
* @type {string|Highcharts.SVGPathArray|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#inverted
|
|
* @type {boolean|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#matrix
|
|
* @type {Array<number>|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#stroke
|
|
* @type {Highcharts.ColorString|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#rotation
|
|
* @type {string|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#rotationOriginX
|
|
* @type {number|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#rotationOriginY
|
|
* @type {number|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#scaleX
|
|
* @type {number|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#scaleY
|
|
* @type {number|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#translateX
|
|
* @type {number|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#translateY
|
|
* @type {number|undefined}
|
|
*//**
|
|
* @name Highcharts.SVGAttributes#zIndex
|
|
* @type {number|undefined}
|
|
*/
|
|
|
|
/**
|
|
* An SVG DOM element. The type is a reference to the regular SVGElement in the
|
|
* global scope.
|
|
*
|
|
* @typedef {globals.GlobalSVGElement} Highcharts.SVGDOMElement
|
|
*
|
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/SVGElement
|
|
*/
|
|
|
|
/**
|
|
* Array of path commands, that will go into the `d` attribute of an SVG
|
|
* element.
|
|
*
|
|
* @typedef {Array<number|Highcharts.SVGPathCommand>} Highcharts.SVGPathArray
|
|
*/
|
|
|
|
/**
|
|
* Possible path commands in a SVG path array.
|
|
*
|
|
* @typedef {string} Highcharts.SVGPathCommand
|
|
* @validvalue ["a","c","h","l","m","q","s","t","v","z","A","C","H","L","M","Q","S","T","V","Z"]
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
import H from './Globals.js';
|
|
|
|
/**
|
|
* The Highcharts object is the placeholder for all other members, and various
|
|
* utility functions. The most important member of the namespace would be the
|
|
* chart constructor.
|
|
*
|
|
* @example
|
|
* var chart = Highcharts.chart('container', { ... });
|
|
*
|
|
* @namespace Highcharts
|
|
*/
|
|
|
|
H.timers = [];
|
|
|
|
var charts = H.charts,
|
|
doc = H.doc,
|
|
win = H.win;
|
|
|
|
/**
|
|
* Provide error messages for debugging, with links to online explanation. This
|
|
* function can be overridden to provide custom error handling.
|
|
*
|
|
* @sample highcharts/chart/highcharts-error/
|
|
* Custom error handler
|
|
*
|
|
* @function Highcharts.error
|
|
*
|
|
* @param {number|string} code
|
|
* The error code. See
|
|
* [errors.xml](https://github.com/highcharts/highcharts/blob/master/errors/errors.xml)
|
|
* for available codes. If it is a string, the error message is printed
|
|
* directly in the console.
|
|
*
|
|
* @param {boolean} [stop=false]
|
|
* Whether to throw an error or just log a warning in the console.
|
|
*/
|
|
H.error = function (code, stop, chart) {
|
|
var msg = H.isNumber(code) ?
|
|
'Highcharts error #' + code + ': www.highcharts.com/errors/' + code :
|
|
code;
|
|
if (chart) {
|
|
H.fireEvent(chart, 'displayError', { code: code });
|
|
}
|
|
if (stop) {
|
|
throw new Error(msg);
|
|
}
|
|
// else ...
|
|
if (win.console) {
|
|
console.log(msg); // eslint-disable-line no-console
|
|
}
|
|
};
|
|
|
|
/**
|
|
* An animator object used internally. One instance applies to one property
|
|
* (attribute or style prop) on one element. Animation is always initiated
|
|
* through {@link SVGElement#animate}.
|
|
*
|
|
* @example
|
|
* var rect = renderer.rect(0, 0, 10, 10).add();
|
|
* rect.animate({ width: 100 });
|
|
*
|
|
* @private
|
|
* @class Highcharts.Fx
|
|
*
|
|
* @param {Highcharts.HTMLDOMElement|Highcharts.SVGElement} elem
|
|
* The element to animate.
|
|
*
|
|
* @param {Highcharts.AnimationOptionsObject} options
|
|
* Animation options.
|
|
*
|
|
* @param {string} prop
|
|
* The single attribute or CSS property to animate.
|
|
*/
|
|
H.Fx = function (elem, options, prop) {
|
|
this.options = options;
|
|
this.elem = elem;
|
|
this.prop = prop;
|
|
};
|
|
H.Fx.prototype = {
|
|
|
|
/**
|
|
* Set the current step of a path definition on SVGElement.
|
|
*
|
|
* @function Highcharts.Fx#dSetter
|
|
*/
|
|
dSetter: function () {
|
|
var start = this.paths[0],
|
|
end = this.paths[1],
|
|
ret = [],
|
|
now = this.now,
|
|
i = start.length,
|
|
startVal;
|
|
|
|
// Land on the final path without adjustment points appended in the ends
|
|
if (now === 1) {
|
|
ret = this.toD;
|
|
|
|
} else if (i === end.length && now < 1) {
|
|
while (i--) {
|
|
startVal = parseFloat(start[i]);
|
|
ret[i] =
|
|
isNaN(startVal) ? // a letter instruction like M or L
|
|
end[i] :
|
|
now * (parseFloat(end[i] - startVal)) + startVal;
|
|
|
|
}
|
|
// If animation is finished or length not matching, land on right value
|
|
} else {
|
|
ret = end;
|
|
}
|
|
this.elem.attr('d', ret, null, true);
|
|
},
|
|
|
|
/**
|
|
* Update the element with the current animation step.
|
|
*
|
|
* @function Highcharts.Fx#update
|
|
*/
|
|
update: function () {
|
|
var elem = this.elem,
|
|
prop = this.prop, // if destroyed, it is null
|
|
now = this.now,
|
|
step = this.options.step;
|
|
|
|
// Animation setter defined from outside
|
|
if (this[prop + 'Setter']) {
|
|
this[prop + 'Setter']();
|
|
|
|
// Other animations on SVGElement
|
|
} else if (elem.attr) {
|
|
if (elem.element) {
|
|
elem.attr(prop, now, null, true);
|
|
}
|
|
|
|
// HTML styles, raw HTML content like container size
|
|
} else {
|
|
elem.style[prop] = now + this.unit;
|
|
}
|
|
|
|
if (step) {
|
|
step.call(elem, now, this);
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Run an animation.
|
|
*
|
|
* @function Highcharts.Fx#run
|
|
*
|
|
* @param {number} from
|
|
* The current value, value to start from.
|
|
*
|
|
* @param {number} to
|
|
* The end value, value to land on.
|
|
*
|
|
* @param {string} [unit]
|
|
* The property unit, for example `px`.
|
|
*/
|
|
run: function (from, to, unit) {
|
|
var self = this,
|
|
options = self.options,
|
|
timer = function (gotoEnd) {
|
|
return timer.stopped ? false : self.step(gotoEnd);
|
|
},
|
|
requestAnimationFrame =
|
|
win.requestAnimationFrame ||
|
|
function (step) {
|
|
setTimeout(step, 13);
|
|
},
|
|
step = function () {
|
|
for (var i = 0; i < H.timers.length; i++) {
|
|
if (!H.timers[i]()) {
|
|
H.timers.splice(i--, 1);
|
|
}
|
|
}
|
|
|
|
if (H.timers.length) {
|
|
requestAnimationFrame(step);
|
|
}
|
|
};
|
|
|
|
if (from === to && !this.elem['forceAnimate:' + this.prop]) {
|
|
delete options.curAnim[this.prop];
|
|
if (options.complete && Object.keys(options.curAnim).length === 0) {
|
|
options.complete.call(this.elem);
|
|
}
|
|
} else { // #7166
|
|
this.startTime = +new Date();
|
|
this.start = from;
|
|
this.end = to;
|
|
this.unit = unit;
|
|
this.now = this.start;
|
|
this.pos = 0;
|
|
|
|
timer.elem = this.elem;
|
|
timer.prop = this.prop;
|
|
|
|
if (timer() && H.timers.push(timer) === 1) {
|
|
requestAnimationFrame(step);
|
|
}
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Run a single step in the animation.
|
|
*
|
|
* @function Highcharts.Fx#step
|
|
*
|
|
* @param {boolean} [gotoEnd]
|
|
* Whether to go to the endpoint of the animation after abort.
|
|
*
|
|
* @return {boolean}
|
|
* Returns `true` if animation continues.
|
|
*/
|
|
step: function (gotoEnd) {
|
|
var t = +new Date(),
|
|
ret,
|
|
done,
|
|
options = this.options,
|
|
elem = this.elem,
|
|
complete = options.complete,
|
|
duration = options.duration,
|
|
curAnim = options.curAnim;
|
|
|
|
if (elem.attr && !elem.element) { // #2616, element is destroyed
|
|
ret = false;
|
|
|
|
} else if (gotoEnd || t >= duration + this.startTime) {
|
|
this.now = this.end;
|
|
this.pos = 1;
|
|
this.update();
|
|
|
|
curAnim[this.prop] = true;
|
|
|
|
done = true;
|
|
|
|
H.objectEach(curAnim, function (val) {
|
|
if (val !== true) {
|
|
done = false;
|
|
}
|
|
});
|
|
|
|
if (done && complete) {
|
|
complete.call(elem);
|
|
}
|
|
ret = false;
|
|
|
|
} else {
|
|
this.pos = options.easing((t - this.startTime) / duration);
|
|
this.now = this.start + ((this.end - this.start) * this.pos);
|
|
this.update();
|
|
ret = true;
|
|
}
|
|
return ret;
|
|
},
|
|
|
|
/**
|
|
* Prepare start and end values so that the path can be animated one to one.
|
|
*
|
|
* @function Highcharts.Fx#initPath
|
|
*
|
|
* @param {Highcharts.SVGElement} elem
|
|
* The SVGElement item.
|
|
*
|
|
* @param {string} fromD
|
|
* Starting path definition.
|
|
*
|
|
* @param {Highcharts.SVGPathArray} toD
|
|
* Ending path definition.
|
|
*
|
|
* @return {Array<Highcharts.SVGPathArray>}
|
|
* An array containing start and end paths in array form so that
|
|
* they can be animated in parallel.
|
|
*/
|
|
initPath: function (elem, fromD, toD) {
|
|
fromD = fromD || '';
|
|
var shift,
|
|
startX = elem.startX,
|
|
endX = elem.endX,
|
|
bezier = fromD.indexOf('C') > -1,
|
|
numParams = bezier ? 7 : 3,
|
|
fullLength,
|
|
slice,
|
|
i,
|
|
start = fromD.split(' '),
|
|
end = toD.slice(), // copy
|
|
isArea = elem.isArea,
|
|
positionFactor = isArea ? 2 : 1,
|
|
reverse;
|
|
|
|
/**
|
|
* In splines make moveTo and lineTo points have six parameters like
|
|
* bezier curves, to allow animation one-to-one.
|
|
*/
|
|
function sixify(arr) {
|
|
var isOperator,
|
|
nextIsOperator;
|
|
i = arr.length;
|
|
while (i--) {
|
|
|
|
// Fill in dummy coordinates only if the next operator comes
|
|
// three places behind (#5788)
|
|
isOperator = arr[i] === 'M' || arr[i] === 'L';
|
|
nextIsOperator = /[a-zA-Z]/.test(arr[i + 3]);
|
|
if (isOperator && nextIsOperator) {
|
|
arr.splice(
|
|
i + 1, 0,
|
|
arr[i + 1], arr[i + 2],
|
|
arr[i + 1], arr[i + 2]
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Insert an array at the given position of another array
|
|
*/
|
|
function insertSlice(arr, subArr, index) {
|
|
[].splice.apply(
|
|
arr,
|
|
[index, 0].concat(subArr)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* If shifting points, prepend a dummy point to the end path.
|
|
*/
|
|
function prepend(arr, other) {
|
|
while (arr.length < fullLength) {
|
|
|
|
// Move to, line to or curve to?
|
|
arr[0] = other[fullLength - arr.length];
|
|
|
|
// Prepend a copy of the first point
|
|
insertSlice(arr, arr.slice(0, numParams), 0);
|
|
|
|
// For areas, the bottom path goes back again to the left, so we
|
|
// need to append a copy of the last point.
|
|
if (isArea) {
|
|
insertSlice(
|
|
arr,
|
|
arr.slice(arr.length - numParams), arr.length
|
|
);
|
|
i--;
|
|
}
|
|
}
|
|
arr[0] = 'M';
|
|
}
|
|
|
|
/**
|
|
* Copy and append last point until the length matches the end length.
|
|
*/
|
|
function append(arr, other) {
|
|
var i = (fullLength - arr.length) / numParams;
|
|
while (i > 0 && i--) {
|
|
|
|
// Pull out the slice that is going to be appended or inserted.
|
|
// In a line graph, the positionFactor is 1, and the last point
|
|
// is sliced out. In an area graph, the positionFactor is 2,
|
|
// causing the middle two points to be sliced out, since an area
|
|
// path starts at left, follows the upper path then turns and
|
|
// follows the bottom back.
|
|
slice = arr.slice().splice(
|
|
(arr.length / positionFactor) - numParams,
|
|
numParams * positionFactor
|
|
);
|
|
|
|
// Move to, line to or curve to?
|
|
slice[0] = other[fullLength - numParams - (i * numParams)];
|
|
|
|
// Disable first control point
|
|
if (bezier) {
|
|
slice[numParams - 6] = slice[numParams - 2];
|
|
slice[numParams - 5] = slice[numParams - 1];
|
|
}
|
|
|
|
// Now insert the slice, either in the middle (for areas) or at
|
|
// the end (for lines)
|
|
insertSlice(arr, slice, arr.length / positionFactor);
|
|
|
|
if (isArea) {
|
|
i--;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (bezier) {
|
|
sixify(start);
|
|
sixify(end);
|
|
}
|
|
|
|
// For sideways animation, find out how much we need to shift to get the
|
|
// start path Xs to match the end path Xs.
|
|
if (startX && endX) {
|
|
for (i = 0; i < startX.length; i++) {
|
|
// Moving left, new points coming in on right
|
|
if (startX[i] === endX[0]) {
|
|
shift = i;
|
|
break;
|
|
// Moving right
|
|
} else if (startX[0] ===
|
|
endX[endX.length - startX.length + i]) {
|
|
shift = i;
|
|
reverse = true;
|
|
break;
|
|
}
|
|
}
|
|
if (shift === undefined) {
|
|
start = [];
|
|
}
|
|
}
|
|
|
|
if (start.length && H.isNumber(shift)) {
|
|
|
|
// The common target length for the start and end array, where both
|
|
// arrays are padded in opposite ends
|
|
fullLength = end.length + shift * positionFactor * numParams;
|
|
|
|
if (!reverse) {
|
|
prepend(end, start);
|
|
append(start, end);
|
|
} else {
|
|
prepend(start, end);
|
|
append(end, start);
|
|
}
|
|
}
|
|
|
|
return [start, end];
|
|
},
|
|
|
|
/**
|
|
* Handle animation of the color attributes directly.
|
|
*
|
|
* @function Highcharts.Fx#fillSetter
|
|
*/
|
|
fillSetter: function () {
|
|
H.Fx.prototype.strokeSetter.apply(this, arguments);
|
|
},
|
|
|
|
/**
|
|
* Handle animation of the color attributes directly.
|
|
*
|
|
* @function Highcharts.Fx#strokeSetter
|
|
*/
|
|
strokeSetter: function () {
|
|
this.elem.attr(
|
|
this.prop,
|
|
H.color(this.start).tweenTo(H.color(this.end), this.pos),
|
|
null,
|
|
true
|
|
);
|
|
}
|
|
|
|
}; // End of Fx prototype
|
|
|
|
|
|
|
|
/**
|
|
* Utility function to deep merge two or more objects and return a third object.
|
|
* The merge function can also be used with a single object argument to create a
|
|
* deep copy of an object.
|
|
*
|
|
* @function Highcharts.merge
|
|
*
|
|
* @param {*} a
|
|
* The first object to extend. When only this is given, the function
|
|
* returns a deep copy.
|
|
*
|
|
* @param {*} [n]
|
|
* An object to merge into the previous one.
|
|
*
|
|
* @return {*}
|
|
* The merged object. If the first argument is true, the return is the
|
|
* same as the second argument.
|
|
*//**
|
|
* Utility function to deep merge two or more objects and return a third object.
|
|
* If the first argument is true, the contents of the second object is copied
|
|
* into the first object. The merge function can also be used with a single
|
|
* object argument to create a deep copy of an object.
|
|
*
|
|
* @function Highcharts.merge
|
|
*
|
|
* @param {boolean} extend
|
|
* Whether to extend the left-side object (a) or return a whole new
|
|
* object.
|
|
*
|
|
* @param {*} a
|
|
* The first object to extend. When only this is given, the function
|
|
* returns a deep copy.
|
|
*
|
|
* @param {*} [n]
|
|
* An object to merge into the previous one.
|
|
*
|
|
* @return {*}
|
|
* The merged object. If the first argument is true, the return is the
|
|
* same as the second argument.
|
|
*/
|
|
H.merge = function () {
|
|
var i,
|
|
args = arguments,
|
|
len,
|
|
ret = {},
|
|
doCopy = function (copy, original) {
|
|
// An object is replacing a primitive
|
|
if (typeof copy !== 'object') {
|
|
copy = {};
|
|
}
|
|
|
|
H.objectEach(original, function (value, key) {
|
|
|
|
// Copy the contents of objects, but not arrays or DOM nodes
|
|
if (
|
|
H.isObject(value, true) &&
|
|
!H.isClass(value) &&
|
|
!H.isDOMElement(value)
|
|
) {
|
|
copy[key] = doCopy(copy[key] || {}, value);
|
|
|
|
// Primitives and arrays are copied over directly
|
|
} else {
|
|
copy[key] = original[key];
|
|
}
|
|
});
|
|
return copy;
|
|
};
|
|
|
|
// If first argument is true, copy into the existing object. Used in
|
|
// setOptions.
|
|
if (args[0] === true) {
|
|
ret = args[1];
|
|
args = Array.prototype.slice.call(args, 2);
|
|
}
|
|
|
|
// For each argument, extend the return
|
|
len = args.length;
|
|
for (i = 0; i < len; i++) {
|
|
ret = doCopy(ret, args[i]);
|
|
}
|
|
|
|
return ret;
|
|
};
|
|
|
|
/**
|
|
* Shortcut for parseInt
|
|
*
|
|
* @private
|
|
* @function Highcharts.pInt
|
|
*
|
|
* @param {*} s
|
|
*
|
|
* @param {number} mag
|
|
* Magnitude
|
|
*
|
|
* @return {number}
|
|
*/
|
|
H.pInt = function (s, mag) {
|
|
return parseInt(s, mag || 10);
|
|
};
|
|
|
|
/**
|
|
* Utility function to check for string type.
|
|
*
|
|
* @function Highcharts.isString
|
|
*
|
|
* @param {*} s
|
|
* The item to check.
|
|
*
|
|
* @return {boolean}
|
|
* True if the argument is a string.
|
|
*/
|
|
H.isString = function (s) {
|
|
return typeof s === 'string';
|
|
};
|
|
|
|
/**
|
|
* Utility function to check if an item is an array.
|
|
*
|
|
* @function Highcharts.isArray
|
|
*
|
|
* @param {*} obj
|
|
* The item to check.
|
|
*
|
|
* @return {boolean}
|
|
* True if the argument is an array.
|
|
*/
|
|
H.isArray = function (obj) {
|
|
var str = Object.prototype.toString.call(obj);
|
|
return str === '[object Array]' || str === '[object Array Iterator]';
|
|
};
|
|
|
|
/**
|
|
* Utility function to check if an item is of type object.
|
|
*
|
|
* @function Highcharts.isObject
|
|
*
|
|
* @param {*} obj
|
|
* The item to check.
|
|
*
|
|
* @param {boolean} [strict=false]
|
|
* Also checks that the object is not an array.
|
|
*
|
|
* @return {boolean}
|
|
* True if the argument is an object.
|
|
*/
|
|
H.isObject = function (obj, strict) {
|
|
return !!obj && typeof obj === 'object' && (!strict || !H.isArray(obj));
|
|
};
|
|
|
|
/**
|
|
* Utility function to check if an Object is a HTML Element.
|
|
*
|
|
* @function Highcharts.isDOMElement
|
|
*
|
|
* @param {*} obj
|
|
* The item to check.
|
|
*
|
|
* @return {boolean}
|
|
* True if the argument is a HTML Element.
|
|
*/
|
|
H.isDOMElement = function (obj) {
|
|
return H.isObject(obj) && typeof obj.nodeType === 'number';
|
|
};
|
|
|
|
/**
|
|
* Utility function to check if an Object is an class.
|
|
*
|
|
* @function Highcharts.isClass
|
|
*
|
|
* @param {*} obj
|
|
* The item to check.
|
|
*
|
|
* @return {boolean}
|
|
* True if the argument is an class.
|
|
*/
|
|
H.isClass = function (obj) {
|
|
var c = obj && obj.constructor;
|
|
return !!(
|
|
H.isObject(obj, true) &&
|
|
!H.isDOMElement(obj) &&
|
|
(c && c.name && c.name !== 'Object')
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Utility function to check if an item is a number and it is finite (not NaN,
|
|
* Infinity or -Infinity).
|
|
*
|
|
* @function Highcharts.isNumber
|
|
*
|
|
* @param {*} n
|
|
* The item to check.
|
|
*
|
|
* @return {boolean}
|
|
* True if the item is a finite number
|
|
*/
|
|
H.isNumber = function (n) {
|
|
return typeof n === 'number' && !isNaN(n) && n < Infinity && n > -Infinity;
|
|
};
|
|
|
|
/**
|
|
* Remove the last occurence of an item from an array.
|
|
*
|
|
* @function Highcharts.erase
|
|
*
|
|
* @param {Array} arr
|
|
* The array.
|
|
*
|
|
* @param {*} item
|
|
* The item to remove.
|
|
*/
|
|
H.erase = function (arr, item) {
|
|
var i = arr.length;
|
|
while (i--) {
|
|
if (arr[i] === item) {
|
|
arr.splice(i, 1);
|
|
break;
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Check if an object is null or undefined.
|
|
*
|
|
* @function Highcharts.defined
|
|
*
|
|
* @param {*} obj
|
|
* The object to check.
|
|
*
|
|
* @return {boolean}
|
|
* False if the object is null or undefined, otherwise true.
|
|
*/
|
|
H.defined = function (obj) {
|
|
return obj !== undefined && obj !== null;
|
|
};
|
|
|
|
/**
|
|
* Set or get an attribute or an object of attributes. To use as a setter, pass
|
|
* a key and a value, or let the second argument be a collection of keys and
|
|
* values. To use as a getter, pass only a string as the second argument.
|
|
*
|
|
* @function Highcharts.attr
|
|
*
|
|
* @param {Highcharts.HTMLDOMElement|Highcharts.SVGDOMElement} elem
|
|
* The DOM element to receive the attribute(s).
|
|
*
|
|
* @param {string|Highcharts.HTMLAttributes|Highcharts.SVGAttributes} [prop]
|
|
* The property or an object of key-value pairs.
|
|
*
|
|
* @param {string} [value]
|
|
* The value if a single property is set.
|
|
*
|
|
* @return {*}
|
|
* When used as a getter, return the value.
|
|
*/
|
|
H.attr = function (elem, prop, value) {
|
|
var ret;
|
|
|
|
// if the prop is a string
|
|
if (H.isString(prop)) {
|
|
// set the value
|
|
if (H.defined(value)) {
|
|
elem.setAttribute(prop, value);
|
|
|
|
// get the value
|
|
} else if (elem && elem.getAttribute) {
|
|
ret = elem.getAttribute(prop);
|
|
|
|
// IE7 and below cannot get class through getAttribute (#7850)
|
|
if (!ret && prop === 'class') {
|
|
ret = elem.getAttribute(prop + 'Name');
|
|
}
|
|
}
|
|
|
|
// else if prop is defined, it is a hash of key/value pairs
|
|
} else if (H.defined(prop) && H.isObject(prop)) {
|
|
H.objectEach(prop, function (val, key) {
|
|
elem.setAttribute(key, val);
|
|
});
|
|
}
|
|
return ret;
|
|
};
|
|
|
|
/**
|
|
* Check if an element is an array, and if not, make it into an array.
|
|
*
|
|
* @function Highcharts.splat
|
|
*
|
|
* @param {*} obj
|
|
* The object to splat.
|
|
*
|
|
* @return {Array}
|
|
* The produced or original array.
|
|
*/
|
|
H.splat = function (obj) {
|
|
return H.isArray(obj) ? obj : [obj];
|
|
};
|
|
|
|
/**
|
|
* Set a timeout if the delay is given, otherwise perform the function
|
|
* synchronously.
|
|
*
|
|
* @function Highcharts.syncTimeout
|
|
*
|
|
* @param {Function} fn
|
|
* The function callback.
|
|
*
|
|
* @param {number} delay
|
|
* Delay in milliseconds.
|
|
*
|
|
* @param {*} [context]
|
|
* The context.
|
|
*
|
|
* @return {number}
|
|
* An identifier for the timeout that can later be cleared with
|
|
* Highcharts.clearTimeout.
|
|
*/
|
|
H.syncTimeout = function (fn, delay, context) {
|
|
if (delay) {
|
|
return setTimeout(fn, delay, context);
|
|
}
|
|
fn.call(0, context);
|
|
};
|
|
|
|
/**
|
|
* Internal clear timeout. The function checks that the `id` was not removed
|
|
* (e.g. by `chart.destroy()`). For the details see
|
|
* [issue #7901](https://github.com/highcharts/highcharts/issues/7901).
|
|
*
|
|
* @function Highcharts.clearTimeout
|
|
*
|
|
* @param {number} id
|
|
* Id of a timeout.
|
|
*/
|
|
H.clearTimeout = function (id) {
|
|
if (H.defined(id)) {
|
|
clearTimeout(id);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Utility function to extend an object with the members of another.
|
|
*
|
|
* @function Highcharts.extend
|
|
*
|
|
* @param {Highcharts.Dictionary<*>} a
|
|
* The object to be extended.
|
|
*
|
|
* @param {Highcharts.Dictionary<*>} b
|
|
* The object to add to the first one.
|
|
*
|
|
* @return {Highcharts.Dictionary<*>}
|
|
* Object a, the original object.
|
|
*/
|
|
H.extend = function (a, b) {
|
|
var n;
|
|
if (!a) {
|
|
a = {};
|
|
}
|
|
for (n in b) {
|
|
a[n] = b[n];
|
|
}
|
|
return a;
|
|
};
|
|
|
|
|
|
/**
|
|
* Return the first value that is not null or undefined.
|
|
*
|
|
* @function Highcharts.pick
|
|
*
|
|
* @param {...*} items
|
|
* Variable number of arguments to inspect.
|
|
*
|
|
* @return {*}
|
|
* The value of the first argument that is not null or undefined.
|
|
*/
|
|
H.pick = function () {
|
|
var args = arguments,
|
|
i,
|
|
arg,
|
|
length = args.length;
|
|
for (i = 0; i < length; i++) {
|
|
arg = args[i];
|
|
if (arg !== undefined && arg !== null) {
|
|
return arg;
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Set CSS on a given element.
|
|
*
|
|
* @function Highcharts.css
|
|
*
|
|
* @param {Highcharts.HTMLDOMElement} el
|
|
* An HTML DOM element.
|
|
*
|
|
* @param {Highcharts.CSSObject} styles
|
|
* Style object with camel case property names.
|
|
*/
|
|
H.css = function (el, styles) {
|
|
if (H.isMS && !H.svg) { // #2686
|
|
if (styles && styles.opacity !== undefined) {
|
|
styles.filter = 'alpha(opacity=' + (styles.opacity * 100) + ')';
|
|
}
|
|
}
|
|
H.extend(el.style, styles);
|
|
};
|
|
|
|
/**
|
|
* Utility function to create an HTML element with attributes and styles.
|
|
*
|
|
* @function Highcharts.createElement
|
|
*
|
|
* @param {string} tag
|
|
* The HTML tag.
|
|
*
|
|
* @param {Highcharts.HTMLAttributes} [attribs]
|
|
* Attributes as an object of key-value pairs.
|
|
*
|
|
* @param {Highcharts.CSSObject} [styles]
|
|
* Styles as an object of key-value pairs.
|
|
*
|
|
* @param {Highcharts.HTMLDOMElement} [parent]
|
|
* The parent HTML object.
|
|
*
|
|
* @param {boolean} [nopad=false]
|
|
* If true, remove all padding, border and margin.
|
|
*
|
|
* @return {Highcharts.HTMLDOMElement}
|
|
* The created DOM element.
|
|
*/
|
|
H.createElement = function (tag, attribs, styles, parent, nopad) {
|
|
var el = doc.createElement(tag),
|
|
css = H.css;
|
|
if (attribs) {
|
|
H.extend(el, attribs);
|
|
}
|
|
if (nopad) {
|
|
css(el, { padding: 0, border: 'none', margin: 0 });
|
|
}
|
|
if (styles) {
|
|
css(el, styles);
|
|
}
|
|
if (parent) {
|
|
parent.appendChild(el);
|
|
}
|
|
return el;
|
|
};
|
|
|
|
/**
|
|
* Extend a prototyped class by new members.
|
|
*
|
|
* @function Highcharts.extendClass
|
|
*
|
|
* @param {*} parent
|
|
* The parent prototype to inherit.
|
|
*
|
|
* @param {Highcharts.Dictionary<*>} members
|
|
* A collection of prototype members to add or override compared to the
|
|
* parent prototype.
|
|
*
|
|
* @return {*}
|
|
* A new prototype.
|
|
*/
|
|
H.extendClass = function (parent, members) {
|
|
var object = function () {};
|
|
object.prototype = new parent(); // eslint-disable-line new-cap
|
|
H.extend(object.prototype, members);
|
|
return object;
|
|
};
|
|
|
|
/**
|
|
* Left-pad a string to a given length by adding a character repetetively.
|
|
*
|
|
* @function Highcharts.pad
|
|
*
|
|
* @param {number} number
|
|
* The input string or number.
|
|
*
|
|
* @param {number} length
|
|
* The desired string length.
|
|
*
|
|
* @param {string} [padder=0]
|
|
* The character to pad with.
|
|
*
|
|
* @return {string}
|
|
* The padded string.
|
|
*/
|
|
H.pad = function (number, length, padder) {
|
|
return new Array(
|
|
(length || 2) +
|
|
1 -
|
|
String(number)
|
|
.replace('-', '')
|
|
.length
|
|
).join(padder || 0) + number;
|
|
};
|
|
|
|
/**
|
|
* Return a length based on either the integer value, or a percentage of a base.
|
|
*
|
|
* @function Highcharts.relativeLength
|
|
*
|
|
* @param {Highcharts.RelativeSize} value
|
|
* A percentage string or a number.
|
|
*
|
|
* @param {number} base
|
|
* The full length that represents 100%.
|
|
*
|
|
* @param {number} [offset=0]
|
|
* A pixel offset to apply for percentage values. Used internally in
|
|
* axis positioning.
|
|
*
|
|
* @return {number}
|
|
* The computed length.
|
|
*/
|
|
H.relativeLength = function (value, base, offset) {
|
|
return (/%$/).test(value) ?
|
|
(base * parseFloat(value) / 100) + (offset || 0) :
|
|
parseFloat(value);
|
|
};
|
|
|
|
/**
|
|
* Wrap a method with extended functionality, preserving the original function.
|
|
*
|
|
* @function Highcharts.wrap
|
|
*
|
|
* @param {*} obj
|
|
* The context object that the method belongs to. In real cases, this is
|
|
* often a prototype.
|
|
*
|
|
* @param {string} method
|
|
* The name of the method to extend.
|
|
*
|
|
* @param {Function} func
|
|
* A wrapper function callback. This function is called with the same
|
|
* arguments as the original function, except that the original function
|
|
* is unshifted and passed as the first argument.
|
|
*/
|
|
H.wrap = function (obj, method, func) {
|
|
var proceed = obj[method];
|
|
obj[method] = function () {
|
|
var args = Array.prototype.slice.call(arguments),
|
|
outerArgs = arguments,
|
|
ctx = this,
|
|
ret;
|
|
ctx.proceed = function () {
|
|
proceed.apply(ctx, arguments.length ? arguments : outerArgs);
|
|
};
|
|
args.unshift(proceed);
|
|
ret = func.apply(this, args);
|
|
ctx.proceed = null;
|
|
return ret;
|
|
};
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
* Recursively converts all Date properties to timestamps.
|
|
*
|
|
* @param {Object} object - any object to convert properties of
|
|
*/
|
|
H.datePropsToTimestamps = function (object) {
|
|
H.objectEach(object, function (val, key) {
|
|
if (H.isObject(val) && typeof val.getTime === 'function') {
|
|
object[key] = val.getTime();
|
|
} else if (H.isObject(val) || H.isArray(val)) {
|
|
H.datePropsToTimestamps(val);
|
|
}
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Format a single variable. Similar to sprintf, without the % prefix.
|
|
*
|
|
* @example
|
|
* formatSingle('.2f', 5); // => '5.00'.
|
|
*
|
|
* @function Highcharts.formatSingle
|
|
*
|
|
* @param {string} format
|
|
* The format string.
|
|
*
|
|
* @param {*} val
|
|
* The value.
|
|
*
|
|
* @param {Highcharts.Time} [time]
|
|
* A `Time` instance that determines the date formatting, for example
|
|
* for applying time zone corrections to the formatted date.
|
|
*
|
|
* @return {string}
|
|
* The formatted representation of the value.
|
|
*/
|
|
H.formatSingle = function (format, val, time) {
|
|
var floatRegex = /f$/,
|
|
decRegex = /\.([0-9])/,
|
|
lang = H.defaultOptions.lang,
|
|
decimals;
|
|
|
|
if (floatRegex.test(format)) { // float
|
|
decimals = format.match(decRegex);
|
|
decimals = decimals ? decimals[1] : -1;
|
|
if (val !== null) {
|
|
val = H.numberFormat(
|
|
val,
|
|
decimals,
|
|
lang.decimalPoint,
|
|
format.indexOf(',') > -1 ? lang.thousandsSep : ''
|
|
);
|
|
}
|
|
} else {
|
|
val = (time || H.time).dateFormat(format, val);
|
|
}
|
|
return val;
|
|
};
|
|
|
|
/**
|
|
* Format a string according to a subset of the rules of Python's String.format
|
|
* method.
|
|
*
|
|
* @example
|
|
* var s = Highcharts.format(
|
|
* 'The {color} fox was {len:.2f} feet long',
|
|
* { color: 'red', len: Math.PI }
|
|
* );
|
|
* // => The red fox was 3.14 feet long
|
|
*
|
|
* @function Highcharts.format
|
|
*
|
|
* @param {string} str
|
|
* The string to format.
|
|
*
|
|
* @param {*} ctx
|
|
* The context, a collection of key-value pairs where each key is
|
|
* replaced by its value.
|
|
*
|
|
* @param {Highcharts.Time} [time]
|
|
* A `Time` instance that determines the date formatting, for example
|
|
* for applying time zone corrections to the formatted date.
|
|
*
|
|
* @return {string}
|
|
* The formatted string.
|
|
*/
|
|
H.format = function (str, ctx, time) {
|
|
var splitter = '{',
|
|
isInside = false,
|
|
segment,
|
|
valueAndFormat,
|
|
path,
|
|
i,
|
|
len,
|
|
ret = [],
|
|
val,
|
|
index;
|
|
|
|
while (str) {
|
|
index = str.indexOf(splitter);
|
|
if (index === -1) {
|
|
break;
|
|
}
|
|
|
|
segment = str.slice(0, index);
|
|
if (isInside) { // we're on the closing bracket looking back
|
|
|
|
valueAndFormat = segment.split(':');
|
|
path = valueAndFormat.shift().split('.'); // get first and leave
|
|
len = path.length;
|
|
val = ctx;
|
|
|
|
// Assign deeper paths
|
|
for (i = 0; i < len; i++) {
|
|
if (val) {
|
|
val = val[path[i]];
|
|
}
|
|
}
|
|
|
|
// Format the replacement
|
|
if (valueAndFormat.length) {
|
|
val = H.formatSingle(valueAndFormat.join(':'), val, time);
|
|
}
|
|
|
|
// Push the result and advance the cursor
|
|
ret.push(val);
|
|
|
|
} else {
|
|
ret.push(segment);
|
|
|
|
}
|
|
str = str.slice(index + 1); // the rest
|
|
isInside = !isInside; // toggle
|
|
splitter = isInside ? '}' : '{'; // now look for next matching bracket
|
|
}
|
|
ret.push(str);
|
|
return ret.join('');
|
|
};
|
|
|
|
/**
|
|
* Get the magnitude of a number.
|
|
*
|
|
* @function Highcharts.getMagnitude
|
|
*
|
|
* @param {number} number
|
|
* The number.
|
|
*
|
|
* @return {number}
|
|
* The magnitude, where 1-9 are magnitude 1, 10-99 magnitude 2 etc.
|
|
*/
|
|
H.getMagnitude = function (num) {
|
|
return Math.pow(10, Math.floor(Math.log(num) / Math.LN10));
|
|
};
|
|
|
|
/**
|
|
* Take an interval and normalize it to multiples of round numbers.
|
|
*
|
|
* @deprecated
|
|
* @function Highcharts.normalizeTickInterval
|
|
*
|
|
* @param {number} interval
|
|
* The raw, un-rounded interval.
|
|
*
|
|
* @param {Array} [multiples]
|
|
* Allowed multiples.
|
|
*
|
|
* @param {number} [magnitude]
|
|
* The magnitude of the number.
|
|
*
|
|
* @param {boolean} [allowDecimals]
|
|
* Whether to allow decimals.
|
|
*
|
|
* @param {boolean} [hasTickAmount]
|
|
* If it has tickAmount, avoid landing on tick intervals lower than
|
|
* original.
|
|
*
|
|
* @return {number}
|
|
* The normalized interval.
|
|
*
|
|
* @todo
|
|
* Move this function to the Axis prototype. It is here only for historical
|
|
* reasons.
|
|
*/
|
|
H.normalizeTickInterval = function (
|
|
interval,
|
|
multiples,
|
|
magnitude,
|
|
allowDecimals,
|
|
hasTickAmount
|
|
) {
|
|
var normalized,
|
|
i,
|
|
retInterval = interval;
|
|
|
|
// round to a tenfold of 1, 2, 2.5 or 5
|
|
magnitude = H.pick(magnitude, 1);
|
|
normalized = interval / magnitude;
|
|
|
|
// multiples for a linear scale
|
|
if (!multiples) {
|
|
multiples = hasTickAmount ?
|
|
// Finer grained ticks when the tick amount is hard set, including
|
|
// when alignTicks is true on multiple axes (#4580).
|
|
[1, 1.2, 1.5, 2, 2.5, 3, 4, 5, 6, 8, 10] :
|
|
|
|
// Else, let ticks fall on rounder numbers
|
|
[1, 2, 2.5, 5, 10];
|
|
|
|
|
|
// the allowDecimals option
|
|
if (allowDecimals === false) {
|
|
if (magnitude === 1) {
|
|
multiples = multiples.filter(function (num) {
|
|
return num % 1 === 0;
|
|
});
|
|
} else if (magnitude <= 0.1) {
|
|
multiples = [1 / magnitude];
|
|
}
|
|
}
|
|
}
|
|
|
|
// normalize the interval to the nearest multiple
|
|
for (i = 0; i < multiples.length; i++) {
|
|
retInterval = multiples[i];
|
|
// only allow tick amounts smaller than natural
|
|
if (
|
|
(
|
|
hasTickAmount &&
|
|
retInterval * magnitude >= interval
|
|
) ||
|
|
(
|
|
!hasTickAmount &&
|
|
(
|
|
normalized <=
|
|
(
|
|
multiples[i] +
|
|
(multiples[i + 1] || multiples[i])
|
|
) / 2
|
|
)
|
|
)
|
|
) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Multiply back to the correct magnitude. Correct floats to appropriate
|
|
// precision (#6085).
|
|
retInterval = H.correctFloat(
|
|
retInterval * magnitude,
|
|
-Math.round(Math.log(0.001) / Math.LN10)
|
|
);
|
|
|
|
return retInterval;
|
|
};
|
|
|
|
|
|
/**
|
|
* Sort an object array and keep the order of equal items. The ECMAScript
|
|
* standard does not specify the behaviour when items are equal.
|
|
*
|
|
* @function Highcharts.stableSort
|
|
*
|
|
* @param {Array} arr
|
|
* The array to sort.
|
|
*
|
|
* @param {Function} sortFunction
|
|
* The function to sort it with, like with regular Array.prototype.sort.
|
|
*/
|
|
H.stableSort = function (arr, sortFunction) {
|
|
var length = arr.length,
|
|
sortValue,
|
|
i;
|
|
|
|
// Add index to each item
|
|
for (i = 0; i < length; i++) {
|
|
arr[i].safeI = i; // stable sort index
|
|
}
|
|
|
|
arr.sort(function (a, b) {
|
|
sortValue = sortFunction(a, b);
|
|
return sortValue === 0 ? a.safeI - b.safeI : sortValue;
|
|
});
|
|
|
|
// Remove index from items
|
|
for (i = 0; i < length; i++) {
|
|
delete arr[i].safeI; // stable sort index
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Non-recursive method to find the lowest member of an array. `Math.min` raises
|
|
* a maximum call stack size exceeded error in Chrome when trying to apply more
|
|
* than 150.000 points. This method is slightly slower, but safe.
|
|
*
|
|
* @function Highcharts.arrayMin
|
|
*
|
|
* @param {Array} data
|
|
* An array of numbers.
|
|
*
|
|
* @return {number}
|
|
* The lowest number.
|
|
*/
|
|
H.arrayMin = function (data) {
|
|
var i = data.length,
|
|
min = data[0];
|
|
|
|
while (i--) {
|
|
if (data[i] < min) {
|
|
min = data[i];
|
|
}
|
|
}
|
|
return min;
|
|
};
|
|
|
|
/**
|
|
* Non-recursive method to find the lowest member of an array. `Math.max` raises
|
|
* a maximum call stack size exceeded error in Chrome when trying to apply more
|
|
* than 150.000 points. This method is slightly slower, but safe.
|
|
*
|
|
* @function Highcharts.arrayMax
|
|
*
|
|
* @param {Array} data
|
|
* An array of numbers.
|
|
*
|
|
* @return {number}
|
|
* The highest number.
|
|
*/
|
|
H.arrayMax = function (data) {
|
|
var i = data.length,
|
|
max = data[0];
|
|
|
|
while (i--) {
|
|
if (data[i] > max) {
|
|
max = data[i];
|
|
}
|
|
}
|
|
return max;
|
|
};
|
|
|
|
/**
|
|
* Utility method that destroys any SVGElement instances that are properties on
|
|
* the given object. It loops all properties and invokes destroy if there is a
|
|
* destroy method. The property is then delete.
|
|
*
|
|
* @function Highcharts.destroyObjectProperties
|
|
*
|
|
* @param {*} obj
|
|
* The object to destroy properties on.
|
|
*
|
|
* @param {*} [except]
|
|
* Exception, do not destroy this property, only delete it.
|
|
*/
|
|
H.destroyObjectProperties = function (obj, except) {
|
|
H.objectEach(obj, function (val, n) {
|
|
// If the object is non-null and destroy is defined
|
|
if (val && val !== except && val.destroy) {
|
|
// Invoke the destroy
|
|
val.destroy();
|
|
}
|
|
|
|
// Delete the property from the object.
|
|
delete obj[n];
|
|
});
|
|
};
|
|
|
|
|
|
/**
|
|
* Discard a HTML element by moving it to the bin and delete.
|
|
*
|
|
* @function Highcharts.discardElement
|
|
*
|
|
* @param {Highcharts.HTMLDOMElement} element
|
|
* The HTML node to discard.
|
|
*/
|
|
H.discardElement = function (element) {
|
|
var garbageBin = H.garbageBin;
|
|
// create a garbage bin element, not part of the DOM
|
|
if (!garbageBin) {
|
|
garbageBin = H.createElement('div');
|
|
}
|
|
|
|
// move the node and empty bin
|
|
if (element) {
|
|
garbageBin.appendChild(element);
|
|
}
|
|
garbageBin.innerHTML = '';
|
|
};
|
|
|
|
/**
|
|
* Fix JS round off float errors.
|
|
*
|
|
* @function Highcharts.correctFloat
|
|
*
|
|
* @param {number} num
|
|
* A float number to fix.
|
|
*
|
|
* @param {number} [prec=14]
|
|
* The precision.
|
|
*
|
|
* @return {number}
|
|
* The corrected float number.
|
|
*/
|
|
H.correctFloat = function (num, prec) {
|
|
return parseFloat(
|
|
num.toPrecision(prec || 14)
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Set the global animation to either a given value, or fall back to the given
|
|
* chart's animation option.
|
|
*
|
|
* @function Highcharts.setAnimation
|
|
*
|
|
* @param {boolean|Highcharts.AnimationOptionsObject} animation
|
|
* The animation object.
|
|
*
|
|
* @param {Highcharts.Chart} chart
|
|
* The chart instance.
|
|
*
|
|
* @todo
|
|
* This function always relates to a chart, and sets a property on the renderer,
|
|
* so it should be moved to the SVGRenderer.
|
|
*/
|
|
H.setAnimation = function (animation, chart) {
|
|
chart.renderer.globalAnimation = H.pick(
|
|
animation,
|
|
chart.options.chart.animation,
|
|
true
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Get the animation in object form, where a disabled animation is always
|
|
* returned as `{ duration: 0 }`.
|
|
*
|
|
* @function Highcharts.animObject
|
|
*
|
|
* @param {boolean|Highcharts.AnimationOptionsObject} animation
|
|
* An animation setting. Can be an object with duration, complete and
|
|
* easing properties, or a boolean to enable or disable.
|
|
*
|
|
* @return {Highcharts.AnimationOptionsObject}
|
|
* An object with at least a duration property.
|
|
*/
|
|
H.animObject = function (animation) {
|
|
return H.isObject(animation) ?
|
|
H.merge(animation) :
|
|
{ duration: animation ? 500 : 0 };
|
|
};
|
|
|
|
/**
|
|
* The time unit lookup
|
|
*
|
|
* @ignore
|
|
*/
|
|
H.timeUnits = {
|
|
millisecond: 1,
|
|
second: 1000,
|
|
minute: 60000,
|
|
hour: 3600000,
|
|
day: 24 * 3600000,
|
|
week: 7 * 24 * 3600000,
|
|
month: 28 * 24 * 3600000,
|
|
year: 364 * 24 * 3600000
|
|
};
|
|
|
|
/**
|
|
* Format a number and return a string based on input settings.
|
|
*
|
|
* @sample highcharts/members/highcharts-numberformat/
|
|
* Custom number format
|
|
*
|
|
* @function Highcharts.numberFormat
|
|
*
|
|
* @param {number} number
|
|
* The input number to format.
|
|
*
|
|
* @param {number} decimals
|
|
* The amount of decimals. A value of -1 preserves the amount in the
|
|
* input number.
|
|
*
|
|
* @param {string} [decimalPoint]
|
|
* The decimal point, defaults to the one given in the lang options, or
|
|
* a dot.
|
|
*
|
|
* @param {string} [thousandsSep]
|
|
* The thousands separator, defaults to the one given in the lang
|
|
* options, or a space character.
|
|
*
|
|
* @return {string}
|
|
* The formatted number.
|
|
*/
|
|
H.numberFormat = function (number, decimals, decimalPoint, thousandsSep) {
|
|
number = +number || 0;
|
|
decimals = +decimals;
|
|
|
|
var lang = H.defaultOptions.lang,
|
|
origDec = (number.toString().split('.')[1] || '').split('e')[0].length,
|
|
strinteger,
|
|
thousands,
|
|
ret,
|
|
roundedNumber,
|
|
exponent = number.toString().split('e'),
|
|
fractionDigits;
|
|
|
|
if (decimals === -1) {
|
|
// Preserve decimals. Not huge numbers (#3793).
|
|
decimals = Math.min(origDec, 20);
|
|
} else if (!H.isNumber(decimals)) {
|
|
decimals = 2;
|
|
} else if (decimals && exponent[1] && exponent[1] < 0) {
|
|
// Expose decimals from exponential notation (#7042)
|
|
fractionDigits = decimals + +exponent[1];
|
|
if (fractionDigits >= 0) {
|
|
// remove too small part of the number while keeping the notation
|
|
exponent[0] = (+exponent[0]).toExponential(fractionDigits)
|
|
.split('e')[0];
|
|
decimals = fractionDigits;
|
|
} else {
|
|
// fractionDigits < 0
|
|
exponent[0] = exponent[0].split('.')[0] || 0;
|
|
|
|
if (decimals < 20) {
|
|
// use number instead of exponential notation (#7405)
|
|
number = (exponent[0] * Math.pow(10, exponent[1]))
|
|
.toFixed(decimals);
|
|
} else {
|
|
// or zero
|
|
number = 0;
|
|
}
|
|
exponent[1] = 0;
|
|
}
|
|
}
|
|
|
|
// Add another decimal to avoid rounding errors of float numbers. (#4573)
|
|
// Then use toFixed to handle rounding.
|
|
roundedNumber = (
|
|
Math.abs(exponent[1] ? exponent[0] : number) +
|
|
Math.pow(10, -Math.max(decimals, origDec) - 1)
|
|
).toFixed(decimals);
|
|
|
|
// A string containing the positive integer component of the number
|
|
strinteger = String(H.pInt(roundedNumber));
|
|
|
|
// Leftover after grouping into thousands. Can be 0, 1 or 2.
|
|
thousands = strinteger.length > 3 ? strinteger.length % 3 : 0;
|
|
|
|
// Language
|
|
decimalPoint = H.pick(decimalPoint, lang.decimalPoint);
|
|
thousandsSep = H.pick(thousandsSep, lang.thousandsSep);
|
|
|
|
// Start building the return
|
|
ret = number < 0 ? '-' : '';
|
|
|
|
// Add the leftover after grouping into thousands. For example, in the
|
|
// number 42 000 000, this line adds 42.
|
|
ret += thousands ? strinteger.substr(0, thousands) + thousandsSep : '';
|
|
|
|
// Add the remaining thousands groups, joined by the thousands separator
|
|
ret += strinteger
|
|
.substr(thousands)
|
|
.replace(/(\d{3})(?=\d)/g, '$1' + thousandsSep);
|
|
|
|
// Add the decimal point and the decimal component
|
|
if (decimals) {
|
|
// Get the decimal component
|
|
ret += decimalPoint + roundedNumber.slice(-decimals);
|
|
}
|
|
|
|
if (exponent[1] && +ret !== 0) {
|
|
ret += 'e' + exponent[1];
|
|
}
|
|
|
|
return ret;
|
|
};
|
|
|
|
/**
|
|
* Easing definition
|
|
*
|
|
* @private
|
|
* @function Math.easeInOutSine
|
|
*
|
|
* @param {number} pos
|
|
* Current position, ranging from 0 to 1.
|
|
*
|
|
* @return {number}
|
|
*/
|
|
Math.easeInOutSine = function (pos) {
|
|
return -0.5 * (Math.cos(Math.PI * pos) - 1);
|
|
};
|
|
|
|
/**
|
|
* Get the computed CSS value for given element and property, only for numerical
|
|
* properties. For width and height, the dimension of the inner box (excluding
|
|
* padding) is returned. Used for fitting the chart within the container.
|
|
*
|
|
* @function Highcharts.getStyle
|
|
*
|
|
* @param {Highcharts.HTMLDOMElement} el
|
|
* An HTML element.
|
|
*
|
|
* @param {string} prop
|
|
* The property name.
|
|
*
|
|
* @param {boolean} [toInt=true]
|
|
* Parse to integer.
|
|
*
|
|
* @return {number}
|
|
* The numeric value.
|
|
*/
|
|
H.getStyle = function (el, prop, toInt) {
|
|
|
|
var style;
|
|
|
|
// For width and height, return the actual inner pixel size (#4913)
|
|
if (prop === 'width') {
|
|
return Math.max(
|
|
0, // #8377
|
|
(
|
|
Math.min(
|
|
el.offsetWidth,
|
|
el.scrollWidth,
|
|
el.getBoundingClientRect ?
|
|
Math.floor(el.getBoundingClientRect().width) : // #6427
|
|
Infinity
|
|
) -
|
|
H.getStyle(el, 'padding-left') -
|
|
H.getStyle(el, 'padding-right')
|
|
)
|
|
);
|
|
} else if (prop === 'height') {
|
|
return Math.max(
|
|
0, // #8377
|
|
Math.min(el.offsetHeight, el.scrollHeight) -
|
|
H.getStyle(el, 'padding-top') -
|
|
H.getStyle(el, 'padding-bottom')
|
|
);
|
|
}
|
|
|
|
if (!win.getComputedStyle) {
|
|
// SVG not supported, forgot to load oldie.js?
|
|
H.error(27, true);
|
|
}
|
|
|
|
// Otherwise, get the computed style
|
|
style = win.getComputedStyle(el, undefined);
|
|
if (style) {
|
|
style = style.getPropertyValue(prop);
|
|
if (H.pick(toInt, prop !== 'opacity')) {
|
|
style = H.pInt(style);
|
|
}
|
|
}
|
|
return style;
|
|
};
|
|
|
|
/**
|
|
* Search for an item in an array.
|
|
*
|
|
* @function Highcharts.inArray
|
|
*
|
|
* @deprecated
|
|
*
|
|
* @param {*} item
|
|
* The item to search for.
|
|
*
|
|
* @param {Array} arr
|
|
* The array or node collection to search in.
|
|
*
|
|
* @param {number} [fromIndex=0]
|
|
* The index to start searching from.
|
|
*
|
|
* @return {number}
|
|
* The index within the array, or -1 if not found.
|
|
*/
|
|
H.inArray = function (item, arr, fromIndex) {
|
|
return arr.indexOf(item, fromIndex);
|
|
};
|
|
|
|
/**
|
|
* Return the value of the first element in the array that satisfies the
|
|
* provided testing function.
|
|
*
|
|
* @function Highcharts.find
|
|
*
|
|
* @param {Array} arr
|
|
* The array to test.
|
|
*
|
|
* @param {Function} callback
|
|
* The callback function. The function receives the item as the first
|
|
* argument. Return `true` if this item satisfies the condition.
|
|
*
|
|
* @return {*}
|
|
* The value of the element.
|
|
*/
|
|
H.find = Array.prototype.find ?
|
|
function (arr, callback) {
|
|
return arr.find(callback);
|
|
} :
|
|
// Legacy implementation. PhantomJS, IE <= 11 etc. #7223.
|
|
function (arr, fn) {
|
|
var i,
|
|
length = arr.length;
|
|
|
|
for (i = 0; i < length; i++) {
|
|
if (fn(arr[i], i)) {
|
|
return arr[i];
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Returns an array of a given object's own properties.
|
|
*
|
|
* @function Highcharts.keys
|
|
* @deprecated
|
|
*
|
|
* @param {*} obj
|
|
* The object of which the properties are to be returned.
|
|
*
|
|
* @return {Array<string>}
|
|
* An array of strings that represents all the properties.
|
|
*/
|
|
H.keys = Object.keys;
|
|
|
|
/**
|
|
* Get the element's offset position, corrected for `overflow: auto`.
|
|
*
|
|
* @function Highcharts.offset
|
|
*
|
|
* @param {Highcharts.HTMLDOMElement} el
|
|
* The HTML element.
|
|
*
|
|
* @return {Highcharts.OffsetObject}
|
|
* An object containing `left` and `top` properties for the position in
|
|
* the page.
|
|
*/
|
|
H.offset = function (el) {
|
|
var docElem = doc.documentElement,
|
|
box = (el.parentElement || el.parentNode) ?
|
|
el.getBoundingClientRect() :
|
|
{ top: 0, left: 0 };
|
|
|
|
return {
|
|
top: box.top + (win.pageYOffset || docElem.scrollTop) -
|
|
(docElem.clientTop || 0),
|
|
left: box.left + (win.pageXOffset || docElem.scrollLeft) -
|
|
(docElem.clientLeft || 0)
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Stop running animation.
|
|
*
|
|
* @function Highcharts.stop
|
|
*
|
|
* @param {Highcharts.SVGElement} el
|
|
* The SVGElement to stop animation on.
|
|
*
|
|
* @param {string} [prop]
|
|
* The property to stop animating. If given, the stop method will stop a
|
|
* single property from animating, while others continue.
|
|
*
|
|
* @todo
|
|
* A possible extension to this would be to stop a single property, when
|
|
* we want to continue animating others. Then assign the prop to the timer
|
|
* in the Fx.run method, and check for the prop here. This would be an
|
|
* improvement in all cases where we stop the animation from .attr. Instead of
|
|
* stopping everything, we can just stop the actual attributes we're setting.
|
|
*/
|
|
H.stop = function (el, prop) {
|
|
|
|
var i = H.timers.length;
|
|
|
|
// Remove timers related to this element (#4519)
|
|
while (i--) {
|
|
if (H.timers[i].elem === el && (!prop || prop === H.timers[i].prop)) {
|
|
H.timers[i].stopped = true; // #4667
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Iterate over object key pairs in an object.
|
|
*
|
|
* @function Highcharts.objectEach
|
|
*
|
|
* @param {*} obj
|
|
* The object to iterate over.
|
|
*
|
|
* @param {Highcharts.ObjectEachCallbackFunction} fn
|
|
* The iterator callback. It passes three arguments:
|
|
* * value - The property value.
|
|
* * key - The property key.
|
|
* * obj - The object that objectEach is being applied to.
|
|
*
|
|
* @param {*} [ctx]
|
|
* The context.
|
|
*/
|
|
H.objectEach = function (obj, fn, ctx) {
|
|
for (var key in obj) {
|
|
if (obj.hasOwnProperty(key)) {
|
|
fn.call(ctx || obj[key], obj[key], key, obj);
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Iterate over an array.
|
|
*
|
|
* @deprecated
|
|
* @function Highcharts.each
|
|
*
|
|
* @param {Array<*>} arr
|
|
* The array to iterate over.
|
|
*
|
|
* @param {Function} fn
|
|
* The iterator callback. It passes three arguments:
|
|
* - `item`: The array item.
|
|
* - `index`: The item's index in the array.
|
|
* - `arr`: The array that each is being applied to.
|
|
*
|
|
* @param {*} [ctx]
|
|
* The context.
|
|
*/
|
|
|
|
/**
|
|
* Filter an array by a callback.
|
|
*
|
|
* @deprecated
|
|
* @function Highcharts.grep
|
|
*
|
|
* @param {Array<*>} arr
|
|
* The array to filter.
|
|
*
|
|
* @param {Function} callback
|
|
* The callback function. The function receives the item as the first
|
|
* argument. Return `true` if the item is to be preserved.
|
|
*
|
|
* @return {Array<*>}
|
|
* A new, filtered array.
|
|
*/
|
|
|
|
/**
|
|
* Map an array by a callback.
|
|
*
|
|
* @deprecated
|
|
* @function Highcharts.map
|
|
*
|
|
* @param {Array<*>} arr
|
|
* The array to map.
|
|
*
|
|
* @param {Function} fn
|
|
* The callback function. Return the new value for the new array.
|
|
*
|
|
* @return {Array<*>}
|
|
* A new array item with modified items.
|
|
*/
|
|
|
|
/**
|
|
* Reduce an array to a single value.
|
|
*
|
|
* @deprecated
|
|
* @function Highcharts.reduce
|
|
*
|
|
* @param {Array} arr
|
|
* The array to reduce.
|
|
*
|
|
* @param {Function} fn
|
|
* The callback function. Return the reduced value. Receives 4
|
|
* arguments: Accumulated/reduced value, current value, current array
|
|
* index, and the array.
|
|
*
|
|
* @param {*} initialValue
|
|
* The initial value of the accumulator.
|
|
*
|
|
* @return {*}
|
|
* The reduced value.
|
|
*/
|
|
|
|
/**
|
|
* Test whether at least one element in the array passes the test implemented by
|
|
* the provided function.
|
|
*
|
|
* @deprecated
|
|
* @function Highcharts.some
|
|
*
|
|
* @param {Array<*>} arr
|
|
* The array to test
|
|
*
|
|
* @param {Function} fn
|
|
* The function to run on each item. Return truty to pass the test.
|
|
* Receives arguments `currentValue`, `index` and `array`.
|
|
*
|
|
* @param {*} ctx
|
|
* The context.
|
|
*
|
|
* @return {boolean}
|
|
*/
|
|
H.objectEach({
|
|
map: 'map',
|
|
each: 'forEach',
|
|
grep: 'filter',
|
|
reduce: 'reduce',
|
|
some: 'some'
|
|
}, function (val, key) {
|
|
H[key] = function (arr) {
|
|
return Array.prototype[val].apply(
|
|
arr,
|
|
[].slice.call(arguments, 1)
|
|
);
|
|
};
|
|
});
|
|
|
|
/**
|
|
* Add an event listener.
|
|
*
|
|
* @function Highcharts.addEvent<T>
|
|
*
|
|
* @param {T} el
|
|
* The element or object to add a listener to. It can be a
|
|
* {@link HTMLDOMElement}, an {@link SVGElement} or any other object.
|
|
*
|
|
* @param {string} type
|
|
* The event type.
|
|
*
|
|
* @param {Highcharts.EventCallbackFunction<T>} fn
|
|
* The function callback to execute when the event is fired.
|
|
*
|
|
* @param {Highcharts.Dictionary<*>} options
|
|
* Event options
|
|
*
|
|
* @param {number} options.order
|
|
* The order the event handler should be called. This opens for having
|
|
* one handler be called before another, independent of in which order
|
|
* they were added.
|
|
*
|
|
* @return {Function}
|
|
* A callback function to remove the added event.
|
|
*/
|
|
H.addEvent = function (el, type, fn, options) {
|
|
|
|
var events,
|
|
addEventListener = el.addEventListener || H.addEventListenerPolyfill;
|
|
|
|
// If we're setting events directly on the constructor, use a separate
|
|
// collection, `protoEvents` to distinguish it from the item events in
|
|
// `hcEvents`.
|
|
if (typeof el === 'function' && el.prototype) {
|
|
events = el.prototype.protoEvents = el.prototype.protoEvents || {};
|
|
} else {
|
|
events = el.hcEvents = el.hcEvents || {};
|
|
}
|
|
|
|
// Allow click events added to points, otherwise they will be prevented by
|
|
// the TouchPointer.pinch function after a pinch zoom operation (#7091).
|
|
if (H.Point && el instanceof H.Point && el.series && el.series.chart) {
|
|
el.series.chart.runTrackerClick = true;
|
|
}
|
|
|
|
// Handle DOM events
|
|
if (addEventListener) {
|
|
addEventListener.call(el, type, fn, false);
|
|
}
|
|
|
|
if (!events[type]) {
|
|
events[type] = [];
|
|
}
|
|
|
|
events[type].push(fn);
|
|
|
|
// Order the calls
|
|
if (options && H.isNumber(options.order)) {
|
|
fn.order = options.order;
|
|
events[type].sort(function (a, b) {
|
|
return a.order - b.order;
|
|
});
|
|
}
|
|
|
|
// Return a function that can be called to remove this event.
|
|
return function () {
|
|
H.removeEvent(el, type, fn);
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Remove an event that was added with {@link Highcharts#addEvent}.
|
|
*
|
|
* @function Highcharts.removeEvent<T>
|
|
*
|
|
* @param {T} el
|
|
* The element to remove events on.
|
|
*
|
|
* @param {string} [type]
|
|
* The type of events to remove. If undefined, all events are removed
|
|
* from the element.
|
|
*
|
|
* @param {Highcharts.EventCallbackFunction<T>} [fn]
|
|
* The specific callback to remove. If undefined, all events that match
|
|
* the element and optionally the type are removed.
|
|
*/
|
|
H.removeEvent = function (el, type, fn) {
|
|
|
|
var events,
|
|
index;
|
|
|
|
function removeOneEvent(type, fn) {
|
|
var removeEventListener =
|
|
el.removeEventListener || H.removeEventListenerPolyfill;
|
|
|
|
if (removeEventListener) {
|
|
removeEventListener.call(el, type, fn, false);
|
|
}
|
|
}
|
|
|
|
function removeAllEvents(eventCollection) {
|
|
var types,
|
|
len;
|
|
|
|
if (!el.nodeName) {
|
|
return; // break on non-DOM events
|
|
}
|
|
|
|
if (type) {
|
|
types = {};
|
|
types[type] = true;
|
|
} else {
|
|
types = eventCollection;
|
|
}
|
|
|
|
H.objectEach(types, function (val, n) {
|
|
if (eventCollection[n]) {
|
|
len = eventCollection[n].length;
|
|
while (len--) {
|
|
removeOneEvent(n, eventCollection[n][len]);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
['protoEvents', 'hcEvents'].forEach(function (coll) {
|
|
var eventCollection = el[coll];
|
|
if (eventCollection) {
|
|
if (type) {
|
|
events = eventCollection[type] || [];
|
|
if (fn) {
|
|
index = events.indexOf(fn);
|
|
if (index > -1) {
|
|
events.splice(index, 1);
|
|
eventCollection[type] = events;
|
|
}
|
|
removeOneEvent(type, fn);
|
|
|
|
} else {
|
|
removeAllEvents(eventCollection);
|
|
eventCollection[type] = [];
|
|
}
|
|
} else {
|
|
removeAllEvents(eventCollection);
|
|
el[coll] = {};
|
|
}
|
|
}
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Fire an event that was registered with {@link Highcharts#addEvent}.
|
|
*
|
|
* @function Highcharts.fireEvent
|
|
*
|
|
* @param {*} el
|
|
* The object to fire the event on. It can be a {@link HTMLDOMElement},
|
|
* an {@link SVGElement} or any other object.
|
|
*
|
|
* @param {string} type
|
|
* The type of event.
|
|
*
|
|
* @param {Highcharts.Dictionary<*>} [eventArguments]
|
|
* Custom event arguments that are passed on as an argument to the event
|
|
* handler.
|
|
*
|
|
* @param {Function} [defaultFunction]
|
|
* The default function to execute if the other listeners haven't
|
|
* returned false.
|
|
*/
|
|
H.fireEvent = function (el, type, eventArguments, defaultFunction) {
|
|
var e,
|
|
events,
|
|
len,
|
|
i,
|
|
fn;
|
|
|
|
eventArguments = eventArguments || {};
|
|
|
|
if (doc.createEvent && (el.dispatchEvent || el.fireEvent)) {
|
|
e = doc.createEvent('Events');
|
|
e.initEvent(type, true, true);
|
|
|
|
H.extend(e, eventArguments);
|
|
|
|
if (el.dispatchEvent) {
|
|
el.dispatchEvent(e);
|
|
} else {
|
|
el.fireEvent(type, e);
|
|
}
|
|
|
|
} else {
|
|
|
|
['protoEvents', 'hcEvents'].forEach(function (coll) {
|
|
|
|
if (el[coll]) {
|
|
events = el[coll][type] || [];
|
|
len = events.length;
|
|
|
|
if (!eventArguments.target) { // We're running a custom event
|
|
|
|
H.extend(eventArguments, {
|
|
// Attach a simple preventDefault function to skip
|
|
// default handler if called. The built-in
|
|
// defaultPrevented property is not overwritable (#5112)
|
|
preventDefault: function () {
|
|
eventArguments.defaultPrevented = true;
|
|
},
|
|
// Setting target to native events fails with clicking
|
|
// the zoom-out button in Chrome.
|
|
target: el,
|
|
// If the type is not set, we're running a custom event
|
|
// (#2297). If it is set, we're running a browser event,
|
|
// and setting it will cause en error in IE8 (#2465).
|
|
type: type
|
|
});
|
|
}
|
|
|
|
|
|
for (i = 0; i < len; i++) {
|
|
fn = events[i];
|
|
|
|
// If the event handler return false, prevent the default
|
|
// handler from executing
|
|
if (fn && fn.call(el, eventArguments) === false) {
|
|
eventArguments.preventDefault();
|
|
}
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
// Run the default if not prevented
|
|
if (defaultFunction && !eventArguments.defaultPrevented) {
|
|
defaultFunction.call(el, eventArguments);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* The global animate method, which uses Fx to create individual animators.
|
|
*
|
|
* @function Highcharts.animate
|
|
*
|
|
* @param {Highcharts.HTMLDOMElement|Highcharts.SVGElement} el
|
|
* The element to animate.
|
|
*
|
|
* @param {Highcharts.HTMLAttributes|Highcharts.SVGAttributes} params
|
|
* An object containing key-value pairs of the properties to animate.
|
|
* Supports numeric as pixel-based CSS properties for HTML objects and
|
|
* attributes for SVGElements.
|
|
*
|
|
* @param {Highcharts.AnimationOptionsObject} [opt]
|
|
* Animation options.
|
|
*/
|
|
H.animate = function (el, params, opt) {
|
|
var start,
|
|
unit = '',
|
|
end,
|
|
fx,
|
|
args;
|
|
|
|
if (!H.isObject(opt)) { // Number or undefined/null
|
|
args = arguments;
|
|
opt = {
|
|
duration: args[2],
|
|
easing: args[3],
|
|
complete: args[4]
|
|
};
|
|
}
|
|
if (!H.isNumber(opt.duration)) {
|
|
opt.duration = 400;
|
|
}
|
|
opt.easing = typeof opt.easing === 'function' ?
|
|
opt.easing :
|
|
(Math[opt.easing] || Math.easeInOutSine);
|
|
opt.curAnim = H.merge(params);
|
|
|
|
H.objectEach(params, function (val, prop) {
|
|
// Stop current running animation of this property
|
|
H.stop(el, prop);
|
|
|
|
fx = new H.Fx(el, opt, prop);
|
|
end = null;
|
|
|
|
if (prop === 'd') {
|
|
fx.paths = fx.initPath(
|
|
el,
|
|
el.d,
|
|
params.d
|
|
);
|
|
fx.toD = params.d;
|
|
start = 0;
|
|
end = 1;
|
|
} else if (el.attr) {
|
|
start = el.attr(prop);
|
|
} else {
|
|
start = parseFloat(H.getStyle(el, prop)) || 0;
|
|
if (prop !== 'opacity') {
|
|
unit = 'px';
|
|
}
|
|
}
|
|
|
|
if (!end) {
|
|
end = val;
|
|
}
|
|
if (end && end.match && end.match('px')) {
|
|
end = end.replace(/px/g, ''); // #4351
|
|
}
|
|
fx.run(start, end, unit);
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Factory to create new series prototypes.
|
|
*
|
|
* @function Highcharts.seriesType
|
|
*
|
|
* @param {string} type
|
|
* The series type name.
|
|
*
|
|
* @param {string} parent
|
|
* The parent series type name. Use `line` to inherit from the basic
|
|
* {@link Series} object.
|
|
*
|
|
* @param {*} options
|
|
* The additional default options that is merged with the parent's
|
|
* options.
|
|
*
|
|
* @param {*} props
|
|
* The properties (functions and primitives) to set on the new
|
|
* prototype.
|
|
*
|
|
* @param {*} [pointProps]
|
|
* Members for a series-specific extension of the {@link Point}
|
|
* prototype if needed.
|
|
*
|
|
* @return {Highcharts.Series}
|
|
* The newly created prototype as extended from {@link Series} or its
|
|
* derivatives.
|
|
*/
|
|
// docs: add to API + extending Highcharts
|
|
H.seriesType = function (type, parent, options, props, pointProps) {
|
|
var defaultOptions = H.getOptions(),
|
|
seriesTypes = H.seriesTypes;
|
|
|
|
// Merge the options
|
|
defaultOptions.plotOptions[type] = H.merge(
|
|
defaultOptions.plotOptions[parent],
|
|
options
|
|
);
|
|
|
|
// Create the class
|
|
seriesTypes[type] = H.extendClass(seriesTypes[parent] ||
|
|
function () {}, props);
|
|
seriesTypes[type].prototype.type = type;
|
|
|
|
// Create the point class if needed
|
|
if (pointProps) {
|
|
seriesTypes[type].prototype.pointClass =
|
|
H.extendClass(H.Point, pointProps);
|
|
}
|
|
|
|
return seriesTypes[type];
|
|
};
|
|
|
|
/**
|
|
* Get a unique key for using in internal element id's and pointers. The key is
|
|
* composed of a random hash specific to this Highcharts instance, and a
|
|
* counter.
|
|
*
|
|
* @example
|
|
* var id = H.uniqueKey(); // => 'highcharts-x45f6hp-0'
|
|
*
|
|
* @function Highcharts.uniqueKey
|
|
*
|
|
* @return {string}
|
|
* A unique key.
|
|
*/
|
|
H.uniqueKey = (function () {
|
|
|
|
var uniqueKeyHash = Math.random().toString(36).substring(2, 9),
|
|
idCounter = 0;
|
|
|
|
return function () {
|
|
return 'highcharts-' + uniqueKeyHash + '-' + idCounter++;
|
|
};
|
|
}());
|
|
|
|
H.isFunction = function (obj) {
|
|
return typeof obj === 'function';
|
|
};
|
|
|
|
// Register Highcharts as a plugin in jQuery
|
|
if (win.jQuery) {
|
|
|
|
/**
|
|
* Highcharts-extended JQuery.
|
|
*
|
|
* @external JQuery
|
|
*/
|
|
|
|
/**
|
|
* Helper function to return the chart of the current JQuery selector
|
|
* element.
|
|
*
|
|
* @function external:JQuery#highcharts
|
|
*
|
|
* @return {Highcharts.Chart}
|
|
* The chart that is linked to the JQuery selector element.
|
|
*//**
|
|
* Factory function to create a chart in the current JQuery selector
|
|
* element.
|
|
*
|
|
* @function external:JQuery#highcharts
|
|
*
|
|
* @param {"Chart"|"Map"|"StockChart"|string} [className]
|
|
* Name of the factory class in the Highcharts namespace.
|
|
*
|
|
* @param {Highcharts.Options} [options]
|
|
* The chart options structure.
|
|
*
|
|
* @param {Highcharts.ChartCallbackFunction} [callback]
|
|
* Function to run when the chart has loaded and and all external
|
|
* images are loaded. Defining a
|
|
* [chart.event.load](https://api.highcharts.com/highcharts/chart.events.load)
|
|
* handler is equivalent.
|
|
*
|
|
* @return {JQuery}
|
|
* The current JQuery selector.
|
|
*/
|
|
win.jQuery.fn.highcharts = function () {
|
|
var args = [].slice.call(arguments);
|
|
|
|
if (this[0]) { // this[0] is the renderTo div
|
|
|
|
// Create the chart
|
|
if (args[0]) {
|
|
new H[ // eslint-disable-line no-new
|
|
// Constructor defaults to Chart
|
|
H.isString(args[0]) ? args.shift() : 'Chart'
|
|
](this[0], args[0], args[1]);
|
|
return this;
|
|
}
|
|
|
|
// When called without parameters or with the return argument,
|
|
// return an existing chart
|
|
return charts[H.attr(this[0], 'data-highcharts-chart')];
|
|
}
|
|
};
|
|
}
|