highcharts 10.2.0 → 10.2.1

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

@@ -0,0 +1,394 @@
+/* *
+ *
+ *  Imports
+ *
+ * */
+import U from '../../Core/Utilities.js';
+var isNumber = U.isNumber;
+/* *
+ *
+ *  Constants
+ *
+ * */
+/**
+ * A packed bubble series is a two dimensional series type, where each point
+ * renders a value in X, Y position. Each point is drawn as a bubble
+ * where the bubbles don't overlap with each other and the radius
+ * of the bubble relates to the value.
+ *
+ * @sample highcharts/demo/packed-bubble/
+ *         Packed bubble chart
+ * @sample highcharts/demo/packed-bubble-split/
+ *         Split packed bubble chart
+ *
+ * @extends      plotOptions.bubble
+ * @excluding    connectEnds, connectNulls, cropThreshold, dragDrop, jitter,
+ *               keys, pointPlacement, sizeByAbsoluteValue, step, xAxis,
+ *               yAxis, zMax, zMin, dataSorting, boostThreshold,
+ *               boostBlending
+ * @product      highcharts
+ * @since        7.0.0
+ * @requires     highcharts-more
+ * @optionparent plotOptions.packedbubble
+ */
+var PackedBubbleSeriesDefaults = {
+    /**
+     * Minimum bubble size. Bubbles will automatically size between the
+     * `minSize` and `maxSize` to reflect the value of each bubble.
+     * Can be either pixels (when no unit is given), or a percentage of
+     * the smallest one of the plot width and height, divided by the square
+     * root of total number of points.
+     *
+     * @sample highcharts/plotoptions/bubble-size/
+     *         Bubble size
+     *
+     * @type {number|string}
+     *
+     * @private
+     */
+    minSize: '10%',
+    /**
+     * Maximum bubble size. Bubbles will automatically size between the
+     * `minSize` and `maxSize` to reflect the value of each bubble.
+     * Can be either pixels (when no unit is given), or a percentage of
+     * the smallest one of the plot width and height, divided by the square
+     * root of total number of points.
+     *
+     * @sample highcharts/plotoptions/bubble-size/
+     *         Bubble size
+     *
+     * @type {number|string}
+     *
+     * @private
+     */
+    maxSize: '50%',
+    sizeBy: 'area',
+    zoneAxis: 'y',
+    crisp: false,
+    tooltip: {
+        pointFormat: 'Value: {point.value}'
+    },
+    /**
+     * Flag to determine if nodes are draggable or not. Available for
+     * graph with useSimulation set to true only.
+     *
+     * @since 7.1.0
+     *
+     * @private
+     */
+    draggable: true,
+    /**
+     * An option is giving a possibility to choose between using simulation
+     * for calculating bubble positions. These reflects in both animation
+     * and final position of bubbles. Simulation is also adding options to
+     * the series graph based on used layout. In case of big data sets, with
+     * any performance issues, it is possible to disable animation and pack
+     * bubble in a simple circular way.
+     *
+     * @sample highcharts/series-packedbubble/spiral/
+     *         useSimulation set to false
+     *
+     * @since 7.1.0
+     *
+     * @private
+     */
+    useSimulation: true,
+    /**
+     * Series options for parent nodes.
+     *
+     * @since 8.1.1
+     *
+     * @private
+     */
+    parentNode: {
+        /**
+         * Allow this series' parent nodes to be selected
+         * by clicking on the graph.
+         *
+         * @since 8.1.1
+         */
+        allowPointSelect: false
+    },
+    /**
+    /**
+     *
+     * @declare Highcharts.SeriesPackedBubbleDataLabelsOptionsObject
+     *
+     * @private
+     */
+    dataLabels: {
+        /**
+         * The
+         * [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
+         * specifying what to show for _node_ in the networkgraph. In v7.0
+         * defaults to `{key}`, since v7.1 defaults to `undefined` and
+         * `formatter` is used instead.
+         *
+         * @type      {string}
+         * @since     7.0.0
+         * @apioption plotOptions.packedbubble.dataLabels.format
+         */
+        // eslint-disable-next-line valid-jsdoc
+        /**
+         * Callback JavaScript function to format the data label for a node.
+         * Note that if a `format` is defined, the format takes precedence
+         * and the formatter is ignored.
+         *
+         * @type  {Highcharts.SeriesPackedBubbleDataLabelsFormatterCallbackFunction}
+         * @since 7.0.0
+         */
+        formatter: function () {
+            var numberFormatter = this.series.chart.numberFormatter;
+            var value = this.point.value;
+            return isNumber(value) ? numberFormatter(value, -1) : '';
+        },
+        /**
+         * @type      {string}
+         * @since     7.1.0
+         * @apioption plotOptions.packedbubble.dataLabels.parentNodeFormat
+         */
+        // eslint-disable-next-line valid-jsdoc
+        /**
+         * @type  {Highcharts.SeriesPackedBubbleDataLabelsFormatterCallbackFunction}
+         * @since 7.1.0
+         */
+        parentNodeFormatter: function () {
+            return this.name;
+        },
+        /**
+         * @sample {highcharts} highcharts/series-packedbubble/packed-dashboard
+         *         Dashboard with dataLabels on parentNodes
+         *
+         * @declare Highcharts.SeriesPackedBubbleDataLabelsTextPathOptionsObject
+         * @since   7.1.0
+         */
+        parentNodeTextPath: {
+            /**
+             * Presentation attributes for the text path.
+             *
+             * @type      {Highcharts.SVGAttributes}
+             * @since     7.1.0
+             * @apioption plotOptions.packedbubble.dataLabels.attributes
+             */
+            /**
+             * Enable or disable `textPath` option for link's or marker's
+             * data labels.
+             *
+             * @since 7.1.0
+             */
+            enabled: true
+        },
+        /**
+         * Options for a _node_ label text which should follow marker's
+         * shape.
+         *
+         * **Note:** Only SVG-based renderer supports this option.
+         *
+         * @extends   plotOptions.series.dataLabels.textPath
+         * @apioption plotOptions.packedbubble.dataLabels.textPath
+         */
+        padding: 0,
+        style: {
+            transition: 'opacity 2000ms'
+        }
+    },
+    /**
+     * Options for layout algorithm when simulation is enabled. Inside there
+     * are options to change the speed, padding, initial bubbles positions
+     * and more.
+     *
+     * @extends   plotOptions.networkgraph.layoutAlgorithm
+     * @excluding approximation, attractiveForce, repulsiveForce, theta
+     * @since     7.1.0
+     *
+     * @private
+     */
+    layoutAlgorithm: {
+        /**
+         * Initial layout algorithm for positioning nodes. Can be one of
+         * the built-in options ("circle", "random") or a function where
+         * positions should be set on each node (`this.nodes`) as
+         * `node.plotX` and `node.plotY`.
+         *
+         * @sample highcharts/series-networkgraph/initial-positions/
+         *         Initial positions with callback
+         *
+         * @type {"circle"|"random"|Function}
+         */
+        initialPositions: 'circle',
+        /**
+         * @sample highcharts/series-packedbubble/initial-radius/
+         *         Initial radius set to 200
+         *
+         * @extends   plotOptions.networkgraph.layoutAlgorithm.initialPositionRadius
+         * @excluding states
+         */
+        initialPositionRadius: 20,
+        /**
+         * The distance between two bubbles, when the algorithm starts to
+         * treat two bubbles as overlapping. The `bubblePadding` is also the
+         * expected distance between all the bubbles on simulation end.
+         */
+        bubblePadding: 5,
+        /**
+         * Whether bubbles should interact with their parentNode to keep
+         * them inside.
+         */
+        parentNodeLimit: false,
+        /**
+         * Whether series should interact with each other or not. When
+         * `parentNodeLimit` is set to true, thi option should be set to
+         * false to avoid sticking points in wrong series parentNode.
+         */
+        seriesInteraction: true,
+        /**
+         * In case of split series, this option allows user to drag and
+         * drop points between series, for changing point related series.
+         *
+         * @sample highcharts/series-packedbubble/packed-dashboard/
+         *         Example of drag'n drop bubbles for bubble kanban
+         */
+        dragBetweenSeries: false,
+        /**
+         * Layout algorithm options for parent nodes.
+         *
+         * @extends   plotOptions.networkgraph.layoutAlgorithm
+         * @excluding approximation, attractiveForce, enableSimulation,
+         *            repulsiveForce, theta
+         */
+        parentNodeOptions: {
+            maxIterations: 400,
+            gravitationalConstant: 0.03,
+            maxSpeed: 50,
+            initialPositionRadius: 100,
+            seriesInteraction: true,
+            /**
+             * Styling options for parentNodes markers. Similar to
+             * line.marker options.
+             *
+             * @sample highcharts/series-packedbubble/parentnode-style/
+             *         Bubble size
+             *
+             * @extends   plotOptions.series.marker
+             * @excluding states
+             */
+            marker: {
+                fillColor: null,
+                fillOpacity: 1,
+                lineWidth: null,
+                lineColor: null,
+                symbol: 'circle'
+            }
+        },
+        enableSimulation: true,
+        /**
+         * Type of the algorithm used when positioning bubbles.
+         * @ignore-option
+         */
+        type: 'packedbubble',
+        /**
+         * Integration type. Integration determines how forces are applied
+         * on particles. The `packedbubble` integration is based on
+         * the networkgraph `verlet` integration, where the new position
+         * is based on a previous position without velocity:
+         * `newPosition += previousPosition - newPosition`.
+         *
+         * @sample highcharts/series-networkgraph/forces/
+         *
+         * @ignore-option
+         */
+        integration: 'packedbubble',
+        maxIterations: 1000,
+        /**
+         * Whether to split series into individual groups or to mix all
+         * series together.
+         *
+         * @since   7.1.0
+         * @default false
+         */
+        splitSeries: false,
+        /**
+         * Max speed that node can get in one iteration. In terms of
+         * simulation, it's a maximum translation (in pixels) that a node
+         * can move (in both, x and y, dimensions). While `friction` is
+         * applied on all nodes, max speed is applied only for nodes that
+         * move very fast, for example small or disconnected ones.
+         *
+         * @see [layoutAlgorithm.integration](#series.networkgraph.layoutAlgorithm.integration)
+         *
+         * @see [layoutAlgorithm.friction](#series.networkgraph.layoutAlgorithm.friction)
+         */
+        maxSpeed: 5,
+        gravitationalConstant: 0.01,
+        friction: -0.981
+    }
+};
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default PackedBubbleSeriesDefaults;
+/* *
+ *
+ *  API Options
+ *
+ * */
+/**
+ * A `packedbubble` series. If the [type](#series.packedbubble.type) option is
+ * not specified, it is inherited from [chart.type](#chart.type).
+ *
+ * @type      {Object}
+ * @extends   series,plotOptions.packedbubble
+ * @excluding cropThreshold, dataParser, dataSorting, dataURL, dragDrop, stack,
+ *            boostThreshold, boostBlending
+ * @product   highcharts
+ * @requires  highcharts-more
+ * @apioption series.packedbubble
+ */
+/**
+ * An array of data points for the series. For the `packedbubble` series type,
+ * points can be given in the following ways:
+ *
+ * 1.  An array of `values`.
+ *
+ *  ```js
+ *     data: [5, 1, 20]
+ *  ```
+ *
+ * 2.  An array of objects with named values. The objects are point
+ * configuration objects as seen below. If the total number of data points
+ * exceeds the series' [turboThreshold](#series.packedbubble.turboThreshold),
+ * this option is not available.
+ *
+ *  ```js
+ *     data: [{
+ *         value: 1,
+ *         name: "Point2",
+ *         color: "#00FF00"
+ *     }, {
+ *         value: 5,
+ *         name: "Point1",
+ *         color: "#FF00FF"
+ *     }]
+ *  ```
+ *
+ * @type      {Array<Object|Array>}
+ * @extends   series.line.data
+ * @excluding marker, x, y
+ * @sample    {highcharts} highcharts/series/data-array-of-objects/
+ *            Config objects
+ * @product   highcharts
+ * @apioption series.packedbubble.data
+ */
+/**
+ * @type      {Highcharts.SeriesPackedBubbleDataLabelsOptionsObject|Array<Highcharts.SeriesPackedBubbleDataLabelsOptionsObject>}
+ * @product   highcharts
+ * @apioption series.packedbubble.data.dataLabels
+ */
+/**
+ * @excluding enabled,enabledThreshold,height,radius,width
+ * @product   highcharts
+ * @apioption series.packedbubble.marker
+ */
+''; // adds doclets above to transpiled file

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

@@ -436,6 +436,8 @@ var PieSeries = /** @class */ (function (_super) {
      *               boostBlending
      * @product      highcharts highmaps
      * @optionparent plotOptions.pie
+     *
+     * @private
      */
     PieSeries.defaultOptions = merge(Series.defaultOptions, {
         /**
@@ -544,7 +546,7 @@ var PieSeries = /** @class */ (function (_super) {
             /**
              * Alignment method for data labels. Possible values are:
              *
-             * - `toPlotEdges`: Each label touches the nearest vertical edge of
+             * - `plotEdges`: Each label touches the nearest vertical edge of
              *   the plot area.
              *
              * - `connectors`: Connectors have the same x position and the

package/es-modules/Series/PolarComposition.js

@@ -177,7 +177,7 @@ function onSeriesAfterTranslate() {
         // of non-shared.
         series.kdByAngle = chart_1.tooltip && chart_1.tooltip.shared;
         if (series.kdByAngle) {
-            series.searchPoint = series.polar.searchPointByAngle;
+            series.searchPoint = searchPointByAngle;
         }
         else {
             series.options.findNearestPointBy = 'xy';
@@ -225,6 +225,17 @@ function onSeriesAfterTranslate() {
         }
     }
 }
+/**
+ * Search a k-d tree by the point angle, used for shared tooltips in polar
+ * charts
+ * @private
+ */
+function searchPointByAngle(e) {
+    var series = this, chart = series.chart, xAxis = series.xAxis, center = xAxis.pane && xAxis.pane.center, plotX = e.chartX - (center && center[0] || 0) - chart.plotLeft, plotY = e.chartY - (center && center[1] || 0) - chart.plotTop;
+    return series.searchKDTree({
+        clientX: 180 + (Math.atan2(plotX, plotY) * (-180 / Math.PI))
+    });
+}
 /**
  * Extend chart.get to also search in panes. Used internally in
  * responsiveness and chart.update.
@@ -757,17 +768,6 @@ var PolarAdditions = /** @class */ (function () {
             end: end
         };
     };
-    /**
-     * Search a k-d tree by the point angle, used for shared tooltips in polar
-     * charts
-     * @private
-     */
-    PolarAdditions.prototype.searchPointByAngle = function (e) {
-        var series = this.series, chart = series.chart, xAxis = series.xAxis, center = xAxis.pane.center, plotX = e.chartX - center[0] - chart.plotLeft, plotY = e.chartY - center[1] - chart.plotTop;
-        return series.searchKDTree({
-            clientX: 180 + (Math.atan2(plotX, plotY) * (-180 / Math.PI))
-        });
-    };
     /**
      * Translate a point's plotX and plotY from the internal angle and radius
      * measures to true plotX, plotY coordinates

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

@@ -482,6 +482,8 @@ var SankeySeries = /** @class */ (function (_super) {
      *               zones, minPointLength, dataSorting, boostBlending
      * @requires     modules/sankey
      * @optionparent plotOptions.sankey
+     *
+     * @private
      */
     SankeySeries.defaultOptions = merge(ColumnSeries.defaultOptions, {
         borderWidth: 0,
@@ -1034,11 +1036,21 @@ export default SankeySeries;
  *     }]
  *  ```
  *
+ *  When you provide the data as tuples, the keys option has to be set as well.
+ *
+ *  ```js
+ *     keys: ['from', 'to', 'weight'],
+ *     data: [
+ *         ['Category1', 'Category2', 2],
+ *         ['Category1', 'Category3', 5]
+ *     ]
+ *  ```
+ *
  * @sample {highcharts} highcharts/series/data-array-of-objects/
  *         Config objects
  *
  * @declare   Highcharts.SeriesSankeyPointOptionsObject
- * @type      {Array<*>}
+ * @type      {Array<*>|Array<Array<(string|number)>>}
  * @extends   series.line.data
  * @excluding dragDrop, drilldown, marker, x, y
  * @product   highcharts

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

@@ -201,9 +201,12 @@ var ScatterSeries = /** @class */ (function (_super) {
          * series, in a scatter plot the series.name by default shows in the
          * headerFormat and point.x and point.y in the pointFormat.
          *
-         * @product highcharts highstock
+         * @product highcharts highstock highmaps
          */
         tooltip: {
+            /**
+             * @product highcharts highstock
+             */
             headerFormat: '<span style="color:{point.color}">\u25CF</span> ' +
                 '<span style="font-size: 10px"> {series.name}</span><br/>',
             pointFormat: 'x: <b>{point.x}</b><br/>y: <b>{point.y}</b><br/>'

package/es-modules/Series/Scatter3D/Scatter3DSeries.js

@@ -25,7 +25,7 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
-import Math3D from '../../Extensions/Math3D.js';
+import Math3D from '../../Core/Math3D.js';
 var pointCameraDistance = Math3D.pointCameraDistance;
 import Scatter3DPoint from './Scatter3DPoint.js';
 import ScatterSeries from '../Scatter/ScatterSeries.js';

package/es-modules/Series/SeriesOnPointComposition.js

@@ -290,9 +290,13 @@ export default SeriesOnPointComposition;
  *
  * */
 /**
- * Options for the `Series on point` feature. Only `pie` and `sunburst` series
+ * Options for the _Series on point_ feature. Only `pie` and `sunburst` series
  * are supported at this moment.
  *
+ * @sample      {highcharts} highcharts/series-on-point/series-on-point
+ *              Series on point
+ * @sample      {highmaps} maps/demo/map-pies
+ *              Pies on a map
  * @requires    modules/series-on-point
  * @since 10.2.0
  * @type        {object}

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

@@ -98,7 +98,7 @@ var solidGaugeOptions = {
      * @apioption plotOptions.solidgauge.radius
      */
     /**
-     * Wether to draw rounded edges on the gauge.
+     * Whether to draw rounded edges on the gauge.
      *
      * @sample {highcharts} highcharts/demo/gauge-activity/
      *         Activity Gauge

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

@@ -30,7 +30,7 @@ var __extends = (this && this.__extends) || (function () {
 import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
 var Point = SeriesRegistry.series.prototype.pointClass, TreemapPoint = SeriesRegistry.seriesTypes.treemap.prototype.pointClass;
 import U from '../../Core/Utilities.js';
-var correctFloat = U.correctFloat, extend = U.extend;
+var correctFloat = U.correctFloat, extend = U.extend, wrap = U.wrap;
 /* *
  *
  *  Class
@@ -79,22 +79,21 @@ var SunburstPoint = /** @class */ (function (_super) {
         if (this.dataLabelPath) {
             this.dataLabelPath = this.dataLabelPath.destroy();
         }
+        // All times
         this.dataLabelPath = renderer
             .arc({
             open: true,
             longArc: moreThanHalf ? 1 : 0
         })
-            // Add it inside the data label group so it gets destroyed
-            // with the label
-            .add(label);
-        this.dataLabelPath.attr({
+            .attr({
             start: (upperHalf ? start : end),
             end: (upperHalf ? end : start),
             clockwise: +upperHalf,
             x: shapeArgs.x,
             y: shapeArgs.y,
             r: (r + shapeArgs.innerR) / 2
-        });
+        })
+            .add(renderer.defs);
         return this.dataLabelPath;
     };
     SunburstPoint.prototype.isValid = function () {

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

@@ -100,7 +100,7 @@ function getDlOptions(params) {
             if (point.innerArcLength < 1 &&
                 point.outerArcLength > shape.radius) {
                 rotationRad = 0;
-                // Triger setTextPath function to get textOutline etc.
+                // Trigger setTextPath function to get textOutline etc.
                 if (point.dataLabelPath && rotationMode === 'circular') {
                     options.textPath = {
                         enabled: true
@@ -124,7 +124,7 @@ function getDlOptions(params) {
             else {
                 // Trigger the destroyTextPath function
                 if (point.dataLabel &&
-                    point.dataLabel.textPathWrapper &&
+                    point.dataLabel.textPath &&
                     rotationMode === 'circular') {
                     options.textPath = {
                         enabled: false
@@ -614,6 +614,7 @@ var SunburstSeries = /** @class */ (function (_super) {
      * @product      highcharts
      * @requires     modules/sunburst.js
      * @optionparent plotOptions.sunburst
+     *
      * @private
      */
     SunburstSeries.defaultOptions = merge(TreemapSeries.defaultOptions, {
@@ -661,6 +662,13 @@ var SunburstSeries = /** @class */ (function (_super) {
          * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
          * @apioption plotOptions.sunburst.levels.color
          */
+        /**
+         * Determines whether the chart should receive one color per point based
+         * on this level.
+         *
+         * @type      {boolean}
+         * @apioption plotOptions.sunburst.levels.colorByPoint
+         */
         /**
          * Can set a `colorVariation` on all points which lies on the same
          * level.
@@ -734,6 +742,8 @@ var SunburstSeries = /** @class */ (function (_super) {
          * @type    {Array<number|string>}
          * @default ["50%", "50%"]
          * @product highcharts
+         *
+         * @private
          */
         center: ['50%', '50%'],
         colorByPoint: false,
@@ -741,10 +751,14 @@ var SunburstSeries = /** @class */ (function (_super) {
          * Disable inherited opacity from Treemap series.
          *
          * @ignore-option
+         *
+         * @private
          */
         opacity: 1,
         /**
          * @declare Highcharts.SeriesSunburstDataLabelsOptionsObject
+         *
+         * @private
          */
         dataLabels: {
             allowOverlap: true,
@@ -776,6 +790,8 @@ var SunburstSeries = /** @class */ (function (_super) {
          * Which point to use as a root in the visualization.
          *
          * @type {string}
+         *
+         * @private
          */
         rootId: void 0,
         /**
@@ -783,6 +799,8 @@ var SunburstSeries = /** @class */ (function (_super) {
          * set to false the first level visible when drilling is considered
          * to be level one. Otherwise the level will be the same as the tree
          * structure.
+         *
+         * @private
          */
         levelIsConstant: true,
         /**
@@ -792,6 +810,8 @@ var SunburstSeries = /** @class */ (function (_super) {
          *         Sunburst with various sizes per level
          *
          * @since 6.0.5
+         *
+         * @private
          */
         levelSize: {
             /**
@@ -839,6 +859,8 @@ var SunburstSeries = /** @class */ (function (_super) {
          *         Sliced sunburst
          *
          * @since 6.0.4
+         *
+         * @private
          */
         slicedOffset: 10
     });

package/es-modules/Series/Timeline/TimelineSeries.js

@@ -296,6 +296,8 @@ var TimelineSeries = /** @class */ (function (_super) {
      *               boostBlending
      * @requires     modules/timeline
      * @optionparent plotOptions.timeline
+     *
+     * @private
      */
     TimelineSeries.defaultOptions = merge(LineSeries.defaultOptions, {
         colorByPoint: true,