Skip to content

Interface: OhlcOptions

Defined in: layers/ohlc.ts:13

An OHLC bar chart — the western cousin of the candlestick. Each period is a vertical low→high line with a left tick at the open and a right tick at the close, colored up/down by direction. Streams like CandlestickLayer.

Properties

close

ts
close: ArrayLike<number>;

Defined in: layers/ohlc.ts:19


downColor?

ts
optional downColor?: string | Color;

Defined in: layers/ohlc.ts:25

Close < open color. Default red.


high

ts
high: ArrayLike<number>;

Defined in: layers/ohlc.ts:17


lineWidth?

ts
optional lineWidth?: number;

Defined in: layers/ohlc.ts:27

Line thickness in CSS px. Default 1.5.


low

ts
low: ArrayLike<number>;

Defined in: layers/ohlc.ts:18


name?

ts
optional name?: string;

Defined in: layers/ohlc.ts:30


open

ts
open: ArrayLike<number>;

Defined in: layers/ohlc.ts:16


renderType?

ts
optional renderType?: RenderType;

Defined in: layers/ohlc.ts:29

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


upColor?

ts
optional upColor?: string | Color;

Defined in: layers/ohlc.ts:23

Close ≥ open color. Default green.


width?

ts
optional width?: number;

Defined in: layers/ohlc.ts:21

Total tick span in data units (each open/close tick is half of this). Default 70% of median spacing.


x

ts
x: ArrayLike<number>;

Defined in: layers/ohlc.ts:15

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


yAxis?

ts
optional yAxis?: string;

Defined in: layers/ohlc.ts:31

MIT licensed. WebGL2 required.