apexcharts 8.2.0 → 8.3.1

package/types/apexcharts.d.ts

@@ -336,11 +336,11 @@ declare class ApexCharts {
   /** Returns the sum of all data points whose x value falls within [minX, maxX]. */
   getSeriesTotalXRange(minX: number, maxX: number): number[]
 
-  /** Returns the highest y value in the specified series. */
-  getHighestValueInSeries(seriesIndex?: number): number
+  /** Returns the highest y value in the specified series, or undefined for an index with no series. */
+  getHighestValueInSeries(seriesIndex?: number): number | undefined
 
-  /** Returns the lowest y value in the specified series. */
-  getLowestValueInSeries(seriesIndex?: number): number
+  /** Returns the lowest y value in the specified series, or undefined for an index with no series. */
+  getLowestValueInSeries(seriesIndex?: number): number | undefined
 
   /** Returns the sum of each series (totals used for percentage calculations). */
   getSeriesTotal(): number[]
@@ -2131,6 +2131,7 @@ type ApexChart = {
   /** Strata (#2) series renderer. Requires `import 'apexcharts/features/renderer-canvas'` for non-SVG. */
   renderer?: 'svg' | 'canvas' | 'auto'
   rendererThreshold?: number
+  /** @deprecated Has no effect; removed in 9.0. Use `renderer` instead. */
   layers?: {
     series?: 'svg' | 'canvas' | 'auto'
     grid?: 'svg'
@@ -2236,13 +2237,21 @@ type ApexChart = {
     type?: 'x' | 'y' | 'xy'
     autoScaleYaxis?: boolean
     /**
-     * Cursor-anchored zoom on mouse wheel / trackpad. `'auto'` enables it only
-     * when the toolbar's reset button is present, so an unintended scroll-zoom
-     * is always undoable; `true` forces it on even with the toolbar hidden.
-     * Requires `enabled: true`.
+     * Cursor-anchored zoom on mouse wheel / trackpad. `'auto'` is cooperative:
+     * a bare wheel scrolls the page, and Ctrl/Cmd + wheel (or a trackpad
+     * pinch) zooms. It is offered only when the toolbar's reset button is
+     * present, so a zoom is always undoable. `true` zooms on every wheel, even
+     * with the toolbar hidden. Requires `enabled: true`.
      * @default 'auto'
      */
     allowMouseWheelZoom?: boolean | 'auto'
+    /**
+     * With the cooperative `'auto'` wheel, a bare scroll over the chart
+     * briefly shows how to zoom it. The text is the locale's
+     * `toolbar.wheelZoomHint`, where `{key}` becomes Ctrl or ⌘.
+     * @default true
+     */
+    wheelHint?: boolean
     /**
      * Momentum: enable two-finger pinch-zoom on touch devices. Zooms the x-axis
      * around the pinch centroid, frame-by-frame. `'auto'` enables it only when
@@ -2398,6 +2407,7 @@ type ApexChart = {
   }
   dataReducer?: {
     enabled?: boolean
+    /** @deprecated Has no effect; removed in 9.0. */
     algorithm?: 'lttb'
     targetPoints?: number
     threshold?: number
@@ -2869,6 +2879,8 @@ type ApexLocale = {
       exportToSVG?: string
       exportToPNG?: string
       exportToCSV?: string
+      /** The cooperative wheel's hint; `{key}` becomes Ctrl or ⌘. Default 'Use {key} + scroll to zoom'. */
+      wheelZoomHint?: string
     }
     /** The highlight filter add-on's words. */
     highlightFilter?: {
@@ -3781,7 +3793,8 @@ type ApexPlotOptions = {
      * recolours) across a regroup - the circles-to-bars transition.
      * 'identity': keyed by each datum's `id`/`name`, so a SPECIFIC unit migrates
      * across any regroup or relayout keeping its colour and size. Requires the
-     * per-unit object form with unique ids/names.
+     * per-unit object form with unique ids/names (a repeated one is tracked by
+     * its order of appearance).
      */
     transition?: 'group' | 'flow' | 'identity'
     /**
@@ -3919,7 +3932,10 @@ type ApexPlotOptions = {
       sizeField?: string
       /** `[minRadius, maxRadius]` in px: turns dots into area-scaled bubbles. */
       sizeRange?: [number, number]
-      /** Left-gutter width reserved for lane (category) labels (lanes mode). */
+      /**
+       * Left-gutter width reserved for lane (category) labels (lanes mode).
+       * Defaults to the widest label, up to a third of the plot.
+       */
       laneLabelWidth?: number
       /** Draw the faint gridlines. Defaults to true. */
       gridlines?: boolean
@@ -3991,7 +4007,11 @@ type ApexPlotOptions = {
     borderRadius?: number
     /** 1 dot represents this many units of value (waffle scaling). */
     unitValue?: number
-    /** Safety cap on total dots; counts scale down proportionally above it. */
+    /**
+     * Safety cap on total dots; counts scale down proportionally above it (a
+     * scatter keeps an even sample of each category). A split grid draws a
+     * fixed number of cells per tile and is not capped.
+     */
     maxUnits?: number
     /** Packed layout: order categories smallest-first (minority centred). */
     sortByGroup?: boolean
@@ -5327,7 +5347,8 @@ interface ApexUnitObject {
    * Stable identity. The datum's own `id`/`name` when the per-unit object form
    * supplies one, so a provider can address a specific unit ("Texas",
    * "employee 41") rather than a positional slot; otherwise
-   * `"<seriesIndex>:<dataPointIndex>"`.
+   * `"<seriesIndex>:<dataPointIndex>"`. A repeated one is suffixed by its
+   * order of appearance (`"Alex#2"`).
    */
   id: string
   /** Global draw order across every category. */