FineReport文檔

JS API接口匯總

版本說明

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

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

版本功能變動
11.0.10報表塊物件API、報表塊列欄物件API、報表塊儲存格物件API 支援普通報表
11.0.7「FineVis企業戰情室編輯模式」插件 V1.8.0 及之後版本，適配了部分API，詳情見 FVS支援的JS API匯總
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

API
說明行動端10.0 版本
_g()獲取報表物件，獲取後結合報表物件的方法使用支援支援，但 10.0 支援的範圍和方法較少，11.0 新增部分方法
getParameterContainer獲取報表中參數面板物件，獲取後結合 參數面板API 使用支援不支援，11.0 新增的API
parameterCommit提交參數後重新查詢，重新整理報表支援支援
loadContentPane重新載入，重新整理報表支援支援
getPreviewType獲取報表當前所在的預覽模式支援不支援，11.0 新增的API

FR 物件上的方法，如下表所示，詳細介紹可見：全局接口-FR

API說明行動端10.0 版本
servletURL獲取 servletURL支援不支援，11.0 新增的API
serverURL獲取 serverURL不支援不支援，11.0 新增的API
server獲取 server不支援不支援，11.0 新增的API
fineServletURL獲取 fineServletURL不支援不支援，11.0 新增的API
SessionMgr.getSessionID獲取 sessionId支援不支援，11.0 新增的API
showDialog開啟一個對話框不支援支援
closeDialog關閉對話窗不支援支援
doHyperlinkByGetGet 方法開啟一個網頁頁面，可以傳遞參數，可以設定頁面屬性支援支援
doHyperlinkByPostPost 方法開啟一個網頁頁面，可以傳遞參數，可以設定頁面屬性支援支援
doURLPrint調出列印工具，列印報表不支援支援
MsgFR 內建統一風格的訊息框，可以替代 Window 中的 alert、confirm 以及 prompt 彈窗支援支援
remoteEvaluate

執行 FR 內建公式，傳回公式計算結果

注：需要將公式轉化成字串形式。

支援支援
jsonEncode對字串進行 jsonEncode 編碼不支援支援
jsonDecode對字串進行 jsonDecode 解碼不支援支援
ajax封裝過的 jQuery.ajax() 函式支援支援
isEmpty判斷物件是否為空不支援支援
isArray判斷物件是否為陣列不支援支援

FR 物件上的方法，僅行動端支援的，如下表所示，詳細介紹可見：行動端專有

API
說明行動端10.0 版本
location用於實現定位功能，獲取經緯度，可以在https、企業微信、釘釘中使用支援支援
Mobile.getDeviceInfo獲取裝置資訊支援支援

FS 物件上的方法，如下表所示，詳細介紹可見：全局API-FS

API
說明行動端10.0 版本
signOut登出數據決策系統，即傳回決策平台登入介面不支援支援
tabPane.closeActiveTab關閉數據決策系統的標簽頁，即自動關閉決策系統中開啟的預覽範本支援支援
tabPane.addItem在數據決策系統中開啟新標簽頁支援支援

參數面板API

參數面板API可用於調整參數面板的一些屬性，如下表所示，詳細介紹可見：參數面板API

API
說明行動端10.0 版本
getWidgetByName獲取參數面板中的元件，結合元件的方法使用支援支援，但注意獲取參數面板的API有變化
collapse收起參數面板支援不支援，11.0 新增的API
expand展開參數面板支援不支援，11.0 新增的API
submit自動提交後查詢支援不支援，11.0 新增的API

元件API

元件API主要用於修改參數面板中元件、填報儲存格中元件、決策報表 body 中元件的屬性。元件API分通用和專有，通用API除特殊外所有元件都可以用，專有API只能指定的元件用。

獲取元件的API，只能在元件的「事件」中使用，如下表所示，詳細介紹可見：獲取元件

API
說明行動端10.0 版本
this在元件的事件中使用，獲取當前的元件物件，獲取後可以使用元件的方法和屬性支援支援
this.options.form在元件的事件中呼叫，可以使用 參數面板API 的所有方法支援支援

通用API，如下表所示，詳細介紹可見：元件通用

注：11.0 獲取參數面板的API有變化，如果是透過獲取參數面板API後再繼承以下API使用，需特別注意和 10.0 的差別。

API
說明行動端10.0 版本
getValue獲取元件的實際值支援支援
getText獲取元件的顯示值支援支援
setValue設定元件的值支援支援
visible設定元件可見支援支援
invisible設定元件不可見支援支援
setVisible設定元件可見/不可見支援支援
isVisible元件是否可見支援支援
setEnable設定元件可用/不可用支援支援
isEnabled元件是否可用支援支援
reset重置元件、清空元件的內容支援支援
getType獲取元件類型支援不支援，11.0 新增的API
setWaterMark新增水印文字（僅支援有輸入框的元件）支援不支援，11.0 新增的API
fireEvent呼叫元件事件支援支援
setPopupStyle設定元件下拉選項框的樣式，僅支援有選項框的元件不支援不支援，11.0 新增的API
return false在元件的特定事件中加入 return false，不觸發聯動、查詢不支援支援

「日期元件」專有API，如下表所示，詳細介紹可見：日期元件專有

API
說明行動端10.0 版本
setMaxAndMinDate設定日期元件的可選日期範圍支援不支援，11.0 新增的API
setPopupStyle設定彈出框樣式，僅支援有彈出框的元件不支援不支援，11.0 新增的API

「按鈕元件」專有API，如下表所示，詳細介紹可見：按鈕元件專有

API
說明行動端10.0 版本
doClick觸發按鈕的點選事件，相當於人工點選支援不支援，11.0 新增的API

「下拉框」元件專有API，如下表所示，詳細介紹可見：下拉框元件專有

API
說明行動端10.0 版本
setName4Empty修改下拉框元件下拉時的預設文字“不選”不支援不支援，11.0 新增的API

表格API

表格API主要用於修改報表中表格內容，根據應用場景可分成跑馬燈API、隱藏捲軸API、修改儲存格背景API、修改儲存格字體API、修改列高欄寬API、獲取和設定儲存格值API、設定儲存格提示、設定儲存格樣式。

跑馬燈API如下表所示，詳細介紹可見：跑馬燈API

API
說明行動端10.0 版本
startMarquee開啟跑馬燈效果不支援支援，10.0.19 及之後支援
stopMarquee關閉跑馬燈效果不支援支援，10.0.19 及之後支援

隱藏捲軸API如下表所示，詳細介紹可見：隱藏捲軸API

API
說明行動端10.0 版本
setHScrollBarVisible設定橫向捲軸顯示/隱藏不支援支援，10.0.19 及之後支援
setVScrollBarVisible設定縱向捲軸顯示/隱藏不支援支援，10.0.19 及之後支援

注：以下API 報表塊物件API、報表塊列欄物件API、報表塊儲存格物件API 11.0.10 及以後才支援普通報表。

報表塊物件API，用於定位報表塊中儲存格元素和設定報表塊基本屬性。如下表所示，詳細介紹可見：報表塊物件API

API
說明行動端10.0 版本
getCell(row,col)獲取報表塊第 row 列，第 col 欄的儲存格物件支援不支援，11.0 新增的API
getRow(index)獲取報表塊第 index 列所有儲存格物件支援不支援，11.0 新增的API
getColumn(index)獲取報表塊第 index 欄所有儲存格物件支援不支援，11.0 新增的API
getRowCount()獲取報表塊共有多少列，計算的是擴展後的列數支援不支援，11.0 新增的API
getColumnCount()獲取報表塊共有多少欄，計算的是擴展後的欄數支援不支援，11.0 新增的API
onMouseClick(func)用於綁定滑鼠/手指點選事件，當滑鼠/手指點選報表塊時，觸發綁定的這個事件不支援不支援，11.0 新增的API
onMouseMoveInCell(func)用於綁定滑鼠/手指移入儲存格事件，當滑鼠/手指移入儲存格時，觸發綁定的這個事件不支援不支援，11.0 新增的API
onMouseMoveOutCell(func)用於綁定滑鼠/手指移出儲存格事件，當滑鼠/手指移出儲存格時，觸發綁定的這個事件不支援不支援，11.0 新增的API
scrollTo(opts)設定報表塊自動捲動到某個位置支援不支援，11.0 新增的API
getScrollOffset()獲取報表塊捲動到的位置支援不支援，11.0 新增的API
setRadius(radius, range, single)給報表所有儲存格設定圓角，儲存格必須有背景色，否則無法看出效果。不支援不支援，11.0 新增的API
showToolTip(opts)設定報表塊所有儲存格提示不支援不支援，11.0 新增的API

報表塊列欄物件主要是報表塊列欄上的方法，用來設定報表塊列欄屬性。如下表所示，詳細介紹可見：報表塊列欄物件API

API
說明行動端10.0 版本
setHeight(height)設定儲存格列高。不支援不支援，11.0 新增的API
getHeight()獲取儲存格列高。支援不支援，11.0 新增的API
getCell(col)獲取儲存格某一列上第 col 欄的儲存格物件。支援不支援，11.0 新增的API
setWidth(width)設定儲存格欄寬。不支援不支援，11.0 新增的API
getWidth()獲取儲存格欄寬。支援不支援，11.0 新增的API
getCell(row)獲取儲存格某一欄上第 row 列的儲存格物件。支援不支援，11.0 新增的API
getIndex()獲取儲存格列物件/儲存格欄物件的位置索引支援不支援，11.0 新增的API
setStyle(opts)設定儲存格列/欄物件的樣式不支援不支援，11.0 新增的API
showToolTip(opts)給報表塊儲存格列/欄新增提示。支援不支援，11.0 新增的API

報表塊儲存格API主要是報表塊儲存格上的方法，用來設定報表塊中儲存格的屬性。如下表所示，詳細介紹可見：報表塊儲存格物件API

API
說明行動端10.0 版本
getPosition()獲取當前儲存格位置資訊，使用時需要先獲取到儲存格物件支援不支援，11.0 新增的API
getRow()獲取當前儲存格所在的列儲存格物件。支援不支援，11.0 新增的API
getColumn()獲取當前儲存格所在的欄儲存格物件。支援不支援，11.0 新增的API
getValue()獲取儲存格的值支援不支援，11.0 新增的API
showToolTip(opts)給報儲存格新增提示不支援不支援，11.0 新增的API
setStyle(opts)設定儲存格物件的樣式不支援不支援，11.0 新增的API

樣式屬性 style，JS API 中有樣式參數的API中使用，符合 css 的規範，用來設定邊框、背景、顔色、文字等樣式。詳細介紹見：樣式屬性style

注：以下表格API 11.0.10 版本及以後已有功能更完善的替代API，使用者可使用新API。詳情可看：表格曆史API 

修改儲存格背景API如下表所示，詳細介紹可見：修改儲存格背景

API
說明行動端10.0 版本
addEffecttype: 'highlightRow'，滑鼠點選或者懸浮儲存格時，儲存格所在的列變色支援不支援，11.0 新增的API
type: 'highlightCol'，滑鼠點選或者懸浮儲存格時，儲存格所在的欄變色支援不支援，11.0 新增的API
type: 'highlightCross'，滑鼠點選或者懸浮儲存格時，儲存格所在的列欄變色支援不支援，11.0 新增的API
type: 'highlightCell'，滑鼠點選或者懸浮儲存格時，儲存格變色支援不支援，11.0 新增的API

修改儲存格字體API，如下表所示，詳細介紹可見：修改儲存格字體

API
說明行動端10.0 版本
addEffecttype: 'setCellFont'， 滑鼠點選或者懸浮儲存格時，儲存格字體格式變化支援
不支援，11.0 新增的API
type: 'setRowFont' ，滑鼠點選或者懸浮儲存格時，儲存格所在列字體格式變化支援不支援，11.0 新增的API
滑鼠點選或者懸浮儲存格所在列字體變化，滑鼠點選或懸浮其他列恢複支援不支援，11.0 新增的API

設定儲存格提示API，如下表所示，詳細介紹可見：設定儲存格提示

API
說明行動端10.0 版本
addEffecttype: 'setCellFont'，滑鼠懸浮出現文字/圖片提示框不支援不支援，11.0 新增的API

修改列高欄寬API，如下表所示，詳細介紹可見：修改列高欄寬

API
說明行動端10.0 版本
setRowHeight改變儲存格列高不支援不支援，11.0 新增的API
setColWidth改變儲存格欄高不支援不支援，11.0 新增的API

獲取和設定儲存格值，如下表所示，詳細介紹可見：獲取和設定儲存格值

API
說明行動端10.0 版本
getCellValue獲取特定儲存格的值，參數可以為儲存格地址，也可以為儲存格列欄號部分支援支援，10.0 僅支援填報下使用
setCellValue給特定儲存格指派，參數可以為儲存格地址，也可以為儲存格列欄號部分支援支援，10.0 僅支援填報下使用

設定儲存格樣式API，如下表所示，詳細介紹可見：設定儲存格樣式

API
說明行動端10.0 版本
setCellRadius給報表所有儲存格設定圓角，儲存格必須有背景色，否則無法看出效果。不支援不支援，11.0 新增的API

圖表API

圖表物件API，如下表所示，詳細介紹可見：圖表物件API

API
說明行動端10.0 版本
Chart.WebUtils.getChart獲取圖表塊物件支援支援
getChartWithIndex獲取圖表物件支援支援
getCurrentChartIndex獲取當前展示圖表的chartIndex不支援10.0.19 及之後版本支援
series獲取系欄物件支援部分行動端呼叫 JS支援
series.points獲取資料點物件不支援支援

圖表特效API，如下表所示，詳細介紹可見：圖表特效API

API
說明行動端10.0版本
setSeriesVisible圖表顯示部分系列支援支援
openAutoTooltip資料點提示輪播API不支援支援
dataRefresh圖表重新整理API支援支援
showIndexChart切換到指定圖表物件支援支援
switchCarouselChart切換到上一個（或下一個）圖表物件支援支援
VanCharts.unifiedSwitchCarouselChart統一切換輪播圖表API不支援支援
sortChart圖表排序API不支援支援
saveAsImage圖表匯出API不支援不支援
setMapZoom設定地圖縮放等級和中心點不支援支援
getZoom獲取縮放層級不支援支援
getCenter獲取中心點不支援支援
panTo地圖轉移中心點不支援支援
drillDown向下鑽取不支援支援
drillUp向上鑽取不支援不支援
getLayerIndex 獲取當前鑽取層級，獲取的層級從0開始：0、1、2……不支援不支援
getLayerNames獲取鑽取目錄名稱，結果為陣列，例如：["中國", "湖南省", "長沙市"]不支援不支援
changeParameter改變圖表參數重新指派不支援支援

工具欄API

工具欄API主要用於修改工具欄屬性和工具欄中按鈕屬性，分工具欄API、工具欄按鈕通用API、工具欄按鈕專用API。

工具欄API，如下表所示，詳細介紹可見：工具欄

API
說明行動端10.0 版本
getWidgetByName獲取報表工具欄中的按鈕，可結合按鈕的方法使用不支援支援

普通報表：getToolbar

獲取工具欄物件支援不支援，11.0 新增的API
決策報表：getToolbar(index)獲取獲取報表塊的工具欄，在工具欄開啟的情況下使用支援不支援，11.0 新增的API
toolBarFloat設定工具欄顯示位置不支援不支援，11.0 新增的API
setStyle

修改工具欄大小

不支援不支援，11.0 新增的API
setVisible設定工具欄顯示/隱藏支援不支援，11.0 新增的API

工具欄按鈕通用API，除特殊外所有工具欄按鈕都可以用，如下表所示，詳細介紹可見：工具欄按鈕通用

API
說明行動端10.0 版本
visible設定工具欄某個按鈕可見不支援支援
invisible設定工具欄某個按鈕不可見不支援支援
setVisible設定工具欄某個按鈕可見/不可見不支援支援
isVisible工具欄某個按鈕是否可見不支援支援
setEnable設定工具欄某個按鈕可用/不可用不支援支援
isEnabled工具欄某個按鈕是否可用不支援支援

郵件按鈕專有API，只郵件按鈕可用，如下表所示，詳細介紹可見：郵件按鈕專有

API
說明行動端10.0 版本
changeFormat修改郵件支援的格式選項不支援不支援，11.0 新增的API

報表分頁API

報表分頁API主要用於分頁報表，如下表所示，詳細介紹可見：報表分頁

API
說明行動端10.0 版本
gotoPreviousPage跳轉到上一頁支援支援
gotoNextPage跳轉到下一頁支援支援
gotoLastPage跳轉到最後一頁支援支援
gotoFirstPage跳轉到第一頁支援支援
gotoPage跳轉到指定頁支援支援
getCurrentPageIndex獲取當前頁頁碼支援不支援，11.0 新增的API
getReportTotalPage獲取總頁數支援不支援，11.0 新增的API
currentPageIndex報表當前頁的頁碼支援支援
reportTotalPage報表的總頁數支援支援

報表匯出API

匯出API，主要用於報表匯出，如下表所示，詳細介紹可見：匯出API

API
說明行動端10.0 版本
exportReportToExcel將報表匯出成 Excel部分支援支援
exportReportToImage將報表匯出成圖片部分支援支援
exportReportToPDF將報表匯出成 PDF部分支援支援
exportReportToWord將報表匯出成 Word部分支援支援

普通報表

普通報表API，即只有 cpt 普通報表可用，分公共部分和專有部分，公共部分即所有的預覽模式都可以使用，專有部分只能在對應預覽模式下使用。

分頁預覽API

分頁預覽專有API如下表所示，詳細介紹可見：分頁預覽專有

API
說明行動端10.0 版本
expandNodeLayer將折疊樹展開到 N 層節點不支援僅安裝新引擎插件 V1.6.0 版本及以後支援
collapseNodeLayer將折疊樹收起到 N 層節點不支援僅安裝新引擎插件 V1.6.0 版本及以後支援
expandAllNodeLayer展開折疊樹的所有節點不支援不支援
collapseAllNodeLayer收起折疊樹的所有節點不支援不支援

填報預覽API

填報預覽專有API如下表所示，詳細介紹可見：填報預覽專有

API
說明行動端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清空暫存不支援支援

資料分析API

資料分析專有API如下表所示，詳細介紹可見：資料分析專有

API
說明行動端10.0 版本
centerReport「資料分析」預覽時，設定報表置中顯示不支援不支援，11.0 新增的API
expandNodeLayer「資料分析」預覽時，將折疊樹展開到 N 層節點不支援不支援，11.0 新增的API
collapseNodeLayer「資料分析」預覽時，將折疊樹收起到 N 層節點不支援不支援，11.0 新增的API
expandAllNodeLayer「資料分析」預覽時，展開折疊樹的所有節點不支援不支援，11.0 新增的API
collapseAllNodeLayer「資料分析」預覽時，收起折疊樹的所有節點不支援不支援，11.0 新增的API

決策報表

決策報表（新版）的API，即只有 frm 決策報表可用，分獲取組件API、組件通用API、Tab 組件API。

獲取組件API

獲取組件API如下表所示，詳細介紹可見：獲取組件

API
說明行動端10.0 版本
getWidgetByName獲取報表物件中的某個組件，可以獲取到 body 中的組件和參數面板中的元件支援支援

組件通用API

組件通用API即決策報表中所有組件都可以用，如下表所示，詳細介紹可見：組件通用

API
說明行動端10.0 版本
visible設定組件可見支援支援
invisible設定組件不可見支援支援
setVisible設定組件可見/不可見支援支援
isVisible傳回組件是否可見支援支援

Tab 組件API

Tab 組件API用於修改 Tab 組件的屬性，如下表所示，詳細介紹可見：Tab組件

API
說明行動端10.0 版本
showCardByIndex獲取正在展示的 Tab 頁的定位索引 支援支援
setTabVisible設定某個 Tab 頁顯示/隱藏支援支援
getShowIndex設定 Tab 塊標題顯示/隱藏支援支援
setTitleVisible展示第 N 個 Tab 頁不支援支援

FVS 視覺化報表

適用於安裝了「FineVis企業戰情室編輯模式」插件的使用者，詳細介紹見：FVS支援的JS API匯總 。



附件列表


主題： 二次開發
已經是第一篇
已經是最後一篇
  • 有幫助
  • 沒幫助
  • 只是瀏覽
中文（简体） English 日本語
中文（繁體）

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

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

不再提示

9s后關閉

獲取幫助
線上支援
獲取專業技術支援，快速幫助您解決問題
工作日9:00-12:00，13:30-17:30在线
頁面反饋
針對當前網頁的建議、問題反饋
售前咨詢
獲取報價：
FineReport FineBI
預約演示：
FineReport FineBI
業務咨詢
電話：0933-790886或 0989-092892
郵箱：taiwan@fanruan.com
頁面反饋
*問題分類
不能為空
問題描述
0/1000
不能為空

反馈已提交

网络繁忙

反饋已提交

網絡繁忙