Documentation / @ripl/charts / ChartBandAnnotation
Interface: ChartBandAnnotation ​
Defined in: charts/src/components/annotation.ts:50
A shaded band spanning a value range on one axis (a threshold/target region).
Properties ​
| Property | Type | Description | Defined in |
|---|---|---|---|
axis | AnnotationAxis | The axis the band's ChartBandAnnotation.from/ChartBandAnnotation.to are measured on. | charts/src/components/annotation.ts:54 |
color? | string | Fill color. Defaults to a neutral annotation color. | charts/src/components/annotation.ts:60 |
from | number | Lower bound of the band, in axis values. | charts/src/components/annotation.ts:56 |
label? | string | Optional label rendered inside the band. | charts/src/components/annotation.ts:62 |
opacity? | number | Fill opacity (0–1). Defaults to 0.12. | charts/src/components/annotation.ts:64 |
to | number | Upper bound of the band, in axis values. | charts/src/components/annotation.ts:58 |
type | "band" | Discriminator selecting a band annotation. | charts/src/components/annotation.ts:52 |