@progress/kendo-react-charts
Version:
React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package
66 lines (65 loc) • 2.43 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 { drawing } from '@progress/kendo-drawing';
import { Border, Margin } from '../../common/property-types.js';
/**
* @hidden
*/
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 supported values are:
* - `"left"`—The axis title is positioned on the left (applicable to the horizontal axis).
* - `"right"`—The axis title is positioned on the right (applicable to the horizontal axis).
* - `"center"`—The axis title is positioned 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](https://www.telerik.com/kendo-react-ui/components/drawing/api/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;
/** The child components of the pane title */
children?: React.ReactNode;
}