You need to enable JavaScript to run this app.
导航

URL配置

最近更新时间2023.05.26 20:14:25

首次发布时间2022.10.27 11:06:22

1. 获得 URL 链接

注意

  • 如下两种方式均可获得目标仪表盘/图表/大屏的链接,得到的结果是一致的
  • 仪表盘移动端则只能按照第二种方式获得

1.1 直接在 DataWind 中获得

1.1.1 仪表盘/图表

仪表盘和图表嵌出所述,直接获得仪表盘/图表的链接。
注意:直接选择嵌出即可,即如下状态所示,不用勾选

1.1.2 大屏

如图在列表页选择查看,打开之后浏览器获得URL即可

1.2 自行拼接

选择自行拼接,则按照如下方式进行,划下划线内容是变量,在如下参数详解要解释的,其他为固定内容
仪表盘 $HOST/#/external/dashboard/DASHBOARD_ID?appId=APP_ID&inline=true
比如:

https://console.volcengine.com/bi/datawind/#/external/dashboard/47610?appId=1010681&inline=true

移动端仪表盘 $HOST-h5/dashboard/?appId=APP_ID&id=DASHBOARD_ID&inline=true
比如:

https://console.volcengine.com/bi/datawind-h5/dashboard/?appId=1010681&id=47610&inline=true

注意

移动端链接只能移动端设备访问,如果该链接在PC端打开,则默认跳转为PC端链接

图表 $HOST/#/external/dashboard/DASHBOARD_ID/REPORT_ID?appId=APP_ID&inline=true
比如:

https://console.volcengine.com/bi/datawind/#/external/dashboard/47610/305962?appId=1010681&inline=true

大屏
$HOST/vScreen/preview?appId=APP_ID&id=VSCREEN_ID&resizeMode=auto
比如:

https://console.volcengine.com/bi/datawind/#/vScreen/preview?appId=1010681&id=11&resizeMode=auto

参数详解:

参数说明

$HOST

  • SaaS环境设置为https://console.volcengine.com/bi/datawind
  • 私有化部署环境替换为产品部署的域名

$HOST-h5

移动端的域名

  • SaaS环境设置为https://console.volcengine.com/bi/datawind-h5
  • 私有化部署环境替换为产品移动端部署的域名
APP_IDDataWind的项目ID;获取方式见该文档
DASHBOARD_ID仪表盘ID;获取方式见该文档
REPORT_ID图表ID;获取方式见该文档
VSCREEN_ID大屏ID,获取方式见该文档
2. 在 iframe 中使用

如下代码嵌入了SaaS环境的仪表盘

<iframe src='https://console.volcengine.com/bi/datawind/#/external/dashboard/******?appId=******&inline=true'>
3. 在 SDK 中使用

在组件上传入 urlPrefix 参数以指定访问的地址。

import React from 'react'
import ReactDOM from 'react-dom'

class BIComponent extends React.Component {
  render() {
    return (
      <bi-dashboard
        urlPrefix='https://console.volcengine.com/bi/datawind'
        appId='******'
        dashboardId='******'
      />
    )
  }
}

ReactDOM.render(<BIComponent />, document.querySelector('body'))