Interface WidgetState

What getState returns and restoreState takes. JSON-safe.

interface WidgetState {
    chart: ChartState & ChartSettingsState & { timezone: string };
    chartType: string;
    exchange: string;
    interval: string;
    panels?: PanelDockState;
    rail: null | RailPrefs;
    savedBy?: string;
    symbol: string;
    theme: WidgetThemeName;
    variant?: DataVariant;
    version: 1;
}

Properties

chart chartType exchange interval panels? rail savedBy? symbol theme variant? version

Properties

chart

chart: ChartState & ChartSettingsState & { timezone: string }

chartType

chartType: string

exchange

exchange: string

interval

interval: string

Optionalpanels

panels?: PanelDockState

Optional in older records. Width is bounded when restored.

rail

rail: null | RailPrefs

OptionalsavedBy

savedBy?: string

The library version that wrote the state (since 2.6.3). Absent in older records, which wrote every navigation option whether chosen or not.

symbol

symbol: string

theme

theme: WidgetThemeName

Optionalvariant

variant?: DataVariant

The data variant, absent for the feed's default. Optional in older records.

version

version: 1

Settings

Member Visibility

On This Page

Properties