嵌入式分析 SDK API
    正在准备搜索索引...

    函数 StaticQuestion

    • 渲染静态问题的组件。

      参数

      • props: StaticQuestionProps
        • 可选className?: string

          要添加到根元素的自定义类名。

        • Optionalheight?: Height<string | number>

          一个数字或字符串，指定CSS大小值，用于指定组件的高度

        • 可选hiddenParameters?: string[]

          要隐藏的参数列表。

        • 可选initialSqlParameters?: SqlParameterValues

          SQL参数的初始值。

        • questionId: null | SdkQuestionId
        • 可选style?: CSSProperties

          要添加到根元素的自定义样式对象。

        • 可选title?: SdkQuestionTitleProps

          确定是否显示问题标题，并允许显示自定义标题而不是默认问题标题。默认显示。仅适用于使用默认布局的交互式问题。

        • Optionalwidth?: Width<string | number>

          一个数字或字符串，指定CSS大小值，用于指定组件的宽度

        • 可选withChartTypeSelector?: boolean

          确定是否显示图表类型选择器和相应的设置按钮。仅在使用默认布局时相关。

        • 可选withDownloads?: boolean

          启用在交互式问题中下载结果的功能。

      返回 Element

    索引

    InteractiveQuestion

    分组 分组下拉菜单 图表类型下拉菜单 图表类型选择器 下载组件 下载组件下拉菜单 筛选器 筛选器下拉菜单 问题设置 问题设置下拉菜单 问题可视化 重置按钮 SQL参数列表 摘要 摘要下拉菜单 标题

    InteractiveQuestion

    Breakout: () => null | Element

    类型声明

      • (): null | Element
      • Function

        用于管理数据分组（拆分）的一组徽章。使用问题上下文进行拆分功能。

        Returns null | Element

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

    类型声明

    ChartTypeDropdown: (props: MenuProps) => Element

    类型声明

      • (props: MenuProps): Element
      • Function

        用于选择可视化类型的下拉菜单（条形图、折线图、表格等）。会自动更新以显示当前数据的推荐可视化类型。

        参数

        返回 Element

    ChartTypeSelector: (props: StackProps) => Element

    类型声明

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

    类型声明

      • (props: StackProps): null | Element
      • Function

        提供一个 UI 小部件，用于下载不同格式的数据（根据可视化类型，可以是 CSV、XLSX、JSON 和 PNG）。

        参数

        Returns null | Element

    DownloadWidgetDropdown: (props: PopoverProps) => Element

    类型声明

    Filter: (props: InteractiveQuestionFilterProps) => Element

    类型声明

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

    类型声明

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

    类型声明

      • (props: StackProps): null | Element
      • Function

        用于配置可视化选项（如轴、颜色和格式）的设置面板。使用问题上下文进行设置。

        参数

        Returns null | Element

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

    类型声明

    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: (props?: ButtonProps) => null | Element

      类型声明

        • (props?: ButtonProps): null | Element
        • Function

          用于重置问题修改的按钮。仅在问题有未保存的更改时出现。

          参数

          Returns null | Element

      SqlParametersList: () => null | Element

      类型声明

        • (): null | Element
        • Function

          SQL 问题的参数列表

          Returns null | Element

      Summarize: () => Element

      类型声明

        • (): Element
        • Function

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

          返回 Element

      SummarizeDropdown: (props: InteractiveQuestionSummarizeDropdownProps) => Element

      类型声明

      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

      设置

      本页内容

      InteractiveQuestion
      © . This site is unofficial and not affiliated with Metabase, Inc.