highcharts 13.0.0 → 13.0.2

package/options/dpo.src.d.ts

@@ -6,386 +6,50 @@
 import * as Highcharts from "../highcharts.src";
 declare module "../highcharts.src" {
     /**
-     * (Highstock) Point accessibility options for a series.
+     * (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 PlotDpoAccessibilityPointOptions {
-        /**
-         * (Highstock) 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;
-        /**
-         * (Highstock) Formatter function to determine the date/time format used
-         * with points on datetime axes when describing them to screen reader
-         * users. Receives one argument, `point`, referring to the point to
-         * describe. Should return a date format string compatible with
-         * dateFormat.
-         */
-        dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
-        /**
-         * (Highstock) Whether or not to describe points with the value `null`
-         * to assistive technology, such as screen readers.
-         */
-        describeNull?: boolean;
-        /**
-         * (Highstock) 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;
-        /**
-         * (Highstock) Formatter function to use instead of the default for
-         * point descriptions. Same as
-         * `accessibility.point.descriptionFormatter`, but applies to a series
-         * instead of the whole chart.
-         *
-         * Note: Prefer using accessibility.point.valueDescriptionFormat instead
-         * if possible, as default functionality such as describing annotations
-         * will be preserved.
-         */
-        descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
-        /**
-         * (Highstock) Decimals to use for the values in the point descriptions.
-         * Uses tooltip.valueDecimals if not defined.
-         */
-        valueDecimals?: number;
-        /**
-         * (Highstock) 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;
-        /**
-         * (Highstock) Prefix to add to the values in the point descriptions.
-         * Uses tooltip.valuePrefix if not defined.
-         */
-        valuePrefix?: string;
+    interface PlotDpoDataLabelsAnimationOptions {
         /**
-         * (Highstock) Suffix to add to the values in the point descriptions.
-         * Uses tooltip.valueSuffix if not defined.
+         * (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.
          */
-        valueSuffix?: string;
+        defer?: number;
     }
     /**
-     * (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).
+     * (Highcharts, Highstock) Options for series data sorting.
      */
-    interface PlotDpoDataLabelsOptions {
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data
-         * label compared to the point. If `right`, the right side of the label
-         * should be touching the point. For points with an extent, like
-         * columns, the alignments also dictates how to align it inside the box,
-         * as given with the inside option. Can be one of `left`, `center` or
-         * `right`.
-         */
-        align?: (Highcharts.AlignValue|null);
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Alignment method for data
-         * labels. If set to `plotEdges`, the labels are aligned within the plot
-         * area in the direction of the y-axis. So in a regular column chart,
-         * the labels are aligned vertically according to the `verticalAlign`
-         * setting. In a bar chart, which is inverted, the labels are aligned
-         * horizontally according to the `align` setting. Applies to cartesian
-         * series only.
-         */
-        alignTo?: string;
+    interface PlotDpoDataSortingOptions {
         /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels
-         * to overlap. To make the labels less sensitive for overlapping, the
-         * dataLabels.padding can be set to 0.
-         */
-        allowOverlap?: boolean;
-        /**
-         * (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.
-         */
-        animation?: (boolean|Highcharts.PlotDpoDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The background color or
-         * gradient for the data label. In addition to regular colors, there are
-         * two special setting for this option:
-         *
-         * - `auto` will set the background color the point's color.
-         *
-         * - `contrast` will set it to a contrast against the text color, with
-         * an opacity allowing to see the underlying content. The contrast is
-         * great enough to ensure readability for the text according to
-         * accessibility standards.
-         */
-        backgroundColor?: Highcharts.ColorType;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The border color for the
-         * data label. Setting it to `auto` will use the point's color. Defaults
-         * to `undefined`.
-         */
-        borderColor?: Highcharts.ColorType;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels
-         * for the data label.
-         */
-        borderRadius?: number;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels
-         * for the data label.
-         */
-        borderWidth?: number;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data
-         * label. Particularly in styled mode, this can be used to give each
-         * series' or point's data label unique styling. In addition to this
-         * option, a default color class name is added so that we can give the
-         * labels a contrast text shadow.
-         */
-        className?: string;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) 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?: Highcharts.ColorType;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels
-         * that are outside the plot area. By default, the data label is moved
-         * inside the plot area according to the overflow option.
-         */
-        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, Highstock, Gantt) The distance of the data label from
-         * the data point. Note that the `padding` setting also affects the
-         * rendered distance, but is not visible unless the data label has a
-         * border or background.
-         */
-        distance?: number;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
-         * labels.
+         * (Highcharts, Highstock) Enable or disable data sorting for the
+         * series. Use xAxis.reversed to change the sorting order.
          */
         enabled?: boolean;
         /**
-         * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to
-         * control of which data labels to display. The declarative filter is
-         * designed for use when callback functions are not available, like when
-         * the chart options require a pure JSON structure or for use with
-         * graphical editors. For programmatic control, use the `formatter`
-         * instead, and return `undefined` to disable a single data label. (see
-         * online documentation for example)
-         */
-        filter?: Highcharts.DataLabelsFilterOptionsObject;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
-         * label. Available variables are the same as for `formatter`.
-         */
-        format?: string;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
-         * to format the data label. Note that if a `format` is defined, the
-         * format takes precedence and the formatter is ignored.
+         * (Highcharts, Highstock) Whether to allow matching points by name in
+         * an update. If this option is disabled, points will be matched by
+         * order.
          */
-        formatter?: Highcharts.DataLabelsFormatterCallbackFunction;
+        matchByName?: boolean;
         /**
-         * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent,
-         * like columns or map areas, whether to align the data label inside the
-         * box or to the actual value point. Defaults to `false` in most cases,
-         * `true` in stacked columns.
+         * (Highcharts, Highstock) Determines what data value should be used to
+         * sort by.
          */
-        inside?: boolean;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The rank for this point's
-         * data label in case of collision. If two data labels are about to
-         * overlap, only the one with the highest `labelrank` will be drawn.
-         */
-        labelrank?: number;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the
-         * value of null. Works analogously to format. `nullFormat` can be
-         * applied only to series which support displaying null points.
-         * `heatmap` and `tilemap` supports `nullFormat` by default while the
-         * following series requires [#series.nullInteraction] set to `true`:
-         * `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
-         * `timeline`. Does not work with series that don't display null points,
-         * like `pie`.
-         */
-        nullFormat?: (boolean|string);
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
-         * that defines formatting for points with the value of null. Works
-         * analogously to formatter. `nullFormatter` can be applied only to
-         * series which support displaying null points. `heatmap` and `tilemap`
-         * supports `nullFormatter` by default while the following series
-         * requires (series.nullInteraction)[#series.nullInteraction] set to
-         * `true`: `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
-         * `timeline`. Does not work with series that don't display null points,
-         * like `pie`.
-         */
-        nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels
-         * that flow outside the plot area. The default is `"justify"`, which
-         * aligns them inside the plot area. For columns and bars, this means it
-         * will be moved inside the bar. To display data labels outside the plot
-         * area, set `crop` to `false` and `overflow` to `"allow"`.
-         */
-        overflow?: Highcharts.DataLabelsOverflowValue;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) When either the
-         * `borderWidth` or the `backgroundColor` is set, this is the padding
-         * within the box.
-         *
-         * An array of numbers sets padding for the respective sides. An array
-         * of two numbers repeats the values for the horizontal and vertical
-         * sides.
-         */
-        padding?: object;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative
-         * to points. If `center` alignment is not possible, it defaults to
-         * `right`.
-         */
-        position?: Highcharts.AlignValue;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees.
-         * Note that due to a more complex structure, backgrounds, borders and
-         * padding will be lost on a rotated data label.
-         */
-        rotation?: number;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
-         * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow
-         * can be an object configuration containing `color`, `offsetX`,
-         * `offsetY`, `opacity` and `width`.
-         */
-        shadow?: (boolean|Highcharts.ShadowOptionsObject);
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use
-         * for the border around the label. Symbols are predefined functions on
-         * the Renderer object.
-         */
-        shape?: string;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
-         * default `color` setting is `"contrast"`, which is a pseudo color that
-         * Highcharts picks up and applies the maximum contrast to the
-         * underlying point item, for example the bar in a bar chart.
-         *
-         * The `textOutline` is a pseudo property that applies an outline of the
-         * given width with the given color, which by default is the maximum
-         * contrast to the text. So a bright text color will result in a black
-         * text outline for maximum readability on a mixed background. In some
-         * cases, especially with grayscale text, the text outline doesn't work
-         * well, in which cases it can be disabled by setting it to `"none"`.
-         * When `useHTML` is true, the `textOutline` will not be picked up. In
-         * this, case, the same effect can be achieved through the `text-shadow`
-         * CSS property. As a complementary or alternative to the `textOutline`,
-         * a `dataLabels.backgroundColor` can be used. It provides a more calm
-         * impression and ensures readable text label, at the cost of a risk of
-         * overshadowing the underlying chart elements.
-         *
-         * For some series types, where each point has an extent, like for
-         * example tree maps, the data label may overflow the point. There are
-         * two strategies for handling overflow. By default, the text will wrap
-         * to multiple lines. The other strategy is to set `style.textOverflow`
-         * to `ellipsis`, which will keep the text on one line plus it will
-         * break inside long words.
-         */
-        style?: Highcharts.CSSObject;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text
-         * which should follow marker's shape. Border and background are
-         * disabled for a label that follows a path.
-         *
-         * **Note:** Only SVG-based renderer supports this option. Setting
-         * `useHTML` to true will disable this option.
-         *
-         * Text path support is not bundled into `highcharts.js`, and requires
-         * the `modules/textpath.js` file. However, it is included in the script
-         * files of those series types that use it by default.
-         */
-        textPath?: Highcharts.DataLabelsTextPathOptionsObject;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to
-         * render the labels.
-         */
-        useHTML?: boolean;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a
-         * data label. Can be one of `top`, `middle` or `bottom`. The default
-         * value depends on the data, for instance in a column chart, the label
-         * is above positive values and below negative values.
-         */
-        verticalAlign?: (Highcharts.VerticalAlignValue|null);
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
-         * label relative to the point in pixels.
-         */
-        x?: number;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
-         * label relative to the point in pixels.
-         */
-        y?: number;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) The z index of the data
-         * labels group. Does not apply below series level options.
-         *
-         * Use a `zIndex` of 6 to display it above the series, or use a `zIndex`
-         * of 2 to display it behind the series.
-         */
-        zIndex?: number;
+        sortKey?: string;
     }
     /**
-     * (Highcharts, Highstock, Gantt) Styles for the series label. The color
-     * defaults to the series color, or a contrast color if `onArea`.
+     * (Highstock) Animation when hovering over the marker.
      */
-    interface PlotDpoLabelStyleOptions {
-        fontSize?: number;
-        fontWeight?: string;
+    interface PlotDpoMarkerStatesHoverAnimationOptions {
+        duration?: number;
     }
     /**
      * (Highstock) Options for the connector in the _Series on point_ feature.
@@ -453,9 +117,14 @@ declare module "../highcharts.src" {
         period?: number;
     }
     /**
-     * (Highstock) Animation when not hovering over the marker.
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
      */
     interface PlotDpoStatesInactiveAnimationOptions {
+        /**
+         * (Highcharts, Highstock) The duration of the hover animation in
+         * milliseconds. By default the hover state animates quickly in, and
+         * slowly back to normal.
+         */
         duration?: number;
     }
     /**
@@ -509,4 +178,53 @@ declare module "../highcharts.src" {
          */
         y?: number;
     }
+    /**
+     * (Highstock) A Detrended Price Oscillator. 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 `dpo` series are defined in plotOptions.dpo.
+     *
+     * 3. Options for one single series are given in the series instance array.
+     * (see online documentation for example)
+     *
+     * **TypeScript:**
+     *
+     * - type option should always be set, otherwise a broad set of unsupported
+     * options is allowed.
+     *
+     * - when accessing an array of series, the combined set of all series types
+     * is represented by Highcharts.SeriesOptionsType . Narrowing down to the
+     * specific type can be done by checking the `type` property. (see online
+     * documentation for example)
+     *
+     * You have to extend the `SeriesDpoOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesDpoOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesDpoOptions extends Highcharts.PlotDpoOptions, Highcharts.SeriesOptions {
+        /**
+         * Not available
+         */
+        allAreas?: undefined;
+        /**
+         * Not available
+         */
+        dataParser?: undefined;
+        /**
+         * Not available
+         */
+        dataURL?: undefined;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "dpo";
+    }
 }

package/options/dumbbell.d.ts

@@ -35,7 +35,13 @@ declare module "../highcharts" {
     /**
      * (Highcharts, Highstock) Animation when hovering over the marker.
      */
-    interface PlotDumbbellMarkerStatesHoverAnimationOptions {
+    interface PlotDumbbellLowMarkerStatesSelectAnimationOptions {
+        duration?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Animation when hovering over the marker.
+     */
+    interface PlotDumbbellMarkerStatesSelectAnimationOptions {
         duration?: number;
     }
     /**
@@ -333,9 +339,8 @@ declare module "../highcharts" {
         dataGrouping?: Highcharts.DataGroupingOptionsObject;
         /**
          * (Highcharts, Highstock) Extended data labels for range series types.
-         * Range series data labels use no `x` and `y` options. Instead, they
-         * have `xLow`, `xHigh`, `yLow` and `yHigh` options to allow the higher
-         * and lower data label sets individually.
+         * Range series data labels can be positioned individually by defining
+         * them as an array and setting `alignToKey` to `high` or `low`.
          */
         dataLabels?: (Highcharts.SeriesAreaRangeDataLabelsOptionsObject|Array<Highcharts.SeriesAreaRangeDataLabelsOptionsObject>);
         /**
@@ -375,6 +380,15 @@ declare module "../highcharts" {
          * (Highcharts, Highstock) Options for series data sorting.
          */
         dataSorting?: Highcharts.PlotDumbbellDataSortingOptions;
+        /**
+         * (Highcharts, Highstock) Options for a specific series-level data
+         * table or an array of data tables. The `dataTable` option can be
+         * either a configuration object or an instance of the `DataTable`
+         * class. If a `DataTable` instance is passed, it will be used directly.
+         * If a configuration object or an array is passed, a new `DataTable`
+         * instance will be created based on the provided configuration.
+         */
+        dataTable?: (Highcharts.DataTable|Highcharts.DataTableOptionsObject|Array<(Highcharts.DataTable|Highcharts.DataTableOptionsObject)>);
         /**
          * (Highcharts, Highstock) Deprecated. Use
          * plotOptions.series.accessibility.description instead.
@@ -785,6 +799,10 @@ declare module "../highcharts" {
         /**
          * (Highcharts, Highstock) A collection of options for different series
          * states.
+         *
+         * In addition to the options documented under each state, any option
+         * from the parent series type can be set, with exception of `data` and
+         * `states`.
          */
         states?: Highcharts.SeriesStatesOptionsObject;
         /**
@@ -867,6 +885,11 @@ declare module "../highcharts" {
      * (Highcharts, Highstock) Animation when not hovering over the marker.
      */
     interface PlotDumbbellStatesInactiveAnimationOptions {
+        /**
+         * (Highcharts, Highstock) The duration of the hover animation in
+         * milliseconds. By default the hover state animates quickly in, and
+         * slowly back to normal.
+         */
         duration?: number;
     }
     /**

package/options/dumbbell.src.d.ts

@@ -35,7 +35,13 @@ declare module "../highcharts.src" {
     /**
      * (Highcharts, Highstock) Animation when hovering over the marker.
      */
-    interface PlotDumbbellMarkerStatesHoverAnimationOptions {
+    interface PlotDumbbellLowMarkerStatesSelectAnimationOptions {
+        duration?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Animation when hovering over the marker.
+     */
+    interface PlotDumbbellMarkerStatesSelectAnimationOptions {
         duration?: number;
     }
     /**
@@ -333,9 +339,8 @@ declare module "../highcharts.src" {
         dataGrouping?: Highcharts.DataGroupingOptionsObject;
         /**
          * (Highcharts, Highstock) Extended data labels for range series types.
-         * Range series data labels use no `x` and `y` options. Instead, they
-         * have `xLow`, `xHigh`, `yLow` and `yHigh` options to allow the higher
-         * and lower data label sets individually.
+         * Range series data labels can be positioned individually by defining
+         * them as an array and setting `alignToKey` to `high` or `low`.
          */
         dataLabels?: (Highcharts.SeriesAreaRangeDataLabelsOptionsObject|Array<Highcharts.SeriesAreaRangeDataLabelsOptionsObject>);
         /**
@@ -375,6 +380,15 @@ declare module "../highcharts.src" {
          * (Highcharts, Highstock) Options for series data sorting.
          */
         dataSorting?: Highcharts.PlotDumbbellDataSortingOptions;
+        /**
+         * (Highcharts, Highstock) Options for a specific series-level data
+         * table or an array of data tables. The `dataTable` option can be
+         * either a configuration object or an instance of the `DataTable`
+         * class. If a `DataTable` instance is passed, it will be used directly.
+         * If a configuration object or an array is passed, a new `DataTable`
+         * instance will be created based on the provided configuration.
+         */
+        dataTable?: (Highcharts.DataTable|Highcharts.DataTableOptionsObject|Array<(Highcharts.DataTable|Highcharts.DataTableOptionsObject)>);
         /**
          * (Highcharts, Highstock) Deprecated. Use
          * plotOptions.series.accessibility.description instead.
@@ -785,6 +799,10 @@ declare module "../highcharts.src" {
         /**
          * (Highcharts, Highstock) A collection of options for different series
          * states.
+         *
+         * In addition to the options documented under each state, any option
+         * from the parent series type can be set, with exception of `data` and
+         * `states`.
          */
         states?: Highcharts.SeriesStatesOptionsObject;
         /**
@@ -867,6 +885,11 @@ declare module "../highcharts.src" {
      * (Highcharts, Highstock) Animation when not hovering over the marker.
      */
     interface PlotDumbbellStatesInactiveAnimationOptions {
+        /**
+         * (Highcharts, Highstock) The duration of the hover animation in
+         * milliseconds. By default the hover state animates quickly in, and
+         * slowly back to normal.
+         */
         duration?: number;
     }
     /**