Types
Interfaces and type aliases exported by @reincharts/indicators.
import type { AnyMovingAverageOptions, AroonResult, ATROptions, ... } from "@reincharts/indicators";AnyMovingAverageOptions
Prop
Type
AroonResult
Prop
Type
ATROptions
Prop
Type
Bands
Upper / middle / lower band values.
Prop
Type
BollingerOptions
Prop
Type
BoxSize
Box / reversal size: a fixed price amount or "atr" (ATR at the last bar).
type BoxSize = number | "atr";CCIOptions
Prop
Type
ChangeOverOptions
Prop
Type
ChangeResult
Prop
Type
CompareOptions
Prop
Type
DMIOptions
Prop
Type
DMIResult
Prop
Type
DonchianOptions
Prop
Type
ElderImpulseOptions
Prop
Type
ElderRayOptions
Prop
Type
ElderRayResult
Prop
Type
EnvelopeOptions
Prop
Type
HeikinAshiBar
A source bar with its OHLC replaced by Heikin Ashi values (every other field, e.g. date / volume, is kept).
type HeikinAshiBar<T> = Omit<T, "open" | "high" | "low" | "close"> & {
open: number;
high: number;
low: number;
close: number;
};IchimokuOptions
Prop
Type
IchimokuResult
Ichimoku values computed at each bar, NOT shifted. To plot the cloud, draw spanA / spanB
displacement - 1 bars to the right (plotOffset) and lagging displacement - 1 bars to the left.
Prop
Type
IndicatorColorContext
Extra context passed to IndicatorOutput.colorFn.
Prop
Type
IndicatorComponentProps
Props shared by the convenience indicator components (everything of <Indicator> except definition / inputs).
Prop
Type
IndicatorDefinition
Everything needed to compute, draw, name and configure an indicator.
Prop
Type
IndicatorFill
A filled area between two outputs (by key) or an output and a constant / two constants.
Prop
Type
IndicatorInput
One user-editable setting of an indicator (rendered by settings dialogs).
Prop
Type
IndicatorLevel
A horizontal reference line, e.g. RSI 30 / 70.
Prop
Type
IndicatorOutput
One plotted output of an indicator.
Prop
Type
IndicatorOutputStyle
Style overrides for one output.
Prop
Type
KagiLine
A kagi line segment between two reversals.
Prop
Type
KagiOptions
Prop
Type
KeltnerOptions
Prop
Type
LineBreakBar
A line break bar (draw like a candle body from open to close).
Prop
Type
LineBreakOptions
Prop
Type
LookbackOptions
Prop
Type
MACDOptions
Prop
Type
MACDResult
Prop
Type
MAInputs
Inputs of the moving average definitions.
Prop
Type
MFIOptions
Prop
Type
MovingAverageOptions
Prop
Type
MovingAverageType
Moving average types accepted by the maType option of calculators.
type MovingAverageType = "sma" | "ema" | "wma" | "rma" | "hma" | "tma";OHLCVOptions
Field accessors for calculators that read several bar fields (ATR, Stochastic, VWAP...).
Prop
Type
PointAndFigureBox
One box of a column.
Prop
Type
PointAndFigureColumn
A column of X (direction 1) or O (direction −1) boxes.
Prop
Type
PointAndFigureOptions
Prop
Type
PriceSource
Built-in price sources. hl2 = (H+L)/2, hlc3 = (H+L+C)/3, ohlc4, hlcc4 = (H+L+2C)/4.
type PriceSource = "open" | "high" | "low" | "close" | "hl2" | "hlc3" | "ohlc4" | "hlcc4" | "volume";RenkoBrick
A renko brick. Use as chart data: x = date, candle = open/high/low/close.
Prop
Type
RenkoOptions
Prop
Type
RSIOptions
Prop
Type
SAROptions
Prop
Type
SmoothedForceIndexOptions
Prop
Type
Source
What a calculator reads: a built-in price source, a field name or a function of the datum.
type Source<T = any> = PriceSource | Accessor<T, number | undefined>;SourceOptions
Prop
Type
StdDevOptions
Prop
Type
StochasticOptions
Prop
Type
StochasticResult
Prop
Type
SupertrendOptions
Prop
Type
SupertrendResult
Prop
Type
TransformOptions
Options shared by the bar transforms (renko, kagi, point & figure, line break).
Values
Values aligned 1:1 with the input data; undefined during warm-up or where inputs are missing.
Prop
Type
VolumeOptions
Prop
Type
VolumeResult
Prop
Type
VWAPAnchor
When a VWAP period starts: every day ("session"), week (Monday), month, year, never, or a custom predicate.
type VWAPAnchor =
"session" | "week" | "month" | "year" | "none" | ((d: any, index: number, prev: any) => boolean);VWAPOptions
Prop
Type
VWAPResult
Prop
Type
VWMAOptions
Prop
Type