API / Configuration / AxisPlotBand
Defined in: src/core/types/chart/axis.ts:434
Extends
Properties
| Property | Type | Description |
|---|---|---|
align? |
PlotBandAlign |
Anchor side on the perpendicular axis when size is set. The start side is the bottom for an X axis, left for a left Y axis, and right for a right Y axis. Has no effect without size. Default 'start' |
color? |
string |
The color of the plot line (hex, rgba). |
custom? |
any |
Custom data associated with the plot line/band, accessible in tooltip renderer args. |
from |
null | string | number |
The start position of the plot band in axis units. Can be a number, a string (e.g., a category), or a timestamp if representing a date. When representing a date, the value must be a timestamp (number of milliseconds since Unix epoch). If the value is -Infinity or null, it will be treated as the start of the axis. |
label? |
object |
- |
label.padding? |
number |
The pixel padding for label. Default 5 |
label.qa? |
string |
Can be used for the UI automated test. It is assigned as a data-qa attribute to an element. |
label.style? |
Partial<BaseTextStyle> |
- |
label.text |
string |
- |
layerPlacement? |
PlotLayerPlacement |
Place the line behind or above the chart. |
opacity? |
number |
Individual opacity for the line. Default 1 |
size? |
string | number |
Perpendicular extent of the band. Accepts a pixel number (40), a pixel string ("40px"), or a percentage of the perpendicular plot extent ("25%"). When omitted, the band spans the full perpendicular extent of the plot area (default behavior). |
to |
null | string | number |
The end position of the plot band in axis units. Can be a number, a string (e.g., a category), or a timestamp if representing a date. When representing a date, the value must be a timestamp (number of milliseconds since Unix epoch). If the value is Infinity or null, it will be treated as the end of the axis. |
Previous
Next