highcharts 9.3.1 → 10.0.0

package/es-modules/Series/Organization/OrganizationSeries.js

@@ -178,24 +178,9 @@ var OrganizationSeries = /** @class */ (function (_super) {
         };
         return node;
     };
-    OrganizationSeries.prototype.createNodeColumn = function () {
-        var column = _super.prototype.createNodeColumn.call(this);
-        // Wrap the offset function so that the hanging node's children are
-        // aligned to their parent
-        wrap(column, 'offset', function (proceed, node, factor) {
-            var offset = proceed.call(this, node, factor); // eslint-disable-line no-invalid-this
-            // Modify the default output if the parent's layout is 'hanging'
-            if (node.hangsFrom) {
-                return {
-                    absoluteTop: node.hangsFrom.nodeY
-                };
-            }
-            return offset;
-        });
-        return column;
-    };
     OrganizationSeries.prototype.pointAttribs = function (point, state) {
-        var series = this, attribs = SankeySeries.prototype.pointAttribs.call(series, point, state), level = point.isNode ? point.level : point.fromNode.level, levelOptions = series.mapOptionsToLevel[level || 0] || {}, options = point.options, stateOptions = (levelOptions.states && levelOptions.states[state]) || {}, values = ['borderRadius', 'linkColor', 'linkLineWidth']
+        var series = this, attribs = SankeySeries.prototype.pointAttribs.call(series, point, state), level = point.isNode ? point.level : point.fromNode.level, levelOptions = series.mapOptionsToLevel[level || 0] || {}, options = point.options, stateOptions = (levelOptions.states &&
+            levelOptions.states[state]) || {}, values = ['borderRadius', 'linkColor', 'linkLineWidth']
             .reduce(function (obj, key) {
             obj[key] = pick(stateOptions[key], options[key], levelOptions[key], series.options[key]);
             return obj;
@@ -263,16 +248,37 @@ var OrganizationSeries = /** @class */ (function (_super) {
     };
     OrganizationSeries.prototype.translateNode = function (node, column) {
         SankeySeries.prototype.translateNode.call(this, node, column);
-        if (node.hangsFrom) {
-            node.shapeArgs.height -=
-                this.options.hangingIndent;
-            if (!this.chart.inverted) {
-                node.shapeArgs.y += this.options.hangingIndent;
+        var parentNode = node.hangsFrom, indent = this.options.hangingIndent || 0, sign = this.chart.inverted ? -1 : 1, shapeArgs = node.shapeArgs, indentLogic = this.options.hangingIndentTranslation, minLength = this.options.minNodeLength || 10;
+        if (parentNode) {
+            if (indentLogic === 'cumulative') {
+                // Move to the right:
+                shapeArgs.height -= indent;
+                shapeArgs.y -= sign * indent;
+                while (parentNode) {
+                    shapeArgs.y += sign * indent;
+                    parentNode = parentNode.hangsFrom;
+                }
+            }
+            else if (indentLogic === 'shrink') {
+                // Resize the node:
+                while (parentNode &&
+                    shapeArgs.height > indent + minLength) {
+                    shapeArgs.height -= indent;
+                    parentNode = parentNode.hangsFrom;
+                }
+            }
+            else {
+                // indentLogic === "inherit"
+                // Do nothing (v9.3.2 and prev versions):
+                shapeArgs.height -= indent;
+                if (!this.chart.inverted) {
+                    shapeArgs.y += indent;
+                }
             }
         }
         node.nodeHeight = this.chart.inverted ?
-            node.shapeArgs.width :
-            node.shapeArgs.height;
+            shapeArgs.width :
+            shapeArgs.height;
     };
     /**
      * An organization chart is a diagram that shows the structure of an
@@ -426,6 +432,31 @@ var OrganizationSeries = /** @class */ (function (_super) {
          * @private
          */
         hangingIndent: 20,
+        /**
+         * Defines the indentation of a `hanging` layout parent's children.
+         * Possible options:
+         *
+         * - `inherit` (default): Only the first child adds the indentation,
+         * children of a child with indentation inherit the indentation.
+         * - `cumulative`: All children of a child with indentation add its
+         * own indent. The option may cause overlapping of nodes.
+         * Then use `shrink` option:
+         * - `shrink`: Nodes shrink by the
+         * [hangingIndent](#plotOptions.organization.hangingIndent)
+         * value until they reach the
+         * [minNodeLength](#plotOptions.organization.minNodeLength).
+         *
+         * @sample highcharts/series-organization/hanging-cumulative
+         *         Every indent increases the indentation
+         *
+         * @sample highcharts/series-organization/hanging-shrink
+         *         Every indent decreases the nodes' width
+         *
+         * @type {Highcharts.OrganizationHangingIndentTranslationValue}
+         * @since 10.0.0
+         * @default inherit
+         */
+        hangingIndentTranslation: 'inherit',
         /**
          * The color of the links between nodes.
          *
@@ -443,10 +474,25 @@ var OrganizationSeries = /** @class */ (function (_super) {
          */
         linkLineWidth: 1,
         /**
-         * In a horizontal chart, the width of the nodes in pixels. Node that
+         * In a horizontal chart, the minimum width of the **hanging** nodes
+         * only, in pixels. In a vertical chart, the minimum height of the
+         * **haning** nodes only, in pixels too.
+         *
+         * Note: Used only when
+         * [hangingIndentTranslation](#plotOptions.organization.hangingIndentTranslation)
+         * is set to `shrink`.
+         *
+         * @see [nodeWidth](#plotOptions.organization.nodeWidth)
+         * @private
+         */
+        minNodeLength: 10,
+        /**
+         * In a horizontal chart, the width of the nodes in pixels. Note that
          * most organization charts are vertical, so the name of this option
          * is counterintuitive.
          *
+         * @see [minNodeLength](#plotOptions.organization.minNodeLength)
+         *
          * @private
          */
         nodeWidth: 50,
@@ -478,6 +524,13 @@ export default OrganizationSeries;
  *
  * @typedef {"normal"|"hanging"} Highcharts.SeriesOrganizationNodesLayoutValue
  */
+/**
+ * Indent translation value for the child nodes in an organization chart, when
+ * parent has `hanging` layout. Option can shrink nodes (for tight charts),
+ * translate children to the left, or render nodes directly under the parent.
+ *
+ * @typedef {"inherit"|"cumulative"|"shrink"} Highcharts.OrganizationHangingIndentTranslationValue
+ */
 ''; // detach doclets above
 /* *
  *
@@ -544,6 +597,9 @@ export default OrganizationSeries;
  * Layout for the node's children. If `hanging`, this node's children will hang
  * below their parent, allowing a tighter packing of nodes in the diagram.
  *
+ * Note: Since @next version, the `hanging` layout is set by default for
+ * children of a parent using `hanging` layout.
+ *
  * @sample highcharts/demo/organization-chart
  *         Hanging layout
  *

package/es-modules/Series/PackedBubble/PackedBubbleComposition.js

@@ -80,6 +80,7 @@ H.layouts.packedbubble = extendClass(Reingold, {
             });
         }
     },
+    // #14439, new stable check.
     isStable: function () {
         var tempDiff = Math.abs(this.prevSystemTemperature -
             this.systemTemperature);

package/es-modules/Series/PackedBubble/PackedBubblePoint.js

@@ -69,7 +69,7 @@ var PackedBubblePoint = /** @class */ (function (_super) {
         var point = this, series = this.series, seriesOptions = series.options;
         if (this.isParentNode && seriesOptions.parentNode) {
             var temp = seriesOptions.allowPointSelect;
-            seriesOptions.allowPointSelect = seriesOptions.parentNode.allowPointSelect;
+            seriesOptions.allowPointSelect = (seriesOptions.parentNode.allowPointSelect);
             Point.prototype.firePointEvent.apply(this, arguments);
             seriesOptions.allowPointSelect = temp;
         }

package/es-modules/Series/PackedBubble/PackedBubbleSeries.js

@@ -200,9 +200,6 @@ var PackedBubbleSeries = /** @class */ (function (_super) {
     /**
      * Check if two bubbles overlaps.
      * @private
-     * @param {Array} first bubble
-     * @param {Array} second bubble
-     * @return {Boolean} overlap or not
      */
     PackedBubbleSeries.prototype.checkOverlap = function (bubble1, bubble2) {
         var diffX = bubble1[0] - bubble2[0], // diff of X center values
@@ -332,7 +329,8 @@ var PackedBubbleSeries = /** @class */ (function (_super) {
             return;
         }
         var series = this, chart = series.chart, parentAttribs = {}, nodeMarker = this.layout.options.parentNodeOptions.marker, parentOptions = {
-            fill: nodeMarker.fillColor || color(series.color).brighten(0.4).get(),
+            fill: (nodeMarker.fillColor ||
+                color(series.color).brighten(0.4).get()),
             opacity: nodeMarker.fillOpacity,
             stroke: nodeMarker.lineColor || series.color,
             'stroke-width': pick(nodeMarker.lineWidth, series.options.lineWidth)

package/es-modules/Series/Pie/PiePoint.js

@@ -118,12 +118,19 @@ var PiePoint = /** @class */ (function (_super) {
         return isNumber(this.y) && this.y >= 0;
     };
     /**
-     * Toggle the visibility of the pie slice.
-     * @private
+     * Toggle the visibility of a pie slice or other data point. Note that this
+     * method is available only for some series, like pie, treemap and sunburst.
+     *
+     * @function Highcharts.Point#setVisible
+     *
+     * @param {boolean} [vis]
+     * True to show the pie slice or other data point, false to hide. If
+     * undefined, the visibility is toggled.
+     *
+     * @param {boolean} [redraw] Whether to redraw the chart after the point is
+     * altered. If doing more operations on the chart, it is a good idea to set
+     * redraw to false and call {@link Chart#redraw|chart.redraw()} after.
      *
-     * @param {boolean} vis
-     * Whether to show the slice or not. If undefined, the visibility is
-     * toggled.
      */
     PiePoint.prototype.setVisible = function (vis, redraw) {
         var _this = this;
@@ -167,10 +174,10 @@ var PiePoint = /** @class */ (function (_super) {
      * @param {boolean} sliced
      * When undefined, the slice state is toggled.
      *
-     * @param {boolean} redraw
+     * @param {boolean} [redraw]
      * Whether to redraw the chart. True by default.
      *
-     * @param {boolean|Partial<Highcharts.AnimationOptionsObject>}
+     * @param {boolean|Partial<Highcharts.AnimationOptionsObject>} [animation]
      * Animation options.
      */
     PiePoint.prototype.slice = function (sliced, redraw, animation) {

package/es-modules/Series/Pie/PieSeries.js

@@ -926,7 +926,7 @@ var PieSeries = /** @class */ (function (_super) {
          */
         borderWidth: 1,
         /**
-         * @ignore-options
+         * @ignore-option
          * @private
          */
         lineWidth: void 0,

package/es-modules/Series/Pie3D/Pie3DComposition.js

@@ -22,5 +22,6 @@ import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
  *  Composition
  *
  * */
-SeriesRegistry.seriesTypes.pie.prototype.pointClass.prototype.haloPath = Pie3DPoint.prototype.haloPath;
+SeriesRegistry.seriesTypes.pie.prototype.pointClass.prototype
+    .haloPath = Pie3DPoint.prototype.haloPath;
 SeriesRegistry.seriesTypes.pie = Pie3DSeries;

package/es-modules/Series/Pie3D/Pie3DPoint.js

@@ -59,7 +59,8 @@ var Pie3DPoint = /** @class */ (function (_super) {
      * @private
      */
     Pie3DPoint.prototype.haloPath = function () {
-        return this.series.chart.is3d() ? [] : superHaloPath.apply(this, arguments);
+        return this.series.chart.is3d() ?
+            [] : superHaloPath.apply(this, arguments);
     };
     return Pie3DPoint;
 }(PiePoint));

package/es-modules/Series/Pie3D/Pie3DSeries.js

@@ -111,7 +111,7 @@ var Pie3DSeries = /** @class */ (function (_super) {
             series.data.forEach(function (point) {
                 var shapeArgs = point.shapeArgs, r = shapeArgs.r, 
                 // #3240 issue with datalabels for 0 and null values
-                a1 = (shapeArgs.alpha || options3d_1.alpha) * deg2rad, b1 = (shapeArgs.beta || options3d_1.beta) * deg2rad, a2 = (shapeArgs.start + shapeArgs.end) / 2, labelPosition = point.labelPosition, connectorPosition = labelPosition.connectorPosition, yOffset = (-r * (1 - Math.cos(a1)) * Math.sin(a2)), xOffset = r * (Math.cos(b1) - 1) * Math.cos(a2);
+                a1 = ((shapeArgs.alpha || options3d_1.alpha) * deg2rad), b1 = ((shapeArgs.beta || options3d_1.beta) * deg2rad), a2 = ((shapeArgs.start + shapeArgs.end) / 2), labelPosition = point.labelPosition, connectorPosition = (labelPosition.connectorPosition), yOffset = (-r * (1 - Math.cos(a1)) * Math.sin(a2)), xOffset = r * (Math.cos(b1) - 1) * Math.cos(a2);
                 // Apply perspective on label positions
                 [
                     labelPosition.natural,
@@ -171,6 +171,25 @@ var Pie3DSeries = /** @class */ (function (_super) {
             };
         });
     };
+    /**
+     * @private
+     */
+    Pie3DSeries.prototype.drawTracker = function () {
+        _super.prototype.drawTracker.apply(this, arguments);
+        // Do not do this if the chart is not 3D
+        if (!this.chart.is3d()) {
+            return;
+        }
+        this.points.forEach(function (point) {
+            if (point.graphic) {
+                ['out', 'inn', 'side1', 'side2'].forEach(function (face) {
+                    if (point.graphic) {
+                        point.graphic[face].element.point = point;
+                    }
+                });
+            }
+        });
+    };
     return Pie3DSeries;
 }(PieSeries));
 extend(Pie3DSeries.prototype, {

package/es-modules/Series/Pyramid3D/Pyramid3DSeries.js

@@ -36,7 +36,8 @@ var merge = U.merge;
 /**
  * The pyramid3d series type.
  *
- * @constructor seriesTypes.pyramid3d
+ * @class
+ * @name Highcharts.seriesTypes.pyramid3d
  * @augments seriesTypes.funnel3d
  * @requires highcharts-3d
  * @requires modules/cylinder

package/es-modules/Series/Sankey/SankeyColumnComposition.js

@@ -0,0 +1,193 @@
+import U from '../../Core/Utilities.js';
+var defined = U.defined, relativeLength = U.relativeLength;
+var SankeyColumnComposition;
+(function (SankeyColumnComposition) {
+    /* *
+     *
+     *  Declarations
+     *
+     * */
+    /**
+     * SankeyColumn Composition
+     * @private
+     * @function Highcharts.SankeyColumn#compose
+     *
+     * @param {Array<SankeyPoint>} points
+     * The array of nodes
+     * @param {SankeySeries} series
+     * Series connected to column
+     * @return {ArrayComposition} SankeyColumnArray
+     */
+    function compose(points, series) {
+        var sankeyColumnArray = points;
+        sankeyColumnArray.sankeyColumn =
+            new SankeyColumnAdditions(sankeyColumnArray, series);
+        return sankeyColumnArray;
+    }
+    SankeyColumnComposition.compose = compose;
+    /* *
+     *
+     *  Classes
+     *
+     * */
+    var SankeyColumnAdditions = /** @class */ (function () {
+        function SankeyColumnAdditions(points, series) {
+            this.points = points;
+            this.series = series;
+        }
+        /**
+         * Calculate translation factor used in column and nodes distribution
+         * @private
+         * @function Highcharts.SankeyColumn#getTranslationFactor
+         *
+         * @param {SankeySeries} series
+         * The Series
+         * @return {number} TranslationFactor
+         * Translation Factor
+         */
+        SankeyColumnAdditions.prototype.getTranslationFactor = function (series) {
+            var column = this.points, nodes = column.slice(), chart = series.chart, minLinkWidth = series.options.minLinkWidth || 0;
+            var skipPoint, factor = 0, i, remainingHeight = ((chart.plotSizeY || 0) -
+                (series.options.borderWidth || 0) -
+                (column.length - 1) * series.nodePadding);
+            // Because the minLinkWidth option doesn't obey the direct
+            // translation, we need to run translation iteratively, check
+            // node heights, remove those nodes affected by minLinkWidth,
+            // check again, etc.
+            while (column.length) {
+                factor = remainingHeight / column.sankeyColumn.sum();
+                skipPoint = false;
+                i = column.length;
+                while (i--) {
+                    if (column[i].getSum() * factor < minLinkWidth) {
+                        column.splice(i, 1);
+                        remainingHeight -= minLinkWidth;
+                        skipPoint = true;
+                    }
+                }
+                if (!skipPoint) {
+                    break;
+                }
+            }
+            // Re-insert original nodes
+            column.length = 0;
+            nodes.forEach(function (node) {
+                column.push(node);
+            });
+            return factor;
+        };
+        /**
+         * Get the top position of the column in pixels
+         * @private
+         * @function Highcharts.SankeyColumn#top
+         *
+         * @param {number} factor
+         * The Translation Factor
+         * @return {number} top
+         * The top position of the column
+         */
+        SankeyColumnAdditions.prototype.top = function (factor) {
+            var series = this.series;
+            var nodePadding = series.nodePadding;
+            var height = this.points.reduce(function (height, node) {
+                if (height > 0) {
+                    height += nodePadding;
+                }
+                var nodeHeight = Math.max(node.getSum() * factor, series.options.minLinkWidth || 0);
+                height += nodeHeight;
+                return height;
+            }, 0);
+            return ((series.chart.plotSizeY || 0) - height) / 2;
+        };
+        /**
+         * Get the left position of the column in pixels
+         * @private
+         * @function Highcharts.SankeyColumn#top
+         *
+         * @param {number} factor
+         * The Translation Factor
+         * @return {number} left
+         * The left position of the column
+         */
+        SankeyColumnAdditions.prototype.left = function (factor) {
+            var series = this.series, chart = series.chart, equalNodes = series.options.equalNodes;
+            var maxNodesLength = chart.inverted ?
+                chart.plotHeight : chart.plotWidth, nodePadding = series.nodePadding;
+            var width = this.points.reduce(function (width, node) {
+                if (width > 0) {
+                    width += nodePadding;
+                }
+                var nodeWidth = equalNodes ?
+                    maxNodesLength / node.series.nodes.length - nodePadding :
+                    Math.max(node.getSum() * factor, series.options.minLinkWidth || 0);
+                width += nodeWidth;
+                return width;
+            }, 0);
+            return ((chart.plotSizeX || 0) - Math.round(width)) / 2;
+        };
+        /**
+         * Calculate sum of all nodes inside specific column
+         * @private
+         * @function Highcharts.SankeyColumn#sum
+         *
+         * @param {ArrayComposition} this
+         * Sankey Column Array
+         *
+         * @return {number} sum
+         * Sum of all nodes inside column
+         */
+        SankeyColumnAdditions.prototype.sum = function () {
+            return this.points.reduce(function (sum, node) {
+                return sum + node.getSum();
+            }, 0);
+        };
+        /**
+         * Get the offset in pixels of a node inside the column
+         * @private
+         * @function Highcharts.SankeyColumn#offset
+         *
+         * @param {SankeyPoint} node
+         * Sankey node
+         * @param {number} factor
+         * Translation Factor
+         * @return {number} offset
+         * Offset of a node inside column
+         */
+        SankeyColumnAdditions.prototype.offset = function (node, factor) {
+            var column = this.points, series = this.series, nodePadding = series.nodePadding;
+            var offset = 0, totalNodeOffset;
+            if (series.is('organization') && node.hangsFrom) {
+                return {
+                    absoluteTop: node.hangsFrom.nodeY
+                };
+            }
+            for (var i = 0; i < column.length; i++) {
+                var sum = column[i].getSum();
+                var height = Math.max(sum * factor, series.options.minLinkWidth || 0);
+                var directionOffset = node.options[series.chart.inverted ?
+                    'offsetHorizontal' :
+                    'offsetVertical'], optionOffset = node.options.offset || 0;
+                if (sum) {
+                    totalNodeOffset = height + nodePadding;
+                }
+                else {
+                    // If node sum equals 0 nodePadding is missed #12453
+                    totalNodeOffset = 0;
+                }
+                if (column[i] === node) {
+                    return {
+                        relativeTop: offset + (defined(directionOffset) ?
+                            // directionOffset is a percent
+                            // of the node height
+                            relativeLength(directionOffset, height) :
+                            relativeLength(optionOffset, totalNodeOffset))
+                    };
+                }
+                offset += totalNodeOffset;
+            }
+        };
+        return SankeyColumnAdditions;
+    }());
+    SankeyColumnComposition.SankeyColumnAdditions = SankeyColumnAdditions;
+})(SankeyColumnComposition || (SankeyColumnComposition = {}));
+export default SankeyColumnComposition;

package/es-modules/Series/Sankey/SankeyPoint.js

@@ -27,7 +27,7 @@ import Point from '../../Core/Series/Point.js';
 import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
 var ColumnSeries = SeriesRegistry.seriesTypes.column;
 import U from '../../Core/Utilities.js';
-var defined = U.defined, extend = U.extend;
+var defined = U.defined;
 /* *
  *
  *  Class
@@ -81,6 +81,42 @@ var SankeyPoint = /** @class */ (function (_super) {
         return (this.isNode ? 'highcharts-node ' : 'highcharts-link ') +
             Point.prototype.getClassName.call(this);
     };
+    /**
+     * If there are incoming links, place it to the right of the
+     * highest order column that links to this one.
+     *
+     * @private
+     */
+    SankeyPoint.prototype.getFromNode = function () {
+        var node = this;
+        var fromColumn = -1, fromNode;
+        for (var i = 0; i < node.linksTo.length; i++) {
+            var point = node.linksTo[i];
+            if (point.fromNode.column > fromColumn &&
+                point.fromNode !== node // #16080
+            ) {
+                fromNode = point.fromNode;
+                fromColumn = fromNode.column;
+            }
+        }
+        return { fromNode: fromNode, fromColumn: fromColumn };
+    };
+    /**
+     * Calculate node.column if it's not set by user
+     * @private
+     */
+    SankeyPoint.prototype.setNodeColumn = function () {
+        var node = this;
+        if (!defined(node.options.column)) {
+            // No links to this node, place it left
+            if (node.linksTo.length === 0) {
+                node.column = 0;
+            }
+            else {
+                node.column = node.getFromNode().fromColumn + 1;
+            }
+        }
+    };
     /**
      * @private
      */