highcharts 13.0.0 → 13.0.2

package/options/vector.src.d.ts

@@ -372,7 +372,7 @@ declare module "../highcharts.src" {
          * of two numbers repeats the values for the horizontal and vertical
          * sides.
          */
-        padding?: object;
+        padding?: (number|Array<number>);
         /**
          * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative
          * to points. If `center` alignment is not possible, it defaults to
@@ -766,6 +766,15 @@ declare module "../highcharts.src" {
          * (Highcharts, Highstock) Options for series data sorting.
          */
         dataSorting?: Highcharts.PlotVectorDataSortingOptions;
+        /**
+         * (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.
@@ -1058,6 +1067,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;
         /**
@@ -1146,6 +1159,11 @@ declare module "../highcharts.src" {
      * (Highcharts, Highstock) Animation when not hovering over the marker.
      */
     interface PlotVectorStatesInactiveAnimationOptions {
+        /**
+         * (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;
     }
     /**
@@ -1222,63 +1240,9 @@ declare module "../highcharts.src" {
         defer?: number;
     }
     /**
-     * (Highcharts, Highstock) A `vector` 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 `vector` series are defined in plotOptions.vector.
-     *
-     * 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 `SeriesVectorOptions` via an interface to allow
-     * custom properties: ``` declare interface SeriesVectorOptions {
-     * customProperty: string; }
-     *
+     * (Highcharts, Highstock) Animation when hovering over the marker.
      */
-    interface SeriesVectorOptions extends Highcharts.PlotVectorOptions, Highcharts.SeriesOptions {
-        /**
-         * (Highcharts, Highstock) An array of data points for the series. For
-         * the `vector` series type, points can be given in the following ways:
-         *
-         * 1. An array of arrays with 4 values. In this case, the values
-         * correspond to to `x,y,length,direction`. If the first value is a
-         * string, it is applied as the name of the point, and the `x` value is
-         * inferred. (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|string), number, number, number]|Highcharts.PointOptionsObject)>;
-        /**
-         * 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: "vector";
+    interface SeriesVectorDataMarkerStatesSelectAnimationOptions {
+        duration?: number;
     }
 }

package/options/venn.d.ts

@@ -372,7 +372,7 @@ declare module "../highcharts" {
          * of two numbers repeats the values for the horizontal and vertical
          * sides.
          */
-        padding?: object;
+        padding?: (number|Array<number>);
         /**
          * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative
          * to points. If `center` alignment is not possible, it defaults to
@@ -717,6 +717,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.
@@ -886,6 +895,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;
         /**
@@ -947,9 +960,14 @@ declare module "../highcharts" {
         zoomEnabled?: boolean;
     }
     /**
-     * (Highcharts) Animation when not hovering over the marker.
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
      */
     interface PlotVennStatesInactiveAnimationOptions {
+        /**
+         * (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;
     }
     /**
@@ -1007,86 +1025,22 @@ declare module "../highcharts" {
         y?: number;
     }
     /**
-     * (Highcharts) A `venn` 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 `venn` series are defined in plotOptions.venn.
-     *
-     * 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 `SeriesVennOptions` via an interface to allow
-     * custom properties: ``` declare interface SeriesVennOptions {
-     * 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 SeriesVennOptions extends Highcharts.PlotVennOptions, Highcharts.SeriesOptions {
+    interface SeriesVennDataDataLabelsAnimationOptions {
         /**
-         * (Highcharts) An array of data points for the series. For the
-         * `scatter` 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 `y` options. The `x` values will be
-         * automatically calculated, either starting at 0 and incremented by 1,
-         * or from `pointStart` and `pointInterval` given in the series options.
-         * If the axis has categories, these will be used. Example: (see online
-         * documentation for example)
-         *
-         * 2. An array of arrays with 2 values. In this case, the values
-         * correspond to `x,y`. If the first value is a string, it is applied as
-         * the name of the point, and the `x` value is inferred. (see online
-         * documentation for example)
-         *
-         * 3. 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<Highcharts.PointOptionsObject>;
-        /**
-         * Not available
-         */
-        dataParser?: undefined;
-        /**
-         * Not available
-         */
-        dataURL?: undefined;
-        /**
-         * Not available
-         */
-        stack?: undefined;
-        /**
-         * Not available
-         */
-        steps?: undefined;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
-         * TypeScript non-optional and might be `undefined` in series objects
-         * from unknown sources.
-         */
-        type: "venn";
-        /**
-         * Not available
-         */
-        xAxis?: undefined;
-        /**
-         * Not available
+         * (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.
          */
-        yAxis?: undefined;
+        defer?: number;
     }
 }

package/options/venn.src.d.ts

@@ -372,7 +372,7 @@ declare module "../highcharts.src" {
          * of two numbers repeats the values for the horizontal and vertical
          * sides.
          */
-        padding?: object;
+        padding?: (number|Array<number>);
         /**
          * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative
          * to points. If `center` alignment is not possible, it defaults to
@@ -717,6 +717,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.
@@ -886,6 +895,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;
         /**
@@ -947,9 +960,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 PlotVennStatesInactiveAnimationOptions {
+        /**
+         * (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;
     }
     /**
@@ -1007,86 +1025,22 @@ declare module "../highcharts.src" {
         y?: number;
     }
     /**
-     * (Highcharts) A `venn` 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 `venn` series are defined in plotOptions.venn.
-     *
-     * 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 `SeriesVennOptions` via an interface to allow
-     * custom properties: ``` declare interface SeriesVennOptions {
-     * 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 SeriesVennOptions extends Highcharts.PlotVennOptions, Highcharts.SeriesOptions {
+    interface SeriesVennDataDataLabelsAnimationOptions {
         /**
-         * (Highcharts) An array of data points for the series. For the
-         * `scatter` 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 `y` options. The `x` values will be
-         * automatically calculated, either starting at 0 and incremented by 1,
-         * or from `pointStart` and `pointInterval` given in the series options.
-         * If the axis has categories, these will be used. Example: (see online
-         * documentation for example)
-         *
-         * 2. An array of arrays with 2 values. In this case, the values
-         * correspond to `x,y`. If the first value is a string, it is applied as
-         * the name of the point, and the `x` value is inferred. (see online
-         * documentation for example)
-         *
-         * 3. 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<Highcharts.PointOptionsObject>;
-        /**
-         * Not available
-         */
-        dataParser?: undefined;
-        /**
-         * Not available
-         */
-        dataURL?: undefined;
-        /**
-         * Not available
-         */
-        stack?: undefined;
-        /**
-         * Not available
-         */
-        steps?: undefined;
-        /**
-         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
-         * TypeScript non-optional and might be `undefined` in series objects
-         * from unknown sources.
-         */
-        type: "venn";
-        /**
-         * Not available
-         */
-        xAxis?: undefined;
-        /**
-         * Not available
+         * (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.
          */
-        yAxis?: undefined;
+        defer?: number;
     }
 }