New to KendoReact? Start a free 30-day trial

ChartYAxisLabelsProps

Represents the props of the KendoReact ChartYAxisLabels component.

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. The function argument contains a value field. It defines the axis value. You can split the text into multiple lines by using the line feed characters ("\n").

The available fields in the function argument are:

  • valueThe category value.
  • formatThe default format of the label.
  • textThe default label text.
  • indexThe index of the label.
  • countThe 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 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?

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.

rotation?

LabelRotation | number | "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 steprenders every nth 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:

  • createVisualA function that can be used to get the default visual.
  • cultureThe default culture (if set) on the label.
  • formatThe default format of the label.
  • optionsThe label options.
  • rectThe geometry Rect that defines where the visual has to be rendered.
  • senderThe Chart instance (might be undefined).
  • textThe label text.
  • valueThe category value.