適用場景:安裝了「FVS企業戰情室編輯模式」插件的使用者,可參考本文了解 FVS 範本的相關API。
版本
報表伺服器版本 | 插件版本 | 功能變動 |
---|---|---|
11.0.16 | V1.17.0 | 新增頁面與網頁框通訊API: onlyCommunicateWithOrigins 、postMessage 、addPostMessageListener 、removePostMessageListener |
onlyCommunicateWithOrigins
方法 | onlyCommunicateWithOrigins(origins) | 通訊前指定和 FVS 通訊的 origins,否則無法進行通訊 |
---|---|---|
參數 | origins:string[] | 指定通訊的域,是一個字串陣列 |
傳回值 | - | - |
範例 | 範例:給FVS範本新增頁面載入結束事件
若想實現動態獲取當前域,可參考如下代碼:
| |
應用範例 | JS實現FVS網頁框通訊 | |
行動端 | 不支援 |
postMessage
方法 | postMessage(message) | 傳送訊息 |
---|---|---|
參數 | message: any | 訊息:任意格式 |
傳回值 | - | - |
範例 | 範例:在 FVS 範本中給標題組件新增點選事件
| |
應用範例 | JS實現FVS網頁框通訊 | |
行動端 | 不支援 |
addPostMessageListener
方法 | addPostMessageListener(callback) | 監聽來自網頁框(origins指定的)的資訊 |
---|---|---|
參數 | callback: (message: any) => void | 回呼函式 |
傳回值 | id | 監聽事件的 id |
範例 | 範例:在 FVS 範本中,給 area 正文框元件新增初始化後事件,監聽來自網頁框的訊息,並將其指派給正文框元件
| |
應用範例 | JS實現FVS網頁框通訊 | |
行動端 | 不支援 |
removePostMessageListener
方法 | removePostMessageListener(id) | 刪除 addPostMessageListener 新增的監聽 |
---|---|---|
參數 | id:string | id:addPostMessageListener 函式的傳回值 |
傳回值 | - | - |
範例 | 範例:獲取 addPostMessageListener 監聽 id,如果不再需要監聽,需即時刪除
| |
應用範例 | - | |
行動端 | 不支援 |