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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- indexrequirednumber
- Index in the data array.
- datumrequiredIChartCandlestickDatum
- The raw OHLC datum.
- cxrequirednumber
- Center X of the slot.
- bodyXrequirednumber
- Body left X.
- bodyYrequirednumber
- Body top Y (min of yOpen, yClose).
- bodyWidthrequirednumber
- Body width in SVG-px.
- bodyHeightrequirednumber
- Body height in SVG-px.
- wickToprequirednumber
- Wick top Y (yHigh).
- wickBottomrequirednumber
- Wick bottom Y (yLow).
- colorrequiredstring
- Resolved CSS colour string for the candle.
- isBullishrequiredboolean
- true when close >= open.
- changerequirednumber
- Pre-computed change (close - open).
- changePctrequirednumber
- 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