本頁彙總了所有API，可簡單查看每個API的功能和行動端支援情況。
詳細介紹敬請期待對應的API介紹。
一、公共模組
公共模組的API，普通報表和決策報表都可以使用。
分為全域API、參數面板API、元件API、表格API、工具欄API、報表分頁API和匯出API。
1
全域API
全域API基本用於報表主體，除 _g() 獲取的報表物件上的方法外，還包括 FR 物件 和 FS 物件上的方法。
g() 獲取的報表物件上的方法，如下表所示。
FR 物件上的方法，如下表所示。
FR 物件上的方法，僅行動端支援的，如下表所示。
FS 物件上的方法，如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
g() 獲取的報表物件 | _g() | 獲取報表物件，獲取後結合報表物件的方法使用 | 支援 |
getParameterContainer | 獲取報表中參數面板物件，獲取後結合 參數面板API 使用 | 支援 | |
parameterCommit | 提交參數後重新查詢，刷新報表 | 支援 | |
loadContentPane | 重新加載，刷新報表 | 支援 | |
getPreviewType | 獲取報表當前所在的預覽模式 | 支援 | |
FR 物件 | servletURL | 獲取 servletURL | 支援 |
serverURL | 獲取 serverURL | 不支援 | |
server | 獲取 server | 不支援 | |
fineServletURL | 獲取 fineServletURL | 不支援 | |
SessionMgr.getSessionID | 獲取 sessionId | 支援 | |
showDialog | 打開一個對話框 | 不支援 | |
closeDialog | 關閉對話窗 | 不支援 | |
doHyperlinkByGet | Get 方法打開一個網頁頁面，可以傳遞參數，可以設定頁面屬性 | 支援 | |
doHyperlinkByPost | Post 方法打開一個網頁頁面，可以傳遞參數，可以設定頁面屬性 | 支援 | |
doURLPrint | 調出打印工具，打印報表 | 不支援 | |
Msg | FR 內建的統一風格的消息框，可以替代 Window 中的 alert、confirm 以及 prompt 彈窗 | 支援 | |
remoteEvaluate | 執行 FR 內建公式，返回公式計算結果 | 支援 | |
jsonEncode | 對字串進行jsonEncode 編碼 | 不支援 | |
jsonDecode | 對字串進行jsonEncode 解碼 | 不支援 | |
ajax | 封裝過的 jQuery.ajax() 函數 | 支援 | |
isEmpty | 判斷物件是否爲空 | 不支援 | |
isArray | 判斷物件是否爲陣列 | 不支援 | |
FR 物件-僅行動端支援 | location | 用於實現定位功能，獲取經緯度，可以在https、企業微信、釘釘中使用 | 支援 |
Mobile.getDeviceInfo | 獲取設備信息 | 支援 | |
FS 物件 | signOut | 登出數據決策系統，即返回決策平台登錄介面 | 不支援 |
tabPane.closeActiveTab | 關閉數據決策系統的标簽頁，即自動關閉決策系統中打開的預覽範本 | 支援 | |
tabPane.addItem | 在數據決策系統中打開新标簽頁 | 支援 |
2
參數面板API
參數面板API可用於調整參數面板的一些屬性，如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
| 參數面板API | getWidgetByName | 獲取參數面板中的元件，結合元件的方法使用 | 支援 |
3
元件API
元件API主要用於修改參數面板中元件、填報儲存格中元件、決策報表 body 中元件的屬性。元件API分通用和專有，通用API除特殊外所有元件都可以用，專有API僅能指定的元件用。
獲取元件的API，僅能在元件的【事件】中使用，如下表所示。
通用API，如下表所示。
【日期元件】專有API，如下表所示。
【按鈕元件】專有API，如下表所示。
【下拉框】元件專有API，如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
獲取元件API | this | 在元件的事件中使用，獲取當前的元件物件，獲取後可以使用元件的方法和屬性 | 支援 |
this.options.form | 在元件的事件中調用，可以使用 參數面板API 的所有方法 | 支援 | |
通用API | getValue | 獲取元件的實際值 | 支援 |
getText | 獲取元件的顯示值 | 支援 | |
setValue | 設定元件的值 | 支援 | |
visible | 設定元件可見 | 支援 | |
invisible | 設定元件不可見 | 支援 | |
setVisible | 設定元件可見/不可見 | 支援 | |
isVisible | 元件是否可見 | 支援 | |
setEnable | 設定元件可用/不可用 | 支援 | |
isEnabled | 元件是否可用 | 支援 | |
reset | 重置元件、清空元件的内容 | 支援 | |
getType | 獲取元件類型 | 支援 | |
setWaterMark | 添加水印文字（僅支援有輸入框的元件） | 支援 | |
fireEvent | 調用元件事件 | 支援 | |
setPopupStyle | 設定元件下拉選項框的樣式，僅支援有選項框的元件 | 不支援 | |
return false | 在元件的特定事件中加入 return false，不觸發聯動、查詢 | 不支援 | |
this.options.form | 在元件的事件中調用，可以使用 參數面板API 的所有方法 | 支援 | |
【日期元件】專有API | setMaxAndMinDate | 設定日期元件的可選日期範圍 | 支援 |
setPopupStyle | 設定彈出框樣式，僅支援有彈出框的元件 | 不支援 | |
【按鈕元件】專有API | doClick | 觸發按鈕的點擊事件，相當於人工點擊 | 支援 |
【下拉框】元件專有API | setName4Empty | 修改下拉框元件下拉時的默認文字“不選” | 不支援 |
4
表格API
表格API主要用於修改報表中表格内容，根據應用場景可分成跑馬燈API、隐藏滾動條API、修改儲存格背景API、修改儲存格字體API、修改列高欄寬API、獲取和設定儲存格值API、設定儲存格提示、設定儲存格樣式。
跑馬燈API如下表所示。
隐藏滾動條API如下表所示。
修改儲存格背景API如下表所示。
修改儲存格字體API，如下表所示。
設定儲存格提示API，如下表所示。
修改列高欄寬API，如下表所示。
修改儲存格字體API，如下表所示。
設定儲存格樣式API，如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
跑馬燈API | startMarquee | 開啓跑馬燈效果 | 不支援 |
stopMarquee | 關閉跑馬燈效果 | 不支援 | |
隐藏滾動條API | setHScrollBarVisible | 設定橫向滾動條顯示/隐藏 | 不支援 |
setVScrollBarVisible | 設定縱向滾動條顯示/隐藏 | 不支援 | |
修改儲存格背景API | addEffect | type: 'highlightRow'，滑鼠點擊或者懸浮儲存格時，儲存格所在的列變色 | 支援 |
type: 'highlightCol'，滑鼠點擊或者懸浮儲存格時，儲存格所在的欄變色 | 支援 | ||
type: 'highlightCross' ，滑鼠點擊或者懸浮儲存格時，儲存格所在的列和欄變色 | 支援 | ||
type: 'highlightCell' ，滑鼠點擊或者懸浮儲存格時儲存格變色 | 支援 | ||
修改儲存格字體API | addEffect | type: 'setCellFont'， 滑鼠點擊或者懸浮儲存格時，儲存格字體格式變化 | 支援 |
type: 'setRowFont' ，滑鼠點擊或者懸浮儲存格時，儲存格所在列字體格式變化 | 支援 | ||
滑鼠點擊或者懸浮儲存格所在列字體變化，滑鼠點擊或懸浮其他列恢複 | 支援 | ||
設定儲存格提示API | addEffect | type: 'setCellFont'，滑鼠懸浮出現文字/圖片提示框 | 不支援 |
修改列高欄寬API | setRowHeight | 改變儲存格列高 | 不支援 |
setColWidth | 改變儲存格欄高 | 不支援 | |
修改儲存格字體API | getCellValue | 獲取特定儲存格的值，參數可以爲儲存格地址，也可以爲儲存格列欄号 | 部分支援 |
setCellValue | 給特定儲存格賦值，參數可以爲儲存格地址，也可以爲儲存格列欄号 | 部分支援 | |
設定儲存格樣式API | setCellRadius | 給報表所有儲存格設定圓角，儲存格必須有背景色，否則無法看出效果。 | 不支援 |
5
工具欄API
工具欄API主要用於修改工具欄屬性和工具欄中按鈕屬性，分工具欄API、工具欄按鈕通用API、工具欄按鈕專用API。
工具欄API，如下表所示。
工具欄按鈕通用API，除特殊外所有工具欄按鈕都可以用，如下表所示。
郵件按鈕專有API，僅郵件按鈕可用，如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
工具欄API | getWidgetByName | 獲取報表工具欄中的按鈕，可結合按鈕的方法使用 | 不支援 |
toolBarFloat | 設定工具欄顯示位置 | 不支援 | |
setStyle | 修改工具欄大小 | 不支援 | |
setVisible | 設定工具欄顯示/隐藏 | 支援 | |
工具欄按鈕通用API | visible | 設定工具欄某個按鈕可見 | 不支援 |
invisible | 設定工具欄某個按鈕不可見 | 不支援 | |
setVisible | 設定工具欄某個按鈕不可見/不可見 | 不支援 | |
isVisible | 工具欄某個按鈕是否可見 | 不支援 | |
setEnable | 設定工具欄某個按鈕可用/不可用 | 不支援 | |
isEnabled | 工具欄某個按鈕是否可用 | 不支援 | |
| 郵件按鈕專有API | changeFormat | 修改郵件支援的格式選項 | 不支援
|
6
報表分頁API
報表分頁API主要用於分頁報表，如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
| 報表分頁API | gotoPreviousPage | 跳轉到上一頁 | 支援 |
gotoNextPage | 跳轉到下一頁 | 支援 | |
gotoLastPage | 跳轉到最後一頁 | 支援 | |
gotoFirstPage | 跳轉到第一頁 | 支援 | |
gotoPage | 跳轉到指定頁 | 支援 | |
getCurrentPageIndex | 獲取當前頁頁碼 | 支援 | |
getReportTotalPage | 獲取總頁數 | 支援 | |
currentPageIndex | 報表當前頁的頁碼 | 支援 | |
reportTotalPage | 報表的總頁數 | 支援 |
7
報表匯出API
匯出API，主要用於報表匯出，如下表所示。
方法
API | 說明 | 行動端 | |
|---|---|---|---|
| 匯出API | exportReportToExcel | 将報表匯出成 Excel | 部分支援 |
exportReportToImage | 将報表匯出成圖片 | 部分支援 | |
exportReportToPDF | 将報表匯出成 PDF | 部分支援 | |
exportReportToWord | 将報表匯出成 Word | 部分支援 |
二、普通報表
普通報表API，即僅有 cpt 普通報表可用，分公共模組和專有模組。
公共模組即所有的預覽模式都可以使用，專有模組僅能在對應預覽模式下使用。
1
公共API
公共模組API如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
| 公共模組API | getToolbar | 獲取工具欄物件 | 支援 |
2
分頁預覽API
分頁預覽專有API如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
| 分頁預覽專有API | expandNodeLayer | 展開折疊樹第 N 層節點 | 不支援 |
collapseNodeLayer | 收起折疊樹展開的第 N 層節點 | 不支援 | |
expandAllNodeLayer | 展開折疊樹的所有節點 | 不支援 | |
collapseAllNodeLayer | 收起折疊樹的所有節點 | 不支援 |
3
填報預覽API
填報預覽專有API如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
填報預覽專有API | getWidgetByName | 通過元件名稱獲取填報儲存格中的元件 | 支援 |
getWidgetByCell | 通過儲存格地址獲取填報儲存格中的元件 | 支援 | |
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 | 清空暫存 | 不支援 |
4
資料分析API
資料分析專有API如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
| 資料分析專有API | centerReport | 【資料分析】預覽時，設定報表居中顯示 | 不支援 |
三、決策報表
決策報表的API，即僅有 frm 決策報表可用。
分為獲取組件API、組件通用API、Tab 組件API。
1
獲取組件API
獲取組件API如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
獲取組件API | getAllWidgets | 獲取報表物件中所有組件信息 | 支援 |
getWidgetByName | 獲取報表物件中的某個組件，可以獲取到 body 中的組件和參數面板中的元件 | 支援 |
2
組件通用API
組件通用API即決策報表中所有組件都可以用，如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
組件通用API | visible | 設定組件可見 | 支援 |
invisible | 設定組件不可見 | 支援 | |
setVisible | 設定組件可見/不可見 | 支援 | |
isVisible | 返回組件是否可見 | 支援 |
3
Tab 組件API
Tab 組件API用於修改 Tab 組件的屬性，如下表所示。
方法 | API | 說明 | 行動端 |
|---|---|---|---|
Tab 組件API | showCardByIndex | 獲取正在展示的 Tab 頁的定位索引 | 支援 |
setTabVisible | 設定某個 Tab 頁顯示/隐藏 | 支援 | |
getShowIndex | 設定 Tab 塊标題顯示/隐藏 | 支援 | |
setTitleVisible | 展示第 N 個 Tab 頁 | 不支援
|
