highcharts 13.0.2 → 13.1.0

package/options/series.d.ts

@@ -85,6 +85,25 @@ declare module "../highcharts" {
          */
         valueSuffix?: 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 PlotSeriesDataLabelsAnimationOptions {
+        /**
+         * (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) Options for the series data
      * labels, appearing next to each data point.
@@ -382,6 +401,27 @@ declare module "../highcharts" {
          */
         zIndex?: number;
     }
+    /**
+     * (Highcharts, Highstock) Options for series data sorting.
+     */
+    interface PlotSeriesDataSortingOptions {
+        /**
+         * (Highcharts, Highstock) Enable or disable data sorting for the
+         * series. Use xAxis.reversed to change the sorting order.
+         */
+        enabled?: boolean;
+        /**
+         * (Highcharts, Highstock) Whether to allow matching points by name in
+         * an update. If this option is disabled, points will be matched by
+         * order.
+         */
+        matchByName?: boolean;
+        /**
+         * (Highcharts, Highstock) Determines what data value should be used to
+         * sort by.
+         */
+        sortKey?: string;
+    }
     /**
      * (Highcharts, Highstock, Gantt) Styles for the series label. The color
      * defaults to the series color, or a contrast color if `onArea`.
@@ -390,6 +430,13 @@ declare module "../highcharts" {
         fontSize?: number;
         fontWeight?: string;
     }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Animation when hovering over the
+     * marker.
+     */
+    interface PlotSeriesMarkerStatesHoverAnimationOptions {
+        duration?: number;
+    }
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Animation when hovering over the
      * marker.
@@ -397,6 +444,30 @@ declare module "../highcharts" {
     interface PlotSeriesMarkerStatesSelectAnimationOptions {
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Options for the connector in the
+     * _Series on point_ feature.
+     *
+     * In styled mode, the connector can be styled with the
+     * `.highcharts-connector-seriesonpoint` class name.
+     */
+    interface PlotSeriesOnPointConnectorOptions {
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) A name for the dash style to
+         * use for the connector.
+         */
+        dashstyle?: string;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Color of the connector line.
+         * By default it's the series' color.
+         */
+        stroke?: string;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Pixel width of the connector
+         * line.
+         */
+        width?: number;
+    }
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Options for the _Series on
      * point_ feature. Only `pie` and `sunburst` series are supported at this
@@ -424,6 +495,36 @@ declare module "../highcharts" {
          */
         position?: (object|Highcharts.PlotSeriesOnPointPositionOptions);
     }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Options allowing to set a
+     * position and an offset of the series in the _Series on point_ feature.
+     */
+    interface PlotSeriesOnPointPositionOptions {
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Series center offset from
+         * the original x position. If defined, the connector line is drawn
+         * connecting original position with new position.
+         */
+        offsetX?: number;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Series center offset from
+         * the original y position. If defined, the connector line is drawn from
+         * original position to a new position.
+         */
+        offsetY?: number;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) X position of the series
+         * center. By default, the series is displayed on the point that it is
+         * connected to.
+         */
+        x?: number;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Y position of the series
+         * center. By default, the series is displayed on the point that it is
+         * connected to.
+         */
+        y?: number;
+    }
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) General options for all series
      * types.
@@ -1300,6 +1401,15 @@ declare module "../highcharts" {
          */
         zoomEnabled?: boolean;
     }
+    /**
+     * (Highstock) Properties for each single point.
+     */
+    interface PlotSeriesPointOptions {
+        /**
+         * (Highstock) Events for each single point.
+         */
+        events?: Highcharts.PointEventsOptionsObject;
+    }
     /**
      * (Highcharts, Highstock) Animation setting for hovering the graph in
      * line-type series.
@@ -1312,6 +1422,17 @@ declare module "../highcharts" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
+     */
+    interface PlotSeriesStatesInactiveAnimationOptions {
+        /**
+         * (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;
+    }
     /**
      * (Highcharts, Highstock) Animation setting for hovering the graph in
      * line-type series.
@@ -1324,6 +1445,23 @@ declare module "../highcharts" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock, Gantt) For series on datetime axes, the date
+     * format in the tooltip's header will by default be guessed based on the
+     * closest data points. This member gives the default string representations
+     * used for each unit. For an overview of the string or object
+     * configuration, see dateFormat.
+     */
+    interface PlotSeriesTooltipDateTimeLabelFormatsOptions {
+        day?: string;
+        hour?: string;
+        millisecond?: string;
+        minute?: string;
+        month?: string;
+        second?: string;
+        week?: string;
+        year?: string;
+    }
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Options for the tooltip header
      * when tooltip.split is enabled. The header is the box containing the X
@@ -1369,4 +1507,41 @@ declare module "../highcharts" {
          */
         style?: object;
     }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Positioning options for fixed
+     * tooltip, taking effect only when tooltip.fixed is `true`.
+     */
+    interface PlotSeriesTooltipPositionOptions {
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) The horizontal alignment of
+         * the fixed tooltip.
+         */
+        align?: Highcharts.AlignValue;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) What the fixed tooltip
+         * alignment should be relative to.
+         *
+         * The default, `pane`, means that it is aligned within the plot area
+         * for that given series. If the tooltip is split (as default in Stock
+         * charts), each partial tooltip is aligned within the series' pane.
+         */
+        relativeTo?: Highcharts.OptionsRelativeToValue;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of
+         * the fixed tooltip.
+         */
+        verticalAlign?: Highcharts.VerticalAlignValue;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) X pixel offset from the
+         * given position. Can be used to shy away from axis lines, grid lines
+         * etc to avoid the tooltip overlapping other elements.
+         */
+        x?: number;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Y pixel offset from the
+         * given position. Can be used to shy away from axis lines, grid lines
+         * etc to avoid the tooltip overlapping other elements.
+         */
+        y?: number;
+    }
 }

package/options/series.src.d.ts

@@ -85,6 +85,25 @@ declare module "../highcharts.src" {
          */
         valueSuffix?: 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 PlotSeriesDataLabelsAnimationOptions {
+        /**
+         * (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) Options for the series data
      * labels, appearing next to each data point.
@@ -382,6 +401,27 @@ declare module "../highcharts.src" {
          */
         zIndex?: number;
     }
+    /**
+     * (Highcharts, Highstock) Options for series data sorting.
+     */
+    interface PlotSeriesDataSortingOptions {
+        /**
+         * (Highcharts, Highstock) Enable or disable data sorting for the
+         * series. Use xAxis.reversed to change the sorting order.
+         */
+        enabled?: boolean;
+        /**
+         * (Highcharts, Highstock) Whether to allow matching points by name in
+         * an update. If this option is disabled, points will be matched by
+         * order.
+         */
+        matchByName?: boolean;
+        /**
+         * (Highcharts, Highstock) Determines what data value should be used to
+         * sort by.
+         */
+        sortKey?: string;
+    }
     /**
      * (Highcharts, Highstock, Gantt) Styles for the series label. The color
      * defaults to the series color, or a contrast color if `onArea`.
@@ -390,6 +430,13 @@ declare module "../highcharts.src" {
         fontSize?: number;
         fontWeight?: string;
     }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Animation when hovering over the
+     * marker.
+     */
+    interface PlotSeriesMarkerStatesHoverAnimationOptions {
+        duration?: number;
+    }
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Animation when hovering over the
      * marker.
@@ -397,6 +444,30 @@ declare module "../highcharts.src" {
     interface PlotSeriesMarkerStatesSelectAnimationOptions {
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Options for the connector in the
+     * _Series on point_ feature.
+     *
+     * In styled mode, the connector can be styled with the
+     * `.highcharts-connector-seriesonpoint` class name.
+     */
+    interface PlotSeriesOnPointConnectorOptions {
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) A name for the dash style to
+         * use for the connector.
+         */
+        dashstyle?: string;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Color of the connector line.
+         * By default it's the series' color.
+         */
+        stroke?: string;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Pixel width of the connector
+         * line.
+         */
+        width?: number;
+    }
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Options for the _Series on
      * point_ feature. Only `pie` and `sunburst` series are supported at this
@@ -424,6 +495,36 @@ declare module "../highcharts.src" {
          */
         position?: (object|Highcharts.PlotSeriesOnPointPositionOptions);
     }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Options allowing to set a
+     * position and an offset of the series in the _Series on point_ feature.
+     */
+    interface PlotSeriesOnPointPositionOptions {
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Series center offset from
+         * the original x position. If defined, the connector line is drawn
+         * connecting original position with new position.
+         */
+        offsetX?: number;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Series center offset from
+         * the original y position. If defined, the connector line is drawn from
+         * original position to a new position.
+         */
+        offsetY?: number;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) X position of the series
+         * center. By default, the series is displayed on the point that it is
+         * connected to.
+         */
+        x?: number;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Y position of the series
+         * center. By default, the series is displayed on the point that it is
+         * connected to.
+         */
+        y?: number;
+    }
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) General options for all series
      * types.
@@ -1300,6 +1401,15 @@ declare module "../highcharts.src" {
          */
         zoomEnabled?: boolean;
     }
+    /**
+     * (Highstock) Properties for each single point.
+     */
+    interface PlotSeriesPointOptions {
+        /**
+         * (Highstock) Events for each single point.
+         */
+        events?: Highcharts.PointEventsOptionsObject;
+    }
     /**
      * (Highcharts, Highstock) Animation setting for hovering the graph in
      * line-type series.
@@ -1312,6 +1422,17 @@ declare module "../highcharts.src" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
+     */
+    interface PlotSeriesStatesInactiveAnimationOptions {
+        /**
+         * (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;
+    }
     /**
      * (Highcharts, Highstock) Animation setting for hovering the graph in
      * line-type series.
@@ -1324,6 +1445,23 @@ declare module "../highcharts.src" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock, Gantt) For series on datetime axes, the date
+     * format in the tooltip's header will by default be guessed based on the
+     * closest data points. This member gives the default string representations
+     * used for each unit. For an overview of the string or object
+     * configuration, see dateFormat.
+     */
+    interface PlotSeriesTooltipDateTimeLabelFormatsOptions {
+        day?: string;
+        hour?: string;
+        millisecond?: string;
+        minute?: string;
+        month?: string;
+        second?: string;
+        week?: string;
+        year?: string;
+    }
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Options for the tooltip header
      * when tooltip.split is enabled. The header is the box containing the X
@@ -1369,4 +1507,41 @@ declare module "../highcharts.src" {
          */
         style?: object;
     }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Positioning options for fixed
+     * tooltip, taking effect only when tooltip.fixed is `true`.
+     */
+    interface PlotSeriesTooltipPositionOptions {
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) The horizontal alignment of
+         * the fixed tooltip.
+         */
+        align?: Highcharts.AlignValue;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) What the fixed tooltip
+         * alignment should be relative to.
+         *
+         * The default, `pane`, means that it is aligned within the plot area
+         * for that given series. If the tooltip is split (as default in Stock
+         * charts), each partial tooltip is aligned within the series' pane.
+         */
+        relativeTo?: Highcharts.OptionsRelativeToValue;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of
+         * the fixed tooltip.
+         */
+        verticalAlign?: Highcharts.VerticalAlignValue;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) X pixel offset from the
+         * given position. Can be used to shy away from axis lines, grid lines
+         * etc to avoid the tooltip overlapping other elements.
+         */
+        x?: number;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) Y pixel offset from the
+         * given position. Can be used to shy away from axis lines, grid lines
+         * etc to avoid the tooltip overlapping other elements.
+         */
+        y?: number;
+    }
 }