TooltipSettings

23 Sep 20251 minute to read

Sets and gets the options to customize the tooltip of the circular gauge.

Properties

annotationSettings AnnotationTooltipModel

Gets and sets the tooltip settings for the annotation in circular gauge.

border BorderModel

Sets and gets the options to customize the style properties of the border for pointer tooltip.

enable boolean

Enables or disables the visibility of tooltip.

Defaults to false

enableAnimation boolean

Enables and disables the animation of the pointer tooltip in circular gauge.

Defaults to true

fill string

Sets and gets the fill color of the pointer tooltip. This property accepts value in hex code, rgba string as a valid CSS color string.

Defaults to null

format string

Sets and gets the format for the pointer tooltip content in circular gauge. Use ${value} as a placeholder text to display corresponding pointer value.

Defaults to null

rangeSettings RangeTooltipModel

Sets and gets the tooltip settings of the range in circular gauge.

showAtMousePosition boolean

Enables and disables to show the tooltip of the pointer at mouse position. When set as false which is the default value, the tooltip will be displayed over the axis line.

Defaults to false

template string|Function

Sets and gets the custom template to format the tooltip content. Use ${x} and ${y}
as a placeholder text to display the corresponding data point.

Defaults to null

textStyle FontModel

Gets and sets the text style of the pointer tooltip.

type string[]

Sets and gets the elements such as range, annotation and pointer to which the tooltip must be displayed.

Defaults to Pointer