openalgo-charts 1.0.4 → 1.0.6

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /** Library version string. Matches package.json (published npm release). */
-declare const VERSION = "1.0.4";
+declare const VERSION = "1.0.6";
 /** Returns the current library version. */
 declare function version(): string;
 
@@ -1219,6 +1219,7 @@ declare class Chart {
     private _downLocalY;
     private _dragId;
     private _hoverId;
+    private _overlayFrozen;
     private _dragCb;
     private _dragEndCb;
     private _axisDrag;
@@ -1365,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;
@@ -1575,6 +1591,78 @@ declare class LogoWatermark implements IPrimitive {
     private _tinted;
 }
 
+/**
+ * Inline Buy/Sell button panel (ARCHITECTURE.md §9). A TradingView-style trade
+ * panel docked inside the plot: a SELL button (bid), a quantity chip, and a BUY
+ * button (ask), drawn on the overlay canvas so it stays fixed while the chart
+ * pans/zooms. Clicks hit-test to `${id}:sell` / `${id}:buy` / `${id}:qty`, which
+ * the chart routes through `subscribeClick` — the app places the order. Prices
+ * update cheaply on every tick (`setPrices` / `setMark`).
+ */
+
+interface BuySellButtonsOptions {
+    /** Stable id prefix; hit-tests emit `${id}:sell` / `${id}:buy` / `${id}:qty`. Default `trade`. */
+    id?: string;
+    /** Corner to dock to. Default `top-left`. */
+    position?: WatermarkPosition;
+    /**
+     * Gap from the plot edges in media px. A number applies to both axes; pass
+     * `{ x, y }` to offset independently (e.g. clear an OHLC legend at the top).
+     */
+    margin?: number | {
+        x: number;
+        y: number;
+    };
+    /** Quantity shown in the centre chip (e.g. lots or absolute qty). */
+    qty?: string | number;
+    /** Buy button color (defaults to the theme `buy`). */
+    buyColor?: string;
+    /** Sell button color (defaults to the theme `sell`). */
+    sellColor?: string;
+    /** Button labels. Default `BUY` / `SELL`. */
+    buyLabel?: string;
+    sellLabel?: string;
+    /** Show the price line above each label. Default true. */
+    showPrices?: boolean;
+}
+declare class BuySellButtons implements IPrimitive {
+    private readonly _id;
+    private readonly _position;
+    private readonly _mx;
+    private readonly _my;
+    private readonly _buyLabel;
+    private readonly _sellLabel;
+    private readonly _showPrices;
+    private _qty;
+    private _buyColor?;
+    private _sellColor?;
+    private _bid;
+    private _ask;
+    private _host;
+    private _sellRect;
+    private _buyRect;
+    private _qtyRect;
+    constructor(options?: BuySellButtonsOptions);
+    attached(host: PrimitiveHost): void;
+    detached(): void;
+    zOrder(): ZOrder;
+    autoscaleInfo(): null;
+    /** Distinct bid/ask (shows a spread on the two buttons). */
+    setPrices(bid: number, ask: number): void;
+    /** Single mark price shown on both buttons (when there is no bid/ask). */
+    setMark(price: number): void;
+    setQty(qty: string | number): void;
+    setColors(buyColor?: string, sellColor?: string): void;
+    private _origin;
+    draw(ctx: CanvasRenderingContext2D, rc: PrimitiveRenderContext): void;
+    private _fmt;
+    private _drawButton;
+    private _drawChip;
+    /** Trace a rect rounded on the left or right pair of corners only. */
+    private _roundedSide;
+    hitTest(x: number, y: number, _rc: PrimitiveRenderContext): PrimitiveHit | null;
+}
+
 /**
  * Exponential moving average (ARCHITECTURE.md §8 — an indicator that validates
  * the series/extensibility model). Pure; the result is plotted as a `line`
@@ -2223,4 +2311,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 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 };
+export { ALT_PRESET, type AddSeriesOptions, type AggTick, BUILTIN_COMMANDS, type Bar, type BarUpdate, type BarsRequest, BuySellButtons, type BuySellButtonsOptions, 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 };