@progress/kendo-react-charts
Version:
React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package
69 lines (68 loc) • 2.19 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
import { Element } from '@progress/kendo-drawing';
import { Border, Margin, Padding, TitleVisualArgs } from '../../common/property-types.js';
/**
* @hidden
*/
export interface LegendTitle {
/**
* The alignment of the title.
*
* The available options are:
* - `"center"`—The text is aligned to the middle.
* - `"left"`—The text is aligned to the left.
* - `"right"`—The text is aligned to the right.
*/
align?: 'center' | 'left' | 'right';
/**
* The background color of the title. Accepts a valid CSS color string, including hex and rgb.
*/
background?: string;
/**
* The border of the title.
*/
border?: Border;
/**
* The text color of the title. Accepts a valid CSS color string, including hex and rgb.
*/
color?: string;
/**
* The font of the title.
*/
font?: string;
/**
* The margin of the title. A numeric value sets all margins.
*/
margin?: Margin | number;
/**
* The padding of the title. A numeric value sets all margins.
*/
padding?: Padding | number;
/**
* The position of the title.
*
* The available options are:
* - `"bottom"`—The title is positioned beneath the legend.
* - `"top"`—The title is positioned above the legend.
*/
position?: 'top' | 'bottom';
/**
* The text of the title.
* You can split the text into multiple lines by using the line feed characters ("\n").
*/
text?: string;
/**
* If set to `true`, the Chart displays the Legend title. By default, the title is displayed.
*/
visible?: boolean;
/**
* A function for creating a custom visual for the title.
*/
visual?: (args: TitleVisualArgs) => Element;
}