历史版本25 :FVS支持的JS接口汇总 返回文档
编辑时间:
内容长度:图片数:目录数:
修改原因:
1. 版本编辑
| 报表服务器版本 | JAR包 | 插件版本 | 功能变动 |
|---|---|---|---|
| 11.0 | 2021-11-15 | V1.0.0 | 最低版本要求 |
2. 接口索引编辑
2.1 全局接口
全局接口基本用于大屏报表主体，如下表所示，详细介绍可见：全局接口 。
| 接口 | 说明 |
|---|---|
| duchamp | 获取大屏报表中的组件对象，获取后结合对象的方法使用 |
| servletURL | 获取 servletURL |
| serverURL | 获取 serverURL |
| server | 获取 server |
| fineServletURL | 获取 fineServletURL |
| SessionMgr.getSessionID | 获取 sessionId |
| showDialog | 打开一个对话框 |
| closeDialog | 关闭对话窗 |
| doHyperlinkByGet | Get 方法打开一个网页页面，可以传递参数，可以设置页面属性 |
| doHyperlinkByPost | Post 方法打开一个网页页面，可以传递参数，可以设置页面属性 |
| Msg | FR 内置的统一风格的消息框，可以替代 Window 中的 alert、confirm 、 prompt 以及 toast 弹窗。详细介绍可见：FR.Msg |
| remoteEvaluate | 执行 FVS 内置公式，返回公式计算结果 |
| jsonEncode | 对字符串进行 jsonEncode 编码 |
| jsonDecode | 对字符串进行 jsonEncode 解码 |
| ajax | 封装过的 jQuery.ajax() 函数，详细介绍可见：ajax |
| isEmpty | 判断对象是否为空 |
| isArray | 判断对象是否为数组 |
| cellStr2ColumnRow | 根据单元格编号获取行列索引 |
| columnRow2CellStr | 根据行列号获取单元格编号 |
2.2 页面接口
FVS 页面接口主要用于获取页面上的组件对象，以及分页相关接口。如下表所示，详细介绍可见：FVS页面接口 。
| 接口 | 说明 |
|---|---|
| this | 获取当前的组件对象，获取后可以使用组件的方法和属性 |
| getAllWidgets | 获取当前页面中所有组件 |
| getWidgetByName | 获取当前页面中的某个组件 |
| switchStory | 切换到某个页面 |
| nextStory | 切换到下一页 |
| previousStory | 切换到上一页 |
| refresh | 触发组件刷新，V1.9.1 版本及之后的插件在刷新的同时还支持传参 |
| trigger | 触发组件所有的点击事件 |
| requestFullscreen | 触发页面全屏 |
| exitFullscreen | 关闭页面全屏，仅针对 requestFullscreen 接口有效，对 F11 触发的全屏无效 |
| reload | 触发模板整体自动刷新 |
| setPageButtonDisplayPolicy | 可设置分页切换按钮显隐状态 |
2.3 三维组件接口
FVS 三维组件接口如下表所示，详细介绍可见：FVS三维组件接口 。
| 接口 | 说明 |
|---|---|
| getDataLayers | 获取三维组件所有的数据图层 |
| getDataLayerByName | 获取三维组件的某个具体数据图层 |
| animateSceneTime | 设置自定义模型场景时间动态变化，仅支持 自定义模型组件 |
| getMeshByName | 根据自定义模型 mesh 名称搜索模型对象，结合其属性实现对模型的一些操作 |
| setVisible | 使用 getMeshByName 获取模型对象后，设置模型对象是否可见 |
| setScaling | 使用 getMeshByName 获取模型对象后，设置模型对象的缩放比例 |
| setRotation | 使用 getMeshByName 获取模型对象后，设置模型对象的旋转角度 |
| setPosition | 使用 getMeshByName 获取模型对象后，设置模型对象的位置 |
| focus | 使用 getMeshByName 获取模型对象后，设置模型对象快速聚焦 |
rotateTo rotateForwardTo scaleTo moveTo | 使用 getMeshByName 获取模型对象后，设置模型对象改变角度、朝向、缩放大小、移动位置等运动效果 详情请参见：模型轨迹运动接口 |
| refreshData | 传参并刷新三维组件数据 |
| subscribeMarkerData | 订阅监听三维组件数据图层中的数据更新，需配合刷新接口使用 |
| updateMarkerData | 可单独更新三维组件数据图层中指定模型对象数据 |
| getRoamAnimations | 获取三维组件的所有漫游路径信息（目前仅支持返回漫游路径名称） |
| playRoamAnimations | 播放漫游动画 |
| updateRoamAnimationAction | 暂停/继续/退出播放漫游动画 |
2.4 控件组件接口
FVS 控件组件接口如下表所示，详细介绍可见：控件通用 。
| 接口 | 说明 |
|---|---|
| getValue | 获取控件的实际值 注：V1.16.0 及之后版本， 标题组件 也支持使用 getValue |
| getText | 获取控件的显示值 |
| setValue | 设置控件的值 |
| setVisible | 设置控件可见/不可见 |
| isVisible | 返回控件状态是可见/不可见 |
| setEnable | 设置控件可用/不可用 |
| isEnabled | 返回控件状态是可用/不可用 |
| reset | 重置控件、清空控件的内容 |
| setWaterMark | 添加水印文字（仅支持有输入框的控件） |
2.5 表格组件接口
表格接口用于修改表格组件的属性。
1）表格对象接口，用于定位表格组件中单元格元素和设置表格基本属性。如下表所示，详细介绍可见：表格对象接口 。
| 接口 | 说明 |
|---|---|
| getCell(row, col) | 获取表格第 row 行，第 col 列的单元格对象 |
| getRow(index) | 获取表格第 index 行所有单元格对象 |
| getColumn(index) | 获取表格第 index 列所有单元格对象 |
| getRowCount() | 获取表格共有多少行，计算的是扩展后的行数 |
| getColumnCount() | 获取表格共有多少列，计算的是扩展后的列数 |
| onMouseClick(func) | 用于绑定鼠标/手指点击事件，当鼠标/手指点击表格组件时，触发绑定的这个事件 |
| onMouseMoveInCell(func) | 用于绑定鼠标/手指移入单元格事件，当鼠标/手指移入单元格时，触发绑定的这个事件 |
| onMouseMoveOutCell(func) | 用于绑定鼠标/手指移出单元格事件，当鼠标/手指移出单元格时，触发绑定的这个事件 |
| scrollTo(opts) | 设置表格自动滚动到某个位置 |
| getScrollOffset() | 获取表格滚动到的位置 |
| setRadius(radius, range, single) | 给表格所有单元格设置圆角，单元格必须有背景色，否则无法看出效果 |
| showToolTip(opts) | 设置表格所有单元格提示 |
2）表格行列对象主要是表格组件行列上的方法，用来设置表格行列属性。如下表所示，详细介绍可见：表格行列对象接口 。
| 接口 | 说明 |
|---|---|
| setHeight(height) | 设置单元格行高 |
| getHeight() | 获取单元格行高 |
| setWidth(width) | 设置单元格列宽 |
| getWidth() | 获取单元格列宽 |
| getIndex() | 获取单元格行对象/单元格列对象的位置索引 |
| setStyle(opts) | 设置单元格行/列对象的样式 |
| showToolTip(opts) | 给表格单元格行/列添加提示 |
3）表格单元格接口主要是表格组件单元格上的方法，用来设置单元格的属性。如下表所示，详细介绍可见：单元格对象接口 。
| 接口 | 说明 |
|---|---|
| getPosition() | 获取当前单元格位置信息，使用时需要先获取到单元格对象 |
| getRow() | 获取当前单元格所在的行单元格对象 |
| getColumn() | 获取当前单元格所在的列单元格对象 |
| getValue() | 获取单元格的值 |
| showToolTip(opts) | 给单元格添加提示 |
| setStyle(opts) | 设置单元格对象的样式 |
样式属性 style，JS API 中有样式参数的接口中使用，符合 css 的规范，用来设置边框、背景、颜色、文字等样式。详细介绍可见：样式属性style 。
4）表格组件分页接口主要是针对「多分页表格组件」的方法，用于跳转分页或获取页码。如下表所示，详细介绍可见：报表分页接口 。
| 接口 | 说明 |
|---|---|
| gotoPreviousPage() | 表格组件跳转到上一页 |
| gotoNextPage() | 表格组件跳转到下一页 |
| gotoLastPage() | 表格组件跳转到最后一页 |
| gotoFirstPage() | 表格组件跳转到第一页 |
| gotoPage(pageNumber) | 表格组件跳转到指定页 |
| getCurrentPageIndex() | 获取表格组件当前页页码 |
| getReportTotalPage() | 获取表格组件总页数 |
2.6 轮播器组件接口
FVS 轮播器组件接口如下表所示，详细介绍可见：FVS轮播器组件接口 。
| 接口 | 说明 |
|---|---|
| getShowIndex() | 获取轮播器组件正在展示的 Tab 页的索引 |
| showCardByIndex() | 设置轮播器组件展示第 n 个 Tab 页 |
| setTabVisible() | 显示/隐藏轮播器某个 Tab 页及内容 |
2.7 图表组件接口
FVS 图表组件接口如下表所示，详细介绍可见：FVS图表接口 。
注：以下接口不支持 扩展图表 类型的图表组件。
| 接口 | 说明 |
|---|---|
| getSeries() | 获取图表组件系列对象数组 |
| series[seriesIndex] | 获取图表组件系列对象 |
| series.points | 获取图表系列对象之后获取其数据点对象 |
| setSeriesVisible() | 图表显示部分系列 |
| sortChart() | 图表排序接口 |
| openAutoTooltip() | 图表数据点提示轮播接口 注：该接口支持除轮播类图表以外的其他扩展图表 |
| setMapZoom() | 设置地图缩放等级和中心点 |
| getZoom() | 获取地图缩放层级 |
| getCenter() | 获取地图中心点 |
| panTo() | 设置地图转移中心点 |
| drillDown() | 钻取地图向下钻取 |
| drillUp() | 钻取地图向上钻取 |
| getLayerIndex() | 获取钻取地图当前钻取层级，获取的层级从0开始：0、1、2…… |
| getLayerNames() | 获取钻取目录名称，结果为数组，例如：["中国", "湖南省", "长沙市"] |
2.8 网页框接口
FVS 网页框与页面通信接口，可实现 FVS 网页框于模板页面之间的通信，详细介绍可见：FVS网页框与页面通信接口 。
| 接口 | 说明 |
|---|---|
| onlyCommunicateWithOrigins | 通信前指定和 FVS 通信的 origins，否则无法进行通信 |
| postMessage | 发送消息 |
| addPostMessageListener | 监听来自网页框（origins指定的）的信息 |
| removePostMessageListener | 删除 addPostMessageListener 添加的监听 |