highcharts 13.0.2 → 13.1.0

package/options/hlc.d.ts

@@ -82,6 +82,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 PlotHlcDataLabelsAnimationOptions {
+        /**
+         * (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.
@@ -379,6 +398,27 @@ declare module "../highcharts" {
          */
         zIndex?: number;
     }
+    /**
+     * (Highcharts, Highstock) Options for series data sorting.
+     */
+    interface PlotHlcDataSortingOptions {
+        /**
+         * (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`.
@@ -387,6 +427,27 @@ declare module "../highcharts" {
         fontSize?: number;
         fontWeight?: string;
     }
+    /**
+     * (Highstock) 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 PlotHlcOnPointConnectorOptions {
+        /**
+         * (Highstock) A name for the dash style to use for the connector.
+         */
+        dashstyle?: string;
+        /**
+         * (Highstock) Color of the connector line. By default it's the series'
+         * color.
+         */
+        stroke?: string;
+        /**
+         * (Highstock) Pixel width of the connector line.
+         */
+        width?: number;
+    }
     /**
      * (Highstock) Options for the _Series on point_ feature. Only `pie` and
      * `sunburst` series are supported at this moment.
@@ -412,6 +473,34 @@ declare module "../highcharts" {
          */
         position?: (object|Highcharts.PlotHlcOnPointPositionOptions);
     }
+    /**
+     * (Highstock) Options allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotHlcOnPointPositionOptions {
+        /**
+         * (Highstock) Series center offset from the original x position. If
+         * defined, the connector line is drawn connecting original position
+         * with new position.
+         */
+        offsetX?: number;
+        /**
+         * (Highstock) Series center offset from the original y position. If
+         * defined, the connector line is drawn from original position to a new
+         * position.
+         */
+        offsetY?: number;
+        /**
+         * (Highstock) X position of the series center. By default, the series
+         * is displayed on the point that it is connected to.
+         */
+        x?: number;
+        /**
+         * (Highstock) Y position of the series center. By default, the series
+         * is displayed on the point that it is connected to.
+         */
+        y?: number;
+    }
     /**
      * (Highstock) An HLC chart is a style of financial chart used to describe
      * price movements over time. It displays high, low and close values per
@@ -884,8 +973,10 @@ declare module "../highcharts" {
          * (Highcharts, Highstock, Gantt) The minimal height for a column or
          * width for a bar. By default, 0 values are not shown. To visualize a 0
          * (or close to zero) point, set the minimal point length to a pixel
-         * value like 3\. In stacked column charts, minPointLength might not be
-         * respected for tightly packed values.
+         * value like 3\. In stacked column charts, the length is applied to
+         * each point in isolation, so tightly packed values may overlap. See
+         * the stacked sample below for a plugin that lays out the stack as a
+         * whole instead.
          */
         minPointLength?: number;
         /**
@@ -1202,6 +1293,18 @@ declare module "../highcharts" {
          */
         zoomEnabled?: boolean;
     }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotHlcStatesHoverAnimationOptions {
+        /**
+         * (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 when not hovering over the marker.
      */
@@ -1213,6 +1316,18 @@ declare module "../highcharts" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotHlcStatesSelectAnimationOptions {
+        /**
+         * (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, Gantt) For series on datetime axes, the date
      * format in the tooltip's header will by default be guessed based on the
@@ -1230,6 +1345,48 @@ declare module "../highcharts" {
         week?: string;
         year?: string;
     }
+    /**
+     * (Highstock) Options for the tooltip header when tooltip.split is enabled.
+     * The header is the box containing the X value in a split tooltip.
+     */
+    interface PlotHlcTooltipHeaderOptions {
+        /**
+         * (Highstock) Background color for the tooltip header when
+         * tooltip.split is enabled.
+         */
+        backgroundColor?: Highcharts.ColorType;
+        /**
+         * (Highstock) Border color for the tooltip header when tooltip.split is
+         * enabled.
+         */
+        borderColor?: Highcharts.ColorType;
+        /**
+         * (Highstock) The width of the border for the tooltip header when
+         * tooltip.split is enabled.
+         */
+        borderWidth?: number;
+        /**
+         * (Highstock) Distance between the plot area and the header (except the
+         * chevron) in a split tooltip, in pixels. The default value makes the
+         * header text align with the axis labels.
+         */
+        distance?: number;
+        /**
+         * (Highstock) The name of a symbol to use for the border around the
+         * tooltip header. Applies only when tooltip.split is enabled.
+         *
+         * Custom callbacks for symbol path generation can also be added to
+         * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
+         * series.marker.symbol.
+         */
+        shape?: string;
+        /**
+         * (Highstock) CSS styles for the tooltip header. The default is `{
+         * fontSize: '1em' }`, ensuring that the header text is the same size as
+         * the axis labels.
+         */
+        style?: object;
+    }
     /**
      * (Highstock) Positioning options for fixed tooltip, taking effect only
      * when tooltip.fixed is `true`.
@@ -1283,4 +1440,68 @@ declare module "../highcharts" {
          */
         defer?: number;
     }
+    /**
+     * (Highstock) A `hlc` 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 `hlc` series are defined in plotOptions.hlc.
+     *
+     * 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 `SeriesHlcOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesHlcOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesHlcOptions extends Highcharts.PlotHlcOptions, Highcharts.SeriesOptions {
+        /**
+         * Not available
+         */
+        borderRadius?: undefined;
+        /**
+         * (Highstock) An array of data points for the series. For the `hlc`
+         * series type, points can be given in the following ways:
+         *
+         * 1. An array of arrays with 4 or 3 values. In this case, the values
+         * correspond to `x,high,low,close`. If the first value is a string, it
+         * is applied as the name of the point, and the `x` value is inferred.
+         * The `x` value can also be omitted, in which case the inner arrays
+         * should be of length of 3\. Then the `x` value is automatically
+         * calculated, either starting at 0 and incremented by 1, or from
+         * `pointStart` and `pointInterval` given in the series options. (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|string), number, number, number]|Highcharts.PointOptionsObject)>;
+        /**
+         * Not available
+         */
+        stack?: undefined;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "hlc";
+    }
 }

package/options/hlc.src.d.ts

@@ -82,6 +82,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 PlotHlcDataLabelsAnimationOptions {
+        /**
+         * (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.
@@ -379,6 +398,27 @@ declare module "../highcharts.src" {
          */
         zIndex?: number;
     }
+    /**
+     * (Highcharts, Highstock) Options for series data sorting.
+     */
+    interface PlotHlcDataSortingOptions {
+        /**
+         * (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`.
@@ -387,6 +427,27 @@ declare module "../highcharts.src" {
         fontSize?: number;
         fontWeight?: string;
     }
+    /**
+     * (Highstock) 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 PlotHlcOnPointConnectorOptions {
+        /**
+         * (Highstock) A name for the dash style to use for the connector.
+         */
+        dashstyle?: string;
+        /**
+         * (Highstock) Color of the connector line. By default it's the series'
+         * color.
+         */
+        stroke?: string;
+        /**
+         * (Highstock) Pixel width of the connector line.
+         */
+        width?: number;
+    }
     /**
      * (Highstock) Options for the _Series on point_ feature. Only `pie` and
      * `sunburst` series are supported at this moment.
@@ -412,6 +473,34 @@ declare module "../highcharts.src" {
          */
         position?: (object|Highcharts.PlotHlcOnPointPositionOptions);
     }
+    /**
+     * (Highstock) Options allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotHlcOnPointPositionOptions {
+        /**
+         * (Highstock) Series center offset from the original x position. If
+         * defined, the connector line is drawn connecting original position
+         * with new position.
+         */
+        offsetX?: number;
+        /**
+         * (Highstock) Series center offset from the original y position. If
+         * defined, the connector line is drawn from original position to a new
+         * position.
+         */
+        offsetY?: number;
+        /**
+         * (Highstock) X position of the series center. By default, the series
+         * is displayed on the point that it is connected to.
+         */
+        x?: number;
+        /**
+         * (Highstock) Y position of the series center. By default, the series
+         * is displayed on the point that it is connected to.
+         */
+        y?: number;
+    }
     /**
      * (Highstock) An HLC chart is a style of financial chart used to describe
      * price movements over time. It displays high, low and close values per
@@ -884,8 +973,10 @@ declare module "../highcharts.src" {
          * (Highcharts, Highstock, Gantt) The minimal height for a column or
          * width for a bar. By default, 0 values are not shown. To visualize a 0
          * (or close to zero) point, set the minimal point length to a pixel
-         * value like 3\. In stacked column charts, minPointLength might not be
-         * respected for tightly packed values.
+         * value like 3\. In stacked column charts, the length is applied to
+         * each point in isolation, so tightly packed values may overlap. See
+         * the stacked sample below for a plugin that lays out the stack as a
+         * whole instead.
          */
         minPointLength?: number;
         /**
@@ -1202,6 +1293,18 @@ declare module "../highcharts.src" {
          */
         zoomEnabled?: boolean;
     }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotHlcStatesHoverAnimationOptions {
+        /**
+         * (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 when not hovering over the marker.
      */
@@ -1213,6 +1316,18 @@ declare module "../highcharts.src" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotHlcStatesSelectAnimationOptions {
+        /**
+         * (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, Gantt) For series on datetime axes, the date
      * format in the tooltip's header will by default be guessed based on the
@@ -1230,6 +1345,48 @@ declare module "../highcharts.src" {
         week?: string;
         year?: string;
     }
+    /**
+     * (Highstock) Options for the tooltip header when tooltip.split is enabled.
+     * The header is the box containing the X value in a split tooltip.
+     */
+    interface PlotHlcTooltipHeaderOptions {
+        /**
+         * (Highstock) Background color for the tooltip header when
+         * tooltip.split is enabled.
+         */
+        backgroundColor?: Highcharts.ColorType;
+        /**
+         * (Highstock) Border color for the tooltip header when tooltip.split is
+         * enabled.
+         */
+        borderColor?: Highcharts.ColorType;
+        /**
+         * (Highstock) The width of the border for the tooltip header when
+         * tooltip.split is enabled.
+         */
+        borderWidth?: number;
+        /**
+         * (Highstock) Distance between the plot area and the header (except the
+         * chevron) in a split tooltip, in pixels. The default value makes the
+         * header text align with the axis labels.
+         */
+        distance?: number;
+        /**
+         * (Highstock) The name of a symbol to use for the border around the
+         * tooltip header. Applies only when tooltip.split is enabled.
+         *
+         * Custom callbacks for symbol path generation can also be added to
+         * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
+         * series.marker.symbol.
+         */
+        shape?: string;
+        /**
+         * (Highstock) CSS styles for the tooltip header. The default is `{
+         * fontSize: '1em' }`, ensuring that the header text is the same size as
+         * the axis labels.
+         */
+        style?: object;
+    }
     /**
      * (Highstock) Positioning options for fixed tooltip, taking effect only
      * when tooltip.fixed is `true`.
@@ -1283,4 +1440,68 @@ declare module "../highcharts.src" {
          */
         defer?: number;
     }
+    /**
+     * (Highstock) A `hlc` 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 `hlc` series are defined in plotOptions.hlc.
+     *
+     * 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 `SeriesHlcOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesHlcOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesHlcOptions extends Highcharts.PlotHlcOptions, Highcharts.SeriesOptions {
+        /**
+         * Not available
+         */
+        borderRadius?: undefined;
+        /**
+         * (Highstock) An array of data points for the series. For the `hlc`
+         * series type, points can be given in the following ways:
+         *
+         * 1. An array of arrays with 4 or 3 values. In this case, the values
+         * correspond to `x,high,low,close`. If the first value is a string, it
+         * is applied as the name of the point, and the `x` value is inferred.
+         * The `x` value can also be omitted, in which case the inner arrays
+         * should be of length of 3\. Then the `x` value is automatically
+         * calculated, either starting at 0 and incremented by 1, or from
+         * `pointStart` and `pointInterval` given in the series options. (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|string), number, number, number]|Highcharts.PointOptionsObject)>;
+        /**
+         * Not available
+         */
+        stack?: undefined;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "hlc";
+    }
 }