hyperprop-charting-library 0.1.0

package/dist/hyperprop-charting-library.d.ts

@@ -0,0 +1,170 @@
+interface ChartOptions {
+    width?: number;
+    height?: number;
+    backgroundColor?: string;
+    axisColor?: string;
+    axis?: AxisOptions;
+    upColor?: string;
+    downColor?: string;
+    gridColor?: string;
+    fontFamily?: string;
+    candleBodyWidthRatio?: number;
+    candleMinWidth?: number;
+    candleWickWidth?: number;
+    autoScaleSmoothing?: number;
+    autoScaleIgnoreLatestCandle?: boolean;
+    doubleClickEnabled?: boolean;
+    doubleClickAction?: "reset" | "placeLimitOrder";
+    crosshair?: CrosshairOptions;
+    grid?: GridOptions;
+    watermark?: WatermarkOptions;
+    priceLines?: PriceLineOptions[];
+    orderLines?: OrderLineOptions[];
+    tickerLine?: TickerLineOptions;
+}
+interface AxisOptions {
+    lineColor?: string;
+    textColor?: string;
+    fontSize?: number;
+    lineWidth?: number;
+}
+interface GridOptions {
+    color?: string;
+    opacity?: number;
+    horizontalLines?: boolean;
+    verticalLines?: boolean;
+    horizontalTickCount?: number;
+}
+interface CrosshairOptions {
+    visible?: boolean;
+    color?: string;
+    width?: number;
+    style?: "solid" | "dotted" | "dashed";
+    showHorizontal?: boolean;
+    showVertical?: boolean;
+}
+interface WatermarkOptions {
+    visible?: boolean;
+    text?: string;
+    color?: string;
+    opacity?: number;
+    fontSize?: number;
+    fontWeight?: number | string;
+    thickness?: number;
+}
+interface PriceLineOptions {
+    id?: string;
+    price: number;
+    label?: string;
+    visible?: boolean;
+    style?: "solid" | "dotted" | "dashed";
+    thickness?: number;
+    color?: string;
+    labelBackgroundColor?: string;
+    labelTextColor?: string;
+    labelBorderRadius?: number;
+    showLabel?: boolean;
+}
+interface OrderLineOptions {
+    id?: string;
+    type: "market" | "limit" | "stop" | "takeProfit";
+    side: "buy" | "sell";
+    price: number;
+    behavior?: "static" | "follow";
+    followPrice?: number;
+    qty?: number;
+    pnl?: number;
+    label?: string;
+    visible?: boolean;
+    style?: "solid" | "dotted" | "dashed";
+    thickness?: number;
+    color?: string;
+    labelBackgroundColor?: string;
+    labelTextColor?: string;
+    labelBorderRadius?: number;
+    showCloseButton?: boolean;
+    widgetPosition?: "left" | "center" | "right";
+    draggable?: boolean;
+    actionButtonText?: string;
+    actionButtonAction?: "execute" | "cancel" | "close" | string;
+    actionButtonTextColor?: string;
+    actionButtonBackgroundColor?: string;
+    actionButtonBorderRadius?: number;
+    actionButtonMinWidth?: number;
+    actionButtonPaddingX?: number;
+    actionButtonFullHeight?: boolean;
+    actionButtonFontWeight?: number | string;
+    actionButtonBorderColor?: string;
+    actionButtonBorderStyle?: "solid" | "dotted" | "dashed";
+    actionButtons?: OrderActionButton[];
+    connectorToPrice?: number;
+    connectorColor?: string;
+    connectorStyle?: "solid" | "dotted" | "dashed";
+    connectorThickness?: number;
+    connectorAnchorPaddingRight?: number;
+    fillToPrice?: number;
+    fillColor?: string;
+}
+interface OrderActionEvent {
+    orderId?: string;
+    action: "close" | "cancel" | "move" | "createLimit" | "execute" | string;
+    price?: number;
+    dragging?: boolean;
+    line?: OrderLineOptions;
+}
+interface OrderActionButton {
+    text: string;
+    action: "execute" | "cancel" | "close" | string;
+    draggable?: boolean;
+    textColor?: string;
+    backgroundColor?: string;
+    borderColor?: string;
+    borderStyle?: "solid" | "dotted" | "dashed";
+    borderRadius?: number;
+    minWidth?: number;
+    paddingX?: number;
+    fullHeight?: boolean;
+    fontWeight?: number | string;
+}
+interface ChartClickEvent {
+    x: number;
+    y: number;
+    price?: number;
+    region: "plot" | "x-axis" | "y-axis";
+}
+interface TickerLineOptions {
+    visible?: boolean;
+    style?: "solid" | "dotted" | "dashed";
+    thickness?: number;
+    color?: string;
+    labelBackgroundColor?: string;
+    labelTextColor?: string;
+    labelBorderRadius?: number;
+}
+interface ChartInstance {
+    setData: (data: OhlcDataPoint[]) => void;
+    setPriceLines: (lines: PriceLineOptions[]) => void;
+    addPriceLine: (line: PriceLineOptions) => string;
+    removePriceLine: (id: string) => void;
+    setOrderLines: (lines: OrderLineOptions[]) => void;
+    addOrderLine: (line: OrderLineOptions) => string;
+    updateOrderLine: (id: string, patch: Partial<OrderLineOptions>) => void;
+    removeOrderLine: (id: string) => void;
+    onOrderAction: (handler: ((event: OrderActionEvent) => void) | null) => void;
+    onChartClick: (handler: ((event: ChartClickEvent) => void) | null) => void;
+    setDoubleClickEnabled: (enabled: boolean) => void;
+    setDoubleClickAction: (action: "reset" | "placeLimitOrder") => void;
+    resize: (width?: number, height?: number) => void;
+    destroy: () => void;
+}
+interface OhlcDataPoint {
+    t: string;
+    o: number;
+    h: number;
+    l: number;
+    c: number;
+    v?: number;
+}
+declare function createChart(element: HTMLElement, options?: ChartOptions): ChartInstance;
+
+export { type AxisOptions, type ChartClickEvent, type ChartInstance, type ChartOptions, type CrosshairOptions, type GridOptions, type OhlcDataPoint, type OrderActionButton, type OrderActionEvent, type OrderLineOptions, type PriceLineOptions, type TickerLineOptions, type WatermarkOptions, createChart };