@wangliang139/klinecharts-pro 0.2.11 → 0.2.13

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Chart, DeepPartial, FigureCreate, IndicatorCreate, KLineData, LineType, Nullable, Overlay, OverlayCreate, OverlayEvent, PaneOptions, Period as DefaultPeriod, PolygonType, Styles } from 'klinecharts';
+import { Chart, DeepPartial, FigureCreate, IndicatorCreate, KLineData, LineType, Nullable, Overlay, OverlayCreate, PaneOptions, Period as DefaultPeriod, PolygonType, Styles } from 'klinecharts';
 
 export interface OverlayProperties {
 	style: PolygonType;
@@ -23,42 +23,6 @@ export interface OverlayProperties {
 	borderColor: string;
 	borderWidth: number;
 }
-export type OrderOverlayAttributes = {
-	setPrice: (price: number) => OrderOverlay;
-	setText: (text: string) => OrderOverlay;
-	setQuantity: (quantity: string) => OrderOverlay;
-	setModifyTooltip: (tooltip: string) => OrderOverlay;
-	setTooltip: (tooltip: string) => OrderOverlay;
-	setLineColor: (color: string) => OrderOverlay;
-	setLineWidth: (width: number) => OrderOverlay;
-	setLineStyle: (style: LineType) => OrderOverlay;
-	setLineLength: (length: number) => OrderOverlay;
-	setLineDashedValue: (dashedValue: number[]) => OrderOverlay;
-	setBodyFont: (font: string) => OrderOverlay;
-	setBodyFontWeight: (weight: FontWeights | number) => OrderOverlay;
-	setBodyTextColor: (color: string) => OrderOverlay;
-	setBodyBackgroundColor: (color: string) => OrderOverlay;
-	setBodyBorderColor: (color: string) => OrderOverlay;
-	setQuantityFont: (font: string) => OrderOverlay;
-	setQuantityFontWeight: (weight: FontWeights | number) => OrderOverlay;
-	setQuantityColor: (color: string) => OrderOverlay;
-	setQuantityBackgroundColor: (color: string) => OrderOverlay;
-	setQuantityBorderColor: (color: string) => OrderOverlay;
-	setCancelButtonIconColor: (color: string) => OrderOverlay;
-	setCancelButtonFontWeight: (weight: FontWeights | number) => OrderOverlay;
-	setCancelButtonBackgroundColor: (color: string) => OrderOverlay;
-	setCancelButtonBorderColor: (color: string) => OrderOverlay;
-	setBorderStyle: (style: LineType) => OrderOverlay;
-	setBorderSize: (size: number) => OrderOverlay;
-	setBorderDashedValue: (dashedValue: number[]) => OrderOverlay;
-	setBorderRadius: (radius: number) => OrderOverlay;
-	onMoveStart: <T>(params: T, callback: (params: T, event?: OverlayEvent<unknown>) => void) => OrderOverlay;
-	onMove: <T>(params: T, callback: (params: T, event?: OverlayEvent<unknown>) => void) => OrderOverlay;
-	onMoveEnd: <T>(params: T, callback: (params: T, event?: OverlayEvent<unknown>) => void) => OrderOverlay;
-	onCancel: <T>(params: T, callback: (params: T, event?: OverlayEvent<unknown>) => void) => OrderOverlay;
-	onModify: <T>(params: T, callback: (params: T, event?: OverlayEvent<unknown>) => void) => OrderOverlay;
-};
-export type OrderOverlay = Pick<Overlay, "id" | "paneId" | "name" | "groupId" | "mode" | "points"> & OrderOverlayAttributes;
 export type ProOverlayCreate = OverlayCreate & {
 	properties?: DeepPartial<OverlayProperties>;
 };
@@ -68,18 +32,7 @@ export interface PaneProperties extends Styles {
 	backgroundGradientStartColor: string;
 	backgroundGradientEndColor: string;
 }
-export type FontWeights = "thin" | "extra-light" | "light" | "normal" | "medium" | "semi-bold" | "bold" | "extra-bold" | "black";
-export type OrderType = "buy" | "sell" | "buystop" | "buylimit" | "sellstop" | "selllimit";
-export type OrderModalType = "placeorder" | "modifyorder" | "closepartial";
-export type ExitType = "stoploss" | "takeprofit" | "breakeven" | "manualclose" | "cancel";
 export type DatafeedSubscribeCallback = (data: KLineData, timestamp?: number) => void;
-export type OrderPlacedCallback = (data: OrderInfo | null) => void;
-export interface UndoOptions {
-	/**
-	 * A boolean flag. Controls if undo should be disabled.
-	 */
-	disableUndo?: boolean;
-}
 export interface SymbolInfo {
 	ticker: string;
 	name?: string;
@@ -93,36 +46,6 @@ export interface SymbolInfo {
 	type?: string;
 	logo?: string;
 }
-export interface OrderInfo {
-	orderId: number;
-	action: OrderType;
-	entryPoint: number;
-	exitPoint?: number;
-	stopLoss?: number;
-	takeProfit?: number;
-	lotSize: number;
-	pips?: number;
-	pl?: number;
-	entryTime?: string;
-	exitTime?: string;
-	exitType?: ExitType;
-	partials?: string;
-	accountId?: number;
-}
-export interface OrderModifyInfo {
-	id: number;
-	action?: OrderType;
-	entrypoint?: number;
-	exitpoint?: number;
-	stoploss?: number;
-	takeprofit?: number;
-	lotsize?: number;
-	pips?: number;
-	pl?: number;
-	exittime?: string;
-	exittype?: ExitType;
-	partials?: string;
-}
 export interface Period extends DefaultPeriod {
 	text: string;
 }
@@ -132,8 +55,6 @@ export interface ProChart extends Chart {
 	setActiveChart(id: string): void;
 	chartById(id: string): Chart | undefined;
 	getOverlayById(id: string): Nullable<Overlay>;
-	createOrderLine(options?: UndoOptions): Nullable<OrderOverlay>;
-	createOrderLines(nums: number, options?: UndoOptions): Array<Nullable<OrderOverlay>>;
 }
 export type IndicatorsType = {
 	value?: IndicatorCreate;
@@ -148,45 +69,34 @@ export type FiguresType = {
 	value?: string | FigureCreate;
 	ctx: CanvasRenderingContext2D;
 };
-export type OrderStyleType = {
-	lineStyle?: {
-		style?: string;
-		size?: number;
-		color?: string;
-		dashedValue?: number[];
-	};
-	labelStyle?: {
-		style?: string;
-		size?: number;
-		family?: string;
-		weight?: string;
-		paddingLeft?: number;
-		paddingRight?: number;
-		paddingBottom?: number;
-		paddingTop?: number;
-		borderStyle?: string;
-		borderSize?: number;
-		color?: string;
-		borderColor?: string;
-		backgroundColor?: string;
-	};
-};
-export type OrderStylesType = {
-	buyStyle?: OrderStyleType;
-	buyLimitStyle?: OrderStyleType;
-	buyStopStyle?: OrderStyleType;
-	sellStyle?: OrderStyleType;
-	sellLimitStyle?: OrderStyleType;
-	sellStopStyle?: OrderStyleType;
-	stopLossStyle?: OrderStyleType;
-	takeProfitStyle?: OrderStyleType;
-};
+/** 设置中「交易展示」持久化（不写入 Styles / styleObj） */
+export interface TradingConfig {
+	showPositions: boolean;
+	showLiquidation: boolean;
+	showOpenOrders: boolean;
+}
+export interface PendingOrder {
+	id?: string;
+	side: PositionSide;
+	isBuy: boolean;
+	price?: number;
+	size: number;
+	orderType?: "limit" | "market";
+}
+export type PositionSide = "long" | "short";
+export interface Position {
+	id?: string;
+	side: PositionSide;
+	avgPrice: number;
+	size: number;
+	multiplier?: number;
+}
 export interface ChartObjType {
 	styleObj?: DeepPartial<PaneProperties>;
 	overlays?: OverlaysType[];
 	figures?: FiguresType[];
 	indicators?: IndicatorsType[];
-	orderStyles?: OrderStylesType;
+	trading?: TradingConfig;
 }
 export interface Datafeed {
 	searchSymbols(search?: string): Promise<SymbolInfo[]>;
@@ -194,15 +104,6 @@ export interface Datafeed {
 	subscribe(symbol: SymbolInfo, period: Period, callback: DatafeedSubscribeCallback): void;
 	unsubscribe(symbol: SymbolInfo, period: Period): void;
 }
-export interface OrderResource {
-	retrieveOrder(order_id: number): Promise<OrderInfo | null>;
-	retrieveOrders(action?: OrderType, account_id?: number | string): Promise<OrderInfo[] | null>;
-	openOrder(action: OrderType, lot_size: number, entry_price: number, stop_loss?: number, take_profit?: number): Promise<OrderInfo | null>;
-	closeOrder(order_id: number, lotsize?: number): Promise<OrderInfo | null>;
-	modifyOrder(order: OrderModifyInfo): Promise<OrderInfo | null>;
-	unsetSlOrTP(order_id: string | number, slortp: "sl" | "tp"): Promise<OrderInfo | null>;
-	launchOrderModal(type: OrderModalType, callback: OrderPlacedCallback, order?: OrderModifyInfo): void;
-}
 export interface ChartProOptions {
 	container: string | HTMLElement;
 	rootElementId?: string;
@@ -210,7 +111,6 @@ export interface ChartProOptions {
 	theme?: string;
 	locale?: string;
 	drawingBarVisible?: boolean;
-	orderPanelVisible?: boolean;
 	symbol: SymbolInfo;
 	period: Period;
 	periods?: Period[];
@@ -219,7 +119,6 @@ export interface ChartProOptions {
 	subIndicators?: string[];
 	datafeed: Datafeed;
 	dataTimestamp?: number;
-	orderController?: OrderResource;
 	overrides?: DeepPartial<PaneProperties>;
 }
 export interface ChartPro {
@@ -238,6 +137,9 @@ export interface ChartPro {
 	getInstanceApi(): Nullable<Chart>;
 	resize(): void;
 	dispose(): void;
+	setPositions(positions: Position[]): void;
+	setLiqPrice(price: number | null): void;
+	setOpenOrders(orders: PendingOrder[]): void;
 }
 export declare class DefaultDatafeed implements Datafeed {
 	constructor(apiKey: string);
@@ -249,34 +151,6 @@ export declare class DefaultDatafeed implements Datafeed {
 	subscribe(symbol: SymbolInfo, period: Period, callback: DatafeedSubscribeCallback): void;
 	unsubscribe(symbol: SymbolInfo, period: Period): void;
 }
-export declare class DefaultOrderController implements OrderResource {
-	constructor(_apiurl: string, _apikey: string, _accound_id: number | string);
-	private apikey;
-	private apiurl;
-	private testsesson_id;
-	retrieveOrder(order_id: number): Promise<OrderInfo>;
-	retrieveOrders(action?: OrderType, session_id?: number): Promise<OrderInfo[]>;
-	openOrder(action: OrderType, lot_size: number, entry_price: number, stop_loss?: number, take_profit?: number): Promise<OrderInfo | null>;
-	closeOrder(order_id: number, lotsize?: number): Promise<OrderInfo | null>;
-	modifyOrder(order: OrderModifyInfo): Promise<OrderInfo | null>;
-	unsetSlOrTP(order_id: string | number, slortp: "sl" | "tp"): Promise<OrderInfo | null>;
-	launchOrderModal(type: OrderModalType, callback: OrderPlacedCallback, order?: OrderModifyInfo): void;
-	private makeFetchWithAuthAndBody;
-}
-export declare class DummyOrderController implements OrderResource {
-	constructor(storage_name?: string);
-	private storage_name;
-	retrieveOrder(order_id: number): Promise<Nullable<OrderInfo>>;
-	retrieveOrders(action?: OrderType, account_id?: number): Promise<OrderInfo[]>;
-	openOrder(action: OrderType, size: number, entry: number, stop_loss?: number, take_profit?: number): Promise<OrderInfo | null>;
-	closeOrder(order_id: number, lotsize?: number): Promise<OrderInfo | null>;
-	modifyOrder(_order: OrderModifyInfo): Promise<OrderInfo | null>;
-	unsetSlOrTP(order_id: string | number, slortp: "sl" | "tp"): Promise<OrderInfo | null>;
-	launchOrderModal(type: OrderModalType, callback: OrderPlacedCallback, order?: OrderModifyInfo): void;
-	private retrieveOrdersFromLs;
-	private retrieveOrderFromLs;
-	private storeOrder;
-}
 export declare class KLineChartPro implements ChartPro {
 	constructor(options: ChartProOptions);
 	private _container;
@@ -297,6 +171,9 @@ export declare class KLineChartPro implements ChartPro {
 	getInstanceApi(): Nullable<ProChart>;
 	resize(): void;
 	dispose(): void;
+	setPositions(positions: Position[]): void;
+	setLiqPrice(price: number | null): void;
+	setOpenOrders(orders: PendingOrder[]): void;
 }
 declare function load(key: string, ls: any): void;