highcharts 13.0.0 → 13.0.2

package/options/tilemap.d.ts

@@ -6,558 +6,435 @@
 import * as Highcharts from "../highcharts";
 declare module "../highcharts" {
     /**
-     * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
-     * animation when a series is displayed for the `dataLabels`. The animation
-     * can also be set as a configuration object. Please note that this option
-     * only applies to the initial animation.
-     *
-     * For other animations, see chart.animation and the animation parameter
-     * under the API methods. The following properties are supported:
-     *
-     * - `defer`: The animation delay time in milliseconds.
+     * (Highcharts, Highmaps) Point accessibility options for a series.
      */
-    interface PlotTilemapDataLabelsAnimationOptions {
+    interface PlotTilemapAccessibilityPointOptions {
         /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
-         * milliseconds. Set to `0` to render the data labels immediately. As
-         * `undefined` inherits defer time from the series.animation.defer.
-         */
-        defer?: number;
-    }
-    /**
-     * (Highcharts, Highstock, Gantt) Styles for the series label. The color
-     * defaults to the series color, or a contrast color if `onArea`.
-     */
-    interface PlotTilemapLabelStyleOptions {
-        fontSize?: number;
-        fontWeight?: string;
-    }
-    /**
-     * (Highcharts, Highmaps) Options for the _Series on point_ feature. Only
-     * `pie` and `sunburst` series are supported at this moment.
-     */
-    interface PlotTilemapOnPointOptions {
-        /**
-         * (Highcharts, Highmaps) Options for the connector in the _Series on
-         * point_ feature.
+         * (Highcharts, Highmaps) Date format to use for points on datetime axes
+         * when describing them to screen reader users.
          *
-         * In styled mode, the connector can be styled with the
-         * `.highcharts-connector-seriesonpoint` class name.
-         */
-        connectorOptions?: (Highcharts.PlotTilemapOnPointConnectorOptions|Highcharts.SVGAttributes);
-        /**
-         * (Highcharts, Highmaps) 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.
+         * Defaults to the same format as in tooltip.
+         *
+         * For an overview of the replacement codes, see dateFormat.
          */
-        id?: string;
+        dateFormat?: string;
         /**
-         * (Highcharts, Highmaps) Options allowing to set a position and an
-         * offset of the series in the _Series on point_ feature.
+         * (Highcharts, Highmaps) 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.
          */
-        position?: (object|Highcharts.PlotTilemapOnPointPositionOptions);
-    }
-    /**
-     * (Highcharts, Highmaps) A tilemap series is a type of heatmap where the
-     * tile shapes are configurable.
-     *
-     * 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 `tilemap` series are defined in plotOptions.tilemap.
-     *
-     * 3. Options for one single series are given in the series instance array.
-     * (see online documentation for example)
-     *
-     * **TypeScript:**
-     *
-     * - type option should always be set, otherwise a broad set of unsupported
-     * options is allowed.
-     *
-     * - when accessing an array of series, the combined set of all series types
-     * is represented by Highcharts.SeriesOptionsType . Narrowing down to the
-     * specific type can be done by checking the `type` property. (see online
-     * documentation for example)
-     */
-    interface PlotTilemapOptions {
+        dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
         /**
-         * (Highcharts, Highmaps) Accessibility options for a series.
+         * (Highcharts, Highmaps) Whether or not to describe points with the
+         * value `null` to assistive technology, such as screen readers.
          */
-        accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
+        describeNull?: boolean;
         /**
-         * (Highcharts, Highmaps) Allow this series' points to be selected by
-         * clicking on the graphic (columns, point markers, pie slices, map
-         * areas etc).
+         * (Highcharts, Highmaps) A format string to use instead of the default
+         * for point descriptions.
          *
-         * The selected points can be handled by point select and unselect
-         * events, or collectively by the getSelectedPoints function.
+         * The context of the format string is the point instance.
          *
-         * And alternative way of selecting points is through dragging.
-         */
-        allowPointSelect?: boolean;
-        /**
-         * (Highcharts, Highmaps) Animation is disabled by default on the
-         * heatmap series.
-         */
-        animation?: boolean;
-        /**
-         * (Highmaps) The border color of the map areas.
-         *
-         * In styled mode, the border stroke is given in the `.highcharts-point`
-         * class.
-         */
-        borderColor?: Highcharts.ColorType;
-        /**
-         * (Highcharts, Highmaps) The border radius for each heatmap item. The
-         * border's color and width can be set in marker options.
-         */
-        borderRadius?: number;
-        /**
-         * (Highmaps) The border width for each heatmap item.
-         */
-        borderWidth?: number;
-        /**
-         * (Highcharts, Highmaps) 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.
+         * As opposed to accessibility.point.valueDescriptionFormat, this option
+         * replaces the whole description.
          */
-        className?: string;
+        descriptionFormat?: string;
         /**
-         * (Highcharts, Highmaps) Disable this option to allow series rendering
-         * in the whole plotting area.
+         * (Highcharts, Highmaps) 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:** Clipping should be always enabled when chart.zoomType is
-         * set
+         * Note: Prefer using accessibility.point.valueDescriptionFormat instead
+         * if possible, as default functionality such as describing annotations
+         * will be preserved.
          */
-        clip?: boolean;
+        descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
         /**
-         * (Highcharts) The main color of the series. In heat maps this color is
-         * rarely used, as we mostly use the color to denote the value of each
-         * point. Unless options are set in the colorAxis, the default value is
-         * pulled from the options.colors array.
+         * (Highcharts, Highmaps) Decimals to use for the values in the point
+         * descriptions. Uses tooltip.valueDecimals if not defined.
          */
-        color?: Highcharts.ColorType;
+        valueDecimals?: number;
         /**
-         * (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.
+         * (Highcharts, Highmaps) Format to use for describing the values of
+         * data points to assistive technology - including screen readers. The
+         * point context is available as `{point}`.
          *
-         * 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, Highmaps) Styled mode only. A specific color index to
-         * use for the series, so its graphic representations are given the
-         * class name `highcharts-color-{n}`.
+         * Other available context variables include `{index}`, `{value}`, and
+         * `{xDescription}`.
          *
-         * Since v11, CSS variables on the form `--highcharts-color-{n}` make
-         * changing the color scheme very convenient.
+         * 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.
          */
-        colorIndex?: number;
+        valueDescriptionFormat?: string;
         /**
-         * (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'`.
+         * (Highcharts, Highmaps) Prefix to add to the values in the point
+         * descriptions. Uses tooltip.valuePrefix if not defined.
          */
-        colorKey?: string;
+        valuePrefix?: string;
         /**
-         * (Highcharts, Highmaps) The column size - how many X axis units each
-         * column in the tilemap should span. Works as in Heatmaps.
+         * (Highcharts, Highmaps) Suffix to add to the values in the point
+         * descriptions. Uses tooltip.valueSuffix if not defined.
          */
-        colsize?: number;
+        valueSuffix?: string;
+    }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
+     * labels, appearing next to each data point.
+     *
+     * Since v6.2.0, multiple data labels can be applied to each single point by
+     * defining them as an array of configs.
+     *
+     * In styled mode, the data labels can be styled with the
+     * `.highcharts-data-label-box` and `.highcharts-data-label` class names
+     * (see example).
+     */
+    interface PlotTilemapDataLabelsOptions {
         /**
-         * (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, Highstock, Highmaps, Gantt) 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`.
          */
-        crisp?: boolean;
+        align?: (Highcharts.AlignValue|null);
         /**
-         * (Highcharts, Highmaps) 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.
+         * (Highcharts, Highstock, Highmaps, Gantt) 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.
          */
-        cursor?: (string|Highcharts.CursorValue);
+        alignTo?: string;
         /**
-         * (Highcharts, Highmaps) 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, Highmaps, Gantt) Whether to allow data labels
+         * to overlap. To make the labels less sensitive for overlapping, the
+         * dataLabels.padding can be set to 0.
          */
-        custom?: Highcharts.Dictionary<any>;
+        allowOverlap?: boolean;
         /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
-         * labels, appearing next to each data point.
-         *
-         * Since v6.2.0, multiple data labels can be applied to each single
-         * point by defining them as an array of configs.
-         *
-         * In styled mode, the data labels can be styled with the
-         * `.highcharts-data-label-box` and `.highcharts-data-label` class names
-         * (see example).
-         */
-        dataLabels?: (Highcharts.PlotTilemapDataLabelsOptions|Array<Highcharts.PlotTilemapDataLabelsOptions>);
-        /**
-         * (Highcharts, Highmaps) 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.
+         * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the
+         * initial animation when a series is displayed for the `dataLabels`.
+         * The animation can also be set as a configuration object. Please note
+         * that this option only applies to the initial animation.
          *
-         * 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.
+         * For other animations, see chart.animation and the animation parameter
+         * under the API methods. The following properties are supported:
          *
-         * 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)
+         * - `defer`: The animation delay time in milliseconds.
          */
-        dataMapping?: Highcharts.DataMappingOptionsObject;
+        animation?: (boolean|Highcharts.PlotTilemapDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
         /**
-         * (Highcharts, Highmaps) Deprecated. Use
-         * plotOptions.series.accessibility.description instead.
+         * (Highcharts, Highstock, Highmaps, Gantt) The background color or
+         * gradient for the data label. In addition to regular colors, there are
+         * two special setting for this option:
          *
-         * A description of the series to add to the screen reader information
-         * about the series.
+         * - `auto` will set the background color the point's color.
          *
-         * @deprecated 8.0.0
+         * - `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.
          */
-        description?: string;
+        backgroundColor?: Highcharts.ColorType;
         /**
-         * (Highcharts, Highmaps) 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, Highstock, Highmaps, Gantt) The border color for the
+         * data label. Setting it to `auto` will use the point's color. Defaults
+         * to `undefined`.
          */
-        enableMouseTracking?: boolean;
+        borderColor?: Highcharts.ColorType;
         /**
-         * (Highcharts, Highmaps) 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, Highstock, Highmaps, Gantt) The border radius in pixels
+         * for the data label.
          */
-        events?: Highcharts.SeriesEventsOptionsObject;
+        borderRadius?: number;
         /**
-         * (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, Highstock, Highmaps, Gantt) The border width in pixels
+         * for the data label.
          */
-        gapSize?: number;
+        borderWidth?: 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.
+         * (Highcharts, Highstock, Highmaps, Gantt) 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.
          */
-        gapUnit?: Highcharts.OptionsGapUnitValue;
+        className?: string;
         /**
-         * (Highcharts, Highmaps) Highlight only the hovered point and fade the
-         * remaining points.
+         * (Highcharts, Highstock, Highmaps, Gantt) This options is deprecated.
+         * Use style.color instead.
          *
-         * 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, Highmaps) When set to `false` will prevent the series
-         * data from being included in any form of data export.
+         * 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.
          *
-         * Since version 6.0.0 until 7.1.0 the option was existing undocumented
-         * as `includeInCSVExport`.
+         * @deprecated 10.3.0
          */
-        includeInDataExport?: boolean;
+        color?: Highcharts.ColorType;
         /**
-         * (Highcharts, Highmaps) Make the heatmap render its data points as an
-         * interpolated image.
+         * (Highcharts, Highstock, Highmaps, Gantt) 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.
          */
-        interpolation?: boolean;
+        crop?: boolean;
         /**
-         * (Highcharts, Highmaps) 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, 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.
          */
-        keys?: Array<string>;
+        defer?: boolean;
         /**
-         * (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`.
+         * (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.
          */
-        label?: Highcharts.SeriesLabelOptionsObject;
+        distance?: number;
         /**
-         * (Highcharts, Highmaps) What type of legend symbol to render for this
-         * series. Can be one of `areaMarker`, `lineMarker` or `rectangle`.
+         * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
+         * labels.
          */
-        legendSymbol?: Highcharts.OptionsLegendSymbolValue;
+        enabled?: boolean;
         /**
-         * (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.
+         * (Highcharts, Highstock, Highmaps, Gantt) 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)
          */
-        linkedTo?: string;
-        marker?: any;
+        filter?: Highcharts.DataLabelsFilterOptionsObject;
         /**
-         * (Highcharts, Highmaps) 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.
+         * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
+         * label. Available variables are the same as for `formatter`.
          */
-        negativeColor?: Highcharts.ColorType;
+        format?: string;
         /**
-         * (Highcharts, Highmaps) The color applied to null points. In styled
-         * mode, a general CSS class is applied instead.
+         * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
+         * to format the data label. Note that if a `format` is defined, the
+         * format takes precedence and the formatter is ignored.
          */
-        nullColor?: Highcharts.ColorType;
+        formatter?: Highcharts.DataLabelsFormatterCallbackFunction;
         /**
-         * (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, Highstock, Highmaps, Gantt) 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.
          */
-        nullInteraction?: (boolean|undefined);
+        inside?: boolean;
         /**
-         * (Highcharts, Highmaps) Options for the _Series on point_ feature.
-         * Only `pie` and `sunburst` series are supported at this moment.
+         * (Highcharts, Highstock, Highmaps, Gantt) 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.
          */
-        onPoint?: (object|Highcharts.PlotTilemapOnPointOptions);
+        labelrank?: number;
         /**
-         * (Highcharts, Highmaps) Opacity of a series parts: line, fill (e.g.
-         * area) and dataLabels.
+         * (Highcharts, Highstock, Highmaps, Gantt) 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`.
          */
-        opacity?: number;
+        nullFormat?: (boolean|string);
         /**
-         * (Highcharts, Highmaps) Properties for each single point.
+         * (Highcharts, Highstock, Highmaps, Gantt) 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`.
          */
-        point?: Highcharts.PlotSeriesPointOptions;
+        nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction;
         /**
-         * (Highcharts, Highmaps) 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, Highstock, Highmaps, Gantt) 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"`.
          */
-        pointDescriptionFormat?: Function;
+        overflow?: Highcharts.DataLabelsOverflowValue;
         /**
-         * (Highcharts, Highmaps) Deprecated. Use
-         * series.accessibility.point.descriptionFormatter instead.
-         *
-         * Same as accessibility.series.descriptionFormatter, but for an
-         * individual series. Overrides the chart wide configuration.
+         * (Highcharts, Highstock, Highmaps, Gantt) When either the
+         * `borderWidth` or the `backgroundColor` is set, this is the padding
+         * within the box.
          *
-         * @deprecated 8.0.0
-         */
-        pointDescriptionFormatter?: Function;
-        /**
-         * (Highcharts, Highmaps) The padding between points in the tilemap.
+         * An array of numbers sets padding for the respective sides. An array
+         * of two numbers repeats the values for the horizontal and vertical
+         * sides.
          */
-        pointPadding?: number;
+        padding?: 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, Highstock, Highmaps, Gantt) Aligns data labels relative
+         * to points. If `center` alignment is not possible, it defaults to
+         * `right`.
          */
-        relativeXValue?: boolean;
+        position?: Highcharts.AlignValue;
         /**
-         * (Highcharts, Highmaps) The row size - how many Y axis units each
-         * tilemap row should span. Analogous to colsize.
+         * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees.
+         * Note that due to a more complex structure, backgrounds, borders and
+         * padding will be lost on a rotated data label.
          */
-        rowsize?: number;
+        rotation?: number;
         /**
-         * (Highcharts, Highmaps) 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, Highmaps, Gantt) 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`.
          */
-        selected?: boolean;
+        shadow?: (boolean|Highcharts.ShadowOptionsObject);
         /**
-         * (Highcharts, Highmaps) 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, Highmaps, Gantt) The name of a symbol to use
+         * for the border around the label. Symbols are predefined functions on
+         * the Renderer object.
          */
-        showCheckbox?: boolean;
+        shape?: string;
         /**
-         * (Highcharts, Highmaps) 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, Highmaps, Gantt) 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.
          */
-        showInLegend?: boolean;
+        style?: Highcharts.CSSObject;
         /**
-         * (Highcharts, Highmaps) Deprecated. Use
-         * series.accessibility.keyboardNavigation instead.
+         * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text
+         * which should follow marker's shape. Border and background are
+         * disabled for a label that follows a path.
          *
-         * If set to `true`, the accessibility module will skip past the points
-         * in this series for keyboard navigation.
+         * **Note:** Only SVG-based renderer supports this option. Setting
+         * `useHTML` to true will disable this option.
          *
-         * @deprecated 8.0.0
+         * 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.
          */
-        skipKeyboardNavigation?: boolean;
+        textPath?: Highcharts.DataLabelsTextPathOptionsObject;
         /**
-         * (Highcharts, Highmaps) Sonification/audio chart options for a series.
+         * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to
+         * render the labels.
          */
-        sonification?: Highcharts.SeriesSonificationOptions;
+        useHTML?: boolean;
         /**
-         * (Highcharts, Highmaps) A collection of options for different series
-         * states.
+         * (Highcharts, Highstock, Highmaps, Gantt) 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.
          */
-        states?: Highcharts.SeriesStatesOptionsObject;
+        verticalAlign?: string;
         /**
-         * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events.
-         * When true, the `mouseOut` event on a series isn't triggered until the
-         * mouse moves over another series, or out of the plot area. When false,
-         * the `mouseOut` event on a series is triggered when the mouse leaves
-         * the area around the series' graph or markers. This also implies the
-         * tooltip. When `stickyTracking` is false and `tooltip.shared` is
-         * false, the tooltip will be hidden when moving the mouse between
-         * series.
+         * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
+         * label relative to the point in pixels.
          */
-        stickyTracking?: boolean;
+        x?: number;
         /**
-         * (Highcharts, Highmaps) The shape of the tiles in the tilemap.
-         * Possible values are `hexagon`, `circle`, `diamond`, and `square`.
+         * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
+         * label relative to the point in pixels.
          */
-        tileShape?: Highcharts.TilemapShapeValue;
+        y?: number;
         /**
-         * (Highcharts, Highstock, Highmaps) A configuration object for the
-         * tooltip rendering of each single series. Properties are inherited
-         * from tooltip. Overridable properties are `headerFormat`,
-         * `pointFormat`, `yDecimals`, `xDateFormat`, `yPrefix` and `ySuffix`.
-         * Unlike other series, in a scatter plot the series.name by default
-         * shows in the headerFormat and point.x and point.y in the pointFormat.
+         * (Highcharts, Highstock, Highmaps, Gantt) The z index of the data
+         * labels group. Does not apply below series level options.
+         *
+         * Use a `zIndex` of 6 to display it above the series, or use a `zIndex`
+         * of 2 to display it behind the series.
          */
-        tooltip?: Highcharts.SeriesTooltipOptionsObject;
+        zIndex?: number;
+    }
+    /**
+     * (Highcharts, Highmaps) 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 PlotTilemapOnPointConnectorOptions {
         /**
-         * (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, Highmaps) A name for the dash style to use for the
+         * connector.
          */
-        turboThreshold?: number;
+        dashstyle?: string;
         /**
-         * (Highcharts, Highmaps) Set the initial visibility of the series.
+         * (Highcharts, Highmaps) Color of the connector line. By default it's
+         * the series' color.
          */
-        visible?: boolean;
+        stroke?: string;
         /**
-         * (Highmaps) Define the z index of the series.
+         * (Highcharts, Highmaps) Pixel width of the connector line.
          */
-        zIndex?: number;
+        width?: number;
+    }
+    /**
+     * (Highcharts, Highmaps) Options allowing to set a position and an offset
+     * of the series in the _Series on point_ feature.
+     */
+    interface PlotTilemapOnPointPositionOptions {
         /**
-         * (Highcharts, Highstock) Defines the Axis on which the zones are
-         * applied.
+         * (Highcharts, Highmaps) Series center offset from the original x
+         * position. If defined, the connector line is drawn connecting original
+         * position with new position.
          */
-        zoneAxis?: string;
+        offsetX?: 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.
-         *
-         * In styled mode, the color zones are styled with the
-         * `.highcharts-zone-{n}` class, or custom classed from the `className`
-         * option (view live demo).
+         * (Highcharts, Highmaps) Series center offset from the original y
+         * position. If defined, the connector line is drawn from original
+         * position to a new position.
          */
-        zones?: Array<Highcharts.SeriesZonesOptionsObject>;
+        offsetY?: number;
         /**
-         * (Highcharts, Highmaps) 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, Highmaps) X position of the series center. By default,
+         * the series is displayed on the point that it is connected to.
          */
-        zoomEnabled?: boolean;
-    }
-    /**
-     * (Highcharts, Highstock) A collection of SVG attributes to override the
-     * appearance of the halo, for example `fill`, `stroke` and `stroke-width`.
-     */
-    interface PlotTilemapStatesHoverHaloAttributesOptions {
-        zIndex?: number;
+        x?: number;
+        /**
+         * (Highcharts, Highmaps) Y position of the series center. By default,
+         * the series is displayed on the point that it is connected to.
+         */
+        y?: number;
     }
     /**
      * (Highcharts, Highstock) Animation setting for hovering the graph in
      * line-type series.
      */
-    interface PlotTilemapStatesSelectAnimationOptions {
+    interface PlotTilemapStatesHoverAnimationOptions {
         /**
          * (Highcharts, Highstock) The duration of the hover animation in
          * milliseconds. By default the hover state animates quickly in, and
@@ -566,125 +443,87 @@ declare module "../highcharts" {
         duration?: number;
     }
     /**
-     * (Highcharts, Highstock, Highmaps) Options for the tooltip header when
-     * tooltip.split is enabled. The header is the box containing the X value in
-     * a split tooltip.
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
      */
-    interface PlotTilemapTooltipHeaderOptions {
+    interface PlotTilemapStatesInactiveAnimationOptions {
         /**
-         * (Highcharts, Highstock, Highmaps) Background color for the tooltip
-         * header when tooltip.split is enabled.
+         * (Highcharts, Highstock) The duration of the hover animation in
+         * milliseconds. By default the hover state animates quickly in, and
+         * slowly back to normal.
          */
-        backgroundColor?: Highcharts.ColorType;
+        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 PlotTilemapTooltipDateTimeLabelFormatsOptions {
+        day?: string;
+        hour?: string;
+        millisecond?: string;
+        minute?: string;
+        month?: string;
+        second?: string;
+        week?: string;
+        year?: string;
+    }
+    /**
+     * (Highcharts, Highstock, Highmaps) Positioning options for fixed tooltip,
+     * taking effect only when tooltip.fixed is `true`.
+     */
+    interface PlotTilemapTooltipPositionOptions {
         /**
-         * (Highcharts, Highstock, Highmaps) Border color for the tooltip header
-         * when tooltip.split is enabled.
+         * (Highcharts, Highstock, Highmaps) The horizontal alignment of the
+         * fixed tooltip.
          */
-        borderColor?: Highcharts.ColorType;
+        align?: Highcharts.AlignValue;
         /**
-         * (Highcharts, Highstock, Highmaps) The width of the border for the
-         * tooltip header when tooltip.split is enabled.
+         * (Highcharts, Highstock, Highmaps) 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.
          */
-        borderWidth?: number;
+        relativeTo?: Highcharts.OptionsRelativeToValue;
         /**
-         * (Highcharts, Highstock, Highmaps) Distance between the plot area and
-         * the header (except the chevron) in a split tooltip, in pixels. The
-         * default value makes the header text align with the axis labels.
+         * (Highcharts, Highstock, Highmaps) The vertical alignment of the fixed
+         * tooltip.
          */
-        distance?: number;
+        verticalAlign?: Highcharts.VerticalAlignValue;
         /**
-         * (Highcharts, Highstock, Highmaps) 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.
+         * (Highcharts, Highstock, Highmaps) 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.
          */
-        shape?: string;
+        x?: number;
         /**
-         * (Highcharts, Highstock, Highmaps) CSS styles for the tooltip header.
-         * The default is `{ fontSize: '1em' }`, ensuring that the header text
-         * is the same size as the axis labels.
+         * (Highcharts, Highstock, Highmaps) Y pixel offset from the given
+         * position. Can be used to shy away from axis lines, grid lines etc to
+         * avoid the tooltip overlapping other elements.
          */
-        style?: object;
+        y?: number;
     }
     /**
-     * (Highcharts, Highmaps) A `tilemap` series. If the type option is not
-     * specified, it is inherited from chart.type.
+     * (Highcharts, Highstock, Gantt) Enable or disable the initial animation
+     * when a series is displayed for the `dataLabels`. The animation can also
+     * be set as a configuration object. Please note that this option only
+     * applies to the initial animation.
      *
-     * 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 `tilemap` series are defined in plotOptions.tilemap.
-     *
-     * 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 `SeriesTilemapOptions` via an interface to allow
-     * custom properties: ``` declare interface SeriesTilemapOptions {
-     * customProperty: string; }
+     * For other animations, see chart.animation and the animation parameter
+     * under the API methods. The following properties are supported:
      *
+     * - `defer`: The animation delay time in milliseconds.
      */
-    interface SeriesTilemapOptions extends Highcharts.PlotTilemapOptions, Highcharts.SeriesOptions {
-        /**
-         * Not available
-         */
-        allAreas?: undefined;
-        /**
-         * (Highcharts, Highmaps) An array of data points for the series. For
-         * the `tilemap` 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,y,value`. 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)
-         *
-         * 2. An array of objects with named values. The objects are point
-         * configuration objects as seen below. If the total number of data
-         * points exceeds the series' turboThreshold, this option is not
-         * available. (see online documentation for example)
-         *
-         * Note that for some tileShapes the grid coordinates are offset.
-         */
-        data?: Array<([(number|string), number]|[(number|string), number, number]|Highcharts.PointOptionsObject)>;
-        /**
-         * Not available
-         */
-        dataParser?: undefined;
+    interface SeriesTilemapDataDataLabelsAnimationOptions {
         /**
-         * Not available
-         */
-        dataURL?: undefined;
-        /**
-         * Not available
-         */
-        mapData?: undefined;
-        /**
-         * Not available
-         */
-        stack?: undefined;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
-         * TypeScript non-optional and might be `undefined` in series objects
-         * from unknown sources.
+         * (Highcharts, Highstock, Gantt) The animation delay time in
+         * milliseconds. Set to `0` to render the data labels immediately. As
+         * `undefined` inherits defer time from the series.animation.defer.
          */
-        type: "tilemap";
+        defer?: number;
     }
 }