@progress/kendo-react-charts
Version:
React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package
89 lines (88 loc) • 3.86 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
import { drawing } from '@progress/kendo-drawing';
import { AxisLabelVisualArgs, Border, LabelRotation, Margin, Padding } from '../../common/property-types.js';
/**
* @hidden
*/
export interface ValueAxisLabels {
/**
* The background color of the labels. Accepts a valid CSS color string, including hex and rgb.
*/
background?: string;
/**
* The border of the labels.
*/
border?: Border;
/**
* The text color of the labels. Accepts a valid CSS color string, including hex and rgb.
*/
color?: 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.
*/
content?: (e: any) => string;
/**
* The font style of the labels.
*/
font?: string;
/**
* The format for displaying the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the category value.
*/
format?: string;
/**
* The margin of the labels. A numeric value sets all margins.
*/
margin?: Margin | number;
/**
* 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.
*/
mirror?: boolean;
/**
* The padding of the labels. A numeric value sets all margins.
*/
padding?: Padding | number;
/**
* 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.
*/
rotation?: LabelRotation | number | 'auto';
/**
* The number of labels to skip. By default, no labels are skipped.
*/
skip?: number;
/**
* The label rendering step.
* Every n<sup>th</sup> label is rendered where `n` is the step.
*/
step?: number;
/**
* If set to `true`, the Chart displays the value axis labels. By default, the category axis labels are visible.
*/
visible?: boolean;
/**
* 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`](https://www.telerik.com/kendo-react-ui/components/drawing/api/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.
*/
visual?: (e: AxisLabelVisualArgs) => drawing.Element;
}