FVS大屏JS接口彙總- FineReport帮助文档 - 全面的报表使用教程和学习资料

適用場景：安裝了「FineVis資料視覺化」插件的使用者，可參考本文了解 FVS 企業戰情室範本相關 JS API。

1. 版本

報表伺服器版本	JAR包	插件版本	功能變動
11.0	2021-11-15	V1.0.0	最低版本要求

2. API索引

2.1 全局API

全局API基本用於企業戰情室報表主體，如下表所示，詳細介紹可見：全局API 。

API	說明
duchamp	獲取 FVS 範本中的組件物件，獲取後結合物件的方法使用
servletURL	獲取 servletURL
serverURL	獲取 serverURL
server	獲取 server
fineServletURL	獲取 fineServletURL
SessionMgr.getSessionID	獲取 sessionId
showDialog	開啟一個對話框
closeDialog	關閉對話窗
doHyperlinkByGet	Get 方法開啟一個網頁頁面，可以傳遞參數，可以設定頁面屬性
doHyperlinkByPost	Post 方法開啟一個網頁頁面，可以傳遞參數，可以設定頁面屬性
Msg	FR 內建統一風格的訊息框，可以替代替代 Window 中的 alert、confirm 、 prompt 以及 toast 彈窗。詳細介紹可見：FR.Msg
remoteEvaluate	執行 FVS 內建公式，傳回公式計算結果
jsonEncode	對字串進行 jsonEncode 編碼
jsonDecode	對字串進行 jsonEncode 解碼
ajax	封裝過的 jQuery.ajax() 函式，詳細介紹可見：ajax
isEmpty	判斷物件是否為空
isArray	判斷物件是否為陣列
cellStr2ColumnRow	根據儲存格編號獲取列、欄索引
columnRow2CellStr	根據列、欄號獲取儲存格編號
exportTemplate	匯出 FVS 範本，詳細介紹可見：FVS範本匯出

2.2 頁面API

FVS 頁面API主要用於獲取頁面上的組件物件，以及分頁相關API。如下表所示，詳細介紹可見：FVS頁面API 。

API	說明	備註
this	獲取當前的組件物件，獲取後可以使用組件的方法和屬性
getAllWidgets	獲取當前頁面中所有組件
getWidgetByName	獲取當前頁面中的某個組件
refresh	觸發組件重新整理，V1.9.1 版本及之後的插件在重新整理的同時還支援傳參
trigger	觸發組件所有的點選事件
requestFullscreen	觸發頁面全螢幕
exitFullscreen	關閉頁面全螢幕，僅針對 requestFullscreen API有效，對 F11 觸發的全螢幕無效
reload	觸發範本整體自動重新整理
setPageButtonDisplayPolicy	可設定分頁切換按鈕顯隱狀態
linkageGlobal	實現參數全局聯動
getPage	根據頁索引或頁名稱獲取頁	V2.4.1 版本 FVS 統一範本分頁、表格組件分頁、Tab組件標籤頁相關 API 歷史API請參見： FVS範本分頁歷史API FVS表格組件分頁歷史API FVS-Tab組件歷史API
getPreviousPage	獲取上一頁
getNextPage	獲取下一頁
getFirstPage	獲取第一頁
getLastPage	獲取最後一頁
getCurrentPage	獲取當前頁
getAllPages	獲取所有頁
setVisible	設定頁面顯示或隱藏
isVisible	獲取頁面顯示/隱藏狀態
goto	跳轉到獲取的頁面
getName	獲取頁面名稱
getIndex	獲取頁面索引

2.3 三維組件API

FVS 三維組件API支援所有三維組件，如下表所示，詳細介紹可見：FVS三維組件API 。

API	說明
getDataLayers	獲取三維組件所有的資料圖層
getDataLayerByName	獲取三維組件的某個具體資料圖層
animateSceneTime	設定自訂模型場景時間動態變化，僅支援三維自訂場景組件
getMeshByName	根據自訂模型 mesh 名稱搜尋模型物件，結合其屬性實現對模型的一些操作
setVisible	使用 getMeshByName 獲取模型物件後，設定模型物件是否可見
setScaling	使用 getMeshByName 獲取模型物件後，設定模型物件的縮放比例
setRotation	使用 getMeshByName 獲取模型物件後，設定模型物件的旋轉角度
setPosition	使用 getMeshByName 獲取模型物件後，設定模型物件的位置
focus	使用 getMeshByName 獲取模型物件後，設定模型物件快速聚焦
rotateTo rotateForwardTo scaleTo moveTo	使用 getMeshByName 獲取模型物件後，設定模型物件改變角度、朝向、縮放大小、行動位置等運動效果詳情請參見：模型軌跡運動API
refreshData	傳參並重新整理三維組件資料
subscribeMarkerData	訂閱監聽三維組件資料圖層中的資料更新，需配合重新整理API使用
updateMarkerData	可單獨更新三維組件資料圖層中指定模型物件資料
getRoamAnimations	獲取三維組件的所有漫遊路徑資訊（目前僅支援傳回漫遊路徑名稱）
playRoamAnimations	播放漫遊動畫
updateRoamAnimationAction	暫停/繼續/跳出播放漫遊動畫

2.4 元件組件API

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

API	說明
getValue	獲取元件的實際值注：V1.16.0 及之後版本，標題組件也支援使用 getValue
getText	獲取元件的顯示值
setValue	設定元件的值注：V2.4.1 及之後版本，標題組件也支援使用 setValue
setVisible	設定元件可見/不可見
isVisible	傳回元件狀態是可見/不可見
setEnable	設定元件可用/不可用
isEnabled	傳回元件狀態是可用/不可用
reset	重置元件、清空元件的內容
setWaterMark	新增水印文字（僅支援有輸入框的元件）

2.5 表格組件API

表格API用於修改表格組件的屬性。

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

API	說明
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）表格列、欄物件主要是表格組件列、欄上的方法，用來設定表格列、欄屬性。如下表所示，詳細介紹可見：表格列、欄物件API 。

API	說明
setHeight(height)	設定儲存格列高
getHeight()	獲取儲存格列高
setWidth(width)	設定儲存格欄寬
getWidth()	獲取儲存格欄寬
getCell()	獲取儲存格某一欄上第 row 列的儲存格物件/某一列上第 col 欄的儲存格物件
getIndex()	獲取儲存格列物件/儲存格欄物件的位置索引
setStyle(opts)	設定儲存格列/欄件的樣式
showToolTip(opts)	給表格儲存格列/欄新增提示

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

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

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

4）表格匯出API僅支援將表格組件匯出為 Excel 。詳細介紹可見：報表匯出API 。

API	說明
exportReportToExcel()	將表格組件匯出為 Excel

5）滑鼠點選或者懸浮時，儲存格或所在行列背景顏色變化。詳細介紹可見：滑鼠點選/懸浮時修改儲存格背景API 。

API	說明
addEffect(type, opts)	滑鼠點選或者懸浮時，儲存格或所在列欄背景顏色變化

6）跑馬燈API。詳細介紹可見：跑馬燈API 。

API	說明
startMarquee(opt)	開啟表格組件跑馬燈效果
stopMarquee()	關閉表格組件跑馬燈效果

2.6 圖儲存格件API

FVS 圖儲存格件API如下表所示，詳細介紹可見：FVS圖表API 。

注：以下API不支援擴展圖表類型的圖儲存格件。

API	說明
getSeries()	獲取圖儲存格件系列物件陣列
series[seriesIndex]	獲取圖儲存格件系列物件
series.points	獲取圖表系列物件之後獲取其資料點物件
setSeriesVisible()	圖表顯示部分系列
sortChart()	圖表排序API
openAutoTooltip()	圖表資料點提示輪播API 注：該API支援除輪播類圖表以外的其他擴展圖表
setMapZoom()	設定地圖縮放等級和中心點
getZoom()	獲取地圖縮放層級
getCenter()	獲取地圖中心點
panTo()	設定地圖轉移中心點
drillDown()	鑽取地圖向下鑽取
drillUp()	鑽取地圖向上鑽取
getLayerIndex()	獲取鑽取地圖當前鑽取層級，獲取的層級從0開始：0、1、2……
getLayerNames()	獲取鑽取目錄名稱，結果為陣列，例如：["中國", "湖南省", "長沙市"]

2.7 網頁框API

FVS 網頁框與頁面通訊API，可實現 FVS 網頁框於範本頁面之間的通訊，

詳細介紹可見：FVS網頁框與頁面通訊API 。

API	說明
onlyCommunicateWithOrigins	通訊前指定和 FVS 通訊的 origins，否則無法進行通訊
postMessage	傳送訊息
addPostMessageListener	監聽來自網頁框（origins指定的）的資訊
removePostMessageListener	刪除 addPostMessageListener 新增的監聽

上一篇：FVS大屛支援的JS API場景

下一篇：JS實現資料庫表欄位控制FVS模型顯隱

有幫助
沒幫助
只是瀏覽
圖片不清晰
用語看不懂
功能說明看不懂
操作說明太簡單
內容有錯誤

中文（简体） English 日本語

中文（繁體）

FVS大屏JS接口彙總