@finchart

Appearance

Documentation / @finchart/indicators / LineBreakBlock

Interface: LineBreakBlock ​

Defined in: indicators/src/line-break.ts:14

Line Break (three-line break by default) — a price-axis transform in the Renko lineage: time is thrown away, a line is drawn each time the close beats the last line's close in the running direction, and the direction reverses only when the close beats the extreme of the last lines lines. A block's x is an ordinal (0, 1, 2…); closedAt is the x of the candle that drew it. Register it as a derivation — see the guide's "Price-axis transforms" — and candleSeries() draws the blocks unchanged.

Extends ​

  • OHLC

Properties ​

close ​

close: number

Defined in: core/dist/data/types.d.mts:36

Inherited from ​

OHLC.close

closedAt ​

closedAt: number

Defined in: indicators/src/line-break.ts:18

The x of the source candle that drew this block. The key the axis format uses to recover time.

high ​

high: number

Defined in: core/dist/data/types.d.mts:34

Inherited from ​

OHLC.high

label? ​

optional label?: string

Defined in: core/dist/data/types.d.mts:17

Inherited from ​

OHLC.label

low ​

low: number

Defined in: core/dist/data/types.d.mts:35

Inherited from ​

OHLC.low

open ​

open: number

Defined in: core/dist/data/types.d.mts:33

Inherited from ​

OHLC.open

tone ​

tone: "up" | "down"

Defined in: indicators/src/line-break.ts:20

Which way the line runs — the up/down slot; candleSeries colours a block by close against open, which agrees with it.

volume? ​

optional volume?: number | null

Defined in: core/dist/data/types.d.mts:46

Optional, and — unlike the four prices — null is a gap, not a rejection. A bar without volume is still a bar (a feed's JSON says "volume": null on a halted day and the candle still draws), where a bar without a close is nothing to draw. What is rejected: a string, a NaN, an infinity — the data gate checks volume for finiteness the same way it checks the prices. Consumers of volume (aggregation, the indicators) read a gap through isGap.

Inherited from ​

OHLC.volume

x ​

x: number

Defined in: indicators/src/line-break.ts:16

The block's ordinal — this is the chart's x.

Overrides ​

OHLC.x