反馈已提交

网络繁忙

FVS大屏JS接口汇总

  • 文档创建者:Alicehyy
  • 历史版本:10
  • 最近更新:Alicehyy 于 2023-03-17
  • 适用场景:安装了「FVS大屏编辑模式」插件的用户,可参考本文了解 FVS 大屏模板相关 JS 接口。

    注:不支持移动端。

    1. 版本

    报表服务器版本
    JAR包插件版本功能变动
    11.02021-11-15V1.0.0
    -
    11.0.6-V1.5.0新增六类「控件」组件,新增控件支持的事件与接口
    11.0.7-V1.8.0FVS 补充支持决策报表支持的所有接口
    11.0.9-V1.9.1FVS轮播器组件支持接口 getShowIndex()、showCardByIndex()
    11.0.9-V1.10.1FVS轮播器组件支持接口 setTabVisible()
    11.0.9-V1.13.0自定义模型组件新增接口 animateSceneTime()

    2. 接口索引

    2.1 全局接口

    全局接口基本用于大屏报表主体,如下表所示,详细介绍可见:全局接口 。

    接口说明
    duchamp获取大屏报表中的组件对象,获取后结合对象的方法使用
    servletURL获取 servletURL
    serverURL获取 serverURL
    server获取 server
    fineServletURL获取 fineServletURL
    SessionMgr.getSessionID获取 sessionId
    showDialog打开一个对话框
    closeDialog关闭对话窗
    doHyperlinkByGetGet 方法打开一个网页页面,可以传递参数,可以设置页面属性
    doHyperlinkByPostPost 方法打开一个网页页面,可以传递参数,可以设置页面属性
    MsgFR 内置的统一风格的消息框,可以替代替代 Window 中的 alert、confirm 、 prompt 以及 toast 弹窗。详细介绍可见:FR.Msg
    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触发页面全屏
    reload触发模板整体自动刷新

    2.3 三维组件接口

    FVS 三维组件接口支持所有三维组件,如下表所示,详细介绍可见:FVS三维组件接口

    接口说明
    getDataLayers获取三维组件所有的数据图层
    getDataLayerByName获取三维组件的某个具体数据图层
    animateSceneTime设置自定义模型场景时间动态变化

    2.4 控件组件接口

    FVS 控件组件接口如下表所示,详细介绍可见:控件通用 。

    接口
    说明
    getValue获取控件的实际值
    getText获取控件的显示值
    setValue设置控件的值
    setVisible设置控件可见/不可见
    isVisible

    返回控件状态是可见/不可见

    setEnable设置控件可用/不可用
    isEnabled

    返回控件状态是可用/不可用

    reset重置控件、清空控件的内容
    setWaterMark添加水印文字(仅支持有输入框的控件)

    2.5 表格组件接口

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

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

    接口
    说明
    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)设置表格所有单元格提示

    表格行列对象主要是表格组件行列上的方法,用来设置表格行列属性。如下表所示,详细介绍可见:表格行列对象接口 。

    接口
    说明
    setHeight(height)设置单元格行高
    getHeight()获取单元格行高
    setWidth(width)设置单元格列宽
    getWidth()获取单元格列宽
    getIndex()获取单元格行对象/单元格列对象的位置索引
    setStyle(opts)设置单元格行/列对象的样式
    showToolTip(opts)给表格单元格行/列添加提示

    表格单元格接口主要是表格组件单元格上的方法,用来设置单元格的属性。如下表所示,详细介绍可见:单元格对象接口 。

    接口
    说明
    getPosition()获取当前单元格位置信息,使用时需要先获取到单元格对象
    getRow()获取当前单元格所在的行单元格对象
    getColumn()获取当前单元格所在的列单元格对象
    getValue()获取单元格的值
    showToolTip(opts)给报单元格添加提示
    setStyle(opts)设置单元格对象的样式

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

    2.6 轮播器组件接口

    FVS 轮播器组件接口如下表所示,详细介绍可见:FVS轮播器组件接口

    接口
    说明
    getShowIndex()获取轮播器组件正在展示的 Tab 页的索引
    showCardByIndex()设置轮播器组件展示第 n 个 Tab 页
    setTabVisible()显示/隐藏轮播器某个 Tab 页及内容


    附件列表


    主题: FVS大屏编辑模式
    • 有帮助
    • 没帮助
    • 只是浏览

    售前咨询电话

    400-811-8890转1

    在线技术支持

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

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

    总裁办24H投诉

    热线电话:173-1278-1526

    文 档反 馈

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

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

    不再提示

    10s后关闭