OptionalchildrenOptionalentityAn array that specifies which entity types are available in the data picker
-OptionalinitialInitial values for the SQL parameters.
-OptionalisWhether to show the save button.
-OptionalonA callback function that triggers before saving. Only relevant when isSaveEnabled = true
OptionalonA callback function that triggers when a question is updated, including when a user clicks the Visualize button in the question editor
OptionalonA callback function that triggers when a user saves the question. Only relevant when isSaveEnabled = true
OptionalpluginsThe ID of the question.
-
-This is either:
-
http://localhost:3000/question/1-my-question where the ID is 1
-entity_id key of the question object. You can find a question's Entity ID in the info panel when viewing a question
-new to show the notebook editor for creating new questions. isSaveEnabled must be true to allow saving the questionOptionaltargetThe collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.
-OptionalwithEnables the ability to download results in the interactive question.
-A component that allows you to browse collections and their items.
+A component that allows you to browse collections and their items.
OptionalclassName?: stringA custom class name to be added to the root element.
OptionalcollectionId?: SdkCollectionIdThe numerical ID of the collection, "personal" for the user's personal collection, or "root" for the root collection. You can find this ID in the URL when accessing a collection in your Metabase instance. For example, the collection ID in http://localhost:3000/collection/1-my-collection would be 1. Defaults to "personal"
OptionalEmptyContentComponent?: null | ComponentTypeA component to display when there are no items in the collection.
@@ -17,5 +17,5 @@OptionalpageSize?: numberThe number of items to display per page. The default is 25.
Optionalstyle?: CSSPropertiesA custom style object to be added to the root element.
OptionalvisibleColumns?: CollectionBrowserListColumns[]The columns to display in the collection items table. If not provided, all columns will be shown.
-OptionalvisibleEntityTypes?: ("model" | "question" | "collection" | "dashboard")[]The types of entities that should be visible. If not provided, all entities will be shown.
-OptionalvisibleEntityTypes?: ("collection" | "dashboard" | "question" | "model")[]The types of entities that should be visible. If not provided, all entities will be shown.
+OptionalpageThe number of items to display per page. The default is 25.
OptionalstyleA custom style object to be added to the root element.
OptionalvisibleThe columns to display in the collection items table. If not provided, all columns will be shown.
-OptionalvisibleThe types of entities that should be visible. If not provided, all entities will be shown.
+OptionalvisibleThe types of entities that should be visible. If not provided, all entities will be shown.
Creates a dashboard
+Creates a dashboard
OptionalinitialCollectionId?: SdkCollectionIdInitial collection in which to create a dashboard. You can use predefined system values like root or personal.
OptionalisOpen?: booleanWhether the modal is open or not.
OptionalonClose?: () => voidHandler to close modal component
Handler to react on dashboard creation.
-Optionalprops: CreateQuestionPropsOptionalclassName?: stringA custom class name to be added to the root element.
+OptionalclassName?: stringA custom class name to be added to the root element.
OptionalcomponentPlugins?: MetabasePluginsConfigAdditional mapper function to override or add drill-down menu
OptionalentityTypes?: EmbeddingEntityType[]An array that specifies which entity types are available in the data picker
Optionalheight?: Height<string | number>A number or string specifying a CSS size value that specifies the height of the component
@@ -26,5 +26,5 @@OptionalwithChartTypeSelector?: booleanDetermines whether the chart type selector and corresponding settings button are shown. Only relevant when using the default layout.
OptionalwithDownloads?: booleanEnables the ability to download results in the interactive question.
OptionalwithResetButton?: booleanDetermines whether a reset button is displayed. Only relevant when using the default layout.
-A dashboard component with the features available in the InteractiveDashboard component, as well as the ability to add and update questions, layout, and content within your dashboard.
A dashboard component with the features available in the InteractiveDashboard component, as well as the ability to add and update questions, layout, and content within your dashboard.
OptionalclassName?: stringA custom class name to be added to the root element.
The ID of the dashboard.
@@ -46,4 +46,4 @@
OptionalwithCardTitle?: booleanWhether the dashboard cards should display a title.
OptionalwithDownloads?: booleanWhether to hide the download button.
OptionalwithTitle?: booleanWhether the dashboard should display a title.
-A dashboard component with drill downs, click behaviors, and the ability to view and click into questions.
+A dashboard component with drill downs, click behaviors, and the ability to view and click into questions.
OptionaldrillThroughQuestionHeight?: Height<string | number>Height of a question component when drilled from the dashboard to a question level.
OptionaldrillThroughQuestionProps?: DrillThroughQuestionPropsProps of a question component when drilled from the dashboard to a question level.
Optionalplugins?: MetabasePluginsConfigAdditional mapper function to override or add drill-down menu. See the implementing custom actions section for more details.
@@ -46,4 +46,4 @@OptionalonLoad?: (dashboard: null | MetabaseDashboard) => voidCallback that is called when the dashboard is loaded.
OptionalonLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => voidCallback that is called when the dashboard is loaded without cards.
OptionaldataPickerProps?: Pick<SdkQuestionProps, "entityTypes">Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.
A question component with drill-downs enabled.
-OptionalclassName?: stringA custom class name to be added to the root element.
+A component that renders an interactive question.
+OptionalclassName?: stringA custom class name to be added to the root element.
OptionalcomponentPlugins?: MetabasePluginsConfigAdditional mapper function to override or add drill-down menu
OptionalentityTypes?: EmbeddingEntityType[]An array that specifies which entity types are available in the data picker
Optionalheight?: Height<string | number>A number or string specifying a CSS size value that specifies the height of the component
@@ -27,7 +27,7 @@OptionalwithChartTypeSelector?: booleanDetermines whether the chart type selector and corresponding settings button are shown. Only relevant when using the default layout.
OptionalwithDownloads?: booleanEnables the ability to download results in the interactive question.
OptionalwithResetButton?: booleanDetermines whether a reset button is displayed. Only relevant when using the default layout.
-FunctionA navigation button that returns to the previous view. +Only visible when rendered within the InteractiveDashboardProps.renderDrillThroughQuestion prop.
+FunctionDropdown button for the Breakout component.
+FunctionDetailed chart type selection interface with recommended visualization options.
+FunctionProvides a UI widget for downloading data in different formats (CSV, XLSX, JSON, and PNG depending on the visualization).
FunctionProvides a button that contains a dropdown that shows the DownloadWidget.
FunctionAdvanced query editor that provides full access to question configuration. +Includes filtering, aggregation, custom expressions, and joins.
+OptionalhasVisualizeButton?: booleanOptionalonApply?: () => voidCallback function executed when changes are applied
+FunctionToggle button for showing/hiding the Editor interface.
+In custom layouts, the EditorButton must have an InteractiveQuestionEditorButtonProps.onClick` handler or the button won't do anything when clicked.
OptionalisOpen?: booleanWhether the editor is currently open
+OptionalonClick?: MouseEventHandler<HTMLButtonElement>Callback function to be called when the button is clicked
+FunctionA set of interactive filter badges that allow adding, editing, and removing filters. +Displays current filters as badges with an "Add another filter" option.
+OptionalwithColumnItemIcon?: booleanWhether to show the icon for the column item
+FunctionA dropdown button for the Filter component.
+OptionalwithColumnItemIcon?: booleanWhether to show the icon for the column item
+FunctionAdvanced query editor that provides full access to question configuration. +Includes filtering, aggregation, custom expressions, and joins.
+OptionalhasVisualizeButton?: booleanOptionalonApply?: () => voidCallback function executed when changes are applied
+FunctionToggle button for showing/hiding the Editor interface.
+In custom layouts, the EditorButton must have an InteractiveQuestionEditorButtonProps.onClick` handler or the button won't do anything when clicked.
OptionalisOpen?: booleanWhether the editor is currently open
+OptionalonClick?: MouseEventHandler<HTMLButtonElement>Callback function to be called when the button is clicked
+FunctionSettings panel for configuring visualization options like axes, colors, and formatting. +Uses question context for settings.
+FunctionDropdown button that contains the QuestionSettings component.
+Optionalprops: InteractiveQuestionQuestionSettingsDropdownPropsOptionalheight?: Height<string | number>Height for the dropdown menu
+FunctionThe main visualization component that renders the question results as a chart, table, or other visualization type.
+OptionalclassName?: stringA custom class name to be added to the root element.
+Optionalstyle?: CSSPropertiesA custom style object to be added to the root element.
+Optionalheight?: Height<string | number>A number or string specifying a CSS size value that specifies the height of the component
+Optionalwidth?: Width<string | number>A number or string specifying a CSS size value that specifies the width of the component
+FunctionButton to reset question modifications. Only appears when there are unsaved changes to the question.
+Optionalprops: ButtonPropsFunctionButton for saving question changes. Only enabled when there are unsaved modifications to the question.
+Note: Currently, in custom layouts, the SaveButton must have an onClick handler or the button will not do anything when clicked.
Optionalprops: InteractiveQuestionSaveButtonPropsOptionalonClick?: MouseEventHandler<HTMLButtonElement>A handler function to be called when the button is clicked
+FunctionForm for saving a question, including title and description. When saved:
+OptionalonCancel?: () => voidCallback function executed when save is cancelled
+FunctionDropdown button for the Summarize component.
+FunctionDisplays a title based on the question's state. Shows:
+OptionalclassName?: stringA custom class name to be added to the root element.
+Optionalstyle?: CSSPropertiesA custom style object to be added to the root element.
+Defines how to authenticate with Metabase.
The children of the MetabaseProvider component.
OptionalclassName?: stringA custom class name to be added to the root element.
-OptionalerrorComponent?: SdkErrorComponentA custom error component to display when the SDK encounters an error.
+OptionalerrorComponent?: SdkErrorComponentA custom error component to display when the SDK encounters an error.
OptionaleventHandlers?: SdkEventHandlersConfigOptionalloaderComponent?: () => ElementA custom loader component to display while the SDK is loading.
Optionallocale?: stringDefines the display language. Accepts an ISO language code such as en or de.
diff --git a/_docs/master/embedding/sdk/api/MetabaseProviderProps.html b/_docs/master/embedding/sdk/api/MetabaseProviderProps.html
index c06935f30b..1624bbab66 100644
--- a/_docs/master/embedding/sdk/api/MetabaseProviderProps.html
+++ b/_docs/master/embedding/sdk/api/MetabaseProviderProps.html
@@ -9,10 +9,10 @@
layout: docs-api
---
-
OptionalallowWhether to allow logging to the DevTools console. Defaults to true.
Defines how to authenticate with Metabase.
The children of the MetabaseProvider component.
-OptionalclassA custom class name to be added to the root element.
-OptionalerrorA custom error component to display when the SDK encounters an error.
+OptionalclassA custom class name to be added to the root element.
+OptionalerrorA custom error component to display when the SDK encounters an error.
OptionaleventOptionalloaderA custom loader component to display while the SDK is loading.
OptionallocaleDefines the display language. Accepts an ISO language code such as en or de.
diff --git a/_docs/master/embedding/sdk/api/MetabotQuestion.html b/_docs/master/embedding/sdk/api/MetabotQuestion.html
new file mode 100644
index 0000000000..eec53a55b2
--- /dev/null
+++ b/_docs/master/embedding/sdk/api/MetabotQuestion.html
@@ -0,0 +1,13 @@
+---
+version: master
+has_magic_breadcrumbs: true
+show_category_breadcrumb: true
+show_title_breadcrumb: true
+category: Embedding
+title: MetabotQuestion
+source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/MetabotQuestion.html'
+layout: docs-api
+---
+
+
A lightweight dashboard component.
+A lightweight dashboard component.
OptionaldrillThroughQuestionHeight?: Height<string | number>Height of a question component when drilled from the dashboard to a question level.
OptionaldrillThroughQuestionProps?: DrillThroughQuestionPropsProps of a question component when drilled from the dashboard to a question level.
Optionalplugins?: MetabasePluginsConfigAdditional mapper function to override or add drill-down menu. See the implementing custom actions section for more details.
@@ -46,4 +46,4 @@OptionalonLoad?: (dashboard: null | MetabaseDashboard) => voidCallback that is called when the dashboard is loaded.
OptionalonLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => voidCallback that is called when the dashboard is loaded without cards.
OptionaldataPickerProps?: Pick<SdkQuestionProps, "entityTypes">Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.
A question component without drill-downs.
-OptionalclassName?: stringA custom class name to be added to the root element.
+A component that renders a static question.
+OptionalclassName?: stringA custom class name to be added to the root element.
Optionalheight?: Height<string | number>A number or string specifying a CSS size value that specifies the height of the component
OptionalinitialSqlParameters?: SqlParameterValuesInitial values for the SQL parameters.
Optionalstyle?: CSSPropertiesA custom style object to be added to the root element.
@@ -18,7 +18,7 @@Optionalwidth?: Width<string | number>A number or string specifying a CSS size value that specifies the width of the component
OptionalwithChartTypeSelector?: booleanDetermines whether the chart type selector and corresponding settings button are shown. Only relevant when using the default layout.
OptionalwithDownloads?: booleanEnables the ability to download results in the interactive question.
-FunctionDropdown button for the Breakout component.
+FunctionDetailed chart type selection interface with recommended visualization options.
+FunctionProvides a UI widget for downloading data in different formats (CSV, XLSX, JSON, and PNG depending on the visualization).
FunctionProvides a button that contains a dropdown that shows the DownloadWidget.
FunctionA set of interactive filter badges that allow adding, editing, and removing filters. +Displays current filters as badges with an "Add another filter" option.
+OptionalwithColumnItemIcon?: booleanWhether to show the icon for the column item
+FunctionA dropdown button for the Filter component.
+OptionalwithColumnItemIcon?: booleanWhether to show the icon for the column item
+FunctionSettings panel for configuring visualization options like axes, colors, and formatting. +Uses question context for settings.
+FunctionDropdown button that contains the QuestionSettings component.
+Optionalprops: InteractiveQuestionQuestionSettingsDropdownPropsOptionalheight?: Height<string | number>Height for the dropdown menu
+FunctionThe main visualization component that renders the question results as a chart, table, or other visualization type.
+OptionalclassName?: stringA custom class name to be added to the root element.
+Optionalstyle?: CSSPropertiesA custom style object to be added to the root element.
+Optionalheight?: Height<string | number>A number or string specifying a CSS size value that specifies the height of the component
+Optionalwidth?: Width<string | number>A number or string specifying a CSS size value that specifies the width of the component
+FunctionButton to reset question modifications. Only appears when there are unsaved changes to the question.
+Optionalprops: ButtonPropsFunctionDropdown button for the Summarize component.
+FunctionDisplays a title based on the question's state. Shows:
+OptionalclassName?: stringA custom class name to be added to the root element.
+Optionalstyle?: CSSPropertiesA custom style object to be added to the root element.
+Creates a dashboard
-Creates a dashboard.
+Returns null until the SDK is fully loaded and initialized.
Returns the current user.
+Returns null until the SDK is fully loaded and initialized.
Returns the authentication status of the current user in the Metabase embedding SDK.
+Returns null until the SDK is fully loaded and initialized.
The children of the MetabaseProvider component.s
-