Skip to content
EliteChart

KagiOptions

Documentation

Documentation / @elitechart/core / KagiOptions

Defined in: series/kagi.ts:83

Kagi configuration. Pass to chart.setKagiOptions(...) or to computeKagi directly. reversalPrice takes precedence over reversalPercent when both are set.

Example

code
const pct: KagiOptions = { reversalPercent: 4 }; // 4% — industry-canonical default
const fixed: KagiOptions = { reversalPrice: 5 }; // $5 reversal

Properties

reversalPercent?

code
readonly optional reversalPercent?: number;

Defined in: series/kagi.ts:89

Reversal threshold as a plain percent of the latest extreme (e.g. 4 = 4%). Industry-canonical default. Mutually exclusive with reversalPrice. Range (0, 100].

reversalPrice?

code
readonly optional reversalPrice?: number;

Defined in: series/kagi.ts:95

Reversal threshold as a fixed price-unit delta (e.g. 5 = $5). Useful when the price magnitude is small or constant (FX). Takes precedence over reversalPercent when both are set.