highcharts 12.0.2 → 12.1.1

package/options/treemap.src.d.ts

@@ -6,224 +6,369 @@
 import * as Highcharts from "../highcharts.src";
 declare module "../highcharts.src" {
     /**
-     * (Highcharts) Point accessibility options for a series.
+     * (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.
      */
-    interface PlotTreemapAccessibilityPointOptions {
+    interface PlotTreemapBreadcrumbsButtonThemeOptions {
+        style?: Highcharts.PlotTreemapBreadcrumbsButtonThemeStyleOptions;
+    }
+    interface PlotTreemapBreadcrumbsEventsOptions {
         /**
-         * (Highcharts) Date format to use for points on datetime axes when
-         * describing them to screen reader users.
+         * (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)
          *
-         * Defaults to the same format as in tooltip.
-         *
-         * For an overview of the replacement codes, see dateFormat.
+         * Return false to stop default buttons click action.
+         */
+        click?: Highcharts.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.
+     */
+    interface PlotTreemapBreadcrumbsPositionOptions {
+        /**
+         * (Highcharts, Highmaps) Horizontal alignment of the breadcrumbs
+         * buttons.
          */
-        dateFormat?: string;
+        align?: Highcharts.AlignValue;
         /**
-         * (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.
+         * (Highcharts, Highmaps) Vertical alignment of the breadcrumbs buttons.
          */
-        dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        verticalAlign?: Highcharts.VerticalAlignValue;
         /**
-         * (Highcharts) Whether or not to describe points with the value `null`
-         * to assistive technology, such as screen readers.
+         * (Highcharts, Highmaps) The X offset of the breadcrumbs button group.
          */
-        describeNull?: boolean;
+        x?: number;
         /**
-         * (Highcharts) A format string to use instead of the default for point
-         * descriptions.
+         * (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.
+         */
+        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.
+     */
+    interface PlotTreemapBreadcrumbsSeparatorStyleOptions {
+        color?: string;
+        fontSize?: number;
+    }
+    interface PlotTreemapClusterMarkerOptions {
+        lineWidth?: number;
+        radius?: number;
+    }
+    /**
+     * (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, Highmaps, Gantt) Styles for the label. The
+     * default `color` setting is `"contrast"`, which is a pseudo color that
+     * Highcharts picks up and applies the maximum contrast to the underlying
+     * point item, for example the bar in a bar chart.
+     *
+     * The `textOutline` is a pseudo property that applies an outline of the
+     * given width with the given color, which by default is the maximum
+     * contrast to the text. So a bright text color will result in a black text
+     * outline for maximum readability on a mixed background. In some cases,
+     * especially with grayscale text, the text outline doesn't work well, in
+     * which cases it can be disabled by setting it to `"none"`. When `useHTML`
+     * is true, the `textOutline` will not be picked up. In this, case, the same
+     * effect can be 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.
+     */
+    interface PlotTreemapDataLabelsStyleOptions {
+        textOverflow?: string;
+    }
+    /**
+     * (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.
+     */
+    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;
+    }
+    /**
+     * (Highcharts) Can set the options of dataLabels on each point which lies
+     * on the level. plotOptions.treemap.dataLabels for possible values.
+     */
+    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?: (Highcharts.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;
+        /**
+         * (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.
          *
-         * The context of the format string is the point instance.
+         * For other animations, see chart.animation and the animation parameter
+         * under the API methods. The following properties are supported:
          *
-         * As opposed to accessibility.point.valueDescriptionFormat, this option
-         * replaces the whole description.
+         * - `defer`: The animation delay time in milliseconds.
          */
-        descriptionFormat?: string;
+        animation?: (boolean|Highcharts.PlotTreemapLevelsDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
         /**
-         * (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.
+         * (Highcharts) The background color or gradient for the data label.
+         * Setting it to `auto` will use the point's color.
          */
-        descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        backgroundColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
         /**
-         * (Highcharts) Decimals to use for the values in the point
-         * descriptions. Uses tooltip.valueDecimals if not defined.
+         * (Highcharts) The border color for the data label. Setting it to
+         * `auto` will use the point's color. Defaults to `undefined`.
          */
-        valueDecimals?: number;
+        borderColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
         /**
-         * (Highcharts) Format to use for describing the values of data points
-         * to assistive technology - including screen readers. The point context
-         * is available as `{point}`.
+         * (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.
          *
-         * Other available context variables include `{index}`, `{value}`, and
-         * `{xDescription}`.
+         * 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.
          *
-         * 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.
+         * @deprecated 10.3.0
          */
-        valueDescriptionFormat?: string;
+        color?: Highcharts.ColorType;
         /**
-         * (Highcharts) Prefix to add to the values in the point descriptions.
-         * Uses tooltip.valuePrefix if not defined.
+         * (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.
          */
-        valuePrefix?: string;
+        crop?: boolean;
         /**
-         * (Highcharts) Suffix to add to the values in the point descriptions.
-         * Uses tooltip.valueSuffix if not defined.
+         * (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.
          */
-        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 {
+        defer?: boolean;
         /**
-         * (Highcharts) The default padding for each button and separator in
-         * each direction.
+         * (Highcharts) Enable or disable the data labels.
          */
-        buttonSpacing?: number;
+        enabled?: 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.
+         * (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.
          */
-        buttonTheme?: (Highcharts.PlotTreemapBreadcrumbsButtonThemeOptions|Highcharts.SVGAttributes);
-        events?: Highcharts.PlotTreemapBreadcrumbsEventsOptions;
+        filter?: Highcharts.DataLabelsFilterOptionsObject;
         /**
-         * (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.
+         * (Highcharts) A format string for the data label. Available variables
+         * are the same as for `formatter`.
          */
-        floating?: boolean;
+        format?: string;
         /**
-         * (Highcharts) A format string for the breadcrumbs button. Variables
-         * are enclosed by curly brackets. Available values are passed in the
-         * declared point options.
+         * (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.
          */
-        format?: (string|undefined);
+        formatter?: Highcharts.DataLabelsFormatterCallbackFunction;
         /**
-         * (Highcharts) Callback function to format the breadcrumb text from
-         * scratch.
+         * (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.
          */
-        formatter?: Highcharts.BreadcrumbsFormatterCallbackFunction;
+        inside?: boolean;
         /**
-         * (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.
+         * (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`.
          */
-        position?: (Highcharts.BreadcrumbsAlignOptions|Highcharts.PlotTreemapBreadcrumbsPositionOptions);
+        nullFormat?: (boolean|string);
         /**
-         * (Highcharts, Highmaps) What box to align the button to. Can be either
-         * `plotBox` or `spacingBox`.
+         * (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`.
          */
-        relativeTo?: Highcharts.ButtonRelativeToValue;
+        nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction;
         /**
-         * (Highcharts) Whether to reverse the order of buttons. This is common
-         * in Arabic and Hebrew.
+         * (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"`.
          */
-        rtl?: boolean;
+        overflow?: Highcharts.DataLabelsOverflowValue;
         /**
-         * (Highcharts) Options object for Breadcrumbs separator.
+         * (Highcharts) When either the `borderWidth` or the `backgroundColor`
+         * is set, this is the padding within the box.
          */
-        separator?: Highcharts.PlotTreemapBreadcrumbsSeparatorOptions;
+        padding?: number;
         /**
-         * (Highcharts) Show full path or only a single button.
+         * (Highcharts) Aligns data labels relative to points. If `center`
+         * alignment is not possible, it defaults to `right`.
          */
-        showFullPath?: boolean;
+        position?: Highcharts.AlignValue;
         /**
-         * (Highcharts) CSS styles for all breadcrumbs.
+         * (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|Highcharts.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?: (Highcharts.CSSObject|Highcharts.PlotTreemapLevelsDataLabelsStyleOptions);
+        /**
+         * (Highcharts) Options for a label text which should follow marker's
+         * shape. Border and background are disabled for a label that follows a
+         * path.
          *
-         * In styled mode, the breadcrumbs buttons are styled by the
-         * `.highcharts-breadcrumbs-buttons .highcharts-button` rule with its
-         * different states.
+         * **Note:** Only SVG-based renderer supports this option. Setting
+         * `useHTML` to true will disable this option.
          */
-        style?: Highcharts.SVGAttributes;
+        textPath?: Highcharts.DataLabelsTextPathOptionsObject;
         /**
-         * (Highcharts) Whether to use HTML to render the breadcrumbs items
-         * texts.
+         * (Highcharts) Whether to use HTML to render the labels.
          */
         useHTML?: boolean;
         /**
-         * (Highcharts) The z index of the breadcrumbs group.
+         * (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.
          */
-        zIndex?: number;
-    }
-    /**
-     * (Highcharts) Options object for Breadcrumbs separator.
-     */
-    interface PlotTreemapBreadcrumbsSeparatorOptions {
+        verticalAlign?: string;
         /**
-         * (Highcharts) CSS styles for the breadcrumbs separator.
-         *
-         * In styled mode, the breadcrumbs separators are styled by the
-         * `.highcharts-separator` rule with its different states.
+         * (Highcharts) The x position offset of the label relative to the point
+         * in pixels.
          */
-        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 {
+        x?: number;
         /**
-         * (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.
+         * (Highcharts) The y position offset of the label relative to the point
+         * in pixels.
          */
-        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 {
+        y?: number;
         /**
-         * (Highcharts) The animation delay time in milliseconds. Set to `0` to
-         * render the data labels immediately. As `undefined` inherits defer
-         * time from the series.animation.defer.
+         * (Highcharts) 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.
          */
-        defer?: number;
+        zIndex?: number;
     }
     /**
      * (Highcharts) Set options on specific levels. Takes precedence over series
@@ -433,6 +578,15 @@ declare module "../highcharts.src" {
          * set
          */
         clip?: boolean;
+        /**
+         * (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.
+         */
+        cluster?: Highcharts.PlotTreemapClusterOptions;
         /**
          * (Highcharts) The main color of the series. In line type series it
          * applies to the line and the point markers unless otherwise specified.

package/options/vbp.d.ts

@@ -102,7 +102,7 @@ declare module "../highcharts" {
          * as given with the inside option. Can be one of `left`, `center` or
          * `right`.
          */
-        align?: (Highcharts.AlignValue|null);
+        align?: string;
         /**
          * (Highcharts, Highstock, Highmaps, Gantt) Alignment method for data
          * labels. If set to `plotEdges`, the labels are aligned within the plot

package/options/vbp.src.d.ts

@@ -102,7 +102,7 @@ declare module "../highcharts.src" {
          * as given with the inside option. Can be one of `left`, `center` or
          * `right`.
          */
-        align?: (Highcharts.AlignValue|null);
+        align?: string;
         /**
          * (Highcharts, Highstock, Highmaps, Gantt) Alignment method for data
          * labels. If set to `plotEdges`, the labels are aligned within the plot

package/package.json

@@ -2,7 +2,7 @@
   "name": "highcharts",
   "description": "JavaScript charting framework",
   "homepage": "http://www.highcharts.com",
-  "version": "12.0.2",
+  "version": "12.1.1",
   "author": "Highsoft AS <support@highcharts.com> (http://www.highcharts.com/about)",
   "main": "highcharts.js",
   "repository": {