highcharts 12.0.0 → 12.0.2

package/options/treemap.src.d.ts

@@ -0,0 +1,964 @@
+/*!*
+ *
+ *  Copyright (c) Highsoft AS. All rights reserved.
+ *
+ *!*/
+import * as Highcharts from "../highcharts.src";
+declare module "../highcharts.src" {
+    /**
+     * (Highcharts) Point accessibility options for a series.
+     */
+    interface PlotTreemapAccessibilityPointOptions {
+        /**
+         * (Highcharts) Date format to use for points on datetime axes when
+         * describing them to screen reader users.
+         *
+         * Defaults to the same format as in tooltip.
+         *
+         * For an overview of the replacement codes, see dateFormat.
+         */
+        dateFormat?: string;
+        /**
+         * (Highcharts) Formatter function to determine the date/time format
+         * used with points on datetime axes when describing them to screen
+         * reader users. Receives one argument, `point`, referring to the point
+         * to describe. Should return a date format string compatible with
+         * dateFormat.
+         */
+        dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        /**
+         * (Highcharts) Whether or not to describe points with the value `null`
+         * to assistive technology, such as screen readers.
+         */
+        describeNull?: boolean;
+        /**
+         * (Highcharts) A format string to use instead of the default for point
+         * descriptions.
+         *
+         * The context of the format string is the point instance.
+         *
+         * As opposed to accessibility.point.valueDescriptionFormat, this option
+         * replaces the whole description.
+         */
+        descriptionFormat?: string;
+        /**
+         * (Highcharts) Formatter function to use instead of the default for
+         * point descriptions. Same as
+         * `accessibility.point.descriptionFormatter`, but applies to a series
+         * instead of the whole chart.
+         *
+         * Note: Prefer using accessibility.point.valueDescriptionFormat instead
+         * if possible, as default functionality such as describing annotations
+         * will be preserved.
+         */
+        descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        /**
+         * (Highcharts) Decimals to use for the values in the point
+         * descriptions. Uses tooltip.valueDecimals if not defined.
+         */
+        valueDecimals?: number;
+        /**
+         * (Highcharts) Format to use for describing the values of data points
+         * to assistive technology - including screen readers. The point context
+         * is available as `{point}`.
+         *
+         * Other available context variables include `{index}`, `{value}`, and
+         * `{xDescription}`.
+         *
+         * Additionally, the series name, annotation info, and description added
+         * in `point.accessibility.description` is added by default if relevant.
+         * To override this, use the accessibility.point.descriptionFormatter
+         * option.
+         */
+        valueDescriptionFormat?: string;
+        /**
+         * (Highcharts) Prefix to add to the values in the point descriptions.
+         * Uses tooltip.valuePrefix if not defined.
+         */
+        valuePrefix?: string;
+        /**
+         * (Highcharts) Suffix to add to the values in the point descriptions.
+         * Uses tooltip.valueSuffix if not defined.
+         */
+        valueSuffix?: string;
+    }
+    interface PlotTreemapBreadcrumbsButtonThemeStyleOptions {
+        color?: string;
+    }
+    /**
+     * (Highcharts) Options for the breadcrumbs, the navigation at the top
+     * leading the way up through the traversed levels.
+     */
+    interface PlotTreemapBreadcrumbsOptions {
+        /**
+         * (Highcharts) The default padding for each button and separator in
+         * each direction.
+         */
+        buttonSpacing?: number;
+        /**
+         * (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.
+         */
+        buttonTheme?: (Highcharts.PlotTreemapBreadcrumbsButtonThemeOptions|Highcharts.SVGAttributes);
+        events?: Highcharts.PlotTreemapBreadcrumbsEventsOptions;
+        /**
+         * (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.
+         */
+        floating?: boolean;
+        /**
+         * (Highcharts) A format string for the breadcrumbs button. Variables
+         * are enclosed by curly brackets. Available values are passed in the
+         * declared point options.
+         */
+        format?: (string|undefined);
+        /**
+         * (Highcharts) Callback function to format the breadcrumb text from
+         * scratch.
+         */
+        formatter?: Highcharts.BreadcrumbsFormatterCallbackFunction;
+        /**
+         * (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.
+         */
+        position?: (Highcharts.BreadcrumbsAlignOptions|Highcharts.PlotTreemapBreadcrumbsPositionOptions);
+        /**
+         * (Highcharts, Highmaps) What box to align the button to. Can be either
+         * `plotBox` or `spacingBox`.
+         */
+        relativeTo?: Highcharts.ButtonRelativeToValue;
+        /**
+         * (Highcharts) Whether to reverse the order of buttons. This is common
+         * in Arabic and Hebrew.
+         */
+        rtl?: boolean;
+        /**
+         * (Highcharts) Options object for Breadcrumbs separator.
+         */
+        separator?: Highcharts.PlotTreemapBreadcrumbsSeparatorOptions;
+        /**
+         * (Highcharts) Show full path or only a single button.
+         */
+        showFullPath?: boolean;
+        /**
+         * (Highcharts) CSS styles for all breadcrumbs.
+         *
+         * In styled mode, the breadcrumbs buttons are styled by the
+         * `.highcharts-breadcrumbs-buttons .highcharts-button` rule with its
+         * different states.
+         */
+        style?: Highcharts.SVGAttributes;
+        /**
+         * (Highcharts) Whether to use HTML to render the breadcrumbs items
+         * texts.
+         */
+        useHTML?: boolean;
+        /**
+         * (Highcharts) The z index of the breadcrumbs group.
+         */
+        zIndex?: number;
+    }
+    /**
+     * (Highcharts) Options object for Breadcrumbs separator.
+     */
+    interface PlotTreemapBreadcrumbsSeparatorOptions {
+        /**
+         * (Highcharts) CSS styles for the breadcrumbs separator.
+         *
+         * In styled mode, the breadcrumbs separators are styled by the
+         * `.highcharts-separator` rule with its different states.
+         */
+        style?: (Highcharts.CSSObject|Highcharts.PlotTreemapBreadcrumbsSeparatorStyleOptions);
+        text?: string;
+    }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
+     * animation when a series is displayed for the `dataLabels`. The animation
+     * can also be set as a configuration object. Please note that this option
+     * only applies to the initial animation.
+     *
+     * For other animations, see chart.animation and the animation parameter
+     * under the API methods. The following properties are supported:
+     *
+     * - `defer`: The animation delay time in milliseconds.
+     */
+    interface PlotTreemapDataLabelsAnimationOptions {
+        /**
+         * (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 PlotTreemapLabelStyleOptions {
+        fontSize?: (number|string);
+    }
+    /**
+     * (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.
+     */
+    interface PlotTreemapLevelsDataLabelsAnimationOptions {
+        /**
+         * (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.
+         */
+        defer?: number;
+    }
+    /**
+     * (Highcharts) Set options on specific levels. Takes precedence over series
+     * options, but not point options.
+     */
+    interface PlotTreemapLevelsOptions {
+        /**
+         * (Highcharts) Can set a `borderColor` on all points which lies on the
+         * same level.
+         */
+        borderColor?: Highcharts.ColorString;
+        /**
+         * (Highcharts) Set the dash style of the border of all the point which
+         * lies on the level. See plotOptions.scatter.dashStyle for possible
+         * options.
+         */
+        borderDashStyle?: Highcharts.DashStyleValue;
+        /**
+         * (Highcharts) Can set the borderWidth on all points which lies on the
+         * same level.
+         */
+        borderWidth?: number;
+        /**
+         * (Highcharts) Can set a color on all points which lies on the same
+         * level.
+         */
+        color?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
+        /**
+         * (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.
+         */
+        colorVariation?: Highcharts.PlotTreemapLevelsColorVariationOptions;
+        /**
+         * (Highcharts) Can set the options of dataLabels on each point which
+         * lies on the level. plotOptions.treemap.dataLabels for possible
+         * values.
+         */
+        dataLabels?: (Highcharts.PlotTreemapLevelsDataLabelsOptions|Array<Highcharts.PlotTreemapLevelsDataLabelsOptions>);
+        /**
+         * (Highcharts) Can set the layoutAlgorithm option on a specific level.
+         */
+        layoutAlgorithm?: Highcharts.OptionsLayoutAlgorithmValue;
+        /**
+         * (Highcharts) Can set the layoutStartingDirection option on a specific
+         * level.
+         */
+        layoutStartingDirection?: Highcharts.OptionsLayoutStartingDirectionValue;
+        /**
+         * (Highcharts) Decides which level takes effect from the options set in
+         * the levels object.
+         */
+        level?: number;
+    }
+    /**
+     * (Highcharts) Options for the _Series on point_ feature. Only `pie` and
+     * `sunburst` series are supported at this moment.
+     */
+    interface PlotTreemapOnPointOptions {
+        /**
+         * (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?: (Highcharts.PlotTreemapOnPointConnectorOptions|Highcharts.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|Highcharts.PlotTreemapOnPointPositionOptions);
+    }
+    /**
+     * (Highcharts) A treemap displays hierarchical data using nested
+     * rectangles. The data can be laid out in varying ways depending on
+     * options.
+     *
+     * 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 `treemap` series are defined in plotOptions.treemap.
+     *
+     * 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)
+     */
+    interface PlotTreemapOptions {
+        /**
+         * (Highcharts) Accessibility options for a series.
+         */
+        accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
+        /**
+         * (Highcharts) Allow this series' points to be selected by clicking on
+         * the graphic (columns, point markers, pie slices, map areas etc).
+         *
+         * The 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) When enabled the user can click on a point which is a
+         * parent and zoom in on its children.
+         */
+        allowTraversingTree?: boolean;
+        /**
+         * (Highcharts) Enabling this option will make the treemap alternate the
+         * drawing direction between vertical and horizontal. The next levels
+         * starting direction will always be the opposite of the previous.
+         */
+        alternateStartingDirection?: 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|Highcharts.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?: Highcharts.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) The border radius for each treemap item.
+         */
+        borderRadius?: number;
+        /**
+         * (Highcharts) Options for the breadcrumbs, the navigation at the top
+         * leading the way up through the traversed levels.
+         */
+        breadcrumbs?: Highcharts.PlotTreemapBreadcrumbsOptions;
+        /**
+         * (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.
+         */
+        className?: string;
+        /**
+         * (Highcharts) Disable this option to allow series rendering in the
+         * whole plotting area.
+         *
+         * **Note:** Clipping should be always enabled when chart.zoomType is
+         * set
+         */
+        clip?: boolean;
+        /**
+         * (Highcharts) The main color of the series. In line type series it
+         * applies to the line and the point markers unless otherwise specified.
+         * In bar type series it applies to the bars unless a color is specified
+         * per point. The default value is pulled from the `options.colors`
+         * array.
+         *
+         * In styled mode, the color can be defined by the colorIndex option.
+         * Also, the series color can be set with the `.highcharts-series`,
+         * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
+         * `.highcharts-series-{n}` class, or individual classes given by the
+         * `className` option.
+         */
+        color?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
+        /**
+         * (Highcharts, Highstock, Highmaps) When using dual or multiple color
+         * axes, this number defines which colorAxis the particular series is
+         * connected to. It refers to either the axis id or the index of the
+         * axis in the colorAxis array, with 0 being the first. Set this option
+         * to false to prevent a series from connecting to the default color
+         * axis.
+         *
+         * Since v7.2.0 the option can also be an axis id or an axis index
+         * instead of a boolean flag.
+         */
+        colorAxis?: (boolean|number|string);
+        /**
+         * (Highcharts) 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.
+         */
+        colorByPoint?: boolean;
+        /**
+         * (Highcharts) Styled mode only. A specific color index to use for the
+         * series, so its graphic representations are given the class name
+         * `highcharts-color-{n}`.
+         *
+         * Since v11, CSS variables on the form `--highcharts-color-{n}` make
+         * changing the color scheme very convenient.
+         */
+        colorIndex?: number;
+        /**
+         * (Highcharts, Highstock, 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'`.
+         */
+        colorKey?: string;
+        /**
+         * (Highcharts) A series specific or series type specific color set to
+         * apply instead of the global colors when colorByPoint is true.
+         */
+        colors?: Array<(Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject)>;
+        /**
+         * (Highcharts, Highstock, Gantt) When true, each point or column edge
+         * is rounded to its nearest pixel in order to render sharp on screen.
+         * In some cases, when there are a lot of densely packed columns, this
+         * leads to visible difference in column widths or distance between
+         * columns. In these cases, setting `crisp` to `false` may look better,
+         * even though each column is rendered blurry.
+         */
+        crisp?: boolean;
+        /**
+         * (Highcharts) 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.
+         */
+        cropThreshold?: number;
+        /**
+         * (Highcharts) You can set the cursor to "pointer" if you have click
+         * events attached to the series, to signal to the user that the points
+         * and lines can be clicked.
+         *
+         * In styled mode, the series cursor can be set with the same classes as
+         * listed under series.color.
+         */
+        cursor?: (string|Highcharts.CursorValue);
+        /**
+         * (Highcharts) A reserved subspace to store options and values for
+         * customized functionality. Here you can add additional data for your
+         * own event callbacks and formatter callbacks.
+         */
+        custom?: Highcharts.Dictionary<any>;
+        /**
+         * (Highcharts) Name of the dash style to use for the graph, or for some
+         * series types the outline of each shape.
+         *
+         * In styled mode, the stroke dash-array can be set with the same
+         * classes as listed under series.color.
+         */
+        dashStyle?: Highcharts.DashStyleValue;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Options for the 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.PlotTreemapDataLabelsOptions|Array<Highcharts.PlotTreemapDataLabelsOptions>);
+        /**
+         * (Highcharts) A description of the series to add to the screen reader
+         * information about the series.
+         */
+        description?: string;
+        /**
+         * (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.
+         */
+        enableMouseTracking?: boolean;
+        /**
+         * (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.
+         */
+        events?: Highcharts.SeriesEventsOptionsObject;
+        /**
+         * (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.
+         *
+         * Applies only to series types using nearest neighbor search (not
+         * direct hover) for tooltip.
+         */
+        findNearestPointBy?: Highcharts.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) Whether to ignore hidden points when the layout
+         * algorithm runs. If `false`, hidden points will leave open spaces.
+         */
+        ignoreHiddenPoint?: boolean;
+        /**
+         * (Highcharts) Highlight only the hovered point and fade the remaining
+         * points.
+         *
+         * Scatter-type series require enabling the 'inactive' marker state and
+         * adjusting opacity. Note that this approach could affect performance
+         * with large datasets.
+         */
+        inactiveOtherPoints?: boolean;
+        /**
+         * (Highcharts) When set to `false` will prevent the series data from
+         * being included in any form of data export.
+         *
+         * Since version 6.0.0 until 7.1.0 the option was existing undocumented
+         * as `includeInCSVExport`.
+         */
+        includeInDataExport?: boolean;
+        /**
+         * (Highcharts) This option decides if the user can interact with the
+         * parent nodes or just the leaf nodes. When this option is undefined,
+         * it will be true by default. However when allowTraversingTree is true,
+         * then it will be false by default.
+         */
+        interactByLeaf?: boolean;
+        /**
+         * (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.
+         */
+        keys?: Array<string>;
+        /**
+         * (Highcharts, Highstock, Gantt) Series labels are placed as close to
+         * the series as possible in a natural way, seeking to avoid other
+         * series. The goal of this feature is to make the chart more easily
+         * readable, like if a human designer placed the labels in the optimal
+         * position.
+         *
+         * The series labels currently work with series types having a `graph`
+         * or an `area`.
+         */
+        label?: Highcharts.SeriesLabelOptionsObject;
+        /**
+         * (Highcharts) This option decides which algorithm is used for setting
+         * position and dimensions of the points.
+         */
+        layoutAlgorithm?: Highcharts.OptionsLayoutAlgorithmValue;
+        /**
+         * (Highcharts) Defines which direction the layout algorithm will start
+         * drawing.
+         */
+        layoutStartingDirection?: Highcharts.OptionsLayoutStartingDirectionValue;
+        /**
+         * (Highcharts) What type of legend symbol to render for this series.
+         * Can be one of `areaMarker`, `lineMarker` or `rectangle`.
+         */
+        legendSymbol?: Highcharts.OptionsLegendSymbolValue;
+        /**
+         * (Highcharts) Used together with the levels and allowTraversingTree
+         * options. When set to false the first level visible to be level one,
+         * which is dynamic when traversing the tree. Otherwise the level will
+         * be the same as the tree structure.
+         */
+        levelIsConstant?: boolean;
+        /**
+         * (Highcharts) Set options on specific levels. Takes precedence over
+         * series options, but not point options.
+         */
+        levels?: Array<Highcharts.PlotTreemapLevelsOptions>;
+        /**
+         * (Highcharts, Highstock) The SVG value used for the `stroke-linecap`
+         * and `stroke-linejoin` of a line graph. Round means that lines are
+         * rounded in the ends and bends.
+         */
+        linecap?: Highcharts.SeriesLinecapValue;
+        /**
+         * (Highcharts, Highstock) The width of the line connecting the data
+         * points.
+         */
+        lineWidth?: number;
+        /**
+         * (Highcharts, Highstock, Gantt) The id of another series to link to.
+         * Additionally, the value can be ":previous" to link to the previous
+         * series. When two series are linked, only the first one appears in the
+         * legend. Toggling the visibility of this also toggles the linked
+         * series.
+         *
+         * If master series uses data sorting and linked series does not have
+         * its own sorting definition, the linked series will be sorted in the
+         * same order as the master one.
+         */
+        linkedTo?: string;
+        /**
+         * (Highcharts) The color for the parts of the graph or points that are
+         * below the threshold. Note that `zones` takes precedence over the
+         * negative color. Using `negativeColor` is equivalent to applying a
+         * zone with value of 0.
+         */
+        negativeColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
+        /**
+         * (Highcharts) Options for the _Series on point_ feature. Only `pie`
+         * and `sunburst` series are supported at this moment.
+         */
+        onPoint?: (object|Highcharts.PlotTreemapOnPointOptions);
+        /**
+         * (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?: Highcharts.PlotSeriesPointOptions;
+        /**
+         * (Highcharts) Same as accessibility.point.descriptionFormat, but for
+         * an individual series. Overrides the chart wide configuration.
+         */
+        pointDescriptionFormat?: Function;
+        /**
+         * (Highcharts) Same as accessibility.series.descriptionFormatter, but
+         * for an individual series. Overrides the chart wide configuration.
+         */
+        pointDescriptionFormatter?: Function;
+        /**
+         * (Highcharts, Highstock, Gantt) If no x values are given for the
+         * points in a series, `pointInterval` defines the interval of the x
+         * values. For example, if a series contains one value every decade
+         * starting from year 0, set `pointInterval` to `10`. In true `datetime`
+         * axes, the `pointInterval` is set in milliseconds.
+         *
+         * It can be also be combined with `pointIntervalUnit` to draw irregular
+         * time intervals.
+         *
+         * If combined with `relativeXValue`, an x value can be set on each
+         * point, and the `pointInterval` is added x times to the `pointStart`
+         * setting.
+         *
+         * Please note that this options applies to the _series data_, not the
+         * interval of the axis ticks, which is independent.
+         */
+        pointInterval?: number;
+        /**
+         * (Highcharts, Highstock, Gantt) On datetime series, this allows for
+         * setting the pointInterval to irregular time units, `day`, `month` and
+         * `year`. A day is usually the same as 24 hours, but
+         * `pointIntervalUnit` also takes the DST crossover into consideration
+         * when dealing with local time. Combine this option with
+         * `pointInterval` to draw weeks, quarters, 6 months, 10 years etc.
+         *
+         * Please note that this options applies to the _series data_, not the
+         * interval of the axis ticks, which is independent.
+         */
+        pointIntervalUnit?: Highcharts.OptionsPointIntervalUnitValue;
+        /**
+         * (Highcharts, Highstock, Gantt) If no x values are given for the
+         * points in a series, `pointStart` defines on what value to start. For
+         * example, if a series contains one yearly value starting from 1945,
+         * set `pointStart` to 1945.
+         *
+         * The `pointStart` setting can be a number, or a datetime string that
+         * is parsed according to the `time.timezone` setting.
+         *
+         * If combined with `relativeXValue`, an x value can be set on each
+         * point. The x value from the point options is multiplied by
+         * `pointInterval` and added to `pointStart` to produce a modified x
+         * value.
+         */
+        pointStart?: (number|string);
+        /**
+         * (Highcharts, Highstock) When true, X values in the data set are
+         * relative to the current `pointStart`, `pointInterval` and
+         * `pointIntervalUnit` settings. This allows compression of the data for
+         * datasets with irregular X values.
+         *
+         * The real X values are computed on the formula `f(x) = ax + b`, where
+         * `a` is the `pointInterval` (optionally with a time unit given by
+         * `pointIntervalUnit`), and `b` is the `pointStart`.
+         */
+        relativeXValue?: boolean;
+        /**
+         * (Highcharts) Whether to select the series initially. If
+         * `showCheckbox` is true, the checkbox next to the series name in the
+         * legend will be checked for a selected series.
+         */
+        selected?: boolean;
+        /**
+         * (Highcharts) If true, a checkbox is displayed next to the legend item
+         * to allow selecting the series. The state of the checkbox is
+         * determined by the `selected` option.
+         */
+        showCheckbox?: boolean;
+        /**
+         * (Highcharts) Whether to display this series type or specific series
+         * item in the legend.
+         */
+        showInLegend?: boolean;
+        /**
+         * (Highcharts) If set to `true`, the accessibility module will skip
+         * past the points in this series for keyboard navigation.
+         */
+        skipKeyboardNavigation?: 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.
+         */
+        softThreshold?: boolean;
+        /**
+         * (Highcharts) Sonification/audio chart options for a series.
+         */
+        sonification?: Highcharts.SeriesSonificationOptions;
+        /**
+         * (Highcharts) The sort index of the point inside the treemap level.
+         */
+        sortIndex?: number;
+        /**
+         * (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.
+         *
+         * 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?: Highcharts.OptionsStackingValue;
+        /**
+         * (Highcharts) A wrapper object for all the series options in specific
+         * states.
+         */
+        states?: Highcharts.SeriesStatesOptionsObject;
+        /**
+         * (Highcharts, Highstock) Whether to apply steps to the line. Possible
+         * values are `left`, `center` and `right`.
+         */
+        step?: Highcharts.OptionsStepValue;
+        /**
+         * (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.
+         */
+        stickyTracking?: boolean;
+        /**
+         * (Highcharts, Highstock) The threshold, also called zero level or base
+         * level. For line type series this is only used in conjunction with
+         * negativeColor.
+         */
+        threshold?: (number|null);
+        /**
+         * (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.
+         */
+        tooltip?: Highcharts.SeriesTooltipOptionsObject;
+        /**
+         * (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.
+         */
+        traverseToLeaf?: boolean;
+        /**
+         * (Highcharts, Highstock, Gantt) When a series contains a `data` array
+         * that is longer than this, the Series class looks for data
+         * configurations of plain numbers or arrays of numbers. The first and
+         * last valid points are checked. If found, the rest of the data is
+         * assumed to be the same. This saves expensive data checking and
+         * indexing in long series, and makes data-heavy charts render faster.
+         *
+         * Set it to `0` disable.
+         *
+         * Note:
+         *
+         * - In boost mode turbo threshold is forced. Only array of numbers or
+         * two dimensional arrays are allowed.
+         *
+         * - In version 11.4.3 and earlier, if object configurations were passed
+         * beyond the turbo threshold, a warning was logged in the console and
+         * the data series didn't render.
+         */
+        turboThreshold?: number;
+        /**
+         * (Highcharts) Set the initial visibility of the series.
+         */
+        visible?: boolean;
+        /**
+         * (Highcharts, Highstock) Defines the Axis on which the zones are
+         * applied.
+         */
+        zoneAxis?: string;
+        /**
+         * (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).
+         */
+        zones?: Array<Highcharts.SeriesZonesOptionsObject>;
+    }
+    /**
+     * (Highcharts) A `treemap` series. If the type option is not specified, it
+     * is inherited from chart.type.
+     *
+     * Configuration options for the series are given in three levels:
+     *
+     * 1. Options for all series in a chart are defined in the
+     * plotOptions.series object.
+     *
+     * 2. Options for all `treemap` series are defined in plotOptions.treemap.
+     *
+     * 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)
+     *
+     * You have to extend the `SeriesTreemapOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesTreemapOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesTreemapOptions extends Highcharts.PlotTreemapOptions, Highcharts.SeriesOptions {
+        /**
+         * (Highcharts) An array of data points for the series. For the
+         * `treemap` series type, points can be given in the following ways:
+         *
+         * 1. An array of numerical values. In this case, the numerical values
+         * will be interpreted as `value` options. Example: (see online
+         * documentation for example)
+         *
+         * 2. An array of objects with named values. The following snippet shows
+         * only a few settings, see the complete options set below. If the total
+         * number of data points exceeds the series' turboThreshold, this option
+         * is not available. (see online documentation for example)
+         */
+        data?: Array<(number|null|Highcharts.PointOptionsObject)>;
+        /**
+         * Not available
+         */
+        dataParser?: undefined;
+        /**
+         * Not available
+         */
+        dataURL?: 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.
+         */
+        type: "treemap";
+    }
+}