react-klinecharts-ui 0.3.0 → 0.4.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 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 { DepthOverlayExtendData, DepthOverlayRow, OrderLineFontStyle, OrderLineLabelStyle, OrderLineLineStyle, OrderLineMarkStyle, OrderLinePadding, depthOverlay, indicators, orderLine, overlays, registerExtensions } from './extensions.cjs';
 
@@ -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;
@@ -207,6 +229,21 @@ interface UseIndicatorsReturn {
     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;
 
@@ -418,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;
@@ -861,4 +900,4 @@ declare const superTrend: IndicatorTemplate;
 
 declare const vwap: IndicatorTemplate;
 
-export { 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 };
+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,6 +1,6 @@
 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 { DepthOverlayExtendData, DepthOverlayRow, OrderLineFontStyle, OrderLineLabelStyle, OrderLineLineStyle, OrderLineMarkStyle, OrderLinePadding, depthOverlay, indicators, orderLine, overlays, registerExtensions } from './extensions.js';
 
@@ -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;
@@ -207,6 +229,21 @@ interface UseIndicatorsReturn {
     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;
 
@@ -418,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;
@@ -861,4 +900,4 @@ declare const superTrend: IndicatorTemplate;
 
 declare const vwap: IndicatorTemplate;
 
-export { 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 };
+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 };