Skip to content

Documentation / @finchart/indicators / PointAndFigureColumn

Interface: PointAndFigureColumn ​

Defined in: indicators/src/point-and-figure.ts:18

Point & Figure — a price-axis transform in the Renko lineage: time is thrown away and price is quantised onto an absolute grid of boxes, boxSize apart and aligned to its multiples. A column of X's rises (tone: "up"), a column of O's falls (tone: "down"); a column's x is an ordinal (0, 1, 2…), the last column is live and grows with the close until a reversal starts the next one. A column is OHLC-shaped — its low/high are the prices of its lowest and highest box, open/close the end it started from and the end it reached — so candleSeries() draws it as a bar (a series drawing the X and O glyphs is the natural next step); boxes is how many it holds. Register it as a derivation — see the guide's "Price-axis transforms".

Extends ​

  • OHLC

Properties ​

boxes ​

boxes: number

Defined in: indicators/src/point-and-figure.ts:26

How many boxes the column holds.


close ​

close: number

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

Inherited from ​

OHLC.close


closedAt ​

closedAt: number

Defined in: indicators/src/point-and-figure.ts:22

The x of the source candle whose close last extended the column. 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/point-and-figure.ts:24

up is a column of X's, down a column of O's — the slot a two-colour series reads.


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/point-and-figure.ts:20

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

Overrides ​

OHLC.x