Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

11.6 KB
Raw Blame

Attributes for the <metabase-dashboard> web component.

Embeds a Metabase dashboard. Provide either dashboard-id (for SSO embeds) or token (for guest embeds), plus optional display configuration.

Properties

Property Type Description
auto-refresh-interval number Auto-refresh interval in seconds. For example, 60 refreshes the dashboard every 60 seconds.
---
Optional
Available in Pro/Enterprise and Guest embed.
custom-context string Optional custom context string passed through to the guest token endpoint.
---
Optional
Available in Guest embed.
dashboard-id string | number The ID of the dashboard to embed. Can be a regular ID or an entity ID. Only for SSO embeds — guest embeds set the ID with token.
drills boolean Whether to enable drill-through on the dashboard.
---
Optional
Default: true
Available in Pro/Enterprise.
enable-entity-navigation boolean Whether to enable internal entity navigation (links to dashboards/questions). Requires drills to be true
---
Optional
Default: false
Available in Pro/Enterprise.
hidden-parameters string[] List of filter names to hide from the dashboard, e.g. ['productId'].
---
Optional
Available in Pro/Enterprise.
initial-parameters object Default values for dashboard filters, e.g. { 'productId': '42' }.
---
Optional
Available in Pro/Enterprise and Guest embed.
navigated-entity-parameters object Filter values for dashboards and SQL questions the user reaches through entity navigation. Needs enable-entity-navigation. Keyed by the navigationId that the navigated-entity-parameters-change DOM event reports, e.g. { '<navigationId>': { 'productId': '42' } }. Each navigation gets a new navigationId, going back keeps it. Each entry works like parameters and replaces the values of that visit: keys you omit use their default, null clears a value. To keep the values the click set, start from the event's clickParameters. A visit without an entry keeps the click-behavior values and is not controlled.
---
Optional
Available in Pro/Enterprise.
parameters object Controlled dashboard filters values, e.g. { 'productId': '42' }. Setting this attribute supersedes initial-parameters as the seed and stays in sync with subsequent mutations. Pair with the parameters-change DOM event to track edits.
---
Optional
Available in Pro/Enterprise and Guest embed.
token string The token for guest embeds. Set automatically by the guest embed flow.
---
Optional
Available in Guest embed.
with-downloads boolean Whether to show the button to download the dashboard as PDF and download question results.
---
Optional
Default: true on OSS/Starter, false on Pro/Enterprise
Available in Guest embed.
with-subscriptions boolean Whether to let people set up dashboard subscriptions. Subscriptions sent from embedded dashboards exclude links to Metabase items.
---
Optional
Available in Pro/Enterprise.
with-title boolean Whether to show the dashboard title in the embed.
---
Optional
Default: true
Available in Guest embed.