嵌入式分析SDK

⚠️ 此功能处于测试阶段。您可以自由地尝试它,但请注意,某些内容可能会发生变化(并且可能无法按预期工作)。

嵌入式分析SDK仅在Pro企业版计划(包括自托管和Metabase Cloud)上提供。不过,您可以通过使用API密钥进行身份验证,在本地机器上无需许可证即可尝试SDK。

使用嵌入式分析SDK,您可以使用React(如独立图表、仪表板、查询构建器等)嵌入单个Metabase组件。您可以根据组件管理访问和交互,并拥有高级自定义以实现无缝样式。

嵌入式分析SDK目前处于测试阶段,但您应该试用它并对其进行测试;您可以用它做很多事情。

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

为了给您一个使用SDK的示例,我们已在metaba.se/sdk-demo上构建了示例网站。在三个不同的商店网站之间进行导航:Stitch、Luminara Beauty和Pug & Play。查看它们并探索它们的产品和数据分析部分,以及“新建问题”和“新建仪表板”选项。

Pug and play example app built with embedding SDK

嵌入式分析SDK的先决条件

NPM上的嵌入式分析SDK

查看Metabase嵌入式分析SDK在NPM上的信息:metaba.se/sdk

使用 CLI 快速入门

如果您已安装Node和Docker,您可以将React应用程序切换到当前目录并运行

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

仅在本地工作,并且不需要许可证密钥(但您可以使用它来演示更多功能)。

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

我们还提供了一个使用JWT的示例应用程序快速入门

安装

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

在Metabase中

通过访问管理员设置 > 设置 > 嵌入来启用嵌入式分析SDK。打开SDK,然后点击配置。输入您希望允许SDK嵌入的网站或应用程序的来源,用空格分隔。本地主机将自动包含在内。

在您的React应用程序中

您可以通过npm安装嵌入式分析SDK for React

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

或使用yarn

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

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

嵌入SDK源代码

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

变更日志

查看变更日志

SDK限制

SDK不支持

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

反馈

阅读关于其他Metabase版本的文档。

想要改进这些文档吗? 提出更改。