highcharts 13.0.0 → 13.0.2

package/options/dependencywheel.d.ts

@@ -6,196 +6,619 @@
 import * as Highcharts from "../highcharts";
 declare module "../highcharts" {
     /**
-     * (Highcharts) Point accessibility options for a series.
+     * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
+     * animation when a series is displayed for the `dataLabels`. The animation
+     * can also be set as a configuration object. Please note that this option
+     * only applies to the initial animation.
+     *
+     * For other animations, see chart.animation and the animation parameter
+     * under the API methods. The following properties are supported:
+     *
+     * - `defer`: The animation delay time in milliseconds.
      */
-    interface PlotDependencywheelAccessibilityPointOptions {
+    interface PlotDependencywheelDataLabelsAnimationOptions {
         /**
-         * (Highcharts) Date format to use for points on datetime axes when
-         * describing them to screen reader users.
-         *
-         * Defaults to the same format as in tooltip.
+         * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
+         * milliseconds. Set to `0` to render the data labels immediately. As
+         * `undefined` inherits defer time from the series.animation.defer.
+         */
+        defer?: number;
+    }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
+     * animation when a series is displayed for the `dataLabels`. The animation
+     * can also be set as a configuration object. Please note that this option
+     * only applies to the initial animation.
+     *
+     * For other animations, see chart.animation and the animation parameter
+     * under the API methods. The following properties are supported:
+     *
+     * - `defer`: The animation delay time in milliseconds.
+     */
+    interface PlotDependencywheelLevelsDataLabelsAnimationOptions {
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
+         * milliseconds. Set to `0` to render the data labels immediately. As
+         * `undefined` inherits defer time from the series.animation.defer.
+         */
+        defer?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotDependencywheelLevelsStatesHoverAnimationOptions {
+        /**
+         * (Highcharts, Highstock) The duration of the hover animation in
+         * milliseconds. By default the hover state animates quickly in, and
+         * slowly back to normal.
+         */
+        duration?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotDependencywheelLevelsStatesSelectAnimationOptions {
+        /**
+         * (Highcharts, Highstock) The duration of the hover animation in
+         * milliseconds. By default the hover state animates quickly in, and
+         * slowly back to normal.
+         */
+        duration?: number;
+    }
+    /**
+     * (Highcharts) Options for the _Series on point_ feature. Only `pie` and
+     * `sunburst` series are supported at this moment.
+     */
+    interface PlotDependencywheelOnPointOptions {
+        /**
+         * (Highcharts) Options for the connector in the _Series on point_
+         * feature.
          *
-         * For an overview of the replacement codes, see dateFormat.
+         * In styled mode, the connector can be styled with the
+         * `.highcharts-connector-seriesonpoint` class name.
          */
-        dateFormat?: string;
+        connectorOptions?: (Highcharts.PlotDependencywheelOnPointConnectorOptions|Highcharts.SVGAttributes);
         /**
-         * (Highcharts) Formatter function to determine the date/time format
-         * used with points on datetime axes when describing them to screen
-         * reader users. Receives one argument, `point`, referring to the point
-         * to describe. Should return a date format string compatible with
-         * dateFormat.
+         * (Highcharts) The `id` of the point that we connect the series to.
+         * Only points with a given `plotX` and `plotY` values and map points
+         * are valid.
          */
-        dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        id?: string;
         /**
-         * (Highcharts) Whether or not to describe points with the value `null`
-         * to assistive technology, such as screen readers.
+         * (Highcharts) Options allowing to set a position and an offset of the
+         * series in the _Series on point_ feature.
          */
-        describeNull?: boolean;
+        position?: (object|Highcharts.PlotDependencywheelOnPointPositionOptions);
+    }
+    /**
+     * (Highcharts) A dependency wheel chart is a type of flow diagram, where
+     * all nodes are laid out in a circle, and the flow between the are drawn as
+     * link bands.
+     *
+     * Configuration options for the series are given in three levels:
+     *
+     * 1. Options for all series in a chart are defined in the
+     * plotOptions.series object.
+     *
+     * 2. Options for all `dependencywheel` series are defined in
+     * plotOptions.dependencywheel.
+     *
+     * 3. Options for one single series are given in the series instance array.
+     * (see online documentation for example)
+     *
+     * **TypeScript:**
+     *
+     * - type option should always be set, otherwise a broad set of unsupported
+     * options is allowed.
+     *
+     * - when accessing an array of series, the combined set of all series types
+     * is represented by Highcharts.SeriesOptionsType . Narrowing down to the
+     * specific type can be done by checking the `type` property. (see online
+     * documentation for example)
+     */
+    interface PlotDependencywheelOptions {
         /**
-         * (Highcharts) A format string to use instead of the default for point
-         * descriptions.
+         * (Highcharts) Accessibility options for a series.
+         */
+        accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
+        /**
+         * (Highcharts) Allow this series' points to be selected by clicking on
+         * the graphic (columns, point markers, pie slices, map areas etc).
          *
-         * The context of the format string is the point instance.
+         * The selected points can be handled by point select and unselect
+         * events, or collectively by the getSelectedPoints function.
          *
-         * As opposed to accessibility.point.valueDescriptionFormat, this option
-         * replaces the whole description.
+         * And alternative way of selecting points is through dragging.
          */
-        descriptionFormat?: string;
+        allowPointSelect?: boolean;
         /**
-         * (Highcharts) Formatter function to use instead of the default for
-         * point descriptions. Same as
-         * `accessibility.point.descriptionFormatter`, but applies to a series
-         * instead of the whole chart.
+         * (Highcharts) Enable or disable the initial animation when a series is
+         * displayed. The animation can also be set as a configuration object.
+         * Please note that this option only applies to the initial animation of
+         * the series itself. For other animations, see chart.animation and the
+         * animation parameter under the API methods. The following properties
+         * are supported:
+         *
+         * - `defer`: The animation delay time in milliseconds.
+         *
+         * - `duration`: The duration of the animation in milliseconds.
+         * (Defaults to `1000`)
+         *
+         * - `easing`: Can be a string reference to an easing function set on
+         * the `Math` object or a function. See the _Custom easing function_
+         * demo below. (Defaults to `easeInOutSine`)
          *
-         * Note: Prefer using accessibility.point.valueDescriptionFormat instead
-         * if possible, as default functionality such as describing annotations
-         * will be preserved.
+         * Due to poor performance, animation is disabled in old IE browsers for
+         * several chart types.
          */
-        descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        animation?: (boolean|Highcharts.AnimationOptionsObject);
         /**
-         * (Highcharts) Decimals to use for the values in the point
-         * descriptions. Uses tooltip.valueDecimals if not defined.
+         * (Highcharts, Highstock, Gantt) The color of the border surrounding
+         * each column or bar.
+         *
+         * In styled mode, the border stroke can be set with the
+         * `.highcharts-point` rule.
          */
-        valueDecimals?: number;
+        borderColor?: Highcharts.ColorType;
         /**
-         * (Highcharts) Format to use for describing the values of data points
-         * to assistive technology - including screen readers. The point context
-         * is available as `{point}`.
-         *
-         * Other available context variables include `{index}`, `{value}`, and
-         * `{xDescription}`.
+         * (Highcharts) The corner radius of the border surrounding each node. A
+         * number signifies pixels. A percentage string, like for example `50%`,
+         * signifies a relative size. For nodes this is relative to the node
+         * width.
+         */
+        borderRadius?: (number|string|Highcharts.BorderRadiusOptionsObject);
+        /**
+         * (Highcharts, Highstock, Gantt) The width of the border surrounding
+         * each column or bar. Defaults to `1` when there is room for a border,
+         * but to `0` when the columns are so dense that a border would cover
+         * the next column.
          *
-         * Additionally, the series name, annotation info, and description added
-         * in `point.accessibility.description` is added by default if relevant.
-         * To override this, use the accessibility.point.descriptionFormatter
-         * option.
+         * In styled mode, the stroke width can be set with the
+         * `.highcharts-point` rule.
          */
-        valueDescriptionFormat?: string;
+        borderWidth?: number;
         /**
-         * (Highcharts) Prefix to add to the values in the point descriptions.
-         * Uses tooltip.valuePrefix if not defined.
+         * (Highcharts) The center of the wheel relative to the plot area. Can
+         * be percentages or pixel values. The default behavior is to center the
+         * wheel inside the plot area.
          */
-        valuePrefix?: string;
+        center?: Array<(number|string|null)>;
         /**
-         * (Highcharts) Suffix to add to the values in the point descriptions.
-         * Uses tooltip.valueSuffix if not defined.
+         * (Highcharts, Highstock, Gantt) When `true`, the columns will center
+         * in the category, ignoring null or missing points. When `false`, space
+         * will be reserved for null or missing points.
          */
-        valueSuffix?: string;
-    }
-    /**
-     * (Highcharts, Highstock, Gantt) Styles for the series label. The color
-     * defaults to the series color, or a contrast color if `onArea`.
-     */
-    interface PlotDependencywheelLabelStyleOptions {
-        fontSize?: number;
-        fontWeight?: string;
-    }
-    /**
-     * (Highcharts) Set options on specific levels. Takes precedence over series
-     * options, but not node and link options.
-     */
-    interface PlotDependencywheelLevelsOptions {
+        centerInCategory?: boolean;
         /**
-         * (Highcharts) Can set `borderColor` on all nodes which lay on the same
-         * level.
+         * (Highcharts) An additional class name to apply to the series'
+         * graphical elements. This option does not replace default class names
+         * of the graphical element. Changes to the series' color will also be
+         * reflected in a chart's legend and tooltip.
          */
-        borderColor?: Highcharts.ColorString;
+        className?: string;
         /**
-         * (Highcharts) Can set `borderWidth` on all nodes which lay on the same
-         * level.
+         * (Highcharts) Disable this option to allow series rendering in the
+         * whole plotting area.
+         *
+         * **Note:** Clipping should be always enabled when chart.zoomType is
+         * set
          */
-        borderWidth?: number;
+        clip?: boolean;
         /**
-         * (Highcharts) Can set `color` on all nodes which lay on the same
-         * level.
+         * (Highcharts) The main color of the series. In line type series it
+         * applies to the line and the point markers unless otherwise specified.
+         * In bar type series it applies to the bars unless a color is specified
+         * per point. The default value is pulled from the `options.colors`
+         * array.
+         *
+         * In styled mode, the color can be defined by the colorIndex option.
+         * Also, the series color can be set with the `.highcharts-series`,
+         * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
+         * `.highcharts-series-{n}` class, or individual classes given by the
+         * `className` option.
          */
         color?: Highcharts.ColorType;
         /**
-         * (Highcharts) Can set `colorByPoint` on all nodes which lay on the
-         * same level.
+         * (Highcharts, Highstock, Gantt) When using automatic point colors
+         * pulled from the global colors or series-specific
+         * plotOptions.column.colors collections, this option determines whether
+         * the chart should receive one color per series or one color per point.
+         *
+         * In styled mode, the `colors` or `series.colors` arrays are not
+         * supported, and instead this option gives the points individual color
+         * class names on the form `highcharts-color-{n}`.
          */
         colorByPoint?: boolean;
         /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Can set `dataLabels` on all
-         * points which lay on the same level.
+         * (Highcharts) Styled mode only. A specific color index to use for the
+         * series, so its graphic representations are given the class name
+         * `highcharts-color-{n}`.
+         *
+         * Since v11, CSS variables on the form `--highcharts-color-{n}` make
+         * changing the color scheme very convenient.
+         */
+        colorIndex?: number;
+        /**
+         * (Highcharts, Highstock, Gantt) A series specific or series type
+         * specific color set to apply instead of the global colors when
+         * colorByPoint is true.
+         */
+        colors?: Array<Highcharts.ColorType>;
+        /**
+         * (Highcharts) You can set the cursor to "pointer" if you have click
+         * events attached to the series, to signal to the user that the points
+         * and lines can be clicked.
+         *
+         * In styled mode, the series cursor can be set with the same classes as
+         * listed under series.color.
+         */
+        cursor?: (string|Highcharts.CursorValue);
+        /**
+         * (Highcharts) Higher numbers makes the links in a sankey diagram or
+         * dependency wheel render more curved. A `curveFactor` of 0 makes the
+         * lines straight.
+         */
+        curveFactor?: number;
+        /**
+         * (Highcharts) A reserved subspace to store options and values for
+         * customized functionality. Here you can add additional data for your
+         * own event callbacks and formatter callbacks.
+         */
+        custom?: Highcharts.Dictionary<any>;
+        /**
+         * (Highcharts) Name of the dash style to use for the graph, or for some
+         * series types the outline of each shape.
+         *
+         * In styled mode, the stroke dash-array can be set with the same
+         * classes as listed under series.color.
+         */
+        dashStyle?: Highcharts.DashStyleValue;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) 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.
          */
         dataLabels?: (Highcharts.SeriesSankeyDataLabelsOptionsObject|Array<Highcharts.SeriesSankeyDataLabelsOptionsObject>);
         /**
-         * (Highcharts) Decides which level takes effect from the options set in
-         * the levels object.
+         * (Highcharts) The mapping between the data table and the series data
+         * points. This is used in conjunction with the `dataTable` option (on
+         * chart or series level) to map columns from the data table to the
+         * properties of the data points. The keys of the `dataMapping` object
+         * correspond to the properties of the data points (e.g. `x`, `y`,
+         * `name`), and the values are objects that specify which column from
+         * which data table to use for that property.
+         *
+         * The keys can also be nested paths, for example `dataLabel.format`, to
+         * map to nested properties of the data points.
+         *
+         * The values can also be strings, in which case they are interpreted as
+         * column id's from the first data table.
+         *
+         * A typical use case is that multiple series share a common column,
+         * like `name` or `x`. In this case, to avoid repetition, the common
+         * column can be applied in `plotOptions.series.dataMapping` and the
+         * individual series can specify only the columns that are unique to
+         * them.
+         *
+         * The series name defaults to the column ID of the main data column in
+         * the mapping. The main data column is typically the `y` data for
+         * cartesian series, or `value` for map series. For example, if the
+         * mapping is `{ y: 'Cost' }`, the series name will be `Cost`. (see
+         * online documentation for example)
+         *
+         * If the columns of the DataTable have keys matching the series keys,
+         * the data mapping is not necessary. For example, this DataTable will
+         * connect directly to the series' `x` and `y` keys: (see online
+         * documentation for example)
          */
-        level?: number;
+        dataMapping?: Highcharts.DataMappingOptionsObject;
         /**
-         * (Highcharts) Can set `linkOpacity` on all points which lay on the
-         * same level.
+         * (Highcharts) Options for a specific series-level data table or an
+         * array of data tables. The `dataTable` option can be either a
+         * configuration object or an instance of the `DataTable` class. If a
+         * `DataTable` instance is passed, it will be used directly. If a
+         * configuration object or an array is passed, a new `DataTable`
+         * instance will be created based on the provided configuration.
          */
-        linkOpacity?: number;
+        dataTable?: (Highcharts.DataTable|Highcharts.DataTableOptionsObject|Array<(Highcharts.DataTable|Highcharts.DataTableOptionsObject)>);
         /**
-         * (Highcharts) Can set `states` on all nodes and points which lay on
-         * the same level.
+         * (Highcharts) Deprecated. Use
+         * plotOptions.series.accessibility.description instead.
+         *
+         * A description of the series to add to the screen reader information
+         * about the series.
+         *
+         * @deprecated 8.0.0
          */
-        states?: Highcharts.SeriesStatesOptionsObject;
-    }
-    /**
-     * (Highcharts) Animation when not hovering over the marker.
-     */
-    interface PlotDependencywheelLevelsStatesInactiveAnimationOptions {
-        duration?: number;
-    }
-    /**
-     * (Highcharts) Options for the connector in the _Series on point_ feature.
-     *
-     * In styled mode, the connector can be styled with the
-     * `.highcharts-connector-seriesonpoint` class name.
-     */
-    interface PlotDependencywheelOnPointConnectorOptions {
+        description?: string;
         /**
-         * (Highcharts) A name for the dash style to use for the connector.
+         * (Highcharts) Enable or disable the mouse tracking for a specific
+         * series. This includes point tooltips and click events on graphs and
+         * points. For large datasets it improves performance.
          */
-        dashstyle?: string;
+        enableMouseTracking?: boolean;
         /**
-         * (Highcharts) Color of the connector line. By default it's the series'
-         * color.
+         * (Highcharts) General event handlers for the series items. These event
+         * hooks can also be attached to the series at run time using the
+         * `Highcharts.addEvent` function.
          */
-        stroke?: string;
+        events?: Highcharts.SeriesEventsOptionsObject;
         /**
-         * (Highcharts) Pixel width of the connector line.
+         * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the
+         * total chart width or only the zoomed area when zooming in on parts of
+         * the X axis. By default, the Y axis adjusts to the min and max of the
+         * visible data. Cartesian series only.
          */
-        width?: number;
-    }
-    /**
-     * (Highcharts) Options allowing to set a position and an offset of the
-     * series in the _Series on point_ feature.
-     */
-    interface PlotDependencywheelOnPointPositionOptions {
+        getExtremesFromAll?: boolean;
+        /**
+         * (Highcharts) Highlight only the hovered point and fade the remaining
+         * points.
+         *
+         * Scatter-type series require enabling the 'inactive' marker state and
+         * adjusting opacity. Note that this approach could affect performance
+         * with large datasets.
+         */
+        inactiveOtherPoints?: boolean;
+        /**
+         * (Highcharts) When set to `false` will prevent the series data from
+         * being included in any form of data export.
+         *
+         * Since version 6.0.0 until 7.1.0 the option was existing undocumented
+         * as `includeInCSVExport`.
+         */
+        includeInDataExport?: boolean;
         /**
-         * (Highcharts) Series center offset from the original x position. If
-         * defined, the connector line is drawn connecting original position
-         * with new position.
+         * (Highcharts) An array specifying which option maps to which key in
+         * the data point array. This makes it convenient to work with
+         * unstructured data arrays from different sources.
          */
-        offsetX?: number;
+        keys?: Array<string>;
         /**
-         * (Highcharts) Series center offset from the original y position. If
-         * defined, the connector line is drawn from original position to a new
+         * (Highcharts, Highstock, Gantt) Series labels are placed as close to
+         * the series as possible in a natural way, seeking to avoid other
+         * series. The goal of this feature is to make the chart more easily
+         * readable, like if a human designer placed the labels in the optimal
          * position.
+         *
+         * The series labels currently work with series types having a `graph`
+         * or an `area`.
          */
-        offsetY?: number;
+        label?: Highcharts.SeriesLabelOptionsObject;
         /**
-         * (Highcharts) X position of the series center. By default, the series
-         * is displayed on the point that it is connected to.
+         * (Highcharts) What type of legend symbol to render for this series.
+         * Can be one of `areaMarker`, `lineMarker` or `rectangle`.
          */
-        x?: number;
+        legendSymbol?: Highcharts.OptionsLegendSymbolValue;
         /**
-         * (Highcharts) Y position of the series center. By default, the series
-         * is displayed on the point that it is connected to.
+         * (Highcharts) Set options on specific levels. Takes precedence over
+         * series options, but not node and link options.
          */
-        y?: number;
+        levels?: Array<Highcharts.PlotDependencywheelLevelsOptions>;
+        /**
+         * (Highcharts) Determines color mode for sankey links. Available
+         * options:
+         *
+         * - `from` color of the sankey link will be the same as the 'from node'
+         *
+         * - `gradient` color of the sankey link will be set to gradient between
+         * colors of 'from node' and 'to node'
+         *
+         * - `to` color of the sankey link will be same as the 'to node'.
+         */
+        linkColorMode?: ('from'|'gradient'|'to');
+        /**
+         * (Highcharts, Highstock, Gantt) The id of another series to link to.
+         * Additionally, the value can be ":previous" to link to the previous
+         * series. When two series are linked, only the first one appears in the
+         * legend. Toggling the visibility of this also toggles the linked
+         * series.
+         *
+         * If master series uses data sorting and linked series does not have
+         * its own sorting definition, the linked series will be sorted in the
+         * same order as the master one.
+         *
+         * If a `compare` value is not set on a linked series, it will be
+         * inherited from the parent series.
+         */
+        linkedTo?: string;
+        /**
+         * (Highcharts) Opacity for the links between nodes in the sankey
+         * diagram.
+         */
+        linkOpacity?: number;
+        /**
+         * (Highcharts) The minimal width for a line of a sankey. By default, 0
+         * values are not shown.
+         */
+        minLinkWidth?: number;
+        /**
+         * (Highcharts) The padding between nodes in a sankey diagram or
+         * dependency wheel, in pixels. For sankey charts, this applies to the
+         * nodes of the same column, so vertical distance by default, or
+         * horizontal distance in an inverted (vertical) sankey.
+         *
+         * If the number of nodes is so great that it is impossible 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.
+         */
+        nodePadding?: number;
+        /**
+         * (Highcharts) The pixel width of each node in a sankey diagram or
+         * dependency wheel, or the height in case the chart is inverted.
+         *
+         * Can be a number or a percentage string.
+         *
+         * Sankey series also support setting it to `auto`. With this setting,
+         * the nodes are sized to fill up the plot area in the longitudinal
+         * direction, regardless of the number of levels.
+         */
+        nodeWidth?: (number|string);
+        /**
+         * (Highcharts, Highstock) Whether or not data-points with the value of
+         * `null` should be interactive. When this is set to `true`, tooltips
+         * may highlight these points, and this option also enables keyboard
+         * navigation for such points. Format options for such points include
+         * `nullFormat` and `nullFormatter`. Works for these series: `line`,
+         * `spline`, `area`, `area-spline`, `column`, `bar`, and `timeline`.
+         */
+        nullInteraction?: (boolean|undefined);
+        /**
+         * (Highcharts) Options for the _Series on point_ feature. Only `pie`
+         * and `sunburst` series are supported at this moment.
+         */
+        onPoint?: (object|Highcharts.PlotDependencywheelOnPointOptions);
+        /**
+         * (Highcharts) Opacity for the nodes in the sankey diagram.
+         */
+        opacity?: number;
+        /**
+         * (Highcharts) Properties for each single point.
+         */
+        point?: Highcharts.PlotSeriesPointOptions;
+        /**
+         * (Highcharts) Deprecated. Use
+         * series.accessibility.point.descriptionFormat instead.
+         *
+         * Same as accessibility.point.descriptionFormat, but for an individual
+         * series. Overrides the chart wide configuration.
+         *
+         * @deprecated 12.6.0
+         */
+        pointDescriptionFormat?: Function;
+        /**
+         * (Highcharts) Deprecated. Use
+         * series.accessibility.point.descriptionFormatter instead.
+         *
+         * Same as accessibility.series.descriptionFormatter, but for an
+         * individual series. Overrides the chart wide configuration.
+         *
+         * @deprecated 8.0.0
+         */
+        pointDescriptionFormatter?: Function;
+        /**
+         * (Highcharts, Highstock) When true, X values in the data set are
+         * relative to the current `pointStart`, `pointInterval` and
+         * `pointIntervalUnit` settings. This allows compression of the data for
+         * datasets with irregular X values.
+         *
+         * The real X values are computed on the formula `f(x) = ax + b`, where
+         * `a` is the `pointInterval` (optionally with a time unit given by
+         * `pointIntervalUnit`), and `b` is the `pointStart`.
+         */
+        relativeXValue?: boolean;
+        /**
+         * (Highcharts) Whether to select the series initially. If
+         * `showCheckbox` is true, the checkbox next to the series name in the
+         * legend will be checked for a selected series.
+         */
+        selected?: boolean;
+        /**
+         * (Highcharts) If true, a checkbox is displayed next to the legend item
+         * to allow selecting the series. The state of the checkbox is
+         * determined by the `selected` option.
+         */
+        showCheckbox?: boolean;
+        /**
+         * (Highcharts) Whether to display this particular series or series type
+         * in the legend. Standalone series are shown in legend by default, and
+         * linked series are not. Since v7.2.0 it is possible to show series
+         * that use colorAxis by setting this option to `true`.
+         */
+        showInLegend?: boolean;
+        /**
+         * (Highcharts) Size of the wheel in pixel or percent relative to the
+         * canvas space.
+         */
+        size?: (number|string);
+        /**
+         * (Highcharts) Deprecated. Use series.accessibility.keyboardNavigation
+         * instead.
+         *
+         * If set to `true`, the accessibility module will skip past the points
+         * in this series for keyboard navigation.
+         *
+         * @deprecated 8.0.0
+         */
+        skipKeyboardNavigation?: boolean;
+        /**
+         * (Highcharts) Sonification/audio chart options for a series.
+         */
+        sonification?: Highcharts.SeriesSonificationOptions;
+        /**
+         * (Highcharts) The start angle of the dependency wheel, in degrees
+         * where 0 is up.
+         */
+        startAngle?: number;
+        /**
+         * (Highcharts) A collection of options for different series states.
+         *
+         * In addition to the options documented under each state, any option
+         * from the parent series type can be set, with exception of `data` and
+         * `states`.
+         */
+        states?: Highcharts.SeriesStatesOptionsObject;
+        /**
+         * (Highcharts) 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 not shared. When `stickyTracking` is false and
+         * `tooltip.shared` is false, the tooltip will be hidden when moving the
+         * mouse between series. Defaults to true for line and area type series,
+         * but to false for columns, pies etc.
+         *
+         * **Note:** The boost module will force this option because of
+         * technical limitations.
+         */
+        stickyTracking?: boolean;
+        /**
+         * (Highcharts) A configuration object for the tooltip rendering of each
+         * single series. Properties are inherited from tooltip, but only the
+         * following properties can be defined on a series level.
+         */
+        tooltip?: Highcharts.SeriesTooltipOptionsObject;
+        /**
+         * (Highcharts, Highstock, Gantt) When a series contains a `data` array
+         * that is longer than this, the Series class looks for data
+         * configurations of plain numbers or arrays of numbers. The first and
+         * last valid points are checked. If found, the rest of the data is
+         * assumed to be the same. This saves expensive data checking and
+         * indexing in long series, and makes data-heavy charts render faster.
+         *
+         * Set it to `0` disable.
+         *
+         * Note:
+         *
+         * - In boost mode turbo threshold is forced. Only array of numbers or
+         * two dimensional arrays are allowed.
+         *
+         * - In version 11.4.3 and earlier, if object configurations were passed
+         * beyond the turbo threshold, a warning was logged in the console and
+         * the data series didn't render.
+         */
+        turboThreshold?: number;
+        /**
+         * (Highcharts) Set the initial visibility of the series.
+         */
+        visible?: boolean;
+        /**
+         * (Highcharts) Whether to zoom non-cartesian series. If `chart.zooming`
+         * is set, the option allows to disable zooming on an individual
+         * non-cartesian series. By default zooming is enabled for all series.
+         *
+         * **Note**: This option works only for non-cartesian series.
+         */
+        zoomEnabled?: boolean;
     }
     /**
-     * (Highcharts, Highstock) Animation setting for hovering the graph in
-     * line-type series.
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
      */
-    interface PlotDependencywheelStatesHoverAnimationOptions {
+    interface PlotDependencywheelStatesInactiveAnimationOptions {
         /**
          * (Highcharts, Highstock) The duration of the hover animation in
          * milliseconds. By default the hover state animates quickly in, and
@@ -204,115 +627,73 @@ declare module "../highcharts" {
         duration?: number;
     }
     /**
-     * (Highcharts, Highstock) Animation setting for hovering the graph in
-     * line-type series.
+     * (Highcharts, Highstock, Gantt) For series on datetime axes, the date
+     * format in the tooltip's header will by default be guessed based on the
+     * closest data points. This member gives the default string representations
+     * used for each unit. For an overview of the string or object
+     * configuration, see dateFormat.
      */
-    interface PlotDependencywheelStatesSelectAnimationOptions {
-        /**
-         * (Highcharts, Highstock) The duration of the hover animation in
-         * milliseconds. By default the hover state animates quickly in, and
-         * slowly back to normal.
-         */
-        duration?: number;
+    interface PlotDependencywheelTooltipDateTimeLabelFormatsOptions {
+        day?: string;
+        hour?: string;
+        millisecond?: string;
+        minute?: string;
+        month?: string;
+        second?: string;
+        week?: string;
+        year?: string;
     }
     /**
-     * (Highcharts) Options for the tooltip header when tooltip.split is
-     * enabled. The header is the box containing the X value in a split tooltip.
+     * (Highcharts) Positioning options for fixed tooltip, taking effect only
+     * when tooltip.fixed is `true`.
      */
-    interface PlotDependencywheelTooltipHeaderOptions {
+    interface PlotDependencywheelTooltipPositionOptions {
         /**
-         * (Highcharts) Background color for the tooltip header when
-         * tooltip.split is enabled.
+         * (Highcharts) The horizontal alignment of the fixed tooltip.
          */
-        backgroundColor?: Highcharts.ColorType;
+        align?: Highcharts.AlignValue;
         /**
-         * (Highcharts) Border color for the tooltip header when tooltip.split
-         * is enabled.
+         * (Highcharts) What the fixed tooltip alignment should be relative to.
+         *
+         * The default, `pane`, means that it is aligned within the plot area
+         * for that given series. If the tooltip is split (as default in Stock
+         * charts), each partial tooltip is aligned within the series' pane.
          */
-        borderColor?: Highcharts.ColorType;
+        relativeTo?: Highcharts.OptionsRelativeToValue;
         /**
-         * (Highcharts) The width of the border for the tooltip header when
-         * tooltip.split is enabled.
+         * (Highcharts) The vertical alignment of the fixed tooltip.
          */
-        borderWidth?: number;
+        verticalAlign?: Highcharts.VerticalAlignValue;
         /**
-         * (Highcharts) Distance between the plot area and the header (except
-         * the chevron) in a split tooltip, in pixels. The default value makes
-         * the header text align with the axis labels.
+         * (Highcharts) X pixel offset from the given position. Can be used to
+         * shy away from axis lines, grid lines etc to avoid the tooltip
+         * overlapping other elements.
          */
-        distance?: number;
-        /**
-         * (Highcharts) The name of a symbol to use for the border around the
-         * tooltip header. Applies only when tooltip.split is enabled.
-         *
-         * Custom callbacks for symbol path generation can also be added to
-         * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
-         * series.marker.symbol.
-         */
-        shape?: string;
+        x?: number;
         /**
-         * (Highcharts) CSS styles for the tooltip header. The default is `{
-         * fontSize: '1em' }`, ensuring that the header text is the same size as
-         * the axis labels.
+         * (Highcharts) Y pixel offset from the given position. Can be used to
+         * shy away from axis lines, grid lines etc to avoid the tooltip
+         * overlapping other elements.
          */
-        style?: object;
+        y?: number;
     }
     /**
-     * (Highcharts) A `dependencywheel` series. If the type option is not
-     * specified, it is inherited from chart.type.
-     *
-     * Configuration options for the series are given in three levels:
-     *
-     * 1. Options for all series in a chart are defined in the
-     * plotOptions.series object.
-     *
-     * 2. Options for all `dependencywheel` series are defined in
-     * plotOptions.dependencywheel.
-     *
-     * 3. Options for one single series are given in the series instance array.
-     * (see online documentation for example)
+     * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
+     * animation when a series is displayed for the `dataLabels`. The animation
+     * can also be set as a configuration object. Please note that this option
+     * only applies to the initial animation.
      *
-     * **TypeScript:**
-     *
-     * - type option should always be set, otherwise a broad set of unsupported
-     * options is allowed.
-     *
-     * - when accessing an array of series, the combined set of all series types
-     * is represented by Highcharts.SeriesOptionsType . Narrowing down to the
-     * specific type can be done by checking the `type` property. (see online
-     * documentation for example)
-     *
-     * You have to extend the `SeriesDependencywheelOptions` via an interface to
-     * allow custom properties: ``` declare interface
-     * SeriesDependencywheelOptions { customProperty: string; }
+     * For other animations, see chart.animation and the animation parameter
+     * under the API methods. The following properties are supported:
      *
+     * - `defer`: The animation delay time in milliseconds.
      */
-    interface SeriesDependencywheelOptions extends Highcharts.PlotDependencywheelOptions, Highcharts.SeriesOptions {
-        /**
-         * (Highcharts) An array of data points for the series. For the
-         * `dependencywheel` 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, this option
-         * is not available. (see online documentation for example) When you
-         * provide the data as tuples, the keys option has to be set as well.
-         * (see online documentation for example)
-         */
-        data?: Array<([string, string, number]|Highcharts.SeriesSankeyPointOptionsObject)>;
-        /**
-         * (Highcharts) A collection of options for the individual nodes. The
-         * nodes in a dependency diagram are auto-generated instances of
-         * `Highcharts.Point`, but options can be applied here and linked by the
-         * `id`.
-         */
-        nodes?: Array<Highcharts.SeriesSankeyNodesOptionsObject>;
+    interface SeriesDependencywheelNodesDataLabelsAnimationOptions {
         /**
-         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
-         * TypeScript non-optional and might be `undefined` in series objects
-         * from unknown sources.
+         * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
+         * milliseconds. Set to `0` to render the data labels immediately. As
+         * `undefined` inherits defer time from the series.animation.defer.
          */
-        type: "dependencywheel";
+        defer?: number;
     }
 }