ChartTooltipProps
Represents the props of the KendoReact ChartTooltip component (see example).
Definition
Package:@progress/kendo-react-charts
Properties
background?
string
The background color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
The border configuration options.
color?
string
The text color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
font?
string
The font of the tooltip.
format?
string
The format of the labels. Uses the 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.
opacity?
number
The opacity of the tooltip.
render?
(props: TooltipContext) => ReactNode | (props: SharedTooltipContext) => ReactNode
A function that can be used to create a custom tooltip template.
When the shared property is set to true, the function accepts a SharedTooltipContext object as an argument.
Otherwise, it accepts a TooltipContext object.
The function should return a React element that represents the custom tooltip content.
shared?
boolean
If set to true, the Chart displays a single tooltip for every category (see example).
visible?
boolean
If set to true, the Chart displays the series tooltip. By default, the series tooltip is not displayed.