IChartCandlestickCandle

interface
Chart

Resolved per-candle descriptor produced by the geometry engine inside OrigamChartCandlestick. All numeric fields are expressed in SVG user-units; pre-computes change and direction so the template renders without arithmetic.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

index
required
number
Index in the data array.
datum
required
IChartCandlestickDatum
The raw OHLC datum.
cx
required
number
Center X of the slot.
bodyX
required
number
Body left X.
bodyY
required
number
Body top Y (min of yOpen, yClose).
bodyWidth
required
number
Body width in SVG-px.
bodyHeight
required
number
Body height in SVG-px.
wickTop
required
number
Wick top Y (yHigh).
wickBottom
required
number
Wick bottom Y (yLow).
color
required
string
Resolved CSS colour string for the candle.
isBullish
required
boolean
true when close >= open.
change
required
number
Pre-computed change (close - open).
changePct
required
number
Pre-computed percentage change.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Reading candle data in a custom tooltip slot

vue