嵌入式分析 SDK

⚠️ 此功能为 Beta 版。欢迎试用,但请注意,功能可能会发生变化(并且可能无法按预期工作)。

嵌入式分析 SDK 仅在 ProEnterprise 计划(包括自托管和 Metabase Cloud)中可用。但是,您可以使用 API 密钥验证您的嵌入,在本地计算机上试用 SDK,而无需许可证。

借助嵌入式分析 SDK,您可以使用 React 嵌入各个 Metabase 组件(例如独立图表、仪表板、查询构建器等)。您可以管理每个组件的访问权限和交互性,并进行高级自定义以实现无缝样式设置。

嵌入式分析 SDK 目前为 Beta 版,但您应该查看并试用一下;您可以使用它完成许多很酷的事情。

使用嵌入式分析 SDK 构建的示例应用

为了让您了解 SDK 的可能性,我们整理了示例网站,网址为 metaba.se/sdk-demo。在三个不同的商店网站之间导航:The Stitch、Luminara Beauty 和 Pug & Play。查看它们并浏览其产品和分析部分,以及“新建问题”和“新建仪表板”选项。

Pug and play example app built with embedding SDK

嵌入式分析 SDK 先决条件

NPM 上的嵌入式分析 SDK

查看 NPM 上的 Metabase 嵌入式分析 SDK:https://npmjs.net.cn/package/@metabase/embedding-sdk-react

CLI 快速入门

如果您已安装 Node 和 Docker,则可以更改为您的 React 应用程序并运行

npx @metabase/embedding-sdk-react@latest start

仅在本地有效,您无需许可证密钥(但您可以使用许可证密钥演示更多功能)。

请参阅有关 CLI 快速入门的更多信息。

我们还有一个使用 JWT 的示例应用的快速入门

安装

您需要在 Metabase 中启用 SDK,并在您的应用中将 SDK 安装为依赖项。

在 Metabase 中

通过转到管理设置 > 设置 > 嵌入来启用嵌入式分析 SDK。打开 SDK,然后点击配置。输入您要允许 SDK 嵌入的网站或应用的来源,以空格分隔。本地主机已自动包含在内。

在您的 React 应用程序中

您可以通过 npm 安装用于 React 的嵌入式分析 SDK

npm install @metabase/embedding-sdk-react@51-stable

或使用 yarn

yarn add @metabase/embedding-sdk-react@51-stable

使用嵌入式分析 SDK 进行开发

嵌入 SDK 源代码

您可以在 Metabase 存储库中找到 嵌入 SDK 源代码

更新日志

查看更新日志

SDK 限制

SDK 不支持

  • 已验证内容
  • 官方集合
  • 订阅
  • 提醒
  • 服务器端渲染 (SSR)。
  • 同一应用程序页面上的多个交互式仪表板。如果您需要在同一应用程序页面上嵌入多个仪表板,则可以嵌入静态仪表板。

反馈

  • 通过电子邮件发送至团队:[email protected]
  • 在 Slack 上向团队发送消息。如果您没有设置 Slack 频道,请通过电子邮件联系我们:[email protected]

阅读其他Metabase 版本的文档。