highcharts 13.0.2 → 13.1.0

package/options/obv.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 PlotObvDataLabelsAnimationOptions {
+        /**
+         * (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 PlotObvDataSortingOptions {
+        /**
+         * (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,12 +427,39 @@ declare module "../highcharts.src" {
         fontSize?: number;
         fontWeight?: string;
     }
+    /**
+     * (Highstock) Animation when hovering over the marker.
+     */
+    interface PlotObvMarkerStatesHoverAnimationOptions {
+        duration?: number;
+    }
     /**
      * (Highstock) Animation when hovering over the marker.
      */
     interface PlotObvMarkerStatesSelectAnimationOptions {
         duration?: number;
     }
+    /**
+     * (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 PlotObvOnPointConnectorOptions {
+        /**
+         * (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.
@@ -418,6 +485,34 @@ declare module "../highcharts.src" {
          */
         position?: (object|Highcharts.PlotObvOnPointPositionOptions);
     }
+    /**
+     * (Highstock) Options allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotObvOnPointPositionOptions {
+        /**
+         * (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) On-Balance Volume (OBV) technical indicator. This series
      * requires the `linkedTo` option to be set and should be loaded after the
@@ -1096,6 +1191,18 @@ declare module "../highcharts.src" {
          */
         zoomEnabled?: boolean;
     }
+    /**
+     * (Highstock) Parameters used in calculation of regression series' points.
+     */
+    interface PlotObvParamsOptions {
+        index?: string;
+        period?: string;
+        /**
+         * (Highstock) The id of another series to use its data as volume data
+         * for the indicator calculation.
+         */
+        volumeSeriesID?: string;
+    }
     /**
      * (Highcharts, Highstock) Animation setting for hovering the graph in
      * line-type series.
@@ -1108,6 +1215,17 @@ declare module "../highcharts.src" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
+     */
+    interface PlotObvStatesInactiveAnimationOptions {
+        /**
+         * (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.
@@ -1120,6 +1238,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 PlotObvTooltipDateTimeLabelFormatsOptions {
+        day?: string;
+        hour?: string;
+        millisecond?: string;
+        minute?: string;
+        month?: string;
+        second?: string;
+        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.
@@ -1162,6 +1297,40 @@ declare module "../highcharts.src" {
          */
         style?: object;
     }
+    /**
+     * (Highstock) Positioning options for fixed tooltip, taking effect only
+     * when tooltip.fixed is `true`.
+     */
+    interface PlotObvTooltipPositionOptions {
+        /**
+         * (Highstock) The horizontal alignment of the fixed tooltip.
+         */
+        align?: Highcharts.AlignValue;
+        /**
+         * (Highstock) 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;
+        /**
+         * (Highstock) The vertical alignment of the fixed tooltip.
+         */
+        verticalAlign?: Highcharts.VerticalAlignValue;
+        /**
+         * (Highstock) 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;
+        /**
+         * (Highstock) 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;
+    }
     /**
      * (Highstock) A `OBV` series. If the type option is not specified, it is
      * inherited from chart.type.
@@ -1195,11 +1364,7 @@ declare module "../highcharts.src" {
         /**
          * Not available
          */
-        dataParser?: undefined;
-        /**
-         * Not available
-         */
-        dataURL?: undefined;
+        allAreas?: undefined;
         /**
          * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
          * TypeScript non-optional and might be `undefined` in series objects

package/options/ohlc.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 PlotOhlcDataLabelsAnimationOptions {
+        /**
+         * (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 PlotOhlcDataSortingOptions {
+        /**
+         * (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 PlotOhlcOnPointConnectorOptions {
+        /**
+         * (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.PlotOhlcOnPointPositionOptions);
     }
+    /**
+     * (Highstock) Options allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotOhlcOnPointPositionOptions {
+        /**
+         * (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 OHLC chart is a style of financial chart used to describe
      * price movements over time. It displays open, high, low and close values
@@ -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;
         /**
@@ -1206,6 +1297,18 @@ declare module "../highcharts" {
          */
         zoomEnabled?: boolean;
     }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotOhlcStatesHoverAnimationOptions {
+        /**
+         * (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.
      */
@@ -1217,6 +1320,18 @@ declare module "../highcharts" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotOhlcStatesSelectAnimationOptions {
+        /**
+         * (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
@@ -1234,6 +1349,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 PlotOhlcTooltipHeaderOptions {
+        /**
+         * (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`.
@@ -1268,6 +1425,25 @@ declare module "../highcharts" {
          */
         y?: number;
     }
+    /**
+     * (Highcharts, Highstock) 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 SeriesOhlcDataDataLabelsAnimationOptions {
+        /**
+         * (Highcharts, Highstock) 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;
+    }
     /**
      * (Highstock) A `ohlc` series. If the type option is not specified, it is
      * inherited from chart.type.
@@ -1298,6 +1474,10 @@ declare module "../highcharts" {
      *
      */
     interface SeriesOhlcOptions extends Highcharts.PlotOhlcOptions, Highcharts.SeriesOptions {
+        /**
+         * Not available
+         */
+        borderRadius?: undefined;
         /**
          * (Highstock) An array of data points for the series. For the `ohlc`
          * series type, points can be given in the following ways:
@@ -1320,11 +1500,7 @@ declare module "../highcharts" {
         /**
          * Not available
          */
-        dataParser?: undefined;
-        /**
-         * Not available
-         */
-        dataURL?: undefined;
+        stack?: undefined;
         /**
          * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
          * TypeScript non-optional and might be `undefined` in series objects