highcharts 9.3.2 → 10.1.0

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

@@ -1133,7 +1133,7 @@ export default Point;
 * @type {Highcharts.Point}
 */
 /**
- * Configuration hash for the data label and tooltip formatters.
+ * Configuration for the data label and tooltip formatters.
  *
  * @interface Highcharts.PointLabelObject
  */ /**
@@ -1175,7 +1175,7 @@ export default Point;
 */ /**
 * The y value of the point.
 * @name Highcharts.PointLabelObject#y
-* @type {number|undefined}
+* @type {number|null|undefined}
 */
 /**
  * Gets fired when the mouse leaves the area close to the point.

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

@@ -826,8 +826,18 @@ var Series = /** @class */ (function () {
      */
     Series.prototype.setData = function (data, redraw, animation, updatePoints) {
         var series = this, oldData = series.points, oldDataLength = (oldData && oldData.length) || 0, options = series.options, chart = series.chart, dataSorting = options.dataSorting, xAxis = series.xAxis, turboThreshold = options.turboThreshold, xData = this.xData, yData = this.yData, pointArrayMap = series.pointArrayMap, valueCount = pointArrayMap && pointArrayMap.length, keys = options.keys;
-        var i, pt, updatedData, indexOfX = 0, indexOfY = 1, firstPoint = null;
-        data = data || [];
+        var i, pt, updatedData, indexOfX = 0, indexOfY = 1, firstPoint = null, copiedData;
+        if (!chart.options.chart.allowMutatingData) { // #4259
+            // Remove old reference
+            if (options.data) {
+                delete series.options.data;
+            }
+            if (series.userOptions.data) {
+                delete series.userOptions.data;
+            }
+            copiedData = merge(true, data);
+        }
+        data = copiedData || data || [];
         var dataLength = data.length;
         redraw = pick(redraw, true);
         if (dataSorting && dataSorting.enabled) {
@@ -835,7 +845,8 @@ var Series = /** @class */ (function () {
         }
         // First try to run Point.update which is cheaper, allows animation,
         // and keeps references to points.
-        if (updatePoints !== false &&
+        if (chart.options.chart.allowMutatingData &&
+            updatePoints !== false &&
             dataLength &&
             oldDataLength &&
             !series.cropped &&
@@ -1034,7 +1045,7 @@ var Series = /** @class */ (function () {
             xExtremes = xAxis.getExtremes();
             min = xExtremes.min;
             max = xExtremes.max;
-            updatingNames = xAxis.categories && !xAxis.names.length;
+            updatingNames = !!(xAxis.categories && !xAxis.names.length);
         }
         // optionally filter out points outside the plot area
         if (isCartesian &&
@@ -1162,7 +1173,7 @@ var Series = /** @class */ (function () {
      * @function Highcharts.Series#generatePoints
      */
     Series.prototype.generatePoints = function () {
-        var series = this, options = series.options, dataOptions = options.data, processedXData = series.processedXData, processedYData = series.processedYData, PointClass = series.pointClass, processedDataLength = processedXData.length, cropStart = series.cropStart || 0, hasGroupedData = series.hasGroupedData, keys = options.keys, points = [], groupCropStartIndex = (options.dataGrouping &&
+        var series = this, options = series.options, dataOptions = (series.processedData || options.data), processedXData = series.processedXData, processedYData = series.processedYData, PointClass = series.pointClass, processedDataLength = processedXData.length, cropStart = series.cropStart || 0, hasGroupedData = series.hasGroupedData, keys = options.keys, points = [], groupCropStartIndex = (options.dataGrouping &&
             options.dataGrouping.groupAll ?
             cropStart :
             0);
@@ -1448,8 +1459,16 @@ var Series = /** @class */ (function () {
                     !xAxis.validatePositiveValue(xValue)) {
                 point.isNull = true;
             }
-            // Get the plotX translation
+            /**
+             * The translated X value for the point in terms of pixels. Relative
+             * to the X axis position if the series has one, otherwise relative
+             * to the plot area. Depending on the series type this value might
+             * not be defined.
+             * @name Highcharts.Point#plotX
+             * @type {number|undefined}
+             */
             point.plotX = plotX = correctFloat(// #5236
+            // Get the plotX translation
             limitedRange(xAxis.translate(// #3923
             xValue, 0, 0, 0, 1, pointPlacement, this.type === 'flags')) // #3923
             );
@@ -1506,6 +1525,14 @@ var Series = /** @class */ (function () {
             if (isNumber(yValue)) {
                 var translated = yAxis.translate(yValue, false, true, false, true);
                 if (typeof translated !== 'undefined') {
+                    /**
+                     * The translated Y value for the point in terms of pixels.
+                     * Relative to the Y axis position if the series has one,
+                     * otherwise relative to the plot area. Depending on the
+                     * series type this value might not be defined.
+                     * @name Highcharts.Point#plotY
+                     * @type {number|undefined}
+                     */
                     point.plotY = limitedRange(translated);
                 }
             }
@@ -1520,10 +1547,7 @@ var Series = /** @class */ (function () {
                 threshold ||
                 0);
             // some API data
-            point.category = (categories &&
-                typeof categories[point.x] !== 'undefined' ?
-                categories[point.x] :
-                point.x);
+            point.category = pick(categories && categories[point.x], point.x);
             // Determine auto enabling of markers (#3635, #5099)
             if (!point.isNull && point.visible !== false) {
                 if (typeof lastPlotX !== 'undefined') {
@@ -1842,26 +1866,26 @@ var Series = /** @class */ (function () {
     Series.prototype.markerAttribs = function (point, state) {
         var seriesOptions = this.options, seriesMarkerOptions = seriesOptions.marker, pointMarkerOptions = point.marker || {}, symbol = (pointMarkerOptions.symbol ||
             seriesMarkerOptions.symbol);
-        var seriesStateOptions, pointStateOptions, radius = pick(pointMarkerOptions.radius, seriesMarkerOptions.radius);
+        var seriesStateOptions, pointStateOptions, radius = pick(pointMarkerOptions.radius, seriesMarkerOptions && seriesMarkerOptions.radius);
         // Handle hover and select states
         if (state) {
             seriesStateOptions = seriesMarkerOptions.states[state];
             pointStateOptions = pointMarkerOptions.states &&
                 pointMarkerOptions.states[state];
-            radius = pick(pointStateOptions && pointStateOptions.radius, seriesStateOptions && seriesStateOptions.radius, radius + (seriesStateOptions && seriesStateOptions.radiusPlus ||
+            radius = pick(pointStateOptions && pointStateOptions.radius, seriesStateOptions && seriesStateOptions.radius, radius && radius + (seriesStateOptions && seriesStateOptions.radiusPlus ||
                 0));
         }
         point.hasImage = symbol && symbol.indexOf('url') === 0;
         if (point.hasImage) {
             radius = 0; // and subsequently width and height is not set
         }
-        var attribs = {
+        var attribs = isNumber(radius) ? {
             // Math.floor for #1843:
             x: seriesOptions.crisp ?
                 Math.floor(point.plotX - radius) :
                 point.plotX - radius,
             y: point.plotY - radius
-        };
+        } : {};
         if (radius) {
             attribs.width = attribs.height = 2 * radius;
         }
@@ -1933,7 +1957,7 @@ var Series = /** @class */ (function () {
         var series = this, chart = series.chart, issue134 = /AppleWebKit\/533/.test(win.navigator.userAgent), data = series.data || [];
         var destroy, i, point, axis;
         // add event hook
-        fireEvent(series, 'destroy');
+        fireEvent(series, 'destroy', { keepEventsForUpdate: keepEventsForUpdate });
         // remove events
         this.removeEvents(keepEventsForUpdate);
         // erase from axes
@@ -2099,10 +2123,10 @@ var Series = /** @class */ (function () {
         else if (series.visible) {
             // If zones were removed, restore graph and area
             if (graph) {
-                graph.show(true);
+                graph.show();
             }
             if (area) {
-                area.show(true);
+                area.show();
             }
         }
     };
@@ -2552,7 +2576,7 @@ var Series = /** @class */ (function () {
         else if (series.graph) { // create
             series.tracker = renderer.path(trackerPath)
                 .attr({
-                visibility: series.visible ? 'visible' : 'hidden',
+                visibility: series.visible ? 'inherit' : 'hidden',
                 zIndex: 2
             })
                 .addClass(trackByArea ?
@@ -2670,7 +2694,10 @@ var Series = /** @class */ (function () {
             names[x] = point.name;
         }
         dataOptions.splice(i, 0, options);
-        if (isInTheMiddle) {
+        if (isInTheMiddle ||
+            // When processedData is present we need to splice an empty slot
+            // into series.data, otherwise generatePoints won't pick it up.
+            series.processedData) {
             series.data.splice(i, 0, null);
             series.processData();
         }
@@ -2860,6 +2887,8 @@ var Series = /** @class */ (function () {
             typeof options.pointStart !== 'undefined' ||
             typeof options.pointInterval !== 'undefined' ||
             typeof options.relativeXValue !== 'undefined' ||
+            options.joinBy ||
+            options.mapData || // #11636
             // Changes to data grouping requires new points in new group
             series.hasOptionChanged('dataGrouping') ||
             series.hasOptionChanged('pointStart') ||
@@ -2868,9 +2897,12 @@ var Series = /** @class */ (function () {
             series.hasOptionChanged('keys'));
         newType = newType || initialType;
         if (keepPoints) {
-            preserve.push('data', 'isDirtyData', 'points', 'processedXData', 'processedYData', 'xIncrement', 'cropped', '_hasPointMarkers', '_hasPointLabels', 'clips', // #15420
+            preserve.push('data', 'isDirtyData', 'points', 'processedData', // #17057
+            'processedXData', 'processedYData', 'xIncrement', 'cropped', '_hasPointMarkers', '_hasPointLabels', 'clips', // #15420
             // Networkgraph (#14397)
             'nodes', 'layout', 
+            // Treemap
+            'level', 
             // Map specific, consider moving it to series-specific preserve-
             // properties (#10617)
             'mapMap', 'mapData', 'minY', 'maxY', 'minX', 'maxX');
@@ -2922,8 +2954,6 @@ var Series = /** @class */ (function () {
             series.remove(false, false, false, true);
             if (casting) {
                 // Modern browsers including IE11
-                // @todo slow, consider alternatives mentioned:
-                // https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/setPrototypeOf
                 if (Object.setPrototypeOf) {
                     Object.setPrototypeOf(series, seriesTypes[newType].prototype);
                     // Legacy (IE < 11)

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

@@ -1250,6 +1250,9 @@ var seriesDefaults = {
          * parameter, `event`, is passed to the function, containing common
          * event information.
          *
+         * Returning `false` cancels the default behavior, which is to show a
+         * tooltip for the point.
+         *
          * @sample {highcharts} highcharts/plotoptions/series-point-events-mouseover/
          *         Show values in the chart's corner on mouse over
          *
@@ -1972,7 +1975,7 @@ var seriesDefaults = {
              * @deprecated
              *
              * @extends   plotOptions.series.marker
-             * @excluding states
+             * @excluding states, symbol
              * @product   highcharts highstock
              */
             marker: {

package/es-modules/Core/Tooltip.js

@@ -158,6 +158,12 @@ var Tooltip = /** @class */ (function () {
      * the context here is an object holding point, series, x, y etc.
      *
      * @function Highcharts.Tooltip#defaultFormatter
+     *
+     * @param {Highcharts.Tooltip} tooltip
+     *
+     * @return {string|Array<string>}
+     * Returns a string (single tooltip and shared)
+     * or an array of strings (split tooltip)
      */
     Tooltip.prototype.defaultFormatter = function (tooltip) {
         var items = this.points || splat(this);
@@ -710,7 +716,7 @@ var Tooltip = /** @class */ (function () {
     Tooltip.prototype.refresh = function (pointOrPoints, mouseEvent) {
         var tooltip = this, chart = this.chart, options = tooltip.options, points = splat(pointOrPoints), point = points[0], pointConfig = [], formatter = options.formatter || tooltip.defaultFormatter, shared = tooltip.shared, styledMode = chart.styledMode;
         var textConfig = {};
-        if (!options.enabled) {
+        if (!options.enabled || !point.series) { // #16820
             return;
         }
         U.clearTimeout(this.hideTimer);
@@ -1289,46 +1295,23 @@ export default Tooltip;
  * @callback Highcharts.TooltipFormatterCallbackFunction
  *
  * @param {Highcharts.TooltipFormatterContextObject} this
- *        Context to format
+ * Context to format
  *
  * @param {Highcharts.Tooltip} tooltip
- *        The tooltip instance
+ * The tooltip instance
  *
  * @return {false|string|Array<(string|null|undefined)>|null|undefined}
- *         Formatted text or false
+ * Formatted text or false
  */
 /**
+ * Configuration for the tooltip formatters.
+ *
  * @interface Highcharts.TooltipFormatterContextObject
+ * @extends Highcharts.PointLabelObject
  */ /**
-* @name Highcharts.TooltipFormatterContextObject#color
-* @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
-*/ /**
-* @name Highcharts.TooltipFormatterContextObject#colorIndex
-* @type {number|undefined}
-*/ /**
-* @name Highcharts.TooltipFormatterContextObject#key
-* @type {number}
-*/ /**
-* @name Highcharts.TooltipFormatterContextObject#percentage
-* @type {number|undefined}
-*/ /**
-* @name Highcharts.TooltipFormatterContextObject#point
-* @type {Highcharts.Point}
-*/ /**
+* Array of points in shared tooltips.
 * @name Highcharts.TooltipFormatterContextObject#points
 * @type {Array<Highcharts.TooltipFormatterContextObject>|undefined}
-*/ /**
-* @name Highcharts.TooltipFormatterContextObject#series
-* @type {Highcharts.Series}
-*/ /**
-* @name Highcharts.TooltipFormatterContextObject#total
-* @type {number|undefined}
-*/ /**
-* @name Highcharts.TooltipFormatterContextObject#x
-* @type {number}
-*/ /**
-* @name Highcharts.TooltipFormatterContextObject#y
-* @type {number}
 */
 /**
  * A callback function to place the tooltip in a specific position.

package/es-modules/Core/Utilities.js

@@ -197,7 +197,9 @@ function cleanRecursively(newer, older) {
             // Arrays, primitives and DOM nodes are copied directly
         }
         else if (isObject(newer[key]) ||
-            newer[key] !== older[key]) {
+            newer[key] !== older[key] ||
+            // If the newer key is explicitly undefined, keep it (#10525)
+            (key in newer && !(key in older))) {
             result[key] = newer[key];
         }
     });
@@ -365,7 +367,7 @@ function defined(obj) {
  * @param {Highcharts.HTMLDOMElement|Highcharts.SVGDOMElement} elem
  *        The DOM element to receive the attribute(s).
  *
- * @param {string|Highcharts.HTMLAttributes|Highcharts.SVGAttributes} [prop]
+ * @param {string|Highcharts.HTMLAttributes|Highcharts.SVGAttributes} [keyOrAttribs]
  *        The property or an object of key-value pairs.
  *
  * @param {number|string} [value]
@@ -374,33 +376,34 @@ function defined(obj) {
  * @return {string|null|undefined}
  *         When used as a getter, return the value.
  */
-function attr(elem, prop, value) {
+function attr(elem, keyOrAttribs, value) {
+    var isGetter = isString(keyOrAttribs) && !defined(value);
     var ret;
-    // if the prop is a string
-    if (isString(prop)) {
-        // set the value
+    var attrSingle = function (value, key) {
+        // Set the value
         if (defined(value)) {
-            elem.setAttribute(prop, value);
-            // get the value
+            elem.setAttribute(key, value);
+            // Get the value
         }
-        else if (elem && elem.getAttribute) {
-            ret = elem.getAttribute(prop);
+        else if (isGetter) {
+            ret = elem.getAttribute(key);
             // IE7 and below cannot get class through getAttribute (#7850)
-            if (!ret && prop === 'class') {
-                ret = elem.getAttribute(prop + 'Name');
+            if (!ret && key === 'class') {
+                ret = elem.getAttribute(key + 'Name');
             }
+            // Remove the value
         }
-        // else if prop is defined, it is a hash of key/value pairs
+        else {
+            elem.removeAttribute(key);
+        }
+    };
+    // If keyOrAttribs is a string
+    if (isString(keyOrAttribs)) {
+        attrSingle(value, keyOrAttribs);
+        // Else if keyOrAttribs is defined, it is a hash of key/value pairs
     }
     else {
-        objectEach(prop, function (val, key) {
-            if (defined(val)) {
-                elem.setAttribute(key, val);
-            }
-            else {
-                elem.removeAttribute(key);
-            }
-        });
+        objectEach(keyOrAttribs, attrSingle);
     }
     return ret;
 }
@@ -451,10 +454,8 @@ function syncTimeout(fn, delay, context) {
  *
  * @function Highcharts.clearTimeout
  *
- * @param {number} id
- *        Id of a timeout.
- *
- * @return {void}
+ * @param {number|undefined} id
+ * Id of a timeout.
  */
 function internalClearTimeout(id) {
     if (defined(id)) {
@@ -524,9 +525,8 @@ function pick() {
  */
 function css(el, styles) {
     if (H.isMS && !H.svg) { // #2686
-        if (styles && typeof styles.opacity !== 'undefined') {
-            styles.filter =
-                'alpha(opacity=' + (styles.opacity * 100) + ')';
+        if (styles && defined(styles.opacity)) {
+            styles.filter = "alpha(opacity=" + styles.opacity * 100 + ")";
         }
     }
     extend(el.style, styles);
@@ -715,7 +715,7 @@ function getMagnitude(num) {
 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);
+    magnitude = pick(magnitude, getMagnitude(interval));
     var normalized = interval / magnitude;
     // multiples for a linear scale
     if (!multiples) {

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

@@ -318,7 +318,7 @@ var Annotation = /** @class */ (function () {
             opacity: 0,
             zIndex: this.options.zIndex,
             visibility: this.options.visible ?
-                'visible' :
+                'inherit' :
                 'hidden'
         })
             .add();
@@ -355,7 +355,7 @@ var Annotation = /** @class */ (function () {
      */
     Annotation.prototype.setVisibility = function (visible) {
         var options = this.options, navigation = this.chart.navigationBindings, visibility = pick(visible, !options.visible);
-        this.graphic.attr('visibility', visibility ? 'visible' : 'hidden');
+        this.graphic.attr('visibility', visibility ? 'inherit' : 'hidden');
         if (!visibility) {
             this.setControlPointsVisibility(false);
             if (navigation.activeAnnotation === this &&
@@ -1140,6 +1140,13 @@ merge(Annotation.prototype,
          * @since     7.1.0
          * @apioption annotations.events.afterUpdate
          */
+        /**
+         * Fires when the annotation is clicked.
+         *
+         * @type      {Highcharts.EventCallbackFunction<Highcharts.Annotation>}
+         * @since     7.1.0
+         * @apioption annotations.events.click
+         */
         /**
          * Event callback when annotation is removed from the chart.
          *

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

@@ -82,7 +82,7 @@ var ControlPoint = /** @class */ (function () {
      *
      */
     ControlPoint.prototype.setVisibility = function (visible) {
-        this.graphic.attr('visibility', visible ? 'visible' : 'hidden');
+        this.graphic[visible ? 'show' : 'hide']();
         this.options.visible = visible;
     };
     /**

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

@@ -329,7 +329,7 @@ var MockPoint = /** @class */ (function () {
             this.plotX = xAxis.toPixels(options.x, true);
         }
         else {
-            this.x = null;
+            this.x = void 0;
             this.plotX = options.x;
         }
         if (yAxis) {

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

@@ -948,6 +948,14 @@ setOptions({
                     }
                 ]
             },
+            /**
+             * A ellipse annotation bindings. Includes `start` and two events in
+             * `steps` array. First updates the second point, responsible for a
+             * rx width, and second updates the ry width.
+             *
+             * @type    {Highcharts.NavigationBindingsOptionsObject}
+             * @default {"className": "highcharts-ellipse-annotation", "start": function() {}, "steps": [function() {}], "annotationsOptions": {}}
+             */
             ellipseAnnotation: {
                 className: 'highcharts-ellipse-annotation',
                 start: function (e) {
@@ -1094,7 +1102,7 @@ setOptions({
          * from a different server.
          *
          * @type      {string}
-         * @default   https://code.highcharts.com/9.3.2/gfx/stock-icons/
+         * @default   https://code.highcharts.com/10.1.0/gfx/stock-icons/
          * @since     7.1.3
          * @apioption navigation.iconsURL
          */

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

@@ -1111,7 +1111,7 @@ addEvent(NavigationBindings, 'showPopup', function (config) {
         this.popup = new H.Popup(this.chart.container, (this.chart.options.navigation.iconsURL ||
             (this.chart.options.stockTools &&
                 this.chart.options.stockTools.gui.iconsURL) ||
-            'https://code.highcharts.com/9.3.2/gfx/stock-icons/'), this.chart);
+            'https://code.highcharts.com/10.1.0/gfx/stock-icons/'), this.chart);
     }
     this.popup.showForm(config.formType, this.chart, config.options, config.onSubmit);
 });

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

@@ -47,11 +47,13 @@ var BasicAnnotation = /** @class */ (function (_super) {
         var options = this.options;
         if (options.shapes) {
             delete options.labelOptions;
-            if (options.shapes[0].type) {
-                this.basicType = options.shapes[0].type;
+            var type = options.shapes[0].type;
+            // The rectangle is rendered as a path, whereas other basic shapes
+            // are rendered as their respecitve SVG shapes.
+            if (type && type !== 'path') {
+                this.basicType = type;
             }
             else {
-                // Defalut shape would be rectangle.
                 this.basicType = 'rectangle';
             }
         }

package/es-modules/Extensions/Boost/BoostInit.js

@@ -165,7 +165,7 @@ function init() {
                                 }
                             }
                             // Add points and reset
-                            if (clientX !== lastClientX) {
+                            if (!compareX || clientX !== lastClientX) {
                                 // maxI is number too:
                                 if (typeof minI !== 'undefined') {
                                     plotY =
@@ -242,6 +242,11 @@ function init() {
         fillOpacity: true,
         sampling: true
     });
+    extend(seriesTypes.areaspline.prototype, {
+        fill: true,
+        fillOpacity: true,
+        sampling: true
+    });
     extend(seriesTypes.column.prototype, {
         fill: true,
         sampling: true

package/es-modules/Extensions/Boost/BoostOptions.js

@@ -149,6 +149,32 @@ import '../../Core/Globals.js';
  * @default   false
  * @apioption boost.debug.timeBufferCopy
  */
+/**
+ * The pixel ratio for the WebGL content. If 0, the `window.devicePixelRatio` is
+ * used. This ensures sharp graphics on high DPI displays like Apple's Retina,
+ * as well as when a page is zoomed.
+ *
+ * The default is left at 1 for now, as this is a new feature that has the
+ * potential to break existing setups. Over time, when it has been battle
+ * tested, the intention is to set it to 0 by default.
+ *
+ * Another use case for this option is to set it to 2 in order to make exported
+ * and upscaled charts render sharp.
+ *
+ * One limitation when using the `pixelRatio` is that the line width of graphs
+ * is scaled down. Since the Boost module currently can only render 1px line
+ * widths, it is scaled down to a thin 0.5 pixels on a Retina display.
+ *
+ * @sample    highcharts/boost/line-devicepixelratio
+ *            Enable the `devicePixelRatio`
+ * @sample    highcharts/boost/line-export-pixelratio
+ *            Sharper graphics in export
+ *
+ * @type      {number}
+ * @since 10.0.0
+ * @default   1
+ * @apioption boost.pixelRatio
+ */
 /**
  * Enable or disable GPU translations. GPU translations are faster than doing
  * the translation in JavaScript.

package/es-modules/Extensions/Boost/Boostables.js

@@ -12,6 +12,7 @@
 // These are the series we allow boosting for.
 var boostables = [
     'area',
+    'areaspline',
     'arearange',
     'column',
     'columnrange',