嵌入式分析 SDK
通过嵌入式分析 SDK,您可以使用 React 嵌入 Metabase 的各个组件(例如独立的图表、仪表板、查询构建器等)。您可以管理每个组件的访问和交互性,并进行高级自定义以实现无缝样式设置。
使用嵌入式分析 SDK 构建的示例应用
为了让您了解 SDK 的可能性,我们整理了 metaba.se/sdk-demo 上的示例网站。您可以在不同的商店网站之间导航。查看并探索他们的产品和分析部分,以及“新建问题”和“新建仪表板”选项。
这是 Shoppy 源代码。
嵌入式分析 SDK 先决条件
- 使用 React 18 或 React 19 的 React 应用程序。
- Nodejs 20.x 或更高版本。
- Metabase 1.52 版或更高版本。
快速入门
- 快速入门(如果您有 Metabase 和一个应用程序)
- CLI 快速入门(如果您有应用程序,但没有 Metabase)
- React 示例应用快速入门(如果您两者都没有)
安装
要使用 SDK,您需要在 Metabase 中启用 SDK,并在您的 React 应用程序中安装 SDK。
在 Metabase 中启用 SDK
通过访问 Admin settings > Settings > Embedding 启用嵌入式分析 SDK。切换打开 SDK,然后点击配置。输入您希望允许 SDK 嵌入的网站或应用程序的来源,用空格分隔。localhost 会自动包含在内。
在您的 React 应用程序中安装 SDK
您可以通过 npm 安装用于 React 的嵌入式分析 SDK。请确保使用与您的 Metabase 版本对应的 dist-tag,例如:Metabase 53 的 53-stable
npm install @metabase/embedding-sdk-react@53-stable
或使用 yarn
yarn add @metabase/embedding-sdk-react@53-stable
使用嵌入式分析 SDK 进行开发
从其中一个快速入门开始,然后查看这些页面以获取有关组件、主题等的更多信息。
嵌入式分析 SDK 源代码
您可以在Metabase 仓库中找到嵌入式分析 SDK 源代码。
更新日志
查看 SDK 更新日志
NPM 上的嵌入式分析 SDK
在 NPM 上查看 Metabase 嵌入式分析 SDK:metaba.se/sdk。
SDK 限制
SDK 不支持
- 验证内容
- 官方集合
- 订阅
- 警报
- 服务器端渲染 (SSR)
- 同一应用程序页面上的多个交互式仪表板。如果需要在同一应用程序页面上嵌入多个仪表板,您可以嵌入静态仪表板。
问题、功能请求和支持
您可以通过在问题上留下点赞表情符号来投票支持现有功能请求。欢迎留下带有有用上下文的评论。了解更多。
在创建新问题之前,请确保您的问题或功能请求的 issue 尚未存在。如需寻求帮助
- 付费客户可以通过常规渠道联系我们的成功团队。
- 使用开源版本的用户可以在我们的讨论论坛上发帖。
阅读其他Metabase 版本的文档。