CategoryAxisRangeLabels

Premium

Updated over 6 months ago

The configuration options of the category axis date range labels.

Name	Type	Default	Description
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 fields available 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. text—The default label text. index—The index of the label. count—The total number of rendered labels.
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?	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.
rotation?	number | "auto" | LabelRotation		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.
visible?	boolean		If set to true, the Chart displays the category axis date range labels. By default, the category axis date range labels are not 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 geometry Rect that defines where the visual has to be rendered. sender—The Chart instance (might be undefined). text—The label text. value—The category value.