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
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- axis'x' | 'y'
- Axis the band spans. "y" shades a horizontal stripe; "x" shades a vertical stripe. Default "y".
- fromrequirednumber | string
- Lower bound in axis units. String when axis="x" and categories are strings.
- torequirednumber | string
- Upper bound in axis units.
- colorTIntent | string
- Fill colour. Accepts a TIntent token name or any CSS colour string. Default resolves to the warning intent bg token.
- opacitynumber
- Fill opacity in the 0..1 range. Default 0.15.
- labelstring
- Optional label rendered centred inside the band.
- labelColorTIntent | 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.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Highlighting a warning zone with a plot band