highcharts 12.0.0 → 12.0.2

package/options/flags.d.ts

@@ -0,0 +1,167 @@
+/*!*
+ *
+ *  Copyright (c) Highsoft AS. All rights reserved.
+ *
+ *!*/
+import * as Highcharts from "../highcharts";
+declare module "../highcharts" {
+    /**
+     * (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 PlotFlagsDataLabelsAnimationOptions {
+        /**
+         * (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) Options for the series data sorting.
+     */
+    interface PlotFlagsDataSortingOptions {
+        /**
+         * (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;
+    }
+    /**
+     * (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 PlotFlagsOnPointConnectorOptions {
+        /**
+         * (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 allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotFlagsOnPointPositionOptions {
+        /**
+         * (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) A `flags` 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 `flags` series are defined in plotOptions.flags.
+     *
+     * 3. Options for one single series are given in the series instance array.
+     * (see online documentation for example)
+     *
+     * **TypeScript:**
+     *
+     * - the type option must always be set.
+     *
+     * - 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 `SeriesFlagsOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesFlagsOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesFlagsOptions extends Highcharts.PlotFlagsOptions, Highcharts.SeriesOptions {
+        /**
+         * Not available
+         */
+        colorByPoint?: undefined;
+        /**
+         * (Highstock) An array of data points for the series. For the `flags`
+         * series type, points can be given in the following ways:
+         *
+         * 1. 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
+         */
+        pointPadding?: undefined;
+        /**
+         * Not available
+         */
+        pointWidth?: undefined;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "flags";
+        /**
+         * Not available
+         */
+        useOhlcData?: undefined;
+    }
+}

package/options/flags.src.d.ts

@@ -0,0 +1,167 @@
+/*!*
+ *
+ *  Copyright (c) Highsoft AS. All rights reserved.
+ *
+ *!*/
+import * as Highcharts from "../highcharts.src";
+declare module "../highcharts.src" {
+    /**
+     * (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 PlotFlagsDataLabelsAnimationOptions {
+        /**
+         * (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) Options for the series data sorting.
+     */
+    interface PlotFlagsDataSortingOptions {
+        /**
+         * (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;
+    }
+    /**
+     * (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 PlotFlagsOnPointConnectorOptions {
+        /**
+         * (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 allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotFlagsOnPointPositionOptions {
+        /**
+         * (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) A `flags` 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 `flags` series are defined in plotOptions.flags.
+     *
+     * 3. Options for one single series are given in the series instance array.
+     * (see online documentation for example)
+     *
+     * **TypeScript:**
+     *
+     * - the type option must always be set.
+     *
+     * - 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 `SeriesFlagsOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesFlagsOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesFlagsOptions extends Highcharts.PlotFlagsOptions, Highcharts.SeriesOptions {
+        /**
+         * Not available
+         */
+        colorByPoint?: undefined;
+        /**
+         * (Highstock) An array of data points for the series. For the `flags`
+         * series type, points can be given in the following ways:
+         *
+         * 1. 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
+         */
+        pointPadding?: undefined;
+        /**
+         * Not available
+         */
+        pointWidth?: undefined;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "flags";
+        /**
+         * Not available
+         */
+        useOhlcData?: undefined;
+    }
+}

package/options/flowmap.d.ts

@@ -0,0 +1,152 @@
+/*!*
+ *
+ *  Copyright (c) Highsoft AS. All rights reserved.
+ *
+ *!*/
+import * as Highcharts from "../highcharts";
+declare module "../highcharts" {
+    /**
+     * (Highmaps) Point accessibility options for a series.
+     */
+    interface PlotFlowmapAccessibilityPointOptions {
+        /**
+         * (Highmaps) Date format to use for points on datetime axes when
+         * describing them to screen reader users.
+         *
+         * Defaults to the same format as in tooltip.
+         *
+         * For an overview of the replacement codes, see dateFormat.
+         */
+        dateFormat?: string;
+        /**
+         * (Highmaps) Formatter function to determine the date/time format used
+         * with points on datetime axes when describing them to screen reader
+         * users. Receives one argument, `point`, referring to the point to
+         * describe. Should return a date format string compatible with
+         * dateFormat.
+         */
+        dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        /**
+         * (Highmaps) Whether or not to describe points with the value `null` to
+         * assistive technology, such as screen readers.
+         */
+        describeNull?: boolean;
+        /**
+         * (Highmaps) A format string to use instead of the default for point
+         * descriptions.
+         *
+         * The context of the format string is the point instance.
+         *
+         * As opposed to accessibility.point.valueDescriptionFormat, this option
+         * replaces the whole description.
+         */
+        descriptionFormat?: string;
+        /**
+         * (Highmaps) Formatter function to use instead of the default for point
+         * descriptions. Same as `accessibility.point.descriptionFormatter`, but
+         * applies to a series instead of the whole chart.
+         *
+         * Note: Prefer using accessibility.point.valueDescriptionFormat instead
+         * if possible, as default functionality such as describing annotations
+         * will be preserved.
+         */
+        descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        /**
+         * (Highmaps) Decimals to use for the values in the point descriptions.
+         * Uses tooltip.valueDecimals if not defined.
+         */
+        valueDecimals?: number;
+        /**
+         * (Highmaps) Format to use for describing the values of data points to
+         * assistive technology - including screen readers. The point context is
+         * available as `{point}`.
+         *
+         * Other available context variables include `{index}`, `{value}`, and
+         * `{xDescription}`.
+         *
+         * Additionally, the series name, annotation info, and description added
+         * in `point.accessibility.description` is added by default if relevant.
+         * To override this, use the accessibility.point.descriptionFormatter
+         * option.
+         */
+        valueDescriptionFormat?: string;
+        /**
+         * (Highmaps) Prefix to add to the values in the point descriptions.
+         * Uses tooltip.valuePrefix if not defined.
+         */
+        valuePrefix?: string;
+        /**
+         * (Highmaps) Suffix to add to the values in the point descriptions.
+         * Uses tooltip.valueSuffix if not defined.
+         */
+        valueSuffix?: string;
+    }
+    /**
+     * (Highmaps) An array of data points for the series. For the `flowmap`
+     * series type, points can be given in the following ways:
+     *
+     * 1. An array of arrays with options as values. In this case, the values
+     * correspond to `from, to, weight`. Example: (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. (see online
+     * documentation for example)
+     *
+     * 3. For objects with named values, instead of using the `mappoint` `id`,
+     * you can use `[longitude, latitude]` arrays. (see online documentation for
+     * example)
+     */
+    interface SeriesFlowmapDataOptions {
+        /**
+         * (Highmaps) A `curveFactor` with a higher value than 0 will curve the
+         * link clockwise. A negative value will curve the link counter
+         * clockwise. If the value is 0 the link will be straight.
+         */
+        curveFactor?: number;
+        /**
+         * (Highmaps) The fill color of an individual link.
+         */
+        fillColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
+        /**
+         * (Highmaps) The opacity of the link color fill.
+         */
+        fillOpacity?: number;
+        /**
+         * (Highmaps) ID referencing a map point holding coordinates of the link
+         * origin or coordinates in terms of array of `[longitude, latitude]` or
+         * object with `lon` and `lat` properties.
+         */
+        from?: (string|Highcharts.LonLatArray|Highcharts.MapLonLatObject);
+        /**
+         * (Highmaps) If set to `true`, the line will grow towards its end.
+         */
+        growTowards?: boolean;
+        /**
+         * (Highmaps) Specify the `lineWidth` of the link.
+         */
+        lineWidth?: number;
+        /**
+         * (Highmaps) Specifying a `markerEnd` here will create an arrow symbol
+         * indicating the direction of flow at the destination of one individual
+         * link. If one has been previously specified at the higher level option
+         * it will be overridden for the current link.
+         */
+        markerEnd?: (Highcharts.SeriesFlowmapDataMarkerEndOptions|null);
+        /**
+         * (Highmaps) The opacity of an individual link.
+         */
+        opacity?: number;
+        /**
+         * (Highmaps) ID referencing a map point holding coordinates of the link
+         * origin or coordinates in terms of array of `[longitude, latitude]` or
+         * object with `lon` and `lat` properties.
+         */
+        to?: (string|Highcharts.LonLatArray|Highcharts.MapLonLatObject);
+        /**
+         * (Highmaps) The weight of a link determines its thickness compared to
+         * other links.
+         */
+        weight?: number;
+    }
+}

package/options/flowmap.src.d.ts

@@ -0,0 +1,152 @@
+/*!*
+ *
+ *  Copyright (c) Highsoft AS. All rights reserved.
+ *
+ *!*/
+import * as Highcharts from "../highcharts.src";
+declare module "../highcharts.src" {
+    /**
+     * (Highmaps) Point accessibility options for a series.
+     */
+    interface PlotFlowmapAccessibilityPointOptions {
+        /**
+         * (Highmaps) Date format to use for points on datetime axes when
+         * describing them to screen reader users.
+         *
+         * Defaults to the same format as in tooltip.
+         *
+         * For an overview of the replacement codes, see dateFormat.
+         */
+        dateFormat?: string;
+        /**
+         * (Highmaps) Formatter function to determine the date/time format used
+         * with points on datetime axes when describing them to screen reader
+         * users. Receives one argument, `point`, referring to the point to
+         * describe. Should return a date format string compatible with
+         * dateFormat.
+         */
+        dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        /**
+         * (Highmaps) Whether or not to describe points with the value `null` to
+         * assistive technology, such as screen readers.
+         */
+        describeNull?: boolean;
+        /**
+         * (Highmaps) A format string to use instead of the default for point
+         * descriptions.
+         *
+         * The context of the format string is the point instance.
+         *
+         * As opposed to accessibility.point.valueDescriptionFormat, this option
+         * replaces the whole description.
+         */
+        descriptionFormat?: string;
+        /**
+         * (Highmaps) Formatter function to use instead of the default for point
+         * descriptions. Same as `accessibility.point.descriptionFormatter`, but
+         * applies to a series instead of the whole chart.
+         *
+         * Note: Prefer using accessibility.point.valueDescriptionFormat instead
+         * if possible, as default functionality such as describing annotations
+         * will be preserved.
+         */
+        descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
+        /**
+         * (Highmaps) Decimals to use for the values in the point descriptions.
+         * Uses tooltip.valueDecimals if not defined.
+         */
+        valueDecimals?: number;
+        /**
+         * (Highmaps) Format to use for describing the values of data points to
+         * assistive technology - including screen readers. The point context is
+         * available as `{point}`.
+         *
+         * Other available context variables include `{index}`, `{value}`, and
+         * `{xDescription}`.
+         *
+         * Additionally, the series name, annotation info, and description added
+         * in `point.accessibility.description` is added by default if relevant.
+         * To override this, use the accessibility.point.descriptionFormatter
+         * option.
+         */
+        valueDescriptionFormat?: string;
+        /**
+         * (Highmaps) Prefix to add to the values in the point descriptions.
+         * Uses tooltip.valuePrefix if not defined.
+         */
+        valuePrefix?: string;
+        /**
+         * (Highmaps) Suffix to add to the values in the point descriptions.
+         * Uses tooltip.valueSuffix if not defined.
+         */
+        valueSuffix?: string;
+    }
+    /**
+     * (Highmaps) An array of data points for the series. For the `flowmap`
+     * series type, points can be given in the following ways:
+     *
+     * 1. An array of arrays with options as values. In this case, the values
+     * correspond to `from, to, weight`. Example: (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. (see online
+     * documentation for example)
+     *
+     * 3. For objects with named values, instead of using the `mappoint` `id`,
+     * you can use `[longitude, latitude]` arrays. (see online documentation for
+     * example)
+     */
+    interface SeriesFlowmapDataOptions {
+        /**
+         * (Highmaps) A `curveFactor` with a higher value than 0 will curve the
+         * link clockwise. A negative value will curve the link counter
+         * clockwise. If the value is 0 the link will be straight.
+         */
+        curveFactor?: number;
+        /**
+         * (Highmaps) The fill color of an individual link.
+         */
+        fillColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
+        /**
+         * (Highmaps) The opacity of the link color fill.
+         */
+        fillOpacity?: number;
+        /**
+         * (Highmaps) ID referencing a map point holding coordinates of the link
+         * origin or coordinates in terms of array of `[longitude, latitude]` or
+         * object with `lon` and `lat` properties.
+         */
+        from?: (string|Highcharts.LonLatArray|Highcharts.MapLonLatObject);
+        /**
+         * (Highmaps) If set to `true`, the line will grow towards its end.
+         */
+        growTowards?: boolean;
+        /**
+         * (Highmaps) Specify the `lineWidth` of the link.
+         */
+        lineWidth?: number;
+        /**
+         * (Highmaps) Specifying a `markerEnd` here will create an arrow symbol
+         * indicating the direction of flow at the destination of one individual
+         * link. If one has been previously specified at the higher level option
+         * it will be overridden for the current link.
+         */
+        markerEnd?: (Highcharts.SeriesFlowmapDataMarkerEndOptions|null);
+        /**
+         * (Highmaps) The opacity of an individual link.
+         */
+        opacity?: number;
+        /**
+         * (Highmaps) ID referencing a map point holding coordinates of the link
+         * origin or coordinates in terms of array of `[longitude, latitude]` or
+         * object with `lon` and `lat` properties.
+         */
+        to?: (string|Highcharts.LonLatArray|Highcharts.MapLonLatObject);
+        /**
+         * (Highmaps) The weight of a link determines its thickness compared to
+         * other links.
+         */
+        weight?: number;
+    }
+}