@progress/kendo-angular-charts
Version:
Kendo UI Charts for Angular - A comprehensive package for creating beautiful and interactive data visualization. Every chart type, stock charts, and sparklines are included.
70 lines (69 loc) • 3.14 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { drawing } from '@progress/kendo-drawing';
import { Border, Margin, Padding, SeriesLabelsContentArgs, SeriesLabelsVisualArgs } from '../../common/property-types';
import { SeriesDefaultsLabelsFrom } from './labels.from.interface';
import { SeriesDefaultsLabelsTo } from './labels.to.interface';
/**
* Represents the configuration options of the series labels.
*/
export interface SeriesDefaultsLabels {
/**
* Specifies the background color of the labels. Accepts a valid CSS color string, including HEX and RGB.
*/
background?: string;
/**
* Specifies the border of the labels.
*/
border?: Border;
/**
* Specifies the text color of the labels. Accepts a valid CSS color string, including HEX and RGB.
*/
color?: string;
/**
* Specifies the function which returns the Chart series labels content.
* You can split the text into multiple lines by using line feed characters (`"\n"`).
*/
content?: (e: SeriesLabelsContentArgs) => string;
/**
* Specifies the font style of the labels.
*/
font?: string;
/**
* Specifies the format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
*/
format?: string;
/**
* Specifies the margin of the labels. A numeric value sets all margins.
*/
margin?: Margin | number;
/**
* Specifies the padding of the labels. A numeric value sets all margins.
*/
padding?: Padding | number;
/**
* Specifies the rotation angle of the labels. By default, the labels are not rotated.
*/
rotation?: number;
/**
* Determines whether the Chart displays the series labels.
* When set to `true`, the labels are visible. By default, the Chart series labels are not displayed.
*/
visible?: boolean;
/**
* Specifies a function that can be used to create a custom visual for the labels.
*/
visual?: (e: SeriesLabelsVisualArgs) => drawing.Element;
/**
* Specifies the Chart series `from` label configuration.
* Displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_seriesdefaultslabels %}#toc-visible) or the [`seriesDefaults.labels.from.visible`]({% slug api_charts_seriesdefaultslabelsfrom %}#toc-visible) option is set to `true`.
*/
from?: SeriesDefaultsLabelsFrom;
/**
* Specifies the Chart series `to` label configuration.
* Displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_seriesdefaultslabels %}#toc-visible) or the [`seriesDefaults.labels.to.visible`]({% slug api_charts_seriesdefaultslabelsto %}#toc-visible) option is set to `true`.
*/
to?: SeriesDefaultsLabelsTo;
}