Skip to content

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

22.2 KB
Raw Blame
---
title: CreateQuestion
layout: docs-api
redirect_from:
  - /docs/latest/embedding/api/CreateQuestion
---

<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateQuestion | 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">CreateQuestion</a></li></ul><h1 class="deprecated">Function CreateQuestion</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="createquestion"><span class="tsd-kind-call-signature">CreateQuestion</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <a href="CreateQuestionProps.html" class="tsd-signature-type tsd-kind-interface">CreateQuestionProps</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="#createquestion" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="CreateQuestionProps.html" class="tsd-signature-type tsd-kind-interface">CreateQuestionProps</a></span><ul class="tsd-parameters"><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="datapicker"><code class="tsd-tag">Optional</code><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></h5><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 = &quot;staged&quot;</code>.</p>
</div></li><li class="tsd-parameter"><h5 id="entitytypes"><code class="tsd-tag">Optional</code><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></h5><div class="tsd-comment tsd-typography"><p>An array that specifies which entity types are available in the data picker</p>
</div></li><li class="tsd-parameter"><h5 id="height"><code class="tsd-tag">Optional</code><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">&lt;</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">&gt;</span></h5><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></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 parameters to hide.</p>
</div></li><li class="tsd-parameter"><h5 id="initialcollection"><code class="tsd-tag">Optional</code><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></h5><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></li><li class="tsd-parameter"><h5 id="initialsqlparameters"><code class="tsd-tag">Optional</code><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></h5><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></li><li class="tsd-parameter"><h5 id="issaveenabled"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">isSaveEnabled</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 save button.</p>
</div></li><li class="tsd-parameter"><h5 id="onbeforesave"><code class="tsd-tag">Optional</code><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">=&gt;</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><p>A callback function that triggers before saving. Only relevant when <code>isSaveEnabled = true</code></p>
</div></li><li class="tsd-parameter"><h5 id="onnavigateback"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">onNavigateBack</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><p>A callback function that triggers when a user clicks the back button.</p>
</div></li><li class="tsd-parameter"><h5 id="onrun"><code class="tsd-tag">Optional</code><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">=&gt;</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 updated, including when a user clicks the <code>Visualize</code> button in the question editor</p>
</div></li><li class="tsd-parameter"><h5 id="onsave"><code class="tsd-tag">Optional</code><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">=&gt;</span> <span class="tsd-signature-type">void</span></h5><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></li><li class="tsd-parameter"><h5 id="onsqlparameterschange"><code class="tsd-tag">Optional</code><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">=&gt;</span> <span class="tsd-signature-type">void</span></h5><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></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">display</span><span class="tsd-signature-symbol">:</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;object&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;table&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;bar&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;line&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;pie&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;scalar&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;row&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;area&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;combo&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;pivot&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;smartscalar&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;gauge&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;progress&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;funnel&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;map&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;scatter&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;boxplot&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;waterfall&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;sankey&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;treemap&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;list&quot;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><p>A callback function that triggers when the visualization type changes.</p>
</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></li><li class="tsd-parameter"><h5 id="sqlparameters"><code class="tsd-tag">Optional</code><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></h5><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></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="targetcollection"><code class="tsd-tag">Optional</code><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></h5><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></li><li class="tsd-parameter"><h5 id="title"><code class="tsd-tag">Optional</code><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></h5><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></li><li class="tsd-parameter"><h5 id="width"><code class="tsd-tag">Optional</code><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">&lt;</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">&gt;</span></h5><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></li><li class="tsd-parameter"><h5 id="withalerts"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withAlerts</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Enables the ability to set up alerts on the question.</p>
</div></li><li class="tsd-parameter"><h5 id="withcharttypeselector"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withChartTypeSelector</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><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></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>Enables the ability to download results in the question.</p>
</div></li><li class="tsd-parameter"><h5 id="witheditorbutton"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withEditorButton</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Determines whether the editor button is shown. Only relevant when using the default layout.</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 class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" 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>Use <code>&lt;InteractiveQuestion questionId=&quot;new&quot; /&gt;</code> instead.</p>
</div></div></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>