openalgo-charts 1.0.3 → 1.0.5

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /** Library version string. Matches package.json (published npm release). */
-declare const VERSION = "1.0.3";
+declare const VERSION = "1.0.5";
 /** Returns the current library version. */
 declare function version(): string;
 
@@ -492,6 +492,10 @@ interface PrimitiveRenderContext {
     priceAxisWidth: number;
     dpr: number;
     theme: ChartTheme;
+    /** externalId of the primitive hit under the pointer (hover state), if any. */
+    hoverId?: string | null;
+    /** externalId of the line being dragged (active state), if any. */
+    dragId?: string | null;
 }
 interface PrimitiveHit {
     externalId: string;
@@ -634,6 +638,10 @@ interface PaneRenderContext {
     showHorzGrid: boolean;
     /** Optional custom time label formatter (UTC seconds -> string). Defaults to IST. */
     timeFormatter?: (utcSeconds: number, tickMark?: TickMarkType) => string;
+    /** externalId of the primitive under the pointer (hover visual state). */
+    hoverId?: string | null;
+    /** externalId of the line currently being dragged (active visual state). */
+    dragId?: string | null;
 }
 declare class Pane {
     readonly element: HTMLElement;
@@ -946,8 +954,8 @@ declare class TradingController {
     private _renderTrades;
     private _sync;
     private _sig;
+    /** Info segment for a position: live P&L text (side/size live in badge/qty). */
     private _positionPill;
-    private _orderPill;
     private _positionOpts;
     private _orderOpts;
     private _onClick;
@@ -958,7 +966,11 @@ declare class TradingController {
 /**
  * Horizontal price line primitive (ARCHITECTURE.md §8). The reusable base for
  * order/SL/TP/alert/indicator-level lines: a line across the plot plus a fixed
- * right-axis price tag. Drag handling is added by the trade layer in Phase 9.
+ * right-axis price tag and an optional broker-style segmented pill group on the
+ * line — [badge][qty][label][✕] — with hover / dragging states (the chart
+ * passes `hoverId`/`dragId` on the render context) and a drag ghost at the
+ * pre-drag price via `setDragGhost`. Interaction semantics are unchanged from
+ * the classic tag: the ✕ hit-tests as `${id}::close`, everything else drags.
  */
 
 interface PriceLineOptions {
@@ -968,7 +980,11 @@ interface PriceLineOptions {
     dashed: boolean;
     /** Right-axis tag text. Defaults to the formatted price. */
     label?: string;
-    /** Optional tag drawn at the LEFT end of the line (broker-style order tag). */
+    /** Solid colored badge segment at the start of the pill group (e.g. 'BUY', 'TP', 'SL'). */
+    badge?: string;
+    /** Quantity segment rendered as a neutral box after the badge. */
+    qty?: string | number;
+    /** Info text segment (order type, price, P&L ...) — the classic left tag text. */
     leftLabel?: string;
     /**
      * Fraction of the plot width the line spans, measured from the right (price)
@@ -976,7 +992,7 @@ interface PriceLineOptions {
      * partial-width order line. The right-axis tag is always drawn.
      */
     extentFromRight?: number;
-    /** Draw a small cancel (cross) box at the right end; hit-tests as `${id}::close`. */
+    /** Draw a cancel (✕) segment at the end of the pill group; hit-tests as `${id}::close`. */
     closeButton?: boolean;
     /** Stable id returned by hit-test (for click/drag routing). */
     id: string;
@@ -986,14 +1002,22 @@ interface PriceLineOptions {
 declare class PriceLine implements IPrimitive {
     private _opts;
     private _host;
+    private _ghostPrice;
+    /** Pill-group geometry from the last draw (media px) for hit-testing. */
+    private _group;
     constructor(opts: PriceLineOptions);
     attached(host: PrimitiveHost): void;
     detached(): void;
     get price(): number;
     /** Move the line; schedules a repaint via the host. */
     setPrice(price: number): void;
-    /** Update the left-end tag text (e.g. live position P&L); repaints. */
+    /** Update the info segment text (e.g. live position P&L); repaints. */
     setLeftLabel(text: string): void;
+    /**
+     * Show a dimmed reference line at the pre-drag price while the user drags
+     * (pass the original price on drag start, null on drag end to clear).
+     */
+    setDragGhost(price: number | null): void;
     options(): Readonly<PriceLineOptions>;
     zOrder(): ZOrder;
     autoscaleInfo(): {
@@ -1194,6 +1218,8 @@ declare class Chart {
     private _downX;
     private _downLocalY;
     private _dragId;
+    private _hoverId;
+    private _overlayFrozen;
     private _dragCb;
     private _dragEndCb;
     private _axisDrag;
@@ -1340,6 +1366,21 @@ declare class Chart {
     private _onFrame;
     private _attachInput;
     private readonly _onPointerEnter;
+    /**
+     * The chart renders as stacked canvases, so the browser's right-click
+     * "Save image as…" would capture only the topmost (transparent overlay)
+     * layer — a blank image. Just before the native menu opens, composite the
+     * clicked pane's base layer *beneath* its overlay bitmap so the saved image
+     * is the visible chart, and freeze overlay repaints (live ticks repaint every
+     * few hundred ms and would wipe the snapshot while the menu is open). The
+     * freeze lifts on the next pointer/wheel/key input after the menu closes.
+     * Apps that present their own menu (preventDefault on contextmenu) are
+     * unaffected. Multi-pane note: the native save captures the clicked pane
+     * only — use `downloadScreenshot()` for the full multi-pane composite.
+     */
+    private readonly _onContextMenu;
+    /** Resume overlay repaints after the native context menu closes. */
+    private _unfreezeOverlay;
     private _localPoint;
     private readonly _onPointerDown;
     private readonly _onPointerMove;
@@ -1360,9 +1401,21 @@ declare class Chart {
     private _shortcutsActive;
     /** Execute a built-in command; returns false for unknown (custom) commands. */
     private _runShortcut;
-    private _downloadScreenshot;
+    /**
+     * Composite the full chart (all panes + overlays) and trigger a PNG download.
+     * This is what the screenshot keyboard shortcut runs; call it from a toolbar
+     * button for a reliable "save image" — the browser's native right-click
+     * "Save image as…" captures only the topmost (transparent overlay) canvas.
+     */
+    downloadScreenshot(filename?: string): void;
     /** Refresh the polite live-region summary screen readers announce. */
     private _updateAccessibleSummary;
+    /**
+     * Track the primitive under the pointer: apply its cursor hint to the
+     * container and repaint on hover enter/leave so lines/pills can render
+     * hover states (they read `hoverId` off the render context).
+     */
+    private _setHover;
     private _updateCursor;
     private _maybeLoadHistory;
     private _startKinetic;
@@ -1799,6 +1852,32 @@ interface LtpEvent {
     volume?: number;
     timeSec: number;
 }
+/**
+ * Real-time order lifecycle event from the `subscribe_orders` stream — fills,
+ * partial fills, rejections, cancellations, pushed by the broker (or by the
+ * sandbox engine in analyze mode).
+ */
+interface OrderUpdateEvent {
+    orderId: string;
+    symbol: string;
+    exchange: string;
+    action: 'BUY' | 'SELL';
+    quantity: number;
+    price: number;
+    /** Undefined when the broker reports 0 (plain LIMIT/MARKET). */
+    triggerPrice?: number;
+    pricetype: string;
+    product: string;
+    /** Lowercase OpenAlgo status: open | trigger pending | complete | rejected | cancelled | ... */
+    status: string;
+    filledQuantity: number;
+    pendingQuantity: number;
+    averagePrice: number;
+    /** Broker RMS/OMS text when rejected. */
+    rejectionReason: string;
+    /** 'live' for broker events, 'analyze' for sandbox events. */
+    mode: string;
+}
 /**
  * Pure: build a subscribe message — `{ action, symbol, exchange, mode }`, where
  * `mode` is the numeric OpenAlgo data mode. Depth subscriptions may request a
@@ -1830,6 +1909,8 @@ declare class OpenAlgoWsFeed {
     private readonly _depthCbs;
     private readonly _stateCbs;
     private readonly _controlCbs;
+    private readonly _orderCbs;
+    private _ordersSubscribed;
     private readonly _subs;
     private _userClosed;
     private _attempts;
@@ -1855,6 +1936,10 @@ declare class OpenAlgoWsFeed {
     onDepth(cb: (symbol: string, exchange: string, depth: MarketDepth) => void): () => void;
     subscribe(mode: WsMode, symbol: string, exchange: string, depthLevel?: number): void;
     unsubscribe(mode: WsMode, symbol: string, exchange: string): void;
+    /** Subscribe to real-time order updates (fills / cancels / rejections). Account-level; replayed on reconnect. */
+    onOrderUpdate(cb: (e: OrderUpdateEvent) => void): () => void;
+    subscribeOrders(): void;
+    unsubscribeOrders(): void;
     close(): void;
     private _dispatch;
 }