Interface ChartState

interface ChartState {
    alerts?: AlertsDocument;
    barSpacing?: number;
    crosshairMode?: "normal" | "magnet";
    crosshairSnapToBar?: boolean;
    drawings?: unknown;
    grid?: { horzLines: boolean; vertLines: boolean };
    indicatorLegendCollapsed?: boolean;
    indicators?: IndicatorState[];
    panes?: PaneState[];
    priceOnlyAutoScale?: boolean;
    primaryPane?: number;
    series?: SeriesState[];
    sourceAbove?: string;
    version: number;
    viewport?: { from: number; to: number };
}

Properties

alerts? barSpacing? crosshairMode? crosshairSnapToBar? drawings? grid? indicatorLegendCollapsed? indicators? panes? priceOnlyAutoScale? primaryPane? series? sourceAbove? version viewport?

Properties

Optionalalerts

alerts?: AlertsDocument

OptionalbarSpacing

barSpacing?: number

OptionalcrosshairMode

crosshairMode?: "normal" | "magnet"

OptionalcrosshairSnapToBar

crosshairSnapToBar?: boolean

Optionaldrawings

drawings?: unknown

Opaque slot the drawing tier fills. The base engine round-trips it untouched, so an app that persists state keeps drawings for free once the tier is loaded.

Optionalgrid

grid?: { horzLines: boolean; vertLines: boolean }

OptionalindicatorLegendCollapsed

indicatorLegendCollapsed?: boolean

Collapse only study legend rows. Omission preserves the current preference.

Optionalindicators

indicators?: IndicatorState[]

Optionalpanes

panes?: PaneState[]

OptionalpriceOnlyAutoScale

priceOnlyAutoScale?: boolean

Only the primary series contributes to its scale's auto-fit. Omission preserves the current preference.

OptionalprimaryPane

primaryPane?: number

Slot in panes of the primary price pane, present only when it is not the first (version 2). Every paneIndex in the state, of a pane, a series, a study or a drawing, is a visual slot counted from the top, so this says which of them is the price pane. Omitted with panes present means slot 0, the only place a price pane could be before it could move. Needs panes, and must name one of them.

Optionalseries

series?: SeriesState[]

Informational: restoreState does not recreate these (it has no data).

OptionalsourceAbove

sourceAbove?: string

Instance id of the study the price source paints directly above, present only when the source was moved over a study on its pane. Omission, as in every layout from before the source could move, paints the source behind the studies. Read with indicators: a restore without them leaves it be.

version

version: number

Optionalviewport

viewport?: { from: number; to: number }

Visible logical range at save time.

Settings

Member Visibility

On This Page

Properties