Class: OhlcLayer

Defined in: layers/ohlc.ts:86

A drawable data series backed by GPU buffers.

Implements

• Layer

Constructors

Constructor

new OhlcLayer(gl, opts): OhlcLayer;

Defined in: layers/ohlc.ts:115

Parameters

Parameter	Type
gl	WebGL2RenderingContext
opts	OhlcOptions

Returns

OhlcLayer

Properties

colorCss

readonly colorCss: string;

Defined in: layers/ohlc.ts:89

---

id

readonly id: string;

Defined in: layers/ohlc.ts:87

Implementation of

Layer.id

---

name

readonly name: string;

Defined in: layers/ohlc.ts:88

---

yAxis

readonly yAxis: string;

Defined in: layers/ohlc.ts:90

The y axis this layer is bound to.

Implementation of

Layer.yAxis

Methods

appendCandle()

appendCandle(c): void;

Defined in: layers/ohlc.ts:221

Append one new bar (grows the series).

Parameters

Parameter	Type
c	Candle

Returns

void

---

bounds()

bounds(): 
  | {
  x: Range;
  y: Range;
}
  | null;

Defined in: layers/ohlc.ts:248

Data-space bounds of this layer, for autoscaling. null if empty.

Returns

| { x: Range; y: Range; } | null

Implementation of

Layer.bounds

---

dispose()

dispose(): void;

Defined in: layers/ohlc.ts:265

Returns

void

Implementation of

Layer.dispose

---

draw()

draw(state): void;

Defined in: layers/ohlc.ts:253

Parameters

Parameter	Type
state	DrawState

Returns

void

Implementation of

Layer.draw

---

setData()

setData(data): void;

Defined in: layers/ohlc.ts:214

Replace every bar and re-upload (for streaming a whole new window).

Parameters

Parameter	Type
data	CandlestickData

Returns

void

---

updateLast()

updateLast(c): void;

Defined in: layers/ohlc.ts:229

Update the most recent bar in place — the cheap hot path for a live bar.

Parameters

Parameter	Type
c	Candle

Returns

void