JS API接口汇总- FineReport帮助文档 - 全面的报表使用教程和学习资料

文档创建者：RosieY

历史版本：33

最近更新：Carly 于 2023-03-16

版本	功能变动
11.0.10	报表块对象接口、报表块行列对象接口、报表块单元格对象接口支持普通报表
11.0.7	「FVS大屏编辑模式」插件 V1.8.0 及之后版本，适配了部分接口，详情见 FVS大屏JS接口汇总
11.0.7	决策报表新增多个报表块接口，详情见：报表块对象接口、报表块行列对象接口、报表块单元格对象接口
11.0	-

本页汇总了JS API 所有接口，可简单查看每个接口的功能和移动端支持情况，详细介绍请阅读对应的接口介绍。

注：接口使用中，注意接口名称大小写，请严格按照文档中名称使用。

公共模块

公共模块的接口，普通报表和决策报表都可以使用，分全局接口、参数面板接口、控件接口、表格接口、工具栏接口、报表分页接口和导出接口。

全局接口

全局接口基本用于报表主体，除 _g() 获取的报表对象上的方法外，还包括 FR 对象和 FS 对象上的方法。

g() 获取的报表对象上的方法，如下表所示，详细介绍可见：全局接口

接口	说明	移动端	10.0 版本
_g()	获取报表对象，获取后结合报表对象的方法使用	支持	支持，但 10.0 支持的范围和方法较少，11.0 新增部分方法
getParameterContainer	获取报表中参数面板对象，获取后结合参数面板接口使用	支持	不支持，11.0 新增的接口
parameterCommit	提交参数后重新查询，刷新报表	支持	支持
loadContentPane	重新加载，刷新报表	支持	支持
getPreviewType	获取报表当前所在的预览模式	支持	不支持，11.0 新增的接口

FR 对象上的方法，如下表所示，详细介绍可见：全局接口-FR

接口	说明	移动端	10.0 版本
servletURL	获取 servletURL	支持	不支持，11.0 新增的接口
serverURL	获取 serverURL	不支持	不支持，11.0 新增的接口
server	获取 server	不支持	不支持，11.0 新增的接口
fineServletURL	获取 fineServletURL	不支持	不支持，11.0 新增的接口
SessionMgr.getSessionID	获取 sessionId	支持	不支持，11.0 新增的接口
showDialog	打开一个对话框	不支持	支持
closeDialog	关闭对话窗	不支持	支持
doHyperlinkByGet	Get 方法打开一个网页页面，可以传递参数，可以设置页面属性	支持	支持
doHyperlinkByPost	Post 方法打开一个网页页面，可以传递参数，可以设置页面属性	支持	支持
doURLPrint	调出打印工具，打印报表	不支持	支持
Msg	FR 内置的统一风格的消息框，可以替代 Window 中的 alert、confirm 以及 prompt 弹窗	支持	支持
remoteEvaluate	执行 FR 内置公式，返回公式计算结果	支持	支持
jsonEncode	对字符串进行 jsonEncode 编码	不支持	支持
jsonDecode	对字符串进行 jsonDecode 解码	不支持	支持
ajax	封装过的 jQuery.ajax() 函数	支持	支持
isEmpty	判断对象是否为空	不支持	支持
isArray	判断对象是否为数组	不支持	支持

FR 对象上的方法，仅移动端支持的，如下表所示，详细介绍可见：移动端专有

接口	说明	移动端	10.0 版本
location	用于实现定位功能，获取经纬度，可以在https、企业微信、钉钉中使用	支持	支持
Mobile.getDeviceInfo	获取设备信息	支持	支持

FS 对象上的方法，如下表所示，详细介绍可见：全局接口-FS

接口	说明	移动端	10.0 版本
signOut	登出数据决策系统，即返回决策平台登录界面	不支持	支持
tabPane.closeActiveTab	关闭数据决策系统的标签页，即自动关闭决策系统中打开的预览模板	支持	支持
tabPane.addItem	在数据决策系统中打开新标签页	支持	支持

参数面板接口

参数面板接口可用于调整参数面板的一些属性，如下表所示，详细介绍可见：参数面板接口

接口	说明	移动端	10.0 版本
getWidgetByName	获取参数面板中的控件，结合控件的方法使用	支持	支持，但注意获取参数面板的接口有变化
collapse	收起参数面板	支持	不支持，11.0 新增的接口
expand	展开参数面板	支持	不支持，11.0 新增的接口
submit	自动提交后查询	支持	不支持，11.0 新增的接口

控件接口

控件接口主要用于修改参数面板中控件、填报单元格中控件、决策报表 body 中控件的属性。控件接口分通用和专有，通用接口除特殊外所有控件都可以用，专有接口只能指定的控件用。

获取控件的接口，只能在控件的「事件」中使用，如下表所示，详细介绍可见：获取控件

接口	说明	移动端	10.0 版本
this	在控件的事件中使用，获取当前的控件对象，获取后可以使用控件的方法和属性	支持	支持
this.options.form	在控件的事件中调用，可以使用参数面板接口的所有方法	支持	支持

通用接口，如下表所示，详细介绍可见：控件通用

注：11.0 获取参数面板的接口有变化，如果是通过获取参数面板接口后再继承以下接口使用，需特别注意和 10.0 的区别。

接口	说明	移动端	10.0 版本
getValue	获取控件的实际值	支持	支持
getText	获取控件的显示值	支持	支持
setValue	设置控件的值	支持	支持
visible	设置控件可见	支持	支持
invisible	设置控件不可见	支持	支持
setVisible	设置控件可见/不可见	支持	支持
isVisible	控件是否可见	支持	支持
setEnable	设置控件可用/不可用	支持	支持
isEnabled	控件是否可用	支持	支持
reset	重置控件、清空控件的内容	支持	支持
getType	获取控件类型	支持	不支持，11.0 新增的接口
setWaterMark	添加水印文字（仅支持有输入框的控件）	支持	不支持，11.0 新增的接口
fireEvent	调用控件事件	支持	支持
setPopupStyle	设置控件下拉选项框的样式，仅支持有选项框的控件	不支持	不支持，11.0 新增的接口
return false	在控件的特定事件中加入 return false，不触发联动、查询	不支持	支持

「日期控件」专有接口，如下表所示，详细介绍可见：日期控件专有

接口	说明	移动端	10.0 版本
setMaxAndMinDate	设置日期控件的可选日期范围	支持	不支持，11.0 新增的接口
setPopupStyle	设置弹出框样式，仅支持有弹出框的控件	不支持	不支持，11.0 新增的接口

「按钮控件」专有接口，如下表所示，详细介绍可见：按钮控件专有

接口	说明	移动端	10.0 版本
doClick	触发按钮的点击事件，相当于人工点击	支持	不支持，11.0 新增的接口

「下拉框」控件专有接口，如下表所示，详细介绍可见：下拉框控件专有

接口	说明	移动端	10.0 版本
setName4Empty	修改下拉框控件下拉时的默认文字“不选”	不支持	不支持，11.0 新增的接口

表格接口

表格接口主要用于修改报表中表格内容，根据应用场景可分成跑马灯接口、隐藏滚动条接口、修改单元格背景接口、修改单元格字体接口、修改行高列宽接口、获取和设置单元格值接口、设置单元格提示、设置单元格样式。

跑马灯接口如下表所示，详细介绍可见：跑马灯接口

接口	说明	移动端	10.0 版本
startMarquee	开启跑马灯效果	不支持	支持，10.0.19 及之后支持
stopMarquee	关闭跑马灯效果	不支持	支持，10.0.19 及之后支持

隐藏滚动条接口如下表所示，详细介绍可见：隐藏滚动条接口

接口	说明	移动端	10.0 版本
setHScrollBarVisible	设置横向滚动条显示/隐藏	不支持	支持，10.0.19 及之后支持
setVScrollBarVisible	设置纵向滚动条显示/隐藏	不支持	支持，10.0.19 及之后支持

注：以下接口报表块对象接口、报表块行列对象接口、报表块单元格对象接口 11.0.10 及以后才支持普通报表。

报表块对象接口，用于定位报表块中单元格元素和设置报表块基本属性。如下表所示，详细介绍可见：报表块对象接口

接口	说明	移动端	10.0 版本
getCell(row,col)	获取报表块第 row 行，第 col 列的单元格对象	支持	不支持，11.0 新增的接口
getRow(index)	获取报表块第 index 行所有单元格对象	支持	不支持，11.0 新增的接口
getColumn(index)	获取报表块第 index 列所有单元格对象	支持	不支持，11.0 新增的接口
getRowCount()	获取报表块共有多少行，计算的是扩展后的行数	支持	不支持，11.0 新增的接口
getColumnCount()	获取报表块共有多少列，计算的是扩展后的列数	支持	不支持，11.0 新增的接口
onMouseClick(func)	用于绑定鼠标/手指点击事件，当鼠标/手指点击报表块时，触发绑定的这个事件	不支持	不支持，11.0 新增的接口
onMouseMoveInCell(func)	用于绑定鼠标/手指移入单元格事件，当鼠标/手指移入单元格时，触发绑定的这个事件	不支持	不支持，11.0 新增的接口
onMouseMoveOutCell(func)	用于绑定鼠标/手指移出单元格事件，当鼠标/手指移出单元格时，触发绑定的这个事件	不支持	不支持，11.0 新增的接口
scrollTo(opts)	设置报表块自动滚动到某个位置	支持	不支持，11.0 新增的接口
getScrollOffset()	获取报表块滚动到的位置	支持	不支持，11.0 新增的接口
setRadius(radius, range, single)	给报表所有单元格设置圆角，单元格必须有背景色，否则无法看出效果。	不支持	不支持，11.0 新增的接口
showToolTip(opts)	设置报表块所有单元格提示	不支持	不支持，11.0 新增的接口

报表块行列对象主要是报表块行列上的方法，用来设置报表块行列属性。如下表所示，详细介绍可见：报表块行列对象接口

接口	说明	移动端	10.0 版本
setHeight(height)	设置单元格行高。	不支持	不支持，11.0 新增的接口
getHeight()	获取单元格行高。	支持	不支持，11.0 新增的接口
getCell(col)	获取单元格某一行上第 col 列的单元格对象。	支持	不支持，11.0 新增的接口
setWidth(width)	设置单元格列宽。	不支持	不支持，11.0 新增的接口
getWidth()	获取单元格列宽。	支持	不支持，11.0 新增的接口
getCell(row)	获取单元格某一列上第 row 行的单元格对象。	支持	不支持，11.0 新增的接口
getIndex()	获取单元格行对象/单元格列对象的位置索引	支持	不支持，11.0 新增的接口
setStyle(opts)	设置单元格行/列对象的样式	支持	不支持，11.0 新增的接口
showToolTip(opts)	给报表块单元格行/列添加提示。	支持	不支持，11.0 新增的接口

报表块单元格接口主要是报表块单元格上的方法，用来设置报表块中单元格的属性。如下表所示，详细介绍可见：报表块单元格对象接口

接口	说明	移动端	10.0 版本
getPosition()	获取当前单元格位置信息，使用时需要先获取到单元格对象	支持	不支持，11.0 新增的接口
getRow()	获取当前单元格所在的行单元格对象。	支持	不支持，11.0 新增的接口
getColumn()	获取当前单元格所在的列单元格对象。	支持	不支持，11.0 新增的接口
getValue()	获取单元格的值	支持	不支持，11.0 新增的接口
showToolTip(opts)	给报单元格添加提示	不支持	不支持，11.0 新增的接口
setStyle(opts)	设置单元格对象的样式	支持	不支持，11.0 新增的接口

样式属性 style，JS API 中有样式参数的接口中使用，符合 css 的规范，用来设置边框、背景、颜色、文字等样式。详细介绍见：样式属性style

注：以下表格接口 11.0.10 版本及以后已有功能更完善的替代接口，用户可使用新接口。详情可看：表格历史接口

修改单元格背景接口如下表所示，详细介绍可见：修改单元格背景

接口	说明	移动端	10.0 版本
addEffect	type: 'highlightRow'，鼠标点击或者悬浮单元格时，单元格所在的行变色	支持	不支持，11.0 新增的接口
	type: 'highlightCross'，鼠标点击或者悬浮单元格时，单元格所在的列变色	支持	不支持，11.0 新增的接口
	type: 'highlightCol'，鼠标点击或者悬浮单元格时，单元格所在的行列变色	支持	不支持，11.0 新增的接口
	type: 'highlightCell'，鼠标点击或者悬浮单元格时，单元格变色	支持	不支持，11.0 新增的接口

修改单元格字体接口，如下表所示，详细介绍可见：修改单元格字体

接口	说明	移动端	10.0 版本
addEffect	type: 'setCellFont'，鼠标点击或者悬浮单元格时，单元格字体格式变化	支持	不支持，11.0 新增的接口
	type: 'setRowFont' ，鼠标点击或者悬浮单元格时，单元格所在行字体格式变化	支持	不支持，11.0 新增的接口
	鼠标点击或者悬浮单元格所在行字体变化，鼠标点击或悬浮其他行恢复	支持	不支持，11.0 新增的接口

设置单元格提示接口，如下表所示，详细介绍可见：设置单元格提示

接口	说明	移动端	10.0 版本
addEffect	type: 'setCellFont'，鼠标悬浮出现文字/图片提示框	不支持	不支持，11.0 新增的接口

修改行高列宽接口，如下表所示，详细介绍可见：修改行高列宽

接口	说明	移动端	10.0 版本
setRowHeight	改变单元格行高	不支持	不支持，11.0 新增的接口
setColWidth	改变单元格列高	不支持	不支持，11.0 新增的接口

修改单元格字体接口，如下表所示，详细介绍可见：获取和设置单元格值

接口	说明	移动端	10.0 版本
getCellValue	获取特定单元格的值，参数可以为单元格地址，也可以为单元格行列号	部分支持	支持，10.0 仅支持填报下使用
setCellValue	给特定单元格赋值，参数可以为单元格地址，也可以为单元格行列号	部分支持	支持，10.0 仅支持填报下使用

设置单元格样式接口，如下表所示，详细介绍可见：设置单元格样式

接口	说明	移动端	10.0 版本
setCellRadius	给报表所有单元格设置圆角，单元格必须有背景色，否则无法看出效果。	不支持	不支持，11.0 新增的接口

工具栏接口

工具栏接口主要用于修改工具栏属性和工具栏中按钮属性，分工具栏接口、工具栏按钮通用接口、工具栏按钮专用接口。

工具栏接口，如下表所示，详细介绍可见：工具栏

接口	说明	移动端	10.0 版本
getWidgetByName	获取报表工具栏中的按钮，可结合按钮的方法使用	不支持	支持
toolBarFloat	设置工具栏显示位置	不支持	不支持，11.0 新增的接口
setStyle	修改工具栏大小	不支持	不支持，11.0 新增的接口
setVisible	设置工具栏显示/隐藏	支持	不支持，11.0 新增的接口

工具栏按钮通用接口，除特殊外所有工具栏按钮都可以用，如下表所示，详细介绍可见：工具栏按钮通用

接口	说明	移动端	10.0 版本
visible	设置工具栏某个按钮可见	不支持	支持
invisible	设置工具栏某个按钮不可见	不支持	支持
setVisible	设置工具栏某个按钮不可见/不可见	不支持	支持
isVisible	工具栏某个按钮是否可见	不支持	支持
setEnable	设置工具栏某个按钮可用/不可用	不支持	支持
isEnabled	工具栏某个按钮是否可用	不支持	支持

邮件按钮专有接口，只邮件按钮可用，如下表所示，详细介绍可见：邮件按钮专有

接口	说明	移动端	10.0 版本
changeFormat	修改邮件支持的格式选项	不支持	不支持，11.0 新增的接口

报表分页接口

报表分页接口主要用于分页报表，如下表所示，详细介绍可见：报表分页

接口	说明	移动端	10.0 版本
gotoPreviousPage	跳转到上一页	支持	支持
gotoNextPage	跳转到下一页	支持	支持
gotoLastPage	跳转到最后一页	支持	支持
gotoFirstPage	跳转到第一页	支持	支持
gotoPage	跳转到指定页	支持	支持
getCurrentPageIndex	获取当前页页码	支持	不支持，11.0 新增的接口
getReportTotalPage	获取总页数	支持	不支持，11.0 新增的接口
currentPageIndex	报表当前页的页码	支持	支持
reportTotalPage	报表的总页数	支持	支持

报表导出接口

导出接口，主要用于报表导出，如下表所示，详细介绍可见：导出接口

接口	说明	移动端	10.0 版本
exportReportToExcel	将报表导出成 Excel	部分支持	支持
exportReportToImage	将报表导出成图片	部分支持	支持
exportReportToPDF	将报表导出成 PDF	部分支持	支持
exportReportToWord	将报表导出成 Word	部分支持	支持

普通报表

普通报表接口，即只有 cpt 普通报表可用，分公共部分和专有部分，公共部分即所有的预览模式都可以使用，专有部分只能在对应预览模式下使用。

公共接口

公共部分接口如下表所示，详细介绍可见：公共部分

接口	说明	移动端	10.0 版本
getToolbar	获取工具栏对象	支持	不支持，11.0 新增的接口

分页预览接口

分页预览专有接口如下表所示，详细介绍可见：分页预览专有

接口	说明	移动端	10.0 版本
expandNodeLayer	将折叠树展开到 N 层节点	不支持	仅安装新引擎插件 V1.6.0 版本及以后支持
collapseNodeLayer	将折叠树收起到 N 层节点	不支持	仅安装新引擎插件 V1.6.0 版本及以后支持
expandAllNodeLayer	展开折叠树的所有节点	不支持	不支持
collapseAllNodeLayer	收起折叠树的所有节点	不支持	不支持

填报预览接口

填报预览专有接口如下表所示，详细介绍可见：填报预览专有

接口	说明	移动端	10.0 版本
getWidgetByName	通过控件名称获取填报单元格中的控件	支持	支持
getWidgetByCell	通过单元格地址获取填报单元格中的控件	支持	支持
getWidgetsByName	通过控件名称获取填报单元格具有同一名字的控件	支持	支持
appendReportRC	在特定的位置插入行	不支持	支持
appendReportRow	插入行	支持	支持
deleteReportRC	删除行	不支持	支持
deleteRows	删除行	不支持	支持
refreshAllSheets	重新查询，刷新所有 sheet，刷新后会停留在上次查看的 sheet	支持	支持
loadSheetByIndex	切换到指定 sheet，参数是 sheet 序号	不支持	支持
loadSheetByName	切换到指定 sheet，参数可以是 sheet 名称	不支持	支持
isDirtyPage	判断页面是否被编辑过	不支持	支持
isAutoStash	判断是否开启自动暂存，自动暂存可参考：填报暂存	不支持	支持
writeReport	强制提交，不校验	支持	支持
verifyAndWriteReport	校验并提交报表	支持	支持
verifyReport	数据校验	支持	支持
importExcel	导入 Excel	不支持	支持
importExcel_Append	「增量导入」的方式导入 Excel	不支持	支持
importExcel_Clean	「清空导入」的方式导入 Excel	不支持	支持
importExcel_Cover	「覆盖导入」的方式导入 Excel	不支持	支持
stash	暂存	不支持	支持
clear	清空暂存	不支持	支持

数据分析接口

数据分析专有接口如下表所示，详细介绍可见：数据分析专有

接口	说明	移动端	10.0 版本
centerReport	「数据分析」预览时，设置报表居中显示	不支持	不支持，11.0 新增的接口
expandNodeLayer	「数据分析」预览时，将折叠树展开到 N 层节点	不支持	不支持，11.0 新增的接口
collapseNodeLayer	「数据分析」预览时，将折叠树收起到 N 层节点	不支持	不支持，11.0 新增的接口
expandAllNodeLayer	「数据分析」预览时，展开折叠树的所有节点	不支持	不支持，11.0 新增的接口
collapseAllNodeLayer	「数据分析」预览时，收起折叠树的所有节点	不支持	不支持，11.0 新增的接口

决策报表

决策报表的接口，即只有 frm 决策报表可用，分获取组件接口、组件通用接口、Tab 组件接口。

获取组件接口

获取组件接口如下表所示，详细介绍可见：获取组件

接口	说明	移动端	10.0 版本
getAllWidgets	获取报表对象中所有组件信息	支持	不支持，11.0 新增的接口
getWidgetByName	获取报表对象中的某个组件，可以获取到 body 中的组件和参数面板中的控件	支持	支持

组件通用接口

组件通用接口即决策报表中所有组件都可以用，如下表所示，详细介绍可见：组件通用

接口	说明	移动端	10.0 版本
visible	设置组件可见	支持	支持
invisible	设置组件不可见	支持	支持
setVisible	设置组件可见/不可见	支持	支持
isVisible	返回组件是否可见	支持	支持

Tab 组件接口

Tab 组件接口用于修改 Tab 组件的属性，如下表所示，详细介绍可见：Tab组件

接口	说明	移动端	10.0 版本
showCardByIndex	获取正在展示的 Tab 页的定位索引	支持	支持
setTabVisible	设置某个 Tab 页显示/隐藏	支持	支持
getShowIndex	设置 Tab 块标题显示/隐藏	支持	支持
setTitleVisible	展示第 N 个 Tab 页	不支持	支持

报表块接口

报表块接口用于修改报表块组件的属性。

报表块工具栏接口，用于获取报表块工具栏，获取到后修改工具栏属性。如下表所示，详细介绍可见：报表块工具栏接口

接口	说明	移动端	10.0 版本
getToolbar(index)	获取获取报表块的工具栏，在工具栏打开的情况下使用	支持	不支持，11.0 新增的接口

FVS 大屏报表

适用于安装了「FVS大屏编辑模式」插件的用户，详细介绍见：FVS大屏JS接口汇总。

上一篇：JS API

下一篇：JS API兼容说明

有帮助
没帮助
只是浏览

售前咨询电话

400-811-8890转1

在线技术支持

请前往「服务平台」，选择「在线支持」

热线电话：400-811-8890转2

总裁办24H投诉

热线电话：173-1278-1526

文档反馈

鼠标选中内容，快速反馈问题

鼠标选中存在疑惑的内容，即可快速反馈问题，我们将会跟进处理。

不再提示

10s后关闭

JS API接口汇总