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: MetabaseCard
layout: docs-api
redirect_from:
- /docs/latest/embedding/api/MetabaseCard
---
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MetabaseCard | 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">MetabaseCard</a></li></ul><h1>Type Alias MetabaseCard</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">MetabaseCard</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MetabaseCardBase</span> <span class="tsd-signature-symbol">&</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">never</span> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"table"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"object"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"list"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TableVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><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">"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">"row"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CartesianVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"scatter"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ScatterVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"waterfall"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">WaterfallVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pie"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PieVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><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">"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><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ScalarVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"funnel"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">FunnelVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"map"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MapVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"sankey"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SankeyVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"boxplot"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BoxplotVisualizationSettings</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">visualization</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CustomVizDisplayType</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">visualizationSettings</span><span class="tsd-signature-symbol">?:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" class="tsd-signature-type external" target="_blank">Record</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/>)</div><div class="tsd-comment tsd-typography"><p>Ad-hoc card definition for SDK-rendered questions. Pass only <code>query</code> when
Metabase should infer a display from the query result. Add <code>visualization</code>
when the user or design asks for a specific chart type. Add
<code>visualizationSettings</code> only for explicit setting-level presentation changes.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported">Not Exported<a href="#not-exported" 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></h4><p>MetabaseCardBase</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-1">Not Exported<a href="#not-exported-1" 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></h4><p>TableVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-2">Not Exported<a href="#not-exported-2" 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></h4><p>CartesianVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-3">Not Exported<a href="#not-exported-3" 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></h4><p>ScatterVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-4">Not Exported<a href="#not-exported-4" 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></h4><p>WaterfallVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-5">Not Exported<a href="#not-exported-5" 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></h4><p>PieVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-6">Not Exported<a href="#not-exported-6" 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></h4><p>ScalarVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-7">Not Exported<a href="#not-exported-7" 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></h4><p>FunnelVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-8">Not Exported<a href="#not-exported-8" 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></h4><p>MapVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-9">Not Exported<a href="#not-exported-9" 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></h4><p>SankeyVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-10">Not Exported<a href="#not-exported-10" 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></h4><p>BoxplotVisualizationSettings</p>
</div><div class="tsd-tag-notExported"><h4 class="tsd-anchor-link" id="not-exported-11">Not Exported<a href="#not-exported-11" 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></h4><p>CustomVizDisplayType</p>
</div></div></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>