highcharts 12.0.0 → 12.0.2

package/options/lollipop.d.ts

@@ -0,0 +1,216 @@
+/*!*
+ *
+ *  Copyright (c) Highsoft AS. All rights reserved.
+ *
+ *!*/
+import * as Highcharts from "../highcharts";
+declare module "../highcharts" {
+    /**
+     * (Highcharts, Highstock) Point accessibility options for a series.
+     */
+    interface PlotLollipopAccessibilityPointOptions {
+        /**
+         * (Highcharts, Highstock) 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;
+        /**
+         * (Highcharts, Highstock) 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>;
+        /**
+         * (Highcharts, Highstock) Whether or not to describe points with the
+         * value `null` to assistive technology, such as screen readers.
+         */
+        describeNull?: boolean;
+        /**
+         * (Highcharts, Highstock) 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;
+        /**
+         * (Highcharts, Highstock) 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>;
+        /**
+         * (Highcharts, Highstock) Decimals to use for the values in the point
+         * descriptions. Uses tooltip.valueDecimals if not defined.
+         */
+        valueDecimals?: number;
+        /**
+         * (Highcharts, Highstock) 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;
+        /**
+         * (Highcharts, Highstock) Prefix to add to the values in the point
+         * descriptions. Uses tooltip.valuePrefix if not defined.
+         */
+        valuePrefix?: string;
+        /**
+         * (Highcharts, Highstock) Suffix to add to the values in the point
+         * descriptions. Uses tooltip.valueSuffix if not defined.
+         */
+        valueSuffix?: string;
+    }
+    /**
+     * (Highcharts, Highstock) Options for the series data sorting.
+     */
+    interface PlotLollipopDataSortingOptions {
+        /**
+         * (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) 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 PlotLollipopOnPointConnectorOptions {
+        /**
+         * (Highcharts, Highstock) A name for the dash style to use for the
+         * connector.
+         */
+        dashstyle?: string;
+        /**
+         * (Highcharts, Highstock) Color of the connector line. By default it's
+         * the series' color.
+         */
+        stroke?: string;
+        /**
+         * (Highcharts, Highstock) Pixel width of the connector line.
+         */
+        width?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Options allowing to set a position and an offset
+     * of the series in the _Series on point_ feature.
+     */
+    interface PlotLollipopOnPointPositionOptions {
+        /**
+         * (Highcharts, Highstock) 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) 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) X position of the series center. By default,
+         * the series is displayed on the point that it is connected to.
+         */
+        x?: number;
+        /**
+         * (Highcharts, Highstock) Y position of the series center. By default,
+         * the series is displayed on the point that it is connected to.
+         */
+        y?: number;
+    }
+    /**
+     * (Highcharts, Highstock) The `lollipop` 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 `lollipop` series are defined in plotOptions.lollipop.
+     *
+     * 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 `SeriesLollipopOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesLollipopOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesLollipopOptions extends Highcharts.PlotLollipopOptions, Highcharts.SeriesOptions {
+        /**
+         * (Highcharts, Highstock) An array of data points for the series. For
+         * the `lollipop` series type, points can be given in the following
+         * ways:
+         *
+         * 1. An array of numerical values. In this case, the numerical values
+         * will be interpreted as `y` options. The `x` values will be
+         * automatically calculated, either starting at 0 and incremented by 1,
+         * or from `pointStart` and `pointInterval` given in the series options.
+         * If the axis has categories, these will be used. Example: (see online
+         * documentation for example)
+         *
+         * 2. An array of arrays with 2 values. In this case, the values
+         * correspond to `x,y`. If the first value is a string, it is applied as
+         * the name of the point, and the `x` value is inferred. (see online
+         * documentation for example)
+         *
+         * 3. 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|[(number|string), (number|null)]|null|Highcharts.PointOptionsObject)>;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "lollipop";
+    }
+}

package/options/lollipop.src.d.ts

@@ -0,0 +1,216 @@
+/*!*
+ *
+ *  Copyright (c) Highsoft AS. All rights reserved.
+ *
+ *!*/
+import * as Highcharts from "../highcharts.src";
+declare module "../highcharts.src" {
+    /**
+     * (Highcharts, Highstock) Point accessibility options for a series.
+     */
+    interface PlotLollipopAccessibilityPointOptions {
+        /**
+         * (Highcharts, Highstock) 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;
+        /**
+         * (Highcharts, Highstock) 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>;
+        /**
+         * (Highcharts, Highstock) Whether or not to describe points with the
+         * value `null` to assistive technology, such as screen readers.
+         */
+        describeNull?: boolean;
+        /**
+         * (Highcharts, Highstock) 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;
+        /**
+         * (Highcharts, Highstock) 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>;
+        /**
+         * (Highcharts, Highstock) Decimals to use for the values in the point
+         * descriptions. Uses tooltip.valueDecimals if not defined.
+         */
+        valueDecimals?: number;
+        /**
+         * (Highcharts, Highstock) 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;
+        /**
+         * (Highcharts, Highstock) Prefix to add to the values in the point
+         * descriptions. Uses tooltip.valuePrefix if not defined.
+         */
+        valuePrefix?: string;
+        /**
+         * (Highcharts, Highstock) Suffix to add to the values in the point
+         * descriptions. Uses tooltip.valueSuffix if not defined.
+         */
+        valueSuffix?: string;
+    }
+    /**
+     * (Highcharts, Highstock) Options for the series data sorting.
+     */
+    interface PlotLollipopDataSortingOptions {
+        /**
+         * (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) 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 PlotLollipopOnPointConnectorOptions {
+        /**
+         * (Highcharts, Highstock) A name for the dash style to use for the
+         * connector.
+         */
+        dashstyle?: string;
+        /**
+         * (Highcharts, Highstock) Color of the connector line. By default it's
+         * the series' color.
+         */
+        stroke?: string;
+        /**
+         * (Highcharts, Highstock) Pixel width of the connector line.
+         */
+        width?: number;
+    }
+    /**
+     * (Highcharts, Highstock) Options allowing to set a position and an offset
+     * of the series in the _Series on point_ feature.
+     */
+    interface PlotLollipopOnPointPositionOptions {
+        /**
+         * (Highcharts, Highstock) 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) 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) X position of the series center. By default,
+         * the series is displayed on the point that it is connected to.
+         */
+        x?: number;
+        /**
+         * (Highcharts, Highstock) Y position of the series center. By default,
+         * the series is displayed on the point that it is connected to.
+         */
+        y?: number;
+    }
+    /**
+     * (Highcharts, Highstock) The `lollipop` 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 `lollipop` series are defined in plotOptions.lollipop.
+     *
+     * 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 `SeriesLollipopOptions` via an interface to allow
+     * custom properties: ``` declare interface SeriesLollipopOptions {
+     * customProperty: string; }
+     *
+     */
+    interface SeriesLollipopOptions extends Highcharts.PlotLollipopOptions, Highcharts.SeriesOptions {
+        /**
+         * (Highcharts, Highstock) An array of data points for the series. For
+         * the `lollipop` series type, points can be given in the following
+         * ways:
+         *
+         * 1. An array of numerical values. In this case, the numerical values
+         * will be interpreted as `y` options. The `x` values will be
+         * automatically calculated, either starting at 0 and incremented by 1,
+         * or from `pointStart` and `pointInterval` given in the series options.
+         * If the axis has categories, these will be used. Example: (see online
+         * documentation for example)
+         *
+         * 2. An array of arrays with 2 values. In this case, the values
+         * correspond to `x,y`. If the first value is a string, it is applied as
+         * the name of the point, and the `x` value is inferred. (see online
+         * documentation for example)
+         *
+         * 3. 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|[(number|string), (number|null)]|null|Highcharts.PointOptionsObject)>;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "lollipop";
+    }
+}