[auto] adding content to backport-55-1cdb4bf7a4e829c923634a29c1643c7a3df452e8->release-x.55.x (#307)

Co-authored-by: Metabase Docs bot <[email protected]>

Author: github-automation-metabase

_docs/latest/embedding/sdk/api/EditableDashboard.html

@@ -22,19 +22,29 @@
 <br/></li>
 <li>the string ID found in the <code>entity_id</code> key of the dashboard object when using the API directly or using the SDK Collection Browser to return data</li>
 </ul>
-</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="drillthroughquestionheight"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">drillThroughQuestionHeight</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Height of a question component when drilled from the dashboard to a question level.</p>
-</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="drillthroughquestionprops"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">drillThroughQuestionProps</span><span class="tsd-signature-symbol">?: </span><a href="DrillThroughQuestionProps.html" class="tsd-signature-type tsd-kind-interface">DrillThroughQuestionProps</a></h5><div class="tsd-comment tsd-typography"><p>Props for the drill-through question</p>
+</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="drillthroughquestionheight"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">drillThroughQuestionHeight</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>Height of a question component when drilled from the dashboard to a question level.</p>
+</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="drillthroughquestionprops"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">drillThroughQuestionProps</span><span class="tsd-signature-symbol">?: </span><a href="DrillThroughQuestionProps.html" class="tsd-signature-type tsd-kind-interface">DrillThroughQuestionProps</a></h5><div class="tsd-comment tsd-typography"><p>Props of a question component when drilled from the dashboard to a question level.</p>
+</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="hiddenparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters">parameters to hide</a>.
+<br/></p>
+<ul>
+<li>Combining <a href="EditableDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.
+<br/></li>
+<li>Combining <a href="EditableDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li>
+</ul>
 </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="initialparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">initialParameters</span><span class="tsd-signature-symbol">?: </span><a href="ParameterValues.html" class="tsd-signature-type tsd-kind-type-alias">ParameterValues</a></h5><div class="tsd-comment tsd-typography"><p>Query parameters for the dashboard. For a single option, use a <code>string</code> value, and use a list of strings for multiple options.
 <br/></p>
 <ul>
-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.
+<li>Combining <a href="EditableDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.
 <br/></li>
-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li>
+<li>Combining <a href="EditableDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="EditableDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li>
 </ul>
 </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="onload"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">onLoad</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dashboard</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MetabaseDashboard.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDashboard</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><p>Callback that is called when the dashboard is loaded.</p>
 </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="onloadwithoutcards"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">onLoadWithoutCards</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dashboard</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MetabaseDashboard.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDashboard</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><p>Callback that is called when the dashboard is loaded without cards.</p>
 </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="plugins"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">plugins</span><span class="tsd-signature-symbol">?: </span><a href="MetabasePluginsConfig.html" class="tsd-signature-type tsd-kind-type-alias">MetabasePluginsConfig</a></h5><div class="tsd-comment tsd-typography"><p>Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details.</p>
+</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="renderdrillthroughquestion"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">renderDrillThroughQuestion</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478" class="tsd-signature-type external" target="_blank">ReactNode</a></h5><div class="tsd-comment tsd-typography"><p>A custom React component to render the question layout.
+Use namespaced InteractiveQuestion components to build the layout.</p>
 </div><div class="tsd-comment tsd-typography"></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/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579" 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><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="withcardtitle"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withCardTitle</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether the dashboard cards should display a title.</p>
 </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="withdownloads"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withDownloads</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to hide the download button.</p>
+</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5 id="withtitle"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withTitle</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether the dashboard should display a title.</p>
 </div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/jsx-runtime.d.ts#L6" class="tsd-signature-type external" target="_blank">Element</a></h4><div class="tsd-comment tsd-typography"></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>