PlotBandLabel
Specifies the appearance configuration for the plot band label.
Definition
Package:@progress/kendo-angular-charts
Properties
align?
"left" | "right" | "center"
Specifies 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
Specifies the background color of the label. Accepts a valid CSS color string, including hex and rgb.
color?
string
Specifies the color of the plot band label text.
Accepts a valid CSS color
configuration string, including hex and rgb.
font?
string
Specifies the font of the plot band label text.
Accepts a valid CSS font
configuration string.
position?
"top" | "bottom" | "center"
Specifies 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
Specifies the rotation angle of the label. By default, the label is not rotated.
text?
string
Specifies the text of the label.
You can split the text into multiple lines by using line feed characters ("\n").
visible?
boolean
Determines whether to display the plot band label. By default, the plot band labels are not displayed.
Specifies 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 geometryRectthat 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.