charton

Appearance

charton API

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

Interface: LinkGroup ​

Defined in: packages/core/src/link-group.ts:44

Charts kept in step with each other. Create one with createLinkGroup.

Properties ​

charts ​

readonly charts: readonly Chart[]

Defined in: packages/core/src/link-group.ts:46

The charts in the group, in the order they joined.

options ​

readonly options: Readonly<LinkGroupOptions>

Defined in: packages/core/src/link-group.ts:47

Methods ​

add() ​

add(chart): void

Defined in: packages/core/src/link-group.ts:53

Add a chart. It takes the linked state of the group's first chart: its visible range, symbol, interval and timezone, as far as they are linked. A destroyed chart leaves the group by itself.

Parameters ​

chart ​

Chart

Returns ​

void

applyOptions() ​

applyOptions(options): void

Defined in: packages/core/src/link-group.ts:57

Change what is linked. Switching a link on brings every chart to the first chart's state.

Parameters ​

options ​

Partial<LinkGroupOptions>

Returns ​

void

destroy() ​

destroy(): void

Defined in: packages/core/src/link-group.ts:59

Take every chart out of the group. The group cannot be used afterwards.

Returns ​

void

remove() ​

remove(chart): void

Defined in: packages/core/src/link-group.ts:55

Take a chart out of the group; it keeps what it shows.

Parameters ​

chart ​

Chart

Returns ​

void