highcharts 8.2.0 → 8.2.2

package/highcharts.d.ts

@@ -533,9 +533,9 @@ export type PointMouseOutCallbackFunction = (this: Point, event: PointerEvent) =
  */
 export type PointMouseOverCallbackFunction = (this: Point, event: Event) => void;
 /**
- * Possible option types for a data point.
+ * Possible option types for a data point. Use `null` to indicate a gap.
  */
-export type PointOptionsType = (number|string|PointOptionsObject|Array<(number|string)>|null);
+export type PointOptionsType = (number|string|PointOptionsObject|Array<(number|string|null)>|null);
 /**
  * Gets fired when the point is removed using the `.remove()` method.
  *
@@ -864,7 +864,7 @@ export type TooltipFormatterCallbackFunction = (this: TooltipFormatterContextObj
  *
  * @return New position for the tooltip.
  */
-export type TooltipPositionerCallbackFunction = (this: Tooltip, labelWidth: number, labelHeight: number, point: (Point|TooltipPositionerPointObject)) => PositionObject;
+export type TooltipPositionerCallbackFunction = (this: Tooltip, labelWidth: number, labelHeight: number, point: TooltipPositionerPointObject) => PositionObject;
 export type TooltipShapeValue = ("callout"|"circle"|"square");
 export type VariablePieSizeByValue = ("area"|"radius");
 /**
@@ -1291,12 +1291,7 @@ export interface AnnotationControllable {
  * specific control point.
  */
 export interface AnnotationControlPointOptionsObject {
-    height?: number;
     positioner?: AnnotationControlPointPositionerFunction;
-    style?: (AnnotationsControlPointStyleOptions|NavigationAnnotationsControlPointStyleOptions);
-    symbol?: string;
-    visible?: boolean;
-    width?: number;
 }
 /**
  * (Highcharts, Highstock, Highmaps, Gantt) Accessibility options for an
@@ -1358,11 +1353,6 @@ export interface AnnotationsAnimationOptions {
      */
     defer?: number;
 }
-export interface AnnotationsControlPointStyleOptions {
-    fill?: string;
-    stroke?: string;
-    "stroke-width"?: number;
-}
 export interface AnnotationsCrookedLineControlPointOptions {
     events?: any;
 }
@@ -4298,13 +4288,13 @@ export interface AxisCurrentDateIndicatorOptions {
     zIndex?: number;
 }
 /**
- * (Gantt) For a datetime axis, the scale will automatically adjust to the
- * appropriate unit. This member gives the default string representations used
- * for each unit. For intermediate values, different units may be used, for
- * example the `day` unit can be used on midnight and `hour` unit be used for
- * intermediate values on the same axis. For grid axes (like in Gantt charts),
- * it is possible to declare as a list to provide different formats depending on
- * available space. For an overview of the replacement codes, see dateFormat.
+ * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
+ * automatically adjust to the appropriate unit. This member gives the default
+ * string representations used for each unit. For intermediate values, different
+ * units may be used, for example the `day` unit can be used on midnight and
+ * `hour` unit be used for intermediate values on the same axis.
+ *
+ * For an overview of the replacement codes, see dateFormat.
  *
  * Defaults to: (see online documentation for example)
  */
@@ -5726,14 +5716,14 @@ export interface ChartParallelAxesOptions {
      */
     crosshair?: (boolean|AxisCrosshairOptions);
     /**
-     * (Gantt) For a datetime axis, the scale will automatically adjust to the
-     * appropriate unit. This member gives the default string representations
-     * used for each unit. For intermediate values, different units may be used,
-     * for example the `day` unit can be used on midnight and `hour` unit be
-     * used for intermediate values on the same axis. For grid axes (like in
-     * Gantt charts), it is possible to declare as a list to provide different
-     * formats depending on available space. For an overview of the replacement
-     * codes, see dateFormat.
+     * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
+     * automatically adjust to the appropriate unit. This member gives the
+     * default string representations used for each unit. For intermediate
+     * values, different units may be used, for example the `day` unit can be
+     * used on midnight and `hour` unit be used for intermediate values on the
+     * same axis.
+     *
+     * For an overview of the replacement codes, see dateFormat.
      *
      * Defaults to: (see online documentation for example)
      */
@@ -7339,7 +7329,6 @@ export interface ColorAxisScrollbarOptions {
      * content is zoomed out to it full extent.
      */
     showFull?: boolean;
-    step?: number;
     /**
      * (Highstock) The color of the track background.
      */
@@ -11131,11 +11120,6 @@ export interface NavigationAnnotationsAnimationOptions {
      */
     defer?: number;
 }
-export interface NavigationAnnotationsControlPointStyleOptions {
-    fill?: string;
-    stroke?: string;
-    "stroke-width"?: number;
-}
 /**
  * (Highcharts, Highstock, Highmaps, Gantt) Events available in annotations.
  */
@@ -12102,7 +12086,7 @@ export interface NavigatorHandlesOptions {
      * (Highstock, Gantt) The width for the handle border and the stripes
      * inside.
      */
-    lineWidth?: number;
+    lineWidth?: object;
     /**
      * (Highstock, Gantt) Array to define shapes of handles. 0-index for left,
      * 1-index for right.
@@ -12957,14 +12941,14 @@ export interface NavigatorXAxisOptions {
      */
     currentDateIndicator?: (boolean|AxisCurrentDateIndicatorOptions);
     /**
-     * (Gantt) For a datetime axis, the scale will automatically adjust to the
-     * appropriate unit. This member gives the default string representations
-     * used for each unit. For intermediate values, different units may be used,
-     * for example the `day` unit can be used on midnight and `hour` unit be
-     * used for intermediate values on the same axis. For grid axes (like in
-     * Gantt charts), it is possible to declare as a list to provide different
-     * formats depending on available space. For an overview of the replacement
-     * codes, see dateFormat.
+     * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
+     * automatically adjust to the appropriate unit. This member gives the
+     * default string representations used for each unit. For intermediate
+     * values, different units may be used, for example the `day` unit can be
+     * used on midnight and `hour` unit be used for intermediate values on the
+     * same axis.
+     *
+     * For an overview of the replacement codes, see dateFormat.
      *
      * Defaults to: (see online documentation for example)
      */
@@ -14215,14 +14199,14 @@ export interface NavigatorYAxisOptions {
      */
     crosshair?: (boolean|AxisCrosshairOptions);
     /**
-     * (Gantt) For a datetime axis, the scale will automatically adjust to the
-     * appropriate unit. This member gives the default string representations
-     * used for each unit. For intermediate values, different units may be used,
-     * for example the `day` unit can be used on midnight and `hour` unit be
-     * used for intermediate values on the same axis. For grid axes (like in
-     * Gantt charts), it is possible to declare as a list to provide different
-     * formats depending on available space. For an overview of the replacement
-     * codes, see dateFormat.
+     * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
+     * automatically adjust to the appropriate unit. This member gives the
+     * default string representations used for each unit. For intermediate
+     * values, different units may be used, for example the `day` unit can be
+     * used on midnight and `hour` unit be used for intermediate values on the
+     * same axis.
+     *
+     * For an overview of the replacement codes, see dateFormat.
      *
      * Defaults to: (see online documentation for example)
      */
@@ -15271,13 +15255,6 @@ export interface NavigatorYAxisTitleOptions {
      */
     y?: number;
 }
-/**
- * (Highcharts, Highstock, Gantt) An object of additional SVG attributes for the
- * no-data label.
- */
-export interface NoDataAttrOptions {
-    zIndex?: number;
-}
 /**
  * (Highcharts, Highstock, Gantt) Options for displaying a message like "No data
  * to display". This feature requires the file no-data-to-display.js to be
@@ -15289,7 +15266,7 @@ export interface NoDataOptions {
      * (Highcharts, Highstock, Gantt) An object of additional SVG attributes for
      * the no-data label.
      */
-    attr?: (NoDataAttrOptions|SVGAttributes);
+    attr?: SVGAttributes;
     /**
      * (Highcharts, Highstock, Gantt) The position of the no-data label,
      * relative to the plot area.
@@ -42690,7 +42667,7 @@ export interface PlotFlagsOptions {
      *
      * This option is set by default to 1 if data sorting is enabled.
      */
-    pointRange?: number;
+    pointRange?: (number|null);
     /**
      * (Highcharts, Highstock, Gantt) If no x values are given for the points in
      * a series, pointStart defines on what value to start. For example, if a
@@ -48363,7 +48340,6 @@ export interface PlotIkhSenkouSpanOptions {
      * Span A is under Senkou Span B.
      */
     negativeColor?: (ColorString|GradientColorObject|PatternObject);
-    styles?: any;
 }
 /**
  * (Highstock) The styles for Tenkan line
@@ -57293,7 +57269,7 @@ export interface PlotMaplineOptions {
      * In styled mode, the border stroke is given in the `.highcharts-point`
      * class.
      */
-    borderColor?: string;
+    borderColor?: (ColorString|GradientColorObject|PatternObject);
     /**
      * (Highmaps) The border width of each map area.
      *
@@ -57568,7 +57544,7 @@ export interface PlotMaplineOptions {
      * points and have a backend that can preprocess the data into a parallel
      * array of the mapData.
      */
-    joinBy?: string;
+    joinBy?: (string|Array<string>);
     /**
      * (Highmaps) An array specifying which option maps to which key in the data
      * point array. This makes it convenient to work with unstructured data
@@ -57906,7 +57882,7 @@ export interface PlotMapOptions {
      * In styled mode, the border stroke is given in the `.highcharts-point`
      * class.
      */
-    borderColor?: string;
+    borderColor?: (ColorString|GradientColorObject|PatternObject);
     /**
      * (Highmaps) The border width of each map area.
      *
@@ -58177,7 +58153,7 @@ export interface PlotMapOptions {
      * points and have a backend that can preprocess the data into a parallel
      * array of the mapData.
      */
-    joinBy?: string;
+    joinBy?: (string|Array<string>);
     /**
      * (Highmaps) An array specifying which option maps to which key in the data
      * point array. This makes it convenient to work with unstructured data
@@ -88768,7 +88744,7 @@ export interface PlotTreemapOptions {
      * `options.colors` collection, this option determines whether the chart
      * should receive one color per series or one color per point.
      */
-    colorByPoint?: boolean;
+    colorByPoint?: object;
     /**
      * (Highcharts) Styled mode only. A specific color index to use for the
      * series, so its graphic representations are given the class name
@@ -102714,7 +102690,6 @@ export interface ScrollbarOptions {
      * scrolled content is zoomed out to it full extent.
      */
     showFull?: boolean;
-    step?: number;
     /**
      * (Highstock, Gantt) The color of the track background.
      */
@@ -108607,7 +108582,6 @@ export interface SeriesPieDataLabelsOptionsObject {
      * area.
      */
     alignTo?: string;
-    allowOverlap?: boolean;
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
      * animation when a series is displayed for the `dataLabels`. The animation
@@ -110551,11 +110525,6 @@ export interface SeriesStatesHoverOptionsObject {
      * (Highmaps) The color of the shape in this state.
      */
     color?: (ColorString|GradientColorObject|PatternObject);
-    /**
-     * (Highcharts, Highstock) The additional connector line width for a hovered
-     * point.
-     */
-    connectorWidthPlus?: number;
     /**
      * (Highstock) Enable separate styles for the hovered series to visualize
      * that the user hovers either the series itself or the legend.
@@ -111556,8 +111525,8 @@ export interface SeriesTooltipOptionsObject {
     nullFormatter?: TooltipFormatterCallbackFunction;
     /**
      * (Highstock) The HTML of the point's line in the tooltip. Variables are
-     * enclosed by curly brackets. Available variables are point.x, point.y,
-     * series. name and series.color and other properties on the same form.
+     * enclosed by curly brackets. Available variables are `point.x`, `point.y`,
+     * `series.name` and `series.color` and other properties on the same form.
      * Furthermore, `point.y` can be extended by the `tooltip.valuePrefix` and
      * `tooltip.valueSuffix` variables. This can also be overridden for each
      * series, which makes it a good hook for displaying units.
@@ -111572,11 +111541,6 @@ export interface SeriesTooltipOptionsObject {
      * flexibility.
      */
     pointFormatter?: FormatterCallbackFunction<Point>;
-    /**
-     * (Highstock) Prevents the tooltip from switching or closing, when touched
-     * or pointed.
-     */
-    stickOnContact?: boolean;
     /**
      * (Highstock) Number of decimals in indicator series.
      */
@@ -113070,9 +113034,10 @@ export interface StockToolsGuiDefinitionsZoomChangeZoomYOptions {
 export interface StockToolsGuiOptions {
     /**
      * (Highstock) A collection of strings pointing to config options for the
-     * toolbar items. Each name refers to unique key from definitions object.
+     * toolbar items. Each name refers to a unique key from the definitions
+     * object.
      */
-    buttons?: string;
+    buttons?: Array<string>;
     /**
      * (Highstock) A CSS class name to apply to the stocktools' div, allowing
      * unique CSS styling for each chart.
@@ -113506,7 +113471,7 @@ export interface TimelineDataLabelsOptionsObject {
      * depends on the data, for instance in a column chart, the label is above
      * positive values and below negative values.
      */
-    verticalAlign?: string;
+    verticalAlign?: (VerticalAlignValue|null);
     width?: number;
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
@@ -113901,10 +113866,10 @@ export interface TooltipOptions {
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) The HTML of the point's line in
      * the tooltip. Variables are enclosed by curly brackets. Available
-     * variables are point.x, point.y, series. name and series.color and other
-     * properties on the same form. Furthermore, `point.y` can be extended by
-     * the `tooltip.valuePrefix` and `tooltip.valueSuffix` variables. This can
-     * also be overridden for each series, which makes it a good hook for
+     * variables are `point.x`, `point.y`, `series.name` and `series.color` and
+     * other properties on the same form. Furthermore, `point.y` can be extended
+     * by the `tooltip.valuePrefix` and `tooltip.valueSuffix` variables. This
+     * can also be overridden for each series, which makes it a good hook for
      * displaying units.
      *
      * In styled mode, the dot is colored by a class name rather than the point
@@ -114026,7 +113991,7 @@ export interface TooltipOptions {
 /**
  * Point information for positioning a tooltip.
  */
-export interface TooltipPositionerPointObject {
+export interface TooltipPositionerPointObject extends Point {
     /**
      * If `tooltip.split` option is enabled and positioner is called for each of
      * the boxes separately, this property indicates the call on the xAxis
@@ -114497,14 +114462,14 @@ export interface XAxisOptions {
      */
     currentDateIndicator?: (boolean|AxisCurrentDateIndicatorOptions);
     /**
-     * (Gantt) For a datetime axis, the scale will automatically adjust to the
-     * appropriate unit. This member gives the default string representations
-     * used for each unit. For intermediate values, different units may be used,
-     * for example the `day` unit can be used on midnight and `hour` unit be
-     * used for intermediate values on the same axis. For grid axes (like in
-     * Gantt charts), it is possible to declare as a list to provide different
-     * formats depending on available space. For an overview of the replacement
-     * codes, see dateFormat.
+     * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
+     * automatically adjust to the appropriate unit. This member gives the
+     * default string representations used for each unit. For intermediate
+     * values, different units may be used, for example the `day` unit can be
+     * used on midnight and `hour` unit be used for intermediate values on the
+     * same axis.
+     *
+     * For an overview of the replacement codes, see dateFormat.
      *
      * Defaults to: (see online documentation for example)
      */
@@ -115391,7 +115356,6 @@ export interface XAxisScrollbarOptions {
      * content is zoomed out to it full extent.
      */
     showFull?: boolean;
-    step?: number;
     /**
      * (Highstock) The color of the track background.
      */
@@ -116143,14 +116107,14 @@ export interface YAxisOptions {
      */
     crosshair?: (boolean|AxisCrosshairOptions);
     /**
-     * (Gantt) For a datetime axis, the scale will automatically adjust to the
-     * appropriate unit. This member gives the default string representations
-     * used for each unit. For intermediate values, different units may be used,
-     * for example the `day` unit can be used on midnight and `hour` unit be
-     * used for intermediate values on the same axis. For grid axes (like in
-     * Gantt charts), it is possible to declare as a list to provide different
-     * formats depending on available space. For an overview of the replacement
-     * codes, see dateFormat.
+     * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
+     * automatically adjust to the appropriate unit. This member gives the
+     * default string representations used for each unit. For intermediate
+     * values, different units may be used, for example the `day` unit can be
+     * used on midnight and `hour` unit be used for intermediate values on the
+     * same axis.
+     *
+     * For an overview of the replacement codes, see dateFormat.
      *
      * Defaults to: (see online documentation for example)
      */
@@ -117181,7 +117145,6 @@ export interface YAxisScrollbarOptions {
      * scrollbar. Defaults to 20 on touch devices.
      */
     size?: number;
-    step?: number;
     /**
      * (Highstock) The color of the track background.
      */
@@ -117872,14 +117835,14 @@ export interface ZAxisOptions {
      */
     currentDateIndicator?: (boolean|AxisCurrentDateIndicatorOptions);
     /**
-     * (Gantt) For a datetime axis, the scale will automatically adjust to the
-     * appropriate unit. This member gives the default string representations
-     * used for each unit. For intermediate values, different units may be used,
-     * for example the `day` unit can be used on midnight and `hour` unit be
-     * used for intermediate values on the same axis. For grid axes (like in
-     * Gantt charts), it is possible to declare as a list to provide different
-     * formats depending on available space. For an overview of the replacement
-     * codes, see dateFormat.
+     * (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
+     * automatically adjust to the appropriate unit. This member gives the
+     * default string representations used for each unit. For intermediate
+     * values, different units may be used, for example the `day` unit can be
+     * used on midnight and `hour` unit be used for intermediate values on the
+     * same axis.
+     *
+     * For an overview of the replacement codes, see dateFormat.
      *
      * Defaults to: (see online documentation for example)
      */
@@ -118696,7 +118659,6 @@ export interface ZAxisScrollbarOptions {
      * content is zoomed out to it full extent.
      */
     showFull?: boolean;
-    step?: number;
     /**
      * (Highstock) The color of the track background.
      */
@@ -119168,9 +119130,12 @@ export class Axis {
      * @param to
      *        The axis value to end on.
      *
+     * @param options
+     *        The plotBand or plotLine configuration object.
+     *
      * @return The SVG path definition in array form.
      */
-    getPlotBandPath(from: number, to: number): SVGPathArray;
+    getPlotBandPath(from: number, to: number, options: (AxisPlotBandsOptions|AxisPlotLinesOptions)): SVGPathArray;
     /**
      * Create the path for a plot line that goes from the given value on this
      * axis, across the plot to the opposite side. Also used internally for grid
@@ -120350,48 +120315,6 @@ export class Pointer {
      */
     reset(allowMove?: boolean, delay?: number): void;
 }
-/**
- * This is the base series prototype that all other series types inherit from. A
- * new series is initialized either through the series option structure, or
- * after the chart is initialized, through Highcharts.Chart#addSeries.
- *
- * The object can be accessed in a number of ways. All series and point event
- * handlers give a reference to the `series` object. The chart object has a
- * series property that is a collection of all the chart's series. The point
- * objects and axis objects also have the same reference.
- *
- * Another way to reference the series programmatically is by `id`. Add an id in
- * the series configuration options, and get the series object by
- * Highcharts.Chart#get.
- *
- * Configuration options for the series are given in three levels. Options for
- * all series in a chart are given in the plotOptions.series object. Then
- * options for all series of a specific type are given in the plotOptions of
- * that type, for example `plotOptions.line`. Next, options for one single
- * series are given in the series array, or as arguments to `chart.addSeries`.
- *
- * The data in the series is stored in various arrays.
- *
- * - First, `series.options.data` contains all the original config options for
- * each point whether added by options or methods like `series.addPoint`.
- *
- * - Next, `series.data` contains those values converted to points, but in case
- * the series data length exceeds the `cropThreshold`, or if the data is
- * grouped, `series.data` doesn't contain all the points. It only contains the
- * points that have been created on demand.
- *
- * - Then there's `series.points` that contains all currently visible point
- * objects. In case of cropping, the cropped-away points are not part of this
- * array. The `series.points` array starts at `series.cropStart` compared to
- * `series.data` and `series.options.data`. If however the series data is
- * grouped, these can't be correlated one to one.
- *
- * - `series.xData` and `series.processedXData` contain clean x values,
- * equivalent to `series.data` and `series.points`.
- *
- * - `series.yData` and `series.processedYData` contain clean y values,
- * equivalent to `series.data` and `series.points`.
- */
 export class Series {
     /**
      * This is the base series prototype that all other series types inherit
@@ -122376,9 +122299,16 @@ export function format(str: string, ctx: Record<string, any>, chart?: Chart): st
  * @param chart
  *        The chart instance.
  *
+ * @param animation
+ *        An animation setting. Can be an object with duration, complete and
+ *        easing properties, or a boolean to enable or disable.
+ *
+ * @param series
+ *        Series to defer animation.
+ *
  * @return The numeric value.
  */
-export function getDeferredAnimation(chart: Chart): number;
+export function getDeferredAnimation(chart: Chart, animation: (boolean|AnimationOptionsObject), series?: Series): number;
 /**
  * Get the magnitude of a number.
  *