PlotBandLabel
The appearance configuration for the plot band label.
align?
"left" | "right" | "center"
The horizontal alignment of the label text.
By default, the label is aligned to the left.
The supported values are:
"center"
—The label is positioned in the center of the plot band."right"
—The label is positioned on the right side of the plot band."left"
—The label is positioned on the left side of the plot band.
background?
string
The background color of the label. Accepts a valid CSS color string, including hex and rgb.
border?
The border of the label.
color?
string
The color of the plot band label text.
Accepts a valid CSS color
configuration string, including hex and rgb.
font?
string
The font of the plot band label text.
Accepts a valid CSS font
configuration string.
margin?
number | Margin
The margin of the label. A numeric value sets all margins.
padding?
number | Padding
The padding of the label. A numeric value sets all paddings.
position?
"top" | "bottom" | "center"
The vertical position of the label inside the plot band.
By default, the label is aligned to the top.
The supported values are:
"bottom"
—The label is positioned on the bottom of the plot band."center"
—The label is positioned in the center of the plot band."top"
—The label is positioned on the top of the plot band.
rotation?
number
The rotation angle of the label. By default, the label is not rotated.
text?
string
The text of the label.
The text can be split into multiple lines by using line feed characters ("\n").
visible?
boolean
If set to false
, the will not display the plot band label.
By default, the plot band labels are not displayed.
visual?
(e: PlotBandLabelVisualArgs) => Element
A function that can be used to create a custom visual for the label.
The available argument fields are:
text
—The label text.rect
—The geometryRect
that defines where the visual has to be rendered.options
—The label options.createVisual
—A function that can be used to get the default visual.sender
—A reference to the Chart instance.