版本
報表伺服器版本 | 行動端版本 | 功能變動 |
---|---|---|
11.0 | - | 和 10.0 差別: 10.0 無此類API |
11.0.7 | - | 決策報表新增支援 getCell、getRow、getColumn、getRowCount、getColumnCount、onMouseClick、onMouseMoveInCell、onMouseMoveOutCell、scrollTo、getScrollOffset、setRadius、showToolTip API。 |
11.0.7 | - | 安裝了「FineVis資料視覺化」插件 V1.8.0 及之後版本,FVS 視覺化看板支援 getCell、getRow、getColumn、getRowCount、getColumnCount、onMouseClick、onMouseMoveInCell、scrollTo、getScrollOffset、setRadius、showToolTip API。 |
11.0.10 | 11.0.70 | 普通報表支援getCell、getRow、getColumn、getRowCount、getColumnCount、onMouseClick、onMouseMoveInCell、onMouseMoveOutCell、scrollTo、getScrollOffset、setRadius、showToolTip API。 |
在使用API前,請務必先仔細閱讀 JS API 相容說明,API預設支援普通報表和決策報表(新版)。
getCell
方法 | getCell(row,col) | 獲取第 row 行, 第 col 列的儲存格物件,其中參數為儲存格擴展後的位置。獲取儲存格物件後,可以使用報表塊儲存格物件API對儲存格進行設定。 |
---|---|---|
參數 | row:number col:number 注: 合併的儲存格,col、row 需要輸入合併後儲存格的首行號/首列號,否則傳回 undefined | row:儲存格行號,數字,從 1 開始 col:儲存格列號,數字,從 1 開始 |
回傳值 | object | object :儲存格 cell 物件 |
範例 | 範例1:若獲取到的報表塊定義為 report,獲取該報表塊的 A1 儲存格
範例2:決策報表中獲取 report0 報表塊中 A1 儲存格
範例3:普通報表中獲取 A1 儲存格
範例4:將普通報表中 A1 儲存格的字體設定為紅色、14 號
範例5:將決策報表中 report0 報表塊 A1 儲存格的字體設定為紅色、14 號
範例6:獲取 FVS視覺化看板中「表格1」組件中 A1 儲存格
範例7:將 FVS 視覺化看板中「表格1」組件 A1 儲存格的字體設定為紅色、20 號
| |
應用範例 | 點選按鈕,將決策報表中 report0 報表塊 A1 儲存格的字體設定為紅色、14 號: 點選可下載範本:获取单元格后修改单元格样式.frm FVS 視覺化看板:JS修改表格组件单元格样式.fvs | |
行動端 | 支援行動端 |
getRow
方法 | getRow(index) | 獲取第 index 行所有儲存格物件,其中參數為儲存格擴展後的行號。獲取儲存格物件後,可以使用報表塊儲存格物件API對儲存格進行設定。 |
---|---|---|
參數 | index:number | index:行號,數字,從 1 開始 |
回傳值 | object | object :儲存格行物件 |
範例 | 範例1:若獲取到的報表塊定義為 report,獲取該報表塊第一行儲存格物件
範例2:決策報表中獲取 report0 報表塊中第一行儲存格物件
範例3:普通報表中獲取第一行儲存格物件
範例4:將普通報表中,第一行儲存格的字體都設定為紅色、14號
範例5:將決策報表中 report0 報表塊的第一行儲存格的字體都設定為紅色、14 號
範例6:獲取 FVS 視覺化看板中「表格1」組件中第一行儲存格物件
範例7:將 FVS 視覺化看板中「表格1」組件的第一行儲存格的字體都設定為紅色、20 號
| |
應用範例 | 點選按鈕,將決策報表中 report0 報表塊的第一行儲存格的字體都設定為紅色、14 號: 點選可下載範本:获取行后修改行单元格样式.frm FVS 視覺化看板:JS修改表格组件行单元格样式.fvs | |
行動端 | 支援行動端 |
getColumn
方法 | getColumn(index) | 獲取第 index 列所有儲存格物件,其中參數為儲存格擴展後的列號。獲取儲存格物件後,可以使用報表塊儲存格物件API對儲存格進行設定。 |
---|---|---|
參數 | index:number | index:列號,數字,從 1 開始 |
回傳值 | object | object :儲存格列物件 |
範例 | 範例1:若獲取到的報表塊定義為 report,獲取該報表塊第一欄儲存格物件
範例2:決策報表中獲取 report0 報表塊中第一欄儲存格物件
範例3:普通報表中獲取第一欄儲存格物件
範例4:將普通報表中,第一欄儲存格的字體都設定為紅色、14 號
範例5:將決策報表中 report0 報表塊的第一欄儲存格的字體都設定為紅色、14 號
範例6:獲取 FVS 視覺化看板中「表格1」組件中第一欄儲存格物件
範例7:將 FVS 視覺化看板中「表格1」的第一欄儲存格的字體都設定為紅色、20 號
| |
應用範例 | 點選按鈕,將決策報表中 report0 報表塊的第一欄儲存格的字體都設定為紅色、14 號: 點選可下載範本:获取列后修改列单元格样式.frm FVS 視覺化看板:JS修改表格组件列单元格样式.fvs | |
行動端 | 支援行動端 |
getRowCount
方法 | getRowCount() | 獲取報表塊共有多少行,計算的是擴展後的行數 注:分頁預覽下僅獲取當前頁展示的總行數。 |
---|---|---|
參數 | - | - |
回傳值 | number | 報表塊的總行數,數字 |
範例 | 範例1:若獲取到的報表塊定義為 report,獲取該報表塊的總行數
範例2:決策報表中獲取 report0 報表塊的總行數
範例3:普通報表中,獲取儲存格行數:
範例4:獲取 FVS 視覺化看板中「表格1」組件的總行數
範例5:獲取決策報表中 report0 報表塊的總行數後,透過彈窗顯示總行數
| |
應用範例 | 點選按鈕,獲取決策報表中 report0 報表塊的總行數: 點選可下載範本:获取表格共有多少行.frm FVS 視覺化看板:JS获取表格组件总行数.fvs | |
行動端 | 支援行動端 |
getColumnCount
方法 | getColumnCount() | 獲取報表塊共有多少列,計算的是擴展後的列數 注:分頁預覽下僅獲取當前頁展示的總列數。 |
---|---|---|
參數 | - | - |
回傳值 | number | 報表塊的總列數,數字 |
範例 | 範例1:若獲取到的報表塊定義為 report,獲取該報表塊的總列數
範例2:獲取決策報表中 report0 報表塊的總列數
範例3:普通報表中,獲取儲存格行數
範例4:獲取 FVS 視覺化看板中「表格1」組件的總列數
範例5:獲取決策報表中 report0 報表塊的總列數後,透過彈窗顯示總列數
| |
應用範例 | 點選按鈕,獲取決策報表中 report0 報表塊的總列數: 點選可下載範本:获取表格共有多少列.frm FVS 視覺化看板:JS获取表格组件总列数.fvs | |
行動端 | 支援行動端 |
onMouseClick
方法 | onMouseClick(func) | 用於綁定滑鼠/手指點選事件,當滑鼠/手指點選表格時,觸發綁定的這個事件 |
---|---|---|
參數 | func:Function | func:回呼方法,函式形式 |
回傳值 | - | - |
範例 | 範例1:若獲取到的報表塊定義為 report,給該報表塊綁定一個點選後彈窗提醒的事件
範例2:給決策報表中 report0 報表塊綁定一個點選後彈窗提醒的事件
範例3:給普通報表綁定一個點選後彈窗提醒的事件
範例4:給 FVS 視覺化看板中「表格1」組件綁定一個點選後彈窗提醒的事件
範例5:給決策報表 report0 報表塊綁定一個點選後開啟跑馬燈的事件
| |
應用範例 | 給決策報表 report0 報表塊綁定點選後開啟跑馬燈的事件,當滑鼠點選報表塊時,開啟跑馬燈: 點選可下載範本:点击表格开启跑马灯.frm FVS 視覺化看板:点击表格开启跑马灯.fvs | |
行動端 | 不支援行動端 |
onMouseMoveInCell
方法 | onMouseMoveInCell(func) | 用於綁定滑鼠/手指移入儲存格事件,當滑鼠/手指移入儲存格時,觸發綁定的這個事件 |
---|---|---|
參數 | func:Function | func:回呼方法,函式形式 |
回傳值 | - | - |
範例 | 範例1:若獲取到的報表塊定義為 report,給該報表塊綁定一個移入表格後彈窗提醒的事件
範例2:給決策報表中 report0 報表塊綁定一個滑鼠移入後彈窗提醒的事件
範例3:給普通報表綁定一個滑鼠移入後彈窗提醒的事件
範例4:給 FVS 視覺化看板中「表格1」組件綁定一個移入表格後彈窗提醒的事件
範例5:給決策報表 report0 報表塊綁定一個滑鼠移入後開啟跑馬燈的事件
| |
應用範例 | 給決策報表 report0 報表塊綁定滑鼠移入後彈窗事件,當滑鼠移入報表塊時,彈窗提醒: 點選可下載範本:鼠标移入表格时弹窗提醒.frm FVS 視覺化看板:鼠标移入表格组件弹窗提醒.fvs | |
行動端 | 不支援行動端 |
onMouseMoveOutCell
方法 | onMouseMoveOutCell(func) | 用於綁定滑鼠/手指移出儲存格事件,當滑鼠/手指移出儲存格時,觸發綁定的這個事件 |
---|---|---|
參數 | func:Function | func:回呼方法,函式形式 |
回傳值 | - | - |
範例 | 範例1:若獲取到的報表塊定義為 report,給該報表塊綁定一個移出表格儲存格後彈窗提醒的事件
範例2:給決策報表中 report0 報表塊綁定一個移出表格儲存格後彈窗提醒的事件
範例3:給普通報表綁定一個滑鼠移出後彈窗提醒的事件
範例4:給決策報表 report0 報表塊綁定一個移出表格儲存格後表格第一行顏色變化的事件:
範例5:給 FVS 視覺化看板中「表格1」組件綁定一個移出儲存格後第一行變色事件
| |
應用範例 | 給決策報表 report0 報表塊綁定滑鼠移出儲存格後第一行變色事件,當滑鼠移出 A1 儲存格後,報表塊第一行顏色變化成紅色: 點選可下載範本:鼠标移出表格时颜色变化.frm FVS 視覺化看板:鼠标移出单元格颜色变化.fvs | |
行動端 | 不支援行動端 |
scrollTo
方法 | scrollTo(opts) | 設定報表塊捲動一段距離 |
---|---|---|
參數 | opts: Object { x: number, y: number } | opts: 捲動距離,json 格式
|
回傳值 | - | - |
範例 | 範例1:若獲取到的報表塊定義為 report,設定該報表塊橫向捲動 50 縱向捲動 100 :
範例2:將決策報表中 report0 報表塊橫向捲動 50 縱向捲動 100:
範例3:將普通報表橫向捲動 50 縱向捲動 100:
範例4:將 FVS 視覺化看板中「表格1」組件橫向捲動 50 縱向捲動 100:
範例5:將決策報表 report0 報表塊橫向捲動 50 縱向捲動 100:
| |
應用範例 | 將決策報表 report0 報表塊橫向不變,縱向捲動 100: 點選可下載範本:设置报表块自动滚动到某个位置.frm FVS 視覺化看板:设置表格滚动到某个位置.fvs | |
行動端 | 支援行動端,FVS 插件僅 V2.1.0 及之後版本支援行動端 |
getScrollOffset
方法 | getScrollOffset() | 獲取報表塊捲動到的位置 |
---|---|---|
參數 | - | - |
回傳值 | opts: Object { x: number, y: number } | opts: 捲動位置,json 格式
|
範例 | 範例1:若獲取到的報表塊定義為 report,獲取該報表塊當前捲動到的位置
範例2:獲取決策報表中 report0 報表塊當前捲動到的位置
範例3:獲取普通報表當前縱向捲軸所在的位置
範例4:獲取 FVS 視覺化看板中「表格1」組件當前縱向捲動到的位置
範例5:獲取決策報表中 report0 報表塊當前捲動到的位置並彈窗提醒當前位置
| |
應用範例 | 獲取決策報表中 report0 報表塊當前捲動到的位置並彈窗提醒當前位置: 點選可下載範本:获取报表块滚动到的位置.frm FVS 視覺化看板:获取表格滚动到的某个位置.fvs | |
行動端 | 支援行動端,FVS 插件僅 V2.1.0 及之後版本支援行動端 |
setRadius
方法 | setRadius(radius, range, single) | 給報表所有儲存格設定圓角,儲存格必須有背景色,否則無法看出效果。 |
---|---|---|
參數 | radius: number range: Object { row: [row1:number,row2:number,), column: [column1:number,column 2:number], cell: [col:number, row:number] } single: boolean | 1)radius:圓角程度,數字 2)range:圓角範圍,json 格式,可選欄位,預設為整個表格儲存格
3)single: 決定圓角的形式,布林型,預設為false
|
回傳值 | - | - |
範例 | 範例1:若獲取到的報表塊定義為 report,給該報表塊整體設定一個 25 的圓角:
範例2:給決策報表中 report0 報表塊整體設定一個 25 的圓角:
範例3:給決策報表中 report0 報表塊 A1 儲存格設定一個 25 的圓角:
範例4:給決策報表中 report0 報表塊第 1 行到第 3 行整體設定一個 25 的圓角:
範例5:給決策報表中 report0 報表塊第 2 列到第 5 列整體設定一個 25 的圓角:
範例6:給普通報表第 1 行到第 3 行整體設定一個 25 的圓角:
範例7:給 FVS 視覺化看板中「表格1」組件儲存格整體設定一個 25 的圓角: duchamp.getWidgetByName("表格1").setRadius(25); | |
應用範例 | 點選按鈕,給決策報表中 report0 報表塊第 1 行設定一個 25 的圓角: 點選可下載範本:设置单元格圆角.frm FVS 視覺化看板:设置单元格行圆角.fvs | |
行動端 | 不支援行動端 |
showToolTip
方法 | showToolTip(opts) | 設定報表塊所有儲存格提示 |
---|---|---|
參數 | opts: Object { show: boolean, content: { text: string, // 文字 image: string, // 圖片 header: string // 標題 } style: { } } | opts: 彈窗選項,是個物件 1)show:是否會出現彈窗,布林型,true 為出現,false 為不出現 2)content:可選欄位,不指定即為顯示文字,內容為儲存格中的值
也可以將圖片放置在報表工程目錄 %FR_HOME%\webapps\webroot 下,透過 URL 存取。如: http://localhost:8075/webroot/11.jpg
3)style: 可選欄位,不指定則為預設樣式,支援的樣式可參考:儲存格樣式屬性style |
回傳值 | - | - |
範例 | 範例1:若獲取到的報表塊定義為 report,給該報表塊設定一個標題為“提示”,內容為紅色“地區銷售資料”字樣的提示框:
範例2:給決策報表中 report0 報表塊設定一個標題為“提示”,內容為紅色“地區銷售資料”字樣的提示框:
範例3:給普通報表設定一個標題為“提示”,內容為網頁圖片帆軟 LOG 的提示框:
範例4:給決策報表中 report0 報表塊設定一個沒有標題,內容為紅色“地區銷售資料”字樣的提示框:
範例5:給 FVS 視覺化看板中「表格1」組件設定一個標題標題為“提示”,內容為儲存格值預設樣式的提示框
| |
應用範例 | 給決策報表中 report0 報表塊設定一個標題為“提示”,內容為紅色“地區銷售資料”字樣的提示框: 點選可下載範本:鼠标悬浮单元格文字提示.frm FVS 視覺化看板:鼠标悬浮单元格文字提示.fvs | |
行動端 | 不支援行動端 |