IChartBoxPlotProps

interface
Chart

Props for OrigamChartBoxPlot — extends IChartBaseProps with box-plot-specific controls: category order, box width, whisker cap width, outlier visibility, axis/grid visibility, Y-axis range overrides and axis label formatters.

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.

categories
Array<string>
Explicit category order. When absent the order is inferred from the first occurrence of each category in series[0].data.
boxWidth
number
Box width as a fraction of the per-category slot width. Range [0, 1]. Default 0.6.
whiskerCapWidth
number
Whisker cap width as a fraction of the per-category slot width. Range [0, 1]. Default 0.4.
showOutliers
boolean
Render outlier dots beyond the whisker fences. Default true.
showAxis
boolean
Render X and Y axes. Default true.
showGrid
boolean
Render horizontal grid lines. Default true.
yMin
number
Override the auto-computed Y-axis minimum. When absent the component uses min(data) − 10% padding.
yMax
number
Override the auto-computed Y-axis maximum. When absent the component uses max(data) + 10% padding.
xAxisFormat
(value: string | number) => string
Formatter applied to X-axis category labels. Default: identity (category string returned as-is).
yAxisFormat
(value: number) => string
Formatter applied to Y-axis tick values. Default: String(value).

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

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

Box plot with custom box width and Y-axis formatter

vue