反饋已提交

網絡繁忙

JS API接口彙總

版本說明

本頁彙總了JS API 所有API，可簡單查看每個API的功能和行動端支援情況，詳細介紹請閱讀對應的API介紹。
在使用API前，請務必先仔細閱讀 JS API 相容說明。

注：API使用中，注意API名稱大小寫，請嚴格按照文檔中名稱使用。

版本功能變動
11.0.10報表塊物件API、報表塊行列物件API、報表塊儲存格物件API 支援普通報表
11.0.7「FVS大屏編輯模式」插件 V1.8.0 及之後版本，適配了部分API，詳情見 FVS大屏JSAPI彙總
11.0.7決策報表新增多個報表塊API，詳情見： 報表塊物件API、報表塊行列物件API、報表塊儲存格物件API
11.0.3圖表物件API新增獲取當前展示圖表API，詳情見：圖表物件API
11.0.2圖表新增特效API，詳情見：圖表特效API
11.0-

公共模組

公共模組的API，普通報表和決策報表（新版）都可以使用，分全局API、參數面板API、元件API、表格API、圖表API、工具欄API、報表分頁API和匯出API。

全局API

全局API基本用於報表主體，除 _g() 獲取的報表物件上的方法外，還包括 FR 物件 和 FS 物件上的方法。

g() 獲取的報表物件上的方法，如下表所示，詳細介紹可見： 全局API

接口
說明行動端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: 'highlightCross'，鼠标點擊或者懸浮單元格時，單元格所在的列變色支援不支援，11.0 新增的接口
type: 'highlightCol'，鼠标點擊或者懸浮單元格時，單元格所在的行列變色支援不支援，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 版本
getAllWidgets獲取報表對象中所有組件信息支援不支援，11.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 大屏報表

适用於安裝了「FVS大屏編輯模式」插件的用戶，詳細介紹見：FVS大屏JS接口彙總 。



附件列表


主題： 二次開發
上一篇：JS API 簡介
下一篇：公共模組API
  • 有幫助
  • 沒幫助
  • 只是瀏覽
  • 圖片不清晰
  • 用語看不懂
  • 功能說明看不懂
  • 操作說明太簡單
  • 內容有錯誤
中文（简体） English 日本語
中文（繁體）

文 檔回 饋

滑鼠選中內容，快速回饋問題

滑鼠選中存在疑惑的內容，即可快速回饋問題，我們將會跟進處理。

不再提示

10s後關閉