@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.21 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 { drawing } from '@progress/kendo-drawing';
import { Border, Margin } from '../../common/property-types';
/**
* The `panes.title` options.
*/
export interface PanesTitle {
/**
* 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 style of the title.
*/
font?: string;
/**
* The margin of the title. A numeric value sets all margins.
*/
margin?: Margin | number;
/**
* The position of the title.
*
* The positioning of the axis title can be set to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
*/
position?: 'left' | 'right' | 'center';
/**
* The text of the title.
* You can split the text into multiple lines by using line feed characters (`"\n"`).
*/
text?: string;
/**
* If set to `true`, the Chart displays the pane title. By default, the pane title is visible.
*/
visible?: boolean;
/**
* A function that can be used to create a custom visual for the title.
*
* The available argument fields are:
*
* - `text`—The label text.
* - `rect`—The [geometry Rect]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
* - `sender`—The Chart instance (might be `undefined`).
* - `options`—The label options.
* - `createVisual`—A function that can be used to get the default visual.
*/
visual?: (e: any) => drawing.Element;
}