highcharts 13.0.2 → 13.1.0

package/options/macd.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 PlotMacdDataLabelsAnimationOptions {
+        /**
+         * (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 PlotMacdDataSortingOptions {
+        /**
+         * (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,23 @@ declare module "../highcharts" {
         fontSize?: number;
         fontWeight?: string;
     }
+    /**
+     * (Highstock) The styles for macd line
+     */
+    interface PlotMacdMacdLineOptions {
+        styles?: Highcharts.PlotMacdMacdLineStylesOptions;
+        /**
+         * (Highcharts, Highstock) An array defining zones within a series.
+         * Zones can be applied to the X axis, Y axis or Z axis for bubbles,
+         * according to the `zoneAxis` option. The zone definitions have to be
+         * in ascending order regarding to the value.
+         *
+         * In styled mode, the color zones are styled with the
+         * `.highcharts-zone-{n}` class, or custom classed from the `className`
+         * option (view live demo).
+         */
+        zones?: Array<Highcharts.SeriesZonesOptionsObject>;
+    }
     interface PlotMacdMacdLineStylesOptions {
         /**
          * (Highstock) Color of the line.
@@ -397,12 +454,39 @@ declare module "../highcharts" {
          */
         lineWidth?: number;
     }
+    /**
+     * (Highstock) Animation when hovering over the marker.
+     */
+    interface PlotMacdMarkerStatesHoverAnimationOptions {
+        duration?: number;
+    }
     /**
      * (Highstock) Animation when hovering over the marker.
      */
     interface PlotMacdMarkerStatesSelectAnimationOptions {
         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 PlotMacdOnPointConnectorOptions {
+        /**
+         * (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.
@@ -428,6 +512,34 @@ declare module "../highcharts" {
          */
         position?: (object|Highcharts.PlotMacdOnPointPositionOptions);
     }
+    /**
+     * (Highstock) Options allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotMacdOnPointPositionOptions {
+        /**
+         * (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) Moving Average Convergence Divergence (MACD). This series
      * requires `linkedTo` option to be set and should be loaded after the
@@ -1116,6 +1228,35 @@ declare module "../highcharts" {
          */
         zoomEnabled?: boolean;
     }
+    /**
+     * (Highstock) Parameters used in calculation of regression series' points.
+     */
+    interface PlotMacdParamsOptions {
+        /**
+         * (Highstock) The point index which indicator calculations will base.
+         * For example using OHLC data, index=2 means the indicator will be
+         * calculated using Low values.
+         */
+        index?: number;
+        /**
+         * (Highstock) The long period for indicator calculations.
+         */
+        longPeriod?: number;
+        /**
+         * (Highstock) The base period for indicator calculations. This is the
+         * number of data points which are taken into account for the indicator
+         * calculations.
+         */
+        period?: number;
+        /**
+         * (Highstock) The short period for indicator calculations.
+         */
+        shortPeriod?: number;
+        /**
+         * (Highstock) The base period for signal calculations.
+         */
+        signalPeriod?: number;
+    }
     /**
      * (Highstock) The styles for signal line
      */
@@ -1133,6 +1274,16 @@ declare module "../highcharts" {
          */
         zones?: Array<Highcharts.SeriesZonesOptionsObject>;
     }
+    interface PlotMacdSignalLineStylesOptions {
+        /**
+         * (Highstock) Color of the line.
+         */
+        lineColor?: Highcharts.ColorString;
+        /**
+         * (Highstock) Pixel width of the line.
+         */
+        lineWidth?: number;
+    }
     /**
      * (Highcharts, Highstock) Animation setting for hovering the graph in
      * line-type series.
@@ -1145,6 +1296,17 @@ declare module "../highcharts" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
+     */
+    interface PlotMacdStatesInactiveAnimationOptions {
+        /**
+         * (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.
@@ -1157,6 +1319,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 PlotMacdTooltipDateTimeLabelFormatsOptions {
+        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.
@@ -1199,4 +1378,79 @@ declare module "../highcharts" {
          */
         style?: object;
     }
+    /**
+     * (Highstock) Positioning options for fixed tooltip, taking effect only
+     * when tooltip.fixed is `true`.
+     */
+    interface PlotMacdTooltipPositionOptions {
+        /**
+         * (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 `MACD` 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 `macd` series are defined in plotOptions.macd.
+     *
+     * 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 `SeriesMacdOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesMacdOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesMacdOptions extends Highcharts.PlotMacdOptions, Highcharts.SeriesOptions {
+        /**
+         * Not available
+         */
+        allAreas?: undefined;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "macd";
+    }
 }

package/options/macd.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 PlotMacdDataLabelsAnimationOptions {
+        /**
+         * (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 PlotMacdDataSortingOptions {
+        /**
+         * (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,23 @@ declare module "../highcharts.src" {
         fontSize?: number;
         fontWeight?: string;
     }
+    /**
+     * (Highstock) The styles for macd line
+     */
+    interface PlotMacdMacdLineOptions {
+        styles?: Highcharts.PlotMacdMacdLineStylesOptions;
+        /**
+         * (Highcharts, Highstock) An array defining zones within a series.
+         * Zones can be applied to the X axis, Y axis or Z axis for bubbles,
+         * according to the `zoneAxis` option. The zone definitions have to be
+         * in ascending order regarding to the value.
+         *
+         * In styled mode, the color zones are styled with the
+         * `.highcharts-zone-{n}` class, or custom classed from the `className`
+         * option (view live demo).
+         */
+        zones?: Array<Highcharts.SeriesZonesOptionsObject>;
+    }
     interface PlotMacdMacdLineStylesOptions {
         /**
          * (Highstock) Color of the line.
@@ -397,12 +454,39 @@ declare module "../highcharts.src" {
          */
         lineWidth?: number;
     }
+    /**
+     * (Highstock) Animation when hovering over the marker.
+     */
+    interface PlotMacdMarkerStatesHoverAnimationOptions {
+        duration?: number;
+    }
     /**
      * (Highstock) Animation when hovering over the marker.
      */
     interface PlotMacdMarkerStatesSelectAnimationOptions {
         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 PlotMacdOnPointConnectorOptions {
+        /**
+         * (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.
@@ -428,6 +512,34 @@ declare module "../highcharts.src" {
          */
         position?: (object|Highcharts.PlotMacdOnPointPositionOptions);
     }
+    /**
+     * (Highstock) Options allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotMacdOnPointPositionOptions {
+        /**
+         * (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) Moving Average Convergence Divergence (MACD). This series
      * requires `linkedTo` option to be set and should be loaded after the
@@ -1116,6 +1228,35 @@ declare module "../highcharts.src" {
          */
         zoomEnabled?: boolean;
     }
+    /**
+     * (Highstock) Parameters used in calculation of regression series' points.
+     */
+    interface PlotMacdParamsOptions {
+        /**
+         * (Highstock) The point index which indicator calculations will base.
+         * For example using OHLC data, index=2 means the indicator will be
+         * calculated using Low values.
+         */
+        index?: number;
+        /**
+         * (Highstock) The long period for indicator calculations.
+         */
+        longPeriod?: number;
+        /**
+         * (Highstock) The base period for indicator calculations. This is the
+         * number of data points which are taken into account for the indicator
+         * calculations.
+         */
+        period?: number;
+        /**
+         * (Highstock) The short period for indicator calculations.
+         */
+        shortPeriod?: number;
+        /**
+         * (Highstock) The base period for signal calculations.
+         */
+        signalPeriod?: number;
+    }
     /**
      * (Highstock) The styles for signal line
      */
@@ -1133,6 +1274,16 @@ declare module "../highcharts.src" {
          */
         zones?: Array<Highcharts.SeriesZonesOptionsObject>;
     }
+    interface PlotMacdSignalLineStylesOptions {
+        /**
+         * (Highstock) Color of the line.
+         */
+        lineColor?: Highcharts.ColorString;
+        /**
+         * (Highstock) Pixel width of the line.
+         */
+        lineWidth?: number;
+    }
     /**
      * (Highcharts, Highstock) Animation setting for hovering the graph in
      * line-type series.
@@ -1145,6 +1296,17 @@ declare module "../highcharts.src" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts, Highstock) Animation when not hovering over the marker.
+     */
+    interface PlotMacdStatesInactiveAnimationOptions {
+        /**
+         * (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.
@@ -1157,6 +1319,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 PlotMacdTooltipDateTimeLabelFormatsOptions {
+        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.
@@ -1199,4 +1378,79 @@ declare module "../highcharts.src" {
          */
         style?: object;
     }
+    /**
+     * (Highstock) Positioning options for fixed tooltip, taking effect only
+     * when tooltip.fixed is `true`.
+     */
+    interface PlotMacdTooltipPositionOptions {
+        /**
+         * (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 `MACD` 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 `macd` series are defined in plotOptions.macd.
+     *
+     * 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 `SeriesMacdOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesMacdOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesMacdOptions extends Highcharts.PlotMacdOptions, Highcharts.SeriesOptions {
+        /**
+         * Not available
+         */
+        allAreas?: undefined;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "macd";
+    }
 }