highcharts 9.3.1 → 10.0.0

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

@@ -28,11 +28,12 @@ import H from '../../Core/Globals.js';
 import NodesComposition from '../NodesComposition.js';
 import SankeyPoint from './SankeyPoint.js';
 import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
+import SankeyColumnComposition from './SankeyColumnComposition.js';
 var Series = SeriesRegistry.series, ColumnSeries = SeriesRegistry.seriesTypes.column;
 import TU from '../TreeUtilities.js';
 var getLevelOptions = TU.getLevelOptions;
 import U from '../../Core/Utilities.js';
-var defined = U.defined, extend = U.extend, find = U.find, isObject = U.isObject, merge = U.merge, pick = U.pick, relativeLength = U.relativeLength, stableSort = U.stableSort;
+var defined = U.defined, extend = U.extend, isObject = U.isObject, merge = U.merge, pick = U.pick, relativeLength = U.relativeLength, stableSort = U.stableSort;
 /* *
  *
  *  Class
@@ -97,56 +98,6 @@ var SankeySeries = /** @class */ (function (_super) {
      *
      * */
     /* eslint-disable valid-jsdoc */
-    /**
-     * Create a node column.
-     * @private
-     */
-    SankeySeries.prototype.createNodeColumn = function () {
-        var series = this, chart = this.chart, column = [];
-        column.sum = function () {
-            return this.reduce(function (sum, node) {
-                return sum + node.getSum();
-            }, 0);
-        };
-        // Get the offset in pixels of a node inside the column.
-        column.offset = function (node, factor) {
-            var offset = 0, totalNodeOffset, nodePadding = series.nodePadding;
-            for (var i = 0; i < column.length; i++) {
-                var sum = column[i].getSum(), height = Math.max(sum * factor, series.options.minLinkWidth), directionOffset = node.options[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;
-            }
-        };
-        // Get the top position of the column in pixels.
-        column.top = function (factor) {
-            var nodePadding = series.nodePadding;
-            var height = this.reduce(function (height, node) {
-                if (height > 0) {
-                    height += nodePadding;
-                }
-                var nodeHeight = Math.max(node.getSum() * factor, series.options.minLinkWidth);
-                height += nodeHeight;
-                return height;
-            }, 0);
-            return (chart.plotSizeY - height) / 2;
-        };
-        return column;
-    };
     /**
      * Create node columns by analyzing the nodes and the relations between
      * incoming and outgoing links.
@@ -155,50 +106,18 @@ var SankeySeries = /** @class */ (function (_super) {
     SankeySeries.prototype.createNodeColumns = function () {
         var columns = [];
         this.nodes.forEach(function (node) {
-            var fromColumn = -1, fromNode;
-            if (!defined(node.options.column)) {
-                // No links to this node, place it left
-                if (node.linksTo.length === 0) {
-                    node.column = 0;
-                    // There are incoming links, place it to the right of the
-                    // highest order column that links to this one.
-                }
-                else {
-                    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;
-                        }
-                    }
-                    node.column = fromColumn + 1;
-                    // Hanging layout for organization chart
-                    if (fromNode &&
-                        fromNode.options.layout === 'hanging') {
-                        node.hangsFrom = fromNode;
-                        var i_1 = -1;
-                        find(fromNode.linksFrom, function (link, index) {
-                            var found = link.toNode === node;
-                            if (found) {
-                                i_1 = index;
-                            }
-                            return found;
-                        });
-                        node.column += i_1;
-                    }
-                }
-            }
+            node.setNodeColumn();
             if (!columns[node.column]) {
-                columns[node.column] = this.createNodeColumn();
+                columns[node.column] =
+                    SankeyColumnComposition.compose([], this);
             }
             columns[node.column].push(node);
         }, this);
         // Fill in empty columns (#8865)
         for (var i = 0; i < columns.length; i++) {
             if (typeof columns[i] === 'undefined') {
-                columns[i] = this.createNodeColumn();
+                columns[i] =
+                    SankeyColumnComposition.compose([], this);
             }
         }
         return columns;
@@ -311,41 +230,6 @@ var SankeySeries = /** @class */ (function (_super) {
      * @private
      */
     SankeySeries.prototype.translate = function () {
-        var _this = this;
-        // Get the translation factor needed for each column to fill up the
-        // plot height
-        var getColumnTranslationFactor = function (column) {
-            var nodes = column.slice();
-            var minLinkWidth = _this.options.minLinkWidth || 0;
-            var exceedsMinLinkWidth;
-            var factor = 0;
-            var i;
-            var remainingHeight = chart.plotSizeY -
-                options.borderWidth - (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.sum();
-                exceedsMinLinkWidth = false;
-                i = column.length;
-                while (i--) {
-                    if (column[i].getSum() * factor < minLinkWidth) {
-                        column.splice(i, 1);
-                        remainingHeight -= minLinkWidth;
-                        exceedsMinLinkWidth = true;
-                    }
-                }
-                if (!exceedsMinLinkWidth) {
-                    break;
-                }
-            }
-            // Re-insert original nodes
-            column.length = 0;
-            nodes.forEach(function (node) { return column.push(node); });
-            return factor;
-        };
         if (!this.processedXData) {
             this.processData();
         }
@@ -356,7 +240,7 @@ var SankeySeries = /** @class */ (function (_super) {
         this.nodePadding = this.getNodePadding();
         // Find out how much space is needed. Base it on the translation
         // factor of the most spaceous column.
-        this.translationFactor = nodeColumns.reduce(function (translationFactor, column) { return Math.min(translationFactor, getColumnTranslationFactor(column)); }, Infinity);
+        this.translationFactor = nodeColumns.reduce(function (translationFactor, column) { return Math.min(translationFactor, column.sankeyColumn.getTranslationFactor(series)); }, Infinity);
         this.colDistance =
             (chart.plotSizeX - nodeWidth -
                 options.borderWidth) / Math.max(1, nodeColumns.length - 1);
@@ -515,7 +399,7 @@ var SankeySeries = /** @class */ (function (_super) {
      * @private
      */
     SankeySeries.prototype.translateNode = function (node, column) {
-        var translationFactor = this.translationFactor, chart = this.chart, options = this.options, sum = node.getSum(), nodeHeight = Math.max(Math.round(sum * translationFactor), this.options.minLinkWidth), nodeWidth = Math.round(this.nodeWidth), crisp = Math.round(options.borderWidth) % 2 / 2, nodeOffset = column.offset(node, translationFactor), fromNodeTop = Math.floor(pick(nodeOffset.absoluteTop, (column.top(translationFactor) +
+        var translationFactor = this.translationFactor, chart = this.chart, options = this.options, sum = node.getSum(), nodeHeight = Math.max(Math.round(sum * translationFactor), this.options.minLinkWidth), nodeWidth = Math.round(this.nodeWidth), crisp = Math.round(options.borderWidth) % 2 / 2, nodeOffset = column.sankeyColumn.offset(node, translationFactor), fromNodeTop = Math.floor(pick(nodeOffset.absoluteTop, (column.sankeyColumn.top(translationFactor) +
             nodeOffset.relativeTop))) + crisp, left = Math.floor(this.colDistance * node.column +
             options.borderWidth / 2) + relativeLength(node.options.offsetHorizontal || 0, nodeWidth) +
             crisp, nodeLeft = chart.inverted ?
@@ -834,7 +718,7 @@ extend(SankeySeries.prototype, {
     isCartesian: false,
     orderNodes: true,
     noSharedTooltip: true,
-    pointArrayMap: ['from', 'to'],
+    pointArrayMap: ['from', 'to', 'weight'],
     pointClass: SankeyPoint,
     searchPoint: H.noop
 });

package/es-modules/Series/Scatter/ScatterSeries.js

@@ -185,7 +185,7 @@ var ScatterSeries = /** @class */ (function (_super) {
          *
          * @type      {boolean}
          * @default   false
-         * @product   highcharts highstock
+         * @product   highcharts highstock highmaps
          * @apioption plotOptions.scatter.stickyTracking
          */
         /**

package/es-modules/Series/SolidGauge/SolidGaugeComposition.js

@@ -50,7 +50,9 @@ symbols.arc = function (x, y, w, h, options) {
     if (options && options.rounded) {
         var r = options.r || w, smallR = (r - (options.innerR || 0)) / 2, outerArcStart = path[0], innerArcStart = path[2];
         if (outerArcStart[0] === 'M' && innerArcStart[0] === 'L') {
-            var x1 = outerArcStart[1], y1 = outerArcStart[2], x2 = innerArcStart[1], y2 = innerArcStart[2], roundStart = ['A', smallR, smallR, 0, 1, 1, x1, y1], roundEnd = ['A', smallR, smallR, 0, 1, 1, x2, y2];
+            var x1 = outerArcStart[1], y1 = outerArcStart[2], x2 = innerArcStart[1], y2 = innerArcStart[2], roundStart = [
+                'A', smallR, smallR, 0, 1, 1, x1, y1
+            ], roundEnd = ['A', smallR, smallR, 0, 1, 1, x2, y2];
             // Replace the line segment and the last close segment
             path[2] = roundEnd;
             path[4] = roundStart;

package/es-modules/Series/Spline/SplineSeries.js

@@ -62,14 +62,6 @@ var SplineSeries = /** @class */ (function (_super) {
      *
      * @private
      * @function Highcharts.seriesTypes.spline#getPointSpline
-     *
-     * @param {Array<Highcharts.Point>}
-     *
-     * @param {Highcharts.Point} point
-     *
-     * @param {number} i
-     *
-     * @return {Highcharts.SVGPathArray}
      */
     SplineSeries.prototype.getPointSpline = function (points, point, i) {
         var 

package/es-modules/Series/Sunburst/SunburstSeries.js

@@ -395,7 +395,7 @@ var SunburstSeries = /** @class */ (function (_super) {
             };
         }
         points.forEach(function (point) {
-            var node = point.node, level = mapOptionsToLevel[node.level], shapeExisting = point.shapeExisting || {}, shape = node.shapeArgs || {}, animationInfo, onComplete, visible = !!(node.visible && node.shapeArgs);
+            var node = point.node, level = mapOptionsToLevel[node.level], shapeExisting = (point.shapeExisting || {}), shape = node.shapeArgs || {}, animationInfo, onComplete, visible = !!(node.visible && node.shapeArgs);
             if (hasRendered && animation) {
                 animationInfo = getAnimation(shape, {
                     center: center,
@@ -539,7 +539,6 @@ var SunburstSeries = /** @class */ (function (_super) {
         // @todo Only if series.isDirtyData is true
         tree = series.tree = series.getTree();
         // Render traverseUpButton, after series.nodeMap i calculated.
-        series.renderTraverseUpButton(rootId);
         mapIdToNode = series.nodeMap;
         nodeRoot = mapIdToNode[rootId];
         idTop = isString(nodeRoot.parent) ? nodeRoot.parent : '';
@@ -616,6 +615,15 @@ var SunburstSeries = /** @class */ (function (_super) {
      * @private
      */
     SunburstSeries.defaultOptions = merge(TreemapSeries.defaultOptions, {
+        /**
+         * Options for the breadcrumbs, the navigation at the top leading the
+         * way up through the traversed levels.
+         *
+         * @since 10.0.0
+         * @product   highcharts
+         * @extends   navigation.breadcrumbs
+         * @optionparent plotOptions.sunburst.breadcrumbs
+         */
         /**
          * Set options on specific levels. Takes precedence over series options,
          * but not point options.
@@ -689,7 +697,7 @@ var SunburstSeries = /** @class */ (function (_super) {
         /**
          * Can set a `levelSize` on all points which lies on the same level.
          *
-         * @type      {object}
+         * @type      {Object}
          * @apioption plotOptions.sunburst.levels.levelSize
          */
         /**
@@ -812,11 +820,14 @@ var SunburstSeries = /** @class */ (function (_super) {
             unit: 'weight'
         },
         /**
-         * Options for the button appearing when traversing down in a treemap.
+         * Options for the button appearing when traversing down in a sunburst.
+         * Since v9.3.3 the `traverseUpButton` is replaced by `breadcrumbs`.
          *
          * @extends   plotOptions.treemap.traverseUpButton
          * @since     6.0.0
+         * @deprecated
          * @apioption plotOptions.sunburst.traverseUpButton
+         *
          */
         /**
          * If a point is sliced, moved out from the center, how many pixels

package/es-modules/Series/Sunburst/SunburstUtilities.js

@@ -39,7 +39,7 @@ var SunburstUtilities;
      * @private
      * @function calculateLevelSizes
      *
-     * @param {object} levelOptions
+     * @param {Object} levelOptions
      * Map of level to its options.
      *
      * @param {Highcharts.Dictionary<number>} params
@@ -58,7 +58,8 @@ var SunburstUtilities;
             levelsNotIncluded = Object.keys(result).filter(function (k) {
                 return levels.indexOf(+k) === -1;
             });
-            diffRadius = remainingSize = isNumber(p.diffRadius) ? p.diffRadius : 0;
+            diffRadius = remainingSize = isNumber(p.diffRadius) ?
+                p.diffRadius : 0;
             // Convert percentage to pixels.
             // Calculate the remaining size to divide between "weight" levels.
             // Calculate total weight to use in convertion from weight to

package/es-modules/Series/Tilemap/TilemapPoint.js

@@ -59,8 +59,6 @@ var TilemapPoint = /** @class */ (function (_super) {
     /**
      * @private
      * @function Highcharts.Point#haloPath
-     *
-     * @return {Highcharts.SVGElement|Highcharts.SVGPathArray|Array<Highcharts.SVGElement>}
      */
     TilemapPoint.prototype.haloPath = function () {
         return this.series.tileShape.haloPath.apply(this, arguments);

package/es-modules/Series/Tilemap/TilemapShapes.js

@@ -20,13 +20,6 @@ var clamp = U.clamp, pick = U.pick;
 /**
  * Utility func to get padding definition from tile size division
  * @private
- * @param {Highcharts.TilemapSeries} series
- * series
- * @param {Highcharts.number} xDiv
- * xDiv
- * @param {Highcharts.number} yDiv
- * yDiv
- * @return {Highcharts.TilemapPaddingObject}
  */
 function tilePaddingFromTileSize(series, xDiv, yDiv) {
     var options = series.options;

package/es-modules/Series/TreeUtilities.js

@@ -64,7 +64,7 @@ function getColor(node, options) {
  *
  * @private
  *
- * @param {object} params
+ * @param {Object} params
  * Object containing parameters.
  * - `defaults` Object containing default options. The default options are
  *   merged with the userOptions to get the final options for a specific
@@ -156,7 +156,7 @@ function setTreeValues(tree, options) {
  *
  * @private
  *
- * @param {object} series
+ * @param {Object} series
  * The series to operate on.
  *
  * @return {string}