IChartCandlestickProps
interface
Chart
Props for <OrigamChartCandlestick> — the financial OHLC chart. Renders one candlestick per datum with a body between open/close and a wick from low to high. Extends IChartBaseProps (omitting categories).
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- heightnumber | string400
- Chart height. Accepts a number (interpreted as px) or any valid CSS length. Ignored when aspectRatio is set.
- bullishColorTIntent | string'success'
- Fill colour for bullish candles (close >= open). Default 'success'.
- bearishColorTIntent | string'danger'
- Fill colour for bearish candles (close < open). Default 'danger'.
- candleWidthnumber0.6
- Fraction of the per-slot width occupied by the candle body [0..1]. Default 0.6.
- wickWidthnumber1
- Wick stroke width in SVG user-units. Default 1.
- showLegendbooleanfalse
- Toggle the legend. Candlestick charts rarely need a legend — default is false.
- showTooltipbooleantrue
- Toggle the hover tooltip. Default true.
- showGridbooleantrue
- Render background grid lines. Default true.
- showAxisbooleantrue
- Render X / Y axes + tick labels. Default true.
- yMinnumber
- Override the auto-computed Y axis minimum. When omitted derived from min(low) with 5% padding.
- yMaxnumber
- Override the auto-computed Y axis maximum. When omitted derived from max(high) with 5% padding.
- xAxisFormat(value: string | number) => string
- Formatter applied to X-axis (date) tick labels.
- yAxisFormat(value: number) => string
- Formatter applied to Y-axis (price) tick labels.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Basic OHLC candlestick chart setup