Skip to content

charton API


charton API / @chart-on/core / index / LayoutSerializeOptions

Interface: LayoutSerializeOptions ​

Defined in: packages/core/src/layout.ts:100

Options for serializeLayout: whether to include drawings and the visible range, and metadata to save.

Properties ​

drawings? ​

optional drawings?: boolean

Defined in: packages/core/src/layout.ts:102

Include the drawings. Default true; turn off when the app stores drawings elsewhere (e.g. per symbol).


meta? ​

optional meta?: LayoutMeta

Defined in: packages/core/src/layout.ts:106

Metadata to save, e.g. { name, createdAt }. updatedAt defaults to now.


visibleRange? ​

optional visibleRange?: boolean

Defined in: packages/core/src/layout.ts:104

Include the visible time range. Default false.