highcharts 12.3.0 → 12.4.0

package/highcharts.d.ts

@@ -6302,6 +6302,15 @@ export interface ChartOptions {
      * marker square when selecting (zooming in on) an area of the chart.
      */
     selectionMarkerFill?: (ColorString|GradientColorObject|PatternObject);
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) Whether to apply a drop shadow
+     * to the global series group. This causes all the series to have the same
+     * shadow. Contrary to the `series.shadow` option, this prevents items from
+     * casting shadows on each other, like for others series in a stack. The
+     * shadow can be an object configuration containing `color`, `offsetX`,
+     * `offsetY`, `opacity` and `width`.
+     */
+    seriesGroupShadow?: (boolean|ShadowOptionsObject);
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Whether to apply a drop shadow
      * to the outer chart area. Requires that backgroundColor be set. The shadow
@@ -6448,11 +6457,6 @@ export interface ChartParallelAxesEventsOptions {
      * a point.
      */
     pointBreak?: AxisPointBreakEventCallbackFunction;
-    /**
-     * (Highcharts, Highstock, Gantt) An event fired when a point is outside a
-     * break after zoom.
-     */
-    pointBreakOut?: AxisPointBreakEventCallbackFunction;
     /**
      * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
      * break from this axis.
@@ -7601,11 +7605,6 @@ export interface ColorAxisEventsOptions {
      * @deprecated 11.4.4
      */
     legendItemClick?: Function;
-    /**
-     * (Highcharts, Highstock, Gantt) An event fired when a point is outside a
-     * break after zoom.
-     */
-    pointBreakOut?: AxisPointBreakEventCallbackFunction;
     /**
      * (Highcharts, Highstock, Highmaps) Fires when the minimum and maximum is
      * set for the axis, either by calling the `.setExtremes()` method or by
@@ -8149,9 +8148,7 @@ export interface ColorAxisOptions {
     range?: number;
     /**
      * (Highcharts, Highstock, Highmaps) Whether to reverse the axis so that the
-     * highest number is closest to the origin. Defaults to `false` in a
-     * horizontal legend and `true` in a vertical legend, where the smallest
-     * value starts on top.
+     * highest number is closest to the origin. Defaults to `false`.
      */
     reversed?: boolean;
     /**
@@ -12094,7 +12091,7 @@ export interface LangOptions {
      * (Highcharts, Highstock, Highmaps, Gantt) An array containing the months
      * names. Corresponds to the `%B` format in `Highcharts.dateFormat()`.
      * Defaults to 'undefined', meaning the default month names are used
-     * according to the `lang.locale` setting.
+     * according to the `lang.locale` or browser settings.
      */
     months?: Array<string>;
     /**
@@ -12171,13 +12168,15 @@ export interface LangOptions {
      * (Highcharts, Highstock, Highmaps, Gantt) An array containing the months
      * names in abbreviated form. Corresponds to the `%b` format in
      * `Highcharts.dateFormat()`. Defaults to 'undefined', meaning the default
-     * short month names are used according to the `lang.locale` setting.
+     * short month names are used according to the `lang.locale` or browser
+     * settings.
      */
     shortMonths?: Array<string>;
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) Short week days, starting
-     * Sunday. Defaults to 'undefined', meaning the default short weekday names
-     * are used according to the `lang.locale` setting.
+     * Sunday. Corresponds to the `%a` format in `Highcharts.dateFormat()`.
+     * Defaults to 'undefined', meaning the default short weekday names are used
+     * according to the `lang.locale` or browser settings.
      */
     shortWeekdays?: Array<string>;
     /**
@@ -12203,8 +12202,9 @@ export interface LangOptions {
     viewFullscreen?: string;
     /**
      * (Highcharts, Highstock, Highmaps, Gantt) An array containing the weekday
-     * names. Defaults to 'undefined', meaning the default weekday names are
-     * used according to the `lang.locale` setting.
+     * names. Corresponds to the `%A` format in `Highcharts.dateFormat()`.
+     * Defaults to 'undefined', meaning the default weekday names are used
+     * according to the `lang.locale` or browser settings.
      */
     weekdays?: Array<string>;
     weekFrom?: string;
@@ -12552,6 +12552,7 @@ export interface LegendItemClickEventObject {
 }
 export interface LegendItemObject {
     item?: SVGElement;
+    label?: SVGElement;
     line?: SVGElement;
     symbol?: SVGElement;
 }
@@ -18194,11 +18195,6 @@ export interface NavigatorXAxisEventsOptions {
      * a point.
      */
     pointBreak?: AxisPointBreakEventCallbackFunction;
-    /**
-     * (Highcharts, Highstock, Gantt) An event fired when a point is outside a
-     * break after zoom.
-     */
-    pointBreakOut?: AxisPointBreakEventCallbackFunction;
     /**
      * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
      * break from this axis.
@@ -19461,11 +19457,6 @@ export interface NavigatorYAxisEventsOptions {
      * a point.
      */
     pointBreak?: AxisPointBreakEventCallbackFunction;
-    /**
-     * (Highcharts, Highstock, Gantt) An event fired when a point is outside a
-     * break after zoom.
-     */
-    pointBreakOut?: AxisPointBreakEventCallbackFunction;
     /**
      * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
      * break from this axis.
@@ -97339,11 +97330,6 @@ export interface XAxisEventsOptions {
      * a point.
      */
     pointBreak?: AxisPointBreakEventCallbackFunction;
-    /**
-     * (Highcharts, Highstock, Gantt) An event fired when a point is outside a
-     * break after zoom.
-     */
-    pointBreakOut?: AxisPointBreakEventCallbackFunction;
     /**
      * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
      * break from this axis.
@@ -99102,11 +99088,6 @@ export interface YAxisEventsOptions {
      * a point.
      */
     pointBreak?: AxisPointBreakEventCallbackFunction;
-    /**
-     * (Highcharts, Highstock, Gantt) An event fired when a point is outside a
-     * break after zoom.
-     */
-    pointBreakOut?: AxisPointBreakEventCallbackFunction;
     /**
      * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
      * break from this axis.
@@ -100961,11 +100942,6 @@ export interface ZAxisEventsOptions {
      * a point.
      */
     pointBreak?: AxisPointBreakEventCallbackFunction;
-    /**
-     * (Highcharts, Highstock, Gantt) An event fired when a point is outside a
-     * break after zoom.
-     */
-    pointBreakOut?: AxisPointBreakEventCallbackFunction;
     /**
      * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
      * break from this axis.
@@ -103550,6 +103526,12 @@ export class Point {
      * Pie series only. Whether to display a slice offset from the center.
      */
     sliced?: boolean;
+    /**
+     * Defines the tooltip's position for a data point in a chart. It is an
+     * array of numbers representing the coordinates for the tooltip's
+     * placement, allowing for precise control over its location.
+     */
+    readonly tooltipPos?: Readonly<Array<number>>;
     /**
      * The total of values in either a stack for stacked series, or a pie in a
      * pie series.
@@ -104938,13 +104920,13 @@ disabledState?: SVGAttributes, shape?: SymbolKeyValue, useHTML?: boolean): SVGEl
      * Utility to return the baseline offset and total line height from the font
      * size.
      *
-     * @param element
+     * @param ref
      *        The element to inspect for a current font size. If a number is
      *        given, it's used as a fall back for direct font size in pixels.
      *
      * @return The font metrics.
      */
-    fontMetrics(element?: (number|SVGDOMElement|SVGElement)): FontMetricsObject;
+    fontMetrics(ref: (number|SVGDOMElement|SVGElement)): FontMetricsObject;
     /**
      * Create and return an svg group element. Child Highcharts.SVGElement
      * objects are added to the group by using the group as the first parameter