TooltipSettingsModel API in JavaScript Stock Chart API control

Interface for a class TooltipSettings

Properties

border

BorderModel

Options for customizing the tooltip borders, including the color and width of the tooltip’s border.

duration

number

Duration of the tooltip animation, specified in milliseconds.

enable

boolean

If set to true, enables tooltips for the data points.

enableAnimation

boolean

If set to true, the tooltip will animate as it moves from one point to another.

enableMarker

boolean

If set to true, enables the marker in the chart tooltip.

enableTextWrap

boolean

Wraps the tooltip’s long text based on the available space.

Note that this feature applies only to chart tooltips.

fadeOutDuration

number

Duration of the fade-out animation for hiding the tooltip, in milliseconds.

fadeOutMode

FadeOutMode

Specifies the mode for the fade-out animation when hiding the tooltip.

fill

string

The fill color of the tooltip, specified as a valid CSS color string in hex or rgba format.

format

string

Specifies the format for customizing the content of the tooltip.

header

string

Customizes the header text for the tooltip. By default, this property displays the series name.

location

LocationModel

Specifies the location of the tooltip relative to the chart. If x is 20, the tooltip moves 20 pixels to the right of the chart.

<div id='Chart'></div>

let chart: Chart = new Chart({
...
tooltip: {
       enable: true,
       location: { x: 100, y: 150 }
 }
...
});
chart.appendTo('#Chart');

opacity

number

The opacity of the tooltip, expressed as a numerical value.

shared

boolean

If set to true, a single tooltip will be displayed for each index.

showNearestPoint

boolean

Specifies whether the nearest points should be included in the shared tooltip. By default, the nearest data points are displayed. Set this property to false to exclude the nearest point.

template

string | Function

A custom template used to format the tooltip content. Use ${x} and ${y} as placeholders for the corresponding data points.

textStyle

FontModel

This property defines the font family, size, style, weight, and color for the tooltip text.