charton

Appearance

charton API

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

Interface: DataTarget ​

Defined in: packages/core/src/data/controller.ts:17

Where loaded bars go (the chart's main candle series). Must copy what it keeps.

Methods ​

dropped()? ​

optional dropped(bar, reason): void

Defined in: packages/core/src/data/controller.ts:27

A bar from the source was left out: invalid, older than the last bar, or a duplicate time.

Parameters ​

bar ​

Bar

reason ​

DropReason

Returns ​

void

lookback()? ​

optional lookback(): number

Defined in: packages/core/src/data/controller.ts:21

Extra bars to load first, so indicator warm-up (their lookback) stays off screen.

Returns ​

number

prepend()? ​

optional prepend(older, bars): void

Defined in: packages/core/src/data/controller.ts:32

A page of history: older bars, all before the first bar passed so far, now lead bars. Without it the page arrives as setData(bars, 'history').

Parameters ​

older ​

Bar[]

bars ​

Bar[]

Returns ​

void

setAdjustments()? ​

optional setAdjustments(adjustments): void

Defined in: packages/core/src/data/controller.ts:25

The corporate actions known for the bars setData is about to pass (see DataSource.adjustments).

Parameters ​

adjustments ​

readonly Adjustment[]

Returns ​

void

setData() ​

setData(bars, kind): void

Defined in: packages/core/src/data/controller.ts:18

Parameters ​

bars ​

Bar[]

kind ​

DataLoadKind

Returns ​

void

setPriceFormat() ​

setPriceFormat(format): void

Defined in: packages/core/src/data/controller.ts:23

The symbol's price format (symbolPriceFormat), or undefined to detect decimals from the data.

Parameters ​

format ​

PriceFormat | undefined

Returns ​

void

update() ​

update(bar): void

Defined in: packages/core/src/data/controller.ts:19

Parameters ​

bar ​

Bar

Returns ​

void