Skip to main content

types.RuntimeCandleSeries#

Describes an overlay candle series in RuntimeOutput.candleSeries.

SYNTAX#

interface RuntimeCandleSeries { kind: 'candle'; name: string; ohlc: ({ o: number; h: number; l: number; c: number } | null)[]; bullishColor: string; bearishColor: string; wickColor: string; }

ARGUMENTS#

  • kind ('candle') — Discriminator.
  • name (string) — Series identifier.
  • ohlc ((PlotCandleOhlc | null)[]) — Per-bar OHLC tuples; null for skipped bars.
  • bullishColor (string) — Body color when c >= o.
  • bearishColor (string) — Body color when c < o.
  • wickColor (string) — Wick color.

RETURNS#

Type definition.

EXAMPLE#

{ kind: 'candle', name: 'ha', ohlc: [...], bullishColor: '#26a69a', bearishColor: '#ef5350', wickColor: '#888' }

SEE ALSO#

types.RuntimeOutput, indicator.plot.candle