The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
---
title: StaticDashboard
layout: docs-api
redirect_from:
- /docs/latest/embedding/api/StaticDashboard
---
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StaticDashboard | Embedded analytics SDK API</title><link rel="icon" href="assets/favicon.ico"/>{% include docs/embedded-analytics-sdk-metadata.html %}<meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><link rel="stylesheet" href="assets/custom.css"/><script defer src="assets/main.js"></script><script defer src="assets/custom.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Embedded analytics SDK API</a><div id="tsd-toolbar-links"><a href="javascript:navigateBack({ fallbackUrl: '/docs/latest/embedding/sdk/introduction' })">Back to documentation</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">StaticDashboard</a></li></ul><h1>Function StaticDashboard</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="staticdashboard"><span class="tsd-kind-call-signature">StaticDashboard</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <a href="StaticDashboardProps.html" class="tsd-signature-type tsd-kind-interface">StaticDashboardProps</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react/index.d.ts#L4239" class="tsd-signature-type external" target="_blank">Element</a><a href="#staticdashboard" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A lightweight dashboard component.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="StaticDashboardProps.html" class="tsd-signature-type tsd-kind-interface">StaticDashboardProps</a></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5 id="autorefreshinterval"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">autoRefreshInterval</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The interval between auto refreshes on the dashboard, in seconds.</p>
</div></li><li class="tsd-parameter"><h5 id="classname"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">className</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>A custom class name to be added to the root element.</p>
</div></li><li class="tsd-parameter"><h5 id="dashboardid"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">dashboardId</span><span class="tsd-signature-symbol">?: </span><a href="SdkDashboardId.html" class="tsd-signature-type tsd-kind-type-alias">SdkDashboardId</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><p>The ID of the dashboard.
<br/>
This is either:
<br/></p>
<ul>
<li>the numerical ID when accessing a dashboard link, i.e. <code>http://localhost:3000/dashboard/1-my-dashboard</code> where the ID is <code>1</code>
<br/></li>
<li>the string ID found in the <code>entity_id</code> key of the dashboard object when using the API directly or using the SDK Collection Browser to return data</li>
</ul>
</div></li><li class="tsd-parameter"><h5 id="hiddenparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters">parameters to hide</a>.
<br/></p>
<ul>
<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.
<br/></li>
<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li>
</ul>
</div></li><li class="tsd-parameter"><h5 id="initialparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">initialParameters</span><span class="tsd-signature-symbol">?: </span><a href="ParameterValues.html" class="tsd-signature-type tsd-kind-type-alias">ParameterValues</a></h5><div class="tsd-comment tsd-typography"><p>Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host.
<br/>
For each parameter:
<br/></p>
<ul>
<li>set to a value (string for a single option, array of strings for multiple): that value is applied.
<br/></li>
<li>set to <code>null</code>: strictly cleared, ignoring the parameter's default.
<br/></li>
<li>omitted (or set to <code>undefined</code>): falls back to the parameter's default (or <code>null</code> if it has no default).
<br/>
<br/></li>
<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.
<br/></li>
<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li>
</ul>
</div></li><li class="tsd-parameter"><h5 id="onload"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">onLoad</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dashboard</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseDashboard.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDashboard</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><p>Callback that is called when the dashboard is loaded.</p>
</div></li><li class="tsd-parameter"><h5 id="onloadwithoutcards"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">onLoadWithoutCards</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dashboard</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseDashboard.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDashboard</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><p>Callback that is called when the dashboard is loaded without cards.</p>
</div></li><li class="tsd-parameter"><h5 id="onparameterschange"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">onParametersChange</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">:</span> <a href="ParameterChangePayload.html" class="tsd-signature-type tsd-kind-type-alias">ParameterChangePayload</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><p>Fires on parameters change. The payload's <code>source</code> distinguishes the initial state on load (<code>'initial-state'</code>), user edits in the UI (<code>'manual-change'</code>), and auto-updates (<code>'auto-change'</code>).</p>
</div></li><li class="tsd-parameter"><h5 id="onvisualizationchange"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">onVisualizationChange</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">visualization</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"object"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"table"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"bar"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"line"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pie"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"scalar"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"area"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"combo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"smartscalar"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"gauge"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"progress"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"funnel"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"map"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"scatter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"boxplot"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"waterfall"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sankey"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"treemap"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"list"</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><p>A callback function that triggers when a question is opened from a dashboard card
or when the user changes the visualization type of a question.</p>
</div></li><li class="tsd-parameter"><h5 id="parameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">parameters</span><span class="tsd-signature-symbol">?: </span><a href="ParameterValues.html" class="tsd-signature-type tsd-kind-type-alias">ParameterValues</a></h5><div class="tsd-comment tsd-typography"><p>Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values:
<br/></p>
<ul>
<li>a parameter set to a value uses that value.
<br/></li>
<li>a parameter set to <code>null</code> is cleared, even if it has a default.
<br/></li>
<li>a parameter omitted from the object (or set to <code>undefined</code>) uses its default (or <code>null</code> if it has no default).
<br/>
<br/>
Pair with <a href="EditableDashboardProps.html#onparameterschange" class="tsd-kind-property">onParametersChange</a> to stay in sync with user edits.
<br/></li>
<li>Combining <a href="EditableDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.
<br/></li>
<li>Combining <a href="EditableDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li>
</ul>
</div></li><li class="tsd-parameter"><h5 id="plugins"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">plugins</span><span class="tsd-signature-symbol">?: </span><a href="MetabasePluginsConfig.html" class="tsd-signature-type tsd-kind-type-alias">MetabasePluginsConfig</a></h5><div class="tsd-comment tsd-typography"><p>Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details.</p>
</div></li><li class="tsd-parameter"><h5 id="style"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">style</span><span class="tsd-signature-symbol">?: </span><a href="https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react/index.d.ts#L2571" class="tsd-signature-type external" target="_blank">CSSProperties</a></h5><div class="tsd-comment tsd-typography"><p>A custom style object to be added to the root element.</p>
</div></li><li class="tsd-parameter"><h5 id="token"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">token</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><p>A valid JWT token for the guest embed.</p>
</div></li><li class="tsd-parameter"><h5 id="withcardtitle"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withCardTitle</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether the dashboard cards should display a title.</p>
</div></li><li class="tsd-parameter"><h5 id="withdownloads"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withDownloads</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to hide the download button.</p>
</div></li><li class="tsd-parameter"><h5 id="withsubscriptions"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withSubscriptions</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to show the subscriptions button.</p>
</div></li><li class="tsd-parameter"><h5 id="withtitle"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withTitle</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether the dashboard should display a title.</p>
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react/index.d.ts#L4239" class="tsd-signature-type external" target="_blank">Element</a></h4></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="javascript:navigateBack({ fallbackUrl: '/docs/latest/embedding/sdk/introduction' })" class="tsd-nav-link">Back to documentation</a></nav><nav class="tsd-navigation"><a href="index.html">Embedded analytics SDK API</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p><script type="text/javascript" src="/gdpr-cookie-notice/dist/script.js"></script><script type="text/javascript" src="/js/cookie-consent.js"></script><link href="/gdpr-cookie-notice/dist/style.css" rel="stylesheet" /><link href="/css/gdpr.css" rel="stylesheet" /></p></footer><div class="overlay"></div></body></html>