@tradecanvas/commons 1.3.0 → 1.7.0

package/dist/types/chart.d.ts

@@ -1,7 +1,36 @@
 import { Theme, ThemeName } from './theme.js';
 import { DrawingToolType } from './drawing.js';
 import { TimeFrame } from './ohlc.js';
-export type ChartType = 'candlestick' | 'line' | 'area' | 'bar' | 'heikinAshi' | 'hollowCandle' | 'baseline' | 'renko' | 'lineBreak' | 'kagi' | 'pointAndFigure' | 'rangeBars' | 'volumeCandles' | 'hlcArea' | 'stepLine' | 'lineWithMarkers' | 'equivolume';
+export type ChartType = 'candlestick' | 'line' | 'area' | 'bar' | 'heikinAshi' | 'hollowCandle' | 'baseline' | 'renko' | 'lineBreak' | 'kagi' | 'pointAndFigure' | 'rangeBars' | 'volumeCandles' | 'hlcArea' | 'stepLine' | 'lineWithMarkers' | 'equivolume' | 'hiLo';
+/**
+ * Settings of the chart types that build bars of their own. What isn't set
+ * is worked out from the data.
+ */
+export interface ChartTypeOptions {
+    /** Box size in price, or 'atr' (default): the average true range of the last `atrPeriod` bars (14). */
+    renko?: {
+        boxSize?: number | 'atr';
+        atrPeriod?: number;
+    };
+    /** How many lines a reversal has to break (3). */
+    lineBreak?: {
+        lines?: number;
+    };
+    /** The reversal: percent of the line's start (4), or an amount of price with `reversalType` 'price'. */
+    kagi?: {
+        reversal?: number;
+        reversalType?: 'percent' | 'price';
+    };
+    /** Box size in price ('auto': 1% of the average close) and boxes to reverse (3). */
+    pointAndFigure?: {
+        boxSize?: number | 'auto';
+        reversal?: number;
+    };
+    /** Each bar's range in price ('auto': 0.5% of the average close). */
+    rangeBars?: {
+        range?: number | 'auto';
+    };
+}
 export type LineStyle = 'solid' | 'dashed' | 'dotted';
 /**
  * Controls which features are available to the end user.
@@ -13,7 +42,7 @@ export interface FeaturesConfig {
     drawings?: boolean;
     /** Whitelist of allowed drawing tool types. When set, only these tools are available. */
     drawingTools?: DrawingToolType[];
-    /** Enable magnet/snap for drawing anchors */
+    /** Allow magnet/snap for drawing anchors. When false, `setDrawingMagnet(true)` is ignored. */
     drawingMagnet?: boolean;
     /** Enable undo/redo for drawings (Ctrl+Z / Ctrl+Y) */
     drawingUndoRedo?: boolean;
@@ -21,6 +50,11 @@ export interface FeaturesConfig {
     trading?: boolean;
     /** Right-click menu for placing orders. Default `false` — opt in explicitly. */
     tradingContextMenu?: boolean;
+    /**
+     * A "+" by the price axis, level with the crosshair; a click on it emits
+     * `priceAxisAdd` with the price. Default `false` (ChartWidget turns it on).
+     */
+    priceAxisAddButton?: boolean;
     /** Enable indicator overlays and panels */
     indicators?: boolean;
     /** Whitelist of allowed indicator IDs. When set, only these are available. */
@@ -48,6 +82,8 @@ export interface FeaturesConfig {
     grid?: boolean;
     /** Show OHLCV legend overlay */
     legend?: boolean;
+    /** Tag each indicator line's latest value on its value axis. Default true. */
+    indicatorValueLabels?: boolean;
     /** Show volume bars below candles */
     volume?: boolean;
     /** Show watermark text */
@@ -62,23 +98,27 @@ export interface FeaturesConfig {
     replay?: boolean;
     /** Show session break lines (day separators) */
     sessionBreaks?: boolean;
-    /** Show bar countdown timer (time until current candle closes) */
+    /** Show bar countdown timer (time until current candle closes). When false it stays hidden. */
     barCountdown?: boolean;
-    /** Enable compare/overlay symbols */
+    /** Enable compare/overlay symbols. When false, `addCompareSymbol` does nothing. */
     compareSymbols?: boolean;
-    /** Enable data export (CSV/JSON) */
+    /** Enable data export (CSV/JSON). When false, `exportVisibleData` / `exportAllData` do nothing. */
     dataExport?: boolean;
-    /** Enable logarithmic price scale toggle */
+    /** Allow the logarithmic price scale. When false, switching to it is ignored. */
     logScale?: boolean;
-    /** Whitelist of available timeframes. When set, only these are selectable. */
+    /**
+     * Whitelist of timeframes. When set, `setTimeframe` ignores any other, and
+     * ChartWidget offers only these.
+     */
     timeframes?: TimeFrame[];
-    /** Default favorite timeframes shown in the quick-access bar */
+    /** ChartWidget: timeframes on the quick-access bar until the user changes them. */
     defaultTimeframeFavorites?: TimeFrame[];
 }
 export interface ChartOptions {
     width?: number;
     height?: number;
-    chartType: ChartType;
+    /** Default `'candlestick'`. */
+    chartType?: ChartType;
     theme?: ThemeName | Theme;
     autoScale?: boolean;
     rightMargin?: number;
@@ -104,11 +144,75 @@ export interface ChartOptions {
      * resting position).
      */
     freePan?: boolean;
+    /**
+     * Timezone for the time axis, crosshair, tooltip, day breaks and range
+     * presets: an IANA zone (`'America/New_York'`, daylight saving included), a
+     * fixed offset in minutes east of UTC, or null (default) for the browser's.
+     */
+    timeZone?: string | number | null;
+    /**
+     * Show a price scale on the left too. It carries the overlays put on it
+     * (`addIndicator(…, { scale: 'left' })`), else it mirrors the price scale.
+     * It shows by itself once an overlay is on it.
+     */
+    leftPriceScale?: boolean;
     /** Bounds for free panning. */
     panLimits?: {
         minVisibleBars?: number;
     };
+    /**
+     * How prices read on the price scale and everything that prints one (axis,
+     * crosshair, last-price tag, legend, tooltip, orders, alerts, drawings): a
+     * function of yours, or fractions of a point (a bond in 32nds: `101'16`).
+     * Indicator panes keep their own numbers. Default: decimals.
+     */
+    priceFormat?: PriceFormatter | PriceFraction;
+    /** How times read on the time axis, the crosshair and the tooltip. Default: the chart's own. */
+    timeFormatter?: TimeFormatter;
+    /** Settings of Renko, Line Break, Kagi, Point & Figure and range bars. */
+    chartTypeOptions?: ChartTypeOptions;
+    /** Mark the highest high and lowest low on screen with a line and a price tag. */
+    highLowLines?: boolean;
+    /** The shapes the chart draws: price tags, axis pills and order badges square (default), rounded or pills. */
+    shapes?: import('./theme.js').ShapeConfig;
+    /**
+     * The chart for screen readers: a summary, what is on screen after the keys
+     * move it, comma and period to read the bars. On by default; labels in your
+     * language here; `false` leaves it out.
+     */
+    a11y?: false | {
+        labels?: Partial<import('./a11y.js').ChartA11yLabels>;
+    };
+    /**
+     * Show the bars outside the symbol's regular hours (`SymbolInfo.sessions`):
+     * pre- and post-market. Default true; bars a day or longer are never left out.
+     */
+    extendedHours?: boolean;
+}
+/** A price in your words, e.g. `(p) => '$' + p.toFixed(2)`. */
+export type PriceFormatter = (price: number) => string;
+/**
+ * Prices in fractions of a point: `denominator` 32 prints 101.5 as `101'16`.
+ * `subDenominator` 2 or 4 splits each fraction in halves or quarters, printed
+ * as a last digit the way futures quote them (`101'165` is 101 and 16½ 32nds).
+ */
+export interface PriceFraction {
+    denominator: number;
+    subDenominator?: number;
+}
+/** Where a time is printed, for a `TimeFormatter`. */
+export interface TimeFormatContext {
+    /**
+     * `'date'`: an axis label of a bar a day or longer; `'day'`: an axis label
+     * where a new day starts; `'time'`: an axis label within a day;
+     * `'crosshair'`: the crosshair's label and the tooltip.
+     */
+    kind: 'date' | 'day' | 'time' | 'crosshair';
+    /** The chart's time zone: an IANA name, minutes east of UTC, or null for the browser's. */
+    timeZone: string | number | null;
 }
+/** A time (ms since the epoch) in your words. */
+export type TimeFormatter = (time: number, context: TimeFormatContext) => string;
 export interface SessionBreakOptions {
     visible?: boolean;
     color?: string;

package/dist/types/chart.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chart.d.ts","sourceRoot":"","sources":["../../src/types/chart.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C,MAAM,MAAM,SAAS,GACjB,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GACvC,YAAY,GAAG,cAAc,GAAG,UAAU,GAC1C,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,gBAAgB,GACjD,WAAW,GACX,eAAe,GAAG,SAAS,GAAG,UAAU,GAAG,iBAAiB,GAC5D,YAAY,CAAC;AAEjB,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAE7B,mFAAmF;IACnF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,yFAAyF;IACzF,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,6CAA6C;IAC7C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sDAAsD;IACtD,eAAe,CAAC,EAAE,OAAO,CAAC;IAG1B,gEAAgE;IAChE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gFAAgF;IAChF,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAG7B,2CAA2C;IAC3C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAGxB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,sCAAsC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uBAAuB;IACvB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,OAAO,CAAC;IAGnB,sBAAsB;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sBAAsB;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,gCAAgC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,qCAAqC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;IAGpB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0BAA0B;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,wBAAwB;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gDAAgD;IAChD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kEAAkE;IAClE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qCAAqC;IACrC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oCAAoC;IACpC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;IAGnB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IACzB,gEAAgE;IAChE,yBAAyB,CAAC,EAAE,SAAS,EAAE,CAAC;CACzC;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,yCAAyC;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uCAAuC;IACvC,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,iGAAiG;IACjG,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,+BAA+B;IAC/B,SAAS,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACrC,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,YAAY,CAAC;CAC7C;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"chart.d.ts","sourceRoot":"","sources":["../../src/types/chart.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C,MAAM,MAAM,SAAS,GACjB,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GACvC,YAAY,GAAG,cAAc,GAAG,UAAU,GAC1C,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,gBAAgB,GACjD,WAAW,GACX,eAAe,GAAG,SAAS,GAAG,UAAU,GAAG,iBAAiB,GAC5D,YAAY,GAAG,MAAM,CAAC;AAE1B;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uGAAuG;IACvG,KAAK,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzD,kDAAkD;IAClD,SAAS,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/B,wGAAwG;IACxG,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;KAAE,CAAC;IACjE,oFAAoF;IACpF,cAAc,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAClE,qEAAqE;IACrE,SAAS,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACzC;AAED,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAE7B,mFAAmF;IACnF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,yFAAyF;IACzF,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,8FAA8F;IAC9F,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sDAAsD;IACtD,eAAe,CAAC,EAAE,OAAO,CAAC;IAG1B,gEAAgE;IAChE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gFAAgF;IAChF,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAG7B,2CAA2C;IAC3C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAGxB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,sCAAsC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uBAAuB;IACvB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,OAAO,CAAC;IAGnB,sBAAsB;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sBAAsB;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,gCAAgC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8EAA8E;IAC9E,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,qCAAqC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;IAGpB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0BAA0B;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,wBAAwB;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gDAAgD;IAChD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,+FAA+F;IAC/F,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,mFAAmF;IACnF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,mGAAmG;IACnG,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iFAAiF;IACjF,QAAQ,CAAC,EAAE,OAAO,CAAC;IAGnB;;;OAGG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IACzB,mFAAmF;IACnF,yBAAyB,CAAC,EAAE,SAAS,EAAE,CAAC;CACzC;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,KAAK,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,yCAAyC;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uCAAuC;IACvC,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,iGAAiG;IACjG,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAClC;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+BAA+B;IAC/B,SAAS,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC;IAC7C,gGAAgG;IAChG,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,kFAAkF;IAClF,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8GAA8G;IAC9G,MAAM,CAAC,EAAE,OAAO,YAAY,EAAE,WAAW,CAAC;IAC1C;;;;OAIG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,WAAW,EAAE,eAAe,CAAC,CAAA;KAAE,CAAC;IACzE;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,+DAA+D;AAC/D,MAAM,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,sDAAsD;AACtD,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,WAAW,CAAC;IAC5C,2FAA2F;IAC3F,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,iDAAiD;AACjD,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,KAAK,MAAM,CAAC;AAEjF,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACrC,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,YAAY,CAAC;CAC7C;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/drawing.d.ts

@@ -1,5 +1,6 @@
 import { Point, ViewportState } from './rendering.js';
-export type DrawingToolType = 'trendLine' | 'horizontalLine' | 'horizontalRay' | 'verticalLine' | 'ray' | 'extendedLine' | 'crossLine' | 'trendAngle' | 'infoLine' | 'parallelChannel' | 'regressionChannel' | 'fibRetracement' | 'fibExtension' | 'fibTimeZones' | 'fibChannel' | 'fibSpeedResistanceFan' | 'rectangle' | 'ellipse' | 'triangle' | 'circle' | 'pitchfork' | 'schiffPitchfork' | 'modifiedSchiffPitchfork' | 'elliottWave' | 'xabcdPattern' | 'abcdPattern' | 'headAndShoulders' | 'priceRange' | 'dateRange' | 'dateAndPriceRange' | 'measure' | 'text' | 'arrow' | 'priceLabel' | 'gannFan' | 'gannBox' | 'cyclicLines' | 'anchoredVWAP' | 'volumeProfileRange' | 'riskReward';
+import { OHLCBar } from './ohlc.js';
+export type DrawingToolType = 'trendLine' | 'horizontalLine' | 'horizontalRay' | 'verticalLine' | 'ray' | 'extendedLine' | 'crossLine' | 'trendAngle' | 'infoLine' | 'parallelChannel' | 'regressionChannel' | 'fibRetracement' | 'fibExtension' | 'fibTimeZones' | 'fibChannel' | 'fibSpeedResistanceFan' | 'rectangle' | 'ellipse' | 'triangle' | 'circle' | 'pitchfork' | 'schiffPitchfork' | 'modifiedSchiffPitchfork' | 'elliottWave' | 'xabcdPattern' | 'abcdPattern' | 'headAndShoulders' | 'priceRange' | 'dateRange' | 'dateAndPriceRange' | 'measure' | 'text' | 'arrow' | 'priceLabel' | 'gannFan' | 'gannBox' | 'cyclicLines' | 'anchoredVWAP' | 'volumeProfileRange' | 'riskReward' | 'note' | 'callout' | 'flag' | 'arrowMark' | 'icon' | 'brush' | 'highlighter' | 'path' | 'polyline' | 'curve' | 'arc' | 'fibCircles' | 'fibSpiral' | 'fibArcs' | 'fibWedge' | 'pitchfan' | 'gannSquare' | 'elliottImpulse' | 'elliottCorrection' | 'elliottTriangle' | 'elliottDoubleCombo' | 'elliottTripleCombo' | 'threeDrives' | 'cypherPattern' | 'timeCycles' | 'sineLine' | 'forecast' | 'projection' | 'barsPattern';
 export interface AnchorPoint {
     time: number;
     price: number;
@@ -20,19 +21,102 @@ export interface DrawingState {
     style: DrawingStyle;
     visible: boolean;
     locked: boolean;
+    /** The tool's own settings (levels, extend left/right…); see `DrawingDescriptor.options`. */
+    options?: DrawingOptions;
+    /** The group it belongs to: drawings selected, hidden and locked together. */
+    group?: {
+        id: string;
+        name: string;
+    };
     meta?: Record<string, unknown>;
 }
+/** One level of a Fibonacci or Gann tool: a ratio, shown or not, in its own colour. */
+export interface DrawingLevel {
+    value: number;
+    visible: boolean;
+    /** CSS colour; the drawing's colour when left out. */
+    color?: string;
+}
+export type DrawingOptionValue = boolean | number | string | DrawingLevel[];
+/** A drawing's settings beyond the shared style, by key. Missing keys take the tool's defaults. */
+export type DrawingOptions = Record<string, DrawingOptionValue>;
+/** A setting a drawing tool offers beyond the shared style, with its default. */
+export type DrawingOptionDef = {
+    kind: 'boolean';
+    label: string;
+    default: boolean;
+} | {
+    kind: 'number';
+    label: string;
+    default: number;
+    min?: number;
+    max?: number;
+    step?: number;
+} | {
+    kind: 'choice';
+    label: string;
+    default: string;
+    choices: readonly {
+        value: string;
+        label: string;
+    }[];
+} | {
+    kind: 'levels';
+    label: string;
+    default: readonly DrawingLevel[];
+} | {
+    kind: 'text';
+    label: string;
+    default: string;
+};
+export type DrawingOptionDefs = Readonly<Record<string, DrawingOptionDef>>;
 export interface DrawingDescriptor {
     type: DrawingToolType;
     name: string;
     requiredAnchors: number;
     singleClick?: boolean;
+    /** Settings the tool offers beyond the shared style; a settings dialog is built from them. */
+    options?: DrawingOptionDefs;
+    /** It fills an area with `style.fillColor` (a settings dialog offers the fill). */
+    fill?: boolean;
+    /** It draws `style.text` (a settings dialog offers the text and its size). */
+    text?: boolean;
+    /**
+     * How it is drawn with the pointer. 'clicks' (the default): a click per
+     * anchor up to `requiredAnchors`. 'freehand': press and drag, a point every
+     * few pixels, release to finish. 'path': a click per point, at least
+     * `requiredAnchors` and at most `maxAnchors`; a double-click, Enter or a
+     * click on the last point finishes it.
+     */
+    creation?: 'clicks' | 'freehand' | 'path';
+    /** Most points a 'path' takes (100 when left out). */
+    maxAnchors?: number;
 }
 export interface DrawingPlugin {
     descriptor: DrawingDescriptor;
     render(ctx: CanvasRenderingContext2D, state: DrawingState, viewport: ViewportState, selected: boolean): void;
     hitTest(point: Point, state: DrawingState, viewport: ViewportState, tolerance: number): boolean;
     hitTestAnchor(point: Point, state: DrawingState, viewport: ViewportState, tolerance: number): number;
+    /**
+     * The drawing after handle `index` (from `hitTestAnchor`) is dragged to
+     * `anchor`. Without it, the handle is anchor `index` and moves there. A
+     * tool with handles that are not anchors (a position's target, say)
+     * changes its options instead.
+     */
+    moveHandle?(state: DrawingState, index: number, anchor: AnchorPoint): DrawingState;
+    /**
+     * The prices of the drawing's lines at `time` (what an alert on it
+     * crosses), or null where it doesn't reach. Tools without it take no alerts.
+     * With `viewport` the lines follow the chart as drawn: straight across bars
+     * (not clock time, so a weekend gap doesn't bend them) and on a log scale
+     * straight in log price.
+     */
+    priceAt?(state: DrawingState, time: number, viewport?: ViewportState): number[] | null;
+    /**
+     * For a tool drawn from the chart's bars (an anchored VWAP, a volume
+     * profile): the chart hands it a getter for them when it is registered.
+     */
+    setDataGetter?(getter: () => readonly OHLCBar[]): void;
 }
 export declare const DEFAULT_DRAWING_STYLE: DrawingStyle;
 //# sourceMappingURL=drawing.d.ts.map

package/dist/types/drawing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"drawing.d.ts","sourceRoot":"","sources":["../../src/types/drawing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE3D,MAAM,MAAM,eAAe,GACvB,WAAW,GAAG,gBAAgB,GAAG,eAAe,GAAG,cAAc,GAAG,KAAK,GAAG,cAAc,GAC1F,WAAW,GAAG,YAAY,GAAG,UAAU,GACvC,iBAAiB,GAAG,mBAAmB,GACvC,gBAAgB,GAAG,cAAc,GAAG,cAAc,GAAG,YAAY,GAAG,uBAAuB,GAC3F,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAC/C,WAAW,GAAG,iBAAiB,GAAG,yBAAyB,GAAG,aAAa,GAC3E,cAAc,GAAG,aAAa,GAAG,kBAAkB,GACnD,YAAY,GAAG,WAAW,GAAG,mBAAmB,GAAG,SAAS,GAC5D,MAAM,GAAG,OAAO,GAAG,YAAY,GAC/B,SAAS,GAAG,SAAS,GAAG,aAAa,GACrC,cAAc,GACd,oBAAoB,GACpB,YAAY,CAAC;AAEjB,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,MAAM,CACJ,GAAG,EAAE,wBAAwB,EAC7B,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,aAAa,EACvB,QAAQ,EAAE,OAAO,GAChB,IAAI,CAAC;IACR,OAAO,CACL,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,aAAa,EACvB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;IACX,aAAa,CACX,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,aAAa,EACvB,SAAS,EAAE,MAAM,GAChB,MAAM,CAAC;CACX;AAED,eAAO,MAAM,qBAAqB,EAAE,YAOnC,CAAC"}
+{"version":3,"file":"drawing.d.ts","sourceRoot":"","sources":["../../src/types/drawing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,MAAM,MAAM,eAAe,GACvB,WAAW,GAAG,gBAAgB,GAAG,eAAe,GAAG,cAAc,GAAG,KAAK,GAAG,cAAc,GAC1F,WAAW,GAAG,YAAY,GAAG,UAAU,GACvC,iBAAiB,GAAG,mBAAmB,GACvC,gBAAgB,GAAG,cAAc,GAAG,cAAc,GAAG,YAAY,GAAG,uBAAuB,GAC3F,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAC/C,WAAW,GAAG,iBAAiB,GAAG,yBAAyB,GAAG,aAAa,GAC3E,cAAc,GAAG,aAAa,GAAG,kBAAkB,GACnD,YAAY,GAAG,WAAW,GAAG,mBAAmB,GAAG,SAAS,GAC5D,MAAM,GAAG,OAAO,GAAG,YAAY,GAC/B,SAAS,GAAG,SAAS,GAAG,aAAa,GACrC,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,GAClD,OAAO,GAAG,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,KAAK,GAC/D,YAAY,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,GAC/E,gBAAgB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG,oBAAoB,GAAG,oBAAoB,GACxG,aAAa,GAAG,eAAe,GAC/B,YAAY,GAAG,UAAU,GACzB,UAAU,GAAG,YAAY,GAAG,aAAa,CAAC;AAE9C,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,6FAA6F;IAC7F,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,8EAA8E;IAC9E,KAAK,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,uFAAuF;AACvF,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,YAAY,EAAE,CAAC;AAE5E,mGAAmG;AACnG,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;AAEhE,iFAAiF;AACjF,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,GACpD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7F;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,SAAS;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,GACxG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAA;CAAE,GACnE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAErD,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAE3E,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8FAA8F;IAC9F,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,mFAAmF;IACnF,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,8EAA8E;IAC9E,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;IAC1C,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,MAAM,CACJ,GAAG,EAAE,wBAAwB,EAC7B,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,aAAa,EACvB,QAAQ,EAAE,OAAO,GAChB,IAAI,CAAC;IACR,OAAO,CACL,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,aAAa,EACvB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;IACX,aAAa,CACX,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,aAAa,EACvB,SAAS,EAAE,MAAM,GAChB,MAAM,CAAC;IACV;;;;;OAKG;IACH,UAAU,CAAC,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,YAAY,CAAC;IACnF;;;;;;OAMG;IACH,OAAO,CAAC,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IACvF;;;OAGG;IACH,aAAa,CAAC,CAAC,MAAM,EAAE,MAAM,SAAS,OAAO,EAAE,GAAG,IAAI,CAAC;CACxD;AAED,eAAO,MAAM,qBAAqB,EAAE,YAOnC,CAAC"}

package/dist/types/events.d.ts

@@ -1,7 +1,36 @@
 import { OHLCBar, DataSeries } from './ohlc.js';
 import { Point } from './rendering.js';
 import { IndicatorValue } from './indicator.js';
-export type ChartEventType = 'crosshairMove' | 'click' | 'barClick' | 'visibleRangeChange' | 'priceRangeChange' | 'zoomChange' | 'dataUpdate' | 'indicatorAdd' | 'indicatorRemove' | 'themeChange' | 'resize' | 'orderPlace' | 'orderModify' | 'orderCancel' | 'positionClose' | 'positionModify' | 'executionError' | 'bracketPlace' | 'drawingCreate' | 'drawingRemove' | 'signalMarkerAdd' | 'signalMarkerRemove' | 'tradeZoneAdd' | 'tradeZoneRemove' | 'alertAdd' | 'alertRemove' | 'alertTriggered' | 'alertUpdate';
+import { DrawingToolType } from './drawing.js';
+import { SymbolInfo } from './symbol.js';
+export type ChartEventType = 'crosshairMove' | 'crosshairLeave' | 'click' | 'barClick' | 'visibleRangeChange' | 'priceRangeChange' | 'zoomChange' | 'dataUpdate' | 'historyLoad' | 'symbolInfoChange' | 'indicatorAdd' | 'indicatorRemove' | 'paneResize'
+/** A pane was folded or opened, maximised or put back, or moved up or down. */
+ | 'paneChange' | 'indicatorUpdate' | 'indicatorChange' | 'themeChange' | 'resize' | 'orderPlace' | 'orderModify' | 'orderCancel' | 'positionClose' | 'positionReverse' | 'positionModify' | 'executionFill' | 'ordersChange' | 'positionsChange' | 'executionError' | 'bracketPlace' | 'drawingCreate' | 'drawingUpdate' | 'drawingDoubleClick' | 'drawingContextMenu' | 'toolModeChange' | 'chartContextMenu' | 'priceAxisAdd' | 'drawingRemove' | 'drawingToolChange' | 'signalMarkerAdd' | 'signalMarkerRemove'
+/** The pointer went onto a signal marker, or off it (`marker: null`). */
+ | 'signalMarkerHover'
+/** A signal marker was clicked. */
+ | 'signalMarkerClick' | 'tradeZoneAdd' | 'tradeZoneRemove' | 'alertAdd' | 'alertRemove' | 'alertTriggered'
+/** An alert reached its `expiresAt` without firing. */
+ | 'alertExpired' | 'symbolSeriesRequest'
+/** A replay step: the bar forming, when it opened, and up to when the replay has shown. */
+ | 'replayStep'
+/** A replay started playing, paused or ended. */
+ | 'replayState' | 'alertUpdate'
+/**
+ * Something a saved layout holds may have changed: drawings, indicators,
+ * alerts, the chart type or the theme. Fires often; debounce it.
+ */
+ | 'stateChange'
+/** The chart type changed (`setChartType`). */
+ | 'chartTypeChange'
+/** The stream moved to another symbol (`connect`, `switchStream`). */
+ | 'symbolChange'
+/** The stream moved to another timeframe (`connect`, `setTimeframe`, `switchStream`). */
+ | 'timeframeChange'
+/** The undo history changed: whether there is something to undo or redo. */
+ | 'historyChange'
+/** The drawings selected changed. */
+ | 'drawingSelect';
 export interface ChartEvent<T = unknown> {
     type: ChartEventType;
     timestamp: number;
@@ -106,6 +135,28 @@ export interface DrawingCreatePayload {
 export interface DrawingRemovePayload {
     id: string;
 }
+/** Where a right-click landed: the price pane, another pane, or an axis. */
+export type ChartContextArea = 'plot' | 'pane' | 'priceAxis' | 'timeAxis';
+/**
+ * Payload for `chartContextMenu`: a right-click off any drawing, where it was
+ * (`x`, `y` in the chart's pixels), and the price and bar time there when the
+ * area has them (the price pane: both; the price axis: price; the time axis: time).
+ */
+export interface ChartContextMenuPayload {
+    area: ChartContextArea;
+    x: number;
+    y: number;
+    price?: number;
+    time?: number;
+    /** For a pane: the indicator whose pane it is. */
+    pane?: string;
+}
+/** Payload for `priceAxisAdd`: the "+" by the price axis was clicked at `price`. */
+export interface PriceAxisAddPayload {
+    price: number;
+    x: number;
+    y: number;
+}
 export interface SignalMarkerAddPayload {
     id: string;
     source: string;
@@ -123,13 +174,41 @@ export interface TradeZoneRemovePayload {
 }
 export interface AlertPayload {
     id: string;
+    /** The level; for an alert on another line, that line's latest value; NaN for a move. */
     price: number;
     condition: string;
     message?: string;
     triggered: boolean;
+    /** What it watches: `'price'` or `<instanceId>:<key>`. */
+    channel?: string;
+    label?: string;
+    /** The line it compares with. */
+    target?: string;
+    /** The drawing it watches. */
+    drawingId?: string;
+    /** A move: the percent, within how many bars. */
+    percent?: number;
+    bars?: number;
+}
+/**
+ * Payload for `historyLoad`: paging older bars in. `loading` when a request
+ * starts, then `loaded` (`count` bars added), `end` (no older bars) or
+ * `error`.
+ */
+export interface HistoryLoadPayload {
+    state: 'loading' | 'loaded' | 'end' | 'error';
+    count: number;
+    error?: string;
+}
+/** What changed on an indicator (`indicatorChange`). */
+export interface IndicatorSettingsChangePayload {
+    instanceId: string;
+    change: 'visible' | 'style' | 'levels' | 'params' | 'pane' | 'scale';
 }
 export interface ChartEventMap {
     crosshairMove: CrosshairMovePayload;
+    /** The pointer left the plot; the crosshair is gone. */
+    crosshairLeave: Record<string, never>;
     click: {
         x: number;
         y: number;
@@ -139,8 +218,51 @@ export interface ChartEventMap {
     priceRangeChange: PriceRangeChangePayload;
     zoomChange: ZoomChangePayload;
     dataUpdate: DataSeries;
+    /** Older bars are being paged in, or finished loading. */
+    historyLoad: HistoryLoadPayload;
+    /** What is known about the symbol on the chart changed (`setSymbolInfo`, or the stream's adapter). */
+    symbolInfoChange: {
+        info: SymbolInfo | null;
+    };
+    chartTypeChange: {
+        type: string;
+        previous: string;
+    };
+    symbolChange: {
+        symbol: string;
+        previous: string | null;
+    };
+    timeframeChange: {
+        timeframe: string;
+        previous: string | null;
+    };
+    historyChange: {
+        canUndo: boolean;
+        canRedo: boolean;
+    };
+    /** The selected drawings' ids, the primary (its handles show) first; none: nothing selected. */
+    drawingSelect: {
+        ids: string[];
+        primary: string | null;
+    };
     indicatorAdd: IndicatorChangePayload;
     indicatorRemove: IndicatorChangePayload;
+    /** An indicator pane was resized (by dragging its divider or `setPanelSize`). */
+    paneResize: {
+        instanceId: string;
+        size: number;
+    };
+    /** A pane was folded or opened, maximised or put back, or moved up or down. */
+    paneChange: {
+        instanceId: string;
+        change: 'collapsed' | 'maximized' | 'order' | 'scale';
+    };
+    /** Indicator values were recomputed from bar index `from` on: new bars, a live tick, a replay step. */
+    indicatorUpdate: {
+        from: number;
+    };
+    /** One indicator's settings changed: shown or hidden, restyled, new levels or inputs, moved to another pane. */
+    indicatorChange: IndicatorSettingsChangePayload;
     themeChange: ThemeChangePayload;
     resize: ResizePayload;
     orderPlace: OrderPlacePayload;
@@ -152,15 +274,47 @@ export interface ChartEventMap {
     executionError: ExecutionErrorPayload;
     drawingCreate: DrawingCreatePayload;
     drawingRemove: DrawingRemovePayload;
+    /** The active drawing tool changed — picked, finished, or cancelled (`tool: null`). */
+    drawingToolChange: {
+        tool: DrawingToolType | null;
+    };
     signalMarkerAdd: SignalMarkerAddPayload;
     signalMarkerRemove: SignalMarkerRemovePayload;
+    signalMarkerHover: {
+        marker: import('./signal.js').SignalMarker | null;
+        x: number;
+        y: number;
+    };
+    signalMarkerClick: {
+        marker: import('./signal.js').SignalMarker;
+        x: number;
+        y: number;
+    };
     tradeZoneAdd: TradeZoneAddPayload;
     tradeZoneRemove: TradeZoneRemovePayload;
     alertAdd: AlertPayload;
     alertRemove: AlertRemovePayload;
     alertTriggered: AlertPayload;
+    alertExpired: AlertPayload;
+    /** An indicator reads a symbol the chart has no bars of: give them with `setSymbolSeries`. */
+    symbolSeriesRequest: {
+        symbol: string;
+    };
+    replayStep: ReplayStepPayload;
+    replayState: {
+        state: 'playing' | 'paused' | 'stopped';
+    };
     alertUpdate: AlertPayload;
 }
+/** Payload for `replayStep`. */
+export interface ReplayStepPayload {
+    /** The chart's bar forming now. */
+    barIndex: number;
+    /** When it opened. */
+    time: number;
+    /** The replay has shown everything before this time (the next step's). */
+    until: number;
+}
 export interface AlertRemovePayload {
     id: string;
 }

package/dist/types/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,MAAM,MAAM,cAAc,GACtB,eAAe,GACf,OAAO,GACP,UAAU,GACV,oBAAoB,GACpB,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,cAAc,GACd,iBAAiB,GACjB,aAAa,GACb,QAAQ,GACR,YAAY,GACZ,aAAa,GACb,aAAa,GACb,eAAe,GACf,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,eAAe,GACf,iBAAiB,GACjB,oBAAoB,GACpB,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,aAAa,GACb,gBAAgB,GAChB,aAAa,CAAC;AAElB,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,OAAO;IACrC,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,CAAC,CAAC;CACZ;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,KAAK,CAAC;IACb,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CAClD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,OAAO,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,WAAW,CAAC;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,oBAAoB,CAAC;IACpC,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,QAAQ,EAAE,eAAe,CAAC;IAC1B,kBAAkB,EAAE,yBAAyB,CAAC;IAC9C,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,UAAU,EAAE,iBAAiB,CAAC;IAC9B,UAAU,EAAE,UAAU,CAAC;IACvB,YAAY,EAAE,sBAAsB,CAAC;IACrC,eAAe,EAAE,sBAAsB,CAAC;IACxC,WAAW,EAAE,kBAAkB,CAAC;IAChC,MAAM,EAAE,aAAa,CAAC;IACtB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,YAAY,EAAE,mBAAmB,CAAC;IAClC,WAAW,EAAE,kBAAkB,CAAC;IAChC,WAAW,EAAE,kBAAkB,CAAC;IAChC,aAAa,EAAE,oBAAoB,CAAC;IACpC,cAAc,EAAE,qBAAqB,CAAC;IACtC,cAAc,EAAE,qBAAqB,CAAC;IACtC,aAAa,EAAE,oBAAoB,CAAC;IACpC,aAAa,EAAE,oBAAoB,CAAC;IACpC,eAAe,EAAE,sBAAsB,CAAC;IACxC,kBAAkB,EAAE,yBAAyB,CAAC;IAC9C,YAAY,EAAE,mBAAmB,CAAC;IAClC,eAAe,EAAE,sBAAsB,CAAC;IACxC,QAAQ,EAAE,YAAY,CAAC;IACvB,WAAW,EAAE,kBAAkB,CAAC;IAChC,cAAc,EAAE,YAAY,CAAC;IAC7B,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,MAAM,cAAc,GACtB,eAAe,GACf,gBAAgB,GAChB,OAAO,GACP,UAAU,GACV,oBAAoB,GACpB,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,kBAAkB,GAClB,cAAc,GACd,iBAAiB,GACjB,YAAY;AACd,+EAA+E;GAC7E,YAAY,GACZ,iBAAiB,GACjB,iBAAiB,GACjB,aAAa,GACb,QAAQ,GACR,YAAY,GACZ,aAAa,GACb,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,gBAAgB,GAChB,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,eAAe,GACf,oBAAoB,GACpB,oBAAoB,GACpB,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,GACf,mBAAmB,GACnB,iBAAiB,GACjB,oBAAoB;AACtB,yEAAyE;GACvE,mBAAmB;AACrB,mCAAmC;GACjC,mBAAmB,GACnB,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,aAAa,GACb,gBAAgB;AAClB,uDAAuD;GACrD,cAAc,GACd,qBAAqB;AACvB,2FAA2F;GACzF,YAAY;AACd,iDAAiD;GAC/C,aAAa,GACb,aAAa;AACf;;;GAGG;GACD,aAAa;AACf,+CAA+C;GAC7C,iBAAiB;AACnB,sEAAsE;GACpE,cAAc;AAChB,yFAAyF;GACvF,iBAAiB;AACnB,4EAA4E;GAC1E,eAAe;AACjB,qCAAqC;GACnC,eAAe,CAAC;AAEpB,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,OAAO;IACrC,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,CAAC,CAAC;CACZ;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,KAAK,CAAC;IACb,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CAClD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,OAAO,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,WAAW,CAAC;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,4EAA4E;AAC5E,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,UAAU,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,gBAAgB,CAAC;IACvB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,oFAAoF;AACpF,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,yFAAyF;IACzF,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,SAAS,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wDAAwD;AACxD,MAAM,WAAW,8BAA8B;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;CACtE;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,oBAAoB,CAAC;IACpC,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACtC,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,QAAQ,EAAE,eAAe,CAAC;IAC1B,kBAAkB,EAAE,yBAAyB,CAAC;IAC9C,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,UAAU,EAAE,iBAAiB,CAAC;IAC9B,UAAU,EAAE,UAAU,CAAC;IACvB,0DAA0D;IAC1D,WAAW,EAAE,kBAAkB,CAAC;IAChC,sGAAsG;IACtG,gBAAgB,EAAE;QAAE,IAAI,EAAE,UAAU,GAAG,IAAI,CAAA;KAAE,CAAC;IAC9C,eAAe,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IACpD,YAAY,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAC1D,eAAe,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAChE,aAAa,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IACtD,gGAAgG;IAChG,aAAa,EAAE;QAAE,GAAG,EAAE,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IACzD,YAAY,EAAE,sBAAsB,CAAC;IACrC,eAAe,EAAE,sBAAsB,CAAC;IACxC,iFAAiF;IACjF,UAAU,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACjD,+EAA+E;IAC/E,UAAU,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,OAAO,CAAA;KAAE,CAAC;IAC1F,uGAAuG;IACvG,eAAe,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAClC,gHAAgH;IAChH,eAAe,EAAE,8BAA8B,CAAC;IAChD,WAAW,EAAE,kBAAkB,CAAC;IAChC,MAAM,EAAE,aAAa,CAAC;IACtB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,YAAY,EAAE,mBAAmB,CAAC;IAClC,WAAW,EAAE,kBAAkB,CAAC;IAChC,WAAW,EAAE,kBAAkB,CAAC;IAChC,aAAa,EAAE,oBAAoB,CAAC;IACpC,cAAc,EAAE,qBAAqB,CAAC;IACtC,cAAc,EAAE,qBAAqB,CAAC;IACtC,aAAa,EAAE,oBAAoB,CAAC;IACpC,aAAa,EAAE,oBAAoB,CAAC;IACpC,uFAAuF;IACvF,iBAAiB,EAAE;QAAE,IAAI,EAAE,eAAe,GAAG,IAAI,CAAA;KAAE,CAAC;IACpD,eAAe,EAAE,sBAAsB,CAAC;IACxC,kBAAkB,EAAE,yBAAyB,CAAC;IAC9C,iBAAiB,EAAE;QAAE,MAAM,EAAE,OAAO,aAAa,EAAE,YAAY,GAAG,IAAI,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/F,iBAAiB,EAAE;QAAE,MAAM,EAAE,OAAO,aAAa,EAAE,YAAY,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxF,YAAY,EAAE,mBAAmB,CAAC;IAClC,eAAe,EAAE,sBAAsB,CAAC;IACxC,QAAQ,EAAE,YAAY,CAAC;IACvB,WAAW,EAAE,kBAAkB,CAAC;IAChC,cAAc,EAAE,YAAY,CAAC;IAC7B,YAAY,EAAE,YAAY,CAAC;IAC3B,8FAA8F;IAC9F,mBAAmB,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACxC,UAAU,EAAE,iBAAiB,CAAC;IAC9B,WAAW,EAAE;QAAE,KAAK,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAA;KAAE,CAAC;IACzD,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED,gCAAgC;AAChC,MAAM,WAAW,iBAAiB;IAChC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,0EAA0E;IAC1E,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC"}

package/dist/types/execution.d.ts

@@ -1,5 +1,5 @@
 import { ConnectionState } from './realtime.js';
-import { TradingOrder, OrderSide, OrderPlaceIntent, OrderModifyIntent, OrderCancelIntent, PositionModifyIntent, PositionCloseIntent } from './trading.js';
+import { TradingOrder, OrderSide, OrderPlaceIntent, OrderModifyIntent, OrderCancelIntent, PositionModifyIntent, PositionCloseIntent, PositionReverseIntent } from './trading.js';
 export interface ExecutionConfig {
     /** Account identifier, when the broker scopes by account. */
     account?: string;
@@ -8,12 +8,20 @@ export interface ExecutionConfig {
     meta?: Record<string, unknown>;
 }
 export type ExecutionEventType = 'orders' | 'positions' | 'fill' | 'connectionChange' | 'error';
+/** Why a fill happened: an order, a position closed by hand or reversed, or its stop-loss or take-profit. */
+export type FillReason = 'order' | 'close' | 'reverse' | 'stopLoss' | 'takeProfit';
 export interface FillEvent {
     orderId: string;
     side: OrderSide;
     price: number;
     quantity: number;
+    /** When it filled (ms since the epoch). */
     time: number;
+    /** The position it opened or closed. */
+    positionId?: string;
+    reason?: FillReason;
+    /** Profit or loss it realised, for a fill that closes a position. */
+    pnl?: number;
 }
 export interface ExecutionError {
     message: string;
@@ -51,6 +59,17 @@ export interface ExecutionAdapter {
     modifyPosition(intent: PositionModifyIntent): Promise<void>;
     /** Close a position (full close). */
     closePosition(intent: PositionCloseIntent): Promise<void>;
+    /**
+     * Close a position and open the same size the other way. Optional: without
+     * it, the chart closes the position and places a market order instead.
+     */
+    reversePosition?(intent: PositionReverseIntent): Promise<void>;
+    /**
+     * The market price, live or replayed, and its time (ms). Optional: a paper
+     * adapter fills pending orders and stops against it and stamps fills with
+     * the time. The chart calls it with the replayed price during a replay.
+     */
+    setMarkPrice?(price: number, time?: number): void;
     on<T = unknown>(event: ExecutionEventType, listener: ExecutionListener<T>): void;
     off<T = unknown>(event: ExecutionEventType, listener: ExecutionListener<T>): void;
     dispose(): void;

package/dist/types/execution.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"execution.d.ts","sourceRoot":"","sources":["../../src/types/execution.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,EACV,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,cAAc,CAAC;AAWtB,MAAM,WAAW,eAAe;IAC9B,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,MAAM,MAAM,kBAAkB,GAC1B,QAAQ,GACR,WAAW,GACX,MAAM,GACN,kBAAkB,GAClB,OAAO,CAAC;AAEZ,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,OAAO;IACzC,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE,CAAC,CAAC;IACR,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEhF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,UAAU,IAAI,IAAI,CAAC;IACnB,kBAAkB,IAAI,eAAe,CAAC;IAEtC,+EAA+E;IAC/E,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC5D,gCAAgC;IAChC,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,8BAA8B;IAC9B,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,iDAAiD;IACjD,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5D,qCAAqC;IACrC,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACjF,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAElF,OAAO,IAAI,IAAI,CAAC;CACjB"}
+{"version":3,"file":"execution.d.ts","sourceRoot":"","sources":["../../src/types/execution.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,EACV,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,cAAc,CAAC;AAWtB,MAAM,WAAW,eAAe;IAC9B,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,MAAM,MAAM,kBAAkB,GAC1B,QAAQ,GACR,WAAW,GACX,MAAM,GACN,kBAAkB,GAClB,OAAO,CAAC;AAEZ,6GAA6G;AAC7G,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,CAAC;AAEnF,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,OAAO;IACzC,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE,CAAC,CAAC;IACR,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEhF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,UAAU,IAAI,IAAI,CAAC;IACnB,kBAAkB,IAAI,eAAe,CAAC;IAEtC,+EAA+E;IAC/E,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC5D,gCAAgC;IAChC,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,8BAA8B;IAC9B,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,iDAAiD;IACjD,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5D,qCAAqC;IACrC,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D;;;OAGG;IACH,eAAe,CAAC,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D;;;;OAIG;IACH,YAAY,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElD,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACjF,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAElF,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/dist/types/index.d.ts

@@ -12,4 +12,8 @@ export * from './execution.js';
 export * from './signal.js';
 export * from './realtime.js';
 export * from './finance.js';
+export * from './symbol.js';
+export * from './quote.js';
+export * from './news.js';
+export * from './a11y.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC"}