react-klinecharts-ui 0.2.0 → 0.4.0

package/dist/index.d.cts

@@ -1,8 +1,8 @@
 import * as react from 'react';
 import { Dispatch, RefObject, ReactNode, ReactElement } from 'react';
-import { Period, SymbolInfo, KLineData, Chart, DeepPartial, Styles, OverlayTemplate, DataLoader, IndicatorTemplate } from 'react-klinecharts';
+import { Period, SymbolInfo, KLineData, Chart, DeepPartial, Styles, OverlayTemplate, YAxisOverride, DataLoader, IndicatorTemplate } from 'react-klinecharts';
 import { OrderLineExtendData } from './extensions.cjs';
-export { OrderLineFontStyle, OrderLineLabelStyle, OrderLineLineStyle, OrderLineMarkStyle, OrderLinePadding, indicators, orderLine, overlays, registerExtensions } from './extensions.cjs';
+export { DepthOverlayExtendData, DepthOverlayRow, OrderLineFontStyle, OrderLineLabelStyle, OrderLineLineStyle, OrderLineMarkStyle, OrderLinePadding, depthOverlay, indicators, orderLine, overlays, registerExtensions } from './extensions.cjs';
 
 interface TerminalPeriod extends Period {
     label: string;
@@ -65,6 +65,15 @@ interface KlinechartsUIState {
     periods: TerminalPeriod[];
     mainIndicators: string[];
     subIndicators: Record<string, string>;
+    /**
+     * Custom Y-axis bindings for indicators, keyed by indicator id
+     * (`main_<name>` / `sub_<name>`), value is the bound `yAxisId`.
+     * Only populated for indicators explicitly bound to a secondary
+     * (non-default) axis via `useIndicators`. Indicators on the shared
+     * default axis are absent. Used to persist bindings across
+     * undo/redo and layout presets.
+     */
+    indicatorAxes: Record<string, string>;
     styles: DeepPartial<Styles> | undefined;
     screenshotUrl: string | null;
 }
@@ -92,6 +101,9 @@ type KlinechartsUIAction = {
 } | {
     type: "SET_SUB_INDICATORS";
     indicators: Record<string, string>;
+} | {
+    type: "SET_INDICATOR_AXES";
+    axes: Record<string, string>;
 } | {
     type: "SET_STYLES";
     styles: DeepPartial<Styles> | undefined;
@@ -176,6 +188,16 @@ interface IndicatorInfo {
     name: string;
     isActive: boolean;
 }
+/** Options accepted when adding an indicator. */
+interface AddIndicatorOptions {
+    /**
+     * Bind the indicator to a custom Y-axis (klinecharts v10 multiple y-axes).
+     * Provide a stable `id` to create/share a secondary axis; e.g.
+     * `{ id: "rsi_axis", position: "left" }`. Omit to use the pane's default
+     * (shared) axis.
+     */
+    yAxis?: YAxisOverride;
+}
 interface UseIndicatorsReturn {
     mainIndicators: IndicatorInfo[];
     subIndicators: IndicatorInfo[];
@@ -183,9 +205,9 @@ interface UseIndicatorsReturn {
     activeSubIndicators: Record<string, string>;
     availableMainIndicators: string[];
     availableSubIndicators: string[];
-    addMainIndicator: (name: string) => void;
+    addMainIndicator: (name: string, options?: AddIndicatorOptions) => void;
     removeMainIndicator: (name: string) => void;
-    addSubIndicator: (name: string) => void;
+    addSubIndicator: (name: string, options?: AddIndicatorOptions) => void;
     removeSubIndicator: (name: string) => void;
     toggleMainIndicator: (name: string) => void;
     toggleSubIndicator: (name: string) => void;
@@ -199,6 +221,29 @@ interface UseIndicatorsReturn {
     }[];
     isMainIndicatorActive: (name: string) => boolean;
     isSubIndicatorActive: (name: string) => boolean;
+    /** Collapse a sub-indicator pane to minimal height (30px). */
+    collapseSubIndicator: (name: string) => void;
+    /** Expand a previously collapsed sub-indicator pane to its prior height. */
+    expandSubIndicator: (name: string) => void;
+    /** Whether the given sub-indicator pane is currently collapsed. */
+    isSubIndicatorCollapsed: (name: string) => boolean;
+    /** Reorder a sub-indicator pane up or down relative to other sub-indicators. */
+    reorderSubIndicator: (name: string, direction: "up" | "down") => void;
+    /**
+     * Custom Y-axis bindings, keyed by indicator id (`main_<name>` /
+     * `sub_<name>`). Only contains indicators bound to a secondary axis.
+     */
+    indicatorAxes: Record<string, string>;
+    /** Get the custom `yAxisId` an indicator is bound to, or `undefined` for the default axis. */
+    getIndicatorAxis: (name: string, isMain: boolean) => string | undefined;
+    /**
+     * Rebind an existing indicator to a different Y-axis. Because klinecharts v10
+     * `overrideIndicator` cannot change axis binding, this removes and recreates
+     * the indicator (preserving calc params, styles and visibility).
+     * Pass `yAxis` to bind to a secondary axis, or omit it to return the
+     * indicator to the pane's default (shared) axis.
+     */
+    bindIndicatorToNewAxis: (name: string, isMain: boolean, yAxis?: YAxisOverride) => void;
 }
 declare function useIndicators(): UseIndicatorsReturn;
 
@@ -227,12 +272,16 @@ interface UseDrawingToolsReturn {
     magnetMode: MagnetMode;
     isLocked: boolean;
     isVisible: boolean;
+    /** Whether drawing tools auto-retrigger after completing a shape. Default: true. */
+    autoRetrigger: boolean;
     selectTool: (name: string) => void;
     clearActiveTool: () => void;
     setMagnetMode: (mode: MagnetMode) => void;
     toggleLock: () => void;
     toggleVisibility: () => void;
     removeAllDrawings: () => void;
+    /** Enable/disable auto-retrigger mode. */
+    setAutoRetrigger: (enabled: boolean) => void;
 }
 declare function useDrawingTools(): UseDrawingToolsReturn;
 
@@ -406,6 +455,8 @@ interface ChartLayoutState {
         calcParams: any[];
         visible: boolean;
         styles?: any;
+        /** Custom Y-axis the indicator is bound to (klinecharts v10 multiple y-axes). */
+        yAxisId?: string;
     }>;
     drawings: Array<{
         name: string;
@@ -494,6 +545,182 @@ interface UseScriptEditorReturn {
  */
 declare function useScriptEditor(): UseScriptEditorReturn;
 
+interface CrosshairBarData {
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume: number;
+    timestamp: number;
+    change: number;
+    changePercent: number;
+}
+interface UseCrosshairReturn {
+    /** OHLCV data of the bar under the crosshair. Null when cursor is off-chart. */
+    barData: CrosshairBarData | null;
+}
+declare function useCrosshair(): UseCrosshairReturn;
+
+type AlertCondition = "crossing_up" | "crossing_down" | "crossing";
+interface Alert {
+    id: string;
+    price: number;
+    condition: AlertCondition;
+    message?: string;
+    triggered: boolean;
+}
+interface UseAlertsReturn {
+    alerts: Alert[];
+    addAlert: (price: number, condition: AlertCondition, message?: string) => string;
+    removeAlert: (id: string) => void;
+    clearAlerts: () => void;
+    onAlertTriggered: (callback: (alert: Alert) => void) => void;
+}
+declare function useAlerts(): UseAlertsReturn;
+
+type ExportFormat = "csv" | "json";
+interface UseDataExportReturn {
+    /** Export all chart data */
+    exportAll: (format: ExportFormat) => void;
+    /** Export only the visible range */
+    exportVisible: (format: ExportFormat) => void;
+}
+declare function useDataExport(): UseDataExportReturn;
+
+interface WatchlistItem {
+    ticker: string;
+    lastPrice: number | null;
+    change: number | null;
+    changePercent: number | null;
+}
+interface UseWatchlistReturn {
+    items: WatchlistItem[];
+    addSymbol: (ticker: string) => void;
+    removeSymbol: (ticker: string) => void;
+    switchSymbol: (ticker: string) => void;
+    activeSymbol: string | null;
+}
+declare function useWatchlist(): UseWatchlistReturn;
+
+type ReplaySpeed = 1 | 2 | 5 | 10;
+interface UseReplayReturn {
+    /** Whether a replay session is active */
+    isReplaying: boolean;
+    /** Whether the replay is currently paused */
+    isPaused: boolean;
+    /** Current playback speed multiplier */
+    speed: ReplaySpeed;
+    /** Current bar index in the replay */
+    barIndex: number;
+    /** Total number of bars in the saved data */
+    totalBars: number;
+    /** Start replaying from the beginning */
+    startReplay: () => void;
+    /** Stop replay and restore original data */
+    stopReplay: () => void;
+    /** Toggle play/pause */
+    togglePause: () => void;
+    /** Advance one bar while paused */
+    stepForward: () => void;
+    /** Go back one bar while paused */
+    stepBackward: () => void;
+    /** Seek to a specific bar index (0-based). Pauses playback. */
+    seekTo: (index: number) => void;
+    /** Change the playback speed */
+    setSpeed: (speed: ReplaySpeed) => void;
+}
+/**
+ * Headless hook for historical data replay (bar-by-bar playback).
+ *
+ * Loads the current chart data, clears the chart, then progressively adds
+ * bars back one at a time at the configured speed. Useful for backtesting
+ * and reviewing price action.
+ */
+declare function useReplay(): UseReplayReturn;
+
+interface CompareSymbol {
+    ticker: string;
+    /** Base price (first bar close) used for percentage normalization */
+    basePrice: number | null;
+    color: string;
+    visible: boolean;
+}
+interface UseCompareReturn {
+    /** Currently compared symbols */
+    symbols: CompareSymbol[];
+    /** Add a symbol — fetches data, normalizes to %, renders as indicator line */
+    addSymbol: (ticker: string, color?: string) => Promise<void>;
+    /** Remove a symbol overlay */
+    removeSymbol: (ticker: string) => void;
+    /** Toggle visibility of a compared symbol */
+    toggleSymbol: (ticker: string) => void;
+    /** Clear all comparisons */
+    clearAll: () => void;
+}
+/**
+ * Headless hook for comparing multiple symbols on the same chart.
+ *
+ * Fetches historical data for each added symbol via the datafeed,
+ * normalizes prices to percentage change from the first bar,
+ * and renders each as a custom indicator line on the main pane.
+ */
+declare function useCompare(): UseCompareReturn;
+
+interface MeasurePoint {
+    price: number;
+    timestamp: number;
+    barIndex: number;
+}
+interface MeasureResult {
+    from: MeasurePoint;
+    to: MeasurePoint;
+    /** Absolute price difference */
+    priceDiff: number;
+    /** Percentage change from → to */
+    pricePercent: number;
+    /** Number of bars between the two points */
+    bars: number;
+    /** Time difference in milliseconds */
+    timeDiff: number;
+}
+interface UseMeasureReturn {
+    /** Whether measure mode is active (waiting for clicks) */
+    isActive: boolean;
+    /** Start measure mode — next two clicks on chart set from/to */
+    startMeasure: () => void;
+    /** Cancel measure mode */
+    cancelMeasure: () => void;
+    /** Current measurement result (null until both points are set) */
+    result: MeasureResult | null;
+    /** Clear the current measurement */
+    clearResult: () => void;
+    /** First point (set after first click) */
+    fromPoint: MeasurePoint | null;
+}
+/**
+ * Headless hook for measuring distance/time/percentage between two points.
+ *
+ * Activates measure mode, captures two clicks on the chart via overlay
+ * interaction, then computes price diff, %, bar count, and time diff.
+ */
+declare function useMeasure(): UseMeasureReturn;
+
+interface Annotation {
+    id: string;
+    text: string;
+    price: number;
+    timestamp: number;
+    color?: string;
+}
+interface UseAnnotationsReturn {
+    annotations: Annotation[];
+    addAnnotation: (text: string, price: number, timestamp: number, color?: string) => string;
+    removeAnnotation: (id: string) => void;
+    updateAnnotation: (id: string, updates: Partial<Pick<Annotation, "text" | "color">>) => void;
+    clearAnnotations: () => void;
+}
+declare function useAnnotations(): UseAnnotationsReturn;
+
 interface TimezoneOption {
     key: string;
     localeKey: string;
@@ -673,4 +900,4 @@ declare const superTrend: IndicatorTemplate;
 
 declare const vwap: IndicatorTemplate;
 
-export { CANDLE_TYPES, COMPARE_RULES, type CandleTypeItem, type CandleTypeOption, type ChartLayoutState, type CompareRule, DEFAULT_PERIODS, DRAWING_CATEGORIES, type Datafeed, type DrawingCategoryItem, type DrawingTool, type DrawingToolCategory, type DrawingToolItem, INDICATOR_PARAMS, type IndicatorDefinition, type IndicatorInfo, type IndicatorParamConfig, type KlinechartsUIAction, type KlinechartsUIContextValue, KlinechartsUIDispatchContext, type KlinechartsUIDispatchValue, type KlinechartsUIOptions, KlinechartsUIProvider, type KlinechartsUISettingsState, type KlinechartsUIState, KlinechartsUIStateContext, type LayoutEntry, MAIN_INDICATORS, type MagnetMode, OrderLineExtendData, type OrderLineOptions, PRICE_AXIS_TYPES, type PartialSymbolInfo, type PriceAxisType, SUB_INDICATORS, type ScriptPlacement, TA, TIMEZONES, TOOLTIP_SHOW_RULES, type TerminalPeriod, type TimezoneItem, type TimezoneOption, type TooltipShowRule, type UndoRedoAction, type UndoRedoActionType, type UseDrawingToolsReturn, type UseFullscreenReturn, type UseIndicatorsReturn, type UseKlinechartsUILoadingReturn, type UseKlinechartsUISettingsReturn, type UseKlinechartsUIThemeReturn, type UseLayoutManagerReturn, type UseOrderLinesReturn, type UsePeriodsReturn, type UseScreenshotReturn, type UseScriptEditorReturn, type UseSymbolSearchReturn, type UseTimezoneReturn, type UseUndoRedoReturn, YAXIS_POSITIONS, type YAxisPosition, abcd, anyWaves, arrow, bollTv, brush, cci, circle, createDataLoader, eightWaves, elliottWave, fibRetracement, fibonacciCircle, fibonacciExtension, fibonacciSegment, fibonacciSpeedResistanceFan, fibonacciSpiral, fiveWaves, gannBox, gannFan, hma, ichimoku, longPosition, maRibbon, macdTv, measure, parallelChannel, parallelogram, pivotPoints, ray, rect, rsiTv, shortPosition, stochastic, superTrend, threeWaves, triangle, useDrawingTools, useFullscreen, useIndicators, useKlinechartsUI, useKlinechartsUILoading, useKlinechartsUISettings, useKlinechartsUITheme, useLayoutManager, useOrderLines, usePeriods, useScreenshot, useScriptEditor, useSymbolSearch, useTimezone, useUndoRedo, vwap, xabcd };
+export { type AddIndicatorOptions, type Alert, type AlertCondition, type Annotation, CANDLE_TYPES, COMPARE_RULES, type CandleTypeItem, type CandleTypeOption, type ChartLayoutState, type CompareRule, type CompareSymbol, type CrosshairBarData, DEFAULT_PERIODS, DRAWING_CATEGORIES, type Datafeed, type DrawingCategoryItem, type DrawingTool, type DrawingToolCategory, type DrawingToolItem, type ExportFormat, INDICATOR_PARAMS, type IndicatorDefinition, type IndicatorInfo, type IndicatorParamConfig, type KlinechartsUIAction, type KlinechartsUIContextValue, KlinechartsUIDispatchContext, type KlinechartsUIDispatchValue, type KlinechartsUIOptions, KlinechartsUIProvider, type KlinechartsUISettingsState, type KlinechartsUIState, KlinechartsUIStateContext, type LayoutEntry, MAIN_INDICATORS, type MagnetMode, type MeasurePoint, type MeasureResult, OrderLineExtendData, type OrderLineOptions, PRICE_AXIS_TYPES, type PartialSymbolInfo, type PriceAxisType, type ReplaySpeed, SUB_INDICATORS, type ScriptPlacement, TA, TIMEZONES, TOOLTIP_SHOW_RULES, type TerminalPeriod, type TimezoneItem, type TimezoneOption, type TooltipShowRule, type UndoRedoAction, type UndoRedoActionType, type UseAlertsReturn, type UseAnnotationsReturn, type UseCompareReturn, type UseCrosshairReturn, type UseDataExportReturn, type UseDrawingToolsReturn, type UseFullscreenReturn, type UseIndicatorsReturn, type UseKlinechartsUILoadingReturn, type UseKlinechartsUISettingsReturn, type UseKlinechartsUIThemeReturn, type UseLayoutManagerReturn, type UseMeasureReturn, type UseOrderLinesReturn, type UsePeriodsReturn, type UseReplayReturn, type UseScreenshotReturn, type UseScriptEditorReturn, type UseSymbolSearchReturn, type UseTimezoneReturn, type UseUndoRedoReturn, type UseWatchlistReturn, type WatchlistItem, YAXIS_POSITIONS, type YAxisPosition, abcd, anyWaves, arrow, bollTv, brush, cci, circle, createDataLoader, eightWaves, elliottWave, fibRetracement, fibonacciCircle, fibonacciExtension, fibonacciSegment, fibonacciSpeedResistanceFan, fibonacciSpiral, fiveWaves, gannBox, gannFan, hma, ichimoku, longPosition, maRibbon, macdTv, measure, parallelChannel, parallelogram, pivotPoints, ray, rect, rsiTv, shortPosition, stochastic, superTrend, threeWaves, triangle, useAlerts, useAnnotations, useCompare, useCrosshair, useDataExport, useDrawingTools, useFullscreen, useIndicators, useKlinechartsUI, useKlinechartsUILoading, useKlinechartsUISettings, useKlinechartsUITheme, useLayoutManager, useMeasure, useOrderLines, usePeriods, useReplay, useScreenshot, useScriptEditor, useSymbolSearch, useTimezone, useUndoRedo, useWatchlist, vwap, xabcd };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import * as react from 'react';
 import { Dispatch, RefObject, ReactNode, ReactElement } from 'react';
-import { Period, SymbolInfo, KLineData, Chart, DeepPartial, Styles, OverlayTemplate, DataLoader, IndicatorTemplate } from 'react-klinecharts';
+import { Period, SymbolInfo, KLineData, Chart, DeepPartial, Styles, OverlayTemplate, YAxisOverride, DataLoader, IndicatorTemplate } from 'react-klinecharts';
 import { OrderLineExtendData } from './extensions.js';
-export { OrderLineFontStyle, OrderLineLabelStyle, OrderLineLineStyle, OrderLineMarkStyle, OrderLinePadding, indicators, orderLine, overlays, registerExtensions } from './extensions.js';
+export { DepthOverlayExtendData, DepthOverlayRow, OrderLineFontStyle, OrderLineLabelStyle, OrderLineLineStyle, OrderLineMarkStyle, OrderLinePadding, depthOverlay, indicators, orderLine, overlays, registerExtensions } from './extensions.js';
 
 interface TerminalPeriod extends Period {
     label: string;
@@ -65,6 +65,15 @@ interface KlinechartsUIState {
     periods: TerminalPeriod[];
     mainIndicators: string[];
     subIndicators: Record<string, string>;
+    /**
+     * Custom Y-axis bindings for indicators, keyed by indicator id
+     * (`main_<name>` / `sub_<name>`), value is the bound `yAxisId`.
+     * Only populated for indicators explicitly bound to a secondary
+     * (non-default) axis via `useIndicators`. Indicators on the shared
+     * default axis are absent. Used to persist bindings across
+     * undo/redo and layout presets.
+     */
+    indicatorAxes: Record<string, string>;
     styles: DeepPartial<Styles> | undefined;
     screenshotUrl: string | null;
 }
@@ -92,6 +101,9 @@ type KlinechartsUIAction = {
 } | {
     type: "SET_SUB_INDICATORS";
     indicators: Record<string, string>;
+} | {
+    type: "SET_INDICATOR_AXES";
+    axes: Record<string, string>;
 } | {
     type: "SET_STYLES";
     styles: DeepPartial<Styles> | undefined;
@@ -176,6 +188,16 @@ interface IndicatorInfo {
     name: string;
     isActive: boolean;
 }
+/** Options accepted when adding an indicator. */
+interface AddIndicatorOptions {
+    /**
+     * Bind the indicator to a custom Y-axis (klinecharts v10 multiple y-axes).
+     * Provide a stable `id` to create/share a secondary axis; e.g.
+     * `{ id: "rsi_axis", position: "left" }`. Omit to use the pane's default
+     * (shared) axis.
+     */
+    yAxis?: YAxisOverride;
+}
 interface UseIndicatorsReturn {
     mainIndicators: IndicatorInfo[];
     subIndicators: IndicatorInfo[];
@@ -183,9 +205,9 @@ interface UseIndicatorsReturn {
     activeSubIndicators: Record<string, string>;
     availableMainIndicators: string[];
     availableSubIndicators: string[];
-    addMainIndicator: (name: string) => void;
+    addMainIndicator: (name: string, options?: AddIndicatorOptions) => void;
     removeMainIndicator: (name: string) => void;
-    addSubIndicator: (name: string) => void;
+    addSubIndicator: (name: string, options?: AddIndicatorOptions) => void;
     removeSubIndicator: (name: string) => void;
     toggleMainIndicator: (name: string) => void;
     toggleSubIndicator: (name: string) => void;
@@ -199,6 +221,29 @@ interface UseIndicatorsReturn {
     }[];
     isMainIndicatorActive: (name: string) => boolean;
     isSubIndicatorActive: (name: string) => boolean;
+    /** Collapse a sub-indicator pane to minimal height (30px). */
+    collapseSubIndicator: (name: string) => void;
+    /** Expand a previously collapsed sub-indicator pane to its prior height. */
+    expandSubIndicator: (name: string) => void;
+    /** Whether the given sub-indicator pane is currently collapsed. */
+    isSubIndicatorCollapsed: (name: string) => boolean;
+    /** Reorder a sub-indicator pane up or down relative to other sub-indicators. */
+    reorderSubIndicator: (name: string, direction: "up" | "down") => void;
+    /**
+     * Custom Y-axis bindings, keyed by indicator id (`main_<name>` /
+     * `sub_<name>`). Only contains indicators bound to a secondary axis.
+     */
+    indicatorAxes: Record<string, string>;
+    /** Get the custom `yAxisId` an indicator is bound to, or `undefined` for the default axis. */
+    getIndicatorAxis: (name: string, isMain: boolean) => string | undefined;
+    /**
+     * Rebind an existing indicator to a different Y-axis. Because klinecharts v10
+     * `overrideIndicator` cannot change axis binding, this removes and recreates
+     * the indicator (preserving calc params, styles and visibility).
+     * Pass `yAxis` to bind to a secondary axis, or omit it to return the
+     * indicator to the pane's default (shared) axis.
+     */
+    bindIndicatorToNewAxis: (name: string, isMain: boolean, yAxis?: YAxisOverride) => void;
 }
 declare function useIndicators(): UseIndicatorsReturn;
 
@@ -227,12 +272,16 @@ interface UseDrawingToolsReturn {
     magnetMode: MagnetMode;
     isLocked: boolean;
     isVisible: boolean;
+    /** Whether drawing tools auto-retrigger after completing a shape. Default: true. */
+    autoRetrigger: boolean;
     selectTool: (name: string) => void;
     clearActiveTool: () => void;
     setMagnetMode: (mode: MagnetMode) => void;
     toggleLock: () => void;
     toggleVisibility: () => void;
     removeAllDrawings: () => void;
+    /** Enable/disable auto-retrigger mode. */
+    setAutoRetrigger: (enabled: boolean) => void;
 }
 declare function useDrawingTools(): UseDrawingToolsReturn;
 
@@ -406,6 +455,8 @@ interface ChartLayoutState {
         calcParams: any[];
         visible: boolean;
         styles?: any;
+        /** Custom Y-axis the indicator is bound to (klinecharts v10 multiple y-axes). */
+        yAxisId?: string;
     }>;
     drawings: Array<{
         name: string;
@@ -494,6 +545,182 @@ interface UseScriptEditorReturn {
  */
 declare function useScriptEditor(): UseScriptEditorReturn;
 
+interface CrosshairBarData {
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume: number;
+    timestamp: number;
+    change: number;
+    changePercent: number;
+}
+interface UseCrosshairReturn {
+    /** OHLCV data of the bar under the crosshair. Null when cursor is off-chart. */
+    barData: CrosshairBarData | null;
+}
+declare function useCrosshair(): UseCrosshairReturn;
+
+type AlertCondition = "crossing_up" | "crossing_down" | "crossing";
+interface Alert {
+    id: string;
+    price: number;
+    condition: AlertCondition;
+    message?: string;
+    triggered: boolean;
+}
+interface UseAlertsReturn {
+    alerts: Alert[];
+    addAlert: (price: number, condition: AlertCondition, message?: string) => string;
+    removeAlert: (id: string) => void;
+    clearAlerts: () => void;
+    onAlertTriggered: (callback: (alert: Alert) => void) => void;
+}
+declare function useAlerts(): UseAlertsReturn;
+
+type ExportFormat = "csv" | "json";
+interface UseDataExportReturn {
+    /** Export all chart data */
+    exportAll: (format: ExportFormat) => void;
+    /** Export only the visible range */
+    exportVisible: (format: ExportFormat) => void;
+}
+declare function useDataExport(): UseDataExportReturn;
+
+interface WatchlistItem {
+    ticker: string;
+    lastPrice: number | null;
+    change: number | null;
+    changePercent: number | null;
+}
+interface UseWatchlistReturn {
+    items: WatchlistItem[];
+    addSymbol: (ticker: string) => void;
+    removeSymbol: (ticker: string) => void;
+    switchSymbol: (ticker: string) => void;
+    activeSymbol: string | null;
+}
+declare function useWatchlist(): UseWatchlistReturn;
+
+type ReplaySpeed = 1 | 2 | 5 | 10;
+interface UseReplayReturn {
+    /** Whether a replay session is active */
+    isReplaying: boolean;
+    /** Whether the replay is currently paused */
+    isPaused: boolean;
+    /** Current playback speed multiplier */
+    speed: ReplaySpeed;
+    /** Current bar index in the replay */
+    barIndex: number;
+    /** Total number of bars in the saved data */
+    totalBars: number;
+    /** Start replaying from the beginning */
+    startReplay: () => void;
+    /** Stop replay and restore original data */
+    stopReplay: () => void;
+    /** Toggle play/pause */
+    togglePause: () => void;
+    /** Advance one bar while paused */
+    stepForward: () => void;
+    /** Go back one bar while paused */
+    stepBackward: () => void;
+    /** Seek to a specific bar index (0-based). Pauses playback. */
+    seekTo: (index: number) => void;
+    /** Change the playback speed */
+    setSpeed: (speed: ReplaySpeed) => void;
+}
+/**
+ * Headless hook for historical data replay (bar-by-bar playback).
+ *
+ * Loads the current chart data, clears the chart, then progressively adds
+ * bars back one at a time at the configured speed. Useful for backtesting
+ * and reviewing price action.
+ */
+declare function useReplay(): UseReplayReturn;
+
+interface CompareSymbol {
+    ticker: string;
+    /** Base price (first bar close) used for percentage normalization */
+    basePrice: number | null;
+    color: string;
+    visible: boolean;
+}
+interface UseCompareReturn {
+    /** Currently compared symbols */
+    symbols: CompareSymbol[];
+    /** Add a symbol — fetches data, normalizes to %, renders as indicator line */
+    addSymbol: (ticker: string, color?: string) => Promise<void>;
+    /** Remove a symbol overlay */
+    removeSymbol: (ticker: string) => void;
+    /** Toggle visibility of a compared symbol */
+    toggleSymbol: (ticker: string) => void;
+    /** Clear all comparisons */
+    clearAll: () => void;
+}
+/**
+ * Headless hook for comparing multiple symbols on the same chart.
+ *
+ * Fetches historical data for each added symbol via the datafeed,
+ * normalizes prices to percentage change from the first bar,
+ * and renders each as a custom indicator line on the main pane.
+ */
+declare function useCompare(): UseCompareReturn;
+
+interface MeasurePoint {
+    price: number;
+    timestamp: number;
+    barIndex: number;
+}
+interface MeasureResult {
+    from: MeasurePoint;
+    to: MeasurePoint;
+    /** Absolute price difference */
+    priceDiff: number;
+    /** Percentage change from → to */
+    pricePercent: number;
+    /** Number of bars between the two points */
+    bars: number;
+    /** Time difference in milliseconds */
+    timeDiff: number;
+}
+interface UseMeasureReturn {
+    /** Whether measure mode is active (waiting for clicks) */
+    isActive: boolean;
+    /** Start measure mode — next two clicks on chart set from/to */
+    startMeasure: () => void;
+    /** Cancel measure mode */
+    cancelMeasure: () => void;
+    /** Current measurement result (null until both points are set) */
+    result: MeasureResult | null;
+    /** Clear the current measurement */
+    clearResult: () => void;
+    /** First point (set after first click) */
+    fromPoint: MeasurePoint | null;
+}
+/**
+ * Headless hook for measuring distance/time/percentage between two points.
+ *
+ * Activates measure mode, captures two clicks on the chart via overlay
+ * interaction, then computes price diff, %, bar count, and time diff.
+ */
+declare function useMeasure(): UseMeasureReturn;
+
+interface Annotation {
+    id: string;
+    text: string;
+    price: number;
+    timestamp: number;
+    color?: string;
+}
+interface UseAnnotationsReturn {
+    annotations: Annotation[];
+    addAnnotation: (text: string, price: number, timestamp: number, color?: string) => string;
+    removeAnnotation: (id: string) => void;
+    updateAnnotation: (id: string, updates: Partial<Pick<Annotation, "text" | "color">>) => void;
+    clearAnnotations: () => void;
+}
+declare function useAnnotations(): UseAnnotationsReturn;
+
 interface TimezoneOption {
     key: string;
     localeKey: string;
@@ -673,4 +900,4 @@ declare const superTrend: IndicatorTemplate;
 
 declare const vwap: IndicatorTemplate;
 
-export { CANDLE_TYPES, COMPARE_RULES, type CandleTypeItem, type CandleTypeOption, type ChartLayoutState, type CompareRule, DEFAULT_PERIODS, DRAWING_CATEGORIES, type Datafeed, type DrawingCategoryItem, type DrawingTool, type DrawingToolCategory, type DrawingToolItem, INDICATOR_PARAMS, type IndicatorDefinition, type IndicatorInfo, type IndicatorParamConfig, type KlinechartsUIAction, type KlinechartsUIContextValue, KlinechartsUIDispatchContext, type KlinechartsUIDispatchValue, type KlinechartsUIOptions, KlinechartsUIProvider, type KlinechartsUISettingsState, type KlinechartsUIState, KlinechartsUIStateContext, type LayoutEntry, MAIN_INDICATORS, type MagnetMode, OrderLineExtendData, type OrderLineOptions, PRICE_AXIS_TYPES, type PartialSymbolInfo, type PriceAxisType, SUB_INDICATORS, type ScriptPlacement, TA, TIMEZONES, TOOLTIP_SHOW_RULES, type TerminalPeriod, type TimezoneItem, type TimezoneOption, type TooltipShowRule, type UndoRedoAction, type UndoRedoActionType, type UseDrawingToolsReturn, type UseFullscreenReturn, type UseIndicatorsReturn, type UseKlinechartsUILoadingReturn, type UseKlinechartsUISettingsReturn, type UseKlinechartsUIThemeReturn, type UseLayoutManagerReturn, type UseOrderLinesReturn, type UsePeriodsReturn, type UseScreenshotReturn, type UseScriptEditorReturn, type UseSymbolSearchReturn, type UseTimezoneReturn, type UseUndoRedoReturn, YAXIS_POSITIONS, type YAxisPosition, abcd, anyWaves, arrow, bollTv, brush, cci, circle, createDataLoader, eightWaves, elliottWave, fibRetracement, fibonacciCircle, fibonacciExtension, fibonacciSegment, fibonacciSpeedResistanceFan, fibonacciSpiral, fiveWaves, gannBox, gannFan, hma, ichimoku, longPosition, maRibbon, macdTv, measure, parallelChannel, parallelogram, pivotPoints, ray, rect, rsiTv, shortPosition, stochastic, superTrend, threeWaves, triangle, useDrawingTools, useFullscreen, useIndicators, useKlinechartsUI, useKlinechartsUILoading, useKlinechartsUISettings, useKlinechartsUITheme, useLayoutManager, useOrderLines, usePeriods, useScreenshot, useScriptEditor, useSymbolSearch, useTimezone, useUndoRedo, vwap, xabcd };
+export { type AddIndicatorOptions, type Alert, type AlertCondition, type Annotation, CANDLE_TYPES, COMPARE_RULES, type CandleTypeItem, type CandleTypeOption, type ChartLayoutState, type CompareRule, type CompareSymbol, type CrosshairBarData, DEFAULT_PERIODS, DRAWING_CATEGORIES, type Datafeed, type DrawingCategoryItem, type DrawingTool, type DrawingToolCategory, type DrawingToolItem, type ExportFormat, INDICATOR_PARAMS, type IndicatorDefinition, type IndicatorInfo, type IndicatorParamConfig, type KlinechartsUIAction, type KlinechartsUIContextValue, KlinechartsUIDispatchContext, type KlinechartsUIDispatchValue, type KlinechartsUIOptions, KlinechartsUIProvider, type KlinechartsUISettingsState, type KlinechartsUIState, KlinechartsUIStateContext, type LayoutEntry, MAIN_INDICATORS, type MagnetMode, type MeasurePoint, type MeasureResult, OrderLineExtendData, type OrderLineOptions, PRICE_AXIS_TYPES, type PartialSymbolInfo, type PriceAxisType, type ReplaySpeed, SUB_INDICATORS, type ScriptPlacement, TA, TIMEZONES, TOOLTIP_SHOW_RULES, type TerminalPeriod, type TimezoneItem, type TimezoneOption, type TooltipShowRule, type UndoRedoAction, type UndoRedoActionType, type UseAlertsReturn, type UseAnnotationsReturn, type UseCompareReturn, type UseCrosshairReturn, type UseDataExportReturn, type UseDrawingToolsReturn, type UseFullscreenReturn, type UseIndicatorsReturn, type UseKlinechartsUILoadingReturn, type UseKlinechartsUISettingsReturn, type UseKlinechartsUIThemeReturn, type UseLayoutManagerReturn, type UseMeasureReturn, type UseOrderLinesReturn, type UsePeriodsReturn, type UseReplayReturn, type UseScreenshotReturn, type UseScriptEditorReturn, type UseSymbolSearchReturn, type UseTimezoneReturn, type UseUndoRedoReturn, type UseWatchlistReturn, type WatchlistItem, YAXIS_POSITIONS, type YAxisPosition, abcd, anyWaves, arrow, bollTv, brush, cci, circle, createDataLoader, eightWaves, elliottWave, fibRetracement, fibonacciCircle, fibonacciExtension, fibonacciSegment, fibonacciSpeedResistanceFan, fibonacciSpiral, fiveWaves, gannBox, gannFan, hma, ichimoku, longPosition, maRibbon, macdTv, measure, parallelChannel, parallelogram, pivotPoints, ray, rect, rsiTv, shortPosition, stochastic, superTrend, threeWaves, triangle, useAlerts, useAnnotations, useCompare, useCrosshair, useDataExport, useDrawingTools, useFullscreen, useIndicators, useKlinechartsUI, useKlinechartsUILoading, useKlinechartsUISettings, useKlinechartsUITheme, useLayoutManager, useMeasure, useOrderLines, usePeriods, useReplay, useScreenshot, useScriptEditor, useSymbolSearch, useTimezone, useUndoRedo, useWatchlist, vwap, xabcd };