集成仪表板或单个图表

1. 概述

1.1 功能概述

通过IFrame容器技术，用户可将Wyn的完整仪表板或单个可视化组件无缝集成至现有Web应用系统，快速构建嵌入式数据分析能力，实现业务系统与数据洞察的深度整合。

2. 操作步骤

2.1 集成整个仪表板

2.1.1 获取仪表板 URL

在文档门户中，选择需要集成的仪表板，单击页面操作栏的在新窗口中浏览仪表板按钮，即可在新的浏览器窗口中打开仪表板，然后将仪表板的URL地址拷贝粘贴到记事本中待用。

2.1.2 添加用户令牌

在获取到仪表板的 URL 后，需要添加用户令牌来进行身份认证和权限认证，其格式为一系列包含字母和数字的字符串。关于如何生成和获取令牌请参考生成令牌一节。在获取到令牌后，将其添加到目标 URL 的末尾，并使用“&token=” 进行连接，得到最终的 URL 字串。
```
例如：http://localhost:51980/dashboards/view/8b75d061-0420-40ca-9b6b-35d0356f0327?theme=default&lng=zh-CN&token=A2D2D9E4EBF94D15F0597A9A1D2A756ED8AE0874D2BD4B1C01070DAAFCB9A4B6
```
注意： 生成令牌时使用的用户，应具有查看仪表板的基本权限以及查看目标仪表板的权限。

2.1.3 更多集成参数

集成参数列表：

序号	参数	说明	可用值
1	lng	用来控制页面的显示语言。	en、zh-CN
2	theme	用来控制页面的系统主题色。	default、 ars、 blue、 red、 forest、 dark-forest、 light、 warm-light 、 green及自定义主题名称。
3	documentThemeId	集成时用来控制仪表板中使用的文档主题。	参数值为具体的文档主题ID。
4	pageNumber	当仪表板有多个页面时用于设置默认显示第几页。	参数值从1开始。
5	lite	指定仪表板查看器为标准分析模式或高级分析模式。	true（标准）、false（高级）
6	dp	用于指定仪表板的参数。	参数值可以是“字符串”、“整数”、“浮点”、“日期时间”和“多维”类型。语法： &dp={"参数1名称":["参数1值1","参数1值2","参数1值3"],"参数2名称":["参数2值1","参数2值2","参数2值3"]}
7	size	用于集成单张仪表板时，设置打开仪表板时默认适应屏幕的方式。	fitheight、 fitwidth、 fitscreen、 auto 分别表示高度自适应、宽度自适应、适应屏幕和等比缩放。
8	hiddenToolbarActions	用于隐藏预览仪表板时上方工具栏中的选项。	refresh、 crossFilter 、slideShow 、filterView、 pageSize、 export、 stretchContent （仅当仪表板中设置了文档内容拉伸比例时才显示）、updateDocThumbnail * 多个参数使用逗号（英文输入法）隔开。
9	clickAction	用于设置鼠标左键点击的触发项。	showTooltip、 keep、 exclude、 drillTo、 jumpTo
10	containerFilterScope	用于设置容器内组件的过滤范围。	page、 container
11	contextMenuActions	用于设置鼠标右键的菜单项。	showTooltip、 keep、 exclude 、drillTo、 jumpTo、 addMonitor、 command
12	hideErrors	用于指定是否隐藏仪表板错误通知。	true、 false
13	title	用于在浏览器标签上添加额外的标题。	输入的文本内容将显示在浏览器页签上。
14	useMobileView	用于在浏览器中查看仪表板的移动端效果。	true，在浏览器中以移动端效果进行展示； false或不添加该参数，即正常展示该仪表板。
15	ssar	用于调整在仪表板在拼接屏幕上的显示效果。	ssar=宽高比例如：拼接屏幕个数为3*2，所以它的宽高比为3/2=1.5，即ssar=1.5
16	toolbar	当默认查看器是高级分析时，可通过toolbar参数控制工具栏的显示和隐藏。	hide（隐藏）、show（显示）

2.2 集成单个仪表板图表

Wyn 提供两种方式生成嵌入式组件URL，满足不同使用习惯的开发需求：

参数化拼接： 直接在仪表板基础URL后追加组件参数（如?showScenarioTitle=true），适合需要精准控制URL结构的高级用户。
可视化生成： 通过仪表板设计器UI的分享组件功能自动构建完整URL，降低手工操作门槛，推荐快速集成场景使用。

下面将详解两种方式的具体操作流程与参数规范。

2.2.1 手动拼接参数

集成单个组件的过程与集成整张仪表板类似，不同点在于需要在集成整张仪表板的 URL 中添加参数指定组件，还可以进一步使用其他参数定制显示效果。

具体可用参数列表如下：

参数	说明	可用值
scenario	用于指定仪表板中的单个组件。	参数值为具体的组件名称。请注意大小写敏感。
showScenarioTitle	用于设置当集成单个组件时是否显示组件标题。	true、 false
showScenarioBackground	用于设置当集成时是否显示组件背景。	true、 false
openfulldashboardmode	指定由组件返回整张仪表板的方式。	newwindow(新页面)、 redirect（重定向）、none（不显示返回按钮）
actions	指定组件显示的菜单项。	clearselection、 focus、 annotation、 export、filter、 clearruntimefilter、 sort、 rank、 modelparameters、 options.property.conditionalformat、 options.property.referenceline、 options.property.trendlines、 options.property.expand、 showdata、analysispath 多个参数使用逗号（英文输入法）隔开。

1）例如：在集成仪表板的URL后边指定一个组件，并显示出原来的背景。

http://localhost:51980/dashboards/view/8b75d061-0420-40ca-9b6b-35d0356f0327?theme=default&lng=zh-CN&token=0b77ebfe232bff06248ce245c24af6aa84010b5f747ef41e605b08ae310a6fed&scenario=column&showScenarioBackground=true

2.2.2 通过UI选项生成URL

在仪表板设计器中，设计并保存仪表板。
在仪表板设计器中，单击任意组件的分享按钮，打开分享组件窗口。

在分享组件窗口选择组件的配置项，即可自动生成嵌入到iFrame 的URL。

属性名称	说明	系统图示
可选菜单项	设置集成之后的组件显示哪些菜单项。比如仅选择“导出” 项目，那么集成之后打开的组件则仅有“导出”选项。因为必须在高级分析模式下才会显示可见菜单项，所以需要最后在URL中手动添加“lite=false”。
大小	配置组件的大小适应方式，默认为适应所在的容器。
返回仪表板	配置组件集成之后是否可以返回完整的仪表板，以及以哪种方式打开完整仪表板。支持无、重定向和新页面三种选项。无代表集成之后的组件不能返回完整仪表板，没有打开完整仪表板的按钮。重定向和新页面代表集成之后的组件会有打开完整仪表板的按钮。重定向代表在当前页面打开完整仪表板；新页面代表在新的页面打开完整仪表板。
文档主题	为组件选择一个文档主题，使其与集成的目标界面更适合。下拉即可选择。
嵌入到	选择IFrame 即代表使用URL的方式集成，下面的自动生成框中将生成对应的iFrame URL。可以直接复制到您系统页面的代码中使用。选择Div即代表使用DIv的方式集成，下面的自动生产框中将生产对应的代码，可复制使用。