@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.
56 lines (55 loc) • 2.08 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 { Border, Padding } from '../../common/property-types';
/**
* Represents the series tooltip options.
*/
export interface SeriesTooltip {
/**
* Sets the background color of the tooltip.
* Accepts a valid CSS color string, including HEX and RGB.
*/
background?: string;
/**
* Configures the border options.
*/
border?: Border;
/**
* Sets the text color of the tooltip.
* Accepts a valid CSS color string, including HEX and RGB.
*/
color?: string;
/**
* Sets the font of the tooltip.
*/
font?: string;
/**
* Sets the format of the labels.
* Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
*
* Use different value placeholders depending on the Chart type.
*
* The Area, Bar, Column, Funnel, Pyramid, Line, and Pie Charts use `{0}` as the value placeholder.
*
* The Bubble Chart uses `{0}` for x value, `{1}` for y value, `{2}` for size value, and `{3}` for category name.
*
* The Scatter and ScatterLine Charts use `{0}` for x value and `{1}` for y value.
*
* The Candlestick and OHLC Charts use `{0}` for open value, `{1}` for high value, `{2}` for low value, `{3}` for close value, and `{4}` for category name.
*
* The RangeArea, RangeBar, and RangeColumn Charts use `{0}` for from value and `{1}` for to value.
*/
format?: string;
/**
* Sets the padding of the tooltip.
* A numeric value sets all paddings.
*/
padding?: Padding | number;
/**
* Determines if the Chart displays the series tooltip.
* By default, the series tooltip is not displayed.
*/
visible?: boolean;
}