StockTooltipSettingsModel

23 Sep 20251 minute to read

Interface for a class StockTooltipSettings

Properties

border BorderModel

Options to customize tooltip borders.

duration number

Duration for the ToolTip animation.

enable boolean

Enables / Disables the visibility of the tooltip.

enableAnimation boolean

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

enableMarker boolean

Enables / Disables the visibility of the marker.

enableTextWrap boolean

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

fadeOutDuration number

Fade Out duration for the ToolTip hide.

fadeOutMode FadeOutMode

Fade Out duration for the Tooltip hide.

fill string

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

format string

Format the ToolTip content.

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

opacity number

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

position TooltipPosition

Specifies the tooltip position. They are:

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

shared boolean

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

showHeaderLine boolean

Specifies whether to display the header line in the tooltip.

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.

showNearestTooltip boolean

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

template string|Function

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

textStyle FontModel

Options to customize the ToolTip text.