docs: add example of rendering images in tooltips #8048
Merged
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
domoritz
requested changes
Mar 17, 2022
site/docs/tooltip.md
Outdated
| @@ -64,6 +64,14 @@ To avoid that the tooltips groups the data, add an aggregate to the tooltip enco | |||
|
|
|||
| <div class="vl-example" data-name="bar_tooltip_aggregate"></div> | |||
|
|
|||
| ## Tooltip image | |||
|
|
|||
| To display an image in a tooltip, you need to use the special field name `image`, which is an indicator to the Vega Tooltip plugin to render an image instead of displaying text in the tooltip. The image tooltip can be specified either by setting the `tooltip` property of the mark definition (as detailed above) or by passing the field *as an array* to the tooltip encoding channel, as in the example below: | |||
There was a problem hiding this comment.
We need to clarify that this only works with Vega-Tooltip and add a link.
This was referenced Mar 22, 2022
domoritz
approved these changes
Apr 8, 2022
| @@ -0,0 +1 @@ | |||
| <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" class="marks" width="92" height="70" viewBox="0 0 92 70"><rect width="92" height="70" fill="white"/><g fill="none" stroke-miterlimit="10" transform="translate(36,5)"><g class="mark-group role-frame root" role="graphics-object" aria-roledescription="group mark container"><g transform="translate(0,0)"><path class="background" aria-hidden="true" d="M0.5,0.5h20v60h-20Z" stroke="#ddd"/><g><g class="mark-text role-mark marks" role="graphics-object" aria-roledescription="text mark container"><text aria-label="image: data/ffox.png" role="graphics-symbol" aria-roledescription="text mark" text-anchor="middle" transform="translate(10,33)" font-family="sans-serif" font-size="11px" fill="black">data/ffox.png</text><text aria-label="image: data/gimp.png" role="graphics-symbol" aria-roledescription="text mark" text-anchor="middle" transform="translate(10,53)" font-family="sans-serif" font-size="11px" fill="black">data/gimp.png</text><text aria-label="image: data/7zip.png" role="graphics-symbol" aria-roledescription="text mark" text-anchor="middle" transform="translate(10,13)" font-family="sans-serif" font-size="11px" fill="black">data/7zip.png</text></g></g><path class="foreground" aria-hidden="true" d="" display="none"/></g></g></g></svg> | |||
There was a problem hiding this comment.
Yes, it was bothering me too, fixed!
Co-authored-by: Dominik Moritz <domoritz@gmail.com>
|
🚀 PR was released in |
Merged
BradyJ27
pushed a commit
to BradyJ27/vega-lite
that referenced
this pull request
Oct 19, 2023
* docs: add example of rendering images in tooltips * docs: add link to vega-tooltip plugin in the image tooltip section * chore: update TOC [CI] * chore: update examples [CI] * style: auto-formatting [CI] * Improve wording Co-authored-by: Dominik Moritz <domoritz@gmail.com> * Remove stroke outline * chore: update examples [CI] Co-authored-by: GitHub Actions Bot <vega-actions-bot@users.noreply.github.com> Co-authored-by: Dominik Moritz <domoritz@gmail.com>
ChiaLingWeng
added a commit
to ChiaLingWeng/vega-lite
that referenced
this pull request
Nov 13, 2023
This reverts commit a92259e.
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.
I am not sure about whether this is the correct place for this information, but it is very useful with image tooltips and it took me quite some time to figure out how to create them by going through the issues, so I think it would be a valuable addition somewhere in the docs.
Example from this comment: