反馈已提交

网络繁忙

JS API接口汇总

  • 文档创建者:RosieY
  • 历史版本:51
  • 最近更新:Alicehyy 于 2024-05-08
  • 版本说明

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

    在使用接口前,请务必先仔细阅读 JS API 兼容说明

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

    版本功能变动
    11.0.10报表块对象接口报表块行列对象接口报表块单元格对象接口 支持普通报表
    11.0.7FineVis数据可视化」插件 V1.8.0 及之后版本,适配了部分接口,详情见 FVS支持的JS接口汇总
    11.0.7决策报表新增多个报表块接口,详情见: 报表块对象接口报表块行列对象接口报表块单元格对象接口
    11.0.3图表对象接口新增获取当前展示图表接口,详情见:图表对象接口
    11.0.2图表新增特效接口,详情见:图表特效接口
    11.0-

    公共模块

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

    全局接口

    全局接口基本用于报表主体,除 _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关闭对话窗不支持支持
    doHyperlinkByGetGet 方法打开一个网页页面,可以传递参数,可以设置页面属性支持支持
    doHyperlinkByPostPost 方法打开一个网页页面,可以传递参数,可以设置页面属性支持支持
    doURLPrint调出打印工具,打印报表不支持支持
    MsgFR 内置的统一风格的消息框,可以替代 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 版本
    addEffecttype: 'highlightRow',鼠标点击或者悬浮单元格时,单元格所在的行变色支持不支持,11.0 新增的接口
    type: 'highlightCol',鼠标点击或者悬浮单元格时,单元格所在的列变色支持不支持,11.0 新增的接口
    type: 'highlightCross',鼠标点击或者悬浮单元格时,单元格所在的行列变色支持不支持,11.0 新增的接口
    type: 'highlightCell',鼠标点击或者悬浮单元格时,单元格变色支持不支持,11.0 新增的接口

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

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

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

    接口
    说明移动端10.0 版本
    addEffecttype: '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 版本
    Chart.WebUtils.getChart获取图表块对象支持支持
    getChartWithIndex获取图表对象支持支持
    getCurrentChartIndex获取当前展示图表的chartIndex不支持10.0.19 及之后版本支持
    series获取系列对象支持部分移动端调用 JS支持
    series.points获取数据点对象不支持支持

    图表特效接口,如下表所示,详细介绍可见:图表特效接口

    接口
    说明移动端10.0版本
    setSeriesVisible图表显示部分系列支持支持
    openAutoTooltip数据点提示轮播接口不支持支持
    dataRefresh图表刷新接口支持支持
    showIndexChart切换到指定图表对象支持支持
    switchCarouselChart切换到上一个(或下一个)图表对象支持支持
    VanCharts.unifiedSwitchCarouselChart统一切换轮播图表接口不支持支持
    sortChart图表排序接口不支持支持
    saveAsImage图表导出接口不支持不支持
    setMapZoom设置地图缩放等级和中心点不支持支持
    getZoom获取缩放层级不支持支持
    getCenter获取中心点不支持支持
    panTo地图转移中心点不支持支持
    drillDown向下钻取不支持支持
    drillUp向上钻取不支持不支持
    getLayerIndex 获取当前钻取层级,获取的层级从0开始:0、1、2……不支持不支持
    getLayerNames获取钻取目录名称,结果为数组,例如:["中国", "湖南省", "长沙市"]不支持不支持
    changeParameter改变图表参数重新赋值不支持支持

    工具栏接口

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

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

    接口
    说明移动端10.0 版本
    getWidgetByName获取报表工具栏中的按钮,可结合按钮的方法使用不支持支持

    普通报表:getToolbar

    获取工具栏对象支持不支持,11.0 新增的接口
    决策报表:getToolbar(index)获取获取报表块的工具栏,在工具栏打开的情况下使用支持不支持,11.0 新增的接口
    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 版本
    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 版本
    getWidgetByName获取报表对象中的某个组件,可以获取到 body 中的组件和参数面板中的控件支持支持

    组件通用接口

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

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

    Tab 组件接口

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

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

    FVS 可视化看板

    适用于安装了「FineVis数据可视化」插件的用户,详细介绍见:FVS支持的JS接口汇总 。


    附件列表


    主题: 二次开发
    已经是第一篇
    已经是最后一篇
    • 有帮助
    • 没帮助
    • 只是浏览
    中文(简体)

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

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

    不再提示

    10s后关闭



    AI

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