highcharts 8.2.0 → 8.2.2

package/es-modules/Core/Series/Series3D.js

@@ -15,7 +15,7 @@ import Math3D from '../../Extensions/Math3D.js';
 var perspective = Math3D.perspective;
 import U from '../Utilities.js';
 var addEvent = U.addEvent, pick = U.pick;
-import './Series.js';
+import '../../Series/LineSeries.js';
 /* eslint-disable no-invalid-this */
 // Wrap the translate method to post-translate points into 3D perspective
 addEvent(H.Series, 'afterTranslate', function () {

package/es-modules/Core/Tooltip.js

@@ -78,7 +78,7 @@ var clamp = U.clamp, css = U.css, defined = U.defined, discardElement = U.discar
  * @param {number} labelHeight
  * Height of the tooltip.
  *
- * @param {Highcharts.Point|Highcharts.TooltipPositionerPointObject} point
+ * @param {Highcharts.TooltipPositionerPointObject} point
  * Point information for positioning a tooltip.
  *
  * @return {Highcharts.PositionObject}
@@ -88,6 +88,7 @@ var clamp = U.clamp, css = U.css, defined = U.defined, discardElement = U.discar
  * Point information for positioning a tooltip.
  *
  * @interface Highcharts.TooltipPositionerPointObject
+ * @extends Highcharts.Point
  */ /**
 * If `tooltip.split` option is enabled and positioner is called for each of the
 * boxes separately, this property indicates the call on the xAxis header, which

package/es-modules/Core/Utilities.js

@@ -397,368 +397,6 @@ function error(code, stop, chart, params) {
     error.messages = [];
 })(error || (error = {}));
 H.error = error;
-/* eslint-disable no-invalid-this, valid-jsdoc */
-/**
- * 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
- * @name Highcharts.Fx
- */
-var Fx = /** @class */ (function () {
-    /* *
-     *
-     *  Constructors
-     *
-     * */
-    /**
-     *
-     * @param {Highcharts.HTMLDOMElement|Highcharts.SVGElement} elem
-     *        The element to animate.
-     *
-     * @param {Partial<Highcharts.AnimationOptionsObject>} options
-     *        Animation options.
-     *
-     * @param {string} prop
-     *        The single attribute or CSS property to animate.
-     */
-    function Fx(elem, options, prop) {
-        this.options = options;
-        this.elem = elem;
-        this.prop = prop;
-    }
-    /* *
-     *
-     *  Functions
-     *
-     * */
-    /**
-     * Set the current step of a path definition on SVGElement.
-     *
-     * @function Highcharts.Fx#dSetter
-     *
-     * @return {void}
-     */
-    Fx.prototype.dSetter = function () {
-        var paths = this.paths, start = paths && paths[0], end = paths && paths[1], path = [], now = this.now || 0;
-        // Land on the final path without adjustment points appended in the ends
-        if (now === 1 || !start || !end) {
-            path = this.toD || [];
-        }
-        else if (start.length === end.length && now < 1) {
-            for (var i = 0; i < end.length; i++) {
-                // Tween between the start segment and the end segment. Start
-                // with a copy of the end segment and tween the appropriate
-                // numerics
-                var startSeg = start[i];
-                var endSeg = end[i];
-                var tweenSeg = [];
-                for (var j = 0; j < endSeg.length; j++) {
-                    var startItem = startSeg[j];
-                    var endItem = endSeg[j];
-                    // Tween numbers
-                    if (typeof startItem === 'number' &&
-                        typeof endItem === 'number' &&
-                        // Arc boolean flags
-                        !(endSeg[0] === 'A' && (j === 4 || j === 5))) {
-                        tweenSeg[j] = startItem + now * (endItem - startItem);
-                        // Strings, take directly from the end segment
-                    }
-                    else {
-                        tweenSeg[j] = endItem;
-                    }
-                }
-                path.push(tweenSeg);
-            }
-            // If animation is finished or length not matching, land on right value
-        }
-        else {
-            path = end;
-        }
-        this.elem.attr('d', path, void 0, true);
-    };
-    /**
-     * Update the element with the current animation step.
-     *
-     * @function Highcharts.Fx#update
-     *
-     * @return {void}
-     */
-    Fx.prototype.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`.
-     *
-     * @return {void}
-     */
-    Fx.prototype.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.
-     */
-    Fx.prototype.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;
-            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 {Highcharts.SVGPathArray|undefined} fromD
-     *        Starting path definition.
-     *
-     * @param {Highcharts.SVGPathArray} toD
-     *        Ending path definition.
-     *
-     * @return {Array<Highcharts.SVGPathArray,Highcharts.SVGPathArray>}
-     *         An array containing start and end paths in array form so that
-     *         they can be animated in parallel.
-     */
-    Fx.prototype.initPath = function (elem, fromD, toD) {
-        var shift, startX = elem.startX, endX = elem.endX, fullLength, i, start = fromD && fromD.slice(), // copy
-        end = toD.slice(), // copy
-        isArea = elem.isArea, positionFactor = isArea ? 2 : 1, reverse;
-        if (!start) {
-            return [end, end];
-        }
-        /**
-         * If shifting points, prepend a dummy point to the end path.
-         * @private
-         * @param {Highcharts.SVGPathArray} arr - array
-         * @param {Highcharts.SVGPathArray} other - array
-         * @return {void}
-         */
-        function prepend(arr, other) {
-            while (arr.length < fullLength) {
-                // Move to, line to or curve to?
-                var moveSegment = arr[0], otherSegment = other[fullLength - arr.length];
-                if (otherSegment && moveSegment[0] === 'M') {
-                    if (otherSegment[0] === 'C') {
-                        arr[0] = [
-                            'C',
-                            moveSegment[1],
-                            moveSegment[2],
-                            moveSegment[1],
-                            moveSegment[2],
-                            moveSegment[1],
-                            moveSegment[2]
-                        ];
-                    }
-                    else {
-                        arr[0] = ['L', moveSegment[1], moveSegment[2]];
-                    }
-                }
-                // Prepend a copy of the first point
-                arr.unshift(moveSegment);
-                // For areas, the bottom path goes back again to the left, so we
-                // need to append a copy of the last point.
-                if (isArea) {
-                    arr.push(arr[arr.length - 1]);
-                }
-            }
-        }
-        /**
-         * Copy and append last point until the length matches the end length.
-         * @private
-         * @param {Highcharts.SVGPathArray} arr - array
-         * @param {Highcharts.SVGPathArray} other - array
-         * @return {void}
-         */
-        function append(arr, other) {
-            while (arr.length < fullLength) {
-                // 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.
-                var segmentToAdd = arr[arr.length / positionFactor - 1].slice();
-                // Disable the first control point of curve segments
-                if (segmentToAdd[0] === 'C') {
-                    segmentToAdd[1] = segmentToAdd[5];
-                    segmentToAdd[2] = segmentToAdd[6];
-                }
-                if (!isArea) {
-                    arr.push(segmentToAdd);
-                }
-                else {
-                    var lowerSegmentToAdd = arr[arr.length / positionFactor].slice();
-                    arr.splice(arr.length / 2, 0, segmentToAdd, lowerSegmentToAdd);
-                }
-            }
-        }
-        // 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;
-                    // Fixed from the right side, "scaling" left
-                }
-                else if (startX[startX.length - 1] ===
-                    endX[endX.length - startX.length + i]) {
-                    shift = startX.length - i;
-                    break;
-                }
-            }
-            if (typeof shift === 'undefined') {
-                start = [];
-            }
-        }
-        if (start.length && 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;
-            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
-     *
-     * @return {void}
-     */
-    Fx.prototype.fillSetter = function () {
-        Fx.prototype.strokeSetter.apply(this, arguments);
-    };
-    /**
-     * Handle animation of the color attributes directly.
-     *
-     * @function Highcharts.Fx#strokeSetter
-     *
-     * @return {void}
-     */
-    Fx.prototype.strokeSetter = function () {
-        this.elem.attr(this.prop, H.color(this.start).tweenTo(H.color(this.end), this.pos), null, true);
-    };
-    return Fx;
-}());
-H.Fx = Fx;
 /* eslint-disable valid-jsdoc */
 /**
  * Utility function to deep merge two or more objects and return a third object.
@@ -1549,8 +1187,6 @@ var arrayMax = H.arrayMax = function arrayMax(data) {
  *
  * @param {*} [except]
  *        Exception, do not destroy this property, only delete it.
- *
- * @return {void}
  */
 var destroyObjectProperties = H.destroyObjectProperties =
     function destroyObjectProperties(obj, except) {
@@ -1571,8 +1207,6 @@ var destroyObjectProperties = H.destroyObjectProperties =
  *
  * @param {Highcharts.HTMLDOMElement} element
  *        The HTML node to discard.
- *
- * @return {void}
  */
 var discardElement = H.discardElement = function discardElement(element) {
     var garbageBin = H.garbageBin;
@@ -1603,45 +1237,6 @@ var discardElement = H.discardElement = function discardElement(element) {
 var correctFloat = H.correctFloat = function correctFloat(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|Partial<Highcharts.AnimationOptionsObject>|undefined} animation
- *        The animation object.
- *
- * @param {Highcharts.Chart} chart
- *        The chart instance.
- *
- * @return {void}
- *
- * @todo
- * This function always relates to a chart, and sets a property on the renderer,
- * so it should be moved to the SVGRenderer.
- */
-var setAnimation = H.setAnimation = function setAnimation(animation, chart) {
-    chart.renderer.globalAnimation = 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=0]
- *        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.
- */
-var animObject = H.animObject = function animObject(animation) {
-    return isObject(animation) ?
-        H.merge({ duration: 500, defer: 0 }, animation) :
-        { duration: animation ? 500 : 0, defer: 0 };
-};
 /**
  * The time unit lookup
  *
@@ -1856,39 +1451,6 @@ var getStyle = H.getStyle = function (el, prop, toInt) {
     }
     return style;
 };
-/**
- * Get the defer as a number value from series animation options.
- *
- * @function Highcharts.getDeferredAnimation
- *
- * @param {Highcharts.Chart} chart
- *        The chart instance.
- *
- * @return {number}
- *        The numeric value.
- */
-var getDeferredAnimation = H.getDeferredAnimation = function (chart, animation, series) {
-    var labelAnimation = animObject(animation);
-    var s = series ? [series] : chart.series;
-    var defer = 0;
-    var duration = 0;
-    s.forEach(function (series) {
-        var seriesAnim = animObject(series.options.animation);
-        defer = animation && defined(animation.defer) ?
-            labelAnimation.defer :
-            Math.max(defer, seriesAnim.duration + seriesAnim.defer);
-        duration = Math.min(labelAnimation.duration, seriesAnim.duration);
-    });
-    // Disable defer for exporting
-    if (chart.renderer.forExport) {
-        defer = 0;
-    }
-    var anim = {
-        defer: Math.max(0, defer - duration),
-        duration: Math.min(defer, duration)
-    };
-    return anim;
-};
 /**
  * Search for an item in an array.
  *
@@ -1982,36 +1544,6 @@ var offset = H.offset = function offset(el) {
             (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.
- *
- * @return {void}
- *
- * @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.
- */
-var stop = 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
-        }
-    }
-};
 /* eslint-disable valid-jsdoc */
 /**
  * Iterate over object key pairs in an object.
@@ -2377,113 +1909,6 @@ var fireEvent = H.fireEvent = function (el, type, eventArguments, defaultFunctio
         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.CSSObject|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 {Partial<Highcharts.AnimationOptionsObject>} [opt]
- *        Animation options.
- *
- * @return {void}
- */
-var animate = H.animate = function (el, params, opt) {
-    var start, unit = '', end, fx, args;
-    if (!isObject(opt)) { // Number or undefined/null
-        args = arguments;
-        opt = {
-            duration: args[2],
-            easing: args[3],
-            complete: args[4]
-        };
-    }
-    if (!isNumber(opt.duration)) {
-        opt.duration = 400;
-    }
-    opt.easing = typeof opt.easing === 'function' ?
-        opt.easing :
-        (Math[opt.easing] || Math.easeInOutSine);
-    opt.curAnim = merge(params);
-    objectEach(params, function (val, prop) {
-        // Stop current running animation of this property
-        stop(el, prop);
-        fx = new Fx(el, opt, prop);
-        end = null;
-        if (prop === 'd' && isArray(params.d)) {
-            fx.paths = fx.initPath(el, el.pathArray, params.d);
-            fx.toD = params.d;
-            start = 0;
-            end = 1;
-        }
-        else if (el.attr) {
-            start = el.attr(prop);
-        }
-        else {
-            start = parseFloat(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 {Highcharts.SeriesOptionsType|Highcharts.Dictionary<*>} options
- *        The additional default options that are merged with the parent's
- *        options.
- *
- * @param {Highcharts.Dictionary<*>} [props]
- *        The properties (functions and primitives) to set on the new
- *        prototype.
- *
- * @param {Highcharts.Dictionary<*>} [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
-var seriesType = H.seriesType = function (type, parent, options, props, pointProps) {
-    var defaultOptions = getOptions(), seriesTypes = H.seriesTypes;
-    // Merge the options
-    defaultOptions.plotOptions[type] = merge(defaultOptions.plotOptions[parent], options);
-    // Create the class
-    seriesTypes[type] = extendClass(seriesTypes[parent] || function () { }, props);
-    seriesTypes[type].prototype.type = type;
-    // Create the point class if needed
-    if (pointProps) {
-        seriesTypes[type].prototype.pointClass =
-            extendClass(H.Point, pointProps);
-    }
-    return seriesTypes[type];
-};
 var serialMode;
 /**
  * Get a unique key for using in internal element id's and pointers. The key is
@@ -2625,10 +2050,7 @@ if (win.jQuery) {
 }
 // TODO use named exports when supported.
 var utilitiesModule = {
-    Fx: H.Fx,
     addEvent: addEvent,
-    animate: animate,
-    animObject: animObject,
     arrayMax: arrayMax,
     arrayMin: arrayMin,
     attr: attr,
@@ -2647,7 +2069,6 @@ var utilitiesModule = {
     find: find,
     fireEvent: fireEvent,
     format: format,
-    getDeferredAnimation: getDeferredAnimation,
     getMagnitude: getMagnitude,
     getNestedProperty: getNestedProperty,
     getOptions: getOptions,
@@ -2670,12 +2091,9 @@ var utilitiesModule = {
     pInt: pInt,
     relativeLength: relativeLength,
     removeEvent: removeEvent,
-    seriesType: seriesType,
-    setAnimation: setAnimation,
     setOptions: setOptions,
     splat: splat,
     stableSort: stableSort,
-    stop: stop,
     syncTimeout: syncTimeout,
     timeUnits: timeUnits,
     uniqueKey: uniqueKey,

package/es-modules/Extensions/Annotations/Annotations.js

@@ -8,6 +8,8 @@
  *
  * */
 'use strict';
+import A from '../../Core/Animation/AnimationUtilities.js';
+var getDeferredAnimation = A.getDeferredAnimation;
 import Chart from '../../Core/Chart/Chart.js';
 var chartProto = Chart.prototype;
 import ControllableMixin from './Mixins/ControllableMixin.js';
@@ -22,7 +24,7 @@ import H from '../../Core/Globals.js';
 import MockPoint from './MockPoint.js';
 import Pointer from '../../Core/Pointer.js';
 import U from '../../Core/Utilities.js';
-var addEvent = U.addEvent, defined = U.defined, destroyObjectProperties = U.destroyObjectProperties, erase = U.erase, extend = U.extend, find = U.find, fireEvent = U.fireEvent, getDeferredAnimation = U.getDeferredAnimation, merge = U.merge, pick = U.pick, splat = U.splat, wrap = U.wrap;
+var addEvent = U.addEvent, defined = U.defined, destroyObjectProperties = U.destroyObjectProperties, erase = U.erase, extend = U.extend, find = U.find, fireEvent = U.fireEvent, merge = U.merge, pick = U.pick, splat = U.splat, wrap = U.wrap;
 /* *********************************************************************
  *
  * ANNOTATION
@@ -995,7 +997,7 @@ merge(Annotation.prototype,
              *         Basic shape annotation
              *
              * @type      {string}
-             * @default   'rect'
+             * @default   rect
              * @apioption annotations.shapeOptions.type
              */
             /**