@progress/kendo-react-charts
Version:
React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package
57 lines (56 loc) • 2.14 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 { Padding } from '../common/property-types.js';
import { TooltipBorder } from './tooltip-border.interface.js';
/**
* @hidden
*/
export interface Tooltip {
/**
* The background color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
*/
background?: string;
/**
* The border configuration options.
*/
border?: TooltipBorder;
/**
* The text color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
*/
color?: string;
/**
* The font of the tooltip.
*/
font?: string;
/**
* The format of the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService.
*
* The available format placeholders are:
* - Area, Bar, Column, Funnel, Pyramid, Line, and Pie: {0} - value.
* - Bubble: {0} - x value, {1} - y value, {2} - size value, {3} - category name.
* - Scatter and scatterLine: {0} - x value, {1} - y value.
* - Candlestick and OHLC: {0} - open value, {1} - high value, {2} - low value, {3} - close value, {4} - category name.
*/
format?: string;
/**
* The opacity of the tooltip.
*/
opacity?: number;
/**
* The padding of the tooltip. A numeric value sets all paddings.
*/
padding?: Padding | number;
/**
* If set to `true`, the Chart displays a single tooltip for every category ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/tooltips#toc-shared-tooltip)).
*/
shared?: boolean;
/**
* If set to `true`, the Chart displays the series tooltip. By default, the series tooltip is not displayed.
*/
visible?: boolean;
}