JS API概覽

1. FineReport 開放了大量的 JS API 給使用者，使用者利用這些 JS 介面，可實現更多更復雜的功能。本文羅列了常用物件和它們的描述，方法的細節請查看對應文章。

1

FR（連接）。

1. 描述：

   透過此物件，呼叫 FineReport 內建的屬性和方法。在設計器中可直接使用 FR 中的方法，在外部應用使用 FR 中的方法必須引入 finereport.js。

2. 示例：

   彈出警告框：FR.Msg.alert(title, message, callback)。

2

FS（連結FS决策系统）。

1. 描述：

   透過此物件，呼叫對決策系統進行操作的屬性和方法。它也包含在finereport.js中。

2. 示例：

   在決策平臺開啟新標籤頁：FS.tabPane.addItem(entry)。

3

contentWindow。

1. 描述：

   在 Web 頁面整合的時候，將 FineReport 報表嵌入IFrame，外部呼叫IFrame中的報表物件時使用。

2. 示例：

   獲取IFrame中的Window物件：document.getElementById('reportFrame').contentWindow。

4

contentPane（連結contentPane）。

1. 描述：

   存放 CPT 報表內容的容器，即整個 CPT 報表物件。CPT 中有，FRM 中沒有。

2. 示例：

   獲取 CPT 填報儲存格元件：contentPane.getWidgetByCell("A1")。

5

_g()。

1. 描述：

   CPT 中，_g() 是整個報表物件，等同於 contentPane，支援 contentPane 下所有支援的方法；FRM 中，_g() 就是整個表單物件 globalForm，支援 globalForm 下所有支援的方法。

2. 示例：

   CPT／FRM 中參數介面元件事件實現查詢：_g().parameterCommit()。

6

paramterEL（連結 参数界面JS实例）。

1. 描述：

   參數面板物件。CPT 中，透過contentPane.parameterEL獲取；FRM 中，透過_g().parameterEL獲取。

2. 示例：

    CPT 載入結束事件中獲取參數介面元件的值：

   FR.Msg.alert("alert", contentPane.parameterEl.getWidgetByName("aa").getValue())。

7

curLGP（連結）。

1. 描述：

   即 current logic pane，填報預覽及決策報表預覽下 contentPane 下都會有一個 curLGP 物件。可用於獲取頁面中的儲存格。

2. 示例：

   填報預覽下獲取當前焦點所在的儲存格：contentPane.curLGP.currentTDCell。

8

form。

1. 描述：

   表單物件。CPT 和 FRM 中的參數介面都是表單，FRM 主體也是表單。

2. 示例：

   CPT 參數介面的按鈕點選事件中獲取其他元件的值：

   FR.Msg.alert("alert", this.options.form.getWidgetByName("aa").getValue())。

9

元件物件（連結 引用控件及控件方法列表）。

1. 描述：

   獲取元件物件的方式有：

   元件的事件中，透過 this 直接獲取到當前的元件物件。

   getWidgetByName() / getWidgetByCell()，用法在連結文章中詳細說明。

2. 示例：

   CPT 參數介面文字元件的編輯結束事件中獲取元件的值：

   FR.Msg.alert("alert", this.getValue())。

10

圖表物件（連結 ）。

1. 描述：

   獲取圖表物件的前提是獲取圖表塊物件，圖表塊物件包括單元格、懸浮元素、決策報表中的圖表塊和報表塊中的圖表。獲取圖表物件後，可以實現重新整理、輪播等效果。

2. 示例：

   獲取 A1 儲物格內圖表塊中的第一個圖表：

   FR.Chart.WebUtils.getChart(“A1”).getChartWithIndex(0)。