1. 概述
1.1 版本
| 報表伺服器版本 |
|---|
| 11.0 |
1.2 功能簡介
公共模組的API，普通報表、FVS 視覺化看板和決策報表都可以使用，主要用來設定報表頁面的屬性；或者是用來設定普通報表和決策報表都有的功能屬性，比如設定元件、表格、工具欄、參數面板、圖表等的屬性。
普通報表的API一般用在 Web頁面事件、元件事件 中。如下圖所示：
FVS 視覺化看板中支援使用 JavaScript 程式碼觸發聯動、跳轉等交互效果。詳情可見：FVS支援的JS事件說明 。
如下圖所示：
決策報表的API一般都用在決策報表的 組件事件 中。如下圖所示：
公共模組API基本可以分為兩類：
一類是全局API，是可以操作整張報表的API，用來獲取報表整體，或者是對報表整體進行操作。如 _g()、FR、FS 及上的一些全局方法。
一類用來設定普通報表和決策報表都有的功能屬性，比如設定元件、表格、工具欄、參數面板、圖表等的屬性。
詳細內容可查看 2 節。
2. 索引
| 小節 | 內容簡介 | 文檔連結 |
|---|---|---|
| 全局API | 全局API，是可以操作整張報表的API，報表中其他元素的方法和屬性都繼承在全局API上。如果要獲取報表中其他元素並對其進行操作，就必須先使用全局API獲取到報表物件。 | 全局API |
| 全局API-FR | 透過 FR.xxx 的形式呼叫全局API FR 物件上的公有屬性與方法，用來設定報表的屬性，或者是呼叫報表的一些功能。 | 全局API-FR |
| 全局API-FS | 設計報表時，可以透過 FS 全局API獲取 FS 物件。FS 物件含有決策系統相關的屬性和方法，在報表中新增後，當報表掛載到決策系統中時，就會有對應的效果。 | 全局API-FS |
| 參數面板API | 參數面板API可用於調整參數面板的一些屬性，如獲取參數面板上的元件、展開和收起參數面板等。 | 參數面板API |
| 元件API | 元件API主要用於修改參數面板中元件、填報儲存格中元件、決策報表 body 中元件的屬性，如給元件指派、隱藏元件，設定元件不可用等。 | 元件API匯總 |
| 表格API | 表格API主要用於修改報表中內容、設定表格樣式，給表格加交互效果等，如給表格設定跑馬燈效果、隱藏表格捲軸、給表格設定滑鼠浮動背景變化效果等。 | 表格API匯總 |
| 圖表API | 圖表的API，即僅針對圖表可用，主要用於獲取圖表物件並對圖表的預覽效果設定特效，例如圖表重新整理等 | 圖表API匯總 |
| 工具欄API | 工具欄API主要用於修改工具欄屬性和工具欄中按鈕屬性，如獲取工具欄上的按鈕、設定工具欄上按鈕的屬性、隱藏工具欄等。 | 工具欄API匯總 |
| 報表分頁API | 報表分頁API主要用於分頁報表，用於定位當前頁數，跳轉到對應頁數，翻頁等。 | 報表分頁API |
| 報表匯出API | 報表匯出API，主要用於將報表匯出成常用的檔案格式，如 Excel、PDF、Word 等。 | 報表匯出API |
