Skip to content

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

12.5 KB
Raw Blame

Expand

Props for the drill-through question

Properties

Property Type Description
children? ReactNode The children of the component
className? string A custom class name to be added to the root element.
dataPicker? EmbeddingDataPicker Controls the menu for selecting data sources in questions. You can opt for the full data picker by setting dataPicker = "staged".
entityTypes? EmbeddingEntityType[] An array that specifies which entity types are available in the data picker
height? Height<string | number> A number or string specifying a CSS size value that specifies the height of the component
initialCollection? SdkCollectionId The collection to preselect in the save modal's collection picker. Unlike targetCollection, the picker remains visible and the user can choose a different collection. Ignored when targetCollection is set.
initialSqlParameters? SqlParameterValues Initial values for SQL parameters, slug-keyed, applied to every SQL question that opens from the dashboard. To control a SQL question opened by a click behavior, use the dashboard's navigatedEntityParameters and onNavigatedEntityParametersChange.
isSaveEnabled? boolean Whether to show the save button.
onBeforeSave? (question: MetabaseQuestion | undefined, context: { isNewQuestion: boolean; }) => Promise<void> A callback function that triggers before saving. Only relevant when isSaveEnabled = true
onRun? (question: MetabaseQuestion | undefined) => void A callback function that triggers when a question is updated, including when a user clicks the Visualize button in the question editor
onSave? (question: MetabaseQuestion, context: { dashboardTabId?: number; isNewQuestion: boolean; }) => void A callback function that triggers when a user saves the question. Only relevant when isSaveEnabled = true
plugins? MetabasePluginsConfig -
style? CSSProperties A custom style object to be added to the root element.
targetCollection? SdkCollectionId The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.
title? SdkQuestionTitleProps Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default.
width? Width<string | number> A number or string specifying a CSS size value that specifies the width of the component
withAlerts? boolean Enables the ability to set up alerts on the question.
withChartTypeSelector? boolean Determines whether the chart type selector and corresponding settings button are shown. Only relevant when using the default layout.
withDownloads? boolean Enables the ability to download results in the question.
withEditorButton? boolean Determines whether the editor button is shown. Only relevant when using the default layout.