函数 InteractiveQuestion

InteractiveQuestion(props: InteractiveQuestionProps): Element
一个支持向下钻取的问题组件。
参数
- props: InteractiveQuestionProps
  - 可选className?: string
    要添加到根元素的自定义类名。
  - 可选componentPlugins?: MetabasePluginsConfig
    用于覆盖或添加钻取菜单的附加映射函数
  - 可选entityTypes?: EmbeddingEntityType[]
    一个数组，指定数据选择器中可用的实体类型
  - 可选height?: Height<string | number>
    一个数字或字符串，指定CSS大小值，用于指定组件的高度
  - 可选initialSqlParameters?: SqlParameterValues
    SQL参数的初始值。
  - 可选isSaveEnabled?: boolean
    是否显示保存按钮。
  - 可选onBeforeSave?: (
    question: undefined | MetabaseQuestion,
    context: { isNewQuestion: boolean },
    ) => Promise<void>
    保存前触发的回调函数。仅在 `isSaveEnabled = true` 时相关。
  - 可选onNavigateBack?: () => void
    用户点击返回按钮时触发的回调函数。
  - 可选onRun?: (question: undefined | MetabaseQuestion) => void
    当问题更新时触发的回调函数，包括用户点击问题编辑器中的 `Visualize` 按钮时。
  - 可选onSave?: (
    question: MetabaseQuestion,
    context: { dashboardTabId?: number; isNewQuestion: boolean },
    ) => void
    当用户保存问题时触发的回调函数。仅在 `isSaveEnabled = true` 时相关。
  - 可选plugins?: MetabasePluginsConfig
  - questionId: null | SdkQuestionId
  - 可选style?: CSSProperties
    要添加到根元素的自定义样式对象。
  - 可选targetCollection?: SdkCollectionId
    保存问题的集合。这将隐藏保存模态框中的集合选择器。仅适用于交互式问题。
  - 可选title?: SdkQuestionTitleProps
    确定是否显示问题标题，并允许显示自定义标题而不是默认问题标题。默认显示。仅适用于使用默认布局的交互式问题。
  - 可选width?: Width<string | number>
    一个数字或字符串，指定CSS大小值，用于指定组件的宽度
  - 可选withChartTypeSelector?: boolean
    确定是否显示图表类型选择器和相应的设置按钮。仅在使用默认布局时相关。
  - 可选withDownloads?: boolean
    启用在交互式问题中下载结果的功能。
  - 可选withResetButton?: boolean
    确定是否显示重置按钮。仅在使用默认布局时相关。
返回 Element

InteractiveQuestion

BackButton

BackButton: (props: InteractiveQuestionBackButtonProps) => null | Element

类型声明

- (props: InteractiveQuestionBackButtonProps): null | Element
- 函数
  一个导航按钮，用于返回上一个视图。仅当在 InteractiveDashboardProps.renderDrillThroughQuestion 属性中渲染时可见。
  参数
  - props: InteractiveQuestionBackButtonProps
  返回 null | Element

Breakout

Breakout: () => null | Element

类型声明

- (): null | Element
- 函数
  一组用于管理数据分组（拆分）的徽章。使用问题上下文进行拆分功能。
  
  返回 null | Element

BreakoutDropdown

BreakoutDropdown: (
props: InteractiveQuestionBreakoutDropdownProps,
) => null | Element

类型声明

- (props: InteractiveQuestionBreakoutDropdownProps): null | Element
- 函数
  Breakout 组件的下拉按钮。
  参数
  - props: InteractiveQuestionBreakoutDropdownProps
  返回 null | Element

ChartTypeDropdown

ChartTypeDropdown: (props: MenuProps) => Element

类型声明

- (props: MenuProps): Element
- 函数
  用于选择可视化类型（条形图、折线图、表格等）的下拉菜单。自动更新以显示当前数据的推荐可视化类型。
  参数
  - props: MenuProps
  返回 Element

ChartTypeSelector

ChartTypeSelector: (props: StackProps) => Element

类型声明

- (props: StackProps): Element
- 函数
  详细的图表类型选择界面，包含推荐的可视化选项。
  参数
  - props: StackProps
  返回 Element

DownloadWidget

DownloadWidget: (props: StackProps) => null | Element

类型声明

- (props: StackProps): null | Element
- 函数
  提供一个用于以不同格式（CSV、XLSX、JSON 和 PNG，取决于可视化）下载数据的 UI 组件。
  参数
  - props: StackProps
  返回 null | Element

DownloadWidgetDropdown

DownloadWidgetDropdown: (props: PopoverProps) => Element

类型声明

- (props: PopoverProps): Element
- 函数
  提供一个按钮，其中包含一个显示 DownloadWidget 的下拉菜单。
  参数
  - props: PopoverProps
  返回 Element

Editor

Editor: (props: InteractiveQuestionEditorProps) => undefined | Element

类型声明

- (props: InteractiveQuestionEditorProps): undefined | Element
- 函数
  高级查询编辑器，提供对问题配置的完全访问权限。包括过滤、聚合、自定义表达式和连接。
  参数
  - props: InteractiveQuestionEditorProps
    - 可选hasVisualizeButton?: boolean
    - 可选onApply?: () => void
      应用更改时执行的回调函数
  返回 undefined | Element

EditorButton

EditorButton: (
props: InteractiveQuestionEditorButtonProps,
) => undefined | false | Element

类型声明

- (props: InteractiveQuestionEditorButtonProps): undefined | false | Element
- 函数
  用于显示/隐藏编辑器界面的切换按钮。在自定义布局中，EditorButton 必须有一个 InteractiveQuestionEditorButtonProps.onClick 处理程序，否则点击按钮将无效。
  参数
  - props: InteractiveQuestionEditorButtonProps
    - 可选isOpen?: boolean
      编辑器当前是否打开
      
      默认值
      false
    - 可选onClick?: MouseEventHandler<HTMLButtonElement>
      点击按钮时调用的回调函数
  返回 undefined | false | Element

Filter

Filter: (props: InteractiveQuestionFilterProps) => Element

类型声明

- (props: InteractiveQuestionFilterProps): Element
- 函数
  一组交互式筛选徽章，允许添加、编辑和删除筛选器。将当前筛选器显示为带有“添加另一个筛选器”选项的徽章。
  参数
  - props: InteractiveQuestionFilterProps
    - 可选withColumnItemIcon?: boolean
      是否显示列项图标
  返回 Element

FilterDropdown

FilterDropdown: (
props: InteractiveQuestionFilterDropdownProps,
) => null | Element

类型声明

- (props: InteractiveQuestionFilterDropdownProps): null | Element
- 函数
  Filter 组件的下拉按钮。
  参数
  - props: InteractiveQuestionFilterDropdownProps
    - 可选withColumnItemIcon?: boolean
      是否显示列项图标
  返回 null | Element

Notebook

Notebook: (props: InteractiveQuestionEditorProps) => undefined | Element

类型声明

- (props: InteractiveQuestionEditorProps): undefined | Element
- 函数
  高级查询编辑器，提供对问题配置的完全访问权限。包括过滤、聚合、自定义表达式和连接。
  参数
  - props: InteractiveQuestionEditorProps
    - 可选hasVisualizeButton?: boolean
    - 可选onApply?: () => void
      应用更改时执行的回调函数
  返回 undefined | Element

已弃用

请改用 InteractiveQuestion.Editor

NotebookButton

NotebookButton: (
props: InteractiveQuestionEditorButtonProps,
) => undefined | false | Element

类型声明

- (props: InteractiveQuestionEditorButtonProps): undefined | false | Element
- 函数
  用于显示/隐藏编辑器界面的切换按钮。在自定义布局中，EditorButton 必须有一个 InteractiveQuestionEditorButtonProps.onClick 处理程序，否则点击按钮将无效。
  参数
  - props: InteractiveQuestionEditorButtonProps
    - 可选isOpen?: boolean
      编辑器当前是否打开
      
      默认值
      false
    - 可选onClick?: MouseEventHandler<HTMLButtonElement>
      点击按钮时调用的回调函数
  返回 undefined | false | Element

已弃用

请改用 InteractiveQuestion.EditorButton

QuestionSettings

QuestionSettings: (props: StackProps) => null | Element

类型声明

- (props: StackProps): null | Element
- 函数
  用于配置轴、颜色和格式等可视化选项的设置面板。使用问题上下文进行设置。
  参数
  - props: StackProps
  返回 null | Element

QuestionSettingsDropdown

QuestionSettingsDropdown: (
props?: InteractiveQuestionQuestionSettingsDropdownProps,
) => Element

类型声明

- (props?: InteractiveQuestionQuestionSettingsDropdownProps): Element
- 函数
  包含 QuestionSettings 组件的下拉按钮。
  参数
  - 可选props: InteractiveQuestionQuestionSettingsDropdownProps
    - 可选height?: Height<string | number>
      下拉菜单的高度
  返回 Element

QuestionVisualization

QuestionVisualization: (
    props: { className?: string; style?: CSSProperties } & {
        height?: Height<string | number>;
        width?: Width<string | number>;
    } & {},
) => Element

类型声明

- (
      props: { className?: string; style?: CSSProperties } & {
          height?: Height<string | number>;
          width?: Width<string | number>;
      } & {},
  ): Element
- 函数
  主要的可视化组件，将问题结果渲染为图表、表格或其他可视化类型。
  参数
  - props: { className?: string; style?: CSSProperties } & {
    height?: Height<string | number>;
    width?: Width<string | number>;
    } & {}
    - 可选className?: string
      要添加到根元素的自定义类名。
    - 可选style?: CSSProperties
      要添加到根元素的自定义样式对象。
    - 可选height?: Height<string | number>
      一个数字或字符串，指定CSS大小值，用于指定组件的高度
    - 可选width?: Width<string | number>
      一个数字或字符串，指定CSS大小值，用于指定组件的宽度
  返回 Element

ResetButton

ResetButton: (props?: ButtonProps) => null | Element

类型声明

- (props?: ButtonProps): null | Element
- 函数
  重置问题修改的按钮。仅在问题有未保存的更改时出现。
  参数
  - 可选props: ButtonProps
  返回 null | Element

SaveButton

SaveButton: (props?: InteractiveQuestionSaveButtonProps) => Element

类型声明

- props?: InteractiveQuestionSaveButtonProps): Element
- 函数
  保存问题更改的按钮。仅在问题有未保存的修改时启用。
  
  注意：目前，在自定义布局中，SaveButton 必须有一个 onClick 处理程序，否则点击按钮将无效。
  参数
  - 可选props: InteractiveQuestionSaveButtonProps
    - 可选onClick?: MouseEventHandler<HTMLButtonElement>
      点击按钮时要调用的处理函数
  返回 Element

SaveQuestionForm

SaveQuestionForm: (
props: InteractiveQuestionSaveQuestionFormProps,
) => null | Element

类型声明

- (props: InteractiveQuestionSaveQuestionFormProps): null | Element
- 函数
  用于保存问题的表单，包括标题和描述。保存时
  - 对于现有问题：调用 SdkQuestionProps.onSave
  - 两个回调都会接收更新后的问题对象
  - 可以通过 InteractiveQuestionSaveQuestionFormProps.onCancel 取消表单
  参数
  - props: InteractiveQuestionSaveQuestionFormProps
    - 可选onCancel?: () => void
      取消保存时执行的回调函数
  返回 null | Element

Summarize

Summarize: () => Element

类型声明

- (): Element
- 函数
  用于添加和管理数据摘要（如计数、求和、平均值）的界面。显示为一组徽章。使用问题上下文进行摘要功能。
  
  返回 Element

SummarizeDropdown

SummarizeDropdown: (props: InteractiveQuestionSummarizeDropdownProps) => Element

类型声明

- (props: InteractiveQuestionSummarizeDropdownProps): Element
- 函数
  Summarize 组件的下拉按钮。
  参数
  - props: InteractiveQuestionSummarizeDropdownProps
  返回 Element

Title

Title: (
props: { className?: string; style?: CSSProperties },
) => undefined | Element

类型声明

- (props: { className?: string; style?: CSSProperties }): undefined | Element
- 函数
  根据问题状态显示标题。显示
  - 如果已保存，则显示问题的显示名称
  - 临时问题（非原生查询）的自动生成描述
  参数
  - props: { className?: string; style?: CSSProperties }
    - 可选className?: string
      要添加到根元素的自定义类名。
    - 可选style?: CSSProperties
      要添加到根元素的自定义样式对象。
  返回 undefined | Element

其他

VisualizationButton

VisualizationButton: () => null | Element

函数 InteractiveQuestion

参数

可选className?: string

可选componentPlugins?: MetabasePluginsConfig

可选entityTypes?: EmbeddingEntityType[]

可选height?: Height<string | number>

可选initialSqlParameters?: SqlParameterValues

可选isSaveEnabled?: boolean

可选onBeforeSave?: ( question: undefined | MetabaseQuestion, context: { isNewQuestion: boolean },) => Promise<void>

可选onNavigateBack?: () => void

可选onRun?: (question: undefined | MetabaseQuestion) => void

可选onSave?: ( question: MetabaseQuestion, context: { dashboardTabId?: number; isNewQuestion: boolean },) => void

可选plugins?: MetabasePluginsConfig

questionId: null | SdkQuestionId

可选style?: CSSProperties

可选targetCollection?: SdkCollectionId

可选title?: SdkQuestionTitleProps

可选width?: Width<string | number>

可选withChartTypeSelector?: boolean

可选withDownloads?: boolean

可选withResetButton?: boolean

返回 Element

索引

InteractiveQuestion

其他

InteractiveQuestion

BackButton

类型声明

参数

返回 null | Element

Breakout

类型声明

返回 null | Element

BreakoutDropdown

类型声明

参数

返回 null | Element

ChartTypeDropdown

类型声明

参数

返回 Element

ChartTypeSelector

类型声明

参数

返回 Element

DownloadWidget

类型声明

参数

返回 null | Element

DownloadWidgetDropdown

类型声明

参数

返回 Element

Editor

类型声明

参数

可选hasVisualizeButton?: boolean

可选onApply?: () => void

返回 undefined | Element

EditorButton

类型声明

参数

可选isOpen?: boolean

默认值

可选onClick?: MouseEventHandler<HTMLButtonElement>

返回 undefined | false | Element

Filter

类型声明

参数

可选withColumnItemIcon?: boolean

返回 Element

FilterDropdown

类型声明

参数

可选withColumnItemIcon?: boolean

返回 null | Element

Notebook

类型声明

参数

可选hasVisualizeButton?: boolean

`可选`className?: string

`可选`componentPlugins?: MetabasePluginsConfig

`可选`entityTypes?: EmbeddingEntityType[]

`可选`height?: Height<string | number>

`可选`initialSqlParameters?: SqlParameterValues

`可选`isSaveEnabled?: boolean

`可选`onBeforeSave?: (
question: undefined | MetabaseQuestion,
context: { isNewQuestion: boolean },
) => Promise<void>

`可选`onNavigateBack?: () => void

`可选`onRun?: (question: undefined | MetabaseQuestion) => void

`可选`onSave?: (
question: MetabaseQuestion,
context: { dashboardTabId?: number; isNewQuestion: boolean },
) => void

`可选`plugins?: MetabasePluginsConfig

`可选`style?: CSSProperties

`可选`targetCollection?: SdkCollectionId

`可选`title?: SdkQuestionTitleProps

`可选`width?: Width<string | number>

`可选`withChartTypeSelector?: boolean

`可选`withDownloads?: boolean

`可选`withResetButton?: boolean

`可选`hasVisualizeButton?: boolean

`可选`onApply?: () => void

`可选`isOpen?: boolean

`可选`onClick?: MouseEventHandler<HTMLButtonElement>

`可选`withColumnItemIcon?: boolean

`可选`withColumnItemIcon?: boolean

`可选`hasVisualizeButton?: boolean

`可选`onApply?: () => void

`可选`isOpen?: boolean

`可选`onClick?: MouseEventHandler<HTMLButtonElement>

`可选`height?: Height<string | number>

`可选`className?: string

`可选`style?: CSSProperties

`可选`height?: Height<string | number>

`可选`width?: Width<string | number>

`可选`onClick?: MouseEventHandler<HTMLButtonElement>

`可选`onCancel?: () => void

`可选`className?: string

`可选`style?: CSSProperties