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

    函数 StaticDashboard

    • 一个轻量级的仪表板组件。

      参数

      • props: StaticDashboardProps
        • 可选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

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

        • 可选plugins?: MetabasePluginsConfig

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

        • 可选style?: CSSProperties

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

        • 可选withCardTitle?: boolean

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

        • 可选withDownloads?: boolean

          是否隐藏下载按钮。

        • 可选withTitle?: boolean

          仪表板是否显示标题。

      返回 Element

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