Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that a special field name is required to render images in tooltips #2570

Merged
merged 1 commit into from Oct 29, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions altair/examples/image_tooltip.py
Expand Up @@ -3,7 +3,9 @@
-------------
This example shows how to render images in tooltips.
Either URLs or local file paths can be used to reference
the images.
the images. To render the image, you must use the special
column name "image" in your data and pass it as a list to
the tooltip encoding.
"""
# category: other charts

Expand All @@ -17,5 +19,5 @@
alt.Chart(source).mark_circle(size=200).encode(
x='a',
y='b',
tooltip=['image'] # Must be a list for the image to render
tooltip=['image'] # Must be a list containing a field called "image"
)