@funnest/charts 0.5.2 → 0.6.1

package/dist/chart.d.ts

@@ -1,9 +1,9 @@
 import { type Locale } from './model/time-format';
 import { TimeScale, type IndexRange, type TimeScaleOptions } from './model/time-scale';
-import { type IndicatorParams, type IndicatorType } from './indicators/definitions';
+import type { IndicatorDefinition, IndicatorParams, IndicatorType } from './indicators/definitions';
 import { type IndicatorConfig, type IndicatorPatch } from './indicators/manager';
-import { type Drawing, type DrawingType } from './objects/drawings';
-import { type ExecutionMarker, type LineHandle, type OrderLineOptions, type PositionLineOptions } from './objects/trading';
+import { type Drawing, type DrawingDefinition, type DrawingType } from './objects/drawings';
+import { type AlertLineOptions, type ExecutionMarker, type LineHandle, type OrderLineOptions, type PositionLineOptions } from './objects/trading';
 import { type ChartSettings, type ChartState } from './settings';
 import { type TradingAdapter } from './objects/trading-sync';
 import { type ChartType, type CrosshairInfo, type PaneId } from './render/renderer';
@@ -33,6 +33,30 @@ export interface ChartOptions {
     historyBatchSize?: number;
     /** The user's fills, positions and orders, synced per symbol. See TradingAdapter. */
     trading?: TradingAdapter;
+    /** Extra indicators (same shape as the built-ins). They appear in the widget's indicator picker. */
+    indicatorDefinitions?: readonly IndicatorDefinition[];
+    /** Extra drawing tools. They appear in the widget's drawing bar. */
+    drawingDefinitions?: readonly DrawingDefinition[];
+}
+/** A symbol overlaid for comparison. */
+export interface CompareInfo {
+    symbol: string;
+    /** Display name once resolved (the symbol until then). */
+    name: string;
+    color: string;
+    /** Bars are loaded. */
+    ready: boolean;
+}
+/** Bar replay: history is cut at a past bar and played forward. */
+export interface ReplayStatus {
+    /** Waiting for the user to click the bar to start from. */
+    selecting: boolean;
+    active: boolean;
+    playing: boolean;
+    /** Bars still hidden to the right. */
+    remaining: number;
+    /** Milliseconds between bars while playing. */
+    interval: number;
 }
 export interface ChartEvents {
     crosshairMove: CrosshairInfo | null;
@@ -68,8 +92,30 @@ export interface ChartEvents {
     /** Realtime connection state/latency reported by the datafeed. */
     connectionChange: ConnectionState;
     indicatorsChange: IndicatorConfig[];
+    /** Undo/redo availability changed (drawings and indicators are tracked). */
+    historyChange: {
+        canUndo: boolean;
+        canRedo: boolean;
+    };
+    comparesChange: CompareInfo[];
+    replayChange: ReplayStatus;
+    /**
+     * Right-click on the chart (mouse only). While anything listens, the browser's own menu is
+     * suppressed — the widget shows its menu (undo, horizontal line here, reset…).
+     */
+    contextMenu: ChartContextMenu;
     error: unknown;
 }
+export interface ChartContextMenu {
+    /** Pixels relative to the chart element. */
+    x: number;
+    y: number;
+    pane: PaneId;
+    /** Price under the pointer (tick-rounded) when it's over the price pane, else null. */
+    price: number | null;
+    /** Time of the bar under the pointer, or null past the data. */
+    time: number | null;
+}
 export interface ChartPaneLayout {
     id: PaneId;
     kind: 'main' | 'volume' | 'indicator';
@@ -165,6 +211,18 @@ export declare class Chart {
     private loadingHistory;
     private noMoreHistory;
     private historyRequestedFor;
+    private countdownLabel;
+    /** Undo/redo of drawings + indicators, as JSON snapshots. */
+    private readonly history;
+    private readonly compares;
+    private compareVersion;
+    /** Base bar index of the % axis and compare lines (the first visible bar). */
+    private percentBaseIndex;
+    private replayState;
+    private replaySelecting;
+    /** Pane height weights the user set by dragging borders (unset panes use PANE_WEIGHT). */
+    private readonly paneWeights;
+    private paneWeightTotal;
     constructor(container: HTMLElement, options?: ChartOptions);
     /** Replaces all bars and scrolls to the latest. */
     setData(bars: readonly Bar[]): void;
@@ -256,6 +314,8 @@ export declare class Chart {
     /** Restores drawings (e.g. from storage). */
     setDrawings(drawings: readonly Drawing[]): void;
     updateDrawing(id: string, patch: Partial<Omit<Drawing, 'id'>>): void;
+    /** Adds a drawing (e.g. a horizontal line at a price) and selects it. Returns its id. */
+    addDrawing(drawing: Omit<Drawing, 'id'>): string;
     removeDrawing(id: string): void;
     clearDrawings(): void;
     get selectedDrawing(): Drawing | null;
@@ -272,6 +332,65 @@ export declare class Chart {
     /** Formatted indicator values at a bar index (default: the last bar), for legends. */
     indicatorLegend(index?: number): IndicatorLegendItem[];
     private indicatorsChanged;
+    /** Built-in and custom indicators this chart can add. */
+    indicatorDefinitions(): IndicatorDefinition[];
+    indicatorDefinition(type: IndicatorType): IndicatorDefinition | undefined;
+    /** Built-in and custom drawing tools, in drawing-bar order. */
+    drawingDefinitions(): DrawingDefinition[];
+    /**
+     * Moves the border above pane `index` (1 = between the price pane and the next one) by `dy` px.
+     * The two neighbouring panes trade height; the rest keep theirs. Users do this by dragging.
+     */
+    resizePane(index: number, dy: number): void;
+    /** Back to the default pane heights. */
+    resetPaneSizes(): void;
+    get canUndo(): boolean;
+    get canRedo(): boolean;
+    /** Reverts the last drawing or indicator change. */
+    undo(): void;
+    redo(): void;
+    private historySnapshot;
+    private recordHistory;
+    private resetHistory;
+    private applyHistory;
+    private emitHistory;
+    /**
+     * Overlays another symbol's closes as a line, rebased to the first visible bar. The price
+     * axis switches to % while any symbol is compared. Needs the `datafeed` option.
+     */
+    addCompare(symbol: string): Promise<void>;
+    removeCompare(symbol: string): void;
+    getCompares(): CompareInfo[];
+    /** Each compared symbol's % change from the first visible bar, at `index` (default: the last bar). */
+    compareLegend(index?: number): (CompareInfo & {
+        value: string;
+    })[];
+    private comparesChanged;
+    /** (Re)loads a compared symbol's bars at the current resolution, back to the main series' first bar. */
+    private reloadCompare;
+    /** Pages a compared symbol's history back until it covers the main series' first bar. */
+    private loadOlderCompare;
+    /** Compare closes at each main bar (the compare bar at or before its time). */
+    private alignedCompare;
+    /** Compare lines in main-price space, each rebased so its first visible value sits on the main close there. */
+    private compareOverlays;
+    get replay(): ReplayStatus;
+    /** Arms start picking: the next click on the chart starts a replay from that bar. Esc cancels. */
+    setReplaySelecting(on: boolean): void;
+    /** Hides every bar after `time` (UTC ms); reveal them with replayStep/replayPlay. */
+    startReplay(time: number): void;
+    /** Reveals the next `count` hidden bars. */
+    replayStep(count?: number): void;
+    /** Plays one bar every `interval` ms (default: the last speed used, initially 1000). */
+    replayPlay(interval?: number): void;
+    /** Changes the playback speed (ms per bar), also while playing. */
+    setReplayInterval(interval: number): void;
+    replayPause(): void;
+    /** Leaves replay and shows every bar again (including live ones that arrived meanwhile). */
+    stopReplay(): void;
+    private endReplay;
+    private stopReplayTimer;
+    private emitReplay;
     private indicatorScale;
     /**
      * Connects the user's account (fills, positions, orders). The chart loads them for the
@@ -282,6 +401,8 @@ export declare class Chart {
     addPositionLine(options: PositionLineOptions): LineHandle<PositionLineOptions>;
     /** Pending order line. Pass `onMove` to make it draggable and `onCancel` for an × button. */
     addOrderLine(options: OrderLineOptions): LineHandle<OrderLineOptions>;
+    /** Price alert line (dotted, gray, "알림" label). Pass `onMove` to make it draggable and `onCancel` for an ×. */
+    addAlertLine(options: AlertLineOptions): LineHandle<AlertLineOptions>;
     /** Fill markers (▲ buy under the bar, ▼ sell above). Replaces the previous set. */
     setExecutions(markers: readonly ExecutionMarker[]): void;
     setTheme(theme: Partial<ThemeTokens>): void;
@@ -307,6 +428,15 @@ export declare class Chart {
     private barInterval;
     private paneCoords;
     private computeFrame;
+    /** Price-pane tick values for the current axis mode. */
+    private mainTicks;
+    private percentBase;
+    /** Price-axis tick labels: prices, or "+2.5%" on a % axis (decimals follow the step). */
+    private mainTickFormat;
+    /** Crosshair and last-price label of the price pane. */
+    private mainValueFormat;
+    /** Time left in the last bar, when it's still forming (null otherwise). */
+    private countdownText;
     /** Auto-scales the price pane to visible candles and overlay indicators; returns the candle extremes. */
     private autoScale;
     private autoScaleIndicator;
@@ -325,6 +455,8 @@ export declare class Chart {
     private createInteractionHost;
     /** Esc cancels a drawing in progress or deselects; Delete/Backspace removes the selected drawing. */
     private observeKeyboard;
+    /** Repaints when the bar-close countdown ticks over (once a second, only while it shows or changes). */
+    private observeCountdown;
     private observeSize;
     /** Theme values using `var(--x)` follow the host page's dark-mode / theme switches automatically. */
     private observeThemeVariables;

package/dist/events.d.ts

@@ -3,5 +3,6 @@ export declare class Emitter<Events extends object> {
     private readonly listeners;
     on<K extends keyof Events>(event: K, listener: Listener<Events[K]>): () => void;
     emit<K extends keyof Events>(event: K, payload: Events[K]): void;
+    has<K extends keyof Events>(event: K): boolean;
     clear(): void;
 }

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 export { Chart, createChart, fallbackResolution } from './chart';
 export { DEFAULT_CHART_SETTINGS, parseChartState } from './settings';
 export type { ChartSettings, ChartState } from './settings';
-export type { ChartEvents, ChartLayout, ChartOptions, ChartPaneLayout, IndicatorLegendItem } from './chart';
+export type { ChartContextMenu, ChartEvents, ChartLayout, ChartOptions, ChartPaneLayout, CompareInfo, IndicatorLegendItem, ReplayStatus } from './chart';
+export type { PriceScaleMode } from './model/price-scale';
 export type { CrosshairInfo, PaneId } from './render/renderer';
 export type { Locale } from './model/time-format';
 export type { IndexRange, TimeScaleOptions } from './model/time-scale';
@@ -12,15 +13,18 @@ export type { FormatPriceOptions } from './price';
 export { decimalsOf, formatCompact, formatPrice, krxTickSize, resolveTickSize, roundToTick } from './price';
 export { isIntradayResolution, resolutionToMs } from './resolution';
 export type { ChartType } from './render/renderer';
-export type { Drawing, DrawingPoint, DrawingType } from './objects/drawings';
-export { FIB_LEVELS } from './objects/drawings';
+export type { BuiltinDrawingType, Drawing, DrawingDefinition, DrawingGeometry, DrawingPoint, DrawingRenderContext, DrawingType, } from './objects/drawings';
+export { BUILTIN_DRAWINGS, distToSegment, FIB_LEVELS } from './objects/drawings';
+export type { PaneCoords } from './objects/types';
+export type { Painter } from './render/painter';
+export type { Palette } from './render/renderer';
 export { snapToOhlc } from './objects/magnet';
-export type { ExecutionGroup, ExecutionMarker, LineHandle, OrderLineOptions, PositionLineOptions } from './objects/trading';
+export type { AlertLineOptions, ExecutionGroup, ExecutionMarker, LineHandle, OrderLineOptions, PositionLineOptions } from './objects/trading';
 export type { Execution, OrderInfo, PositionInfo, TradingAdapter, TradingCallbacks } from './objects/trading-sync';
 export { bucketStart, TickAggregator, timeZoneOffset } from './realtime';
 export type { Tick } from './realtime';
 export { INDICATORS, SERIES_COLORS } from './indicators/definitions';
-export type { IndicatorDefinition, IndicatorOutput, IndicatorParams, IndicatorParamSpec, IndicatorSeries, IndicatorType, } from './indicators/definitions';
+export type { BuiltinIndicatorType, IndicatorDefinition, IndicatorOutput, IndicatorParams, IndicatorParamSpec, IndicatorSeries, IndicatorType, } from './indicators/definitions';
 export type { IndicatorConfig, IndicatorPatch } from './indicators/manager';
 export { maLines, PRICE_SOURCES, priceSource } from './indicators/definitions';
 export type { MaLine, PriceSource, SeriesStyle } from './indicators/definitions';