highcharts 13.0.0 → 13.0.1

package/options/areasplinerange.src.d.ts

@@ -6,952 +6,302 @@
 import * as Highcharts from "../highcharts.src";
 declare module "../highcharts.src" {
     /**
-     * (Highcharts, Highstock) 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 PlotAreasplinerangeDataLabelsAnimationOptions {
-        /**
-         * (Highcharts, Highstock) 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, Gantt) Styles for the series label. The color
-     * defaults to the series color, or a contrast color if `onArea`.
-     */
-    interface PlotAreasplinerangeLabelStyleOptions {
-        fontSize?: number;
-        fontWeight?: string;
-    }
-    /**
-     * (Highcharts, Highstock) Animation when hovering over the marker.
-     */
-    interface PlotAreasplinerangeMarkerStatesHoverAnimationOptions {
-        duration?: number;
-    }
-    /**
-     * (Highcharts, Highstock) Options for the _Series on point_ feature. Only
-     * `pie` and `sunburst` series are supported at this moment.
-     */
-    interface PlotAreasplinerangeOnPointOptions {
-        /**
-         * (Highcharts, Highstock) 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.
-         */
-        connectorOptions?: (Highcharts.PlotAreasplinerangeOnPointConnectorOptions|Highcharts.SVGAttributes);
-        /**
-         * (Highcharts, Highstock) 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.
-         */
-        id?: string;
-        /**
-         * (Highcharts, Highstock) Options allowing to set a position and an
-         * offset of the series in the _Series on point_ feature.
-         */
-        position?: (object|Highcharts.PlotAreasplinerangeOnPointPositionOptions);
-    }
-    /**
-     * (Highcharts, Highstock) The area spline range is a cartesian series type
-     * with higher and lower Y values along an X axis. The area inside the range
-     * is colored, and the graph outlining the area is a smoothed spline.
-     *
-     * 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 `areasplinerange` series are defined in
-     * plotOptions.areasplinerange.
-     *
-     * 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, Highstock) Point accessibility options for a series.
      */
-    interface PlotAreasplinerangeOptions {
+    interface PlotAreasplinerangeAccessibilityPointOptions {
         /**
-         * (Highcharts, Highstock) Accessibility options for a series.
-         */
-        accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
-        /**
-         * (Highcharts, Highstock) 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.
-         */
-        allowPointSelect?: boolean;
-        /**
-         * (Highcharts, Highstock) 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.
+         * (Highcharts, Highstock) Date format to use for points on datetime
+         * axes when describing them to screen reader users.
          *
-         * - `duration`: The duration of the animation in milliseconds.
-         * (Defaults to `1000`)
+         * Defaults to the same format as in tooltip.
          *
-         * - `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.
+         * For an overview of the replacement codes, see dateFormat.
          */
-        animation?: (boolean|Highcharts.AnimationOptionsObject);
+        dateFormat?: string;
         /**
-         * (Highcharts, Highstock) For some series, there is a limit that shuts
-         * down animation by default when the total number of points in the
-         * chart is too high. For example, for a column chart and its
-         * derivatives, animation does not run if there is more than 250 points
-         * totally. To disable this cap, set `animationLimit` to `Infinity`.
-         * This option works if animation is fired on individual points, not on
-         * a group of points like e.g. during the initial animation.
+         * (Highcharts, Highstock) 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.
          */
-        animationLimit?: number;
+        dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
         /**
-         * (Highcharts, Highstock) 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, Highstock) Whether or not to describe points with the
+         * value `null` to assistive technology, such as screen readers.
          */
-        className?: string;
+        describeNull?: boolean;
         /**
-         * (Highcharts, Highstock) Disable this option to allow series rendering
-         * in the whole plotting area.
+         * (Highcharts, Highstock) A format string to use instead of the default
+         * for point descriptions.
          *
-         * **Note:** Clipping should be always enabled when chart.zoomType is
-         * set
-         */
-        clip?: boolean;
-        /**
-         * (Highcharts, Highstock) 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.
+         * The context of the format string is the point instance.
          *
-         * 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, Highstock, Highmaps) When using dual or multiple color
-         * axes, this number defines which colorAxis the particular series is
-         * connected to. It refers to either the axis id or the index of the
-         * axis in the colorAxis array, with 0 being the first. Set this option
-         * to false to prevent a series from connecting to the default color
-         * axis.
-         *
-         * Since v7.2.0 the option can also be an axis id or an axis index
-         * instead of a boolean flag.
-         */
-        colorAxis?: (boolean|number|string);
-        /**
-         * (Highcharts, Highstock) 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, Highmaps) Determines what data value should
-         * be used to calculate point color if `colorAxis` is used. Requires to
-         * set `min` and `max` if some custom point property is used or if
-         * approximation for data grouping is set to `'sum'`.
+         * As opposed to accessibility.point.valueDescriptionFormat, this option
+         * replaces the whole description.
          */
-        colorKey?: string;
+        descriptionFormat?: string;
         /**
-         * (Highstock) Compare the values of the series against the first
-         * non-null, non- zero value in the visible range. The y axis will show
-         * percentage or absolute change depending on whether `compare` is set
-         * to `"percent"` or `"value"`. When this is applied to multiple series,
-         * it allows comparing the development of the series against each other.
-         * Adds a `change` field to every point object. If a `compare` value is
-         * not set on a linked series, it will be inherited from the parent
-         * series.
-         */
-        compare?: Highcharts.OptionsCompareValue;
-        /**
-         * (Highstock) When compare is `percent`, this option dictates whether
-         * to use 0 or 100 as the base of comparison.
-         */
-        compareBase?: (0|100);
-        /**
-         * (Highstock) Defines if comparison should start from the first point
-         * within the visible range or should start from the last point
-         * **before** the range.
+         * (Highcharts, Highstock) 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.
          *
-         * In other words, this flag determines if first point within the
-         * visible range will have 0% (`compareStart=true`) or should have been
-         * already calculated according to the previous point
-         * (`compareStart=false`).
+         * Note: Prefer using accessibility.point.valueDescriptionFormat instead
+         * if possible, as default functionality such as describing annotations
+         * will be preserved.
          */
-        compareStart?: boolean;
+        descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
         /**
-         * (Highcharts) Polar charts only. Whether to connect the ends of a line
-         * series plot across the extremes.
+         * (Highcharts, Highstock) Decimals to use for the values in the point
+         * descriptions. Uses tooltip.valueDecimals if not defined.
          */
-        connectEnds?: boolean;
+        valueDecimals?: number;
         /**
-         * (Highcharts, Highstock) Whether to connect a graph line across null
-         * points, or render a gap between the two points on either side of the
-         * null.
+         * (Highcharts, Highstock) Format to use for describing the values of
+         * data points to assistive technology - including screen readers. The
+         * point context is available as `{point}`.
          *
-         * In stacked area chart, if `connectNulls` is set to true, null points
-         * are interpreted as 0.
-         */
-        connectNulls?: boolean;
-        /**
-         * (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.
-         */
-        crisp?: boolean;
-        /**
-         * (Highcharts, Highstock) When the series contains less points than the
-         * crop threshold, all points are drawn, even if the points fall outside
-         * the visible plot area at the current zoom. The advantage of drawing
-         * all points (including markers and columns), is that animation is
-         * performed on updates. On the other hand, when the series contains
-         * more points than the crop threshold, the series data is cropped to
-         * only contain points that fall within the plot area. The advantage of
-         * cropping away invisible points is to increase performance on large
-         * series.
-         */
-        cropThreshold?: number;
-        /**
-         * (Highstock) Cumulative Sum feature replaces points' values with the
-         * following formula: `sum of all previous points' values + current
-         * point's value`. Works only for points in a visible range. Adds the
-         * `cumulativeSum` field to each point object that can be accessed e.g.
-         * in the tooltip.pointFormat.
+         * Other available context variables include `{index}`, `{value}`, and
+         * `{xDescription}`.
          *
-         * With `dataGrouping` enabled, default grouping approximation is set to
-         * `sum`.
+         * 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.
          */
-        cumulative?: boolean;
+        valueDescriptionFormat?: string;
         /**
-         * (Highstock) Defines if cumulation should start from the first point
-         * within the visible range or should start from the last point
-         * **before** the range.
-         *
-         * In other words, this flag determines if first point within the
-         * visible range will start at 0 (`cumulativeStart=true`) or should have
-         * been already calculated according to the previous point
-         * (`cumulativeStart=false`).
+         * (Highcharts, Highstock) Prefix to add to the values in the point
+         * descriptions. Uses tooltip.valuePrefix if not defined.
          */
-        cumulativeStart?: boolean;
+        valuePrefix?: string;
         /**
-         * (Highcharts, Highstock) 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, Highstock) 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, Highstock) Suffix to add to the values in the point
+         * descriptions. Uses tooltip.valueSuffix if not defined.
          */
-        custom?: Highcharts.Dictionary<any>;
-        /**
-         * (Highcharts, Highstock) 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;
-        /**
-         * (Highstock) Data grouping is the concept of sampling the data values
-         * into larger blocks in order to ease readability and increase
-         * performance of the JavaScript charts. Highcharts Stock by default
-         * applies data grouping when the points become closer than a certain
-         * pixel value, determined by the `groupPixelWidth` option.
-         *
-         * If data grouping is applied, the grouping information of grouped
-         * points can be read from the Point.dataGroup. If point options other
-         * than the data itself are set, for example `name` or `color` or custom
-         * properties, the grouping logic doesn't know how to group it. In this
-         * case the options of the first point instance are copied over to the
-         * group point. This can be altered through a custom `approximation`
-         * callback function.
-         */
-        dataGrouping?: Highcharts.DataGroupingOptionsObject;
-        /**
-         * (Highcharts, Highstock) Extended data labels for range series types.
-         * Range series data labels use no `x` and `y` options. Instead, they
-         * have `xLow`, `xHigh`, `yLow` and `yHigh` options to allow the higher
-         * and lower data label sets individually.
-         */
-        dataLabels?: (Highcharts.SeriesAreaRangeDataLabelsOptionsObject|Array<Highcharts.SeriesAreaRangeDataLabelsOptionsObject>);
-        /**
-         * (Highcharts, Highstock) 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)
-         */
-        dataMapping?: Highcharts.DataMappingOptionsObject;
-        /**
-         * (Highcharts, Highstock) Options for series data sorting.
-         */
-        dataSorting?: Highcharts.PlotAreasplinerangeDataSortingOptions;
-        /**
-         * (Highcharts, Highstock) 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
-         */
-        description?: string;
-        /**
-         * (Highcharts, Highstock) The draggable-points module allows points to
-         * be moved around or modified in the chart. In addition to the options
-         * mentioned under the `dragDrop` API structure, the module fires three
-         * events, point.dragStart, point.drag and point.drop.
-         */
-        dragDrop?: Highcharts.SeriesDragDropOptionsObject;
-        /**
-         * (Highcharts, Highstock) 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.
-         */
-        enableMouseTracking?: boolean;
-        /**
-         * (Highcharts, Highstock) 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.
-         */
-        events?: Highcharts.SeriesEventsOptionsObject;
-        /**
-         * (Highcharts, Highstock) Fill color or gradient for the area. When
-         * `undefined`, the series' `color` is used with the series'
-         * `fillOpacity`.
-         *
-         * In styled mode, the fill color can be set with the `.highcharts-area`
-         * class name.
-         */
-        fillColor?: Highcharts.ColorType;
-        /**
-         * (Highcharts, Highstock) Fill opacity for the area. When you set an
-         * explicit `fillColor`, the `fillOpacity` is not applied. Instead, you
-         * should define the opacity in the `fillColor` with an rgba color
-         * definition. The `fillOpacity` setting, also the default setting,
-         * overrides the alpha component of the `color` setting.
-         *
-         * In styled mode, the fill opacity can be set with the
-         * `.highcharts-area` class name.
-         */
-        fillOpacity?: number;
-        /**
-         * (Highcharts, Highstock) Determines whether the series should look for
-         * the nearest point in both dimensions or just the x-dimension when
-         * hovering the series. Defaults to `'xy'` for scatter series and `'x'`
-         * for most other series. If the data has duplicate x-values, it is
-         * recommended to set this to `'xy'` to allow hovering over all points.
-         *
-         * Applies only to series types using nearest neighbor search (not
-         * direct hover) for tooltip.
-         */
-        findNearestPointBy?: Highcharts.OptionsFindNearestPointByValue;
-        /**
-         * (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.
-         */
-        gapSize?: number;
-        /**
-         * (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.
-         */
-        gapUnit?: Highcharts.OptionsGapUnitValue;
-        /**
-         * (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.
-         */
-        getExtremesFromAll?: boolean;
-        /**
-         * (Highcharts, Highstock) 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, Highstock) 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, Highstock) 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.
-         */
-        keys?: Array<string>;
-        /**
-         * (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`.
-         */
-        label?: Highcharts.SeriesLabelOptionsObject;
-        /**
-         * (Highstock) The line marks the last price from all points.
-         */
-        lastPrice?: Highcharts.SeriesLastPriceOptionsObject;
-        /**
-         * (Highstock) The line marks the last price from visible range of
-         * points.
-         */
-        lastVisiblePrice?: Highcharts.SeriesLastVisiblePriceOptionsObject;
-        /**
-         * (Highcharts, Highstock) What type of legend symbol to render for this
-         * series. Can be one of `areaMarker`, `lineMarker` or `rectangle`.
-         */
-        legendSymbol?: Highcharts.OptionsLegendSymbolValue;
-        /**
-         * (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.
-         */
-        legendSymbolColor?: Highcharts.ColorType;
-        /**
-         * (Highcharts, Highstock) The line cap used for line ends and line
-         * joins on the graph.
-         */
-        linecap?: Highcharts.SeriesLinecapValue;
-        /**
-         * (Highcharts, Highstock) A separate color for the graph line. By
-         * default the line takes the `color` of the series, but the lineColor
-         * setting allows setting a separate color for the line without altering
-         * the `fillColor`.
-         *
-         * In styled mode, the line stroke can be set with the
-         * `.highcharts-graph` class name.
-         */
-        lineColor?: Highcharts.ColorType;
-        /**
-         * (Highcharts, Highstock) Pixel width of the graph line.
-         */
-        lineWidth?: number;
-        /**
-         * (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, Highstock) Options for the lower markers of the
-         * arearange-like series. When `lowMarker` is not defined, options
-         * inherit from the marker.
-         */
-        lowMarker?: Highcharts.PointMarkerOptionsObject;
-        /**
-         * (Highcharts, Highstock) Options for the point markers of line and
-         * scatter-like series. Properties like `fillColor`, `lineColor` and
-         * `lineWidth` define the visual appearance of the markers. The `symbol`
-         * option defines the shape. Other series types, like column series,
-         * don't have markers, but have visual options on the series level
-         * instead.
-         *
-         * In styled mode, the markers can be styled with the
-         * `.highcharts-point`, `.highcharts-point-hover` and
-         * `.highcharts-point-select` class names.
-         */
-        marker?: Highcharts.PointMarkerOptionsObject;
-        /**
-         * (Highstock) Options for the corresponding navigator series if
-         * `showInNavigator` is `true` for this series. Available options are
-         * the same as any series, documented at plotOptions and series.
-         *
-         * These options are merged with options in navigator.series, and will
-         * take precedence if the same option is defined both places.
-         */
-        navigatorOptions?: Highcharts.PlotSeriesOptions;
-        /**
-         * (Highcharts, Highstock) The color for the parts of the graph or
-         * points that are below the threshold. Note that `zones` takes
-         * precedence over the negative color. Using `negativeColor` is
-         * equivalent to applying a zone with value of 0.
-         */
-        negativeColor?: Highcharts.ColorType;
-        /**
-         * (Highcharts) A separate color for the negative part of the area. Note
-         * that `zones` takes precedence over the negative fill color.
-         *
-         * In styled mode, a negative color is set with the
-         * `.highcharts-negative` class name.
-         */
-        negativeFillColor?: Highcharts.ColorType;
-        /**
-         * (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, Highstock) Options for the _Series on point_ feature.
-         * Only `pie` and `sunburst` series are supported at this moment.
-         */
-        onPoint?: (object|Highcharts.PlotAreasplinerangeOnPointOptions);
-        /**
-         * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g.
-         * area) and dataLabels.
-         */
-        opacity?: number;
-        /**
-         * (Highcharts, Highstock) Properties for each single point.
-         */
-        point?: Highcharts.PlotSeriesPointOptions;
-        /**
-         * (Highcharts, Highstock) 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, Highstock) 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, 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.
-         */
-        pointInterval?: number;
-        /**
-         * (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.
-         */
-        pointIntervalUnit?: Highcharts.OptionsPointIntervalUnitValue;
-        /**
-         * (Highcharts, Highstock, Gantt) Possible values: `"on"`, `"between"`,
-         * `number`.
-         *
-         * In a column chart, when pointPlacement is `"on"`, the point will not
-         * create any padding of the X axis. In a polar column chart this means
-         * that the first column points directly north. If the pointPlacement is
-         * `"between"`, the columns will be laid out between ticks. This is
-         * useful for example for visualizing an amount between two points in
-         * time or in a certain sector of a polar chart.
-         *
-         * Since Highcharts 3.0.2, the point placement can also be numeric,
-         * where 0 is on the axis value, -0.5 is between this value and the
-         * previous, and 0.5 is between this value and the next. Unlike the
-         * textual options, numeric point placement options won't affect axis
-         * padding.
-         *
-         * Note that pointPlacement needs a pointRange to work. For column
-         * series this is computed, but for line-type series it needs to be set.
-         *
-         * For the `xrange` series type and gantt charts, if the Y axis is a
-         * category axis, the `pointPlacement` applies to the Y axis rather than
-         * the (typically datetime) X axis.
-         *
-         * Defaults to `undefined` in cartesian charts, `"between"` in polar
-         * charts.
-         */
-        pointPlacement?: (number|string);
-        /**
-         * (Highstock) The width of each point on the x axis. For example in a
-         * column chart with one value each day, the pointRange would be 1 day
-         * (= 24 * 3600
-         *
-         * * 1000 milliseconds). This is normally computed automatically, but
-         * this option can be used to override the automatic value.
-         */
-        pointRange?: number;
-        /**
-         * (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.
-         */
-        pointStart?: (number|string);
-        /**
-         * (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;
+        valueSuffix?: string;
+    }
+    /**
+     * (Highcharts, Highstock) Options for series data sorting.
+     */
+    interface PlotAreasplinerangeDataSortingOptions {
         /**
-         * (Highcharts, Highstock) 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, Highstock) Enable or disable data sorting for the
+         * series. Use xAxis.reversed to change the sorting order.
          */
-        selected?: boolean;
+        enabled?: boolean;
         /**
-         * (Highcharts) Whether to apply a drop shadow to the graph line. Since
-         * 2.3 the shadow can be an object configuration containing `color`,
-         * `offsetX`, `offsetY`, `opacity` and `width`.
+         * (Highcharts, Highstock) Whether to allow matching points by name in
+         * an update. If this option is disabled, points will be matched by
+         * order.
          */
-        shadow?: (boolean|Highcharts.ShadowOptionsObject);
+        matchByName?: boolean;
         /**
-         * (Highcharts, Highstock) 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, Highstock) Determines what data value should be used to
+         * sort by.
          */
-        showCheckbox?: boolean;
+        sortKey?: string;
+    }
+    /**
+     * (Highcharts, Highstock) Animation when hovering over the marker.
+     */
+    interface PlotAreasplinerangeLowMarkerStatesHoverAnimationOptions {
+        duration?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Animation when hovering over the marker.
+     */
+    interface PlotAreasplinerangeMarkerStatesHoverAnimationOptions {
+        duration?: number;
+    }
+    /**
+     * (Highcharts, Highstock) 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 PlotAreasplinerangeOnPointConnectorOptions {
         /**
-         * (Highcharts, Highstock) 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`.
+         * (Highcharts, Highstock) A name for the dash style to use for the
+         * connector.
          */
-        showInLegend?: boolean;
+        dashstyle?: string;
         /**
-         * (Highstock) Whether or not to show the series in the navigator. Takes
-         * precedence over navigator.baseSeries if defined.
+         * (Highcharts, Highstock) Color of the connector line. By default it's
+         * the series' color.
          */
-        showInNavigator?: boolean;
+        stroke?: string;
         /**
-         * (Highcharts, Highstock) 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, Highstock) Pixel width of the connector line.
          */
-        skipKeyboardNavigation?: boolean;
+        width?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Options allowing to set a position and an offset
+     * of the series in the _Series on point_ feature.
+     */
+    interface PlotAreasplinerangeOnPointPositionOptions {
         /**
-         * (Highcharts, Highstock) When this is true, the series will not cause
-         * the Y axis to cross the zero plane (or threshold option) unless the
-         * data actually crosses the plane.
-         *
-         * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3
-         * will make the Y axis show negative values according to the
-         * `minPadding` option. If `softThreshold` is `true`, the Y axis starts
-         * at 0.
+         * (Highcharts, Highstock) Series center offset from the original x
+         * position. If defined, the connector line is drawn connecting original
+         * position with new position.
          */
-        softThreshold?: boolean;
+        offsetX?: number;
         /**
-         * (Highcharts, Highstock) Sonification/audio chart options for a
-         * series.
+         * (Highcharts, Highstock) Series center offset from the original y
+         * position. If defined, the connector line is drawn from original
+         * position to a new position.
          */
-        sonification?: Highcharts.SeriesSonificationOptions;
+        offsetY?: number;
         /**
-         * (Highcharts, Highstock) A collection of options for different series
-         * states.
+         * (Highcharts, Highstock) X position of the series center. By default,
+         * the series is displayed on the point that it is connected to.
          */
-        states?: Highcharts.SeriesStatesOptionsObject;
+        x?: number;
         /**
-         * (Highcharts, Highstock) 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, Highstock) Y position of the series center. By default,
+         * the series is displayed on the point that it is connected to.
          */
-        stickyTracking?: boolean;
+        y?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotAreasplinerangeStatesHoverAnimationOptions {
         /**
-         * (Highcharts, Highstock) The Y axis value to serve as the base for the
-         * area, for distinguishing between values above and below a threshold.
-         * The area between the graph and the threshold is filled.
-         *
-         * * If a number is given, the Y axis will scale to the threshold.
-         *
-         * * If `null`, the scaling behaves like a line series with fill between
-         * the graph and the Y axis minimum.
-         *
-         * * If `Infinity` or `-Infinity`, the area between the graph and the
-         * corresponding Y axis extreme is filled (since v6.1.0).
+         * (Highcharts, Highstock) The duration of the hover animation in
+         * milliseconds. By default the hover state animates quickly in, and
+         * slowly back to normal.
          */
-        threshold?: (number|null);
+        duration?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotAreasplinerangeStatesSelectAnimationOptions {
         /**
-         * (Highcharts, Highstock) 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, Highstock) The duration of the hover animation in
+         * milliseconds. By default the hover state animates quickly in, and
+         * slowly back to normal.
          */
-        tooltip?: Highcharts.SeriesTooltipOptionsObject;
+        duration?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Options for the tooltip header when tooltip.split
+     * is enabled. The header is the box containing the X value in a split
+     * tooltip.
+     */
+    interface PlotAreasplinerangeTooltipHeaderOptions {
         /**
-         * (Highcharts, Highstock) Whether the whole area or just the line
-         * should respond to mouseover tooltips and other mouse or touch events.
+         * (Highcharts, Highstock) Background color for the tooltip header when
+         * tooltip.split is enabled.
          */
-        trackByArea?: boolean;
+        backgroundColor?: Highcharts.ColorType;
         /**
-         * (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.
+         * (Highcharts, Highstock) Border color for the tooltip header when
+         * tooltip.split is enabled.
          */
-        turboThreshold?: number;
+        borderColor?: Highcharts.ColorType;
         /**
-         * (Highcharts, Highstock) Set the initial visibility of the series.
+         * (Highcharts, Highstock) The width of the border for the tooltip
+         * header when tooltip.split is enabled.
          */
-        visible?: boolean;
+        borderWidth?: number;
         /**
-         * (Highcharts, Highstock) Defines the Axis on which the zones are
-         * applied.
+         * (Highcharts, Highstock) 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.
          */
-        zoneAxis?: string;
+        distance?: number;
         /**
-         * (Highcharts, Highstock) An array defining zones within a series.
-         * Zones can be applied to the X axis, Y axis or Z axis for bubbles,
-         * according to the `zoneAxis` option. The zone definitions have to be
-         * in ascending order regarding to the value.
+         * (Highcharts, Highstock) The name of a symbol to use for the border
+         * around the tooltip header. Applies only when tooltip.split is
+         * enabled.
          *
-         * In styled mode, the color zones are styled with the
-         * `.highcharts-zone-{n}` class, or custom classed from the `className`
-         * option (view live demo).
+         * Custom callbacks for symbol path generation can also be added to
+         * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
+         * series.marker.symbol.
          */
-        zones?: Array<Highcharts.SeriesZonesOptionsObject>;
+        shape?: string;
         /**
-         * (Highcharts, Highstock) 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, Highstock) CSS styles for the tooltip header. The
+         * default is `{ fontSize: '1em' }`, ensuring that the header text is
+         * the same size as the axis labels.
          */
-        zoomEnabled?: boolean;
+        style?: object;
     }
     /**
-     * (Highcharts, Highstock) Animation when not hovering over the marker.
-     */
-    interface PlotAreasplinerangeStatesInactiveAnimationOptions {
-        duration?: 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.
-     */
-    interface PlotAreasplinerangeTooltipDateTimeLabelFormatsOptions {
-        day?: string;
-        hour?: string;
-        millisecond?: string;
-        minute?: string;
-        month?: string;
-        second?: string;
-        week?: string;
-        year?: string;
-    }
-    /**
-     * (Highcharts, Highstock) Positioning options for fixed tooltip, taking
-     * effect only when tooltip.fixed is `true`.
+     * (Highcharts, Highstock) A `areasplinerange` 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 `areasplinerange` series are defined in
+     * plotOptions.areasplinerange.
+     *
+     * 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)
+     *
+     * You have to extend the `SeriesAreasplinerangeOptions` via an interface to
+     * allow custom properties: ``` declare interface
+     * SeriesAreasplinerangeOptions { customProperty: string; }
+     *
      */
-    interface PlotAreasplinerangeTooltipPositionOptions {
-        /**
-         * (Highcharts, Highstock) The horizontal alignment of the fixed
-         * tooltip.
-         */
-        align?: Highcharts.AlignValue;
-        /**
-         * (Highcharts, Highstock) What the fixed tooltip alignment should be
-         * relative to.
+    interface SeriesAreasplinerangeOptions extends Highcharts.PlotAreasplinerangeOptions, Highcharts.SeriesOptions {
+        /**
+         * (Highcharts, Highstock) An array of data points for the series. For
+         * the `areasplinerange` series type, points can be given in the
+         * following ways:
+         *
+         * 1. An array of arrays with 3 or 2 values. In this case, the values
+         * correspond to `x,low,high`. If the first value is a string, it is
+         * applied as the name of the point, and the `x` value is inferred. The
+         * `x` value can also be omitted, in which case the inner arrays should
+         * be of length 2\. Then the `x` value is automatically calculated,
+         * either starting at 0 and incremented by 1, or from `pointStart` and
+         * `pointInterval` given in the series options. (see online
+         * documentation for example)
          *
-         * 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.
+         * 2. 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)
          */
-        relativeTo?: Highcharts.OptionsRelativeToValue;
+        data?: Array<([(number|string), number]|[(number|string), number, number]|Highcharts.PointOptionsObject)>;
         /**
-         * (Highcharts, Highstock) The vertical alignment of the fixed tooltip.
+         * Not available
          */
-        verticalAlign?: Highcharts.VerticalAlignValue;
+        dataParser?: undefined;
         /**
-         * (Highcharts, Highstock) 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.
+         * Not available
          */
-        x?: number;
+        dataURL?: undefined;
         /**
-         * (Highcharts, Highstock) 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.
+         * Not available
          */
-        y?: number;
-    }
-    /**
-     * (Highcharts, Highstock) 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 SeriesAreasplinerangeDataDataLabelsAnimationOptions {
+        stack?: undefined;
         /**
-         * (Highcharts, Highstock) 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, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
          */
-        defer?: number;
+        type: "areasplinerange";
     }
 }