feat(tooltip): pass datum to customHTML callback function #1879
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- updated handler for tooltip show event to extract the datum from the event details and pass it as an argument to the customHTML callback function if one was specific within the chart options Close carbon-design-system#1518 Signed-off-by: Steven Massola <steven.massola@ibm.com>
✅ Deploy Preview for carbon-charts-react ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for carbon-charts-angular ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for carbon-charts-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for carbon-charts-core ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
theiliad
approved these changes
Aug 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates
Close #1518
Details
The raw data point/points provided to the chart is not what gets propagated to the tooltip's customHTML callback function.
This PR tries to address that issue by providing the "datum" associated with the hovered element as an argument to the
customHTMLcallback, however, this solution still does not propagate the raw data point/points passed to the chart as certain charts will modify the datum with extraneous properties.This solution was chosen due to its unobtrusiveness rather than its preciseness. Ideally, the raw data would be passed as an argument to the
customHTMLcallback but it was unclear how to accomplish this without the solution getting more involved.Other issues
#774
#1426