反馈已提交

网络繁忙

FVS支持的JS接口汇总

  • 文档创建者:Alicehyy
  • 历史版本:38
  • 最近更新:Alicehyy 于 2024-05-13
  • 适用场景:安装了「FineVis数据可视化」插件的用户,可参考本文了解 FineVis 的相关功能。

    1. 版本

    报表服务器版本
    JAR包插件版本功能变动
    11.02021-11-15V1.0.0
    最低版本要求

    2. 接口索引

    2.1 全局接口

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

    接口说明
    duchamp获取 FVS 模板中的组件对象,获取后结合对象的方法使用
    servletURL获取 servletURL
    serverURL获取 serverURL
    server获取 server
    fineServletURL获取 fineServletURL
    SessionMgr.getSessionID获取 sessionId
    showDialog打开一个对话框
    closeDialog关闭对话窗
    doHyperlinkByGetGet 方法打开一个网页页面,可以传递参数,可以设置页面属性
    doHyperlinkByPostPost 方法打开一个网页页面,可以传递参数,可以设置页面属性
    MsgFR 内置的统一风格的消息框,可以替代 Window 中的 alert、confirm 、 prompt 以及 toast 弹窗。详细介绍可见:FR.Msg
    remoteEvaluate执行 FVS 内置公式,返回公式计算结果
    jsonEncode对字符串进行 jsonEncode 编码
    jsonDecode对字符串进行 jsonEncode 解码
    ajax封装过的 jQuery.ajax() 函数,详细介绍可见:ajax
    isEmpty判断对象是否为空
    isArray判断对象是否为数组
    cellStr2ColumnRow根据单元格编号获取行列索引
    columnRow2CellStr根据行列号获取单元格编号
    exportTemplate导出 FVS 模板,详细介绍可见:FVS模板导出
    FS 对象上的方法,如下表所示,详细介绍可见:全局接口-FS 。

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

    2.2 页面接口

    FVS 页面接口主要用于获取页面上的组件对象,以及分页相关接口。如下表所示,详细介绍可见:FVS页面接口 。

    接口
    说明备注
    this获取当前的组件对象,获取后可以使用组件的方法和属性
    getWidgetByName获取当前页面中的某个组件
    refresh触发组件刷新,V1.9.1 版本及之后的插件在刷新的同时还支持传参
    trigger触发组件所有的点击事件
    requestFullscreen触发页面全屏
    exitFullscreen关闭页面全屏,仅针对 requestFullscreen 接口有效,对 F11 触发的全屏无效
    reload触发模板整体自动刷新
    setPageButtonDisplayPolicy可设置分页切换按钮显隐状态
    linkageGlobal实现参数全局联动
    getPage根据页索引或页名称获取页

    V2.4.1 版本 FVS 统一模板分页、表格组件分页、Tab组件标签页相关 API 接口

    历史接口请参见:

    FVS模板分页历史接口 

    FVS表格组件分页历史接口 

    FVS-Tab组件历史接口 

    getPreviousPage获取上一页
    getNextPage获取下一页
    getFirstPage获取第一页
    getLastPage获取最后一页
    getCurrentPage获取当前页
    getAllPages获取所有页
    setVisible设置页面显示或隐藏
    isVisible获取页面显示/隐藏状态
    goto跳转到获取的页面
    getName获取页面名称
    getIndex获取页面索引

    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

    设置控件的

    注:V2.4.1 及之后版本, 标题组件 也支持使用 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()获取单元格列宽
    getCell()获取单元格某一列上第 row 行的单元格对象/某一行上第 col 列的单元格对象
    getIndex()获取单元格行对象/单元格列对象的位置索引
    setStyle(opts)设置单元格行/列对象的样式
    showToolTip(opts)给表格单元格行/列添加提示

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

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

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

    4)表格导出接口仅支持将表格组件导出为 Excel 。详细介绍可见:报表导出接口

    接口
    说明
    exportReportToExcel()将表格组件导出为 Excel

    5)鼠标点击或者悬浮时,单元格或所在行列背景颜色变化。详细介绍可见:鼠标点击/悬浮时修改单元格背景接口 。

    接口
    说明
    addEffect(type, opts)鼠标点击或者悬浮时,单元格或所在行列背景颜色变化

    6)跑马灯接口。详细介绍可见:跑马灯接口

    接口
    说明
    startMarquee(opt)开启表格组件跑马灯效果
    stopMarquee()关闭表格组件跑马灯效果

    2.6 图表组件接口

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

    注:以下接口不支持 扩展图表 类型的图表组件。

    接口
    说明
    getSeries()获取图表组件系列对象数组
    series[seriesIndex]获取图表组系列对象
    series.points获取图表系列对象之后获取其数据点对象
    setSeriesVisible()图表显示部分系列
    sortChart()图表排序接口
    openAutoTooltip()

    图表数据点提示轮播接口

    注:该接口支持除轮播类图表以外的其他扩展图表

    setMapZoom()设置地图缩放等级和中心点
    getZoom()获取地图缩放层级
    getCenter()获取地图中心点
    panTo()设置地图转移中心点
    drillDown()钻取地图向下钻取
    drillUp()钻取地图向上钻取
    getLayerIndex()获取钻取地图当前钻取层级,获取的层级从0开始:0、1、2……
    getLayerNames()获取钻取目录名称,结果为数组,例如:["中国", "湖南省", "长沙市"]

    2.7 网页框接口

    FVS 网页框与页面通信接口,可实现 FVS 网页框于模板页面之间的通信。详细介绍可见:FVS网页框与页面通信接口

    接口
    说明
    onlyCommunicateWithOrigins通信前指定和 FVS 通信的 origins,否则无法进行通信
    postMessage发送消息
    addPostMessageListener监听来自网页框(origins指定的)的信息
    removePostMessageListener删除 addPostMessageListener 添加的监听

    2.8 移动端专用接口

    FVS 插件为 V2.6.0 及之后版本,且 App 版本为 11.0.91 及之后版本,支持在 App 中使用以下接口,详细介绍可见:移动端专有 、移动端的 JS 接口

    接口
    说明
    FS.tabPane.closeActiveTab关闭当前页,跳转至目录页
    FS.tabPane.addItem打开一个新页面
    logoutApp登出App
    location用于实现定位功能,获取经纬度
    getDeviceInfo获取当前设备信息



    附件列表


    主题: FineVis数据可视化
    • 有帮助
    • 没帮助
    • 只是浏览
    中文(简体)

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

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

    不再提示

    10s后关闭

    联系我们
    在线支持
    获取专业技术支持,快速帮助您解决问题
    工作日9:00-12:00,13:30-17:30在线
    页面反馈
    针对当前网页的建议、问题反馈
    售前咨询
    采购需求/获取报价/预约演示
    或拨打: 400-811-8890 转1
    qr
    热线电话
    咨询/故障救援热线:400-811-8890转2
    总裁办24H投诉:17312781526
    提交页面反馈
    仅适用于当前网页的意见收集,帆软产品问题请在 问答板块提问前往服务平台 获取技术支持