• 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

ChartValueAxisLabelsProps

Represents the props of the KendoReact ChartValueAxisLabels component (see example).

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

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

rotation?

number | "auto" | LabelRotation

The rotation angle (in degrees) of the labels. By default, the labels are not rotated. Angles increase clockwise and zero is to the left. Negative values are acceptable. Can be set to "auto" if the axis is horizontal. In this case, the labels will be 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 label rendering step. Every nth label is rendered where n is the step.

visible?

boolean

If set to true, the Chart displays the value axis labels. By default, the category axis labels are visible.

visual?

(e: AxisLabelVisualArgs) => Element

A function for creating custom visuals 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.
  • 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.