| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958 |
- /* *
- *
- * (c) 2010-2021 Torstein Honsi
- *
- * License: www.highcharts.com/license
- *
- * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
- 'use strict';
- import H from './Globals.js';
- var charts = H.charts, doc = H.doc, win = H.win;
- /**
- * An animation configuration. Animation configurations can also be defined as
- * booleans, where `false` turns off animation and `true` defaults to a duration
- * of 500ms and defer of 0ms.
- *
- * @interface Highcharts.AnimationOptionsObject
- */ /**
- * A callback function to exectute when the animation finishes.
- * @name Highcharts.AnimationOptionsObject#complete
- * @type {Function|undefined}
- */ /**
- * The animation defer in milliseconds.
- * @name Highcharts.AnimationOptionsObject#defer
- * @type {number|undefined}
- */ /**
- * The animation duration in milliseconds.
- * @name Highcharts.AnimationOptionsObject#duration
- * @type {number|undefined}
- */ /**
- * The name of an easing function as defined on the `Math` object.
- * @name Highcharts.AnimationOptionsObject#easing
- * @type {string|Function|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}
- */
- /**
- * Creates a frame for the animated SVG element.
- *
- * @callback Highcharts.AnimationStepCallbackFunction
- *
- * @param {Highcharts.SVGElement} this
- * The SVG element to animate.
- *
- * @return {void}
- */
- /**
- * Interface description for a class.
- *
- * @interface Highcharts.Class<T>
- * @extends Function
- */ /**
- * Class costructor.
- * @function Highcharts.Class<T>#new
- * @param {...Array<*>} args
- * Constructor arguments.
- * @return {T}
- * Class instance.
- */
- /**
- * 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.CursorValue|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}
- */ /**
- * Additional decoration of the element text.
- * @name Highcharts.CSSObject#textDecoration
- * @type {string|undefined}
- */ /**
- * Outline style of the element text.
- * @name Highcharts.CSSObject#textOutline
- * @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.CursorValue
- */
- /**
- * All possible dash styles.
- *
- * @typedef {'Dash'|'DashDot'|'Dot'|'LongDash'|'LongDashDot'|'LongDashDotDot'|'ShortDash'|'ShortDashDot'|'ShortDashDotDot'|'ShortDot'|'Solid'} Highcharts.DashStyleValue
- */
- /**
- * Generic dictionary in TypeScript notation.
- * Use the native `AnyRecord` instead.
- *
- * @deprecated
- * @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<*>|Event} [eventArguments]
- * Event arguments.
- *
- * @return {boolean|void}
- */
- /**
- * The event options for adding function callback.
- *
- * @interface Highcharts.EventOptionsObject
- */ /**
- * 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.
- * @name Highcharts.EventOptionsObject#order
- * @type {number}
- */ /**
- * Whether an event should be passive or not.
- * When set to `true`, the function specified by listener will never call
- * `preventDefault()`.
- * @name Highcharts.EventOptionsObject#passive
- * @type boolean
- */
- /**
- * Formats data as a string. Usually the data is accessible throught the `this`
- * keyword.
- *
- * @callback Highcharts.FormatterCallbackFunction<T>
- *
- * @param {T} this
- * Context to format
- *
- * @return {string}
- * Formatted text
- */
- /**
- * An object of key-value pairs for HTML attributes.
- *
- * @typedef {Highcharts.Dictionary<boolean|number|string|Function>} 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<T>
- *
- * @param {T} this
- * The context.
- *
- * @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}
- */
- /**
- * Describes a range.
- *
- * @interface Highcharts.RangeObject
- */ /**
- * Maximum number of the range.
- * @name Highcharts.RangeObject#max
- * @type {number}
- */ /**
- * Minimum number of the range.
- * @name Highcharts.RangeObject#min
- * @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
- */
- /**
- * Proceed function to call original (wrapped) function.
- *
- * @callback Highcharts.WrapProceedFunction
- *
- * @param {*} [arg1]
- * Optional argument. Without any arguments defaults to first argument of
- * the wrapping function.
- *
- * @param {*} [arg2]
- * Optional argument. Without any arguments defaults to second argument
- * of the wrapping function.
- *
- * @param {*} [arg3]
- * Optional argument. Without any arguments defaults to third argument of
- * the wrapping function.
- *
- * @return {*}
- * Return value of the original function.
- */
- /**
- * 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
- * let chart = Highcharts.chart('container', { ... });
- *
- * @namespace Highcharts
- */
- ''; // detach doclets above
- /**
- * 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.
- *
- * @param {Highcharts.Chart} [chart]
- * Reference to the chart that causes the error. Used in 'debugger'
- * module to display errors directly on the chart.
- * Important note: This argument is undefined for errors that lack
- * access to the Chart instance. In such case, the error will be
- * displayed on the last created chart.
- *
- * @param {Highcharts.Dictionary<string>} [params]
- * Additional parameters for the generated message.
- *
- * @return {void}
- */
- function error(code, stop, chart, params) {
- var severity = stop ? 'Highcharts error' : 'Highcharts warning';
- if (code === 32) {
- code = severity + ": Deprecated member";
- }
- var isCode = isNumber(code);
- var message = isCode ?
- severity + " #" + code + ": www.highcharts.com/errors/" + code + "/" :
- code.toString();
- var defaultHandler = function () {
- if (stop) {
- throw new Error(message);
- }
- // else ...
- if (win.console &&
- error.messages.indexOf(message) === -1 // prevent console flooting
- ) {
- console.warn(message); // eslint-disable-line no-console
- }
- };
- if (typeof params !== 'undefined') {
- var additionalMessages_1 = '';
- if (isCode) {
- message += '?';
- }
- objectEach(params, function (value, key) {
- additionalMessages_1 += "\n - " + key + ": " + value;
- if (isCode) {
- message += encodeURI(key) + '=' + encodeURI(value);
- }
- });
- message += additionalMessages_1;
- }
- fireEvent(Highcharts, 'displayError', { chart: chart, code: code, message: message, params: params }, defaultHandler);
- error.messages.push(message);
- }
- (function (error) {
- error.messages = [];
- })(error || (error = {}));
- /* eslint-disable valid-jsdoc */
- /**
- * 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<T>
- *
- * @param {boolean} extend
- * Whether to extend the left-side object (a) or return a whole new
- * object.
- *
- * @param {T|undefined} a
- * The first object to extend. When only this is given, the function
- * returns a deep copy.
- *
- * @param {...Array<object|undefined>} [n]
- * An object to merge into the previous one.
- *
- * @return {T}
- * 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.
- * The merge function can also be used with a single object argument to create a
- * deep copy of an object.
- *
- * @function Highcharts.merge<T>
- *
- * @param {T|undefined} a
- * The first object to extend. When only this is given, the function
- * returns a deep copy.
- *
- * @param {...Array<object|undefined>} [n]
- * An object to merge into the previous one.
- *
- * @return {T}
- * The merged object. If the first argument is true, the return is the
- * same as the second argument.
- */
- function merge() {
- /* eslint-enable valid-jsdoc */
- var i, args = arguments, ret = {};
- var doCopy = function (copy, original) {
- // An object is replacing a primitive
- if (typeof copy !== 'object') {
- copy = {};
- }
- objectEach(original, function (value, key) {
- // Prototype pollution (#14883)
- if (key === '__proto__' || key === 'constructor') {
- return;
- }
- // Copy the contents of objects, but not arrays or DOM nodes
- if (isObject(value, true) &&
- !isClass(value) &&
- !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
- var len = args.length;
- for (i = 0; i < len; i++) {
- ret = doCopy(ret, args[i]);
- }
- return ret;
- }
- /**
- * Constrain a value to within a lower and upper threshold.
- *
- * @private
- * @param {number} value The initial value
- * @param {number} min The lower threshold
- * @param {number} max The upper threshold
- * @return {number} Returns a number value within min and max.
- */
- function clamp(value, min, max) {
- return value > min ? value < max ? value : max : min;
- }
- // eslint-disable-next-line valid-jsdoc
- /**
- * Remove settings that have not changed, to avoid unnecessary rendering or
- * computing (#9197).
- * @private
- */
- function cleanRecursively(newer, older) {
- var result = {};
- objectEach(newer, function (_val, key) {
- var ob;
- // Dive into objects (except DOM nodes)
- if (isObject(newer[key], true) &&
- !newer.nodeType && // #10044
- older[key]) {
- ob = cleanRecursively(newer[key], older[key]);
- if (Object.keys(ob).length) {
- result[key] = ob;
- }
- // Arrays, primitives and DOM nodes are copied directly
- }
- else if (isObject(newer[key]) ||
- newer[key] !== older[key]) {
- result[key] = newer[key];
- }
- });
- return result;
- }
- /**
- * Shortcut for parseInt
- *
- * @private
- * @function Highcharts.pInt
- *
- * @param {*} s
- * any
- *
- * @param {number} [mag]
- * Magnitude
- *
- * @return {number}
- * number
- */
- function pInt(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.
- */
- function isString(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.
- */
- function isArray(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.
- */
- function isObject(obj, strict) {
- return (!!obj &&
- typeof obj === 'object' &&
- (!strict || !isArray(obj))); // eslint-disable-line @typescript-eslint/no-explicit-any
- }
- /**
- * 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.
- */
- function isDOMElement(obj) {
- return isObject(obj) && typeof obj.nodeType === 'number';
- }
- /**
- * Utility function to check if an Object is a class.
- *
- * @function Highcharts.isClass
- *
- * @param {object|undefined} obj
- * The item to check.
- *
- * @return {boolean}
- * True if the argument is a class.
- */
- function isClass(obj) {
- var c = obj && obj.constructor;
- return !!(isObject(obj, true) &&
- !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
- */
- function isNumber(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.
- *
- * @return {void}
- */
- function erase(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.
- */
- function defined(obj) {
- return typeof 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 {number|string} [value]
- * The value if a single property is set.
- *
- * @return {string|null|undefined}
- * When used as a getter, return the value.
- */
- function attr(elem, prop, value) {
- var ret;
- // if the prop is a string
- if (isString(prop)) {
- // set the value
- if (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 {
- 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.
- */
- function splat(obj) {
- return 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]
- * An optional context to send to the function callback.
- *
- * @return {number}
- * An identifier for the timeout that can later be cleared with
- * Highcharts.clearTimeout. Returns -1 if there is no timeout.
- */
- function syncTimeout(fn, delay, context) {
- if (delay > 0) {
- return setTimeout(fn, delay, context);
- }
- fn.call(0, context);
- return -1;
- }
- /**
- * 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.
- *
- * @return {void}
- */
- function internalClearTimeout(id) {
- if (defined(id)) {
- clearTimeout(id);
- }
- }
- /* eslint-disable valid-jsdoc */
- /**
- * Utility function to extend an object with the members of another.
- *
- * @function Highcharts.extend<T>
- *
- * @param {T|undefined} a
- * The object to be extended.
- *
- * @param {Partial<T>} b
- * The object to add to the first one.
- *
- * @return {T}
- * Object a, the original object.
- */
- function extend(a, b) {
- /* eslint-enable valid-jsdoc */
- var n;
- if (!a) {
- a = {};
- }
- for (n in b) { // eslint-disable-line guard-for-in
- a[n] = b[n];
- }
- return a;
- }
- /* eslint-disable valid-jsdoc */
- /**
- * Return the first value that is not null or undefined.
- *
- * @function Highcharts.pick<T>
- *
- * @param {...Array<T|null|undefined>} items
- * Variable number of arguments to inspect.
- *
- * @return {T}
- * The value of the first argument that is not null or undefined.
- */
- function pick() {
- var args = arguments;
- var length = args.length;
- for (var i = 0; i < length; i++) {
- var arg = args[i];
- if (typeof arg !== 'undefined' && arg !== null) {
- return arg;
- }
- }
- }
- /**
- * Set CSS on a given element.
- *
- * @function Highcharts.css
- *
- * @param {Highcharts.HTMLDOMElement|Highcharts.SVGDOMElement} el
- * An HTML DOM element.
- *
- * @param {Highcharts.CSSObject} styles
- * Style object with camel case property names.
- *
- * @return {void}
- */
- function css(el, styles) {
- if (H.isMS && !H.svg) { // #2686
- if (styles && typeof styles.opacity !== 'undefined') {
- styles.filter =
- 'alpha(opacity=' + (styles.opacity * 100) + ')';
- }
- }
- 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.
- */
- function createElement(tag, attribs, styles, parent, nopad) {
- var el = doc.createElement(tag);
- if (attribs) {
- 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;
- }
- // eslint-disable-next-line valid-jsdoc
- /**
- * Extend a prototyped class by new members.
- *
- * @function Highcharts.extendClass<T>
- *
- * @param {Highcharts.Class<T>} 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 {Highcharts.Class<T>}
- * A new prototype.
- */
- function extendClass(parent, members) {
- var obj = (function () { });
- obj.prototype = new parent(); // eslint-disable-line new-cap
- extend(obj.prototype, members);
- return obj;
- }
- /**
- * 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.
- */
- function pad(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.
- */
- function relativeLength(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 {Highcharts.WrapProceedFunction} 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.
- */
- function wrap(obj, method, func) {
- var proceed = obj[method];
- obj[method] = function () {
- var args = Array.prototype.slice.call(arguments), outerArgs = arguments, ctx = this;
- ctx.proceed = function () {
- proceed.apply(ctx, arguments.length ? arguments : outerArgs);
- };
- args.unshift(proceed);
- var ret = func.apply(this, args);
- ctx.proceed = null;
- return ret;
- };
- }
- /**
- * Get the magnitude of a number.
- *
- * @function Highcharts.getMagnitude
- *
- * @param {number} num
- * The number.
- *
- * @return {number}
- * The magnitude, where 1-9 are magnitude 1, 10-99 magnitude 2 etc.
- */
- function getMagnitude(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.
- */
- function normalizeTickInterval(interval, multiples, magnitude, allowDecimals, hasTickAmount) {
- var i, retInterval = interval;
- // round to a tenfold of 1, 2, 2.5 or 5
- magnitude = pick(magnitude, 1);
- var 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 = 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.
- *
- * @return {void}
- */
- function stableSort(arr, sortFunction) {
- // @todo It seems like Chrome since v70 sorts in a stable way internally,
- // plus all other browsers do it, so over time we may be able to remove this
- // function
- var length = arr.length;
- var 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.
- */
- function arrayMin(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.
- */
- function arrayMax(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.
- */
- function destroyObjectProperties(obj, except) {
- 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.
- */
- function discardElement(element) {
- // create a garbage bin element, not part of the DOM
- if (!garbageBin) {
- garbageBin = createElement('div');
- }
- // move the node and empty bin
- if (element) {
- garbageBin.appendChild(element);
- }
- garbageBin.innerHTML = '';
- }
- var garbageBin;
- /**
- * 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.
- */
- function correctFloat(num, prec) {
- return parseFloat(num.toPrecision(prec || 14));
- }
- /**
- * The time unit lookup
- *
- * @ignore
- */
- var timeUnits = {
- millisecond: 1,
- second: 1000,
- minute: 60000,
- hour: 3600000,
- day: 24 * 3600000,
- week: 7 * 24 * 3600000,
- month: 28 * 24 * 3600000,
- year: 364 * 24 * 3600000
- };
- /**
- * Easing definition
- *
- * @private
- * @function Math.easeInOutSine
- *
- * @param {number} pos
- * Current position, ranging from 0 to 1.
- *
- * @return {number}
- * Ease result
- */
- Math.easeInOutSine = function (pos) {
- return -0.5 * (Math.cos(Math.PI * pos) - 1);
- };
- /**
- * Returns the value of a property path on a given object.
- *
- * @private
- * @function getNestedProperty
- *
- * @param {string} path
- * Path to the property, for example `custom.myValue`.
- *
- * @param {unknown} obj
- * Instance containing the property on the specific path.
- *
- * @return {unknown}
- * The unknown property value.
- */
- function getNestedProperty(path, parent) {
- var pathElements = path.split('.');
- while (pathElements.length && defined(parent)) {
- var pathElement = pathElements.shift();
- // Filter on the key
- if (typeof pathElement === 'undefined' ||
- pathElement === '__proto__') {
- return; // undefined
- }
- var child = parent[pathElement];
- // Filter on the child
- if (!defined(child) ||
- typeof child === 'function' ||
- typeof child.nodeType === 'number' ||
- child === win) {
- return; // undefined
- }
- // Else, proceed
- parent = child;
- }
- return parent;
- }
- /**
- * 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|string|undefined}
- * The style value.
- */
- function getStyle(el, prop, toInt) {
- var customGetStyle = (H.getStyle || // oldie getStyle
- getStyle);
- var style;
- // For width and height, return the actual inner pixel size (#4913)
- if (prop === 'width') {
- var offsetWidth = Math.min(el.offsetWidth, el.scrollWidth);
- // In flex boxes, we need to use getBoundingClientRect and floor it,
- // because scrollWidth doesn't support subpixel precision (#6427) ...
- var boundingClientRectWidth = el.getBoundingClientRect &&
- el.getBoundingClientRect().width;
- // ...unless if the containing div or its parents are transform-scaled
- // down, in which case the boundingClientRect can't be used as it is
- // also scaled down (#9871, #10498).
- if (boundingClientRectWidth < offsetWidth &&
- boundingClientRectWidth >= offsetWidth - 1) {
- offsetWidth = Math.floor(boundingClientRectWidth);
- }
- return Math.max(0, // #8377
- (offsetWidth -
- (customGetStyle(el, 'padding-left', true) || 0) -
- (customGetStyle(el, 'padding-right', true) || 0)));
- }
- if (prop === 'height') {
- return Math.max(0, // #8377
- (Math.min(el.offsetHeight, el.scrollHeight) -
- (customGetStyle(el, 'padding-top', true) || 0) -
- (customGetStyle(el, 'padding-bottom', true) || 0)));
- }
- if (!win.getComputedStyle) {
- // SVG not supported, forgot to load oldie.js?
- error(27, true);
- }
- // Otherwise, get the computed style
- var css = win.getComputedStyle(el, undefined); // eslint-disable-line no-undefined
- if (css) {
- style = css.getPropertyValue(prop);
- if (pick(toInt, prop !== 'opacity')) {
- style = 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.
- */
- function inArray(item, arr, fromIndex) {
- error(32, false, void 0, { 'Highcharts.inArray': 'use Array.indexOf' });
- return arr.indexOf(item, fromIndex);
- }
- /* eslint-disable valid-jsdoc */
- /**
- * Return the value of the first element in the array that satisfies the
- * provided testing function.
- *
- * @function Highcharts.find<T>
- *
- * @param {Array<T>} 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 {T|undefined}
- * The value of the element.
- */
- var find = Array.prototype.find ?
- /* eslint-enable valid-jsdoc */
- function (arr, callback) {
- return arr.find(callback);
- } :
- // Legacy implementation. PhantomJS, IE <= 11 etc. #7223.
- function (arr, callback) {
- var i;
- var length = arr.length;
- for (i = 0; i < length; i++) {
- if (callback(arr[i], i)) { // eslint-disable-line callback-return
- 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.
- */
- function keys(obj) {
- error(32, false, void 0, { 'Highcharts.keys': 'use Object.keys' });
- return Object.keys(obj);
- }
- /**
- * Get the element's offset position, corrected for `overflow: auto`.
- *
- * @function Highcharts.offset
- *
- * @param {global.Element} el
- * The DOM element.
- *
- * @return {Highcharts.OffsetObject}
- * An object containing `left` and `top` properties for the position in
- * the page.
- */
- function offset(el) {
- var docElem = doc.documentElement, box = (el.parentElement || el.parentNode) ?
- el.getBoundingClientRect() :
- { top: 0, left: 0, width: 0, height: 0 };
- return {
- top: box.top + (win.pageYOffset || docElem.scrollTop) -
- (docElem.clientTop || 0),
- left: box.left + (win.pageXOffset || docElem.scrollLeft) -
- (docElem.clientLeft || 0),
- width: box.width,
- height: box.height
- };
- }
- /* eslint-disable valid-jsdoc */
- /**
- * Iterate over object key pairs in an object.
- *
- * @function Highcharts.objectEach<T>
- *
- * @param {*} obj
- * The object to iterate over.
- *
- * @param {Highcharts.ObjectEachCallbackFunction<T>} 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 {T} [ctx]
- * The context.
- *
- * @return {void}
- */
- function objectEach(obj, fn, ctx) {
- /* eslint-enable valid-jsdoc */
- for (var key in obj) {
- if (Object.hasOwnProperty.call(obj, 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.
- *
- * @return {void}
- */
- /**
- * 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}
- */
- objectEach({
- map: 'map',
- each: 'forEach',
- grep: 'filter',
- reduce: 'reduce',
- some: 'some'
- }, function (val, key) {
- H[key] = function (arr) {
- var _a;
- error(32, false, void 0, (_a = {}, _a["Highcharts." + key] = "use Array." + val, _a));
- return Array.prototype[val].apply(arr, [].slice.call(arguments, 1));
- };
- });
- /* eslint-disable valid-jsdoc */
- /**
- * Add an event listener.
- *
- * @function Highcharts.addEvent<T>
- *
- * @param {Highcharts.Class<T>|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>|Function} fn
- * The function callback to execute when the event is fired.
- *
- * @param {Highcharts.EventOptionsObject} [options]
- * Options for adding the event.
- *
- * @return {Function}
- * A callback function to remove the added event.
- */
- function addEvent(el, type, fn, options) {
- /* eslint-enable valid-jsdoc */
- if (options === void 0) { options = {}; }
- // Add hcEvents to either the prototype (in case we're running addEvent on a
- // class) or the instance. If hasOwnProperty('hcEvents') is false, it is
- // inherited down the prototype chain, in which case we need to set the
- // property on this instance (which may itself be a prototype).
- var owner = typeof el === 'function' && el.prototype || el;
- if (!Object.hasOwnProperty.call(owner, 'hcEvents')) {
- owner.hcEvents = {};
- }
- var events = owner.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 && // without H a dependency loop occurs
- el instanceof H.Point &&
- el.series &&
- el.series.chart) {
- el.series.chart.runTrackerClick = true;
- }
- // Handle DOM events
- // If the browser supports passive events, add it to improve performance
- // on touch events (#11353).
- var addEventListener = (el.addEventListener || H.addEventListenerPolyfill);
- if (addEventListener) {
- addEventListener.call(el, type, fn, H.supportsPassiveEvents ? {
- passive: options.passive === void 0 ?
- type.indexOf('touch') !== -1 : options.passive,
- capture: false
- } : false);
- }
- if (!events[type]) {
- events[type] = [];
- }
- var eventObject = {
- fn: fn,
- order: typeof options.order === 'number' ? options.order : Infinity
- };
- events[type].push(eventObject);
- // Order the calls
- events[type].sort(function (a, b) { return a.order - b.order; });
- // Return a function that can be called to remove this event.
- return function () {
- removeEvent(el, type, fn);
- };
- }
- /* eslint-disable valid-jsdoc */
- /**
- * Remove an event that was added with {@link Highcharts#addEvent}.
- *
- * @function Highcharts.removeEvent<T>
- *
- * @param {Highcharts.Class<T>|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.
- *
- * @return {void}
- */
- function removeEvent(el, type, fn) {
- /* eslint-enable valid-jsdoc */
- /**
- * @private
- * @param {string} type - event type
- * @param {Highcharts.EventCallbackFunction<T>} fn - callback
- * @return {void}
- */
- function removeOneEvent(type, fn) {
- var removeEventListener = (el.removeEventListener || H.removeEventListenerPolyfill);
- if (removeEventListener) {
- removeEventListener.call(el, type, fn, false);
- }
- }
- /**
- * @private
- * @param {any} eventCollection - collection
- * @return {void}
- */
- function removeAllEvents(eventCollection) {
- var types, len;
- if (!el.nodeName) {
- return; // break on non-DOM events
- }
- if (type) {
- types = {};
- types[type] = true;
- }
- else {
- types = eventCollection;
- }
- objectEach(types, function (_val, n) {
- if (eventCollection[n]) {
- len = eventCollection[n].length;
- while (len--) {
- removeOneEvent(n, eventCollection[n][len].fn);
- }
- }
- });
- }
- var owner = typeof el === 'function' && el.prototype || el;
- if (Object.hasOwnProperty.call(owner, 'hcEvents')) {
- var events = owner.hcEvents;
- if (type) {
- var typeEvents = (events[type] || []);
- if (fn) {
- events[type] = typeEvents.filter(function (obj) {
- return fn !== obj.fn;
- });
- removeOneEvent(type, fn);
- }
- else {
- removeAllEvents(events);
- events[type] = [];
- }
- }
- else {
- removeAllEvents(events);
- delete owner.hcEvents;
- }
- }
- }
- /* eslint-disable valid-jsdoc */
- /**
- * Fire an event that was registered with {@link Highcharts#addEvent}.
- *
- * @function Highcharts.fireEvent<T>
- *
- * @param {T} 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<*>|Event} [eventArguments]
- * Custom event arguments that are passed on as an argument to the event
- * handler.
- *
- * @param {Highcharts.EventCallbackFunction<T>|Function} [defaultFunction]
- * The default function to execute if the other listeners haven't
- * returned false.
- *
- * @return {void}
- */
- function fireEvent(el, type, eventArguments, defaultFunction) {
- /* eslint-enable valid-jsdoc */
- var e, i;
- eventArguments = eventArguments || {};
- if (doc.createEvent &&
- (el.dispatchEvent ||
- (el.fireEvent &&
- // Enable firing events on Highcharts instance.
- el !== H))) {
- e = doc.createEvent('Events');
- e.initEvent(type, true, true);
- eventArguments = extend(e, eventArguments);
- if (el.dispatchEvent) {
- el.dispatchEvent(eventArguments);
- }
- else {
- el.fireEvent(type, eventArguments);
- }
- }
- else if (el.hcEvents) {
- if (!eventArguments.target) {
- // We're running a custom event
- 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
- });
- }
- var events = [];
- var object = el;
- var multilevel = false;
- // Recurse up the inheritance chain and collect hcEvents set as own
- // objects on the prototypes.
- while (object.hcEvents) {
- if (Object.hasOwnProperty.call(object, 'hcEvents') &&
- object.hcEvents[type]) {
- if (events.length) {
- multilevel = true;
- }
- events.unshift.apply(events, object.hcEvents[type]);
- }
- object = Object.getPrototypeOf(object);
- }
- // For performance reasons, only sort the event handlers in case we are
- // dealing with multiple levels in the prototype chain. Otherwise, the
- // events are already sorted in the addEvent function.
- if (multilevel) {
- // Order the calls
- events.sort(function (a, b) { return a.order - b.order; });
- }
- // Call the collected event handlers
- events.forEach(function (obj) {
- // If the event handler returns false, prevent the default handler
- // from executing
- if (obj.fn.call(el, eventArguments) === false) {
- eventArguments.preventDefault();
- }
- });
- }
- // Run the default if not prevented
- if (defaultFunction && !eventArguments.defaultPrevented) {
- defaultFunction.call(el, eventArguments);
- }
- }
- var serialMode;
- /**
- * 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
- * let id = uniqueKey(); // => 'highcharts-x45f6hp-0'
- *
- * @function Highcharts.uniqueKey
- *
- * @return {string}
- * A unique key.
- */
- var uniqueKey = (function () {
- var hash = Math.random().toString(36).substring(2, 9) + '-';
- var id = 0;
- return function () {
- return 'highcharts-' + (serialMode ? '' : hash) + id++;
- };
- }());
- /**
- * Activates a serial mode for element IDs provided by
- * {@link Highcharts.uniqueKey}. This mode can be used in automated tests, where
- * a simple comparison of two rendered SVG graphics is needed.
- *
- * **Note:** This is only for testing purposes and will break functionality in
- * webpages with multiple charts.
- *
- * @example
- * if (
- * process &&
- * process.env.NODE_ENV === 'development'
- * ) {
- * Highcharts.useSerialIds(true);
- * }
- *
- * @function Highcharts.useSerialIds
- *
- * @param {boolean} [mode]
- * Changes the state of serial mode.
- *
- * @return {boolean|undefined}
- * State of the serial mode.
- */
- function useSerialIds(mode) {
- return (serialMode = pick(mode, serialMode));
- }
- function isFunction(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.events.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 computed-property-spacing, no-new
- // Constructor defaults to Chart
- 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[attr(this[0], 'data-highcharts-chart')];
- }
- };
- }
- // TODO use named exports when supported.
- var utilitiesModule = {
- addEvent: addEvent,
- arrayMax: arrayMax,
- arrayMin: arrayMin,
- attr: attr,
- clamp: clamp,
- cleanRecursively: cleanRecursively,
- clearTimeout: internalClearTimeout,
- correctFloat: correctFloat,
- createElement: createElement,
- css: css,
- defined: defined,
- destroyObjectProperties: destroyObjectProperties,
- discardElement: discardElement,
- erase: erase,
- error: error,
- extend: extend,
- extendClass: extendClass,
- find: find,
- fireEvent: fireEvent,
- getMagnitude: getMagnitude,
- getNestedProperty: getNestedProperty,
- getStyle: getStyle,
- inArray: inArray,
- isArray: isArray,
- isClass: isClass,
- isDOMElement: isDOMElement,
- isFunction: isFunction,
- isNumber: isNumber,
- isObject: isObject,
- isString: isString,
- keys: keys,
- merge: merge,
- normalizeTickInterval: normalizeTickInterval,
- objectEach: objectEach,
- offset: offset,
- pad: pad,
- pick: pick,
- pInt: pInt,
- relativeLength: relativeLength,
- removeEvent: removeEvent,
- splat: splat,
- stableSort: stableSort,
- syncTimeout: syncTimeout,
- timeUnits: timeUnits,
- uniqueKey: uniqueKey,
- useSerialIds: useSerialIds,
- wrap: wrap
- };
- export default utilitiesModule;
|