AxisDefaultsLabelsComponent

The configuration of the axis labels (see example).

Selector

kendo-chart-axis-defaults-labels

Inputs

content

(e: any) => string

The function which returns the label content. The text can be split into multiple lines by using the line feed characters ("\n").

The available fields in the function argument are:

  • valueThe category value.
  • dataItemThe data item if a field is specified. If the category does not have a corresponding item in the data, an empty object is passed.
  • formatThe default format of the label.
  • cultureThe default culture (if set) of the label.

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. 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 label-rendering steprenders every nth label. By default, every label is rendered.

visible

boolean

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

visual

(e: AxisLabelVisualArgs) => Element

A function that for creating a custom visual for the labels.

The available argument fields are:

  • createVisualA function for getting the default visual.
  • cultureThe default culture (if set) of the label.
  • dataItemThe data item if a field has been specified.
  • formatThe default format of the label.
  • optionsThe label options.
  • rectThe geometry Rect that defines where the visual has to be rendered.
  • senderThe Chart instance (can be undefined).
  • textThe label text.
  • valueThe category value.

Methods

notifyChanges

Updates the component fields with the specified values and refreshes the Chart.

Use this method when the configuration values cannot be set through the template.

item.notifyChanges({ visible: true });

Parameters

changes

any

An object containing the updated input fields.