GitHub user jeevallucas created a discussion: Feature Request: Custom Hover
Text / Tooltip Annotation for Charts
### š§© Problem Statement / Motivation
In many visualization tools, one expects the ability to show custom,
user-defined text when hovering over data points (e.g. you hover over a bar,
line point, area, or cell, and see a custom message). Currently, Supersetās
tooltips or hover info are limited to showing predefined metrics, dimensions,
or default metadata. There is no straightforward way to inject arbitrary text
or annotation on hover (e.g. explanatory notes, comments, or context-specific
messages).
This limitation reduces flexibility when users want to provide additional
context, notes, or dynamic messages directly on visualizations without altering
the underlying data.
### Proposed Solution / Feature Description
Introduce a configuration option (per chart, or per visualization plugin) that
allows the dashboard/visualization author to define a custom hover text
template or field. Key aspects:
* A new property (for example: `hover_annotation_template`) in the chartās
configuration panel.
* The template can support placeholders or variables (e.g. `{{ metric_name }}`,
`{{ dimension }}`, `{{ custom_field }}`) so authors can build contextual hover
messages.
* At rendering time, when a user hovers over a chart element, Superset
evaluates the template and displays the resulting text as a tooltip or overlay.
* For charts that support rich rendering (e.g. HTML tooltips, multiline), allow
simple formatting (line breaks, bold, etc.).
* Optionally, allow conditional logic (e.g. only show hover annotation if a
metric exceeds a threshold) ā although this is an enhancement to the base
feature.
This feature would be integrated into chart plugins (in `superset-frontend`)
and propagate through the metadata and tooltip rendering layer.
### š Scope & Non-Goals
**In scope**:
* Simple custom hover text injection with templating.
* Support for existing chart types (bar, line, scatter, area, table, etc.).
* UI to configure the template in chart editor.
* Safe escaping / sanitization to prevent XSS or broken rendering.
**Out of scope** (for a first version):
* Full scripting or complex logic in hover templates (e.g. full JavaScript).
* Cross-chart hover linking (hover in chart A triggers annotation in chart B).
* Very custom tooltip layouts beyond simple text / minor formatting.
* Automatic fallback for charts that donāt support tooltips (those remain
unaffected).
### šÆ Benefits / Use Cases
* Analysts can embed explanatory notes or insights directly into charts,
helping dashboard consumers understand nuances without external documentation.
* Data storytelling: highlight anomalies, warnings, or tips in hover text.
* Interactive dashboards where hovering can reveal extra context or user
instructions.
* Support for multilingual or dynamic commentary without altering the
underlying dataset.
GitHub link: https://github.com/apache/superset/discussions/35319
----
This is an automatically sent email for [email protected].
To unsubscribe, please send an email to:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
