Interface ChartSettingsState

The settings slice of a saved chart state. It is declared here rather than on ChartState so this module owns its own persistence: chart.getState() returns a ChartState & ChartSettingsState, which is still a ChartState to every existing consumer, and restoreState reads it back.

events stays in the saved state although the dialog no longer offers the switches: the chart still owns setEventOptions, a host that feeds its own corporate actions still sets them, and dropping the field would throw that host's saved layout away.

interface ChartSettingsState {
    axisChrome?: Pick<AxisChromeOptions, "sessionClock" | "barCountdown">;
    canvas?: CanvasOptions;
    events?: ChartEventOptions;
    navigation?: Partial<ChartNavigationOptions>;
    statusLine?: LegendStatusLineOptions;
    trading?: TradingSettings;
    watermark?: ChartWatermarkOptions;
}

Properties

axisChrome? canvas? events? navigation? statusLine? trading? watermark?

Properties

OptionalaxisChrome

axisChrome?: Pick<AxisChromeOptions, "sessionClock" | "barCountdown">

The axis-strip switches. Only the switches: AxisChromeOptions.clock is a callback, which no JSON survives, and a host that supplied one supplies it again when it builds the chart.

Optionalcanvas

canvas?: CanvasOptions

Optionalevents

events?: ChartEventOptions

Optionalnavigation

navigation?: Partial<ChartNavigationOptions>

OptionalstatusLine

statusLine?: LegendStatusLineOptions

Optionaltrading

trading?: TradingSettings

Optionalwatermark

watermark?: ChartWatermarkOptions

Settings

Member Visibility

On This Page

Properties