highcharts 12.0.2 → 12.1.0

package/highcharts.d.ts

@@ -1489,7 +1489,8 @@ export interface AccessibilitySeriesOptions {
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) When a series contains more
      * points than this, we no longer expose information about individual points
-     * to screen readers.
+     * to screen readers. Note that the keyboard navigation remains functional,
+     * but points won't have accessible descriptions unless handled separately.
      *
      * Set to `false` to disable.
      */
@@ -68476,7 +68477,7 @@ export interface PlotTreegraphLevelsDataLabelsOptions {
      * `ellipsis`, which will keep the text on one line plus it will break
      * inside long words.
      */
-    style?: CSSObject;
+    style?: (CSSObject|PlotTreegraphLevelsDataLabelsStyleOptions);
     /**
      * (Highcharts) Options for a label text which should follow marker's shape.
      * Border and background are disabled for a label that follows a path.
@@ -68513,617 +68514,337 @@ export interface PlotTreegraphLevelsDataLabelsOptions {
      */
     zIndex?: number;
 }
-export interface PlotTreegraphLinkOptions {
-    /**
-     * (Highcharts) The color of the links between nodes.
-     */
-    color?: ColorString;
-    cursor?: string;
-    /**
-     * (Highcharts) The line width of the links connecting nodes, in pixels.
-     */
-    lineWidth?: number;
-    /**
-     * (Highcharts) Radius for the rounded corners of the links between nodes.
-     * Works for `default` link type.
-     */
-    radius?: number;
-    /**
-     * (Highcharts) Type of the link shape.
-     */
-    type?: ('curved'|'default'|'straight');
-}
 /**
- * (Highcharts) Options for the _Series on point_ feature. Only `pie` and
- * `sunburst` series are supported at this moment.
- */
-export interface PlotTreegraphOnPointOptions {
-    /**
-     * (Highcharts) Options for the connector in the _Series on point_ feature.
-     *
-     * In styled mode, the connector can be styled with the
-     * `.highcharts-connector-seriesonpoint` class name.
-     */
-    connectorOptions?: (PlotTreegraphOnPointConnectorOptions|SVGAttributes);
-    /**
-     * (Highcharts) The `id` of the point that we connect the series to. Only
-     * points with a given `plotX` and `plotY` values and map points are valid.
-     */
-    id?: string;
-    /**
-     * (Highcharts) Options allowing to set a position and an offset of the
-     * series in the _Series on point_ feature.
-     */
-    position?: (object|PlotTreegraphOnPointPositionOptions);
-}
-/**
- * (Highcharts) A treegraph series is a diagram, which shows a relation between
- * ancestors and descendants with a clear parent - child relation. The best
- * examples of the dataStructures, which best reflect this chart are e.g.
- * genealogy tree or directory structure.
- *
- * TODO change back the demo path
- *
- * 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 `treegraph` series are defined in plotOptions.treegraph.
- *
- * 3. Options for one single series are given in the series instance array. (see
- * online documentation for example)
- *
- * **TypeScript:**
- *
- * - the type option must always be set.
- *
- * - 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) Set options on specific levels. Takes precedence over series
+ * options, but not point options.
  */
-export interface PlotTreegraphOptions {
-    /**
-     * (Highcharts) Accessibility options for a series.
-     */
-    accessibility?: SeriesAccessibilityOptionsObject;
+export interface PlotTreegraphLevelsOptions {
     /**
-     * (Highcharts) Allow this series' points to be selected by clicking on the
-     * graphic (columns, point markers, pie slices, map areas etc).
-     *
-     * The selected points can be handled by point select and unselect events,
-     * or collectively by the getSelectedPoints function.
-     *
-     * And alternative way of selecting points is through dragging.
-     */
-    allowPointSelect?: boolean;
-    /**
-     * (Highcharts) Enable or disable the initial animation when a series is
-     * displayed. The animation can also be set as a configuration object.
-     * Please note that this option only applies to the initial animation of the
-     * series itself. For other animations, see chart.animation and the
-     * animation parameter under the API methods. The following properties are
-     * supported:
-     *
-     * - `defer`: The animation delay time in milliseconds.
-     *
-     * - `duration`: The duration of the animation in milliseconds. (Defaults to
-     * `1000`)
-     *
-     * - `easing`: Can be a string reference to an easing function set on the
-     * `Math` object or a function. See the _Custom easing function_ demo below.
-     * (Defaults to `easeInOutSine`)
-     *
-     * Due to poor performance, animation is disabled in old IE browsers for
-     * several chart types.
-     */
-    animation?: (boolean|AnimationOptionsObject);
-    /**
-     * (Highcharts) 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.
-     */
-    animationLimit?: number;
-    /**
-     * (Highcharts) Sets the color blending in the boost module.
-     */
-    boostBlending?: OptionsBoostBlendingValue;
-    /**
-     * (Highcharts) Set the point threshold for when a series should enter boost
-     * mode.
-     *
-     * Setting it to e.g. 2000 will cause the series to enter boost mode when
-     * there are 2000 or more points in the series.
-     *
-     * To disable boosting on the series, set the `boostThreshold` to 0. Setting
-     * it to 1 will force boosting.
-     *
-     * Note that the cropThreshold also affects this setting. When zooming in on
-     * a series that has fewer points than the `cropThreshold`, all points are
-     * rendered although outside the visible plot area, and the `boostThreshold`
-     * won't take effect.
-     */
-    boostThreshold?: number;
-    /**
-     * (Highcharts) An additional class name to apply to the series' graphical
-     * elements. This option does not replace default class names of the
-     * graphical element. Changes to the series' color will also be reflected in
-     * a chart's legend and tooltip.
+     * (Highcharts) Can set a `borderColor` on all points which lies on the same
+     * level.
      */
-    className?: string;
+    borderColor?: ColorString;
     /**
-     * (Highcharts) Disable this option to allow series rendering in the whole
-     * plotting area.
-     *
-     * **Note:** Clipping should be always enabled when chart.zoomType is set
+     * (Highcharts) Set the dash style of the border of all the point which lies
+     * on the level. See plotOptions.scatter.dashStyle for possible options.
      */
-    clip?: boolean;
+    borderDashStyle?: DashStyleValue;
     /**
-     * (Highcharts) Options applied to collapse Button. The collape button is
-     * the small button which indicates, that the node is collapsable.
+     * (Highcharts) Can set the borderWidth on all points which lies on the same
+     * level.
      */
-    collapseButton?: PlotTreegraphCollapseButtonOptions;
+    borderWidth?: number;
     /**
-     * (Highcharts) The main color of the series. In line type series it applies
-     * to the line and the point markers unless otherwise specified. In bar type
-     * series it applies to the bars unless a color is specified per point. The
-     * default value is pulled from the `options.colors` array.
-     *
-     * In styled mode, the color can be defined by the colorIndex option. Also,
-     * the series color can be set with the `.highcharts-series`,
-     * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
-     * `.highcharts-series-{n}` class, or individual classes given by the
-     * `className` option.
+     * (Highcharts) Can set a color on all points which lies on the same level.
      */
     color?: (ColorString|GradientColorObject|PatternObject);
     /**
-     * (Highcharts) When using automatic point colors pulled from the
-     * `options.colors` collection, this option determines whether the chart
-     * should receive one color per series or one color per point.
+     * (Highcharts) A configuration object to define how the color of a child
+     * varies from the parent's color. The variation is distributed among the
+     * children of node. For example when setting brightness, the brightness
+     * change will range from the parent's original brightness on the first
+     * child, to the amount set in the `to` setting on the last node. This
+     * allows a gradient-like color scheme that sets children out from each
+     * other while highlighting the grouping on treemaps and sectors on sunburst
+     * charts.
      */
-    colorByPoint?: boolean;
+    colorVariation?: PlotTreegraphLevelsColorVariationOptions;
     /**
-     * (Highcharts) Styled mode only. A specific color index to use for the
-     * series, so its graphic representations are given the class name
-     * `highcharts-color-{n}`.
-     *
-     * Since v11, CSS variables on the form `--highcharts-color-{n}` make
-     * changing the color scheme very convenient.
+     * (Highcharts) Can set the options of dataLabels on each point which lies
+     * on the level. plotOptions.treemap.dataLabels for possible values.
      */
-    colorIndex?: number;
+    dataLabels?: (PlotTreegraphLevelsDataLabelsOptions|Array<PlotTreegraphLevelsDataLabelsOptions>);
     /**
-     * (Highcharts) A series specific or series type specific color set to apply
-     * instead of the global colors when colorByPoint is true.
+     * (Highcharts) Can set the layoutAlgorithm option on a specific level.
      */
-    colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
+    layoutAlgorithm?: OptionsLayoutAlgorithmValue;
     /**
-     * (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) Can set the layoutStartingDirection option on a specific
+     * level.
      */
-    crisp?: boolean;
+    layoutStartingDirection?: OptionsLayoutStartingDirectionValue;
     /**
-     * (Highcharts) When the series contains less points than the crop
-     * threshold, all points are drawn, event 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.
+     * (Highcharts) Decides which level takes effect from the options set in the
+     * levels object.
      */
-    cropThreshold?: number;
+    level?: number;
+}
+/**
+ * (Highcharts) Options for the connector in the _Series on point_ feature.
+ *
+ * In styled mode, the connector can be styled with the
+ * `.highcharts-connector-seriesonpoint` class name.
+ */
+export interface PlotTreegraphOnPointConnectorOptions {
     /**
-     * (Highcharts) You can set the cursor to "pointer" if you have click events
-     * attached to the series, to signal to the user that the points and lines
-     * can be clicked.
-     *
-     * In styled mode, the series cursor can be set with the same classes as
-     * listed under series.color.
+     * (Highcharts) A name for the dash style to use for the connector.
      */
-    cursor?: (string|CursorValue);
+    dashstyle?: string;
     /**
-     * (Highcharts) A reserved subspace to store options and values for
-     * customized functionality. Here you can add additional data for your own
-     * event callbacks and formatter callbacks.
+     * (Highcharts) Color of the connector line. By default it's the series'
+     * color.
      */
-    custom?: Dictionary<any>;
+    stroke?: string;
     /**
-     * (Highcharts, Highstock, Highmaps, Gantt) Options for the data labels
-     * appearing on top of the nodes and links. For treegraph charts, data
-     * labels are visible for the nodes by default, but hidden for links. This
-     * is controlled by modifying the `nodeFormat`, and the `format` that
-     * applies to links and is an empty string by default.
+     * (Highcharts) Pixel width of the connector line.
      */
-    dataLabels?: (SeriesTreegraphDataLabelsOptionsObject|Array<SeriesTreegraphDataLabelsOptionsObject>);
+    width?: number;
+}
+/**
+ * (Highcharts) Options allowing to set a position and an offset of the series
+ * in the _Series on point_ feature.
+ */
+export interface PlotTreegraphOnPointPositionOptions {
     /**
-     * (Highcharts) A description of the series to add to the screen reader
-     * information about the series.
+     * (Highcharts) Series center offset from the original x position. If
+     * defined, the connector line is drawn connecting original position with
+     * new position.
      */
-    description?: string;
+    offsetX?: number;
     /**
-     * (Highcharts) Enable or disable the mouse tracking for a specific series.
-     * This includes point tooltips and click events on graphs and points. For
-     * large datasets it improves performance.
+     * (Highcharts) Series center offset from the original y position. If
+     * defined, the connector line is drawn from original position to a new
+     * position.
      */
-    enableMouseTracking?: boolean;
+    offsetY?: number;
     /**
-     * (Highcharts) General event handlers for the series items. These event
-     * hooks can also be attached to the series at run time using the
-     * `Highcharts.addEvent` function.
+     * (Highcharts) X position of the series center. By default, the series is
+     * displayed on the point that it is connected to.
      */
-    events?: SeriesEventsOptionsObject;
+    x?: number;
     /**
-     * (Highcharts) Whether the treegraph series should fill the entire plot
-     * area in the X axis direction, even when there are collapsed points.
+     * (Highcharts) Y position of the series center. By default, the series is
+     * displayed on the point that it is connected to.
      */
-    fillSpace?: boolean;
+    y?: number;
+}
+/**
+ * (Highcharts) Point accessibility options for a series.
+ */
+export interface PlotTreemapAccessibilityPointOptions {
     /**
-     * (Highcharts) 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.
+     * (Highcharts) Date format to use for points on datetime axes when
+     * describing them to screen reader users.
      *
-     * Applies only to series types using nearest neighbor search (not direct
-     * hover) for tooltip.
-     */
-    findNearestPointBy?: OptionsFindNearestPointByValue;
-    /**
-     * (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) Highlight only the hovered point and fade the remaining
-     * points.
+     * Defaults to the same format as in tooltip.
      *
-     * Scatter-type series require enabling the 'inactive' marker state and
-     * adjusting opacity. Note that this approach could affect performance with
-     * large datasets.
+     * For an overview of the replacement codes, see dateFormat.
      */
-    inactiveOtherPoints?: boolean;
+    dateFormat?: string;
     /**
-     * (Highcharts) When set to `false` will prevent the series data from being
-     * included in any form of data export.
-     *
-     * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
-     * `includeInCSVExport`.
+     * (Highcharts) 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.
      */
-    includeInDataExport?: boolean;
+    dateFormatter?: ScreenReaderFormatterCallbackFunction<Point>;
     /**
-     * (Highcharts) An array specifying which option maps to which key in the
-     * data point array. This makes it convenient to work with unstructured data
-     * arrays from different sources.
+     * (Highcharts) Whether or not to describe points with the value `null` to
+     * assistive technology, such as screen readers.
      */
-    keys?: Array<string>;
+    describeNull?: 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.
+     * (Highcharts) A format string to use instead of the default for point
+     * descriptions.
      *
-     * The series labels currently work with series types having a `graph` or an
-     * `area`.
-     */
-    label?: SeriesLabelOptionsObject;
-    /**
-     * (Highcharts) What type of legend symbol to render for this series. Can be
-     * one of `areaMarker`, `lineMarker` or `rectangle`.
-     */
-    legendSymbol?: OptionsLegendSymbolValue;
-    /**
-     * (Highcharts) Set options on specific levels. Takes precedence over series
-     * options, but not point options.
-     */
-    levels?: Array<PlotTreegraphLevelsOptions>;
-    link?: PlotTreegraphLinkOptions;
-    /**
-     * (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.
+     * The context of the format string is the point instance.
      *
-     * 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.
+     * As opposed to accessibility.point.valueDescriptionFormat, this option
+     * replaces the whole description.
      */
-    linkedTo?: string;
+    descriptionFormat?: string;
     /**
-     * (Highcharts) 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.
+     * (Highcharts) Formatter function to use instead of the default for point
+     * descriptions. Same as `accessibility.point.descriptionFormatter`, but
+     * applies to a series instead of the whole chart.
      *
-     * In styled mode, the markers can be styled with the `.highcharts-point`,
-     * `.highcharts-point-hover` and `.highcharts-point-select` class names.
+     * Note: Prefer using accessibility.point.valueDescriptionFormat instead if
+     * possible, as default functionality such as describing annotations will be
+     * preserved.
      */
-    marker?: PointMarkerOptionsObject;
+    descriptionFormatter?: ScreenReaderFormatterCallbackFunction<Point>;
     /**
-     * (Highcharts) The distance between nodes in a tree graph in the
-     * longitudinal direction. The longitudinal direction means the direction
-     * that the chart flows - in a horizontal chart the distance is horizontal,
-     * in an inverted chart (vertical), the distance is vertical.
-     *
-     * If a number is given, it denotes pixels. If a percentage string is given,
-     * the distance is a percentage of the rendered node width. A `nodeDistance`
-     * of `100%` will render equal widths for the nodes and the gaps between
-     * them.
-     *
-     * This option applies only when the `nodeWidth` option is `auto`, making
-     * the node width respond to the number of columns.
+     * (Highcharts) Decimals to use for the values in the point descriptions.
+     * Uses tooltip.valueDecimals if not defined.
      */
-    nodeDistance?: (number|string);
+    valueDecimals?: number;
     /**
-     * (Highcharts) The pixel width of each node in a, or the height in case the
-     * chart is inverted. For tree graphs, the node width is only applied if the
-     * marker symbol is `rect`, otherwise the `marker` sizing options apply.
+     * (Highcharts) Format to use for describing the values of data points to
+     * assistive technology - including screen readers. The point context is
+     * available as `{point}`.
      *
-     * Can be a number or a percentage string, or `auto`. If `auto`, the nodes
-     * are sized to fill up the plot area in the longitudinal direction,
-     * regardless of the number of levels.
-     */
-    nodeWidth?: (number|string);
-    /**
-     * (Highcharts) Options for the _Series on point_ feature. Only `pie` and
-     * `sunburst` series are supported at this moment.
-     */
-    onPoint?: (object|PlotTreegraphOnPointOptions);
-    /**
-     * (Highcharts) The opacity of a point in treemap. When a point has
-     * children, the visibility of the children is determined by the opacity.
-     */
-    opacity?: number;
-    /**
-     * (Highcharts) Properties for each single point.
-     */
-    point?: PlotSeriesPointOptions;
-    /**
-     * (Highcharts) Same as accessibility.point.descriptionFormat, but for an
-     * individual series. Overrides the chart wide configuration.
+     * Other available context variables include `{index}`, `{value}`, and
+     * `{xDescription}`.
+     *
+     * Additionally, the series name, annotation info, and description added in
+     * `point.accessibility.description` is added by default if relevant. To
+     * override this, use the accessibility.point.descriptionFormatter option.
      */
-    pointDescriptionFormat?: Function;
+    valueDescriptionFormat?: string;
     /**
-     * (Highcharts) Same as accessibility.series.descriptionFormatter, but for
-     * an individual series. Overrides the chart wide configuration.
+     * (Highcharts) Prefix to add to the values in the point descriptions. Uses
+     * tooltip.valuePrefix if not defined.
      */
-    pointDescriptionFormatter?: Function;
+    valuePrefix?: string;
     /**
-     * (Highcharts, Highstock, Gantt) If no x values are given for the points in
-     * a series, `pointInterval` defines the interval of the x values. For
-     * example, if a series contains one value every decade starting from year
-     * 0, set `pointInterval` to `10`. In true `datetime` axes, the
-     * `pointInterval` is set in milliseconds.
-     *
-     * It can be also be combined with `pointIntervalUnit` to draw irregular
-     * time intervals.
-     *
-     * If combined with `relativeXValue`, an x value can be set on each point,
-     * and the `pointInterval` is added x times to the `pointStart` setting.
-     *
-     * Please note that this options applies to the _series data_, not the
-     * interval of the axis ticks, which is independent.
+     * (Highcharts) Suffix to add to the values in the point descriptions. Uses
+     * tooltip.valueSuffix if not defined.
      */
-    pointInterval?: number;
+    valueSuffix?: string;
+}
+export interface PlotTreemapBreadcrumbsButtonThemeStyleOptions {
+    color?: string;
+}
+/**
+ * (Highcharts) Options for the breadcrumbs, the navigation at the top leading
+ * the way up through the traversed levels.
+ */
+export interface PlotTreemapBreadcrumbsOptions {
     /**
-     * (Highcharts, Highstock, Gantt) On datetime series, this allows for
-     * setting the pointInterval to irregular time units, `day`, `month` and
-     * `year`. A day is usually the same as 24 hours, but `pointIntervalUnit`
-     * also takes the DST crossover into consideration when dealing with local
-     * time. Combine this option with `pointInterval` to draw weeks, quarters, 6
-     * months, 10 years etc.
-     *
-     * Please note that this options applies to the _series data_, not the
-     * interval of the axis ticks, which is independent.
+     * (Highcharts) The default padding for each button and separator in each
+     * direction.
      */
-    pointIntervalUnit?: OptionsPointIntervalUnitValue;
+    buttonSpacing?: 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.
+     * (Highcharts) A collection of attributes for the buttons. The object takes
+     * SVG attributes like `fill`, `stroke`, `stroke-width`, as well as `style`,
+     * a collection of CSS properties for the text.
      *
-     * 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.
+     * The object can also be extended with states, so you can set
+     * presentational options for `hover`, `select` or `disabled` button states.
      */
-    pointStart?: (number|string);
+    buttonTheme?: (PlotTreemapBreadcrumbsButtonThemeOptions|SVGAttributes);
+    events?: PlotTreemapBreadcrumbsEventsOptions;
     /**
-     * (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) When the breadcrumbs are floating, the plot area will not
+     * move to make space for it. By default, the chart will not make space for
+     * the buttons. This property won't work when positioned in the middle.
      */
-    relativeXValue?: boolean;
+    floating?: boolean;
     /**
-     * (Highcharts) Flips the positions of the nodes of a treegraph along the
-     * horizontal axis (vertical if chart is inverted).
+     * (Highcharts) A format string for the breadcrumbs button. Variables are
+     * enclosed by curly brackets. Available values are passed in the declared
+     * point options.
      */
-    reversed?: boolean;
+    format?: (string|undefined);
     /**
-     * (Highcharts) Whether to select the series initially. If `showCheckbox` is
-     * true, the checkbox next to the series name in the legend will be checked
-     * for a selected series.
+     * (Highcharts) Callback function to format the breadcrumb text from
+     * scratch.
      */
-    selected?: boolean;
+    formatter?: BreadcrumbsFormatterCallbackFunction;
     /**
-     * (Highcharts) If true, a checkbox is displayed next to the legend item to
-     * allow selecting the series. The state of the checkbox is determined by
-     * the `selected` option.
+     * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
+     * buttons will be aligned properly for the default chart layout (title,
+     * subtitle, legend, range selector) for the custom chart layout set the
+     * position properties.
      */
-    showCheckbox?: boolean;
+    position?: (BreadcrumbsAlignOptions|PlotTreemapBreadcrumbsPositionOptions);
     /**
-     * (Highcharts) Whether to display this series type or specific series item
-     * in the legend.
+     * (Highcharts, Highmaps) What box to align the button to. Can be either
+     * `plotBox` or `spacingBox`.
      */
-    showInLegend?: boolean;
+    relativeTo?: ButtonRelativeToValue;
     /**
-     * (Highcharts) If set to `true`, the accessibility module will skip past
-     * the points in this series for keyboard navigation.
+     * (Highcharts) Whether to reverse the order of buttons. This is common in
+     * Arabic and Hebrew.
      */
-    skipKeyboardNavigation?: boolean;
+    rtl?: boolean;
     /**
-     * (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) Options object for Breadcrumbs separator.
      */
-    softThreshold?: boolean;
+    separator?: PlotTreemapBreadcrumbsSeparatorOptions;
     /**
-     * (Highcharts) Sonification/audio chart options for a series.
+     * (Highcharts) Show full path or only a single button.
      */
-    sonification?: SeriesSonificationOptions;
+    showFullPath?: boolean;
     /**
-     * (Highcharts, Highstock) Whether to stack the values of each series on top
-     * of each other. Possible values are `undefined` to disable, `"normal"` to
-     * stack by value or `"percent"`.
-     *
-     * When stacking is enabled, data must be sorted in ascending X order.
+     * (Highcharts) CSS styles for all breadcrumbs.
      *
-     * Some stacking options are related to specific series types. In the
-     * streamgraph series type, the stacking option is set to `"stream"`. The
-     * second one is `"overlap"`, which only applies to waterfall series.
-     */
-    stacking?: OptionsStackingValue;
-    /**
-     * (Highcharts) A wrapper object for all the series options in specific
-     * states.
+     * In styled mode, the breadcrumbs buttons are styled by the
+     * `.highcharts-breadcrumbs-buttons .highcharts-button` rule with its
+     * different states.
      */
-    states?: SeriesStatesOptionsObject;
+    style?: SVGAttributes;
     /**
-     * (Highcharts, Highstock) Whether to apply steps to the line. Possible
-     * values are `left`, `center` and `right`.
+     * (Highcharts) Whether to use HTML to render the breadcrumbs items texts.
      */
-    step?: OptionsStepValue;
+    useHTML?: boolean;
     /**
-     * (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) The z index of the breadcrumbs group.
      */
-    stickyTracking?: boolean;
+    zIndex?: number;
+}
+/**
+ * (Highcharts) Options object for Breadcrumbs separator.
+ */
+export interface PlotTreemapBreadcrumbsSeparatorOptions {
     /**
-     * (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) CSS styles for the breadcrumbs separator.
+     *
+     * In styled mode, the breadcrumbs separators are styled by the
+     * `.highcharts-separator` rule with its different states.
      */
-    tooltip?: SeriesTooltipOptionsObject;
+    style?: (CSSObject|PlotTreemapBreadcrumbsSeparatorStyleOptions);
+    text?: string;
+}
+export interface PlotTreemapClusterLayoutAlgorithmOptions {
+    distance?: number;
+    gridSize?: number;
+    kmeansThreshold?: number;
+}
+/**
+ * (Highcharts) An option to optimize treemap series rendering by grouping
+ * smaller leaf nodes below a certain square area threshold in pixels. If the
+ * square area of a point becomes smaller than the specified threshold,
+ * determined by the `pixelWidth` and/or `pixelHeight` options, then this point
+ * is moved into one group point per series.
+ */
+export interface PlotTreemapClusterOptions {
     /**
-     * (Highcharts) This option enables automatic traversing to the last child
-     * level upon node interaction. This feature simplifies navigation by
-     * immediately focusing on the deepest layer of the data structure without
-     * intermediate steps.
+     * (Highcharts) An additional, individual class name for the grouped point's
+     * graphic representation.
      */
-    traverseToLeaf?: boolean;
+    className?: string;
     /**
-     * (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) Individual color for the grouped point. By default the color
+     * is pulled from the parent color.
      */
-    turboThreshold?: number;
+    color?: (ColorString|GradientColorObject|PatternObject);
     /**
-     * (Highcharts) Set the initial visibility of the series.
+     * (Highcharts) Enable or disable Treemap grouping.
      */
-    visible?: boolean;
-}
-/**
- * (Highcharts) A collection of attributes for the buttons. The object takes SVG
- * attributes like `fill`, `stroke`, `stroke-width`, as well as `style`, a
- * collection of CSS properties for the text.
- *
- * The object can also be extended with states, so you can set presentational
- * options for `hover`, `select` or `disabled` button states.
- */
-export interface PlotTreemapBreadcrumbsButtonThemeOptions {
-    style?: PlotTreemapBreadcrumbsButtonThemeStyleOptions;
-}
-export interface PlotTreemapBreadcrumbsEventsOptions {
+    enabled?: boolean;
+    layoutAlgorithm?: PlotTreemapClusterLayoutAlgorithmOptions;
+    marker?: PlotTreemapClusterMarkerOptions;
     /**
-     * (Highcharts) Fires when clicking on the breadcrumbs button. Two arguments
-     * are passed to the function. First breadcrumb button as an SVG element.
-     * Second is the breadcrumbs class, containing reference to the chart,
-     * series etc. (see online documentation for example)
-     *
-     * Return false to stop default buttons click action.
+     * (Highcharts) Defines the minimum number of child nodes required to create
+     * a group of small nodes.
      */
-    click?: BreadcrumbsClickCallbackFunction;
-}
-/**
- * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
- * buttons will be aligned properly for the default chart layout (title,
- * subtitle, legend, range selector) for the custom chart layout set the
- * position properties.
- */
-export interface PlotTreemapBreadcrumbsPositionOptions {
+    minimumClusterSize?: number;
     /**
-     * (Highcharts, Highmaps) Horizontal alignment of the breadcrumbs buttons.
+     * (Highcharts) The name of the point of grouped nodes shown in the tooltip,
+     * dataLabels, etc. By default it is set to '+ n', where n is number of
+     * grouped points.
      */
-    align?: AlignValue;
+    name?: string;
     /**
-     * (Highcharts, Highmaps) Vertical alignment of the breadcrumbs buttons.
+     * (Highcharts) The pixel threshold height of area, which is used in Treemap
+     * grouping.
      */
-    verticalAlign?: VerticalAlignValue;
+    pixelHeight?: number;
     /**
-     * (Highcharts, Highmaps) The X offset of the breadcrumbs button group.
+     * (Highcharts) The pixel threshold width of area, which is used in Treemap
+     * grouping.
      */
-    x?: number;
+    pixelWidth?: number;
     /**
-     * (Highcharts, Highmaps) The Y offset of the breadcrumbs button group. When
-     * `undefined`, and `floating` is `false`, the `y` position is adapted so
-     * that the breadcrumbs are rendered outside the target area.
+     * (Highcharts) A configuration property that specifies the factor by which
+     * the value and size of a grouped node are reduced. This can be
+     * particularly useful when a grouped node occupies a disproportionately
+     * large portion of the graph, ensuring better visual balance and
+     * readability.
      */
-    y?: (number|undefined);
-}
-/**
- * (Highcharts) CSS styles for the breadcrumbs separator.
- *
- * In styled mode, the breadcrumbs separators are styled by the
- * `.highcharts-separator` rule with its different states.
- */
-export interface PlotTreemapBreadcrumbsSeparatorStyleOptions {
-    color?: string;
-    fontSize?: number;
+    reductionFactor?: number;
 }
 /**
  * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels,
@@ -69337,7 +69058,7 @@ export interface PlotTreemapDataLabelsOptions {
      * `ellipsis`, which will keep the text on one line plus it will break
      * inside long words.
      */
-    style?: CSSObject;
+    style?: (CSSObject|PlotTreemapDataLabelsStyleOptions);
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
      * should follow marker's shape. Border and background are disabled for a
@@ -69377,256 +69098,54 @@ export interface PlotTreemapDataLabelsOptions {
     zIndex?: number;
 }
 /**
- * (Highcharts) A configuration object to define how the color of a child varies
- * from the parent's color. The variation is distributed among the children of
- * node. For example when setting brightness, the brightness change will range
- * from the parent's original brightness on the first child, to the amount set
- * in the `to` setting on the last node. This allows a gradient-like color
- * scheme that sets children out from each other while highlighting the grouping
- * on treemaps and sectors on sunburst charts.
+ * (Highcharts, Highstock, Gantt) Styles for the series label. The color
+ * defaults to the series color, or a contrast color if `onArea`.
  */
-export interface PlotTreemapLevelsColorVariationOptions {
-    /**
-     * (Highcharts) The key of a color variation. Currently supports
-     * `brightness` only.
-     */
-    key?: "brightness";
-    /**
-     * (Highcharts) The ending value of a color variation. The last sibling will
-     * receive this value.
-     */
-    to?: number;
+export interface PlotTreemapLabelStyleOptions {
+    fontSize?: (number|string);
 }
 /**
- * (Highcharts) Can set the options of dataLabels on each point which lies on
- * the level. plotOptions.treemap.dataLabels for possible values.
+ * (Highcharts) Enable or disable the initial animation when a series is
+ * displayed for the `dataLabels`. The animation can also be set as a
+ * configuration object. Please note that this option only applies to the
+ * initial animation.
+ *
+ * For other animations, see chart.animation and the animation parameter under
+ * the API methods. The following properties are supported:
+ *
+ * - `defer`: The animation delay time in milliseconds.
  */
-export interface PlotTreemapLevelsDataLabelsOptions {
-    /**
-     * (Highcharts) The alignment of the data label compared to the point. If
-     * `right`, the right side of the label should be touching the point. For
-     * points with an extent, like columns, the alignments also dictates how to
-     * align it inside the box, as given with the inside option. Can be one of
-     * `left`, `center` or `right`.
-     */
-    align?: (AlignValue|null);
-    /**
-     * (Highcharts) Alignment method for data labels. If set to `plotEdges`, the
-     * labels are aligned within the plot area in the direction of the y-axis.
-     * So in a regular column chart, the labels are aligned vertically according
-     * to the `verticalAlign` setting. In a bar chart, which is inverted, the
-     * labels are aligned horizontally according to the `align` setting. Applies
-     * to cartesian series only.
-     */
-    alignTo?: string;
-    /**
-     * (Highcharts) Whether to allow data labels to overlap. To make the labels
-     * less sensitive for overlapping, the dataLabels.padding can be set to 0.
-     */
-    allowOverlap?: boolean;
+export interface PlotTreemapLevelsDataLabelsAnimationOptions {
     /**
-     * (Highcharts) Enable or disable the initial animation when a series is
-     * displayed for the `dataLabels`. The animation can also be set as a
-     * configuration object. Please note that this option only applies to the
-     * initial animation.
-     *
-     * For other animations, see chart.animation and the animation parameter
-     * under the API methods. The following properties are supported:
-     *
-     * - `defer`: The animation delay time in milliseconds.
-     */
-    animation?: (boolean|PlotTreemapLevelsDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
-    /**
-     * (Highcharts) The background color or gradient for the data label. Setting
-     * it to `auto` will use the point's color.
-     */
-    backgroundColor?: (ColorString|GradientColorObject|PatternObject);
-    /**
-     * (Highcharts) The border color for the data label. Setting it to `auto`
-     * will use the point's color. Defaults to `undefined`.
-     */
-    borderColor?: (ColorString|GradientColorObject|PatternObject);
-    /**
-     * (Highcharts) The border radius in pixels for the data label.
-     */
-    borderRadius?: number;
-    /**
-     * (Highcharts) The border width in pixels for the data label.
-     */
-    borderWidth?: number;
-    /**
-     * (Highcharts) A class name for the data label. Particularly in styled
-     * mode, this can be used to give each series' or point's data label unique
-     * styling. In addition to this option, a default color class name is added
-     * so that we can give the labels a contrast text shadow.
-     */
-    className?: string;
-    /**
-     * (Highcharts) This options is deprecated. Use style.color instead.
-     *
-     * The text color for the data labels. Defaults to `undefined`. For certain
-     * series types, like column or map, the data labels can be drawn inside the
-     * points. In this case the data label will be drawn with maximum contrast
-     * by default. Additionally, it will be given a `text-outline` style with
-     * the opposite color, to further increase the contrast. This can be
-     * overridden by setting the `text-outline` style to `none` in the
-     * `dataLabels.style` option.
-     *
-     * @deprecated 10.3.0
-     */
-    color?: ColorType;
-    /**
-     * (Highcharts) Whether to hide data labels that are outside the plot area.
-     * By default, the data label is moved inside the plot area according to the
-     * overflow option.
-     */
-    crop?: boolean;
-    /**
-     * (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.
-     */
-    defer?: boolean;
-    /**
-     * (Highcharts) Enable or disable the data labels.
-     */
-    enabled?: boolean;
-    /**
-     * (Highcharts) A declarative filter to control of which data labels to
-     * display. The declarative filter is designed for use when callback
-     * functions are not available, like when the chart options require a pure
-     * JSON structure or for use with graphical editors. For programmatic
-     * control, use the `formatter` instead, and return `undefined` to disable a
-     * single data label.
-     */
-    filter?: DataLabelsFilterOptionsObject;
-    /**
-     * (Highcharts) A format string for the data label. Available variables are
-     * the same as for `formatter`.
-     */
-    format?: string;
-    /**
-     * (Highcharts) Callback JavaScript function to format the data label. Note
-     * that if a `format` is defined, the format takes precedence and the
-     * formatter is ignored.
-     */
-    formatter?: DataLabelsFormatterCallbackFunction;
-    /**
-     * (Highcharts) For points with an extent, like columns or map areas,
-     * whether to align the data label inside the box or to the actual value
-     * point. Defaults to `false` in most cases, `true` in stacked columns.
-     */
-    inside?: boolean;
-    /**
-     * (Highcharts) Format for points with the value of null. Works analogously
-     * to format. `nullFormat` can be applied only to series which support
-     * displaying null points i.e `heatmap` or `tilemap`. Does not work with
-     * series that don't display null points, like `line`, `column`, `bar` or
-     * `pie`.
-     */
-    nullFormat?: (boolean|string);
-    /**
-     * (Highcharts) Callback JavaScript function that defines formatting for
-     * points with the value of null. Works analogously to formatter.
-     * `nullFormatter` can be applied only to series which support displaying
-     * null points i.e `heatmap` or `tilemap`. Does not work with series that
-     * don't display null points, like `line`, `column`, `bar` or `pie`.
-     */
-    nullFormatter?: DataLabelsFormatterCallbackFunction;
-    /**
-     * (Highcharts) How to handle data labels that flow outside the plot area.
-     * The default is `"justify"`, which aligns them inside the plot area. For
-     * columns and bars, this means it will be moved inside the bar. To display
-     * data labels outside the plot area, set `crop` to `false` and `overflow`
-     * to `"allow"`.
-     */
-    overflow?: DataLabelsOverflowValue;
-    /**
-     * (Highcharts) When either the `borderWidth` or the `backgroundColor` is
-     * set, this is the padding within the box.
-     */
-    padding?: number;
-    /**
-     * (Highcharts) Aligns data labels relative to points. If `center` alignment
-     * is not possible, it defaults to `right`.
-     */
-    position?: AlignValue;
-    /**
-     * (Highcharts) Text rotation in degrees. Note that due to a more complex
-     * structure, backgrounds, borders and padding will be lost on a rotated
-     * data label.
-     */
-    rotation?: number;
-    /**
-     * (Highcharts) The shadow of the box. Works best with `borderWidth` or
-     * `backgroundColor`. Since 2.3 the shadow can be an object configuration
-     * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
-     */
-    shadow?: (boolean|ShadowOptionsObject);
-    /**
-     * (Highcharts) The name of a symbol to use for the border around the label.
-     * Symbols are predefined functions on the Renderer object.
-     */
-    shape?: string;
-    /**
-     * (Highcharts) Styles for the label. The default `color` setting is
-     * `"contrast"`, which is a pseudo color that Highcharts picks up and
-     * applies the maximum contrast to the underlying point item, for example
-     * the bar in a bar chart.
-     *
-     * The `textOutline` is a pseudo property that applies an outline of the
-     * given width with the given color, which by default is the maximum
-     * contrast to the text. So a bright text color will result in a black text
-     * outline for maximum readability on a mixed background. In some cases,
-     * especially with grayscale text, the text outline doesn't work well, in
-     * which cases it can be disabled by setting it to `"none"`. When `useHTML`
-     * is true, the `textOutline` will not be picked up. In this, case, the same
-     * effect can be acheived through the `text-shadow` CSS property.
-     *
-     * 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.
-     */
-    style?: CSSObject;
-    /**
-     * (Highcharts) Options for a label text which should follow marker's shape.
-     * Border and background are disabled for a label that follows a path.
-     *
-     * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
-     * to true will disable this option.
-     */
-    textPath?: DataLabelsTextPathOptionsObject;
-    /**
-     * (Highcharts) Whether to use HTML to render the labels.
-     */
-    useHTML?: boolean;
-    /**
-     * (Highcharts) The vertical alignment of a data label. Can be one of `top`,
-     * `middle` or `bottom`. The default value depends on the data, for instance
-     * in a column chart, the label is above positive values and below negative
-     * values.
-     */
-    verticalAlign?: string;
-    /**
-     * (Highcharts) The x position offset of the label relative to the point in
-     * pixels.
-     */
-    x?: number;
-    /**
-     * (Highcharts) The y position offset of the label relative to the point in
-     * pixels.
-     */
-    y?: number;
-    /**
-     * (Highcharts) The z index of the data labels. Use a `zIndex` of 6 to
-     * display it above the series, or use a `zIndex` of 2 to display it behind
-     * the series.
+     * (Highcharts) The animation delay time in milliseconds. Set to `0` to
+     * render the data labels immediately. As `undefined` inherits defer time
+     * from the series.animation.defer.
      */
-    zIndex?: number;
+    defer?: number;
+}
+/**
+ * (Highcharts) Styles for the label. The default `color` setting is
+ * `"contrast"`, which is a pseudo color that Highcharts picks up and applies
+ * the maximum contrast to the underlying point item, for example the bar in a
+ * bar chart.
+ *
+ * The `textOutline` is a pseudo property that applies an outline of the given
+ * width with the given color, which by default is the maximum contrast to the
+ * text. So a bright text color will result in a black text outline for maximum
+ * readability on a mixed background. In some cases, especially with grayscale
+ * text, the text outline doesn't work well, in which cases it can be disabled
+ * by setting it to `"none"`. When `useHTML` is true, the `textOutline` will not
+ * be picked up. In this, case, the same effect can be acheived through the
+ * `text-shadow` CSS property.
+ *
+ * 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.
+ */
+export interface PlotTreemapLevelsDataLabelsStyleOptions {
+    textOverflow?: string;
 }
 /**
  * (Highcharts) Options for the connector in the _Series on point_ feature.
@@ -86167,11 +85686,11 @@ export interface SeriesTooltipOptionsObject {
      */
     changeDecimals?: number;
     /**
-     * (Highstock) The HTML of the cluster point's in the tooltip. Works only
-     * with marker-clusters module and analogously to pointFormat.
+     * (Highstock) The HTML of the grouped point's nodes in the tooltip. Works
+     * only for Treemap series grouping and analogously to pointFormat.
      *
-     * The cluster tooltip can be also formatted using `tooltip.formatter`
-     * callback function and `point.isCluster` flag.
+     * The grouped nodes point tooltip can be also formatted using
+     * `tooltip.formatter` callback function and `point.isGroupNode` flag.
      */
     clusterFormat?: string;
     /**
@@ -90007,12 +89526,12 @@ export interface TooltipOptions {
      */
     className?: string;
     /**
-     * (Highcharts, Highstock, Highmaps, Gantt) The HTML of the cluster point's
-     * in the tooltip. Works only with marker-clusters module and analogously to
-     * pointFormat.
+     * (Highcharts, Highstock, Highmaps, Gantt) The HTML of the grouped point's
+     * nodes in the tooltip. Works only for Treemap series grouping and
+     * analogously to pointFormat.
      *
-     * The cluster tooltip can be also formatted using `tooltip.formatter`
-     * callback function and `point.isCluster` flag.
+     * The grouped nodes point tooltip can be also formatted using
+     * `tooltip.formatter` callback function and `point.isGroupNode` flag.
      */
     clusterFormat?: string;
     /**