charton

Appearance

charton API

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

Interface: FootprintBuilder ​

Defined in: packages/core/src/profile/footprint.ts:50

Builds live footprint bars from a trade stream; see createFootprintBuilder.

Properties ​

bar ​

readonly bar: FootprintBar | null

Defined in: packages/core/src/profile/footprint.ts:58

The bar being built (a copy), or null before the first trade.

Methods ​

push() ​

push(trade): FootprintBar | null

Defined in: packages/core/src/profile/footprint.ts:56

Add a trade. Returns the bar it changed (a copy), or null when the trade is dropped: outside the session, older than the bar being built, or with an invalid time, price or size.

Parameters ​

trade ​

TradeTick

Returns ​

FootprintBar | null

reset() ​

reset(): void

Defined in: packages/core/src/profile/footprint.ts:60

Forget the bar being built, e.g. after a reconnect.

Returns ​

void