报告预览集成页面
报告预览集成页面:/dash/integration/:projectId
集成报告方法:
1. 更改报告页的URL地址;
2.在URL后加入想要在集成是设置的内容;
3.将配置好的URL集成到自己的环境中即可。
集成页面配置说明:
1.页面切换方式配置:
集成页面默认的页面切换配置是normal类型的,如需更改,可自行配置。
&mode=simple/normal
2.报告页面导航栏配置:
默认状态下,集成报告页面显示:打印、刷新和导出三种功能,也可以自己进行配置。
&toolbar=[“export”,”refresh”,”print”]
3.报告默认显示页面配置:
集成报告默认进入显示第一页,也可以进行配置
&did=14510
4.报告筛选器空间默认参数配置:
目前只支持对列表筛选器控件,日期筛选器控件的配置。
· 列表筛选器:
&defaults=默认配置的数据结构
配置参数数据结构如下:
{
“列表筛选器控件id”:{
“selected”:[“Array”],
selected表示设置的选项列表,如果列表筛选默认有设置,则会覆盖默认设置
“exclude”:[“Boolean”] }
}
eg.
&defaults={“component-25035691-1cllcl1fj”:{“selected”:[“Chelsea”]}}
· 日期筛选器:
&defaults=默认配置的数据结构
目前只支持静态时间段,配置参数数据结构如下:
{
“日期筛选器控件id”:{
type:”StaticTime”
“minBound”:”timeString”,
“maxBound”:”timeString” }
}
eg:
{type:”StaticTime”,minBound:”2016-07-01 00:00:00”, maxBound:”2016-07-01 00:00:00”}
其具体操作方式同列表筛选器相同。
5.报告的侧边栏配置:
集成报告默认不显示侧边栏,如需展示侧边栏,可自行配置。
&side=ture
6.报告的侧边栏排序配置:
集成报告侧边栏默认按照名称圣墟,如需更改,可自行配置。
&sort=title:1/title:2/modifyTime:1/modifyTime:2
名称排序第一种:
名称排序第二种:
7.报告的侧边栏公共文件夹隐藏配置:
集成报告的侧边栏默认展示公共文件夹,如需隐藏,可自行配置。
&hidePublic=true
8.报告的侧边栏私有文件夹隐藏配置:
集成报告的侧边栏默认展示私有文件夹,如需隐藏,可自行配置。
&hidePrivate=true
9.报告的标题栏隐藏配置:
集成报告的标题栏默认展示,如需隐藏,可自行配置,如果使用hideTitle隐藏了标题栏,那么toolbar也会隐藏。
&hideTitle=true
10.报告tab页面颜色配置:
集成报告的tab页面的颜色可以自行设置。
&tabColor=red
11.报表tab页面区域缩放栏隐藏配置:
集成报表tab页面区域缩放栏默认展示,如需修改,可自行配置。
&hideScaleBar=true
12.报告底部栏隐藏配置:
集成报告的底部栏默认展示,如需修改,可自行配置。
&hidePageBar=true
13.报告顶部进度条隐藏配置:
集成报告的顶部进度条默认展示,如需修改,可自行配置。
&hideProgressBar=true
14.报告的缩放配置:
集成报告默认的缩放比例为100%,‘100’:缩放100%,‘width’:自适应宽度,‘screen’自适应窗口,如需更改,可自行配置。
&scale=width
15.报告底部栏放在顶部配置:
集成报告的底部栏默认放在底部,如果需要放在顶部可以自行配置。
&bottomBarPos=top
16.报表中图表权限配置:
集成报告图表功能中的:图表导出功能、数据预览、排序级别等功能可以进行权限管理,具体说明如下。
数据结构如下:
{
“global”:{
“export”: [“Array”], // [‘image’,’excel’,’pdf’]
“view”: [“Boolean”], // true
“sortPriority”: [“Boolean”] // true 排序级别
}
}
上面的注释内表示了默认的配置方式:导出和数据预览功能都是具有的。
具体使用方式:
&permission=serialize(数据结构)
eg.
数据结构 = {
“global”: {
“export”: [
“image”,
“excel”,
“pdf”
],
“view”: [“true”]
}
}
17.dom文档相关配置:
此处配置主要用于dom文档的部分可配置项,目前只支持dom文档的title自定义设置。
数据结构如下:
{
“title”:[“String”], //集成报告-网易有数
}
具体使用方法:
&head = serialize(数据结构)
eg.
数据结构 = {
“title”: “自定义文档标题”
}
有数iframe控件集成方法:
表格设置打开链接时,支持使用当前页面url查询参数值进行插值,可使用
${xxx}
。 如当前页面url为https://bi.youdata.com/dash/xy?rid=123/https://bi.youdata.com/d,则可配置跳转链接为 https://bb.com/goto?a=hello&b=${rid},最终跳转的地址为 https://bb.com/goto?a=hello&b=123有数报告页面iframe控件嵌入第三方页面时,链接地址也支持使用当前页面url查询参数进行插值,方式同上述第1条
当有数报告页面被集成时,页面中的文本、矩形、图片、表格等支持设置自定义事件。自定义事件的配置数据必须为json格式(允许为空),当点击此类辅助控件或表格项时,会向父页面执行postMessage,消息体为
{
type: 'customAction',
payload: {
cid: "c-123-xyz", // 组件id
data: '{"name": "打电话"}', // 自定义数据
compData: { // 只有表格时存在,点击的关联数据
head: ["地区", "销售额"], // 表头
body: [ // 表格数据
["东北", 233],
["华东", 250]
]
},
urlParams: { // 当前页面的url查询参数列表
rid: 123,
token: 456
}
}
}
- 外部系统集成有数页面,通过postMessage,可改变有数页面的筛选器(只支持列表、树状、日期类型)、参数(只支持单值参数)的选中值,进而影响其他报表数据展示。对应接收的消息体为
{
type: 'CHANGE_COMP_SETTING',
data: {
'c-1-82785-86866-kssc2gq4': { // 列表筛选器id
selected: ["华东"], // 选择项
exclude: false // 是否为排除模式
},
'c-1-82785-86866-kstrqik0': { // 树状筛选器id
selected: [["华东", "江苏"]], // 选择项
exclude: false // 是否为排除模式
},
'c-1-82785-86866-kstrqijz': { // 日期筛选器id
type: "StaticTime", // 必须固定为此值
minBound: "2017-07-08 00:00:00", // 最早时间
maxBound: "2018-08-08 24:00:00" // 最晚时间
},
'c-1-82785-86866-kstr1mao': 3, // 参数控制器id与对应的值
'c-1-82785-86866-kt02l48c': "2021-08-21" // 日期类型参数控制器id与对应的值
}
}
- 有数iframe控件集成第3方页面,允许参数(目前只支持单值参数)或者筛选器(只支持列表、树状、日期类型)关联该iframe 当有数页面中筛选器或参数变更时,会向其关联的iframe执行postMessage,对应的消息体为:
{
type: 'CHANGE_COMP_SETTING',
data: {
'c-1-82785-86866-kssc2gq4': { // 列表筛选器id
name: "地区", // 筛选器名称
type: "ListFilter",
selected: ["华东"], // 选择项
exclude: false // 是否为排除模式
},
'c-1-82785-86866-kstrqik0': { // 树状筛选器id
name: "部门",
type: "TreeFilter",
selected: [["华东", "江苏"]],
exclude: false
},
'c-1-82785-86866-kstrqijz': { // 日期筛选器id
name: "下单日期",
type: "DateTimeFilter", // 必须固定为此值
minBound: "2017-07-08 00:00:00", // 最早时间
maxBound: "2018-08-08 24:00:00" // 最晚时间
},
'c-1-82785-86866-kstr1mao': { // 参数控制器id
name: "参数A", // 参数名称
type: "param",
parameterId: "456", // 参数id
value: 12 // 参数值
},
'c-1-82785-86866-kt02l48c': { // 参数控制器id
name: "参数B",
type: "param",
parameterId: "456",
value: '2021-08-21'
}
}
}
页面初次加载时,会在iframe的url上添加查询参数compData=encodeURIComponent(JSON.stringify(compData))
,其中compData为上述消息体的data字段