一、概述
每一張報表都有一個FR物件,結合以下屬性和方法使用。
二、API說明
1
【servletURL】
屬性 | servletURL | 獲取servletURL。 |
---|---|---|
參數 | - | - |
傳回值 | string | 獲取servletURL,傳回值爲字串,格式如:
|
範例 |
| |
應用範例 | - | |
行動端 | 支援行動端,行動端返回格式和PC端有區别,如:/webroot/decision |
2
【serverURL】
屬性 | serverURL | 獲取serverURL。 |
---|---|---|
參數 | - | - |
傳回值 | string | 獲取serverURL,傳回值爲字串,格式如:
|
範例 |
| |
應用範例 | - | |
行動端 | 不支援行動端。 |
3
【server】
屬性 | server | 獲取server。 |
---|---|---|
參數 | - | - |
傳回值 | string | 獲取server,傳回值爲字串,格式如:
|
範例 |
| |
應用範例 | - | |
行動端 | 不支援行動端。 |
4
【fineServletURL】
屬性 | fineServletURL | 獲取fineServletURL。 |
---|---|---|
參數 | - | - |
傳回值 | string | 獲取fineServletURL,傳回值爲字串,格式如:
|
範例 |
| |
應用範例 | - | |
行動端 | 不支援行動端。 |
5
【SessionMgr.getSessionID】
方法 | SessionMgr.getSessionID() | 獲取sessionId |
---|---|---|
參數 | - | - |
傳回值 | string | 獲取sessionId,傳回值爲字串,如:
|
範例 |
| |
應用範例 | 點擊按鈕,列印報表的sessionId: 點擊可下載範本:列印sessionId.cpt。 | |
行動端 | 支援行動端。 |
6
【showDialog】
方法 | showDialog(title,width,height,innerContent) | 開啟一個對話框。 |
---|---|---|
參數 | title:string width:number height:number innerContent:iframe | title:對話框标題,字串。 width:對話框寬度。 height:對話框高度。 innerContent:對話框内容,iframe标簽,如果要開啟工程下的報表,需先将報表定義爲iframe标簽。 |
傳回值 | void | |
範例 | 開啟一個标題爲“彈窗”,寬600、高400内容爲“HelloWorld”的對話框:
開啟一個标題爲“銷量彈窗”,寬700,高500,彈窗内容爲内置範本GettingStartedTW.cpt的對話框: 注:設計器中添加如下較長代碼時,注意換列導緻的代碼格式問題,修改格式即可。
| |
應用範例 | 點擊按鈕,開啟一個标題爲“銷量彈窗”,寬700,高500,彈窗内容爲内置範本GettingStartedTW.cpt的對話框: | |
行動端 | 不支援行動端。 |
7
【closeDialog】
方法 | closeDialog() | 關閉對話窗。 |
---|---|---|
參數 | - | - |
傳回值 | void | |
範例 | FR.closeDialog(); | |
應用範例 | 彈窗選擇數據後,自動關閉已經開啟的對話框: | |
行動端 | 不支援行動端。 |
8
【doHyperlinkByGet】
方法 | doHyperlinkByGet(url,config,target,feature) | Get方法開啟一個網頁頁面,可以傳遞參數,可以設定頁面屬性。 |
---|---|---|
參數 | URL:object config:object target:object feature:object | URL:URL或Json超鏈定義,必填。 支援的絕對路徑如:
相對路徑如:
或
Object:傳遞的參數,可以不寫。 target:超鏈子頁的開啟位置,可以不寫。 feature:超鏈開啟位置的屬性,可以不寫。 |
傳回值 | void | |
範例 | 開啟内置範本GettingStartedTW.cpt,一個爲“銷售報表”,傳遞參數“華東”和是否顯示參數面板,開啟方式爲對話框,對話框寬700、高500:
| |
應用範例 | 點擊按鈕,開啟标題爲“銷售報表”,内容爲華東地區銷量情況,寬700、高500對話框: | |
行動端 | 支援行動端。 |
9
【doHyperlinkByPost】
方法 | doHyperlinkByPost(url,config,target,feature) | Post方法開啟一個網頁頁面,可以傳遞參數,可以設定頁面屬性。 |
---|---|---|
參數 | URL:object config:object target:object feature:object | URL:URL或Json超鏈定義,必填 支援的絕對路徑如:
相對路徑如:
或
Object:傳遞的參數,可以不寫。 target:超鏈子頁的開啟位置,可以不寫。 feature:超鏈開啟位置的屬性,可以不寫。 |
傳回值 | void | |
範例 | 開啟内置範本GettingStartedTW.cpt,一個爲“銷售報表”,傳遞參數“華東”和是否顯示參數面板,開啟方式爲對話框,對話框寬700、高500:
| |
應用範例 | 點擊按鈕,開啟标題爲“銷售報表”,内容爲華東地區銷量情況,寬700、高500對話框: | |
行動端 | 支援行動端。 |
10
【doURLPrint】
方法 | doURLPrint(config) | 呼叫列印工具,列印報表。 |
---|---|---|
參數 | config:object | config:列印參數,參數格式見doURLPrint。 |
傳回值 | Void | |
範例 | 見:doURLPrint。 | |
應用範例 | 自定義列印按鈕,以【零客戶端】方式列印報表: | |
行動端 | 不支援行動端。 |
11
【Msg】
方法 | Msg | FR内置的統一風格的消息框,可以替代Window中的alert、confirm以及prompt。 |
---|---|---|
參數 | - | 需調用其方法使用,詳細内容可見:Msg。 |
傳回值 | Void | |
範例 | 見:Msg | |
應用範例 | 給【文本控件】增加【編輯結束】事件,當填入的工号長度不是6時,彈窗提示:工号必須爲6位: | |
行動端 | 支援行動端。 |
12
【remoteEvaluate】
方法 | remoteEvaluate(formula) | 執行FR内置公式,返回公式計算結果。 注1:remoteEvaluate(String)不支援tablename.select函式。 注2:網頁中不支援調用remoteEvaluate(String)。 |
---|---|---|
參數 | formula:String | 公式,需要寫成字串形式。 |
傳回值 | object | |
範例 | 調用FR中sum函式對A1、A2求和:
調用FR中字串拼接函式CONCATENATE拼接字串
| |
應用範例 | - | |
行動端 | 支援行動端。 |
13
【jsonEncode】
方法 | jsonEncode(String) | 對字串進行jsonEncode編碼。 |
---|---|---|
參數 | - | - |
傳回值 | String | |
範例 | 對報表路徑進行jsonEncode編碼 | |
應用範例 | - | |
行動端 | 不支援行動端。 |
14
【jsonDecode】
方法 | jsonDecode(jsonEncodeString) | 對字串進行jsonEncode解碼。 |
---|---|---|
參數 | - | - |
傳回值 | String | |
範例 | 對轉碼過的報表路徑進行jsonEncode解碼:
| |
應用範例 | - | |
行動端 | 不支援行動端。 |
15
【ajax】
方法 | ajax(options) | 封裝過的jQuery.ajax()函式,對data參數做了中日韓文編碼處理,可以通過FR.ajax(options)在任何可以用JS的地方進行調用。 |
---|---|---|
參數 | options | Ajax參數,JSON格式,說明見:ajax 。 |
傳回值 | void | |
範例 | 見:ajax。 | |
應用範例 | - | |
行動端 | 支援行動端。 |
16
【isEmpty】
方法 | isEmpty(object) | 判斷物件是否爲空。 |
---|---|---|
參數 | object | 物件 |
傳回值 | Boolean | 是否爲空,布爾型。 true:是 false:否 |
範例 | 查看是否存在【文本框控件】text0:
| |
應用範例 | - | |
行動端 | 不支援行動端。 |
17
【isArray】
方法 | isArray(object) | 判斷物件是否爲數組。 |
---|---|---|
參數 | object | 物件 |
傳回值 | Boolean | 是否爲空,布爾型。 true:是 false:否 |
範例 | 定義一個數組,查看其是否爲數組:
| |
應用範例 | - | |
行動端 | 不支援行動端 |
18
【cellStr2ColumnRow】
方法 | cellStr2ColumnRow(cell) | 根據儲存格編号獲取列欄索引。 |
---|---|---|
參數 | cell | 儲存格編号。 |
傳回值 | {col:colindex,row:rowindex} | 行欄索引,json格式。 col:欄索引,從0開始。 row:行索引,從0開始。 |
範例 | 範例1:返回A1儲存格的行欄信息
範例2:列印A1儲存格的行号
| |
應用範例 | 點擊按鈕,列印A1儲存格的行号,如下圖所示: | |
行動端 | 支援行動端 |
19
【columnRow2CellStr】
方法 | columnRow2CellStr({col:colindex,row:rowindex}) | 根據行欄号獲取儲存格編号。 |
---|---|---|
參數 | {col:colindex,row:rowindex} | 列欄索引,json格式。 col:欄索引,從0開始。 row:列索引,從0開始。 |
傳回值 | cell | 儲存格編号 |
範例 | 範例1:返回列索引爲3,欄索引爲1的儲存格編号
範例2:列印列索引爲3,欄索引爲1的儲存格編号
| |
應用範例 | 列印列索引爲3,欄索引爲1的儲存格編号,如下圖所示: | |
行動端 | 不支援行動端。 |