Tooltips

Tooltips appear when a user hovers over a data point. BTA visuals support two tooltip styles — a built-in custom tooltip and the native Power BI tooltip — each with independent styling controls.

Settings

Enabled

Property	Type	Default
`enabled`	boolean	`true`

Toggles tooltips on or off for the visual. When disabled, no tooltip appears on hover.

Style

Property	Type	Default	Options
`style`	TooltipStyle	`"custom"`	`"custom"`, `"powerbi"`

"custom" — Uses the BTA built-in tooltip renderer. All color and styling properties below apply.
"powerbi" — Delegates to the native Power BI tooltip engine. Report-level tooltip pages and custom tooltip configurations are supported. The color properties below are ignored in this mode.

Theme

Property	Type	Default	Options
`theme`	TooltipTheme	`"light"`	`"light"`, `"dark"`

Applies a base color palette to the custom tooltip. When set to "dark", the background defaults to a dark surface and text defaults to white. Individual color overrides (below) take precedence over the theme.

Colors

These properties apply only when style is "custom".

Property	Type	Default	Description
`backgroundColor`	string (hex)	`"#ffffff"`	Tooltip card background color
`borderColor`	string (hex)	`"#e5e7eb"`	Tooltip card border color
`textColor`	string (hex)	`"#111827"`	Primary text color inside the tooltip

Shape & Shadow

Property	Type	Default	Description
`borderRadius`	number	`10`	Corner radius of the tooltip card in pixels
`shadow`	boolean	`true`	Whether to render a drop shadow beneath the tooltip
`maxWidth`	number	`320`	Maximum width of the tooltip card in pixels

Color Swatch

Property	Type	Default	Description
`showColorSwatch`	boolean	`true`	Show a colored square next to each series label in the tooltip

Defaults

enabled:         true
style:           "custom"
theme:           "light"
backgroundColor: "#ffffff"
borderColor:     "#e5e7eb"
textColor:       "#111827"
borderRadius:    10
shadow:          true
maxWidth:        320
showColorSwatch: true

Tips

Use style: "powerbi" when you need report-level tooltip pages (e.g., rich drillthrough tooltips with multiple visuals). The custom tooltip does not support report page tooltips.
Use theme: "dark" on reports with dark backgrounds to avoid a jarring white tooltip on a dark canvas.
Reduce maxWidth (e.g., to 220) when tooltips cover nearby data points in dense charts.
Disable shadow if the visual will be exported to PDF or embedded in a low-fidelity render context where shadow rendering is inconsistent.
Set showColorSwatch: false when the tooltip already includes a color indicator through another mechanism (e.g., a colored series name), to reduce visual noise.

On this page