docs(explore): document show_download param for standalone chart embeds - #43906
docs(explore): document show_download param for standalone chart embeds#43906rusackas wants to merge 1 commit into
Conversation
PR #42238 added a show_download URL param for standalone Explore chart permalinks but didn't document it. Add a section to the embedding guide covering standalone chart URLs and the new param. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Code Review Agent Run #999258Actionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help AI Code Review powered by |
github-actions
Bot
added
doc
✅ Deploy Preview for superset-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| | `standalone` | `0`, `1` | `0`: normal Explore view; `1`: hide the Explore header and controls | | ||
| | `show_download` | `0`, `1` | Show a compact download control (CSV, JSON, Excel) on the standalone chart | | ||
|
|
||
| `show_download` is opt-in and has no effect outside of `standalone=1`. The download control still respects the viewer's `can_download` permission — it's hidden for users who lack it even when the parameter is set. |
There was a problem hiding this comment.
can_download is internal Explore state, not a grantable permission: it is derived from can_export_data with granular export controls or can_csv otherwise. An administrator who looks for can_download will still not expose this control—could this name the actual RBAC permissions and their feature-flag behavior?
|
|
||
| `show_download` is opt-in and has no effect outside of `standalone=1`. The download control still respects the viewer's `can_download` permission — it's hidden for users who lack it even when the parameter is set. | ||
|
|
||
| Unlike dashboard embedding above, this standalone chart URL is a plain page load rather than an iframe embed managed by `@superset-ui/embedded-sdk`, so it doesn't go through guest tokens or the `dashboardUiConfig` options. |
There was a problem hiding this comment.
Explore's Embed Code generates an <iframe> whose src is this permalink with standalone=1. Calling this a plain page load can lead integrators to omit the supported iframe embed—could this distinguish the session-authenticated iframe flow from the Embedded SDK/guest-token flow and show the iframe form?
2 participants
SUMMARY
#42238 added a
show_downloadURL param for standalone Explore chart permalinks but didn't document it anywhere. Adding a short section to the embedding guide covering standalone chart URLs (/explore/p/<key>/?standalone=1) and the newshow_downloadparam, since there wasn't an existing home for it.BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
N/A, docs only.
TESTING INSTRUCTIONS
Read the new "Embedding a Single Chart" section in
docs/docs/using-superset/embedding.mdx.ADDITIONAL INFORMATION