charton

Appearance

charton API

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

Interface: PriceBarOptions ​

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

How to build price-based bars with priceBars or PriceBarBuilder: the bar type, box size, reversal and line counts, the prices used and the time slot between bars.

Properties ​

lines? ​

optional lines?: number

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

lineBreak only: how many lines a reversal must break. A whole number, at least 1. Default 3.

reversal? ​

optional reversal?: number

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

renko: the move against the trend, in bricks counted from the last brick's close, that draws a reversal brick. A whole number, at least 2. Default 2. pointFigure: the move against the column, in boxes counted from its last box, that starts a new column. A whole number, at least 1. Default 3.

size? ​

optional size?: BoxSize

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

Brick size (renko), bar range (range), the move that turns a kagi line (kagi) or the box size (pointFigure). Default: the 14-bar average true range.

slotSeconds? ​

optional slotSeconds?: number

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

Seconds between the times given to consecutive price bars. Default: the interval of the source bars. See PriceBar.time.

source? ​

optional source?: PriceSource

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

Prices used by renko, kagi and pointFigure (default 'close') and range (default 'highLow'). lineBreak always uses closes.

type ​

type: PriceBarType

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