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

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

height
number | string
400
Chart height. Accepts a number (interpreted as px) or any valid CSS length. Ignored when aspectRatio is set.
bullishColor
TIntent | string
'success'
Fill colour for bullish candles (close >= open). Default 'success'.
bearishColor
TIntent | string
'danger'
Fill colour for bearish candles (close < open). Default 'danger'.
candleWidth
number
0.6
Fraction of the per-slot width occupied by the candle body [0..1]. Default 0.6.
wickWidth
number
1
Wick stroke width in SVG user-units. Default 1.
showLegend
boolean
false
Toggle the legend. Candlestick charts rarely need a legend — default is false.
showTooltip
boolean
true
Toggle the hover tooltip. Default true.
showGrid
boolean
true
Render background grid lines. Default true.
showAxis
boolean
true
Render X / Y axes + tick labels. Default true.
yMin
number
Override the auto-computed Y axis minimum. When omitted derived from min(low) with 5% padding.
yMax
number
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.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Basic OHLC candlestick chart setup

vue