Skip to content

Interface: CandlestickOptions

Defined in: layers/candlestick.ts:7

Properties

close

ts
close: ArrayLike<number>;

Defined in: layers/candlestick.ts:13


downColor?

ts
optional downColor?: string | Color;

Defined in: layers/candlestick.ts:19

Close < open color. Default red.


high

ts
high: ArrayLike<number>;

Defined in: layers/candlestick.ts:11


low

ts
low: ArrayLike<number>;

Defined in: layers/candlestick.ts:12


name?

ts
optional name?: string;

Defined in: layers/candlestick.ts:24


open

ts
open: ArrayLike<number>;

Defined in: layers/candlestick.ts:10


renderType?

ts
optional renderType?: RenderType;

Defined in: layers/candlestick.ts:23

Buffer-usage hint; set "dynamic" when streaming via setData. Default "static".


upColor?

ts
optional upColor?: string | Color;

Defined in: layers/candlestick.ts:17

Close ≥ open color. Default green.


wickWidth?

ts
optional wickWidth?: number;

Defined in: layers/candlestick.ts:21

Wick thickness in CSS px. Default 1.5.


width?

ts
optional width?: number;

Defined in: layers/candlestick.ts:15

Body width in data units. Defaults to 70% of the median spacing.


x

ts
x: ArrayLike<number>;

Defined in: layers/candlestick.ts:9

Candle positions (data space — e.g. epoch ms on a time axis).


yAxis?

ts
optional yAxis?: string;

Defined in: layers/candlestick.ts:25

MIT licensed. WebGL2 required.