IChartPlotBand

interface
Chart

A coloured rectangular zone drawn behind (or above) chart data, spanning a numeric range along either the X or Y axis. Applicable to cartesian-family charts only — not for polar, radar or gauge.

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

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.

axis
'x' | 'y'
Axis the band spans. "y" shades a horizontal stripe; "x" shades a vertical stripe. Default "y".
from
requis
number | string
Lower bound in axis units. String when axis="x" and categories are strings.
to
requis
number | string
Upper bound in axis units.
color
TIntent | string
Fill colour. Accepts a TIntent token name or any CSS colour string. Default resolves to the warning intent bg token.
opacity
number
Fill opacity in the 0..1 range. Default 0.15.
label
string
Optional label rendered centred inside the band.
labelColor
TIntent | string
Label fill colour. Accepts a TIntent token or CSS colour. Default "currentColor".
layer
'below' | 'above'
Z-order relative to chart data. "below" (default) — drawn behind series; "above" — drawn on top of data.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

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

Highlighting a warning zone with a plot band

vue