历史版本2 :JS API接口汇总 返回文档
编辑时间:
内容长度:图片数:目录数:
修改原因:
本页汇总了JS API 的所有接口,可简单查看功能和移动端支持情况,接口详细请查看对应的接口介绍。
公共模块编辑
全局接口
全局接口:
接口 | 说明 | 移动端 |
---|---|---|
_g() | 获取报表对象,获取后结合报表对象的方法使用 | 支持 |
getParameterContainer | 获取报表中参数面板对象,获取后结合 参数面板接口 使用 | 支持 |
parameterCommit | 提交参数后重新查询,刷新报表 | 支持 |
loadContentPane | 重新加载,刷新报表 | 支持 |
getPreviewType | 获取报表当前所在的预览模式 | 支持 |
接口 | 说明 | 移动端 |
---|---|---|
servletURL | 获取 servletURL | 支持 |
serverURL | 获取 serverURL | 不支持 |
server | 获取 server | 不支持 |
fineServletURL | 获取 fineServletURL | 不支持 |
SessionMgr.getSessionID | 获取 sessionId | 不支持 |
showDialog | 打开一个对话框 | 不支持 |
closeDialog | 关闭对话窗 | 不支持 |
doHyperlinkByGet | Get 方法打开一个网页页面,可以传递参数,可以设置页面属性 | 支持 |
doHyperlinkByPost | Post 方法打开一个网页页面,可以传递参数,可以设置页面属性 | 支持 |
doURLPrint | 调出打印工具,打印报表 | 不支持 |
Msg | FR 内置的统一风格的消息框,可以替代 Window 中的 alert、confirm 以及 prompt 弹窗 | 支持 |
remoteEvaluate | 执行 FR 内置公式,返回公式计算结果 | 支持 |
jsonEncode | 对字符串进行 jsonEncode 编码 | 不支持 |
jsonDecode | 对字符串进行 jsonEncode 解码 | 不支持 |
ajax | 封装过的 jQuery.ajax() 函数 | 支持 |
isEmpty | 判断对象是否为空 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
signOut | 登出数据决策系统,即返回决策平台登录界面。 | 不支持 |
tabPane.closeActiveTab | 关闭数据决策系统的标签页,即自动关闭决策系统中打开的预览模板。 | 支持 |
tabPane.addItem | 在数据决策系统中打开新标签页。 | 支持 |
参数面板接口
接口 | 说明 | 移动端 |
---|---|---|
getWidgetByName | 获取参数面板中的控件,结合控件的方法使用 | 支持 |
控件
接口 | 说明 | 移动端 |
---|---|---|
getValue | 获取控件的实际值 | 支持 |
getText | 获取控件的显示值 | 支持 |
setValue | 设置控件的值 | 支持 |
visible | 设置控件可见 | 支持 |
invisible | 设置控件不可见 | 支持 |
setVisible | 设置控件可见/不可见 | 支持 |
isVisible | 控件是否可见 | 支持 |
setEnable | 设置控件可用/不可用 | 支持 |
isEnabled | 控件是否可用 | 支持 |
reset | 重置控件、清空控件的内容 | 支持 |
getType | 获取控件类型 | 支持 |
setWaterMark | 添加水印文字(仅支持有输入框的控件) | 支持 |
fireEvent | 调用控件事件 | 支持 |
setPopupStyle | 设置控件下拉选项框的样式,仅支持有选项框的控件 | 不支持 |
return false | 在控件的特定事件中加入 return false,不触发联动、查询 | 不支持 |
this.options.form | 在控件的事件中调用,可以使用 参数面板接口 的所有方法 | 支持 |
接口 | 说明 | 移动端 |
---|---|---|
setMaxAndMinDate | 设置日期控件的可选日期范围 | 支持 |
setPopupStyle | 设置弹出框样式,仅支持有弹出框的控件 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
doClick | 触发按钮的点击事件,相当于人工点击 | 支持 |
接口 | 说明 | 移动端 |
---|---|---|
setName4Empty | 修改下拉框控件下拉时的默认文字“不选” | 不支持 |
工具栏
接口 | 说明 | 移动端 |
---|---|---|
getWidgetByName | 获取报表工具栏中的按钮,可结合按钮的方法使用 | 不支持 |
toolBarFloat | 设置工具栏显示位置 | 不支持 |
setStyle | 修改工具栏大小 | 不支持 |
setVisible | 设置工具栏显示/隐藏 | 支持 |
接口 | 说明 | 移动端 |
---|---|---|
visible | 设置工具栏某个按钮可见 | 不支持 |
invisible | 设置工具栏某个按钮不可见 | 不支持 |
setVisible | 设置工具栏某个按钮不可见/不可见 | 不支持 |
isVisible | 工具栏某个按钮是否可见 | 不支持 |
setEnable | 设置工具栏某个按钮可用/不可用 | 不支持 |
isEnabled | 工具栏某个按钮是否可用 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
changeFormat | 修改邮件支持的格式选项 | 不支持 |
表格
接口 | 说明 | 移动端 |
---|---|---|
startMarquee | 开启跑马灯效果 | 不支持 |
stopMarquee | 关闭跑马灯效果 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
setHScrollBarVisible | 设置横向滚动条显示/隐藏 | 不支持 |
setVScrollBarVisible | 设置横向纵向滚动条显示/隐藏 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
makeHighlightLine | 鼠标点击或者悬浮单元格时,单元格所在的行变色,点击或移动到其他行时恢复 | 支持 |
makeHighlightLineHold | 鼠标点击或者悬浮单元格时,单元格所在的行变色,再次点击或悬浮时恢复 | 支持 |
makeHighlightColumn | 鼠标点击或者悬浮单元格时,单元格所在的列变色,点击或移动到其他列时恢复 | 支持 |
makeHighlightColumn | 鼠标点击或者悬浮单元格时,单元格所在的列变色,再次点击或悬浮时恢复 | 支持 |
makeHighlightCross | 鼠标点击或者悬浮单元格时单元格所在的行和列变色,点击或移动到其他行列时恢复 | 支持 |
makeHighlightCrossHold | 鼠标点击或者悬浮单元格时单元格所在的行和列变色,再次点击或悬浮时恢复 | 支持 |
makeHighlightCell | 鼠标点击或者悬浮单元格时单元格变色,点击或移动到其他行列时恢复 | 支持 |
makeHighlightCellHold | 鼠标点击或者悬浮单元格时单元格变色,再次点击或悬浮时恢复 | 支持 |
接口 | 说明 | 移动端 |
---|---|---|
makeFontCell | 鼠标点击或者悬浮单元格时,单元格所在的行变色,点击或移动到其他行时恢复 | 支持 |
makeFontCellHold | 鼠标点击或者悬浮所在单元格字体变化,鼠标再次点击变色行恢复,或悬浮移开恢复 | 支持 |
makeFontLine | 鼠标点击或者悬浮单元格所在行字体变化,鼠标点击或悬浮其他行恢复 | 支持 |
makeFontLineHold | 鼠标点击或者悬浮单元格所在行字体变化,鼠标再次点击变色行恢复,或悬浮移开恢复 | 支持 |
接口 | 说明 | 移动端 |
---|---|---|
makeRowHeight | 改变单元格行高 | 不支持 |
makeColWidth | 改变单元格列高 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
getCellValue | 获取特定单元格的值,参数可以为单元格地址,也可以为单元格行列号 | 不支持 |
setCellValue | 给特定单元格赋值,参数可以为单元格地址,也可以为单元格行列号 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
makeHoverTooltip | 鼠标悬浮出现提示框 | 不支持 |
makeHoverImageTooltip | 鼠标悬浮单元格时显示图片 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
makeCellRadius | 给报表所有单元格设置圆角,单元格必须有背景色,否则无法看出效果。 | 不支持 |
报表分页
接口 | 说明 | 移动端 |
---|---|---|
gotoPreviousPage | 跳转到上一页 | 支持 |
gotoNextPage | 跳转到下一页 | 支持 |
gotoLastPage | 跳转到最后一页 | 支持 |
gotoFirstPage | 跳转到第一页 | 支持 |
gotoPage | 跳转到指定页 | 支持 |
getCurrentPageIndex | 导出excel | 获取当前页页码 |
getReportTotalPage | 获取总页数 | 部分支持 |
currentPageIndex | 报表当前页的页码 | 部分支持 |
reportTotalPage | 报表的总页数 | 部分支持 |
接口 | 说明 | 移动端 |
---|---|---|
exportReportToExcel | 将报表导出成 Excel | 不支持 |
exportReportToImage | 将报表导出成图片 | 不支持 |
exportReportToPDF | 将报表导出成 PDF | 不支持 |
exportReportToWord | 将报表导出成 Word | 不支持 |
普通报表编辑
接口 | 说明 | 移动端 |
---|---|---|
getToolbar | 获取工具栏对象 | 支持 |
接口 | 说明 | 移动端 |
---|---|---|
expandNodeLayer | 展开折叠树第 N 层节点 | 不支持 |
collapseNodeLayer | 收起折叠树展开的第 N 层节点 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
getWidgetByName | 通过控件名称获取填报单元格中的控件 | 支持 |
getWidgetByCell | 通过单元格地址获取填报单元格中的控件 | 支持 |
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() | 清空暂存 | 不支持 |
接口 | 说明 | 移动端 |
---|---|---|
centerReport | 「数据分析」预览时,设置报表居中显示 | 不支持 |
决策报表编辑
接口 | 说明 | 移动端 |
---|---|---|
getAllWidgets | 获取报表对象中所有组件信息 | 支持 |
getWidgetByName | 获取报表对象中的某个组件,可以获取到 body 中的组件和参数面板中的控件 | 支持 |
接口 | 说明 | 移动端 |
---|---|---|
visible | 设置组件可见 | 支持 |
invisible | 设置组件不可见 | 支持 |
setVisible | 设置组件可见/不可见 | 支持 |
isVisible | 返回组件是否可见 | 支持 |
接口 | 说明 | 移动端 |
---|---|---|
showCardByIndex | 获取正在展示的 Tab 页的定位索引 | 支持 |
setTabVisible | 设置某个 Tab 页显示/隐藏 | 支持 |
getShowIndex | 设置 Tab 块标题显示/隐藏 | 支持 |
setTitleVisible | 展示第 N 个 Tab 页 | 不支持 |