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: SdkQuestionProps
layout: docs-api
redirect_from:
- /docs/latest/embedding/api/SdkQuestionProps
---
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SdkQuestionProps | 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">SdkQuestionProps</a></li></ul><h1>Interface SdkQuestionProps</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SdkQuestionProps</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#classname">className</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#datapicker">dataPicker</a><span class="tsd-signature-symbol">?:</span> <a href="EmbeddingDataPicker.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingDataPicker</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#entitytypes">entityTypes</a><span class="tsd-signature-symbol">?:</span> <a href="EmbeddingEntityType.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingEntityType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#height">height</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Height</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">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hiddenparameters">hiddenParameters</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#initialcollection">initialCollection</a><span class="tsd-signature-symbol">?:</span> <a href="SdkCollectionId.html" class="tsd-signature-type tsd-kind-type-alias">SdkCollectionId</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#initialsqlparameters">initialSqlParameters</a><span class="tsd-signature-symbol">?:</span> <a href="SqlParameterValues.html" class="tsd-signature-type tsd-kind-type-alias">SqlParameterValues</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#issaveenabled">isSaveEnabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onbeforesave">onBeforeSave</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">question</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseQuestion.html" class="tsd-signature-type tsd-kind-interface">MetabaseQuestion</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">isNewQuestion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onnavigateback">onNavigateBack</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onrun">onRun</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">question</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseQuestion.html" class="tsd-signature-type tsd-kind-interface">MetabaseQuestion</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onsave">onSave</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">question</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseQuestion.html" class="tsd-signature-type tsd-kind-interface">MetabaseQuestion</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">dashboardTabId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">isNewQuestion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onsqlparameterschange">onSqlParametersChange</a><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="SqlParameterChangePayload.html" class="tsd-signature-type tsd-kind-type-alias">SqlParameterChangePayload</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onvisualizationchange">onVisualizationChange</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">display</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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#plugins">plugins</a><span class="tsd-signature-symbol">?:</span> <a href="MetabasePluginsConfig.html" class="tsd-signature-type tsd-kind-type-alias">MetabasePluginsConfig</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#questionid">questionId</a><span class="tsd-signature-symbol">?:</span> <a href="SdkQuestionId.html" class="tsd-signature-type tsd-kind-type-alias">SdkQuestionId</a><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sqlparameters">sqlParameters</a><span class="tsd-signature-symbol">?:</span> <a href="SqlParameterValues.html" class="tsd-signature-type tsd-kind-type-alias">SqlParameterValues</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#style">style</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#targetcollection">targetCollection</a><span class="tsd-signature-symbol">?:</span> <a href="SdkCollectionId.html" class="tsd-signature-type tsd-kind-type-alias">SdkCollectionId</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#title">title</a><span class="tsd-signature-symbol">?:</span> <a href="SdkQuestionTitleProps.html" class="tsd-signature-type tsd-kind-type-alias">SdkQuestionTitleProps</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#token">token</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">null</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#width">width</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Width</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">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#withalerts">withAlerts</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#withcharttypeselector">withChartTypeSelector</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#withdownloads">withDownloads</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#witheditorbutton">withEditorButton</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#classname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>class<wbr/>Name?</span></a>
<a href="#datapicker" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Picker?</span></a>
<a href="#entitytypes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Types?</span></a>
<a href="#height" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>height?</span></a>
<a href="#hiddenparameters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>hidden<wbr/>Parameters?</span></a>
<a href="#initialcollection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>Collection?</span></a>
<a href="#initialsqlparameters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>Sql<wbr/>Parameters?</span></a>
<a href="#issaveenabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Save<wbr/>Enabled?</span></a>
<a href="#onbeforesave" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Before<wbr/>Save?</span></a>
<a href="#onnavigateback" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Navigate<wbr/>Back?</span></a>
<a href="#onrun" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Run?</span></a>
<a href="#onsave" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Save?</span></a>
<a href="#onsqlparameterschange" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Sql<wbr/>Parameters<wbr/>Change?</span></a>
<a href="#onvisualizationchange" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Visualization<wbr/>Change?</span></a>
<a href="#plugins" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>plugins?</span></a>
<a href="#questionid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>question<wbr/>Id?</span></a>
<a href="#sqlparameters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>sql<wbr/>Parameters?</span></a>
<a href="#style" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>style?</span></a>
<a href="#targetcollection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>target<wbr/>Collection?</span></a>
<a href="#title" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>title?</span></a>
<a href="#token" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>token?</span></a>
<a href="#width" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>width?</span></a>
<a href="#withalerts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>with<wbr/>Alerts?</span></a>
<a href="#withcharttypeselector" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>with<wbr/>Chart<wbr/>Type<wbr/>Selector?</span></a>
<a href="#withdownloads" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>with<wbr/>Downloads?</span></a>
<a href="#witheditorbutton" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>with<wbr/>Editor<wbr/>Button?</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="classname"><code class="tsd-tag">Optional</code><span>class<wbr/>Name</span><a href="#classname" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">className</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A custom class name to be added to the root element.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datapicker"><code class="tsd-tag">Optional</code><span>data<wbr/>Picker</span><a href="#datapicker" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">dataPicker</span><span class="tsd-signature-symbol">?:</span> <a href="EmbeddingDataPicker.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingDataPicker</a></div><div class="tsd-comment tsd-typography"><p>Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting <code>dataPicker = "staged"</code>.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="entitytypes"><code class="tsd-tag">Optional</code><span>entity<wbr/>Types</span><a href="#entitytypes" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">entityTypes</span><span class="tsd-signature-symbol">?:</span> <a href="EmbeddingEntityType.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingEntityType</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>An array that specifies which entity types are available in the data picker</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="height"><code class="tsd-tag">Optional</code><span>height</span><a href="#height" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Height</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">number</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>A number or string specifying a CSS size value that specifies the height of the component</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hiddenparameters"><code class="tsd-tag">Optional</code><span>hidden<wbr/>Parameters</span><a href="#hiddenparameters" 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></h3><div class="tsd-signature"><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></div><div class="tsd-comment tsd-typography"><p>A list of parameters to hide.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="initialcollection"><code class="tsd-tag">Optional</code><span>initial<wbr/>Collection</span><a href="#initialcollection" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">initialCollection</span><span class="tsd-signature-symbol">?:</span> <a href="SdkCollectionId.html" class="tsd-signature-type tsd-kind-type-alias">SdkCollectionId</a></div><div class="tsd-comment tsd-typography"><p>The collection to preselect in the save modal's collection picker. Unlike <code>targetCollection</code>, the picker remains visible and the user can choose a different collection. Ignored when <code>targetCollection</code> is set.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="initialsqlparameters"><code class="tsd-tag">Optional</code><span>initial<wbr/>Sql<wbr/>Parameters</span><a href="#initialsqlparameters" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">initialSqlParameters</span><span class="tsd-signature-symbol">?:</span> <a href="SqlParameterValues.html" class="tsd-signature-type tsd-kind-type-alias">SqlParameterValues</a></div><div class="tsd-comment tsd-typography"><p>Initial values for SQL 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: 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).</li>
</ul>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="issaveenabled"><code class="tsd-tag">Optional</code><span>is<wbr/>Save<wbr/>Enabled</span><a href="#issaveenabled" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">isSaveEnabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to show the save button.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onbeforesave"><code class="tsd-tag">Optional</code><span>on<wbr/>Before<wbr/>Save</span><a href="#onbeforesave" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">onBeforeSave</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">question</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseQuestion.html" class="tsd-signature-type tsd-kind-interface">MetabaseQuestion</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">isNewQuestion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>A callback function that triggers before saving. Only relevant when <code>isSaveEnabled = true</code></p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onnavigateback"><code class="tsd-tag">Optional</code><span>on<wbr/>Navigate<wbr/>Back</span><a href="#onnavigateback" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">onNavigateBack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>A callback function that triggers when a user clicks the back button.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onrun"><code class="tsd-tag">Optional</code><span>on<wbr/>Run</span><a href="#onrun" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">onRun</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">question</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseQuestion.html" class="tsd-signature-type tsd-kind-interface">MetabaseQuestion</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>A callback function that triggers when a question is updated, including when a user clicks the <code>Visualize</code> button in the question editor</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onsave"><code class="tsd-tag">Optional</code><span>on<wbr/>Save</span><a href="#onsave" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">onSave</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">question</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseQuestion.html" class="tsd-signature-type tsd-kind-interface">MetabaseQuestion</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">dashboardTabId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">isNewQuestion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</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></div><div class="tsd-comment tsd-typography"><p>A callback function that triggers when a user saves the question. Only relevant when <code>isSaveEnabled = true</code></p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onsqlparameterschange"><code class="tsd-tag">Optional</code><span>on<wbr/>Sql<wbr/>Parameters<wbr/>Change</span><a href="#onsqlparameterschange" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">onSqlParametersChange</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="SqlParameterChangePayload.html" class="tsd-signature-type tsd-kind-type-alias">SqlParameterChangePayload</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Fires on SQL 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></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onvisualizationchange"><code class="tsd-tag">Optional</code><span>on<wbr/>Visualization<wbr/>Change</span><a href="#onvisualizationchange" 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></h3><div class="tsd-signature"><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">display</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></div><div class="tsd-comment tsd-typography"><p>A callback function that triggers when the visualization type changes.</p>
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">display</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></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">display</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><div class="tsd-comment tsd-typography"><p>the new display type</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="plugins"><code class="tsd-tag">Optional</code><span>plugins</span><a href="#plugins" 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></h3><div class="tsd-signature"><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></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="questionid"><code class="tsd-tag">Optional</code><span>question<wbr/>Id</span><a href="#questionid" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">questionId</span><span class="tsd-signature-symbol">?:</span> <a href="SdkQuestionId.html" class="tsd-signature-type tsd-kind-type-alias">SdkQuestionId</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sqlparameters"><code class="tsd-tag">Optional</code><span>sql<wbr/>Parameters</span><a href="#sqlparameters" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">sqlParameters</span><span class="tsd-signature-symbol">?:</span> <a href="SqlParameterValues.html" class="tsd-signature-type tsd-kind-type-alias">SqlParameterValues</a></div><div class="tsd-comment tsd-typography"><p>Controlled SQL parameter values, slug-keyed. On every render, this object replaces the question'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 <code>onSqlParametersChange</code> to stay in sync with user edits.</li>
</ul>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="style"><code class="tsd-tag">Optional</code><span>style</span><a href="#style" 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></h3><div class="tsd-signature"><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></div><div class="tsd-comment tsd-typography"><p>A custom style object to be added to the root element.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="targetcollection"><code class="tsd-tag">Optional</code><span>target<wbr/>Collection</span><a href="#targetcollection" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">targetCollection</span><span class="tsd-signature-symbol">?:</span> <a href="SdkCollectionId.html" class="tsd-signature-type tsd-kind-type-alias">SdkCollectionId</a></div><div class="tsd-comment tsd-typography"><p>The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="title"><code class="tsd-tag">Optional</code><span>title</span><a href="#title" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">?:</span> <a href="SdkQuestionTitleProps.html" class="tsd-signature-type tsd-kind-type-alias">SdkQuestionTitleProps</a></div><div class="tsd-comment tsd-typography"><p>Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="token"><code class="tsd-tag">Optional</code><span>token</span><a href="#token" 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></h3><div class="tsd-signature"><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></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="width"><code class="tsd-tag">Optional</code><span>width</span><a href="#width" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Width</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">number</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>A number or string specifying a CSS size value that specifies the width of the component</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withalerts"><code class="tsd-tag">Optional</code><span>with<wbr/>Alerts</span><a href="#withalerts" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">withAlerts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enables the ability to set up alerts on the question.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withcharttypeselector"><code class="tsd-tag">Optional</code><span>with<wbr/>Chart<wbr/>Type<wbr/>Selector</span><a href="#withcharttypeselector" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">withChartTypeSelector</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Determines whether the chart type selector and corresponding settings button are shown. Only relevant when using the default layout.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withdownloads"><code class="tsd-tag">Optional</code><span>with<wbr/>Downloads</span><a href="#withdownloads" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">withDownloads</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enables the ability to download results in the question.</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="witheditorbutton"><code class="tsd-tag">Optional</code><span>with<wbr/>Editor<wbr/>Button</span><a href="#witheditorbutton" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">withEditorButton</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Determines whether the editor button is shown. Only relevant when using the default layout.</p>
</div></section></section></details></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#classname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>class<wbr/>Name</span></a><a href="#datapicker"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Picker</span></a><a href="#entitytypes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Types</span></a><a href="#height"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>height</span></a><a href="#hiddenparameters"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>hidden<wbr/>Parameters</span></a><a href="#initialcollection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>Collection</span></a><a href="#initialsqlparameters"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>Sql<wbr/>Parameters</span></a><a href="#issaveenabled"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Save<wbr/>Enabled</span></a><a href="#onbeforesave"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Before<wbr/>Save</span></a><a href="#onnavigateback"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Navigate<wbr/>Back</span></a><a href="#onrun"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Run</span></a><a href="#onsave"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Save</span></a><a href="#onsqlparameterschange"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Sql<wbr/>Parameters<wbr/>Change</span></a><a href="#onvisualizationchange"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Visualization<wbr/>Change</span></a><a href="#plugins"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>plugins</span></a><a href="#questionid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>question<wbr/>Id</span></a><a href="#sqlparameters"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>sql<wbr/>Parameters</span></a><a href="#style"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>style</span></a><a href="#targetcollection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>target<wbr/>Collection</span></a><a href="#title"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>title</span></a><a href="#token"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>token</span></a><a href="#width"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>width</span></a><a href="#withalerts"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>with<wbr/>Alerts</span></a><a href="#withcharttypeselector"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>with<wbr/>Chart<wbr/>Type<wbr/>Selector</span></a><a href="#withdownloads"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>with<wbr/>Downloads</span></a><a href="#witheditorbutton"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="assets/icons.svg#icon-1024"></use></svg><span>with<wbr/>Editor<wbr/>Button</span></a></div></details></div></details></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>