@progress/kendo-react-charts
Version:
React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package
54 lines (53 loc) • 2 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 { Border, NoteLabelPosition } from '../../common/property-types.js';
/**
* @hidden
*/
export interface SeriesNotesLabel {
/**
* The background color of the label. Accepts a valid CSS color string, including hex and rgb.
*/
background?: string;
/**
* The border of the label.
*/
border?: Border;
/**
* The text color of the label. 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 which defines the point value. You can split the text into multiple lines by using line feed characters (`"\n"`).
*/
content?: (e: any) => string;
/**
* The font style of the label.
*/
font?: string;
/**
* The format for displaying the notes label. 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 axis value.
*/
format?: string;
/**
* The position of the labels.
*
* The available options are:
* - `"inside"`—The label is positioned inside the icon.
* - `"outside"`—The label is positioned outside the icon.
*/
position?: NoteLabelPosition;
/**
* The rotation angle of the label. By default, the label is not rotated.
*/
rotation?: number;
/**
* If set to `true`, the Chart displays the series notes label. By default, the series notes label is visible.
*/
visible?: boolean;
}