Skip to content

charton API


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

Interface: Bar ​

Defined in: packages/core/src/types.ts:5

One OHLC bar at time, with optional volume and per-bar colours.

Extended by ​

Properties ​

borderColor? ​

optional borderColor?: string

Defined in: packages/core/src/types.ts:25

This bar's body outline colour in candle styles that draw bodies (not the bar styles), while borders is on.


buyVolume? ​

optional buyVolume?: number

Defined in: packages/core/src/types.ts:16

Part of volume from buy-side (aggressor) trades, when the data reports it. The rest of volume counts as sell-side. Used by volume profiles.


close ​

close: number

Defined in: packages/core/src/types.ts:10


color? ​

optional color?: string

Defined in: packages/core/src/types.ts:21

This bar's body colour in candle styles (the bar and tick lines of bar styles), over the series' up and down colours. Line and area styles ignore it.


high ​

high: number

Defined in: packages/core/src/types.ts:8


low ​

low: number

Defined in: packages/core/src/types.ts:9


open ​

open: number

Defined in: packages/core/src/types.ts:7


time ​

time: number

Defined in: packages/core/src/types.ts:6


volume? ​

optional volume?: number

Defined in: packages/core/src/types.ts:11


wickColor? ​

optional wickColor?: string

Defined in: packages/core/src/types.ts:23

This bar's wick colour in candle styles that draw wicks (not the bar styles), while wicks is on.