CategoryAxisLabels
The configuration options of the category axis labels.
background? string
The background color of the labels. Accepts a valid CSS color string, including hex and rgb.
border? 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: any) => string
The function which returns the label content.
You can split the text into multiple lines by using the line feed characters ("\n"
).
The available fields in the function argument are:
-
value
—The category value. -
dataItem
—The data item if a field is specified. If the category does not have a corresponding item in the data, an empty object is passed. -
format
—The default format of the label. -
culture
—The default culture (if set) of the label.
culture? string
The culture to use when formatting date values.
The specified culture must be loaded as demonstrated in the Internationalization Overview.
dateFormats? DateFormats
The format for displaying the labels of the date category axis.
The {0}
placeholder represents the category value.
The Chart selects the appropriate format for the current categoryAxis.baseUnit
option.
Setting the categoryAxis.labels.format
option overrides the date formats.
For more information, refer to the format
method of IntlService.
Not supported for Radar Charts. Use
categoryAxis.labels.format
instead.
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? Margin | number
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? Padding | number
The padding of the labels. A numeric value sets all paddings.
position? AxisLabelsPosition
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? LabelRotation | number | "auto"
The rotation angle of the labels. By default, the labels are not rotated.
If the axis is horizontal, can be set to "auto"
.
In this case, the labels are rotated
only if the slot size is not sufficient for the entire labels.
skip? number
The number of labels to skip. By default, no labels are skipped.
step? number
The rendering step of the label—renders every nth label. By default, every label is rendered.
visible? boolean
If set to true
, the Chart displays the category axis labels.
By default, the category axis labels are visible.
visual? (e: AxisLabelVisualArgs) => Element
A function for creating a custom visual for the labels.
The available argument fields are:
-
createVisual
—A function for getting the default visual. -
culture
—The default culture (if set) on the label. -
dataItem
—The data item if a field is specified. -
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.