charton

Appearance

charton API

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

Interface: FootprintBuilderOptions ​

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

Options for createFootprintBuilder: the bar interval and the row grouping.

Extends ​

Properties ​

interval ​

interval: Interval

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

The interval of the bars built.

Inherited from ​

BarBucketOptions.interval

rowSize ​

rowSize: number

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

Row height in price units, usually the tick size or a multiple of it.

session? ​

optional session?: SessionSchedule

Defined in: packages/core/src/data/aggregate.ts:36

Trading hours, in timezone. Intraday bars then start at each session range's open (a 1h bar of a 09:30 open runs 09:30 to 10:30), daily and longer bars group by trading day (an overnight session's evening belongs to the next day), and anything outside the session is dropped.

Inherited from ​

BarBucketOptions.session

timezone? ​

optional timezone?: string

Defined in: packages/core/src/data/aggregate.ts:29

IANA timezone that daily and longer bars follow (usually the symbol's timezone); UTC when unset or unknown.

Inherited from ​

BarBucketOptions.timezone