@rekurt/openkline - v0.2.0
    Preparing search index...

    Interface FullState

    Full chart snapshot — includes the candle data window. Use for workspace persistence, bug reproduction, or any case where the receiver should not re-fetch data through a transport. Typically 100 KB – 1 MB depending on buffer length.

    interface FullState {
        alerts?: Alert[];
        chartType: ChartType | string & {};
        data: Candle[];
        drawings: DrawingSnapshot[];
        indicators: IndicatorConfig[];
        resolution: string;
        symbol: string;
        theme: ThemeMode | ThemeColors;
        version: 1;
        viewport: {
            autoFollow: boolean;
            candleWidth: number;
            priceScaleMode?: PriceScaleMode;
            startIndex: number;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    alerts? chartType data drawings indicators resolution symbol theme version viewport

    Properties

    alerts?: Alert[]

    Price alerts (C3). Optional + additive: Alert is already a flat, JSON-safe shape so it persists as-is. States written before C3 omit the field and load back with no alerts — no schema bump or migration needed. A fired one-shot alert serializes with active: false, so it restores disarmed (it won't immediately re-fire on the next tick).

    chartType: ChartType | string & {}

    Built-in type, or a host-registered custom series type.

    data: Candle[]
    drawings: DrawingSnapshot[]
    indicators: IndicatorConfig[]
    resolution: string
    symbol: string
    theme: ThemeMode | ThemeColors
    version: 1
    viewport: {
        autoFollow: boolean;
        candleWidth: number;
        priceScaleMode?: PriceScaleMode;
        startIndex: number;
    }

    Type Declaration

    • autoFollow: boolean
    • candleWidth: number
    • OptionalpriceScaleMode?: PriceScaleMode

      Price-axis scale mode. Optional + additive: states written before F1 omit it and load back as 'linear', so no schema bump needed.

    • startIndex: number

    Settings

    Member Visibility

    On This Page

    Properties