openalgo-charts 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /** Library version string. Matches package.json (published npm release). */
-declare const VERSION = "1.0.2";
+declare const VERSION = "1.0.4";
 /** Returns the current library version. */
 declare function version(): string;
 
@@ -365,6 +365,12 @@ interface SeriesStyle {
     volumeScaled?: boolean;
     /** Whether the series is drawn and counted in autoscale. Default true. */
     visible?: boolean;
+    /** Optional label carried with the series (for host-drawn legends). */
+    title?: string;
+    /** Show the dashed horizontal last-price line across the plot. Default true. */
+    priceLineVisible?: boolean;
+    /** Show the last-value tag on the price axis. Default true. */
+    lastValueVisible?: boolean;
     color?: string;
     lineWidth?: number;
     /** Line dash style for line/step/area/HLC series. Default 'solid'. */
@@ -405,6 +411,14 @@ interface ChartTheme {
     axisFontSize?: number;
     /** Grid line dash style (default 'solid'). */
     gridStyle?: 'solid' | 'dashed' | 'dotted';
+    /** Crosshair line dash style (default 'dashed'). */
+    crosshairStyle?: 'solid' | 'dashed' | 'dotted';
+    /** Crosshair line width in device px (default 1 = hairline). */
+    crosshairWidth?: number;
+    /** Background of the crosshair value tags (defaults to `crosshair`). */
+    crosshairLabelBackground?: string;
+    /** Show the crosshair price/time value tags (default true). */
+    crosshairLabelVisible?: boolean;
     upColor: string;
     downColor: string;
     wickUpColor: string;
@@ -478,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;
@@ -578,6 +596,20 @@ interface SeriesApi {
     createMarkers(): SeriesMarkers;
 }
 
+/**
+ * Axis label rendering (ARCHITECTURE.md §6, §5.3). Price axis (right strip) and
+ * time axis (bottom strip). Time labels switch from clock to date at IST day
+ * boundaries; gaps are already collapsed by the logical-index time scale.
+ */
+
+/**
+ * Boundary class of a time-axis label, passed to a custom `timeFormatter` as a
+ * hint so a host can render adaptive labels (year at year boundaries, month at
+ * month boundaries, day otherwise, clock intraday) — parity with common
+ * `tickMarkFormatter(time, tickMarkType)` APIs.
+ */
+type TickMarkType = 'year' | 'month' | 'day' | 'time' | 'timeWithSeconds';
+
 /**
  * A pane is one vertically-stacked drawing region (price pane, volume pane,
  * indicator pane). It owns a base + top canvas (ARCHITECTURE.md §3.1) and a
@@ -605,7 +637,11 @@ interface PaneRenderContext {
     /** Draw the horizontal (price) grid lines. */
     showHorzGrid: boolean;
     /** Optional custom time label formatter (UTC seconds -> string). Defaults to IST. */
-    timeFormatter?: (utcSeconds: number) => string;
+    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;
@@ -918,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;
@@ -930,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 {
@@ -940,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)
@@ -948,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;
@@ -958,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(): {
@@ -1061,7 +1113,7 @@ interface ChartOptions {
      * omitted, labels use IST (Indian market default). e.g. for UTC:
      * `(s) => new Date(s * 1000).toISOString().slice(11, 16)`.
      */
-    timeFormatter?: (utcSeconds: number) => string;
+    timeFormatter?: (utcSeconds: number, tickMark?: TickMarkType) => string;
 }
 interface AddSeriesOptions {
     /** Target pane index (0 = price). Higher panes are created on demand. */
@@ -1166,6 +1218,7 @@ declare class Chart {
     private _downX;
     private _downLocalY;
     private _dragId;
+    private _hoverId;
     private _dragCb;
     private _dragEndCb;
     private _axisDrag;
@@ -1280,7 +1333,7 @@ declare class Chart {
      * Set a custom time-axis + crosshair label formatter (UTC seconds -> string)
      * at runtime. Pass undefined to restore the IST default.
      */
-    setTimeFormatter(fn: ((utcSeconds: number) => string) | undefined): void;
+    setTimeFormatter(fn: ((utcSeconds: number, tickMark?: TickMarkType) => string) | undefined): void;
     /** Swap the palette at runtime (dark/light toggle) without recreating the chart. */
     setTheme(theme: ChartTheme): void;
     /**
@@ -1294,7 +1347,7 @@ declare class Chart {
             horzLines?: boolean;
         };
         priceFormatter?: ((price: number) => string) | null;
-        timeFormatter?: ((utcSeconds: number) => string) | undefined;
+        timeFormatter?: ((utcSeconds: number, tickMark?: TickMarkType) => string) | undefined;
         crosshairMode?: CrosshairMode;
     }): void;
     panes(): readonly Pane[];
@@ -1332,9 +1385,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;
@@ -1771,6 +1836,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
@@ -1802,6 +1893,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;
@@ -1827,6 +1920,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;
 }
@@ -2126,4 +2223,4 @@ declare function lerp(a: number, b: number, t: number): number;
  */
 declare function roundToTick(value: number, step: number): number;
 
-export { ALT_PRESET, type AddSeriesOptions, type AggTick, BUILTIN_COMMANDS, type Bar, type BarUpdate, type BarsRequest, CandleBuilder, type CandleBuilderOptions, type CandleStyle, type CandleUpdate, Chart, type ChartEvent, type ChartOptions, type ChartTheme, type CrosshairMoveEvent, type CustomShortcut, DEFAULT_CANDLE_BUILDER_OPTIONS, DEFAULT_CANDLE_STYLE, DEFAULT_HISTOGRAM_STYLE, DEFAULT_KEYMAP, DEFAULT_PRICE_SCALE_OPTIONS, DEFAULT_THEME, DEFAULT_TIME_SCALE_OPTIONS, DEFAULT_TRADING_COLORS, type DataFeed, type DepthLevel, type DrawItem, EventMarkers, FakeDataFeed, type FeedScheduler, type HistogramStyle, type IPrimitive, IST_OFFSET_SECONDS, InvalidationLevel, type KeymapEntry, type LateTickPolicy, type LinePoint, type LogicalRange, LogoWatermark, type LogoWatermarkOptions, type LtpEvent, type MarkerPosition, type MarkerShape, type MarkerSize, type MarketDepth, type OpenAlgoConfig, OpenAlgoDataFeed, type OpenAlgoLiveConfig, OpenAlgoLiveDataFeed, type OpenAlgoTradeConfig, OpenAlgoTradeFeed, type OpenAlgoWsConfig, OpenAlgoWsFeed, type OrderSide$1 as OrderSide, type OrderType$1 as OrderType, type OriginalTime, Pane, type PaneInvalidation, type PlaceOrder, type PositionSide, PriceLine, type PriceLineOptions, type PriceRange, PriceScale, type PriceScaleId, type PriceScaleMode, type PriceScaleOptions, type PrimitiveHit, type PrimitiveHost, type PrimitiveRenderContext, type RendererEntry, type SeriesApi, type SeriesDataItem, type SeriesMarker, SeriesMarkers, type SeriesRenderContext, type SeriesStyle, type SeriesType, type ShortcutListItem, ShortcutManager, type ShortcutManagerOptions, type ShortcutPreset, type ShortcutScope, type ShortcutTriggerEvent, type Size, type SocketFactory, type SocketLike, type SupertrendPoint, type Tick, TickBarAggregator, type TickTimeframe, TimeScale, type TimeScaleOp, type TimeScaleOptions, type TradeFeed, type TradeMarkerVariant, TradeMarkersPrimitive, type TradingColors, TradingController, type TradingHost, type TradingLineStyle, type TradingLineVariant, type TradingOrder, type TradingOrderSide, type TradingOrderType, type TradingPosition, type TradingSettings, type TradingSyncPayload, type TradingTrade, type UTCSeconds, type UnsubscribeFn, VERSION, type VolumeMode, type WatermarkPosition, type Whitespace, type WsControlMessage, type WsMode, type WsState, type ZOrder, atr, autoscaleRange, bestHit, bitmapSize, clamp, compactVolume, conflateBars, conflateItems, conflationGroupSize, createChart, darkTheme, drawShape, effectiveMarkerPx, ema, emaSeries, epochMsToUtcSeconds, eventToCombo, formatCombo, formatIstDate, formatIstTime, formatIstTimeSeconds, formatSubscribe, formatUnsubscribe, generateBars, getChartType, intervalToSeconds, isNewIstDay, isReservedCombo, isValidCombo, isWhitespace, istStringToUtcSeconds, lerp, lightTheme, mapHistoryResponse, mapOrder, mapPosition, markerSizePx, mergeBars, niceTicks, normalizeCombo, optimalBarWidth, parseCombo, parseMessage, precisionForStep, registerChartType, registeredChartTypes, roundToTick, rowTimeToUtcSeconds, rsi, rsiSeries, snapToDevicePixel, supertrend, supertrendSeries, toBar, trueRange, utcSecondsToIstDateString, utcSecondsToIstParts, version, verticalGradient, watermarkRect };
+export { ALT_PRESET, type AddSeriesOptions, type AggTick, BUILTIN_COMMANDS, type Bar, type BarUpdate, type BarsRequest, CandleBuilder, type CandleBuilderOptions, type CandleStyle, type CandleUpdate, Chart, type ChartEvent, type ChartOptions, type ChartTheme, type CrosshairMoveEvent, type CustomShortcut, DEFAULT_CANDLE_BUILDER_OPTIONS, DEFAULT_CANDLE_STYLE, DEFAULT_HISTOGRAM_STYLE, DEFAULT_KEYMAP, DEFAULT_PRICE_SCALE_OPTIONS, DEFAULT_THEME, DEFAULT_TIME_SCALE_OPTIONS, DEFAULT_TRADING_COLORS, type DataFeed, type DepthLevel, type DrawItem, EventMarkers, FakeDataFeed, type FeedScheduler, type HistogramStyle, type IPrimitive, IST_OFFSET_SECONDS, InvalidationLevel, type KeymapEntry, type LateTickPolicy, type LinePoint, type LogicalRange, LogoWatermark, type LogoWatermarkOptions, type LtpEvent, type MarkerPosition, type MarkerShape, type MarkerSize, type MarketDepth, type OpenAlgoConfig, OpenAlgoDataFeed, type OpenAlgoLiveConfig, OpenAlgoLiveDataFeed, type OpenAlgoTradeConfig, OpenAlgoTradeFeed, type OpenAlgoWsConfig, OpenAlgoWsFeed, type OrderSide$1 as OrderSide, type OrderType$1 as OrderType, type OriginalTime, Pane, type PaneInvalidation, type PlaceOrder, type PositionSide, PriceLine, type PriceLineOptions, type PriceRange, PriceScale, type PriceScaleId, type PriceScaleMode, type PriceScaleOptions, type PrimitiveHit, type PrimitiveHost, type PrimitiveRenderContext, type RendererEntry, type SeriesApi, type SeriesDataItem, type SeriesMarker, SeriesMarkers, type SeriesRenderContext, type SeriesStyle, type SeriesType, type ShortcutListItem, ShortcutManager, type ShortcutManagerOptions, type ShortcutPreset, type ShortcutScope, type ShortcutTriggerEvent, type Size, type SocketFactory, type SocketLike, type SupertrendPoint, type Tick, TickBarAggregator, type TickMarkType, type TickTimeframe, TimeScale, type TimeScaleOp, type TimeScaleOptions, type TradeFeed, type TradeMarkerVariant, TradeMarkersPrimitive, type TradingColors, TradingController, type TradingHost, type TradingLineStyle, type TradingLineVariant, type TradingOrder, type TradingOrderSide, type TradingOrderType, type TradingPosition, type TradingSettings, type TradingSyncPayload, type TradingTrade, type UTCSeconds, type UnsubscribeFn, VERSION, type VolumeMode, type WatermarkPosition, type Whitespace, type WsControlMessage, type WsMode, type WsState, type ZOrder, atr, autoscaleRange, bestHit, bitmapSize, clamp, compactVolume, conflateBars, conflateItems, conflationGroupSize, createChart, darkTheme, drawShape, effectiveMarkerPx, ema, emaSeries, epochMsToUtcSeconds, eventToCombo, formatCombo, formatIstDate, formatIstTime, formatIstTimeSeconds, formatSubscribe, formatUnsubscribe, generateBars, getChartType, intervalToSeconds, isNewIstDay, isReservedCombo, isValidCombo, isWhitespace, istStringToUtcSeconds, lerp, lightTheme, mapHistoryResponse, mapOrder, mapPosition, markerSizePx, mergeBars, niceTicks, normalizeCombo, optimalBarWidth, parseCombo, parseMessage, precisionForStep, registerChartType, registeredChartTypes, roundToTick, rowTimeToUtcSeconds, rsi, rsiSeries, snapToDevicePixel, supertrend, supertrendSeries, toBar, trueRange, utcSecondsToIstDateString, utcSecondsToIstParts, version, verticalGradient, watermarkRect };