charton

Appearance

charton API

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

Interface: PriceBar ​

Defined in: packages/core/src/price-bars.ts:82

A bar built by priceBars or PriceBarBuilder: an ordinary bar on an evenly spaced time slot, plus the source bar times it spans. Renko, line break and range bars are drawn as candles. A kagi bar is one vertical stretch of the kagi line, from open (where the line turned) to close (how far it ran). A point & figure bar is one column: rising columns are X boxes from open up to close, falling ones O boxes from open down to close, each price the middle of a box.

Extends ​

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.

Inherited from ​

Bar.borderColor

boxSize? ​

optional boxSize?: number

Defined in: packages/core/src/price-bars.ts:98

pointFigure only: the box size the column was built with. The 'pointFigure' candle style reads it, so the boxes match the builder.

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.

Inherited from ​

Bar.buyVolume

close ​

close: number

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

Inherited from ​

Bar.close

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.

Inherited from ​

Bar.color

endTime ​

endTime: number

Defined in: packages/core/src/price-bars.ts:93

Time of the source bar that completed the price bar, or of the newest source bar while it is still forming.

high ​

high: number

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

Inherited from ​

Bar.high

low ​

low: number

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

Inherited from ​

Bar.low

open ​

open: number

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

Inherited from ​

Bar.open

startTime ​

startTime: number

Defined in: packages/core/src/price-bars.ts:91

Time of the source bar the price bar starts in (where the previous one ended; the first source bar for the first one).

time ​

time: number

Defined in: packages/core/src/price-bars.ts:89

A slot on an evenly spaced time axis: the first source bar's time plus slotSeconds per price bar. Price bars have no time of their own, and several can form within one source bar, so this only orders them. The time they cover is startTime to endTime.

Overrides ​

Bar.time

volume? ​

optional volume?: number

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

Inherited from ​

Bar.volume

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.

Inherited from ​

Bar.wickColor