Docs 菜单

Docs 主页查看和分析数据Atlas 图表

嵌入式 SDK

在此页面上

  • 安装嵌入式 SDK
  • 举例

您可以使用嵌入 SDK 将图表或仪表盘嵌入到 Web 应用程序中,从而能够更灵活地调整设置和呈现。

要了解详情,请参阅开始使用嵌入 SDK

如果您有简单的网络应用程序,则无需安装,通过脚本标签即可引用嵌入式 SDK。您可以使用 UMD 直接在浏览器中运行 @mongodb-js/charts-embed-sdk

<script src="https://unpkg.com/@mongodb-js/charts-embed-dom"></script>

如果您正在构建更复杂的网络应用程序,并且正在使用 npmyarn,则可以安装嵌入式 SDK,直接通过脚本文件加以使用。

要安装带有 npm 的嵌入式 SDK,请使用以下命令:

npm install @mongodb-js/charts-embed-dom

要使用 yarn 进行安装:

yarn add @mongodb-js/charts-embed-dom

codesandbox.io 提供了使用嵌入式 SDK 的 示例应用程序。该示例应用程序演示了嵌入式 SDK 可用的一些交互功能,包括交互式筛选和手动刷新按钮。

为此示例应用配置了一个图表 ID 和特定于此应用的基本 URL。请务必为您自己的应用配置正确的图表 ID 或仪表盘 ID 以及基本 URL。

此示例应用使用两种 SDK 方法:

方法
说明
参数
返回:
refresh()
使用数据源中的最新数据重新加载图表。
承诺<void>
setFilter()

根据指定的 MQL 筛选文档筛选嵌入式图表。

注意

筛选器中包含的所有字段都必须在“Embed Chart”(嵌入图表)模式中指定。请参阅使用 SDK 筛选嵌入式图表

filter 对象
承诺<void>

MongoDB Embedding SDK Examples GitHub 存储库中提供了其他示例。

←  筛选嵌入式仪表盘开始使用嵌入式 SDK →