react-native-livechart 4.16.0 → 4.18.0

package/src/types.ts

@@ -591,7 +591,11 @@ export interface AreaDotsConfig {
 export interface BadgeConfig extends BadgeStyleConfig {
   /** Visual style of the badge pill. Default `"default"`. */
   variant?: BadgeVariant;
-  /** Show the pointed tail toward the live dot. Default `true`. */
+  /**
+   * Show the pointed tail toward the live dot. When `false`, no tail space is
+   * reserved: the pill body sits flush at the gutter edge (right after the dot
+   * gap) and the auto right padding shrinks accordingly. Default `true`.
+   */
   tail?: boolean;
   /** Which side of the chart the badge appears on. Default `"right"`. */
   position?: "right" | "left";
@@ -737,6 +741,22 @@ export interface XAxisConfig {
   minGap?: number;
 }
 
+/**
+ * Auto-hide both axes while idle (see {@link LiveChartCoreProps.axisAutoHide}).
+ *
+ * @experimental
+ */
+export interface AxisAutoHideConfig {
+  /** Fade-in duration (ms) when interaction starts — near-instant. Default `60`. */
+  fadeInMs?: number;
+  /** Fade-out duration (ms) back to idle. Default `250`. */
+  fadeOutMs?: number;
+  /** Axis opacity while idle (0 = fully hidden). Default `0`. */
+  idleOpacity?: number;
+  /** Untouched time (ms) before the axes fade back out. Default `3000`. */
+  hideAfterMs?: number;
+}
+
 /**
  * Morfi-style on-canvas tooltip for {@link LiveChartSeries}: a time-range pill
  * above the guide plus one value pill at every visible series intersection.
@@ -945,6 +965,15 @@ export interface ScrubConfig {
    * Default `false`.
    */
   clampToPlot?: boolean;
+  /**
+   * Candle mode: snap the crosshair to candle centers. The scrub X is
+   * quantized to the hovered candle's center before it drives the crosshair,
+   * so the line — and everything derived from it (the time, tooltip, and
+   * trailing dim) — jumps from candle to candle instead of gliding, the
+   * tick-to-tick feel of pro charting tools. A position in a gap between
+   * candles keeps the raw finger X; no effect in line mode. Default `false`.
+   */
+  snapToCandles?: boolean;
 }
 
 /**
@@ -1360,6 +1389,12 @@ export interface MarkerClusterConfig {
   /** Collapse a co-located run to a single count badge once it exceeds this many.
    *  Default `5`. */
   maxBeforeGroup?: number;
+  /**
+   * `"vertical"` only: cap the column at this many glyphs instead of letting it
+   * grow unbounded (and off the plot). The oldest `maxVisible` glyphs keep
+   * their stack; the newest overflow is hidden. Default unbounded.
+   */
+  maxVisible?: number;
   /**
    * What a collapsed cluster draws in place of its members:
    *  - `"count"` (default) — the built-in round count badge (a circle with the
@@ -1520,6 +1555,21 @@ export interface DotConfig {
   show?: boolean;
   /** Dot fill color. Defaults to the chart line color (per series for multi-series). */
   color?: string;
+  /**
+   * Keep the dot on the **true live point** while scrolled back or overscrolled
+   * with `timeScroll`: it tracks the live point's x (instead of staying pinned
+   * to the plot's right edge), keeps its heartbeat pulse (the dot still marks
+   * an honest live position), stays visible under
+   * `timeScroll.hideLiveOnScrollBack`, and hides once the live point leaves the
+   * visible window. Ignored when `badge.followViewEdge` is set — an edge-pinned
+   * dot must stay aligned with its badge. Single-series `LiveChart` only
+   * (multi-series dots already ride each line's end while scrolled). Default
+   * `false` (the dot stays pinned to the right edge with its pulse suppressed
+   * while scrolled back).
+   *
+   * @experimental
+   */
+  trackWhileParked?: boolean;
 }
 
 /** Live dot configuration for multi-series charts (extends the shared {@link DotConfig}). */
@@ -1791,6 +1841,14 @@ export interface TimeScrollConfig {
    * clamped. Applies to the pinch-zoom (`zoom`) clamps too.
    */
   overscroll?: number;
+  /**
+   * Fling inertia on release: a fast drag keeps scrolling and decays to a
+   * stop (the classic momentum feel). Set `false` to stop the window dead
+   * where the finger lifts — a deliberate, TradingView-style hard stop. A
+   * release that lands within the snap zone of the live edge still
+   * re-attaches to live. Default `true`.
+   */
+  fling?: boolean;
 }
 
 /**
@@ -2005,7 +2063,10 @@ export interface LiveChartCoreProps {
   exaggerate?: boolean;
   /**
    * Clamp the Y-axis lower bound at 0 (prices, market caps, volumes) so the axis
-   * never shows negative ticks when data collapses toward zero. Default `false`.
+   * never shows negative ticks when data collapses toward zero. With
+   * `yRangeScale` zoomed out, the expansion stops once the lower bound reaches
+   * 0 so the data stays centered instead of continuing to grow only upward.
+   * Default `false`.
    */
   nonNegative?: boolean;
   /**
@@ -2038,6 +2099,15 @@ export interface LiveChartCoreProps {
   yAxis?: boolean | YAxisConfig;
   /** X-axis time labels. `true` = defaults, `false` = hidden, or pass `XAxisConfig`. Default `true`. */
   xAxis?: boolean | XAxisConfig;
+  /**
+   * Auto-hide both axes while the chart is at rest: the X/Y axes (grid, ticks,
+   * labels) fade in on any interaction — scrubbing, time-scrolling, flinging,
+   * pinch-zooming — and fade back out once the chart goes untouched for
+   * `hideAfterMs`. `true` = defaults, or pass `AxisAutoHideConfig`. Default off.
+   *
+   * @experimental
+   */
+  axisAutoHide?: boolean | AxisAutoHideConfig;
   /**
    * Label floated at the top edge of the plot area. `true` = the built-in value
    * label showing the chart's current TOP Y-axis bound (updated each frame),