报告预览集成页面:/dash/integration/:projectId

字段名称 参数说明
token 鉴权使用
rid 报告id
did 报告页面id((若不开启发布功能,则为报告id;若开启发布功能:id可以是已经发布的报告的id,也可以是报告草稿的id))
toolbar 功能键
mode 底部导航条显示方式
defaults 筛选器
side 侧边栏
sort 排序
hidePublic 公共文件夹隐藏
hidePrivate 私有文件夹隐藏
hideTitle 顶部标题栏隐藏
tabColor tab页面颜色设置
hideScaleBar 缩放栏隐藏
hidePageBar 整个报告底部工具栏隐藏
enableReportDetail 报告列表详情,内容是属性以及相关信息,默认是 false
hideProgressBar 顶部进度条隐藏
hideLoading 加载中动画隐藏
scale 缩放配置
bottomBarPos 底部栏放在顶部配置
backgroundColor 页面背景颜色设置
fit 集成页面自适应宽度时两边不留白,默认是 false
parameters 参数配置值
showExportExcelRemind 显示导出Excel时的提醒,默认是false
showExportExcelData 显示导出Excel时的数据格式选择,默认是false

(1)集成报告模式

报告的模式目前分为两种:normal、simple;加入的原因主要为了区别报告页面切换的方式。

配置方式:直接在url后加入

  &mode=simple
  • normal

    普通模式,是一种默认配置模式,报告的页面切换方式与目前预览方式一致;

  • simple

    简单模式,是一种相对normal更为简单的页面切换方式

(2)集成报告默认显示页面

集成报告默认进入显示第一页,如果需要更改默认显示页面;直接配置url中的dashboard

配置方式:直接在url后加入

  &did=14510

(3)集成报告筛选器控件默认参数配置

目前只支持对列表筛选器控件,日期筛选器控件的配置。

  • 列表筛序器控件

配置方式:直接在url后加入

  &defaults=默认配置的数据结构

配置参数数据结构如下:

{
  "列表筛选器控件id":{
    selected: Array,
    exclude: Boolean
  }
}

其中selected表示设置的选项列表,如果列表筛选默认有设置, 这里的配置会覆盖默认的配置。

  • 日期筛序器控件

配置方式:直接在url后加入

  &defaults=默认配置的数据结构

目前只支持静态时间段,筛选出从起始时间到结束时间的数据,配置参数数据结构如下:

{
  "日期筛选器控件id":{
    type: "StaticTime",
    minBound: timeString,
    maxBound: timeString
  }
}
eg:
{type: "StaticTime", minBound: "2016-07-01 00:00:00", maxBound: "2016-07-20 23:59:59"}

其中minBound,maxBound分别表示起始时间与结束时间,起始时间不能大于结束时间,同时minBound,maxBound的日期格式为"YYYY-MM-DD HH:mm:ss"。如果日期筛选默认有设置,这里的配置会覆盖默认的配置。

(4)集成报告的侧边栏

集成报告默认不展示侧边栏,如需展示侧边栏;直接配置url中的side

配置方式:直接在url后加入

  &side=true

(5)集成报告的侧边栏排序

集成报告侧边栏默认按照名称升序,如需更改排序方式,直接配置url中的sort

配置方式:直接在url后加入

  &sort=title:1/title:2/modifyTime:1/modifyTime:2

(6)集成报告的侧边栏公共文件夹隐藏

集成报告侧边栏默认展示公共文件夹,如需隐藏,直接配置url中的hidePublic

配置方式:直接在url后加入

  &hidePublic=true

(7)集成报告的侧边栏私有文件夹隐藏

集成报告侧边栏默认展示私有文件夹,如需隐藏,直接配置url中的hidePrivate

配置方式:直接在url后加入

  &hidePrivate=true

(8)集成报告的标题栏隐藏

集成报告标题栏默认展示,如需隐藏,直接配置url中的hideTitle 如果隐藏,toolbar也会隐藏

配置方式:直接在url后加入

  &hideTitle=true

(9)集成报告的tab页面颜色设置

集成报告tab页面颜色设置,如需设置,直接配置url中的tabColor,css颜色

配置方式:直接在url后加入

  &tabColor=red

或者

  &tabColor=%23ccc

(10)集成报告的tab页面区域缩放栏隐藏

集成报告tab页面区域缩放栏默认展示,如需隐藏,直接配置url中的hideScaleBar

配置方式:直接在url后加入

  &hideScaleBar=true

(11)集成报告的底部栏隐藏

集成报告底部栏默认展示,如需隐藏,直接配置url中的hidePageBar

配置方式:直接在url后加入

  &hidePageBar=true

(12)集成报告的详情展示

集成报告详情默认不展示,如需展示,直接配置url中的enableReportDetail

配置方式:直接在url后加入

  &enableReportDetail=true

(13)集成报告的顶部进度条隐藏

集成报告顶部进度条默认展示,如需隐藏,直接配置url中的hideProgressBar

配置方式:直接在url后加入

  &hideProgressBar=true

(14)集成报告的加载中动画隐藏

集成报告加载中动画默认展示,如需隐藏,直接配置url中的hideLoading

配置方式:直接在url后加入

  &hideLoading=true

(15)集成报告的缩放配置

集成报告缩放配置,默认为100%:100: 为缩放100%,'width':自适应宽度,'screen':自适应窗口,直接配置url中的scale

配置方式:直接在url后加入

  &scale=width

(16)集成报告的底部栏放在顶部配置

集成报告底部栏放在顶部配置,默认为放在底部,如需放在顶部,直接配置url中的bottomBarPos

配置方式:直接在url后加入

  &bottomBarPos=top

(17)集成报告的页面背景颜色设置

集成报告页面背景颜色设置,如需设置,直接配置url中的backgroundColor,css颜色

配置方式:直接在url后加入

  &backgroundColor=red

或者

  &backgroundColor=%23ccc

(18)集成报告的页面参数控制的配置

集成报告页面全局参数或者参数控制器的参数的默认配置,目前只支持静态的,如需设置,直接配置url中的parameters 用户可配置的参数为:[{id:控制参数的id,defaultValue:控制参数的值}] 若非浏览器需要直接使用需要:encodeURIComponent('[{"id":1908,"defaultValue":2},{"id":35,"defaultValue":"2020-12-01%2017:54:36"}]')

配置方式:直接在url后加入

  &parameters=[{"id":1908,"defaultValue":2},{"id":35,"defaultValue":"2020-12-01%2017:54:36"}]

(19)图表权限配置

此处的权限配置主要用于图表功能的配置(如:图表导出功能、数据预览、排序级别等功能)

数据结构:

{
    global:{
        export: Array, // ['image','excel','pdf']
        view: Boolean, // true
        sortPriority: Boolean, // true 排序级别
        refreshHist: Boolean, // true 查看刷新历史记录
        inteExplore: Boolean, // true 智能分析
    }
}

上面的注释部分表示默认的配置方式:即导出和数据预览功能都是具有的

使用方式

&permission = serialize(数据结构)
@example 数据结构 = {
  "global": {
    "export": [
      "image",
      "excel",
      "pdf"
    ],
    "view": true
  }
}

https://demo.xx.com/dash/integration/2345?rid=12&token=1231dadf12312adfad323adas&side=true&sort=title:1&hidePublic=false&hidePrivate=true&toolbar=[]&mode=normal&permission=%7B%22global%22%3A%7B%22export%22%3A%5B%22image%22%2C%22excel%22%2C%22pdf%22%5D%2C%22view%22%3Atrue%7D%7D

(20)dom文档相关配置

此处的配置主要用于dom文档的部分可配项(目前只支持配置dom文档的title自定义设置)

数据结构:

{
    title:String, //集成报告
}

使用方式:

&head = serialize(数据结构)
@example 数据结构 = {
  "title": "自定义文档标题"
}

https://demo.xx.com/dash/integration/2345?rid=12&token=1231dadf12312adfad323adas&head=%7B%22title%22%3A%22%E8%87%AA%E5%AE%9A%E4%B9%89%E6%96%87%E6%A1%A3%E6%A0%87%E9%A2%98%22%7D

(21)集成报告的导航栏

报告导航栏可配置项包括(打印功能、数据刷新功能、报告导出功能、全屏功能) 可配置参数print、refresh、bookmark、export、fullScreen、doctor分别对应打印、刷新数据、书签、导出报告、全屏、数据医生 可以配置显示顺序以及是否显示、默认情况下都显示,默认顺序为[print, refresh, bookmark, export, doctor, fullScreen]

配置方式:直接在url后加入

  &toolbar=['print', 'refresh', 'bookmark', 'export', 'doctor', 'fullScreen']

(22)集成报告的草稿模式

报告未开启发布功能:id则为报告id。
报告开启发布功能:‘/api/dash/folder/list’、‘/api/dash/report/get’接口中,id则为报告草稿的id,publishRelatedId为发布报告的id。