highcharts 13.0.0 → 13.0.2

package/options/timeline.d.ts

@@ -6,118 +6,36 @@
 import * as Highcharts from "../highcharts";
 declare module "../highcharts" {
     /**
-     * (Highcharts) 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 PlotTimelineAccessibilityPointOptions {
-        /**
-         * (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>;
+    interface PlotTimelineDataLabelsAnimationOptions {
         /**
-         * (Highcharts) Whether or not to describe points with the value `null`
-         * to assistive technology, such as screen readers.
+         * (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.
          */
-        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;
+        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 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.
+     * (Highcharts, Highstock, Gantt) Styles for the series label. The color
+     * defaults to the series color, or a contrast color if `onArea`.
      */
-    interface PlotTimelineDataLabelsStyleOptions {
+    interface PlotTimelineLabelStyleOptions {
         fontSize?: number;
         fontWeight?: string;
-        textAlign?: string;
-        textOutline?: string;
     }
     /**
      * (Highcharts) Animation when hovering over the marker.
      */
-    interface PlotTimelineMarkerStatesHoverAnimationOptions {
+    interface PlotTimelineMarkerStatesSelectAnimationOptions {
         duration?: number;
     }
     /**
@@ -332,6 +250,15 @@ declare module "../highcharts" {
          * documentation for example)
          */
         dataMapping?: Highcharts.DataMappingOptionsObject;
+        /**
+         * (Highcharts) 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) Deprecated. Use
          * plotOptions.series.accessibility.description instead.
@@ -573,6 +500,10 @@ declare module "../highcharts" {
         sonification?: Highcharts.SeriesSonificationOptions;
         /**
          * (Highcharts) 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;
         /**
@@ -610,9 +541,14 @@ declare module "../highcharts" {
         zoomEnabled?: boolean;
     }
     /**
-     * (Highcharts) Animation when not hovering over the marker.
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
      */
     interface PlotTimelineStatesInactiveAnimationOptions {
+        /**
+         * (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;
     }
     /**
@@ -667,63 +603,22 @@ declare module "../highcharts" {
         y?: number;
     }
     /**
-     * (Highcharts) The `timeline` 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 `timeline` series are defined in plotOptions.timeline.
-     *
-     * 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)
+     * (Highcharts, Highstock, Gantt) Enable or disable the initial animation
+     * when a series is displayed for the `dataLabels`. The animation can also
+     * be set as a configuration object. Please note that this option only
+     * applies to the initial animation.
      *
-     * You have to extend the `SeriesTimelineOptions` via an interface to allow
-     * custom properties: ``` declare interface SeriesTimelineOptions {
-     * customProperty: string; }
+     * For other animations, see chart.animation and the animation parameter
+     * under the API methods. The following properties are supported:
      *
+     * - `defer`: The animation delay time in milliseconds.
      */
-    interface SeriesTimelineOptions extends Highcharts.PlotTimelineOptions, Highcharts.SeriesOptions {
-        /**
-         * (Highcharts) An array of data points for the series. For the
-         * `timeline` series type, points can be given with three general
-         * parameters, `name`, `label`, and `description`:
-         *
-         * Example: (see online documentation for example) If all points
-         * additionally have the `x` values, and xAxis type is set to
-         * `datetime`, then events are laid out on a true time axis, where their
-         * placement reflects the actual time between them.
-         */
-        data?: Array<Highcharts.PointOptionsObject>;
-        /**
-         * Not available
-         */
-        dataParser?: undefined;
-        /**
-         * Not available
-         */
-        dataURL?: undefined;
-        /**
-         * Not available
-         */
-        stack?: undefined;
+    interface SeriesTimelineDataDataLabelsAnimationOptions {
         /**
-         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
-         * TypeScript non-optional and might be `undefined` in series objects
-         * from unknown sources.
+         * (Highcharts, Highstock, Gantt) The animation delay time in
+         * milliseconds. Set to `0` to render the data labels immediately. As
+         * `undefined` inherits defer time from the series.animation.defer.
          */
-        type: "timeline";
+        defer?: number;
     }
 }

package/options/timeline.src.d.ts

@@ -6,118 +6,36 @@
 import * as Highcharts from "../highcharts.src";
 declare module "../highcharts.src" {
     /**
-     * (Highcharts) 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 PlotTimelineAccessibilityPointOptions {
-        /**
-         * (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>;
+    interface PlotTimelineDataLabelsAnimationOptions {
         /**
-         * (Highcharts) Whether or not to describe points with the value `null`
-         * to assistive technology, such as screen readers.
+         * (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.
          */
-        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;
+        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 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.
+     * (Highcharts, Highstock, Gantt) Styles for the series label. The color
+     * defaults to the series color, or a contrast color if `onArea`.
      */
-    interface PlotTimelineDataLabelsStyleOptions {
+    interface PlotTimelineLabelStyleOptions {
         fontSize?: number;
         fontWeight?: string;
-        textAlign?: string;
-        textOutline?: string;
     }
     /**
      * (Highcharts) Animation when hovering over the marker.
      */
-    interface PlotTimelineMarkerStatesHoverAnimationOptions {
+    interface PlotTimelineMarkerStatesSelectAnimationOptions {
         duration?: number;
     }
     /**
@@ -332,6 +250,15 @@ declare module "../highcharts.src" {
          * documentation for example)
          */
         dataMapping?: Highcharts.DataMappingOptionsObject;
+        /**
+         * (Highcharts) 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) Deprecated. Use
          * plotOptions.series.accessibility.description instead.
@@ -573,6 +500,10 @@ declare module "../highcharts.src" {
         sonification?: Highcharts.SeriesSonificationOptions;
         /**
          * (Highcharts) 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;
         /**
@@ -610,9 +541,14 @@ declare module "../highcharts.src" {
         zoomEnabled?: boolean;
     }
     /**
-     * (Highcharts) Animation when not hovering over the marker.
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
      */
     interface PlotTimelineStatesInactiveAnimationOptions {
+        /**
+         * (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;
     }
     /**
@@ -667,63 +603,22 @@ declare module "../highcharts.src" {
         y?: number;
     }
     /**
-     * (Highcharts) The `timeline` 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 `timeline` series are defined in plotOptions.timeline.
-     *
-     * 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)
+     * (Highcharts, Highstock, Gantt) Enable or disable the initial animation
+     * when a series is displayed for the `dataLabels`. The animation can also
+     * be set as a configuration object. Please note that this option only
+     * applies to the initial animation.
      *
-     * You have to extend the `SeriesTimelineOptions` via an interface to allow
-     * custom properties: ``` declare interface SeriesTimelineOptions {
-     * customProperty: string; }
+     * For other animations, see chart.animation and the animation parameter
+     * under the API methods. The following properties are supported:
      *
+     * - `defer`: The animation delay time in milliseconds.
      */
-    interface SeriesTimelineOptions extends Highcharts.PlotTimelineOptions, Highcharts.SeriesOptions {
-        /**
-         * (Highcharts) An array of data points for the series. For the
-         * `timeline` series type, points can be given with three general
-         * parameters, `name`, `label`, and `description`:
-         *
-         * Example: (see online documentation for example) If all points
-         * additionally have the `x` values, and xAxis type is set to
-         * `datetime`, then events are laid out on a true time axis, where their
-         * placement reflects the actual time between them.
-         */
-        data?: Array<Highcharts.PointOptionsObject>;
-        /**
-         * Not available
-         */
-        dataParser?: undefined;
-        /**
-         * Not available
-         */
-        dataURL?: undefined;
-        /**
-         * Not available
-         */
-        stack?: undefined;
+    interface SeriesTimelineDataDataLabelsAnimationOptions {
         /**
-         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
-         * TypeScript non-optional and might be `undefined` in series objects
-         * from unknown sources.
+         * (Highcharts, Highstock, Gantt) The animation delay time in
+         * milliseconds. Set to `0` to render the data labels immediately. As
+         * `undefined` inherits defer time from the series.animation.defer.
          */
-        type: "timeline";
+        defer?: number;
     }
 }