@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.
59 lines (58 loc) • 2.04 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 { Element } from '@progress/kendo-drawing';
import { Border, Margin, Padding, TitleVisualArgs } from '../../common/property-types';
/**
* Represents the configuration options for the Legend title
* ([see example]({% slug legend_chart_charts %}#toc-setting-a-title)).
*/
export interface LegendTitle {
/**
* Specifies the alignment of the title.
*/
align?: 'center' | 'left' | 'right';
/**
* Specifies the background color of the title. Accepts a valid CSS color string, including hex and rgb.
*/
background?: string;
/**
* Specifies the border of the title.
*/
border?: Border;
/**
* Specifies the text color of the title. Accepts a valid CSS color string, including hex and rgb.
*/
color?: string;
/**
* Specifies the font of the title.
*/
font?: string;
/**
* Specifies the margin of the title. A numeric value sets all margins.
*/
margin?: Margin | number;
/**
* Specifies the padding of the title. A numeric value sets all margins.
*/
padding?: Padding | number;
/**
* Specifies the position of the title.
*/
position?: 'top' | 'bottom';
/**
* Specifies the text of the title.
* You can split the text into multiple lines by using the line feed characters ("\n").
*/
text?: string;
/**
* Determines whether the Chart displays the Legend title.
* When set to `true`, the title is visible. By default, the title is displayed.
*/
visible?: boolean;
/**
* Specifies a function for creating a custom visual for the title.
*/
visual?: (args: TitleVisualArgs) => Element;
}