Skip to content

Commit 681eae7

Browse files
committed
Deployed bef0006 to v2 with MkDocs 1.6.1 and mike 1.1.2
1 parent 4218a95 commit 681eae7

File tree

9 files changed

+197
-179
lines changed

9 files changed

+197
-179
lines changed

v2/embedded/app/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4450,7 +4450,7 @@ <h1>App</h1>
44504450

44514451
<div class="admonition abstract">
44524452
<p>点击【系统设置】,进入【嵌入式管理】页面创建嵌入式应用。</p>
4453-
<p><strong>注意:嵌入式 License 最多可创建 5 个嵌入式应用,其它版本无此限制。</strong></p>
4453+
<p><strong>注意:嵌入式版本最多可创建 5 个嵌入式应用,其它版本无此限制。</strong></p>
44544454
</div>
44554455
<div class="admonition abstract">
44564456
<p>嵌入式应用创建后,可以获取 APP ID、APP Secret。</p>

v2/embedded/div/index.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4865,7 +4865,7 @@ <h1>DIV 嵌入</h1>
48654865
<p>DIV 嵌入支持嵌入单个数据大屏、仪表板,图表资源。也支持数据集、数据源,仪表板,数据大屏等模块嵌入,提供一个模块的完整能力,可根据实际需要进行选择。</p>
48664866
<p>DIV 嵌入需引入 DataEase 嵌入式 JS。</p>
48674867
<p>DIV 嵌入的初始化图表不依赖监听触发,DIV 嵌入需要定义好容器的大小 。</p>
4868-
<p><strong>注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见常见问题 4.2</strong></p>
4868+
<p><strong>注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见<a href="https://dataease.io/docs/v2/embedded/question/#2-iframe-div">嵌入式常见问题 2</a></strong></p>
48694869
</div>
48704870
<h2 id="1">1 仪表板嵌入<a class="headerlink" href="#1" title="Permanent link">&para;</a></h2>
48714871
<div class="admonition abstract">
@@ -5253,7 +5253,11 @@ <h2 id="3">3 数据大屏嵌入<a class="headerlink" href="#3" title="Permanent
52535253
</div>
52545254
<h3 id="31">3.1 数据大屏双向参数传递<a class="headerlink" href="#31" title="Permanent link">&para;</a></h3>
52555255
<div class="admonition abstract">
5256-
<p>参考 DIV 仪表板双向参数传递以及 DIV 数据大屏嵌入,将相应 busiFlag 修改对应。</p>
5256+
<p>参考 <a href="https://dataease.io/docs/v2/embedded/div/#11">1.1 仪表板双向参数传递</a>以及 <a href="https://dataease.io/docs/v2/embedded/div/#3">3 数据大屏嵌入</a>,将相应 busiFlag 修改对应。</p>
5257+
<ul>
5258+
<li>仪表板图表 busiFlag: dashboard</li>
5259+
<li>数据大屏图表 busiFlag: dataV</li>
5260+
</ul>
52575261
</div>
52585262
<h2 id="4">4 数据大屏设计器嵌入<a class="headerlink" href="#4" title="Permanent link">&para;</a></h2>
52595263
<div class="admonition abstract">
@@ -5357,7 +5361,7 @@ <h2 id="5">5 图表嵌入<a class="headerlink" href="#5" title="Permanent link">
53575361
</div>
53585362
<h3 id="51">5.1 图表双向参数传递<a class="headerlink" href="#51" title="Permanent link">&para;</a></h3>
53595363
<div class="admonition abstract">
5360-
<p>参考 DIV 仪表板双向参数传递以及 DIV 图表嵌入。</p>
5364+
<p>参考 <a href="https://dataease.io/docs/v2/embedded/div/#11">1.1 仪表板双向参数传递</a>以及 <a href="https://dataease.io/docs/v2/embedded/div/#5">5 图表嵌入</a></p>
53615365
</div>
53625366
<h2 id="6">6 我的填报嵌入<a class="headerlink" href="#6" title="Permanent link">&para;</a></h2>
53635367
<div class="admonition abstract">

v2/embedded/iframe/index.html

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4864,8 +4864,8 @@ <h1>Iframe 嵌入</h1>
48644864
<div class="admonition abstract">
48654865
<p>Iframe 嵌入支持嵌入单个数据大屏、仪表板,图表资源。也支持数据集、数据源,仪表板,数据大屏等模块嵌入,提供一个模块的完整能力,可根据实际需要进行选择。</p>
48664866
<p>使用 postMessage 方式实现 DataEase 和嵌入系统的页面信息交互。</p>
4867-
<p>(postMessage 是挂载在 window下的一个方法,用于不同域名下的两个页面的信息交互,父子页面通过 postMessage()发送消息,再通过监听 message 事件接收信息。)Iframe 嵌入必须在监听触发后,再初始化图表。</p>
4868-
<p><strong>注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见常见问题 4.2</strong></p>
4867+
<p>(postMessage 是挂载在 window下的一个方法,用于不同域名下的两个页面的信息交互,父子页面通过 postMessage() 发送消息,再通过监听 message 事件接收信息。)Iframe 嵌入必须在监听触发后,再初始化图表。</p>
4868+
<p><strong>注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见<a href="https://dataease.io/docs/v2/embedded/question/#2-iframe-div">嵌入式常见问题 2</a></strong></p>
48694869
</div>
48704870
<h2 id="1">1 仪表板嵌入<a class="headerlink" href="#1" title="Permanent link">&para;</a></h2>
48714871
<div class="admonition abstract">
@@ -4960,9 +4960,9 @@ <h3 id="11">1.1 仪表板双向参数传递<a class="headerlink" href="#11" titl
49604960
<p>双向传参应用场景: </br></p>
49614961
<div class="admonition abstract">
49624962
<p>第三方系统向 DataEase 传参,依赖于 DataEase 仪表板/数据大屏外部参数实现。</p>
4963-
<p>1.初始化看板时,由第三方系统向 DataEase 传参过滤数据。
4964-
a) 公共链接拼接 attachParams 过滤数据。</p>
4965-
<p><div class="highlight"><pre><span></span><code>#
4963+
<p>1.初始化看板时,由第三方系统向 DataEase 传参过滤数据。</br></p>
4964+
<p>a) 公共链接拼接 attachParams 过滤数据。
4965+
<div class="highlight"><pre><span></span><code>#
49664966
一、公共链接嵌入(数据不敏感或内网环境可用,使用 ticket 的方式会较为安全)。
49674967
1、获取仪表板公共链接
49684968
2、定义一个 iframe 容器,并且设置好宽高。
@@ -5199,7 +5199,7 @@ <h3 id="11">1.1 仪表板双向参数传递<a class="headerlink" href="#11" titl
51995199
<p>DataEase 向第三方系统传参 </br></p>
52005200
<p>查看看板时,可点击 DataEase 里的各个组件,向第三方系统传递当前点击的内容,具体内容可通过解析传递的 message,获取相应的信息。</p>
52015201
<p>以下为 DataEase 传递内部消息的解析后得到的参数例子,这些参数均可以在 DataEase 获取数据大屏的接口详情里得到。</p>
5202-
<div class="highlight"><pre><span></span><code>1.完整 data json 如下。
5202+
<p><div class="highlight"><pre><span></span><code>1.完整 data json 如下。
52035203
{
52045204
&quot;msgOrigin&quot;: &quot;de-fit2cloud&quot;,
52055205
&quot;type&quot;: &quot;dataease-embedded-interactive&quot;,
@@ -5228,6 +5228,7 @@ <h3 id="11">1.1 仪表板双向参数传递<a class="headerlink" href="#11" titl
52285228
],
52295229
&quot;quotaList&quot;: [ ]}
52305230
</code></pre></div>
5231+
示例代码:
52315232
<div class="highlight"><pre><span></span><code>#
52325233
二、DataEase 嵌入式推荐的 iframe 嵌入
52335234
1、iframe 嵌入需要先在 application.yml 里添加 origin-list
@@ -5293,7 +5294,7 @@ <h3 id="11">1.1 仪表板双向参数传递<a class="headerlink" href="#11" titl
52935294
}
52945295

52955296
&lt;/script&gt;
5296-
</code></pre></div>
5297+
</code></pre></div></p>
52975298
</div>
52985299
<h2 id="2">2 仪表板设计器嵌入<a class="headerlink" href="#2" title="Permanent link">&para;</a></h2>
52995300
<div class="admonition abstract">
@@ -5362,7 +5363,7 @@ <h2 id="2">2 仪表板设计器嵌入<a class="headerlink" href="#2" title="Perm
53625363
</div>
53635364
<h2 id="3">3 数据大屏嵌入<a class="headerlink" href="#3" title="Permanent link">&para;</a></h2>
53645365
<div class="admonition abstract">
5365-
<p>数据大屏嵌入支持嵌入整个数据大屏,用户可以浏览嵌入的数据大屏,数据大屏嵌入还支持外部参数设置。</p>
5366+
<p>可以将数据大屏嵌入到第三方业务系统中,用户通过第三方系统访问数据大屏,同时支持外部参数过滤设置。 </p>
53665367
<div class="highlight"><pre><span></span><code>#
53675368
一、公共链接嵌入(数据不敏感或内网环境可用,使用 ticket 的方式会较为安全)。
53685369
1、获取数据大屏公共链接
@@ -5447,11 +5448,15 @@ <h2 id="3">3 数据大屏嵌入<a class="headerlink" href="#3" title="Permanent
54475448
</div>
54485449
<h3 id="31">3.1 数据大屏双向参数传递<a class="headerlink" href="#31" title="Permanent link">&para;</a></h3>
54495450
<div class="admonition abstract">
5450-
<p>参考 Ifram 仪表板双向参数传递以及 Iframe 数据大屏嵌入,将相应 busiFlag 修改对应。</p>
5451+
<p>参考 <a href="https://dataease.io/docs/v2/embedded/iframe/#11">1.1 仪表板双向参数传递</a>以及 <a href="https://dataease.io/docs/v2/embedded/iframe/#3">3 数据大屏嵌入</a>。以及 Iframe 数据大屏嵌入,将相应 busiFlag 修改对应。</p>
5452+
<ul>
5453+
<li>仪表板图表 busiFlag: dashboard</li>
5454+
<li>数据大屏图表 busiFlag: dataV</li>
5455+
</ul>
54515456
</div>
54525457
<h2 id="4">4 数据大屏设计器嵌入<a class="headerlink" href="#4" title="Permanent link">&para;</a></h2>
54535458
<div class="admonition abstract">
5454-
<p>数据大屏设计器嵌入支持嵌入整个数据大屏设计器界面,用户不仅可以浏览嵌入的数据大屏,还可以对其进行编辑:</p>
5459+
<p>支持嵌入整个数据大屏设计器界面,用户不仅可以浏览嵌入的数据大屏,还可以对其进行编辑:</p>
54555460
<div class="highlight"><pre><span></span><code>#
54565461
一、DataEase 嵌入式推荐的 iframe 嵌入
54575462
1、iframe 嵌入需要先在 application.yml 里添加 origin-list
@@ -5666,7 +5671,7 @@ <h2 id="6">6 我的填报嵌入<a class="headerlink" href="#6" title="Permanent
56665671
<h2 id="7">7 模块嵌入<a class="headerlink" href="#7" title="Permanent link">&para;</a></h2>
56675672
<h3 id="71">7.1 仪表板模块<a class="headerlink" href="#71" title="Permanent link">&para;</a></h3>
56685673
<div class="admonition abstract">
5669-
<p>嵌入整个仪表板模块后,可以实现对仪表板模块的整体使用,包括新建、编辑和删除仪表板</p>
5674+
<p>嵌入整个仪表板模块后,可以实现对仪表板模块的整体使用,包括新建、编辑和删除仪表板</p>
56705675
<div class="highlight"><pre><span></span><code>#
56715676
DataEase 嵌入式推荐的 iframe 嵌入
56725677
1、iframe 嵌入需要先在 application.yml 里添加 origin-list

v2/embedded/process/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4658,7 +4658,7 @@ <h1>嵌入式流程</h1>
46584658
<h2 id="1">1 流程概述<a class="headerlink" href="#1" title="Permanent link">&para;</a></h2>
46594659
<div class="admonition abstract">
46604660
<p>DataEase 支持使用 Iframe 以及 DIV 进行嵌入,两种方法的流程如下。</p>
4661-
<p><strong>注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见常见问题 4.2</strong></p>
4661+
<p><strong>注意:嵌入需要在 DataEase 的配置文件 /opt/dataease2.0/conf/application.yml 里增加 origin-list 配置,并重启服务。详细见<a href="https://dataease.io/docs/v2/embedded/question/#2-iframe-div">嵌入式常见问题 2</a></strong></p>
46624662
</div>
46634663
<h3 id="11-div">1.1 DIV 嵌入式流程<a class="headerlink" href="#11-div" title="Permanent link">&para;</a></h3>
46644664
<div class="admonition abstract">

v2/embedded/setting/index.html

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4544,11 +4544,19 @@
45444544
<h1>基础设置说明</h1>
45454545

45464546
<div class="admonition abstract">
4547-
<p>注意;本文当所使用代码均为嵌入式官方 <a href="https://github.com/dataease/embedded-demo/tree/isv-embedded-demo">demo 代码</a>。并在此基础上进行代码的修改进行演示。</p>
4547+
<p>注意:本文档所使用代码均为嵌入式官方 <a href="https://github.com/dataease/embedded-demo/tree/isv-embedded-demo">demo 代码</a>。并在此基础上进行代码的修改进行演示。</p>
45484548
</div>
45494549
<h2 id="1-token">1 嵌入式 Token<a class="headerlink" href="#1-token" title="Permanent link">&para;</a></h2>
45504550
<div class="admonition abstract">
45514551
<p>采用 JWT 认证 ,官方嵌入式代码生成 token 方式如下,需要获取 DataEase 嵌入式应用的 APP ID、APP Secret,以及 DataEase 中的用户账号。</p>
4552+
<ul>
4553+
<li>
4554+
<p>APP ID:嵌入式获取 JWT token 需要填写的 ID。</p>
4555+
</li>
4556+
<li>
4557+
<p>APP Secret :嵌入式获取 JWT token 需要填写的 Secret。</p>
4558+
</li>
4559+
</ul>
45524560
<p>2.10.0 版本开始,支持设置 token 有效时间。 Token 可根据实际情况使用其它类型语言生成,代码实现方式不唯一。</p>
45534561
<div class="highlight"><pre><span></span><code>@RestController
45544562
public class IndexController {
@@ -4602,7 +4610,7 @@ <h2 id="2-dataease-js">2 DataEase 嵌入式 JS<a class="headerlink" href="#2-dat
46024610
<p>当使用 DIV 嵌入时,需引入 DataEase 提供内置的 js 模块,如下 。</p>
46034611
<p>引入 js 后,即可使用 js 模块提供好的类及方法完成 DIV 的嵌入。</p>
46044612
<p><strong>注意:需要将 js 引入到页面的 head 中,保证依赖的正确加载。</strong></p>
4605-
<div class="highlight"><pre><span></span><code>## {domain}js/div_import_0.0.0-dataease.js DataEase 提供好的 js 模版,
4613+
<div class="highlight"><pre><span></span><code>## 将下方代码中的 src 地址改为静态 js 的访问地址即可。
46064614
## 访问地址为 http://ip:9080/js/div_import_0.0.0-dataease.js
46074615
&lt;script crossorigin type=&quot;module&quot; th:src=&quot;@{{domain}/js/div_import_0.0.0-dataease.js(domain=${vo.domain})}&quot;&gt;&lt;/script&gt;
46084616
</code></pre></div>

v2/embedded/summary/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4547,7 +4547,7 @@ <h2 id="1">1 模块说明<a class="headerlink" href="#1" title="Permanent link">
45474547
</div>
45484548
<p><img alt="1.1嵌入模块说明.jpg" src="../../img/embedded/1.1%E5%B5%8C%E5%85%A5%E6%A8%A1%E5%9D%97%E8%AF%B4%E6%98%8E.jpg" width="900px" /></p>
45494549
<div class="admonition abstract">
4550-
<p>DataEase 嵌入式支持 DIV 和 Iframe 两种嵌入方式,支持按照单个可视化资源,以及现有数据集、数据源、数据大屏、仪表板等完整模块的嵌入。可根据需要自行选择对应方式进行丰富的嵌入需求</p>
4550+
<p>DataEase 嵌入式支持 DIV 和 Iframe 两种嵌入方式,支持按照单个可视化资源,以及现有数据集、数据源、数据大屏、仪表板等完整模块的嵌入。可根据需要自行选择对应方式进行嵌入</p>
45514551
<p>DataEase 同时提供了丰富的 API 接口,包括仪表板管理、数据大屏管理,数据集管理、权限管理、用户管理等模块,可根据实际的业务需求调用 DataEase 的接口完成业务要求,API 说明入口位于 【系统设置】-&gt;【API Key】-&gt;【查看 API】。</p>
45524552
</div>
45534553
<p><img alt="1.1嵌入式BI功能架构(1).png" src="../../img/embedded/1.1%E5%B5%8C%E5%85%A5%E5%BC%8FBI%E5%8A%9F%E8%83%BD%E6%9E%B6%E6%9E%84%EF%BC%881%EF%BC%89.png" width="900px" />
@@ -4556,6 +4556,7 @@ <h2 id="2">2 嵌入式场景效果预览<a class="headerlink" href="#2" title="P
45564556
<div class="admonition abstract">
45574557
<p><a href="https://embedded-bi.dataease.cn/#/home/index">官方演示环境</a>,嵌入式官方体验环境,可查看嵌入式效果。</p>
45584558
<p>官方 demo 代码, <a href="https://github.com/dataease/embedded-demo/tree/main">Layui 框架代码</a><a href="https://github.com/dataease/embedded-demo/tree/isv-embedded-demo">Vue3 代码</a></p>
4559+
<p><strong>注意:如果项目的前端使用的是 Vue3 的框架,建议参考 Vue3 的代码进行嵌入;其他前端框架可参考 LayUl 框架的代码进行嵌入。</strong></p>
45594560
</div>
45604561
<div class="admonition abstract">
45614562
<p>数据大屏及数据大屏设计器嵌入。</p>

v2/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)