charton

Appearance

charton API

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

Interface: BarBucketOptions ​

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

How time is grouped into bars: the bar interval, the timezone of daily and longer bars, and optional trading hours.

Extended by ​

Properties ​

interval ​

interval: Interval

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

The interval of the bars built.

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.

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.