@progress/kendo-react-charts
Version:
React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package
73 lines (72 loc) • 3.6 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, Margin, Padding } from '../../common/property-types.js';
/**
* @hidden
*/
export interface SeriesLabelsTo {
/**
* The background color of the `to` labels. Accepts a valid CSS color string, including hex and rgb.
*/
background?: string;
/**
* The border of the `to` labels.
*/
border?: Border;
/**
* The text color of the `to` labels. Accepts a valid CSS color string, including hex and rgb.
*/
color?: string;
/**
* The function which returns the Chart series `to` label content. You can split the text into multiple lines by using line feed characters (`"\n"`).
*
* The fields available in the function argument are:
* - `category`—The category name. Available for the Area, Bar, Column, Bubble, Donut, Line, Pie, and Waterfall series.
* - `dataItem`—The original data item used to construct the point. If binding to an array, it will be `null`.
* - `percentage`—The point value represented as a percentage value. Available only for the Donut, Pie, and 100% stacked charts.
* - `series`—The data series.
* - `value`—The point value. Can be a number or object containing each bound field.
* - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
* - `total`—The sum of all previous series values. Available for the Waterfall series.
*/
content?: (e: any) => string;
/**
* The font style of the `to` labels.
*/
font?: string;
/**
* The format of the `to` labels. Uses [IntlService format](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format).
*/
format?: string;
/**
* The margin of the `to` labels. A numeric value sets all margins.
*/
margin?: Margin | number;
/**
* The padding of the `to` labels. A numeric value sets all paddings.
*/
padding?: Padding | number;
/**
* The position of the `to` labels.
*
* The available options are:
* - `"center"`—The label is positioned at the point center.
* - `"insideBase"`—The label is positioned inside, near the base of the bar.
* - `"insideEnd"`—The label is positioned inside, near the end of the point.
* - `"outsideEnd"`—The label is positioned outside, near the end of the point.
* - `"above"`—The label is positioned at the top of the marker. Applicable for the RangeArea and VerticalRangeArea series.
* - `"below"`—The label is positioned at the bottom of the marker. Applicable for the RangeArea and VerticalRangeArea series.
* - `"left"`—The label is positioned to the left of the marker. Applicable for the RangeArea and VerticalRangeArea series.
* - `"right"`—The label is positioned to the right of the marker. Applicable for the RangeArea and VerticalRangeArea series.
*/
position?: 'center' | 'insideBase' | 'insideEnd' | 'outsideEnd';
/**
* If set to `true`, the Chart displays the series `to` labels. By default, the Chart series `to` labels are not displayed.
*/
visible?: boolean;
}