@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.
51 lines (50 loc) • 1.86 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 { AxisNoteContentArgs, Border, NoteLabelPosition } from '../../common/property-types';
/**
* The configuration options of the X-axis notes label.
*/
export interface XAxisNotesLabel {
/**
* 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. It defines the axis value.
* You can split the text into multiple lines by using the line feed characters (`"\n"`).
*/
content?: (e: AxisNoteContentArgs) => string;
/**
* The font style of the label.
*/
font?: string;
/**
* The format for displaying the notes label. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
* Contains one placeholder (`"{0}"`) which represents the axis value.
*/
format?: string;
/**
* The position of the labels.
*/
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 X-axis notes label.
* By default, the X-axis notes label is visible.
*/
visible?: boolean;
}