函数 InteractiveQuestion

InteractiveQuestion(props: InteractiveQuestionProps): Element
一个渲染交互式问题的组件。
参数
- props: InteractiveQuestionProps
  - 可选className?: string
    要添加到根元素的自定义类名。
  - OptionalentityTypes?: EmbeddingEntityType[]
    一个数组，指定数据选择器中可用的实体类型
  - Optionalheight?: Height<string | number>
    一个数字或字符串，指定CSS大小值，用于指定组件的高度
  - 可选hiddenParameters?: string[]
    要隐藏的参数列表。
  - 可选initialSqlParameters?: SqlParameterValues
    SQL参数的初始值。
  - 可选isSaveEnabled?: boolean
    是否显示保存按钮。
  - 可选onBeforeSave?: (
    question: undefined | MetabaseQuestion,
    context: { isNewQuestion: boolean },
    ) => Promise<void>
    保存前触发的回调函数。仅在 `isSaveEnabled = true` 时相关。
  - OptionalonNavigateBack?: () => void
    用户点击返回按钮时触发的回调函数。
  - OptionalonRun?: (question: undefined | MetabaseQuestion) => void
    当问题更新时触发的回调函数，包括用户点击问题编辑器中的 `Visualize` 按钮时。
  - 可选onSave?: (
    question: MetabaseQuestion,
    context: { dashboardTabId?: number; isNewQuestion: boolean },
    ) => void
    当用户保存问题时触发的回调函数。仅在 `isSaveEnabled = true` 时相关。
  - 可选onVisualizationChange?: (
        display:
            | "object"
            | "table"
            | "bar"
            | "line"
            | "pie"
            | "scalar"
            | "row"
            | "area"
            | "combo"
            | "pivot"
            | "smartscalar"
            | "gauge"
            | "progress"
            | "funnel"
            | "map"
            | "scatter"
            | "waterfall"
            | "sankey"
            | "list",
    ) => void
    当可视化类型更改时触发的回调函数。
  - 可选plugins?: MetabasePluginsConfig
  - questionId: null | SdkQuestionId
  - 可选style?: CSSProperties
    要添加到根元素的自定义样式对象。
  - 可选targetCollection?: SdkCollectionId
    保存问题的集合。这将隐藏保存模态框中的集合选择器。仅适用于交互式问题。
  - 可选title?: SdkQuestionTitleProps
    确定是否显示问题标题，并允许显示自定义标题而不是默认问题标题。默认显示。仅适用于使用默认布局的交互式问题。
  - Optionalwidth?: Width<string | number>
    一个数字或字符串，指定CSS大小值，用于指定组件的宽度
  - 可选withChartTypeSelector?: boolean
    确定是否显示图表类型选择器和相应的设置按钮。仅在使用默认布局时相关。
  - 可选withDownloads?: boolean
    启用在交互式问题中下载结果的功能。
  - 可选withResetButton?: boolean
    确定是否显示重置按钮。仅在使用默认布局时相关。
返回 Element

InteractiveQuestion

返回按钮

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

类型声明

- (props: InteractiveQuestionBackButtonProps): null | Element
- Function
  返回到上一个视图的导航按钮。仅在 InteractiveDashboardProps.renderDrillThroughQuestion 属性内渲染时可见。
  参数
  - props: InteractiveQuestionBackButtonProps
  Returns null | Element

Breakout

Breakout: () => null | Element

类型声明

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

BreakoutDropdown

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

类型声明

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

ChartTypeDropdown

ChartTypeDropdown: (props: MenuProps) => Element

类型声明

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

ChartTypeSelector

ChartTypeSelector: (props: StackProps) => Element

类型声明

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

DownloadWidget

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

类型声明

- (props: StackProps): null | Element
- Function
  提供一个 UI 小部件，用于下载不同格式的数据（根据可视化类型，可以是 CSV、XLSX、JSON 和 PNG）。
  参数
  - props: StackProps
  Returns null | Element

DownloadWidgetDropdown

DownloadWidgetDropdown: (props: PopoverProps) => Element

类型声明

- (props: PopoverProps): Element
- Function
  提供一个包含 DownloadWidget 的下拉按钮。
  参数
  - props: PopoverProps
  返回 Element

编辑器

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

类型声明

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

编辑器按钮

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

类型声明

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

Filter

Filter: (props: InteractiveQuestionFilterProps) => Element

类型声明

- (props: InteractiveQuestionFilterProps): Element
- Function
  一组交互式过滤器徽章，允许添加、编辑和删除过滤器。将当前过滤器显示为徽章，并提供“添加另一个过滤器”选项。
  参数
  - props: InteractiveQuestionFilterProps
    - OptionalwithColumnItemIcon?: boolean
      是否显示列项图标
  返回 Element

FilterDropdown

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

类型声明

- (props: InteractiveQuestionFilterDropdownProps): null | Element
- Function
  Filter 组件的下拉按钮。
  参数
  - props: InteractiveQuestionFilterDropdownProps
    - OptionalwithColumnItemIcon?: boolean
      是否显示列项图标
  Returns null | Element

笔记本

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

类型声明

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

已弃用

请使用 InteractiveQuestion.Editor

笔记本按钮

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

类型声明

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

已弃用

请使用 InteractiveQuestion.EditorButton

QuestionSettings

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

类型声明

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

QuestionSettingsDropdown

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

类型声明

- (props?: InteractiveQuestionQuestionSettingsDropdownProps): Element
- Function
  包含 QuestionSettings 组件的下拉按钮。
  参数
  - Optionalprops: InteractiveQuestionQuestionSettingsDropdownProps
    - Optionalheight?: 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
- Function
  将问题结果渲染为图表、表格或其他可视化类型的核心可视化组件。
  参数
  - props: { className?: string; style?: CSSProperties } & {
    height?: Height<string | number>;
    width?: Width<string | number>;
    } & {}
    - 可选className?: string
      要添加到根元素的自定义类名。
    - 可选style?: CSSProperties
      要添加到根元素的自定义样式对象。
    - Optionalheight?: Height<string | number>
      一个数字或字符串，指定CSS大小值，用于指定组件的高度
    - Optionalwidth?: Width<string | number>
      一个数字或字符串，指定CSS大小值，用于指定组件的宽度
  返回 Element

ResetButton

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

类型声明

- (props?: ButtonProps): null | Element
- Function
  用于重置问题修改的按钮。仅在问题有未保存的更改时出现。
  参数
  - Optionalprops: ButtonProps
  Returns null | Element

保存按钮

SaveButton: (props?: InteractiveQuestionSaveButtonProps) => Element

类型声明

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

保存问题表单

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

类型声明

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

SqlParametersList

SqlParametersList: () => null | Element

类型声明

- (): null | Element
- Function
  SQL 问题的参数列表
  
  Returns null | Element

Summarize

Summarize: () => Element

类型声明

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

SummarizeDropdown

SummarizeDropdown: (props: InteractiveQuestionSummarizeDropdownProps) => Element

类型声明

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

Title

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

类型声明

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

可视化按钮

VisualizationButton: () => null | Element

类型声明

- (): null | Element
- Function
  触发当前问题可视化的按钮。
  
  Returns null | Element

函数 InteractiveQuestion

参数

可选className?: string

OptionalentityTypes?: EmbeddingEntityType[]

Optionalheight?: Height<string | number>

可选hiddenParameters?: string[]

可选initialSqlParameters?: SqlParameterValues

可选isSaveEnabled?: boolean

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

OptionalonNavigateBack?: () => void

OptionalonRun?: (question: undefined | MetabaseQuestion) => void

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

可选onVisualizationChange?: ( display: | "object" | "table" | "bar" | "line" | "pie" | "scalar" | "row" | "area" | "combo" | "pivot" | "smartscalar" | "gauge" | "progress" | "funnel" | "map" | "scatter" | "waterfall" | "sankey" | "list",) => void

可选plugins?: MetabasePluginsConfig

questionId: null | SdkQuestionId

可选style?: CSSProperties

可选targetCollection?: SdkCollectionId

可选title?: SdkQuestionTitleProps

Optionalwidth?: Width<string | number>

可选withChartTypeSelector?: boolean

可选withDownloads?: boolean

可选withResetButton?: boolean

返回 Element

索引

InteractiveQuestion

InteractiveQuestion

返回按钮

类型声明

参数

Returns null | Element

Breakout

类型声明

Returns null | Element

BreakoutDropdown

类型声明

参数

Returns null | Element

ChartTypeDropdown

类型声明

参数

返回 Element

ChartTypeSelector

类型声明

参数

返回 Element

DownloadWidget

类型声明

参数

Returns null | Element

DownloadWidgetDropdown

类型声明

参数

返回 Element

编辑器

类型声明

参数

OptionalhasVisualizeButton?: boolean

OptionalonApply?: () => void

Returns undefined | Element

编辑器按钮

类型声明

参数

OptionalisOpen?: boolean

默认值

OptionalonClick?: MouseEventHandler<HTMLButtonElement>

返回 undefined | false | Element

Filter

类型声明

参数

OptionalwithColumnItemIcon?: boolean

返回 Element

FilterDropdown

类型声明

参数

OptionalwithColumnItemIcon?: boolean

Returns null | Element

笔记本

类型声明

参数

OptionalhasVisualizeButton?: boolean

`可选`className?: string

`Optional`entityTypes?: EmbeddingEntityType[]

`Optional`height?: Height<string | number>

`可选`hiddenParameters?: string[]

`可选`initialSqlParameters?: SqlParameterValues

`可选`isSaveEnabled?: boolean

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

`Optional`onNavigateBack?: () => void

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

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

`可选`onVisualizationChange?: (
display:
| "object"
| "table"
| "bar"
| "line"
| "pie"
| "scalar"
| "row"
| "area"
| "combo"
| "pivot"
| "smartscalar"
| "gauge"
| "progress"
| "funnel"
| "map"
| "scatter"
| "waterfall"
| "sankey"
| "list",
) => void

`可选`plugins?: MetabasePluginsConfig

`可选`style?: CSSProperties

`可选`targetCollection?: SdkCollectionId

`可选`title?: SdkQuestionTitleProps

`Optional`width?: Width<string | number>

`可选`withChartTypeSelector?: boolean

`可选`withDownloads?: boolean

`可选`withResetButton?: boolean

`Optional`hasVisualizeButton?: boolean

`Optional`onApply?: () => void

`Optional`isOpen?: boolean

`Optional`onClick?: MouseEventHandler<HTMLButtonElement>

`Optional`withColumnItemIcon?: boolean

`Optional`withColumnItemIcon?: boolean

`Optional`hasVisualizeButton?: boolean

`Optional`onApply?: () => void

`Optional`isOpen?: boolean

`Optional`onClick?: MouseEventHandler<HTMLButtonElement>

`Optional`height?: Height<string | number>

`可选`className?: string

`可选`style?: CSSProperties

`Optional`height?: Height<string | number>

`Optional`width?: Width<string | number>

`Optional`onClick?: MouseEventHandler<HTMLButtonElement>

`Optional`onCancel?: () => void

`可选`className?: string

`可选`style?: CSSProperties