1. 内容概述
使用 URL 集成的方式允许用户将服务器数据库上可用的仪表板、报表、数据集、数据源、数据模型、图像和其他资源嵌入到 Web 应用程序中。
用户可以在其 Web 应用程序的 IFrame 中指定 Wyn 资源的 URL。
除此之外，用户还可以直接在 Web 浏览器中使用集成 URL 来访问相应的门户，而无需输入登录信息并自定义最终用户的查看体验。
本为为您介绍集成 URL 的结构、将 Wyn 资源嵌入 Web 应用程序的步骤以及参数使用。
2. 集成 URL 的结构
集成URL的结构如下：
baseURL/module/command/documentid?[dp]&[others]
baseURL 指客户安装的 Wyn Portal 的 URL。如 http://www.wyn.com 或 http://127.0.0.1:51980。
- module 指集成的模块，可选值如下：
| 可选值 | 说明 |
|---|---|
datasources datasets analytics dashboards reports webPages templates floorPlans images theme | 数据源 数据集 数据模型 仪表板 报表 网页 模板 自定义地图 图片 主题 |
- command 可选值如下：
| 可选值 | 说明 |
|---|---|
create view edit | 创建文档，即打开文档的设计器。 预览文档。 编辑文档，即在设计器中打开文档。 |
- documentID 指文档的ID，是文档的唯一标识。当创建新文档时，省略documentID即可。
dp 用来传递文档参数，可以是“字符串”、“整数”、“浮点”、“日期时间”和“多维”类型。
dp 的语法是：&dp={"参数1名称":["参数1值1","参数1值2","参数1值3"],"参数2名称":["参数2值1","参数2值2","参数2值3"]}
提示
用冒号 (:) 分隔参数名称和值。例如，dp={"Parameter1" : [2000.111]}
用双引号 (" ") 将参数名称和值括起来。例如，dp={ " Parameter1 " :[ " Japan " ]}。
使用逗号 (,) 分隔多个参数。例如，dp={"Parameter1":[2000] , "Parameter2":["Wyn Dashboard"] , "Parameter3":["2020-01-01T00:00:00"]}。
- others 代表附加参数，用来传递token、文档类型、文档显示风格等信息。
| 参数 | 参数说明 | 参数值 | |
|---|---|---|---|
| 1 | token | “token”参数是由管理员生成的令牌。 具体请见生成令牌。 | |
| 2 | type | 用于区分数据集类型。 | 可选值： streamingdataset、pushdatase、cacheddataset 分别代表流式数据集、推送数据集、缓存数据集。 |
| 3 | mode | 用于在URL中指定数据模型类型。 | cachemode 表示抽取模型。 例如以下URL代表集成创建抽取模型。 http://10.32.5.241:51980/analytics/create?mode=cachemode |
| 4 | lng | 用来控制页面的显示语言。 | 可选值：en、zh、zh-tw、pl 和 es |
| 5 | dispaly | 用于单张报表集成，设置打开报表时页面默认的预览视图。 | 可选值：Singlepage（单页视图）、Pageless（不分页）、Continuous（多页视图）。 |
| 6 | theme | 用来控制页面的主题色。 | 可选值： default、ars、 blue、red、 forest、dark-forest、light、warm-light 和 green。 |
| 7 | size | 用于集成单张仪表板时，设置打开仪表板时默认适应屏幕的方式。 | 可选值： fitheight、fitwidth、fitscreen、auto 分表表示高度自适应、宽度自适应、适应屏幕和等比缩放。 当仪表板的属性“固定尺寸”打开时，或者仪表板开启标准分析模式时，该参数不起效。 |
| 8 | toolbar | 控制预览仪表板或报表时是否隐藏工具栏。 | 可选值： show、hide、auto |
| 9 | toolbarSize | 用于控制报表页面工具栏的高度。 | 可使用的值有： s（代表31px）、m（代表41px，即默认大小）、l（51px） |
| 10 | hideActions | 隐藏在单击更多按钮时出现的菜单选项或预览区域快速操作栏中的对应功能。 如需隐藏多个功能，可为 hideActions 赋予多个参数值，各参数值之间使用英文逗号分隔即可。 | 支持的参数值有： rename, openInNewWindow, refresh, delete, download, copyUrl, copyReport, copyDashboard, copyDataset, reporting:exportReport, reporting:editReport, reporting:copyAsTemplate, reporting:createReportWithTemplate, reporting:editTemplate, reporting:previewRevision, reporting:editRevision, dashboards:editDashboard, dashboards:createWith, modifyDataSource, modifyDataset, refreshDataset, modifyTheme, batchCheckBox, reconfigDataSource, appendData, modifyFloorPlan. 另外还支持 logout 参数值隐藏退出登录菜单；
使用 managePersonalCategory 参数值隐藏个人分类管理按钮。
|
| 11 | hideavatarmenu | 将其设置为“true”以隐藏显示在门户左下角的头像菜单。 | |
| 12 | hidewelcomescreen | 将其设置为“true”以在集成文档门户时隐藏欢迎屏幕。 | |
| 13 | hidenav | 将其设置为“true”以隐藏文档和资源门户左侧的导航菜单。 | |
| 14 | scenario | 用于显示仪表板中的单个组件。 | 参数值为具体的组件名称。注意大小写敏感。 |
| 15 | lite | 它将仪表板查看器模式指定为标准分析模式或高级分析模式。 | 设置为“true”时，启用标准分析查看器模式， 设置为“false”时，启用高级分析查看器模式。 此参数仅对仪表板有效。 |
| 16 | loadChart | 控制在查看器中初始加载图表时的加载动画效果。此参数仅对报表有效。 | 将其设置为“true”以启用加载动画效果， 设置为“False”以禁用加载动画效果。 |
| 17 | hoverChart | 控制鼠标悬停时图表上的悬停效果。此参数仅对报表有效。 | 将其设置为“true”以启用悬停效果， 将其设置为“False”以禁用悬停效果。 |
| 18 | hoverTable | 控制鼠标悬停时表格和 tablix 行的悬停效果。此参数仅对报表有效。 | 将其设置为“true”以启用悬停效果， 将其设置为“False”以禁用悬停效果。 |
| 19 | hoverTableBackgroundColor | 指定鼠标悬停在表格和矩表行上时的背景颜色，此参数仅对报表有效。 | 支持以下值，如 $theme（背景颜色取决于门户主题背景颜色）、$origin（背景颜色保持不变）、red（背景颜色基于指定的颜色值），或 %2330a0a0（背景颜色基于指定的十六进制值）。 |
| 20 | hoverTableTextColor | 指定鼠标悬停在表格和矩表行上时的文本颜色，此参数仅对报表有效。 | 支持以下值，如 $theme（文本颜色取决于门户主题文本颜色）、$origin（文本颜色保持不变）、red（文本颜色基于指定的 颜色值），或 %2330a0a0（背景颜色基于指定的十六进制值）。 |
| 21 | openfulldashboardmode | 选择文档的打开方式为新窗口还是重定向。 使用“重定向”方式时，当页面地址放在网页的 iframe 中时，重定向效果将显现出来。 重定向仪表板代表跳转后仅将仪表板区域重定向显示成目标文档；重定向当前页面代表浏览器中的URL会重定向显示为新的目标文档。 | 支持的参数值有： newwindow redirect |
| 22 | pageNumber | 当仪表板有多个页面时用于设置默认显示第几页。 | |
| 23 | hiddenToolbarActions | 该参数用于隐藏预览仪表板时上方工具栏中的选项。 | 支持的参数值有： refresh、crossFilter 、slideShow 、filterView、pageSize、export、stretchContent（仅当仪表板中设置了文档内容拉伸比例时才显示） |
| 24 | datasetId | 在仪表板设计器中指定数据集或模型。 | 例如： http://localhost:51980/dashboards/create?token=2cb6c4d1717902b9a...&datasetId=b0082554-9c66-4605-8cf3-5f1ffbd9c314 打开仪表板设计器，并加载指定的数据集。 |
| 25 | horizontalAlignment | 设置报表页面的水平对齐方式。 | 参数值为left，center，right，对应左/中/右。 |
| 26 | parameterPanelPosition | 设置报表参数面板的位置。 | 支持 right 和 top，分别对应参数面板在右侧或上方。 |
| 27 | parameterPanelRoundedControls | 设置是否开启参数面板中元素的圆角效果。
| 参数值支持true 和 false。 |
| 28 | parameterPanelShowMode | 设置是否显示参数面板。 | 支持的参数值为 always。 |
| 29 | hideErrors | 设置是否隐藏预览仪表板时的错误信息。
| 参数值支持true 和 false。 |
| 30 | chartTooltip | 设置是否开启报表中图表的鼠标提示标签。 | 参数值支持true 和 false。 |
| 31 | chartTooltipBackgroundColor | 设置报表图表中鼠标提示标签的背景颜色。 | 支持的参数值有： $theme |
| 32 | chartTooltipBorderColor | 设置报表图表中鼠标提示标签的边框颜色。 | 支持的参数值有： $theme |
| 33 | chartTooltipBorderRadius | 设置报表图表中鼠标提示标签的边框的圆角弧度。 | 有效的数字，单位为 px或 pt 如： ?chartTooltipBorderRadius=5px |
| 34 | chartTooltipBorderSize | 设置报表图表中鼠标提示标签的边框的粗细。 | 有效的数字，单位为 px或 pt 如： ?chartTooltipBorderSize=2px |
| 35 | chartTooltipBorderStyle | 设置报表图表中鼠标提示标签的边框的线型。 | None Dotted Dashed Solid Double Groove Ridge Inset Outset |
| 36 | chartTooltipFontFamily | 设置报表图表中鼠标提示标签中文字的字体。 | 有效的字体类型。 使用自定义字体时，用法如下： ?chartTooltipFontFamily=server-font-自定义字体的ID 例如： ?chartTooltipFontFamily=server-font-7b29b607-ecf9-4914-9811-bd5cdacc3983 |
| 37 | chartTooltipFontSize | 设置报表图表中鼠标提示标签的字体大小。 | 有效的数字，单位为 px或 pt |
| 38 | chartTooltipFontStyle | 设置报表图表中鼠标提示标签的字体是否是斜体。 | Normal Italic |
| 39 | chartTooltipFontWeight | 设置报表图表中鼠标提示标签的字体是否粗体。 | Lighter Thin ExtraLight Light Normal Medium SemiBold Bold ExtraBold Heavy Bolder |
| 40 | chartTooltipTextColor | 设置报表图表中鼠标提示标签的字体颜色。 | 支持的参数值有： $theme ?chartTooltipTextColor=rgb(0,0,0) |
