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

    接口 StaticDashboardProps

    interface StaticDashboardProps {
        className?: string;
        dashboardId: SdkDashboardId;
        dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">;
        hiddenParameters?: string[];
        initialParameters?: ParameterValues;
        onLoad?: (dashboard: null | MetabaseDashboard) => void;
        onLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => void;
        onVisualizationChange?: (
            visualization:
                | "object"
                | "table"
                | "bar"
                | "line"
                | "pie"
                | "scalar"
                | "row"
                | "area"
                | "combo"
                | "pivot"
                | "smartscalar"
                | "gauge"
                | "progress"
                | "funnel"
                | "map"
                | "scatter"
                | "waterfall"
                | "sankey"
                | "list",
        ) => void;
        plugins?: MetabasePluginsConfig;
        style?: CSSProperties;
        withCardTitle?: boolean;
        withDownloads?: boolean;
        withTitle?: boolean;
    }
    索引

    属性

    className? dashboardId dataPickerProps? hiddenParameters? initialParameters? onLoad? onLoadWithoutCards? onVisualizationChange? plugins? style? withCardTitle? withDownloads? withTitle?

    属性

    className?: string

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

    dashboardId: SdkDashboardId

    仪表板的 ID。
    这可以是

    • 访问仪表板链接时使用的数字 ID，例如 `https://:3000/dashboard/1-my-dashboard`，其中 ID 为 `1`
    • 在使用 API 或 SDK 集合浏览器直接返回数据时，在仪表板对象的 `entity_id` 键中找到的字符串 ID
    dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">

    创建新的仪表板问题时，要传递给 `InteractiveQuestion` 渲染的查询构建器的其他属性。

    hiddenParameters?: string[]

    要隐藏的参数列表。

    initialParameters?: ParameterValues

    仪表板的查询参数。对于单个选项，使用 `string` 值；对于多个选项，使用字符串列表。

    onLoad?: (dashboard: null | MetabaseDashboard) => void

    仪表板加载时调用的回调函数。

    onLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => void

    仪表板在没有卡片的情况下加载时调用的回调函数。

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

    当从仪表板卡片打开问题或用户更改问题的可视化类型时触发的回调函数。

    类型声明

      • (
            visualization:
                | "object"
                | "table"
                | "bar"
                | "line"
                | "pie"
                | "scalar"
                | "row"
                | "area"
                | "combo"
                | "pivot"
                | "smartscalar"
                | "gauge"
                | "progress"
                | "funnel"
                | "map"
                | "scatter"
                | "waterfall"
                | "sankey"
                | "list",
        ): void

      • 参数

        • visualization:
              | "object"
              | "table"
              | "bar"
              | "line"
              | "pie"
              | "scalar"
              | "row"
              | "area"
              | "combo"
              | "pivot"
              | "smartscalar"
              | "gauge"
              | "progress"
              | "funnel"
              | "map"
              | "scatter"
              | "waterfall"
              | "sankey"
              | "list"

          the new visualization type

        返回 void

    plugins?: MetabasePluginsConfig

    用于覆盖或添加钻取菜单的附加映射函数。详情请参见实现自定义操作部分。

    style?: CSSProperties

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

    withCardTitle?: boolean

    仪表板卡片是否显示标题。

    withDownloads?: boolean

    是否隐藏下载按钮。

    withTitle?: boolean

    仪表板是否显示标题。

    设置

    本页内容

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