Skip to main content

RSIConfig

type RSIConfig = {
bandColor?: string | number;
bandsVisible?: boolean;
enabled?: boolean;
extremeFill?: boolean;
lineColor?: string | number;
lineVisible?: boolean;
lineWidth?: number;
lowerBand?: number;
maColor?: string | number;
maPeriod?: number;
maType?: MAKind;
maVisible?: boolean;
maWidth?: number;
period?: number;
upperBand?: number;
};

Source: types/src/index.ts:483

RSI indicator config. Rendered in a pane below the candles when enabled: the RSI line, an optional moving-average trendline over it, and two dashed rules at the overbought and oversold levels.

RSI reads closes only — Wilder's definition is built on close-to-close change — so unlike the moving-average, Bollinger, and MACD configs it takes no MASource.

Properties

bandColor?

optional bandColor?: string | number;

Source: types/src/index.ts:510

Color of both dashed band rules. Default gray.


bandsVisible?

optional bandsVisible?: boolean;

Source: types/src/index.ts:512

Draw the overbought/oversold rules. Default true.


enabled?

optional enabled?: boolean;

Source: types/src/index.ts:485

Draw the pane. Default false.


extremeFill?

optional extremeFill?: boolean;

Source: types/src/index.ts:522

Shade the stretches where the RSI line sits past a band, fading out at the rule and deepening toward the end of the scale, so how far a reading went past the threshold reads at a glance. Default true.

Colored from the theme's accentBull (overbought) and accentBear (oversold), the same pair the volume bars and MACD histogram use. Never reaches full opacity — the line and its rule stay legible through it.


lineColor?

optional lineColor?: string | number;

Source: types/src/index.ts:500

RSI line color (hex string or packed ARGB number). Default violet.


lineVisible?

optional lineVisible?: boolean;

Source: types/src/index.ts:504

Draw the RSI line. Default true.


lineWidth?

optional lineWidth?: number;

Source: types/src/index.ts:502

RSI line stroke width in px. Default 1.5.


lowerBand?

optional lowerBand?: number;

Source: types/src/index.ts:491

Oversold band level (0..100). Default 30.


maColor?

optional maColor?: string | number;

Source: types/src/index.ts:506

Trendline color. Default amber.


maPeriod?

optional maPeriod?: number;

Source: types/src/index.ts:493

Trendline (MA of RSI) length. Default 14, clamped to >= 1.


maType?

optional maType?: MAKind;

Source: types/src/index.ts:495

Averaging used for the trendline (MAKind). Default 'sma'.


maVisible?

optional maVisible?: boolean;

Source: types/src/index.ts:497

Draw the moving-average trendline. Default true.


maWidth?

optional maWidth?: number;

Source: types/src/index.ts:508

Trendline stroke width in px. Default 1.5.


period?

optional period?: number;

Source: types/src/index.ts:487

Lookback period in candle counts. Default 14, clamped to >= 2.


upperBand?

optional upperBand?: number;

Source: types/src/index.ts:489

Overbought band level (0..100). Default 70.