YAxisLabelsComponent
The axis labels configuration.
Selector
kendo-chart-y-axis-item-labels
Inputs
background
string
The background color of the labels. Accepts a valid CSS color string, including hex and rgb.
border
The border of the labels.
color
string
The text color of the labels. Accepts a valid CSS color string, including hex and rgb.
content
(e: AxisLabelContentArgs) => string
The function which returns the label content.
You can split the text into multiple lines by using the line feed characters ("\n"
).
culture
string
The culture to use when formatting date values. The specified culture must be loaded as demonstrated in the Internationalization Overview.
dateFormats
The format for displaying the labels when the X values are dates. Uses the format
method of IntlService.
Contains one placeholder ("{0}"
) which represents the category value.
The Chart selects the appropriate format for the current yAxis.baseUnit
. Setting the
categoryAxis.labels.format
option overrides the date formats.
font
string
The font style of the labels.
format
string
The format for displaying the labels. Uses the format
method of IntlService.
Contains one placeholder ("{0}"
) which represents the category value.
margin
number | Margin
The margin of the labels. A numeric value sets all margins.
mirror
boolean
If set to true
, the Chart mirrors the axis labels and ticks. If the labels are normally on the
left side of the axis, the mirroring of the axis renders them to the right.
padding
number | Padding
The padding of the labels. A numeric value sets all paddings.
position
The position of the axis labels. By default, labels are positioned next to the axis.
- When
position
is set toend
, the labels are placed at the end of the crossing axis— typically, at the top or right end of the Chart unless the crossing axis was reversed. - When
position
is set tostart
, the labels are placed at the start of the crossing axis— typically, at the left or bottom end of the Chart unless the crossing axis was reversed.
rotation
number | LabelRotation | "auto"
The rotation angle of the labels. By default, the labels are not rotated.
skip
number
The number of labels to skip.
step
number
The label rendering step—renders every n
th label. By default, every label is rendered.
visible
boolean
If set to true
, the Chart displays the Y-axis labels. By default, the Y-axis labels are visible.
visual
(e: AxisLabelVisualArgs) => Element
A function that can be used to create a custom visual for the labels.
The available argument fields are:
createVisual
—A function that can be used to get the default visual.culture
—The default culture (if set) on the label.format
—The default format of the label.options
—The label options.rect
—The geometryRect
that defines where the visual has to be rendered.sender
—The Chart instance (might beundefined
).text
—The label text.value
—The category value.
Methods
notifyChanges
Updates the component fields with the specified values and refreshes the Chart.
Use this method when the configuration values cannot be set through the template.
item.notifyChanges({ visible: true });
Parameters
changes
any
An object containing the updated input fields.