Optional
Darker variation of the base color
Chart color definition for V2 themes.
A component that allows you to browse collections and their items.
Creates a dashboard
A custom class name to be added to the root element.
Props for the drill-through question
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.
InteractiveDashboard
A dashboard component with drill downs, click behaviors, and the ability to view and click into questions.
A component that renders an interactive question.
A handler function to be called when the button is clicked
Specifies a function to fetch the refresh token. diff --git a/_docs/v0.62/embedding/sdk/api/MetabaseAuthConfigWithSaml.html b/_docs/v0.62/embedding/sdk/api/MetabaseAuthConfigWithSaml.html index 548ff34d57..1dcaf74e40 100644 --- a/_docs/v0.62/embedding/sdk/api/MetabaseAuthConfigWithSaml.html +++ b/_docs/v0.62/embedding/sdk/api/MetabaseAuthConfigWithSaml.html @@ -7,6 +7,8 @@ title: MetabaseAuthConfigWithSaml source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/MetabaseAuthConfigWithSaml.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/MetabaseAuthConfigWithSaml ---
Which authentication method to use. diff --git a/_docs/v0.62/embedding/sdk/api/MetabaseClickAction.html b/_docs/v0.62/embedding/sdk/api/MetabaseClickAction.html index 8309070ddd..5b2fdf60c2 100644 --- a/_docs/v0.62/embedding/sdk/api/MetabaseClickAction.html +++ b/_docs/v0.62/embedding/sdk/api/MetabaseClickAction.html @@ -7,6 +7,8 @@ title: MetabaseClickAction source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/MetabaseClickAction.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/MetabaseClickAction ---
The Collection entity
The CollectionItem entity
Darker variation of the base color
diff --git a/_docs/v0.62/embedding/sdk/api/ChartColorV2.html b/_docs/v0.62/embedding/sdk/api/ChartColorV2.html index 0408e1279e..91bb283321 100644 --- a/_docs/v0.62/embedding/sdk/api/ChartColorV2.html +++ b/_docs/v0.62/embedding/sdk/api/ChartColorV2.html @@ -7,6 +7,8 @@ title: ChartColorV2 source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/ChartColorV2.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/ChartColorV2 ---Type Alias ChartColorV2
Chart color definition for V2 themes.
diff --git a/_docs/v0.62/embedding/sdk/api/CollectionBrowser.html b/_docs/v0.62/embedding/sdk/api/CollectionBrowser.html index 93a65c4195..0fd981e790 100644 --- a/_docs/v0.62/embedding/sdk/api/CollectionBrowser.html +++ b/_docs/v0.62/embedding/sdk/api/CollectionBrowser.html @@ -7,6 +7,8 @@ title: CollectionBrowser source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/CollectionBrowser.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/CollectionBrowser ---Function CollectionBrowser
A component that allows you to browse collections and their items.
diff --git a/_docs/v0.62/embedding/sdk/api/CollectionBrowserListColumns.html b/_docs/v0.62/embedding/sdk/api/CollectionBrowserListColumns.html index 1218ed84ca..1ce26a042b 100644 --- a/_docs/v0.62/embedding/sdk/api/CollectionBrowserListColumns.html +++ b/_docs/v0.62/embedding/sdk/api/CollectionBrowserListColumns.html @@ -7,6 +7,8 @@ title: CollectionBrowserListColumns source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/CollectionBrowserListColumns.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/CollectionBrowserListColumns ---Type Alias CollectionBrowserListColumns
| "type"
| "name"
| "description"
| "lastEditedBy"
| "lastEditedAt"
| "archive"
Settings
Interface CollectionBrowserProps
className?: string;
collectionId?: SdkCollectionId;
EmptyContentComponent?: ComponentType | null;
onClick?: (item: MetabaseCollectionItem) => void;
pageSize?: number;
style?: CSSProperties;
visibleColumns?: CollectionBrowserListColumns[];
visibleEntityTypes?: ("collection" | "dashboard" | "question" | "model")[];
}
Index
Properties
Function CreateDashboardModal
Creates a dashboard
diff --git a/_docs/v0.62/embedding/sdk/api/CreateDashboardModalProps.html b/_docs/v0.62/embedding/sdk/api/CreateDashboardModalProps.html index c0b8d9f248..4dc235cc06 100644 --- a/_docs/v0.62/embedding/sdk/api/CreateDashboardModalProps.html +++ b/_docs/v0.62/embedding/sdk/api/CreateDashboardModalProps.html @@ -7,6 +7,8 @@ title: CreateDashboardModalProps source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/CreateDashboardModalProps.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/CreateDashboardModalProps ---Interface CreateDashboardModalProps
initialCollectionId?: SdkCollectionId;
isOpen?: boolean;
onClose?: () => void;
onCreate: (dashboard: MetabaseDashboard) => void;
targetCollection?: SdkCollectionId;
}
Index
Properties
Interface CreateDashboardValues
collectionId: SdkCollectionId;
description: string | null;
name: string;
}
Index
Properties
Function CreateQuestion
Parameters
OptionalclassName?: stringA custom class name to be added to the root element.
diff --git a/_docs/v0.62/embedding/sdk/api/CreateQuestionProps.html b/_docs/v0.62/embedding/sdk/api/CreateQuestionProps.html index 369ce538e8..7738ee8b07 100644 --- a/_docs/v0.62/embedding/sdk/api/CreateQuestionProps.html +++ b/_docs/v0.62/embedding/sdk/api/CreateQuestionProps.html @@ -7,6 +7,8 @@ title: CreateQuestionProps source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/CreateQuestionProps.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/CreateQuestionProps ---Interface CreateQuestionProps
className?: string;
dataPicker?: EmbeddingDataPicker;
entityTypes?: EmbeddingEntityType[];
height?: Height<string | number>;
hiddenParameters?: string[];
initialCollection?: SdkCollectionId;
initialSqlParameters?: SqlParameterValues;
isSaveEnabled?: boolean;
onBeforeSave?: (
question: MetabaseQuestion | undefined,
context: { isNewQuestion: boolean },
) => Promise<void>;
onNavigateBack?: () => void;
onRun?: (question: MetabaseQuestion | undefined) => void;
onSave?: (
question: MetabaseQuestion,
context: { dashboardTabId?: number; isNewQuestion: boolean },
) => void;
onSqlParametersChange?: (payload: SqlParameterChangePayload) => void;
onVisualizationChange?: (
display:
| "object"
| "table"
| "bar"
| "line"
| "pie"
| "scalar"
| "row"
| "area"
| "combo"
| "pivot"
| "smartscalar"
| "gauge"
| "progress"
| "funnel"
| "map"
| "scatter"
| "boxplot"
| "waterfall"
| "sankey"
| "list",
) => void;
plugins?: MetabasePluginsConfig;
sqlParameters?: SqlParameterValues;
style?: CSSProperties;
targetCollection?: SdkCollectionId;
title?: SdkQuestionTitleProps;
width?: Width<string | number>;
withAlerts?: boolean;
withChartTypeSelector?: boolean;
withDownloads?: boolean;
withEditorButton?: boolean;
}
Index
Properties
Type Alias CustomDashboardCardMenuItem
{ question, }: { question?: MetabaseQuestion },
) => DashCardMenuItem
Type Declaration
Parameters
Returns DashCardMenuItem
Settings
Type Alias DashCardMenuItem
children?: ReactNode;
closeMenuOnClick?: boolean;
color?: MantineColor;
disabled?: boolean;
iconName: IconName;
label: string;
leftSection?: ReactNode;
onClick: () => void;
rightSection?: ReactNode;
}
Index
Properties
Type Alias DashboardCardCustomMenuItem
customItems?: (DashCardMenuItem | CustomDashboardCardMenuItem)[];
withDownloads?: boolean;
withEditLink?: boolean;
}
Index
Properties
Type Alias DashboardCardMenu
Settings
Type Alias DashboardCardMenuCustomElement
{ question, }: { question: MetabaseQuestion },
) => ReactNode
Type Declaration
Parameters
Returns ReactNode
Settings
Interface DrillThroughQuestionProps
Props for the drill-through question
diff --git a/_docs/v0.62/embedding/sdk/api/EditableDashboard.html b/_docs/v0.62/embedding/sdk/api/EditableDashboard.html index 7ae5e68b97..94d4d2c30f 100644 --- a/_docs/v0.62/embedding/sdk/api/EditableDashboard.html +++ b/_docs/v0.62/embedding/sdk/api/EditableDashboard.html @@ -7,6 +7,8 @@ title: EditableDashboard source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/EditableDashboard.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/EditableDashboard ---Function EditableDashboard
A dashboard component with the features available in the
diff --git a/_docs/v0.62/embedding/sdk/api/EditableDashboardProps.html b/_docs/v0.62/embedding/sdk/api/EditableDashboardProps.html index ef1fab0a94..9a9ed2b1d6 100644 --- a/_docs/v0.62/embedding/sdk/api/EditableDashboardProps.html +++ b/_docs/v0.62/embedding/sdk/api/EditableDashboardProps.html @@ -7,6 +7,8 @@ title: EditableDashboardProps source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/EditableDashboardProps.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/EditableDashboardProps ---InteractiveDashboardcomponent, as well as the ability to add and update questions, layout, and content within your dashboard.Interface EditableDashboardProps
autoRefreshInterval?: number;
className?: string;
dashboardId: string | number;
dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">;
drillThroughQuestionHeight?: Height<string | number>;
drillThroughQuestionProps?: DrillThroughQuestionProps;
enableEntityNavigation?: boolean;
hiddenParameters?: string[];
initialParameters?: ParameterValues;
onLoad?: (dashboard: MetabaseDashboard | null) => void;
onLoadWithoutCards?: (dashboard: MetabaseDashboard | null) => void;
onParametersChange?: (payload: ParameterChangePayload) => void;
onVisualizationChange?: (
visualization:
| "object"
| "table"
| "bar"
| "line"
| "pie"
| "scalar"
| "row"
| "area"
| "combo"
| "pivot"
| "smartscalar"
| "gauge"
| "progress"
| "funnel"
| "map"
| "scatter"
| "boxplot"
| "waterfall"
| "sankey"
| "list",
) => void;
parameters?: ParameterValues;
plugins?: MetabasePluginsConfig;
renderDrillThroughQuestion?: () => ReactNode;
style?: CSSProperties;
token?: string | null;
withCardTitle?: boolean;
withDownloads?: boolean;
withSubscriptions?: boolean;
withTitle?: boolean;
}
Index
Properties
Type Alias EmbeddingDataPicker
Settings
Type Alias EmbeddingEntityType
Settings
Type Alias EntityTypeFilterKeys
Settings
Type Alias IconName
| "string"
| "number"
| "function"
| "collection"
| "dashboard"
| "question"
| "model"
| "archive"
| "table"
| "bar"
| "line"
| "pie"
| "scalar"
| "area"
| "smartscalar"
| "gauge"
| "progress"
| "funnel"
| "boxplot"
| "waterfall"
| "sankey"
| "list"
| "revert"
| "add"
| "add_collection"
| "add_column"
| "add_data"
| "add_folder"
| "add_list"
| "add_row"
| "add_to_dash"
| "add_comment"
| "ai"
| "alert"
| "alert_filled"
| "alert_confirm"
| "attachment"
| "arrow_up"
| "arrow_down"
| "arrow_left"
| "arrow_left_to_line"
| "arrow_right"
| "arrow_split"
| "audit"
| "badge"
| "ban"
| "bell"
| "birthday"
| "book_open"
| "bookmark"
| "bookmark_filled"
| "bolt"
| "bolt_filled"
| "breakout"
| "bubble"
| "broken_link"
| "burger"
| "calendar"
| "camera"
| "chart_layout_default"
| "chart_layout_stack"
| "check"
| "check_filled"
| "code_block"
| "chevrondown"
| "chevronleft"
| "chevronright"
| "chevronup"
| "click"
| "clipboard"
| "clock"
| "clone"
| "close"
| "cloud"
| "cloud_filled"
| "collection2"
| "compare"
| "combine"
| "company"
| "comment"
| "currency"
| "connections"
| "contract"
| "copy"
| "corner_up_right"
| "curved"
| "database"
| "database_routing"
| "dependencies"
| "dependent"
| "data_studio"
| "dash"
| "curve"
| "document"
| "download"
| "dyno"
| "edit_document"
| "edit_document_outlined"
| "ellipsis"
| "embed"
| "embed_interactive"
| "embed_modular"
| "embed_static"
| "empty"
| "enter_or_return"
| "exit"
| "expand"
| "expand_arrow"
| "extract"
| "eye"
| "eye_crossed_out"
| "eye_outline"
| "factory"
| "field"
| "fields"
| "filter"
| "filter_plus"
| "find_replace"
| "bug"
| "format_code"
| "formula"
| "funnel_outline"
| "folder"
| "folder_database"
| "folder_filled"
| "gear"
| "gear_settings_filled"
| "gem"
| "ghost"
| "globe"
| "glossary"
| "git_branch"
| "grabber"
| "grid"
| "grid_2x2"
| "grid_bordered"
| "group"
| "google"
| "google_drive"
| "google_sheet"
| "history"
| "home"
| "horizontal_bar"
| "hourglass"
| "info"
| "info_outline"
| "insight"
| "int"
| "io"
| "join_full_outer"
| "join_inner"
| "join_left_outer"
| "join_right_outer"
| "index"
| "key"
| "label"
| "layout_grid"
| "ldap"
| "learn"
| "lightbulb"
| "link"
| "lines"
| "lineandbar"
| "line_style_dashed"
| "line_style_dotted"
| "line_style_solid"
| "location"
| "lock"
| "lock_filled"
| "mail"
| "mail_filled"
| "mcp"
| "medallion"
| "message_circle"
| "metabot"
| "metabot_sad"
| "metric"
| "mode"
| "model_with_badge"
| "moon"
| "move"
| "move_card"
| "network"
| "new_folder"
| "notebook"
| "octagon_alert"
| "package"
| "palette"
| "pause"
| "pencil"
| "pencil_lines"
| "permissions_limited"
| "person"
| "pie_slice"
| "pin"
| "pinmap"
| "pivot_table"
| "play"
| "play_outlined"
| "popover"
| "popular"
| "publish"
| "published"
| "pulse"
| "receipt"
| "recents"
| "share"
| "send"
| "settings"
| "smile"
| "split"
| "sql"
| "subscription"
| "straight"
| "stepped"
| "sticky_note"
| "sort"
| "sort_arrows"
| "sum"
| "sync"
| "synced_collection"
| "transform"
| "quote"
| "redo"
| "return"
| "reference"
| "refresh"
| "refresh_downstream"
| "rename"
| "repository"
| "rocket"
| "ruler"
| "schema"
| "search"
| "search_check"
| "section"
| "segment"
| "shield"
| "shield_outline"
| "shield_stroke"
| "sidebar_closed"
| "sidebar_open"
| "slack"
| "slack_colorized"
| "snail"
| "snippet"
| "sparkles"
| "star_filled"
| "star"
| "stop"
| "store"
| "sun"
| "t-shirt"
| "tab"
| "table2"
| "text_bold"
| "text_italic"
| "text_strike"
| "thumbs_down"
| "thumbs_up"
| "time_history"
| "trash"
| "trash_filled"
| "triangle_left"
| "triangle_right"
| "unarchive"
| "undo"
| "unknown"
| "unpin"
| "unpublish"
| "unreferenced"
| "unsubscribe"
| "upload"
| "variable"
| "verified"
| "official_collection"
| "open_folder"
| "ordered_list"
| "verified_filled"
| "verified_round"
| "view_archive"
| "warning"
| "warning_round"
| "warning_round_filled"
| "warning_triangle_filled"
| "webhook"
| "10k"
| "1m"
| "zap"
| "zoom_in"
| "zoom_out"
| "cake"
| "external"
| "beaker"
| "test_tube"
| "eye_filled"
Settings
Type Alias InitializationStatus
| { status: "uninitialized" }
| { status: "success" }
| { status: "loading" }
| { error: Error; status: "error" }
Settings
Function InteractiveDashboard
props: {
autoRefreshInterval?: number;
dashboardId: SdkDashboardId;
drillThroughQuestionHeight?: Height<string | number>;
drillThroughQuestionProps?: DrillThroughQuestionProps;
initialParameters?: ParameterValues;
onParametersChange?: (payload: ParameterChangePayload) => void;
parameters?: ParameterValues;
plugins?: MetabasePluginsConfig;
renderDrillThroughQuestion?: () => ReactNode;
} & { dashboardId?: SdkDashboardId
| null; token?: string | null } & {
enableEntityNavigation?: boolean;
hiddenParameters?: string[];
initialParameters?: ParameterValues;
withCardTitle?: boolean;
withDownloads?: boolean;
withSubscriptions?: boolean;
withTitle?: boolean;
} & { className?: string; style?: CSSProperties } & {
onLoad?: (dashboard: MetabaseDashboard | null) => void;
onLoadWithoutCards?: (dashboard: MetabaseDashboard | null) => void;
onVisualizationChange?: (
visualization:
| "object"
| "table"
| "bar"
| "line"
| "pie"
| "scalar"
| "row"
| "area"
| "combo"
| "pivot"
| "smartscalar"
| "gauge"
| "progress"
| "funnel"
| "map"
| "scatter"
| "boxplot"
| "waterfall"
| "sankey"
| "list",
) => void;
} & { dataPickerProps?: Pick<SdkQuestionProps, "entityTypes"> } & {},
): Element
A dashboard component with drill downs, click behaviors, and the ability to view and click into questions.
diff --git a/_docs/v0.62/embedding/sdk/api/InteractiveDashboardProps.html b/_docs/v0.62/embedding/sdk/api/InteractiveDashboardProps.html index 7c5116c075..d398c3d008 100644 --- a/_docs/v0.62/embedding/sdk/api/InteractiveDashboardProps.html +++ b/_docs/v0.62/embedding/sdk/api/InteractiveDashboardProps.html @@ -7,6 +7,8 @@ title: InteractiveDashboardProps source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/InteractiveDashboardProps.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/InteractiveDashboardProps ---Interface InteractiveDashboardProps
autoRefreshInterval?: number;
className?: string;
dashboardId: string | number;
dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">;
drillThroughQuestionHeight?: Height<string | number>;
drillThroughQuestionProps?: DrillThroughQuestionProps;
enableEntityNavigation?: boolean;
hiddenParameters?: string[];
initialParameters?: ParameterValues;
onLoad?: (dashboard: MetabaseDashboard | null) => void;
onLoadWithoutCards?: (dashboard: MetabaseDashboard | null) => void;
onParametersChange?: (payload: ParameterChangePayload) => void;
onVisualizationChange?: (
visualization:
| "object"
| "table"
| "bar"
| "line"
| "pie"
| "scalar"
| "row"
| "area"
| "combo"
| "pivot"
| "smartscalar"
| "gauge"
| "progress"
| "funnel"
| "map"
| "scatter"
| "boxplot"
| "waterfall"
| "sankey"
| "list",
) => void;
parameters?: ParameterValues;
plugins?: MetabasePluginsConfig;
renderDrillThroughQuestion?: () => ReactNode;
style?: CSSProperties;
token?: string | null;
withCardTitle?: boolean;
withDownloads?: boolean;
withSubscriptions?: boolean;
withTitle?: boolean;
}
Index
Properties
Function InteractiveQuestion
A component that renders an interactive question.
diff --git a/_docs/v0.62/embedding/sdk/api/InteractiveQuestionBackButtonProps.html b/_docs/v0.62/embedding/sdk/api/InteractiveQuestionBackButtonProps.html index 22d4bdff81..4b3281c4c6 100644 --- a/_docs/v0.62/embedding/sdk/api/InteractiveQuestionBackButtonProps.html +++ b/_docs/v0.62/embedding/sdk/api/InteractiveQuestionBackButtonProps.html @@ -7,6 +7,8 @@ title: InteractiveQuestionBackButtonProps source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/InteractiveQuestionBackButtonProps.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/InteractiveQuestionBackButtonProps ---Type Alias InteractiveQuestionBackButtonProps
ActionIconProps & HTMLAttributes<HTMLButtonElement>,
"noLink" | "onClick",
>
Settings
Type Alias InteractiveQuestionBreakoutDropdownProps
PopoverProps,
"children"
| "onClose"
| "opened",
>
Settings
Interface InteractiveQuestionChartTypeDropdownProps
defaultOpened?: boolean;
onOpenChange?: (opened: boolean) => void;
opened?: boolean;
}
Index
Properties
Type Alias InteractiveQuestionChartTypeSelectorProps
Settings
Interface InteractiveQuestionComponents
AlertsButton: () => Element;
BackButton: (props: InteractiveQuestionBackButtonProps) => Element | null;
Breakout: () => Element | null;
BreakoutDropdown: (
props: InteractiveQuestionBreakoutDropdownProps,
) => Element | null;
ChartTypeDropdown: (
props: InteractiveQuestionChartTypeDropdownProps,
) => Element;
ChartTypeSelector: (props: StackProps) => Element;
DownloadWidget: (props: StackProps) => Element | null;
DownloadWidgetDropdown: (props: PopoverProps) => Element | null;
Editor: (props: InteractiveQuestionEditorProps) => Element | null;
EditorButton: (
props: InteractiveQuestionEditorButtonProps,
) => false | Element | undefined;
Filter: (props: InteractiveQuestionFilterProps) => Element;
FilterDropdown: (
props: InteractiveQuestionFilterDropdownProps,
) => Element | null;
NavigationBackButton: (
props: { className?: string; style?: CSSProperties },
) => ReactNode;
Notebook: (props: InteractiveQuestionEditorProps) => Element | null;
NotebookButton: (
props: InteractiveQuestionEditorButtonProps,
) => false | Element | undefined;
QuestionSettings: (props: StackProps) => Element | null;
QuestionSettingsDropdown: (
props?: InteractiveQuestionQuestionSettingsDropdownProps,
) => Element;
QuestionVisualization: (
props: { className?: string; style?: CSSProperties } & {
height?: Height<string | number>;
width?: Width<string | number>;
} & {},
) => Element;
ResetButton: (props?: ButtonProps) => Element | null;
SaveButton: (props?: InteractiveQuestionSaveButtonProps) => Element;
SaveQuestionForm: (
props: InteractiveQuestionSaveQuestionFormProps,
) => Element | null;
SqlParametersList: () => Element | null;
Summarize: () => Element;
SummarizeDropdown: (
props: InteractiveQuestionSummarizeDropdownProps,
) => Element;
Title: (
props: { className?: string; style?: CSSProperties },
) => Element | undefined;
VisualizationButton: () => Element | null;
}
Index
InteractiveQuestion
Type Alias InteractiveQuestionDownloadWidgetDropdownProps
Settings
Type Alias InteractiveQuestionDownloadWidgetProps
Settings
Interface InteractiveQuestionEditorButtonProps
isOpen?: boolean;
onClick?: MouseEventHandler<HTMLButtonElement>;
}
Index
Properties
Interface InteractiveQuestionEditorProps
hasVisualizeButton?: boolean;
onApply?: () => void;
}
Index
Properties
Type Alias InteractiveQuestionFilterDropdownProps
withColumnItemIcon?: boolean;
}
Index
Properties
Type Alias InteractiveQuestionFilterProps
withColumnItemIcon?: boolean;
}
Index
Properties
Interface InteractiveQuestionProps
className?: string;
dataPicker?: EmbeddingDataPicker;
entityTypes?: EmbeddingEntityType[];
height?: Height<string | number>;
hiddenParameters?: string[];
initialCollection?: SdkCollectionId;
initialSqlParameters?: SqlParameterValues;
isSaveEnabled?: boolean;
onBeforeSave?: (
question: MetabaseQuestion | undefined,
context: { isNewQuestion: boolean },
) => Promise<void>;
onNavigateBack?: () => void;
onRun?: (question: MetabaseQuestion | undefined) => void;
onSave?: (
question: MetabaseQuestion,
context: { dashboardTabId?: number; isNewQuestion: boolean },
) => void;
onSqlParametersChange?: (payload: SqlParameterChangePayload) => void;
onVisualizationChange?: (
display:
| "object"
| "table"
| "bar"
| "line"
| "pie"
| "scalar"
| "row"
| "area"
| "combo"
| "pivot"
| "smartscalar"
| "gauge"
| "progress"
| "funnel"
| "map"
| "scatter"
| "boxplot"
| "waterfall"
| "sankey"
| "list",
) => void;
plugins?: MetabasePluginsConfig;
query?: undefined;
questionId?: SdkQuestionId
| null;
sqlParameters?: SqlParameterValues;
style?: CSSProperties;
targetCollection?: SdkCollectionId;
title?: SdkQuestionTitleProps;
token?: string | null;
width?: Width<string | number>;
withAlerts?: boolean;
withChartTypeSelector?: boolean;
withDownloads?: boolean;
withEditorButton?: boolean;
}
Index
Properties
Interface InteractiveQuestionQuestionSettingsDropdownProps
height?: Height<string | number>;
}
Index
Properties
Type Alias InteractiveQuestionQuestionSettingsProps
Settings
Interface InteractiveQuestionQuestionVisualizationProps
className?: string;
height?: Height<string | number>;
style?: CSSProperties;
width?: Width<string | number>;
}
Index
Properties
Interface InteractiveQuestionResetButtonProps
animate?: boolean;
highlightOnHover?: boolean;
type?: "button" | "submit";
}
Index
Properties
Type Alias InteractiveQuestionSaveButtonProps
onClick?: MouseEventHandler<HTMLButtonElement>;
} & ButtonProps
Type Declaration
OptionalonClick?: MouseEventHandler<HTMLButtonElement>A handler function to be called when the button is clicked
diff --git a/_docs/v0.62/embedding/sdk/api/InteractiveQuestionSaveQuestionFormProps.html b/_docs/v0.62/embedding/sdk/api/InteractiveQuestionSaveQuestionFormProps.html index 724bcade37..f6838f4751 100644 --- a/_docs/v0.62/embedding/sdk/api/InteractiveQuestionSaveQuestionFormProps.html +++ b/_docs/v0.62/embedding/sdk/api/InteractiveQuestionSaveQuestionFormProps.html @@ -7,6 +7,8 @@ title: InteractiveQuestionSaveQuestionFormProps source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/InteractiveQuestionSaveQuestionFormProps.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/InteractiveQuestionSaveQuestionFormProps ---Interface InteractiveQuestionSaveQuestionFormProps
onCancel?: () => void;
}
Index
Properties
Type Alias InteractiveQuestionSummarizeDropdownProps
PopoverProps,
"children"
| "onClose"
| "opened",
>
Settings
Interface InteractiveQuestionTitleProps
className?: string;
style?: CSSProperties;
}
Index
Properties
Type Alias LoginStatus
Settings
Type Alias MetabaseAuthConfig
| MetabaseAuthConfigWithApiKey
| MetabaseAuthConfigWithJwt
| MetabaseAuthConfigWithSaml
| MetabaseIsGuestAuthConfig
Settings
Type Alias MetabaseAuthConfigWithApiKey
apiKey: string;
fetchRequestToken?: never;
isGuest?: false;
preferredAuthMethod?: never;
}
Settings
Type Alias MetabaseAuthConfigWithJwt
apiKey?: never;
fetchRequestToken?: MetabaseFetchRequestTokenFn;
isGuest?: false;
jwtProviderUri?: string;
preferredAuthMethod?: "jwt";
}
Type Declaration
metabaseInstanceUrl: string
OptionalapiKey?: neverOptionalfetchRequestToken?: MetabaseFetchRequestTokenFnSpecifies a function to fetch the refresh token. diff --git a/_docs/v0.62/embedding/sdk/api/MetabaseAuthConfigWithSaml.html b/_docs/v0.62/embedding/sdk/api/MetabaseAuthConfigWithSaml.html index 548ff34d57..1dcaf74e40 100644 --- a/_docs/v0.62/embedding/sdk/api/MetabaseAuthConfigWithSaml.html +++ b/_docs/v0.62/embedding/sdk/api/MetabaseAuthConfigWithSaml.html @@ -7,6 +7,8 @@ title: MetabaseAuthConfigWithSaml source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/MetabaseAuthConfigWithSaml.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/MetabaseAuthConfigWithSaml ---
Type Alias MetabaseAuthConfigWithSaml
apiKey?: never;
fetchRequestToken?: never;
isGuest?: false;
preferredAuthMethod?: "saml";
}
Type Declaration
metabaseInstanceUrl: string
OptionalapiKey?: neverOptionalfetchRequestToken?: neverOptionalisGuest?: falseOptionalpreferredAuthMethod?: "saml"Which authentication method to use. diff --git a/_docs/v0.62/embedding/sdk/api/MetabaseClickAction.html b/_docs/v0.62/embedding/sdk/api/MetabaseClickAction.html index 8309070ddd..5b2fdf60c2 100644 --- a/_docs/v0.62/embedding/sdk/api/MetabaseClickAction.html +++ b/_docs/v0.62/embedding/sdk/api/MetabaseClickAction.html @@ -7,6 +7,8 @@ title: MetabaseClickAction source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/MetabaseClickAction.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/MetabaseClickAction ---
Type Alias MetabaseClickAction
Settings
Type Alias MetabaseClickActionPluginsConfig
clickActions: MetabaseClickAction[],
clickedDataPoint: MetabaseDataPointObject,
) => MetabaseClickAction[] | { onClick: () => void }
Type Declaration
clickActions: MetabaseClickAction[],
clickedDataPoint: MetabaseDataPointObject,
): MetabaseClickAction[] | { onClick: () => void }
Parameters
Returns MetabaseClickAction[] | { onClick: () => void }
Settings
Type Alias MetabaseCollection
The Collection entity
diff --git a/_docs/v0.62/embedding/sdk/api/MetabaseCollectionItem.html b/_docs/v0.62/embedding/sdk/api/MetabaseCollectionItem.html index 7dc88ace24..9166517f81 100644 --- a/_docs/v0.62/embedding/sdk/api/MetabaseCollectionItem.html +++ b/_docs/v0.62/embedding/sdk/api/MetabaseCollectionItem.html @@ -7,6 +7,8 @@ title: MetabaseCollectionItem source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/MetabaseCollectionItem.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/MetabaseCollectionItem ---Type Alias MetabaseCollectionItem
The CollectionItem entity
diff --git a/_docs/v0.62/embedding/sdk/api/MetabaseColorKey.html b/_docs/v0.62/embedding/sdk/api/MetabaseColorKey.html index a61014d4e2..b997143656 100644 --- a/_docs/v0.62/embedding/sdk/api/MetabaseColorKey.html +++ b/_docs/v0.62/embedding/sdk/api/MetabaseColorKey.html @@ -7,6 +7,8 @@ title: MetabaseColorKey source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/MetabaseColorKey.html' layout: docs-api +redirect_from: + - /docs/v0.62/embedding/api/MetabaseColorKey ---