Skip to content
EliteChart

ChartLayout

Documentation


Documentation / @elitechart/core / ChartLayout

Defined in: layout/layout-types.ts:143

The full chart-layout envelope. JSON-safe; stringify-able directly. Produced by chart.serializeLayout(), consumed by chart.loadLayout(...).

Example

code
const layout: ChartLayout = chart.serializeLayout({ user: 'sam' });
localStorage.setItem('layout', JSON.stringify(layout));
// ...later:
const restored: ChartLayout = JSON.parse(localStorage.getItem('layout')!);
chart.loadLayout(restored, drawingRegistry);

Properties

alerts

code
readonly alerts: readonly SerializedAlert[];

Defined in: layout/layout-types.ts:150


compareSeries?

code
readonly optional compareSeries?: readonly SerializedCompareSeries[];

Defined in: layout/layout-types.ts:152

v2+ — compare-series overlays. v1 layouts omit this; loader treats as empty.


corporateEvents?

code
readonly optional corporateEvents?: readonly SerializedCorporateEvent[];

Defined in: layout/layout-types.ts:154

v2+ — corporate event markers.


drawings

code
readonly drawings: readonly SerializedDrawingEntry[];

Defined in: layout/layout-types.ts:149


kind

code
readonly kind: SeriesKind;

Defined in: layout/layout-types.ts:145


magnet?

code
readonly optional magnet?: "off" | "weak" | "strong";

Defined in: layout/layout-types.ts:158

v2+ — magnet mode (crosshair snap-to-OHLC).


meta?

code
readonly optional meta?: Readonly<Record<string, unknown>>;

Defined in: layout/layout-types.ts:165

Free-form consumer payload — datafeed auth state, watchlist index, etc. The chart ignores this field but preserves it on round-trip.


persistentTool?

code
readonly optional persistentTool?: boolean;

Defined in: layout/layout-types.ts:160

v2+ — persistentTool option.


replay?

code
readonly optional replay?: SerializedReplayState;

Defined in: layout/layout-types.ts:156

v2+ — bar-replay state.


symbol

code
readonly symbol: LayoutSymbol;

Defined in: layout/layout-types.ts:147


themeName?

code
readonly optional themeName?: string;

Defined in: layout/layout-types.ts:146


version

code
readonly version: 1 | 2;

Defined in: layout/layout-types.ts:144


viewport

code
readonly viewport: LayoutViewport;

Defined in: layout/layout-types.ts:148