Documentation / @finchart/indicators / KagiPoint

Interface: KagiPoint

Defined in: indicators/src/kagi.ts:20

Kagi — a price-axis transform in the Renko lineage: time is thrown away and a single line follows the close, turning only when the close backs off its extreme by reversal. A point's x is an ordinal (0, 1, 2…), one per vertex; the last point is the line's live end and moves with the close until a reversal fixes it. tone is the yang/yin of the segment that ends at the point (up = yang, drawn thick; down = yin, thin) and breakY, when present, is the price inside that segment where the tone changed — a rising segment turns yang the moment it rises above the previous shoulder, a falling one turns yin the moment it falls below the previous waist (the shoulder or waist already standing when the segment began — Nison's rules 10 and 11); a segment is monotone, so that happens at most once. Register it as a derivation — see the guide's "Price-axis transforms".

Properties

breakY?

optional breakY?: number

Defined in: indicators/src/kagi.ts:36

The price inside the segment ending here at which the tone changed — the shoulder or waist it crossed. Absent when it did not.

---

closedAt

closedAt: number

Defined in: indicators/src/kagi.ts:26

The x of the source candle whose close set y. The key the axis format uses to recover time.

---

tone

tone: "up" | "down"

Defined in: indicators/src/kagi.ts:34

The tone of the segment ending here — up is yang (thick), down is yin (thin). Tone is not direction: a falling segment that has not yet dropped below the previous waist stays yang, a rising one short of the previous shoulder stays yin. The first point carries the first segment's tone, which is that segment's direction.

---

x

x: number

Defined in: indicators/src/kagi.ts:22

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

---

y

y: number

Defined in: indicators/src/kagi.ts:24

The price at the vertex (or, for the last point, the line's current end).