@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.
62 lines (61 loc) • 2.23 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 { Border, Margin, Padding } from '../common/property-types';
/**
* Specifies the configuration options of the subtitle
* ([see example]({% slug api_charts_subtitlecomponent %})).
*/
export interface Subtitle {
/**
* Specifies the alignment of the subtitle.
*
* By default, the subtitle has the same alignment as the title.
*
* Use `center` for middle alignment, `left` for left alignment, and `right` for right alignment.
*/
align?: 'center' | 'left' | 'right';
/**
* Specifies the background color of the subtitle. Accepts a valid CSS color string, including HEX and RGB.
*/
background?: string;
/**
* Specifies the border of the subtitle.
*/
border?: Border;
/**
* Specifies the text color of the subtitle. Accepts a valid CSS color string, including HEX and RGB.
*/
color?: string;
/**
* Specifies the font of the subtitle.
*/
font?: string;
/**
* Specifies the margin of the subtitle. A numeric value sets all margins.
*/
margin?: Margin | number;
/**
* Specifies the padding of the subtitle. A numeric value sets all paddings.
*/
padding?: Padding | number;
/**
* Specifies the position of the subtitle.
*
* By default, the subtitle is placed in the same position as the title.
*
* Use `bottom` to place the subtitle at the bottom or `top` to place it at the top.
*/
position?: 'top' | 'bottom';
/**
* Specifies the text of the chart subtitle. You can also set the text directly for a title with default options.
*
* Use line feed characters ("\n") to split the text into multiple lines.
*/
text?: string;
/**
* Determines whether the Chart displays the subtitle. By default, the subtitle is displayed.
*/
visible?: boolean;
}