Skip to content

charton API


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

Interface: ActivityBarOptions ​

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

Activity bars: a new bar every ticks trades or every volume units traded, whatever the time. Give exactly one of the two.

Properties ​

minGap? ​

optional minGap?: number

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

Smallest step, in seconds, between the times of consecutive bars. A bar's time is its first trade's time, moved forward by this much past the previous bar when trades come faster than bars can have distinct times. Default 0.001.


ticks? ​

optional ticks?: number

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

Trades per bar: a whole number, at least 1.


volume? ​

optional volume?: number

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

Volume per bar: a positive number. A trade larger than the room left in a bar is split across bars.