@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.
64 lines (63 loc) • 2.82 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2024 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../common/property-types';
/**
* The configuration options of the series `to` labels.
*/
export interface SeriesLabelsTo {
/**
* The background color of the `to` labels. Accepts a valid CSS color string, including HEW 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"`).
*/
content?: (e: SeriesLabelsContentArgs) => string;
/**
* The font style of the `to` labels.
*/
font?: string;
/**
* The format of the `to` labels. Uses [IntlService format]({% slug api_intl_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;
}