嵌入式仪表盘选项

在此页面上

嵌入式仪表盘选项

仪表盘配置
getChart('<chartID>')
setAutoRefresh()
setMaxDataAge()
setTheme(theme: 'dark' | 'light')
仪表盘配置示例

嵌入式 SDK 提供了 JavaScript createDashboard()方法，用于在网页中呈现仪表盘。您可以使用选项来控制仪表盘的许多方面（例如，高度和宽度）。

例子

以下示例演示如何使用createDashboard方法以及指定仪表盘高度和宽度的选项。

const dashboard = sdk.createDashboard({
  dashboardId: "8d4dff93-e7ca-4ccd-a622-e20e8a100197",
  baseUrl: "https://charts.mongodb.com/dashboards-embedding-examples-hmewt",
  height: 300,
  width: 400
});

嵌入式仪表盘选项

createDashboard()方法采用以下选项：

选项	类型	说明	必需？
`autoRefresh`	布尔	指定仪表盘是否自动刷新的标志。如果省略，仪表盘不会自动刷新。将此选项与`maxDataAge`选项一起使用可配置仪表盘自动刷新频率。	no
`background`	字符串	应用于仪表盘的背景颜色，而不是`theme`背景。您可以指定：颜色十六进制代码 CSS颜色名称使用以下值的透明背景 `transparent` 如果省略，背景颜色默认为当前的`theme` ： `#F1F5F4` 对于`light`主题，或 `#12212C` 为`dark`主题。	no
`baseUrl`	字符串	仪表盘的基本 URL。	是
`dashboardId`	字符串	标识仪表盘的唯一字符串。	是
`getUserToken`	对象	返回`base64`编码的JSON web token令牌的函数。Charts 会验证此令牌，以确定是否呈现经过身份验证的仪表盘。如果启用了经过身份验证的访问权限，则仅当Charts可以使用配置的身份验证提供程序来验证令牌时， Atlas Charts才会呈现经过身份验证的仪表盘视图。如果令牌无效， Charts将不会呈现仪表盘。如果启用了未经身份验证的访问权限， Atlas Charts将始终呈现未经身份验证的仪表盘视图。要学习；了解更多信息，请参阅使用自定义JSON web token提供程序嵌入经过身份验证的图表。	no
`height`	数字	仪表盘的高度。如果省略，它默认为其container的高度。如果提供的值没有单位，则默认为像素 (px)。	no
`maxDataAge`	数字	加载或刷新仪表盘时从缓存加载的数据的最长期限。如果省略，则仅当数据不足一小时时，Atlas Charts 才会使用缓存中的数据呈现仪表盘。如果缓存中的数据超过一小时，则 Charts 会向数据源查询最新数据，刷新缓存，并使用此数据呈现仪表盘。要了解 Atlas Charts 在加载或刷新基于`autoRefresh`和`maxDataAge`值的仪表盘时如何从缓存加载数据，请参阅刷新和数据缓存行为。	no
`showAttribution`	布尔	指定是否在仪表盘下方显示 MongoDB徽标。默认为`true` 。	no
`theme`	字符串	在仪表盘上使用的主题。以下选项有效： `light` 用于带有深色文本和仪表盘元素的浅色背景，或 `dark` 用于带有浅色文本和仪表盘元素的深色背景。如果省略，则默认为`light` 。	no
`width`	数字	仪表盘的宽度。如果省略，它默认为其container的宽度。如果指定一个没有单位的值，则默认为像素 (px)。	no

创建仪表盘后，您可以通过调用DashboardsEmbedSDK.createDashboard({ ... })返回的Dashboard实例上的方法来控制仪表盘的配置。

仪表盘配置

创建仪表盘后，您可以通过调用DashboardsEmbedSDK.createDashboard({ ... })返回的Dashboard实例上的方法来控制仪表盘的配置。

`getChart('<chartID>')`

使用图表的chartId字符串从嵌入式仪表盘中检索特定图表。调用此方法后，您可以在图表上突出显示元素或筛选数据。

`setAutoRefresh()`

指定仪表盘是否自动刷新的标志。如果省略，仪表盘不会自动刷新。

将此方法与setMaxDataAge方法结合使用可配置仪表盘的刷新频率。

`setMaxDataAge()`

加载或刷新仪表盘时从缓存加载的数据的最长期限。如果省略，则仅当数据不足一小时时，Atlas Charts 才会使用缓存中的数据呈现仪表盘。

如果缓存中的数据超过一小时，则 Charts 会向数据源查询最新数据，刷新缓存，并使用此数据呈现仪表盘。

要了解 Atlas Charts 在加载或刷新基于setAutoRefresh和setMaxDataAge值的仪表盘时如何从缓存加载数据，请参阅刷新和数据缓存行为。

`setTheme(theme: 'dark' | 'light')`

嵌入式仪表盘的当前主题。将主题设置为dark时，请确保仪表盘的背景颜色具有适当的对比度，以便信息可见。

提示

另请参阅：

仪表盘配置示例

示例代码片段为名为dashboard的仪表盘实例配置以下选项：

主题为 dark
自动刷新频率为每 60 秒一次

dashboard.setTheme("dark");
dashboard.setAutoRefresh(true);
dashboard.setMaxDataAge(60);

后退

选项

来年

iframe