@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.
57 lines (56 loc) • 2.28 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 { Padding } from '../common/property-types';
import { TooltipBorder } from './tooltip-border.interface';
/**
* Specifies the configuration options of the tooltip.
*/
export interface Tooltip {
/**
* Specifies the background color of the tooltip. Accepts a valid CSS color string, including HEX and RGB.
*/
background?: string;
/**
* Specifies the border configuration options.
*/
border?: TooltipBorder;
/**
* Specifies the text color of the tooltip. Accepts a valid CSS color string, including HEX and RGB.
*/
color?: string;
/**
* Specifies the font of the tooltip.
*/
font?: string;
/**
* Specifies the format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
*
* The Area, Bar, Column, Funnel, Pyramid, Line, and Pie are represented by `{0}` as the value placeholder.
*
* The Bubble chart type uses the following value placeholders: `{0}` - x value, `{1}` - y value, `{2}` - size value, and `{3}` - category name.
*
* The Scatter and ScatterLine chart types use the following value placeholders: `{0}` - x value and `{1}` - y value.
*
* The Candlestick and OHLC chart types use the following value placeholders: `{0}` - open value, `{1}` - high value, `{2}` - low value, `{3}` - close value, and `{4}` - category name.
*/
format?: string;
/**
* Specifies the opacity of the tooltip.
*/
opacity?: number;
/**
* Specifies the padding of the tooltip. A numeric value sets all paddings.
*/
padding?: Padding | number;
/**
* Determines whether the Chart displays a single tooltip for every category.
*/
shared?: boolean;
/**
* Determines whether the Chart displays the series tooltip.
* By default, the series tooltip is not displayed.
*/
visible?: boolean;
}