highcharts 13.0.0 → 13.0.2

package/options/gauge.d.ts

@@ -6,613 +6,539 @@
 import * as Highcharts from "../highcharts";
 declare module "../highcharts" {
     /**
-     * (Highcharts) 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.
+     * (Highcharts) Point accessibility options for a series.
      */
-    interface PlotGaugeDataLabelsAnimationOptions {
+    interface PlotGaugeAccessibilityPointOptions {
         /**
-         * (Highcharts) 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.
+         * (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.
+         *
+         * For an overview of the replacement codes, see dateFormat.
          */
-        defer?: number;
-    }
-    /**
-     * (Highcharts) Styles for the label. The default `color` setting is
-     * `"contrast"`, which is a pseudo color that Highcharts picks up and
-     * applies the maximum contrast to the underlying point item, for example
-     * the bar in a bar chart.
-     *
-     * The `textOutline` is a pseudo property that applies an outline of the
-     * given width with the given color, which by default is the maximum
-     * contrast to the text. So a bright text color will result in a black text
-     * outline for maximum readability on a mixed background. In some cases,
-     * especially with grayscale text, the text outline doesn't work well, in
-     * which cases it can be disabled by setting it to `"none"`. When `useHTML`
-     * is true, the `textOutline` will not be picked up. In this, case, the same
-     * effect can be achieved through the `text-shadow` CSS property. As a
-     * complementary or alternative to the `textOutline`, a
-     * `dataLabels.backgroundColor` can be used. It provides a more calm
-     * impression and ensures readable text label, at the cost of a risk of
-     * overshadowing the underlying chart elements.
-     *
-     * For some series types, where each point has an extent, like for example
-     * tree maps, the data label may overflow the point. There are two
-     * strategies for handling overflow. By default, the text will wrap to
-     * multiple lines. The other strategy is to set `style.textOverflow` to
-     * `ellipsis`, which will keep the text on one line plus it will break
-     * inside long words.
-     */
-    interface PlotGaugeDataLabelsStyleOptions {
-        fontSize?: number;
-    }
-    /**
-     * (Highcharts, Highstock, Gantt) Styles for the series label. The color
-     * defaults to the series color, or a contrast color if `onArea`.
-     */
-    interface PlotGaugeLabelStyleOptions {
-        fontSize?: number;
-        fontWeight?: string;
-    }
-    /**
-     * (Highcharts) Options for the _Series on point_ feature. Only `pie` and
-     * `sunburst` series are supported at this moment.
-     */
-    interface PlotGaugeOnPointOptions {
+        dateFormat?: string;
+        /**
+         * (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.
+         */
+        dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        /**
+         * (Highcharts) Whether or not to describe points with the value `null`
+         * to assistive technology, such as screen readers.
+         */
+        describeNull?: boolean;
         /**
-         * (Highcharts) Options for the connector in the _Series on point_
-         * feature.
+         * (Highcharts) A format string to use instead of the default for point
+         * descriptions.
+         *
+         * The context of the format string is the point instance.
          *
-         * In styled mode, the connector can be styled with the
-         * `.highcharts-connector-seriesonpoint` class name.
+         * As opposed to accessibility.point.valueDescriptionFormat, this option
+         * replaces the whole description.
          */
-        connectorOptions?: (Highcharts.PlotGaugeOnPointConnectorOptions|Highcharts.SVGAttributes);
+        descriptionFormat?: string;
         /**
-         * (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.
+         * (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.
+         *
+         * Note: Prefer using accessibility.point.valueDescriptionFormat instead
+         * if possible, as default functionality such as describing annotations
+         * will be preserved.
+         */
+        descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        /**
+         * (Highcharts) Decimals to use for the values in the point
+         * descriptions. Uses tooltip.valueDecimals if not defined.
+         */
+        valueDecimals?: number;
+        /**
+         * (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}`.
+         *
+         * 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.
          */
-        id?: string;
+        valueDescriptionFormat?: string;
         /**
-         * (Highcharts) Options allowing to set a position and an offset of the
-         * series in the _Series on point_ feature.
+         * (Highcharts) Prefix to add to the values in the point descriptions.
+         * Uses tooltip.valuePrefix if not defined.
          */
-        position?: (object|Highcharts.PlotGaugeOnPointPositionOptions);
+        valuePrefix?: string;
+        /**
+         * (Highcharts) Suffix to add to the values in the point descriptions.
+         * Uses tooltip.valueSuffix if not defined.
+         */
+        valueSuffix?: string;
     }
     /**
-     * (Highcharts) Gauges are circular plots displaying one or more values with
-     * a dial pointing to values along the perimeter.
-     *
-     * 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 `gauge` series are defined in plotOptions.gauge.
-     *
-     * 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)
+     * (Highcharts) Data labels for the gauge. For gauges, the data labels are
+     * enabled by default and shown in the center.
      */
-    interface PlotGaugeOptions {
+    interface PlotGaugeDataLabelsOptions {
         /**
-         * (Highcharts) Accessibility options for a series.
+         * (Highcharts) The alignment of the data label compared to the point.
+         * If `right`, the right side of the label should be touching the point.
+         * For points with an extent, like columns, the alignments also dictates
+         * how to align it inside the box, as given with the inside option. Can
+         * be one of `left`, `center` or `right`.
          */
-        accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
+        align?: (Highcharts.AlignValue|null);
         /**
-         * (Highcharts) Allow this series' points to be selected by clicking on
-         * the graphic (columns, point markers, pie slices, map areas etc).
-         *
-         * The selected points can be handled by point select and unselect
-         * events, or collectively by the getSelectedPoints function.
-         *
-         * And alternative way of selecting points is through dragging.
+         * (Highcharts) Alignment method for data labels. If set to `plotEdges`,
+         * the labels are aligned within the plot area in the direction of the
+         * y-axis. So in a regular column chart, the labels are aligned
+         * vertically according to the `verticalAlign` setting. In a bar chart,
+         * which is inverted, the labels are aligned horizontally according to
+         * the `align` setting. Applies to cartesian series only.
          */
-        allowPointSelect?: boolean;
+        alignTo?: string;
+        /**
+         * (Highcharts) Whether to allow data labels to overlap. To make the
+         * labels less sensitive for overlapping, the dataLabels.padding can be
+         * set to 0.
+         */
+        allowOverlap?: boolean;
         /**
          * (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.
+         * 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.
          *
-         * - `duration`: The duration of the animation in milliseconds.
-         * (Defaults to `1000`)
+         * For other animations, see chart.animation and the animation parameter
+         * under the API methods. The following properties are supported:
          *
-         * - `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`)
-         *
-         * Due to poor performance, animation is disabled in old IE browsers for
-         * several chart types.
+         * - `defer`: The animation delay time in milliseconds.
          */
-        animation?: (boolean|Highcharts.AnimationOptionsObject);
+        animation?: (boolean|Highcharts.PlotGaugeDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
         /**
-         * (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.
+         * (Highcharts) The background color or gradient for the data label. In
+         * addition to regular colors, there are two special setting for this
+         * option:
+         *
+         * - `auto` will set the background color the point's color.
+         *
+         * - `contrast` will set it to a contrast against the text color, with
+         * an opacity allowing to see the underlying content. The contrast is
+         * great enough to ensure readability for the text according to
+         * accessibility standards.
          */
-        className?: string;
+        backgroundColor?: Highcharts.ColorType;
         /**
-         * (Highcharts) Disable this option to allow series rendering in the
-         * whole plotting area.
-         *
-         * **Note:** Clipping should be always enabled when chart.zoomType is
-         * set
+         * (Highcharts) The border color for the data label. Setting it to
+         * `auto` will use the point's color. Defaults to `undefined`.
          */
-        clip?: boolean;
+        borderColor?: Highcharts.ColorType;
         /**
-         * (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.
+         * (Highcharts) The border radius in pixels for the data label.
          */
-        color?: string;
+        borderRadius?: number;
         /**
-         * (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.
+         * (Highcharts) The border width in pixels for the data label.
          */
-        colorIndex?: number;
+        borderWidth?: number;
         /**
-         * (Highcharts, Highstock, Gantt) When true, each point or column edge
-         * is rounded to its nearest pixel in order to render sharp on screen.
-         * In some cases, when there are a lot of densely packed columns, this
-         * leads to visible difference in column widths or distance between
-         * columns. In these cases, setting `crisp` to `false` may look better,
-         * even though each column is rendered blurry.
+         * (Highcharts) A class name for the data label. Particularly in styled
+         * mode, this can be used to give each series' or point's data label
+         * unique styling. In addition to this option, a default color class
+         * name is added so that we can give the labels a contrast text shadow.
          */
-        crisp?: boolean;
+        className?: string;
         /**
-         * (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.
+         * (Highcharts) This options is deprecated. Use style.color instead.
+         *
+         * The text color for the data labels. Defaults to `undefined`. For
+         * certain series types, like column or map, the data labels can be
+         * drawn inside the points. In this case the data label will be drawn
+         * with maximum contrast by default. Additionally, it will be given a
+         * `text-outline` style with the opposite color, to further increase the
+         * contrast. This can be overridden by setting the `text-outline` style
+         * to `none` in the `dataLabels.style` option.
          *
-         * In styled mode, the series cursor can be set with the same classes as
-         * listed under series.color.
+         * @deprecated 10.3.0
          */
-        cursor?: (string|Highcharts.CursorValue);
+        color?: Highcharts.ColorType;
         /**
-         * (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.
+         * (Highcharts) Whether to hide data labels that are outside the plot
+         * area. By default, the data label is moved inside the plot area
+         * according to the overflow option.
          */
-        custom?: Highcharts.Dictionary<any>;
+        crop?: boolean;
         /**
-         * (Highcharts) Data labels for the gauge. For gauges, the data labels
-         * are enabled by default and shown in the center.
+         * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
+         * labels until the initial series animation has finished. Setting to
+         * `false` renders the data label immediately. If set to `true` inherits
+         * the defer time set in plotOptions.series.animation.
          */
-        dataLabels?: (Highcharts.PlotGaugeDataLabelsOptions|Array<Highcharts.PlotGaugeDataLabelsOptions>);
+        defer?: boolean;
         /**
-         * (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)
+         * (Highcharts, Highstock, Gantt) The distance of the data label from
+         * the data point. Note that the `padding` setting also affects the
+         * rendered distance, but is not visible unless the data label has a
+         * border or background.
          */
-        dataMapping?: Highcharts.DataMappingOptionsObject;
+        distance?: number;
         /**
-         * (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
+         * (Highcharts) Enable or disable the data labels.
          */
-        description?: string;
+        enabled?: boolean;
         /**
-         * (Highcharts) Options for the dial or arrow pointer of the gauge.
-         *
-         * In styled mode, the dial is styled with the `.highcharts-gauge-series
-         * .highcharts-dial` rule.
+         * (Highcharts) A declarative filter to control of which data labels to
+         * display. The declarative filter is designed for use when callback
+         * functions are not available, like when the chart options require a
+         * pure JSON structure or for use with graphical editors. For
+         * programmatic control, use the `formatter` instead, and return
+         * `undefined` to disable a single data label. (see online documentation
+         * for example)
          */
-        dial?: Highcharts.PlotGaugeDialOptions;
+        filter?: Highcharts.DataLabelsFilterOptionsObject;
         /**
-         * (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.
+         * (Highcharts) A format string for the data label. Available variables
+         * are the same as for `formatter`.
          */
-        enableMouseTracking?: boolean;
+        format?: string;
         /**
-         * (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.
+         * (Highcharts) Callback JavaScript function to format the data label.
+         * Note that if a `format` is defined, the format takes precedence and
+         * the formatter is ignored.
          */
-        events?: Highcharts.SeriesEventsOptionsObject;
+        formatter?: Highcharts.DataLabelsFormatterCallbackFunction;
         /**
-         * (Highcharts, Highstock) Defines when to display a gap in the graph,
-         * together with the gapUnit option.
-         *
-         * In case when `dataGrouping` is enabled, points can be grouped into a
-         * larger time span. This can make the grouped points to have a greater
-         * distance than the absolute value of `gapSize` property, which will
-         * result in disappearing graph completely. To prevent this situation
-         * the mentioned distance between grouped points is used instead of
-         * previously defined `gapSize`.
-         *
-         * In practice, this option is most often used to visualize gaps in time
-         * series. In a stock chart, intraday data is available for daytime
-         * hours, while gaps will appear in nights and weekends.
+         * (Highcharts) For points with an extent, like columns or map areas,
+         * whether to align the data label inside the box or to the actual value
+         * point. Defaults to `false` in most cases, `true` in stacked columns.
          */
-        gapSize?: number;
+        inside?: boolean;
         /**
-         * (Highcharts, Highstock) Together with gapSize, this option defines
-         * where to draw gaps in the graph.
-         *
-         * When the `gapUnit` is `"relative"` (default), a gap size of 5 means
-         * that if the distance between two points is greater than 5 times that
-         * of the two closest points, the graph will be broken.
-         *
-         * When the `gapUnit` is `"value"`, the gap is based on absolute axis
-         * values, which on a datetime axis is milliseconds. This also applies
-         * to the navigator series that inherits gap options from the base
-         * series.
+         * (Highcharts) The rank for this point's data label in case of
+         * collision. If two data labels are about to overlap, only the one with
+         * the highest `labelrank` will be drawn.
          */
-        gapUnit?: Highcharts.OptionsGapUnitValue;
+        labelrank?: number;
         /**
-         * (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.
+         * (Highcharts) Format for points with the value of null. Works
+         * analogously to format. `nullFormat` can be applied only to series
+         * which support displaying null points. `heatmap` and `tilemap`
+         * supports `nullFormat` by default while the following series requires
+         * [#series.nullInteraction] set to `true`: `line`, `spline`, `area`,
+         * `area-spline`, `column`, `bar`, and `timeline`. Does not work with
+         * series that don't display null points, like `pie`.
          */
-        inactiveOtherPoints?: boolean;
+        nullFormat?: (boolean|string);
         /**
-         * (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`.
+         * (Highcharts) Callback JavaScript function that defines formatting for
+         * points with the value of null. Works analogously to formatter.
+         * `nullFormatter` can be applied only to series which support
+         * displaying null points. `heatmap` and `tilemap` supports
+         * `nullFormatter` by default while the following series requires
+         * (series.nullInteraction)[#series.nullInteraction] set to `true`:
+         * `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
+         * `timeline`. Does not work with series that don't display null points,
+         * like `pie`.
          */
-        includeInDataExport?: boolean;
+        nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction;
         /**
-         * (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.
+         * (Highcharts) How to handle data labels that flow outside the plot
+         * area. The default is `"justify"`, which aligns them inside the plot
+         * area. For columns and bars, this means it will be moved inside the
+         * bar. To display data labels outside the plot area, set `crop` to
+         * `false` and `overflow` to `"allow"`.
          */
-        keys?: Array<string>;
+        overflow?: Highcharts.DataLabelsOverflowValue;
         /**
-         * (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.
+         * (Highcharts) When either the `borderWidth` or the `backgroundColor`
+         * is set, this is the padding within the box.
          *
-         * The series labels currently work with series types having a `graph`
-         * or an `area`.
+         * An array of numbers sets padding for the respective sides. An array
+         * of two numbers repeats the values for the horizontal and vertical
+         * sides.
+         */
+        padding?: number;
+        /**
+         * (Highcharts) Aligns data labels relative to points. If `center`
+         * alignment is not possible, it defaults to `right`.
          */
-        label?: Highcharts.SeriesLabelOptionsObject;
+        position?: Highcharts.AlignValue;
         /**
-         * (Highcharts) What type of legend symbol to render for this series.
-         * Can be one of `areaMarker`, `lineMarker` or `rectangle`.
+         * (Highcharts) Text rotation in degrees. Note that due to a more
+         * complex structure, backgrounds, borders and padding will be lost on a
+         * rotated data label.
          */
-        legendSymbol?: Highcharts.OptionsLegendSymbolValue;
+        rotation?: number;
         /**
-         * (Highcharts, Highstock, Highmaps) Defines the color of the legend
-         * symbol for this series. Defaults to undefined, in which case the
-         * series color is used. Does not work with styled mode.
+         * (Highcharts) The shadow of the box. Works best with `borderWidth` or
+         * `backgroundColor`. Since 2.3 the shadow can be an object
+         * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
+         * `width`.
          */
-        legendSymbolColor?: Highcharts.ColorType;
+        shadow?: (boolean|Highcharts.ShadowOptionsObject);
         /**
-         * (Highcharts) The line cap used for line ends and line joins on the
-         * graph.
+         * (Highcharts) The name of a symbol to use for the border around the
+         * label. Symbols are predefined functions on the Renderer object.
          */
-        linecap?: Highcharts.SeriesLinecapValue;
+        shape?: string;
         /**
-         * (Highcharts, Highstock) Pixel width of the graph line.
+         * (Highcharts) Styles for the label. The default `color` setting is
+         * `"contrast"`, which is a pseudo color that Highcharts picks up and
+         * applies the maximum contrast to the underlying point item, for
+         * example the bar in a bar chart.
+         *
+         * The `textOutline` is a pseudo property that applies an outline of the
+         * given width with the given color, which by default is the maximum
+         * contrast to the text. So a bright text color will result in a black
+         * text outline for maximum readability on a mixed background. In some
+         * cases, especially with grayscale text, the text outline doesn't work
+         * well, in which cases it can be disabled by setting it to `"none"`.
+         * When `useHTML` is true, the `textOutline` will not be picked up. In
+         * this, case, the same effect can be achieved through the `text-shadow`
+         * CSS property. As a complementary or alternative to the `textOutline`,
+         * a `dataLabels.backgroundColor` can be used. It provides a more calm
+         * impression and ensures readable text label, at the cost of a risk of
+         * overshadowing the underlying chart elements.
+         *
+         * For some series types, where each point has an extent, like for
+         * example tree maps, the data label may overflow the point. There are
+         * two strategies for handling overflow. By default, the text will wrap
+         * to multiple lines. The other strategy is to set `style.textOverflow`
+         * to `ellipsis`, which will keep the text on one line plus it will
+         * break inside long words.
          */
-        lineWidth?: number;
+        style?: (Highcharts.CSSObject|Highcharts.PlotGaugeDataLabelsStyleOptions);
         /**
-         * (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.
+         * (Highcharts) Options for a label text which should follow marker's
+         * shape. Border and background are disabled for a label that follows a
+         * path.
          *
-         * 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.
+         * **Note:** Only SVG-based renderer supports this option. Setting
+         * `useHTML` to true will disable this option.
          *
-         * If a `compare` value is not set on a linked series, it will be
-         * inherited from the parent series.
+         * Text path support is not bundled into `highcharts.js`, and requires
+         * the `modules/textpath.js` file. However, it is included in the script
+         * files of those series types that use it by default.
          */
-        linkedTo?: string;
+        textPath?: Highcharts.DataLabelsTextPathOptionsObject;
         /**
-         * (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`.
+         * (Highcharts) Whether to use HTML to render the labels.
          */
-        nullInteraction?: (boolean|undefined);
+        useHTML?: boolean;
         /**
-         * (Highcharts) Options for the _Series on point_ feature. Only `pie`
-         * and `sunburst` series are supported at this moment.
+         * (Highcharts) The vertical alignment of a data label. Can be one of
+         * `top`, `middle` or `bottom`. The default value depends on the data,
+         * for instance in a column chart, the label is above positive values
+         * and below negative values.
          */
-        onPoint?: (object|Highcharts.PlotGaugeOnPointOptions);
+        verticalAlign?: string;
         /**
-         * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
-         * dataLabels.
+         * (Highcharts) The x position offset of the label relative to the point
+         * in pixels.
          */
-        opacity?: number;
+        x?: number;
         /**
-         * (Highcharts) Allow the dial to overshoot the end of the perimeter
-         * axis by this many degrees. Say if the gauge axis goes from 0 to 60, a
-         * value of 100, or 1000, will show 5 degrees beyond the end of the axis
-         * when this option is set to 5.
+         * (Highcharts) The y position offset of the label relative to the point
+         * in pixels.
          */
-        overshoot?: number;
+        y?: number;
         /**
-         * (Highcharts) Options for the pivot or the center point of the gauge.
+         * (Highcharts) The z index of the data labels group. Does not apply
+         * below series level options.
          *
-         * In styled mode, the pivot is styled with the
-         * `.highcharts-gauge-series .highcharts-pivot` rule.
+         * Use a `zIndex` of 6 to display it above the series, or use a `zIndex`
+         * of 2 to display it behind the series.
          */
-        pivot?: Highcharts.PlotGaugePivotOptions;
+        zIndex?: number;
+    }
+    /**
+     * (Highcharts) Options for the dial or arrow pointer of the gauge.
+     *
+     * In styled mode, the dial is styled with the `.highcharts-gauge-series
+     * .highcharts-dial` rule.
+     */
+    interface PlotGaugeDialOptions {
         /**
-         * (Highcharts) Properties for each single point.
+         * (Highcharts) The background or fill color of the gauge's dial.
          */
-        point?: Highcharts.PlotSeriesPointOptions;
+        backgroundColor?: Highcharts.ColorType;
         /**
-         * (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
+         * (Highcharts) The length of the dial's base part, relative to the
+         * total radius or length of the dial. Accepts a pixel value if given as
+         * a number, or a percentage value if given as a percentage string. If
+         * the base length is greater than 0, the dial's base will have an even
+         * width, before it narrows in to the top.
          */
-        pointDescriptionFormat?: Function;
+        baseLength?: (number|string);
         /**
-         * (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
+         * (Highcharts) The width of the base of the gauge dial. The base is the
+         * part closest to the pivot, defined by baseLength. Accepts a pixel
+         * value if given as a number, or a percentage value if given as a
+         * percentage string.
          */
-        pointDescriptionFormatter?: Function;
+        baseWidth?: (number|string);
         /**
-         * (Highcharts, Highstock, Gantt) If no x values are given for the
-         * points in a series, `pointInterval` defines the interval of the x
-         * values. For example, if a series contains one value every decade
-         * starting from year 0, set `pointInterval` to `10`. In true `datetime`
-         * axes, the `pointInterval` is set in milliseconds.
-         *
-         * It can be also be combined with `pointIntervalUnit` to draw irregular
-         * time intervals.
-         *
-         * If combined with `relativeXValue`, an x value can be set on each
-         * point, and the `pointInterval` is added x times to the `pointStart`
-         * setting.
-         *
-         * Please note that this options applies to the _series data_, not the
-         * interval of the axis ticks, which is independent.
+         * (Highcharts) The border color or stroke of the gauge's dial. By
+         * default, the borderWidth is 0, so this must be set in addition to a
+         * custom border color.
          */
-        pointInterval?: number;
+        borderColor?: Highcharts.ColorType;
         /**
-         * (Highcharts, Highstock, Gantt) On datetime series, this allows for
-         * setting the pointInterval to irregular time units, `day`, `month` and
-         * `year`. A day is usually the same as 24 hours, but
-         * `pointIntervalUnit` also takes the DST crossover into consideration
-         * when dealing with local time. Combine this option with
-         * `pointInterval` to draw weeks, quarters, 6 months, 10 years etc.
-         *
-         * Please note that this options applies to the _series data_, not the
-         * interval of the axis ticks, which is independent.
+         * (Highcharts) The border radius of the gauge dial
          */
-        pointIntervalUnit?: Highcharts.OptionsPointIntervalUnitValue;
+        borderRadius?: (number|string);
         /**
-         * (Highcharts, Highstock, Gantt) If no x values are given for the
-         * points in a series, `pointStart` defines on what value to start. For
-         * example, if a series contains one yearly value starting from 1945,
-         * set `pointStart` to 1945.
-         *
-         * The `pointStart` setting can be a number, or a datetime string that
-         * is parsed according to the `time.timezone` setting.
-         *
-         * If combined with `relativeXValue`, an x value can be set on each
-         * point. The x value from the point options is multiplied by
-         * `pointInterval` and added to `pointStart` to produce a modified x
-         * value.
+         * (Highcharts) The width of the gauge dial border in pixels.
          */
-        pointStart?: (number|string);
+        borderWidth?: number;
         /**
-         * (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`.
+         * (Highcharts) An array with an SVG path for the custom dial.
          */
-        relativeXValue?: boolean;
+        path?: Highcharts.SVGPathArray;
         /**
-         * (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.
+         * (Highcharts) The radius or length of the dial, relative to the radius
+         * of the gauge itself. Accepts a pixel value if given as a number, or a
+         * percentage value if given as a percentage string.
          */
-        selected?: boolean;
+        radius?: (number|string);
         /**
-         * (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.
+         * (Highcharts) The length of the dial's rear end, the part that extends
+         * out on the other side of the pivot. Accepts a pixel value if given as
+         * a number, or a percentage value of the dial's length if given as a
+         * percentage string.
          */
-        showCheckbox?: boolean;
+        rearLength?: (number|string);
         /**
-         * (Highcharts) Whether to display this particular series or series type
-         * in the legend. Defaults to false for gauge series.
+         * (Highcharts) The width of the top of the dial, closest to the
+         * perimeter. The pivot narrows in from the base to the top. Accepts a
+         * pixel value if given as a number, or a percentage of the dial radius
+         * if given as a percentage string.
          */
-        showInLegend?: boolean;
+        topWidth?: (number|string);
+    }
+    /**
+     * (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 PlotGaugeOnPointConnectorOptions {
         /**
-         * (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
+         * (Highcharts) A name for the dash style to use for the connector.
          */
-        skipKeyboardNavigation?: boolean;
+        dashstyle?: string;
         /**
-         * (Highcharts) Sonification/audio chart options for a series.
+         * (Highcharts) Color of the connector line. By default it's the series'
+         * color.
          */
-        sonification?: Highcharts.SeriesSonificationOptions;
+        stroke?: string;
         /**
-         * (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.
+         * (Highcharts) Pixel width of the connector line.
          */
-        stickyTracking?: boolean;
-        threshold?: number;
+        width?: number;
+    }
+    /**
+     * (Highcharts) Options allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotGaugeOnPointPositionOptions {
         /**
-         * (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.
+         * (Highcharts) Series center offset from the original x position. If
+         * defined, the connector line is drawn connecting original position
+         * with new position.
          */
-        tooltip?: Highcharts.SeriesTooltipOptionsObject;
+        offsetX?: number;
         /**
-         * (Highcharts) Set the initial visibility of the series.
+         * (Highcharts) Series center offset from the original y position. If
+         * defined, the connector line is drawn from original position to a new
+         * position.
          */
-        visible?: boolean;
+        offsetY?: number;
         /**
-         * (Highcharts) When this option is `true`, the dial will wrap around
-         * the axes. For instance, in a full-range gauge going from 0 to 360, a
-         * value of 400 will point to 40. When `wrap` is `false`, the dial stops
-         * at 360.
-         *
-         * Defaults to `undefined`, which is equivalent to `true` when the axis
-         * ranges over 360 degrees, and `false` when less.
+         * (Highcharts) X position of the series center. By default, the series
+         * is displayed on the point that it is connected to.
          */
-        wrap?: boolean;
+        x?: number;
         /**
-         * (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.
+         * (Highcharts) Y position of the series center. By default, the series
+         * is displayed on the point that it is connected to.
          */
-        zoomEnabled?: boolean;
+        y?: number;
     }
     /**
-     * (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.
+     * (Highcharts) Options for the pivot or the center point of the gauge.
+     *
+     * In styled mode, the pivot is styled with the `.highcharts-gauge-series
+     * .highcharts-pivot` rule.
      */
-    interface PlotGaugeTooltipDateTimeLabelFormatsOptions {
-        day?: string;
-        hour?: string;
-        millisecond?: string;
-        minute?: string;
-        month?: string;
-        second?: string;
-        week?: string;
-        year?: string;
+    interface PlotGaugePivotOptions {
+        /**
+         * (Highcharts) The background color or fill of the pivot.
+         */
+        backgroundColor?: Highcharts.ColorType;
+        /**
+         * (Highcharts) The border or stroke color of the pivot.
+         */
+        borderColor?: Highcharts.ColorType;
+        /**
+         * (Highcharts) The border or stroke width of the pivot.
+         */
+        borderWidth?: number;
+        /**
+         * (Highcharts) The radius of the pivot, the center point of the gauge.
+         * Accepts a pixel value if given as a number, or a percentage of the
+         * full gauge radius if given as a percentage string.
+         */
+        radius?: (number|string);
     }
     /**
-     * (Highcharts) Positioning options for fixed tooltip, taking effect only
-     * when tooltip.fixed is `true`.
+     * (Highcharts) Options for the tooltip header when tooltip.split is
+     * enabled. The header is the box containing the X value in a split tooltip.
      */
-    interface PlotGaugeTooltipPositionOptions {
+    interface PlotGaugeTooltipHeaderOptions {
         /**
-         * (Highcharts) The horizontal alignment of the fixed tooltip.
+         * (Highcharts) Background color for the tooltip header when
+         * tooltip.split is enabled.
          */
-        align?: Highcharts.AlignValue;
+        backgroundColor?: Highcharts.ColorType;
         /**
-         * (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.
+         * (Highcharts) Border color for the tooltip header when tooltip.split
+         * is enabled.
          */
-        relativeTo?: Highcharts.OptionsRelativeToValue;
+        borderColor?: Highcharts.ColorType;
         /**
-         * (Highcharts) The vertical alignment of the fixed tooltip.
+         * (Highcharts) The width of the border for the tooltip header when
+         * tooltip.split is enabled.
          */
-        verticalAlign?: Highcharts.VerticalAlignValue;
+        borderWidth?: number;
         /**
-         * (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.
+         * (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.
          */
-        x?: number;
+        distance?: number;
         /**
-         * (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.
+         * (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.
          */
-        y?: number;
+        shape?: string;
+        /**
+         * (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.
+         */
+        style?: object;
     }
     /**
      * (Highcharts, Highstock, Gantt) Enable or disable the initial animation