ICustomTooltipConfig

ICustomTooltipConfig.contentpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Markdown content for the custom tooltip section.

content?: string;

Remarks

Supports a subset of Markdown:

• Headings: # through #### - Bold (**text**), italic (*text*) - Unordered lists (- item) and ordered lists (1. item) — not nested - Images (![alt](url)) — https:, http:, and data:image/... URLs only - Links ([text](url)) — http(s) URLs only; rendered as anchors opening in a new tab. End-users can only reach them when the tooltip stays open long enough to interact with (accessible/sticky Highcharts tooltips, geo popups). - Horizontal rules (---) - Backslash escapes (\*, \_, [, \!, etc.) to render a metacharacter as literal text instead of formatting

Not supported: tables, code blocks, blockquotes, nested lists, raw HTML.

Also accepts metric/attribute references ({metric/id}, {label/id}, {computed_attribute/id}) that resolve dynamically per hovered data point. Resolved values are automatically backslash-escaped, so data containing markdown metacharacters renders as literal text — no manual escaping is required.

Use display-form identifiers (NOT parent attribute identifiers) inside {label/id}; a computed attribute has no labels and is named by its own identifier inside {computed_attribute/id}. An attribute id renders correctly for attributes that are already in the chart, but it cannot be fetched as a label for external attributes — and a single such ref causes the secondary tooltip fetch to fail backend-side, dropping every other external ref alongside it.

ICustomTooltipConfig.enabledpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Whether the custom tooltip is enabled.

enabled?: boolean;

ICustomTooltipConfig.placementpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Where to place the custom section relative to the default tooltip content.

placement?: CustomTooltipPlacement;

Default Value

“above”