Skip to content

charton API


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

Interface: TpoSessionOptions ​

Defined in: packages/core/src/profile/tpo.ts:23

Options for computeTpoProfiles: row options plus how bars group into sessions.

Extends ​

Properties ​

interval? ​

optional interval?: Interval

Defined in: packages/core/src/profile/tpo.ts:25

Length of one profile. Default '1d': one per trading day of session.


rowSize ​

rowSize: number

Defined in: packages/core/src/profile/tpo.ts:17

Row height in price units, usually a multiple of the tick size. Scaled up when the range would need more than MAX_PROFILE_ROWS rows.

Inherited from ​

TpoOptions.rowSize


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 ​

FootprintBuilderOptions.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 ​

FootprintBuilderOptions.timezone


valueArea? ​

optional valueArea?: number

Defined in: packages/core/src/profile/tpo.ts:19

Share of all TPOs inside the value area, in percent. Default 70.

Inherited from ​

TpoOptions.valueArea