Skip to content

Commit bef0006

Browse files
committed
feat:优化 嵌入式指南
1 parent 3908d43 commit bef0006

File tree

6 files changed

+29
-17
lines changed

6 files changed

+29
-17
lines changed

docs/embedded/app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
!!! Abstract ""
22
点击【系统设置】,进入【嵌入式管理】页面创建嵌入式应用。
33

4-
**注意:嵌入式 License 最多可创建 5 个嵌入式应用,其它版本无此限制。**
4+
**注意:嵌入式版本最多可创建 5 个嵌入式应用,其它版本无此限制。**
55

66
!!! Abstract ""
77
嵌入式应用创建后,可以获取 APP ID、APP Secret。

docs/embedded/div.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
DIV 嵌入的初始化图表不依赖监听触发,DIV 嵌入需要定义好容器的大小 。
77

8-
**注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见常见问题 4.2。**
8+
**注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见[嵌入式常见问题 2](https://dataease.io/docs/v2/embedded/question/#2-iframe-div)。**
99

1010
## 1 仪表板嵌入
1111
!!! Abstract ""
@@ -410,7 +410,10 @@
410410
```
411411
### 3.1 数据大屏双向参数传递
412412
!!! Abstract ""
413-
参考 DIV 仪表板双向参数传递以及 DIV 数据大屏嵌入,将相应 busiFlag 修改对应。
413+
参考 [1.1 仪表板双向参数传递](https://dataease.io/docs/v2/embedded/div/#11)以及 [3 数据大屏嵌入](https://dataease.io/docs/v2/embedded/div/#3),将相应 busiFlag 修改对应。
414+
415+
- 仪表板图表 busiFlag: dashboard
416+
- 数据大屏图表 busiFlag: dataV
414417

415418
## 4 数据大屏设计器嵌入
416419
!!! Abstract ""
@@ -516,7 +519,7 @@
516519
```
517520
### 5.1 图表双向参数传递
518521
!!! Abstract ""
519-
参考 DIV 仪表板双向参数传递以及 DIV 图表嵌入。
522+
参考 [1.1 仪表板双向参数传递](https://dataease.io/docs/v2/embedded/div/#11)以及 [5 图表嵌入](https://dataease.io/docs/v2/embedded/div/#5)
520523

521524
## 6 我的填报嵌入
522525
!!! Abstract ""

docs/embedded/iframe.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
使用 postMessage 方式实现 DataEase 和嵌入系统的页面信息交互。
55

6-
(postMessage 是挂载在 window下的一个方法,用于不同域名下的两个页面的信息交互,父子页面通过 postMessage()发送消息,再通过监听 message 事件接收信息。)Iframe 嵌入必须在监听触发后,再初始化图表。
6+
(postMessage 是挂载在 window下的一个方法,用于不同域名下的两个页面的信息交互,父子页面通过 postMessage() 发送消息,再通过监听 message 事件接收信息。)Iframe 嵌入必须在监听触发后,再初始化图表。
77

8-
**注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见常见问题 4.2。**
8+
**注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见[嵌入式常见问题 2](https://dataease.io/docs/v2/embedded/question/#2-iframe-div)。**
99

1010
## 1 仪表板嵌入
1111
!!! Abstract ""
@@ -103,9 +103,9 @@
103103
!!! Abstract ""
104104
第三方系统向 DataEase 传参,依赖于 DataEase 仪表板/数据大屏外部参数实现。
105105

106-
1.初始化看板时,由第三方系统向 DataEase 传参过滤数据。
107-
a) 公共链接拼接 attachParams 过滤数据。
106+
1.初始化看板时,由第三方系统向 DataEase 传参过滤数据。</br>
108107

108+
a) 公共链接拼接 attachParams 过滤数据。
109109
```
110110
#
111111
一、公共链接嵌入(数据不敏感或内网环境可用,使用 ticket 的方式会较为安全)。
@@ -380,7 +380,7 @@
380380
],
381381
"quotaList": [ ]}
382382
```
383-
383+
示例代码:
384384
```
385385
#
386386
二、DataEase 嵌入式推荐的 iframe 嵌入
@@ -517,7 +517,7 @@
517517

518518
## 3 数据大屏嵌入
519519
!!! Abstract ""
520-
数据大屏嵌入支持嵌入整个数据大屏,用户可以浏览嵌入的数据大屏,数据大屏嵌入还支持外部参数设置。
520+
可以将数据大屏嵌入到第三方业务系统中,用户通过第三方系统访问数据大屏,同时支持外部参数过滤设置。
521521

522522
```
523523
#
@@ -603,11 +603,14 @@
603603
```
604604
### 3.1 数据大屏双向参数传递
605605
!!! Abstract ""
606-
参考 Ifram 仪表板双向参数传递以及 Iframe 数据大屏嵌入,将相应 busiFlag 修改对应。
606+
参考 [1.1 仪表板双向参数传递](https://dataease.io/docs/v2/embedded/iframe/#11)以及 [3 数据大屏嵌入](https://dataease.io/docs/v2/embedded/iframe/#3)。以及 Iframe 数据大屏嵌入,将相应 busiFlag 修改对应。
607+
608+
- 仪表板图表 busiFlag: dashboard
609+
- 数据大屏图表 busiFlag: dataV
607610

608611
## 4 数据大屏设计器嵌入
609612
!!! Abstract ""
610-
数据大屏设计器嵌入支持嵌入整个数据大屏设计器界面,用户不仅可以浏览嵌入的数据大屏,还可以对其进行编辑:
613+
支持嵌入整个数据大屏设计器界面,用户不仅可以浏览嵌入的数据大屏,还可以对其进行编辑:
611614

612615
```
613616
#
@@ -828,7 +831,7 @@
828831

829832
### 7.1 仪表板模块
830833
!!! Abstract ""
831-
嵌入整个仪表板模块后,可以实现对仪表板模块的整体使用,包括新建、编辑和删除仪表板
834+
嵌入整个仪表板模块后,可以实现对仪表板模块的整体使用,包括新建、编辑和删除仪表板
832835

833836
```
834837
#

docs/embedded/process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
!!! Abstract ""
33
DataEase 支持使用 Iframe 以及 DIV 进行嵌入,两种方法的流程如下。
44

5-
**注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见常见问题 4.2。**
5+
**注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见[嵌入式常见问题 2](https://dataease.io/docs/v2/embedded/question/#2-iframe-div)。**
66
### 1.1 DIV 嵌入式流程
77

88
!!! Abstract ""

docs/embedded/setting.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
!!! Abstract ""
2-
注意;本文当所使用代码均为嵌入式官方 [demo 代码](https://github.com/dataease/embedded-demo/tree/isv-embedded-demo)。并在此基础上进行代码的修改进行演示。
2+
注意:本文档所使用代码均为嵌入式官方 [demo 代码](https://github.com/dataease/embedded-demo/tree/isv-embedded-demo)。并在此基础上进行代码的修改进行演示。
33

44
## 1 嵌入式 Token
55
!!! Abstract ""
66
采用 JWT 认证 ,官方嵌入式代码生成 token 方式如下,需要获取 DataEase 嵌入式应用的 APP ID、APP Secret,以及 DataEase 中的用户账号。
77

8+
- APP ID:嵌入式获取 JWT token 需要填写的 ID。
9+
10+
- APP Secret :嵌入式获取 JWT token 需要填写的 Secret。
11+
812
2.10.0 版本开始,支持设置 token 有效时间。 Token 可根据实际情况使用其它类型语言生成,代码实现方式不唯一。
913

1014
```
@@ -63,7 +67,7 @@
6367
**注意:需要将 js 引入到页面的 head 中,保证依赖的正确加载。**
6468

6569
```
66-
## {domain}js/div_import_0.0.0-dataease.js DataEase 提供好的 js 模版,
70+
## 将下方代码中的 src 地址改为静态 js 的访问地址即可。
6771
## 访问地址为 http://ip:9080/js/div_import_0.0.0-dataease.js
6872
<script crossorigin type="module" th:src="@{{domain}/js/div_import_0.0.0-dataease.js(domain=${vo.domain})}"></script>
6973
```

docs/embedded/summary.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
![1.1嵌入模块说明.jpg](../img/embedded/1.1嵌入模块说明.jpg){ width="900px" }
88

99
!!! Abstract ""
10-
DataEase 嵌入式支持 DIV 和 Iframe 两种嵌入方式,支持按照单个可视化资源,以及现有数据集、数据源、数据大屏、仪表板等完整模块的嵌入。可根据需要自行选择对应方式进行丰富的嵌入需求
10+
DataEase 嵌入式支持 DIV 和 Iframe 两种嵌入方式,支持按照单个可视化资源,以及现有数据集、数据源、数据大屏、仪表板等完整模块的嵌入。可根据需要自行选择对应方式进行嵌入
1111

1212
DataEase 同时提供了丰富的 API 接口,包括仪表板管理、数据大屏管理,数据集管理、权限管理、用户管理等模块,可根据实际的业务需求调用 DataEase 的接口完成业务要求,API 说明入口位于 【系统设置】->【API Key】->【查看 API】。
1313
![1.1嵌入式BI功能架构(1).png](../img/embedded/1.1嵌入式BI功能架构(1).png){ width="900px" }
@@ -18,6 +18,8 @@
1818
[官方演示环境](https://embedded-bi.dataease.cn/#/home/index),嵌入式官方体验环境,可查看嵌入式效果。
1919

2020
官方 demo 代码, [Layui 框架代码](https://github.com/dataease/embedded-demo/tree/main) ,[Vue3 代码](https://github.com/dataease/embedded-demo/tree/isv-embedded-demo) 。
21+
22+
**注意:如果项目的前端使用的是 Vue3 的框架,建议参考 Vue3 的代码进行嵌入;其他前端框架可参考 LayUl 框架的代码进行嵌入。**
2123
!!! Abstract ""
2224
数据大屏及数据大屏设计器嵌入。
2325
![1.2 嵌入场景预览(1)](../img/embedded/1.2 嵌入场景预览(1).PNG){ width="900px" }

0 commit comments

Comments
 (0)