• What is KendoReact
  • Getting Started
  • Server Components
  • Components
    • Animation
    • Barcodes
    • Buttons
    • Chartsupdated
    • Common Utilities
    • Conversational UIupdated
    • Data Gridupdated
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdownsupdated
    • Editor
    • Excel Export
    • File Saver
    • Formupdated
    • Ganttupdated
    • Gauges
    • Indicators
    • Inputsupdated
    • Labels
    • Layoutupdated
    • ListBox
    • ListView
    • Map
    • Notification
    • OrgChartnew
    • PDF Processing
    • PDFViewer
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • ScrollView
    • Sortable
    • Spreadsheetupdated
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeViewupdated
    • Upload
  • Sample Applications
  • Styling & Themes
  • Common Features
  • Project Setup
  • Knowledge Base
  • Changelog
  • Updates
  • Troubleshooting

ChartYAxisLabelsProps

Represents the props of the KendoReact ChartYAxisLabels component.

NameTypeDefaultDescription

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:

  • value—The category value.
  • format—The default format 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 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.

rotation?

number | "auto" | LabelRotation

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 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:

  • 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 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.