历史版本7 :JS API 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

1.1 版本

报表服务器版本
11.0

1.2 功能介绍

FineReport 11.0 提供了全新的 JS API 手册,每个接口都有非常详细的使用说明和使用范围,方便用户给报表添加前端效果。手册便捷易用,且持续优化和更新。相比于 10.0  的 JS 接口,11.0 的接口具有以下优点:

  • 接口更统一、更规整,除特殊情况外,同样的功能决策报表和普通报表接口一致,避免接口混杂的情况。

  • 每个接口都有详细的使用说明和使用范围,如具体是在什么情况下使用、是否支持移动端等,避免接口乱用的情况。

  • 10.0 中用户使用较多的场景已做成接口,不用再通过大段兼容性较差的 JS 代码实现,方便用户制作和维护报表,如跑马灯、隐藏滚动条、鼠标悬浮时单元格所在行背景色等。

  • 10.0 中产品不支持,用户需要通过获取 DOM 元素修改的一些功能已做成接口,方便用户的使用,如「数据分析」预览下报表可以居中显示、参数面板展开和收起、邮件按钮支持的格式可以被修改等。

2. 使用说明编辑

2.1 结构说明

API 手册分两大模块,公共模块和私有模块。其中公共模块决策报表和普通报表都可以使用,私有模块分决策报表和普通报表,分别只能在决策报表和普通报表中使用。如下图所示:



2.2 使用示例

使用接口时,一般通过全局接口 _g() 获取到报表对象,然后使用 _g() 的方法获取报表中其他对象,如参数面板对象、参数面板中控件对象、工具栏元素、工具栏中按钮对象等。通过一层一层的方法获取到指定对象后,再使用其对应的方法。

如要隐藏「参数面板」上「下拉框」控件 comboBox0 ,即设置控件 comboBox0 不可见:

1)首先用全局接口 _g() 获取报表对象。

2)因为要获取参数面板上控件,所以先要获取到参数面板,使用 _g() 的 getParameterContainer 方法获取参数面板对象,即:

_g().getParameterContainer

3)获取到参数面板后,再获取参数面板上的「下拉框」控件,使用参数面板的 getWidgetByName 接口获取控件,即:

_g().getParameterContainer().getWidgetByName("comboBox0")

4)获取到控件后,使用控件的 setVisible 方法设置控件不可用将其隐藏,至此便得到了设置「参数面板」上控件不可用的 JS 语句,即:

_g().getParameterContainer().getWidgetByName("comboBox0").setVisible(false)

5)若将其添加在一个「按钮控件」的「点击」事件中,如下图所示:

即可实现点击按钮隐藏「下拉框」控件的功能,如下图所示:

2021-09-15_2-41-57.gif