StockTooltipSettings

23 Sep 20251 minute to read

Properties

border BorderModel

Options to customize tooltip borders.

duration number

Duration for the ToolTip animation.

Defaults to 300

enable boolean

Enables / Disables the visibility of the tooltip.

Defaults to false.

enableAnimation boolean

If set to true, ToolTip will animate while moving from one point to another.

Defaults to true.

enableMarker boolean

Enables / Disables the visibility of the marker.

Defaults to true.

enableTextWrap boolean

To wrap the tooltip long text based on available space.
This is only application for chart tooltip.

Defaults to false

fadeOutDuration number

Fade Out duration for the ToolTip hide.

Defaults to 1000

fadeOutMode FadeOutMode

Fade Out duration for the Tooltip hide.

Defaults to Move

fill string

The fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.

Defaults to null

format string

Format the ToolTip content.

Defaults to null.

Header for tooltip. By default, the shared tooltip displays the point x value and the series name for each individual tooltip.

Defaults to null

opacity number

The fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.

Defaults to 0.75

position TooltipPosition

Specifies the tooltip position. They are:

  • fixed - Place the tooltip in the fixed position.
  • nearest- Tooltip moves along with the mouse.

Defaults to ‘Fixed’

shared boolean

If set to true, a single ToolTip will be displayed for every index.

Defaults to false.

showHeaderLine boolean

Specifies whether to display the header line in the tooltip.

Defaults to true

showNearestPoint boolean

By default, the nearest points will be included in the shared tooltip; however, you can set it to false to exclude the nearest value from the tooltip.

Defaults to true

showNearestTooltip boolean

Enables or disables the display of tooltips for the nearest data point to the cursor.

Defaults to false.

template string|Function

Custom template to format the ToolTip content. Use ${x} and ${y} as the placeholder text to display the corresponding data point.

Defaults to null.

textStyle FontModel

Options to customize the ToolTip text.