highcharts 10.2.1 → 10.3.1

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

@@ -0,0 +1,522 @@
+/* *
+ *
+ *  Sankey diagram module
+ *
+ *  (c) 2010-2021 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+/* *
+ *
+ *  API Options
+ *
+ * */
+/**
+ * A sankey diagram is a type of flow diagram, in which the width of the
+ * link between two nodes is shown proportionally to the flow quantity.
+ *
+ * @sample highcharts/demo/sankey-diagram/
+ *         Sankey diagram
+ * @sample highcharts/plotoptions/sankey-inverted/
+ *         Inverted sankey diagram
+ * @sample highcharts/plotoptions/sankey-outgoing
+ *         Sankey diagram with outgoing links
+ *
+ * @extends      plotOptions.column
+ * @since        6.0.0
+ * @product      highcharts
+ * @excluding    animationLimit, boostThreshold, borderRadius,
+ *               crisp, cropThreshold, colorAxis, colorKey, depth, dragDrop,
+ *               edgeColor, edgeWidth, findNearestPointBy, grouping,
+ *               groupPadding, groupZPadding, maxPointWidth, negativeColor,
+ *               pointInterval, pointIntervalUnit, pointPadding,
+ *               pointPlacement, pointRange, pointStart, pointWidth,
+ *               shadow, softThreshold, stacking, threshold, zoneAxis,
+ *               zones, minPointLength, dataSorting, boostBlending
+ * @requires     modules/sankey
+ * @optionparent plotOptions.sankey
+ *
+ * @private
+ */
+var SankeySeriesDefaults = {
+    borderWidth: 0,
+    colorByPoint: true,
+    /**
+     * Higher numbers makes the links in a sankey diagram or dependency
+     * wheelrender more curved. A `curveFactor` of 0 makes the lines
+     * straight.
+     *
+     * @private
+     */
+    curveFactor: 0.33,
+    /**
+     * Options for the data labels appearing on top of the nodes and links.
+     * For sankey charts, data labels are visible for the nodes by default,
+     * but hidden for links. This is controlled by modifying the
+     * `nodeFormat`, and the `format` that applies to links and is an empty
+     * string by default.
+     *
+     * @declare Highcharts.SeriesSankeyDataLabelsOptionsObject
+     *
+     * @private
+     */
+    dataLabels: {
+        enabled: true,
+        backgroundColor: 'none',
+        crop: false,
+        /**
+         * The
+         * [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
+         * specifying what to show for _nodes_ in the sankey diagram. By
+         * default the `nodeFormatter` returns `{point.name}`.
+         *
+         * @sample highcharts/plotoptions/sankey-link-datalabels/
+         *         Node and link data labels
+         *
+         * @type {string}
+         */
+        nodeFormat: void 0,
+        // eslint-disable-next-line valid-jsdoc
+        /**
+         * Callback to format data labels for _nodes_ in the sankey diagram.
+         * The `nodeFormat` option takes precedence over the
+         * `nodeFormatter`.
+         *
+         * @type  {Highcharts.SeriesSankeyDataLabelsFormatterCallbackFunction}
+         * @since 6.0.2
+         */
+        nodeFormatter: function () {
+            return this.point.name;
+        },
+        format: void 0,
+        // eslint-disable-next-line valid-jsdoc
+        /**
+         * @type {Highcharts.SeriesSankeyDataLabelsFormatterCallbackFunction}
+         */
+        formatter: function () {
+            return;
+        },
+        inside: true
+    },
+    /**
+     * @ignore-option
+     *
+     * @private
+     */
+    inactiveOtherPoints: true,
+    /**
+     * Set options on specific levels. Takes precedence over series options,
+     * but not node and link options.
+     *
+     * @sample highcharts/demo/sunburst
+     *         Sunburst chart
+     *
+     * @type      {Array<*>}
+     * @since     7.1.0
+     * @apioption plotOptions.sankey.levels
+     */
+    /**
+     * Can set `borderColor` on all nodes which lay on the same level.
+     *
+     * @type      {Highcharts.ColorString}
+     * @apioption plotOptions.sankey.levels.borderColor
+     */
+    /**
+     * Can set `borderWidth` on all nodes which lay on the same level.
+     *
+     * @type      {number}
+     * @apioption plotOptions.sankey.levels.borderWidth
+     */
+    /**
+     * Can set `color` on all nodes which lay on the same level.
+     *
+     * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+     * @apioption plotOptions.sankey.levels.color
+     */
+    /**
+     * Can set `colorByPoint` on all nodes which lay on the same level.
+     *
+     * @type      {boolean}
+     * @default   true
+     * @apioption plotOptions.sankey.levels.colorByPoint
+     */
+    /**
+     * Can set `dataLabels` on all points which lay on the same level.
+     *
+     * @extends   plotOptions.sankey.dataLabels
+     * @apioption plotOptions.sankey.levels.dataLabels
+     */
+    /**
+     * Decides which level takes effect from the options set in the levels
+     * object.
+     *
+     * @type      {number}
+     * @apioption plotOptions.sankey.levels.level
+     */
+    /**
+     * Can set `linkOpacity` on all points which lay on the same level.
+     *
+     * @type      {number}
+     * @default   0.5
+     * @apioption plotOptions.sankey.levels.linkOpacity
+     */
+    /**
+     * Can set `states` on all nodes and points which lay on the same level.
+     *
+     * @extends   plotOptions.sankey.states
+     * @apioption plotOptions.sankey.levels.states
+     */
+    /**
+     * Opacity for the links between nodes in the sankey diagram.
+     *
+     * @private
+     */
+    linkOpacity: 0.5,
+    /**
+     * Opacity for the nodes in the sankey diagram.
+     *
+     * @private
+     */
+    opacity: 1,
+    /**
+     * The minimal width for a line of a sankey. By default,
+     * 0 values are not shown.
+     *
+     * @sample highcharts/plotoptions/sankey-minlinkwidth
+     *         Sankey diagram with minimal link height
+     *
+     * @type      {number}
+     * @since     7.1.3
+     * @default   0
+     * @apioption plotOptions.sankey.minLinkWidth
+     *
+     * @private
+     */
+    minLinkWidth: 0,
+    /**
+     * The pixel width of each node in a sankey diagram or dependency wheel,
+     * or the height in case the chart is inverted.
+     *
+     * @private
+     */
+    nodeWidth: 20,
+    /**
+     * The padding between nodes in a sankey diagram or dependency wheel, in
+     * pixels.
+     *
+     * If the number of nodes is so great that it is possible to lay them
+     * out within the plot area with the given `nodePadding`, they will be
+     * rendered with a smaller padding as a strategy to avoid overflow.
+     *
+     * @private
+     */
+    nodePadding: 10,
+    showInLegend: false,
+    states: {
+        hover: {
+            /**
+             * Opacity for the links between nodes in the sankey diagram in
+             * hover mode.
+             */
+            linkOpacity: 1,
+            /**
+             * Opacity for the nodes in the sankey diagram in hover mode.
+             */
+            opacity: 1
+        },
+        /**
+         * The opposite state of a hover for a single point node/link.
+         *
+         * @declare Highcharts.SeriesStatesInactiveOptionsObject
+         */
+        inactive: {
+            /**
+             * Opacity for the links between nodes in the sankey diagram in
+             * inactive mode.
+             */
+            linkOpacity: 0.1,
+            /**
+             * Opacity of the nodes in the sankey diagram in inactive mode.
+             */
+            opacity: 0.1,
+            /**
+             * Animation when not hovering over the marker.
+             *
+             * @type      {boolean|Partial<Highcharts.AnimationOptionsObject>}
+             * @apioption plotOptions.series.states.inactive.animation
+             */
+            animation: {
+                /** @internal */
+                duration: 50
+            }
+        }
+    },
+    tooltip: {
+        /**
+         * A callback for defining the format for _nodes_ in the chart's
+         * tooltip, as opposed to links.
+         *
+         * @type      {Highcharts.FormatterCallbackFunction<Highcharts.SankeyNodeObject>}
+         * @since     6.0.2
+         * @apioption plotOptions.sankey.tooltip.nodeFormatter
+         */
+        /**
+         * Whether the tooltip should follow the pointer or stay fixed on
+         * the item.
+         */
+        followPointer: true,
+        headerFormat: '<span style="font-size: 10px">{series.name}</span><br/>',
+        pointFormat: '{point.fromNode.name} \u2192 {point.toNode.name}: <b>{point.weight}</b><br/>',
+        /**
+         * The
+         * [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
+         * specifying what to show for _nodes_ in tooltip of a diagram
+         * series, as opposed to links.
+         */
+        nodeFormat: '{point.name}: <b>{point.sum}</b><br/>'
+    }
+};
+/**
+ * A `sankey` series. If the [type](#series.sankey.type) option is not
+ * specified, it is inherited from [chart.type](#chart.type).
+ *
+ * @extends   series,plotOptions.sankey
+ * @excluding animationLimit, boostBlending, boostThreshold, borderColor,
+ *            borderRadius, borderWidth, crisp, cropThreshold, dataParser,
+ *            dataURL, depth, dragDrop, edgeColor, edgeWidth,
+ *            findNearestPointBy, getExtremesFromAll, grouping, groupPadding,
+ *            groupZPadding, label, maxPointWidth, negativeColor, pointInterval,
+ *            pointIntervalUnit, pointPadding, pointPlacement, pointRange,
+ *            pointStart, pointWidth, shadow, softThreshold, stacking,
+ *            threshold, zoneAxis, zones, dataSorting
+ * @product   highcharts
+ * @requires  modules/sankey
+ * @apioption series.sankey
+ */
+/**
+ * A collection of options for the individual nodes. The nodes in a sankey
+ * diagram are auto-generated instances of `Highcharts.Point`, but options can
+ * be applied here and linked by the `id`.
+ *
+ * @sample highcharts/css/sankey/
+ *         Sankey diagram with node options
+ *
+ * @declare   Highcharts.SeriesSankeyNodesOptionsObject
+ * @type      {Array<*>}
+ * @product   highcharts
+ * @apioption series.sankey.nodes
+ */
+/**
+ * The id of the auto-generated node, refering to the `from` or `to` setting of
+ * the link.
+ *
+ * @type      {string}
+ * @product   highcharts
+ * @apioption series.sankey.nodes.id
+ */
+/**
+ * The color of the auto generated node.
+ *
+ * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+ * @product   highcharts
+ * @apioption series.sankey.nodes.color
+ */
+/**
+ * The color index of the auto generated node, especially for use in styled
+ * mode.
+ *
+ * @type      {number}
+ * @product   highcharts
+ * @apioption series.sankey.nodes.colorIndex
+ */
+/**
+ * An optional column index of where to place the node. The default behaviour is
+ * to place it next to the preceding node. Note that this option name is
+ * counter intuitive in inverted charts, like for example an organization chart
+ * rendered top down. In this case the "columns" are horizontal.
+ *
+ * @sample highcharts/plotoptions/sankey-node-column/
+ *         Specified node column
+ *
+ * @type      {number}
+ * @since     6.0.5
+ * @product   highcharts
+ * @apioption series.sankey.nodes.column
+ */
+/**
+ * Individual data label for each node. The options are the same as
+ * the ones for [series.sankey.dataLabels](#series.sankey.dataLabels).
+ *
+ * @extends   plotOptions.sankey.dataLabels
+ * @apioption series.sankey.nodes.dataLabels
+ */
+/**
+ * An optional level index of where to place the node. The default behaviour is
+ * to place it next to the preceding node. Alias of `nodes.column`, but in
+ * inverted sankeys and org charts, the levels are laid out as rows.
+ *
+ * @type      {number}
+ * @since     7.1.0
+ * @product   highcharts
+ * @apioption series.sankey.nodes.level
+ */
+/**
+ * The name to display for the node in data labels and tooltips. Use this when
+ * the name is different from the `id`. Where the id must be unique for each
+ * node, this is not necessary for the name.
+ *
+ * @sample highcharts/css/sankey/
+ *         Sankey diagram with node options
+ *
+ * @type      {string}
+ * @product   highcharts
+ * @apioption series.sankey.nodes.name
+ */
+/**
+ * This option is deprecated, use
+ * [offsetHorizontal](#series.sankey.nodes.offsetHorizontal) and
+ * [offsetVertical](#series.sankey.nodes.offsetVertical) instead.
+ *
+ * In a horizontal layout, the vertical offset of a node in terms of weight.
+ * Positive values shift the node downwards, negative shift it upwards. In a
+ * vertical layout, like organization chart, the offset is horizontal.
+ *
+ * If a percantage string is given, the node is offset by the percentage of the
+ * node size plus `nodePadding`.
+ *
+ * @deprecated
+ * @type      {number|string}
+ * @default   0
+ * @since     6.0.5
+ * @product   highcharts
+ * @apioption series.sankey.nodes.offset
+ */
+/**
+ * The horizontal offset of a node. Positive values shift the node right,
+ * negative shift it left.
+ *
+ * If a percantage string is given, the node is offset by the percentage of the
+ * node size.
+ *
+ * @sample highcharts/plotoptions/sankey-node-column/
+ *         Specified node offset
+ *
+ * @type      {number|string}
+ * @since 9.3.0
+ * @product   highcharts
+ * @apioption series.sankey.nodes.offsetHorizontal
+ */
+/**
+ * The vertical offset of a node. Positive values shift the node down,
+ * negative shift it up.
+ *
+ * If a percantage string is given, the node is offset by the percentage of the
+ * node size.
+ *
+ * @sample highcharts/plotoptions/sankey-node-column/
+ *         Specified node offset
+ *
+ * @type      {number|string}
+ * @since 9.3.0
+ * @product   highcharts
+ * @apioption series.sankey.nodes.offsetVertical
+ */
+/**
+ * An array of data points for the series. For the `sankey` series type,
+ * points can be given in the following way:
+ *
+ * An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
+ * points exceeds the series' [turboThreshold](#series.area.turboThreshold),
+ * this option is not available.
+ *
+ *  ```js
+ *     data: [{
+ *         from: 'Category1',
+ *         to: 'Category2',
+ *         weight: 2
+ *     }, {
+ *         from: 'Category1',
+ *         to: 'Category3',
+ *         weight: 5
+ *     }]
+ *  ```
+ *
+ *  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<*>|Array<Array<(string|number)>>}
+ * @extends   series.line.data
+ * @excluding dragDrop, drilldown, marker, x, y
+ * @product   highcharts
+ * @apioption series.sankey.data
+ */
+/**
+ * The color for the individual _link_. By default, the link color is the same
+ * as the node it extends from. The `series.fillOpacity` option also applies to
+ * the points, so when setting a specific link color, consider setting the
+ * `fillOpacity` to 1.
+ *
+ * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+ * @product   highcharts
+ * @apioption series.sankey.data.color
+ */
+/**
+ * @type      {Highcharts.SeriesSankeyDataLabelsOptionsObject|Array<Highcharts.SeriesSankeyDataLabelsOptionsObject>}
+ * @product   highcharts
+ * @apioption series.sankey.data.dataLabels
+ */
+/**
+ * The node that the link runs from.
+ *
+ * @type      {string}
+ * @product   highcharts
+ * @apioption series.sankey.data.from
+ */
+/**
+ * The node that the link runs to.
+ *
+ * @type      {string}
+ * @product   highcharts
+ * @apioption series.sankey.data.to
+ */
+/**
+ * Whether the link goes out of the system.
+ *
+ * @sample highcharts/plotoptions/sankey-outgoing
+ *         Sankey chart with outgoing links
+ *
+ * @type      {boolean}
+ * @default   false
+ * @product   highcharts
+ * @apioption series.sankey.data.outgoing
+ */
+/**
+ * The weight of the link.
+ *
+ * @type      {number|null}
+ * @product   highcharts
+ * @apioption series.sankey.data.weight
+ */
+''; // adds doclets above to transpiled file
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default SankeySeriesDefaults;

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

@@ -23,6 +23,7 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+import ScatterSeriesDefaults from './ScatterSeriesDefaults.js';
 import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
 var _a = SeriesRegistry.seriesTypes, ColumnSeries = _a.column, LineSeries = _a.line;
 import U from '../../Core/Utilities.js';
@@ -114,104 +115,7 @@ var ScatterSeries = /** @class */ (function (_super) {
             this.graph = this.graph.destroy();
         }
     };
-    /**
-     * A scatter plot uses cartesian coordinates to display values for two
-     * variables for a set of data.
-     *
-     * @sample {highcharts} highcharts/demo/scatter/
-     *         Scatter plot
-     *
-     * @extends      plotOptions.line
-     * @excluding    cropThreshold, pointPlacement, shadow, useOhlcData
-     * @product      highcharts highstock
-     * @optionparent plotOptions.scatter
-     */
-    ScatterSeries.defaultOptions = merge(LineSeries.defaultOptions, {
-        /**
-         * The width of the line connecting the data points.
-         *
-         * @sample {highcharts} highcharts/plotoptions/scatter-linewidth-none/
-         *         0 by default
-         * @sample {highcharts} highcharts/plotoptions/scatter-linewidth-1/
-         *         1px
-         *
-         * @product highcharts highstock
-         */
-        lineWidth: 0,
-        findNearestPointBy: 'xy',
-        /**
-         * Apply a jitter effect for the rendered markers. When plotting
-         * discrete values, a little random noise may help telling the points
-         * apart. The jitter setting applies a random displacement of up to `n`
-         * axis units in either direction. So for example on a horizontal X
-         * axis, setting the `jitter.x` to 0.24 will render the point in a
-         * random position between 0.24 units to the left and 0.24 units to the
-         * right of the true axis position. On a category axis, setting it to
-         * 0.5 will fill up the bin and make the data appear continuous.
-         *
-         * When rendered on top of a box plot or a column series, a jitter value
-         * of 0.24 will correspond to the underlying series' default
-         * [groupPadding](
-         * https://api.highcharts.com/highcharts/plotOptions.column.groupPadding)
-         * and [pointPadding](
-         * https://api.highcharts.com/highcharts/plotOptions.column.pointPadding)
-         * settings.
-         *
-         * @sample {highcharts} highcharts/series-scatter/jitter
-         *         Jitter on a scatter plot
-         *
-         * @sample {highcharts} highcharts/series-scatter/jitter-boxplot
-         *         Jittered scatter plot on top of a box plot
-         *
-         * @product highcharts highstock
-         * @since 7.0.2
-         */
-        jitter: {
-            /**
-             * The maximal X offset for the random jitter effect.
-             */
-            x: 0,
-            /**
-             * The maximal Y offset for the random jitter effect.
-             */
-            y: 0
-        },
-        marker: {
-            enabled: true // Overrides auto-enabling in line series (#3647)
-        },
-        /**
-         * Sticky tracking of mouse events. When true, the `mouseOut` event
-         * on a series isn't triggered until the mouse moves over another
-         * series, or out of the plot area. When false, the `mouseOut` event on
-         * a series is triggered when the mouse leaves the area around the
-         * series' graph or markers. This also implies the tooltip. When
-         * `stickyTracking` is false and `tooltip.shared` is false, the tooltip
-         * will be hidden when moving the mouse between series.
-         *
-         * @type      {boolean}
-         * @default   false
-         * @product   highcharts highstock highmaps
-         * @apioption plotOptions.scatter.stickyTracking
-         */
-        /**
-         * A configuration object for the tooltip rendering of each single
-         * series. Properties are inherited from [tooltip](#tooltip).
-         * Overridable properties are `headerFormat`, `pointFormat`,
-         * `yDecimals`, `xDateFormat`, `yPrefix` and `ySuffix`. Unlike other
-         * 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 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/>'
-        }
-    });
+    ScatterSeries.defaultOptions = merge(LineSeries.defaultOptions, ScatterSeriesDefaults);
     return ScatterSeries;
 }(LineSeries));
 extend(ScatterSeries.prototype, {
@@ -238,77 +142,3 @@ SeriesRegistry.registerSeriesType('scatter', ScatterSeries);
  *
  * */
 export default ScatterSeries;
-/* *
- *
- *  API Options
- *
- * */
-/**
- * A `scatter` series. If the [type](#series.scatter.type) option is
- * not specified, it is inherited from [chart.type](#chart.type).
- *
- * @extends   series,plotOptions.scatter
- * @excluding cropThreshold, dataParser, dataURL, useOhlcData
- * @product   highcharts highstock
- * @apioption series.scatter
- */
-/**
- * An array of data points for the series. For the `scatter` series
- * type, points can be given in the following ways:
- *
- * 1. An array of numerical values. In this case, the numerical values will be
- *    interpreted as `y` options. The `x` values will be automatically
- *    calculated, either starting at 0 and incremented by 1, or from
- *    `pointStart` and `pointInterval` given in the series options. If the axis
- *    has categories, these will be used. Example:
- *    ```js
- *    data: [0, 5, 3, 5]
- *    ```
- *
- * 2. An array of arrays with 2 values. In this case, the values correspond to
- *    `x,y`. If the first value is a string, it is applied as the name of the
- *    point, and the `x` value is inferred.
- *    ```js
- *    data: [
- *        [0, 0],
- *        [1, 8],
- *        [2, 9]
- *    ]
- *    ```
- *
- * 3. An array of objects with named values. The following snippet shows only a
- *    few settings, see the complete options set below. If the total number of
- *    data points exceeds the series'
- *    [turboThreshold](#series.scatter.turboThreshold), this option is not
- *    available.
- *    ```js
- *    data: [{
- *        x: 1,
- *        y: 2,
- *        name: "Point2",
- *        color: "#00FF00"
- *    }, {
- *        x: 1,
- *        y: 4,
- *        name: "Point1",
- *        color: "#FF00FF"
- *    }]
- *    ```
- *
- * @sample {highcharts} highcharts/chart/reflow-true/
- *         Numerical values
- * @sample {highcharts} highcharts/series/data-array-of-arrays/
- *         Arrays of numeric x and y
- * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
- *         Arrays of datetime x and y
- * @sample {highcharts} highcharts/series/data-array-of-name-value/
- *         Arrays of point.name and y
- * @sample {highcharts} highcharts/series/data-array-of-objects/
- *         Config objects
- *
- * @type      {Array<number|Array<(number|string),(number|null)>|null|*>}
- * @extends   series.line.data
- * @product   highcharts highstock
- * @apioption series.scatter.data
- */
-''; // keeps doclets above in JS file