highcharts 9.1.1 → 9.2.2

package/es-modules/Core/Utilities.js

@@ -10,415 +10,99 @@
 '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.
+ *  Functions
  *
- * @callback Highcharts.AnimationStepCallbackFunction
+ * */
+/**
+ * Provide error messages for debugging, with links to online explanation. This
+ * function can be overridden to provide custom error handling.
  *
- * @param {Highcharts.SVGElement} this
- *        The SVG element to animate.
+ * @sample highcharts/chart/highcharts-error/
+ *         Custom error handler
  *
- * @return {void}
- */
-/**
- * Interface description for a class.
+ * @function Highcharts.error
  *
- * @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.
+ * @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.
  *
- * @example
- * {
- *    fontFamily: 'monospace',
- *    fontSize: '1.2em'
- * }
+ * @param {boolean} [stop=false]
+ *        Whether to throw an error or just log a warning in the console.
  *
- * @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.
+ * @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.
  *
- * @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.
+ * @param {Highcharts.Dictionary<string>} [params]
+ *        Additional parameters for the generated message.
  *
- * @typedef {'Dash'|'DashDot'|'Dot'|'LongDash'|'LongDashDot'|'LongDashDotDot'|'ShortDash'|'ShortDashDot'|'ShortDashDotDot'|'ShortDot'|'Solid'} Highcharts.DashStyleValue
+ * @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(H, 'displayError', { chart: chart, code: code, message: message, params: params }, defaultHandler);
+    error.messages.push(message);
+}
+(function (error) {
+    error.messages = [];
+})(error || (error = {}));
+/* eslint-disable valid-jsdoc */
 /**
- * Generic dictionary in TypeScript notation.
- * Use the native `AnyRecord` instead.
+ * 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.
  *
- * @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.
+ * @function Highcharts.merge<T>
  *
- * @callback Highcharts.EventCallbackFunction<T>
+ * @param {boolean} extend
+ *        Whether to extend the left-side object (a) or return a whole new
+ *        object.
  *
- * @param {T} this
+ * @param {T|undefined} a
+ *        The first object to extend. When only this is given, the function
+ *        returns a deep copy.
  *
- * @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(H, '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.
+ * @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
@@ -1903,6 +1587,11 @@ if (win.jQuery) {
         }
     };
 }
+/* *
+ *
+ *  Default Export
+ *
+ * */
 // TODO use named exports when supported.
 var Utilities = {
     addEvent: addEvent,
@@ -1954,3 +1643,329 @@ var Utilities = {
     wrap: wrap
 };
 export default Utilities;
+/* *
+ *
+ *  API Declarations
+ *
+ * */
+/**
+ * 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