EXCEL匯出元件API文件

2021-08-21 02:40:52 字數 3566 閱讀 4380

場景a(無模板場景):, 根據**資料資訊,生成excel(常用於單一**)

場景b(帶模板場景): 根據**資料資訊和現有模板檔案,生成excel(常用於有複雜樣式的**)

startline:資料的開始行號,預設為0(第0行通常放**的表頭),但在場景b中通常起始行號不為0,要根據待賦值資料的起始行號來定義此值。

e.g.excel模板中現有內容結束行號為6,則資料開始行號為7(下標為6),此時傳入的startline引數應為6。

dateformate:資料中日期的格式,預設為"yyyy-mm-dd"。

suffix:生成檔案字尾,可選引數為xlsx(預設,2007以後版本的字尾名)和xls(2003以前版本的字尾名)。

columnwidth:列寬陣列:預設單位為px,陣列大小需跟列表的列數相同,否則設定失敗,按等分處理。

sheetname :表單名稱(適用於無模板匯出,帶模板場景可為空

),預設名稱「sheet1」。

sheetindex :表單索引序號(適用於帶模板匯出,無模板場景可為空

),預設sheetindex = 0。

支援方法:

(1)public static workbook export(exceltitle arrfields, listlstmodel, excelconfig config);

用途:無模板的匯出常用方法。

引數:arrfields,(必填)**標題model列表(key:列的屬性名,對應第二個引數中model的成員變數或者map的key值,value:列的描述名)

lstmodel,(必填)**資料列表,可以是model或者map

config,(非必填)excel的配置model,具體屬性見excelconfig的定義。

(2)public static workbook export(workbook workbook, exceltitle arrfields, listlstmodel, excelconfig config);

用途:建立帶有多個sheet頁的excel時使用的方法,通常結合方法(1)一起使用。

引數:workbook,(必填)excel工作簿物件

lstmodel,(必填)**資料列表,可以是model或者map(同上)

config,(非必填)excel的配置model,具體屬性見excelconfig的定義。(同上)

支援方法:

(1)public static workbook exportbytemplate(inputstream in, string fields, listlstmodel, excelconfig config);

用途:有模板的匯出常用方法。

引數:in,模板檔案輸入流

fields,(必填)**資料域,如

lstmodel,(必填)**資料列表,可以是model或者map

config,(必填)excel的配置model,具體屬性見excelconfig的定義。

(2)public static workbook export(workbook workbook, string fields, listlstmodel, excelconfig config);

用途:建立帶有多個sheet頁的excel時使用的方法,通常結合方法(1)一起使用。

引數:workbook,(必填)excel工作簿物件 

fields,(必填)**資料域,如

lstmodel,(必填)**資料列表,可以是model或者map

config,(必填)excel的配置model,具體屬性見excelconfig的定義。

(3)public static workbook exportbytemplatedynamictitle(inputstream in, exceltitle arrfields, listlstmodel, excelconfig config);

用途:有模板+動態表頭的匯出常用方法。

引數:in,模板檔案輸入流

arrfields,(必填)**標題model列表(key:列的屬性名,對應第二個引數中model的成員變數或者map的key值,value:列的描述名)

lstmodel,(必填)**資料列表,可以是model或者map

config,(必填)excel的配置model,具體屬性見excelconfig的定義。

(4)public static workbook exportbytemplatedynamictitle(workbook workbook, 

, exceltitle arrfields, listlstmodel, excelconfig config);

用途:建立帶有多個sheet頁的excel時使用的方法,通常結合方法(3)一起使用。

引數:workbook,(必填)excel工作簿物件 

arrfields,(必填)**標題model列表(key:列的屬性名,對應第二個引數中model的成員變數或者map的key值,value:列的描述名)

lstmodel,(必填)**資料列表,可以是model或者map

config,(必填)excel的配置model,具體屬性見excelconfig的定義。

目前只定義了兩種常用樣式: 列頭樣式(headercellstyle)和單元格樣式(cellstyle),匯出實現類中(excelexport和excelexporttemplate)使用,應用程式通常不會用到。

(1)public static workbook getworkbook(string suffix);

public static workbook getworkbooktemplate(string suffix, inputstream in);

用途:根據配置中的suffix的值來獲取工作簿物件

引數:suffix,(必填)

待生成檔案的字尾,

in,(必填)

模板檔案的輸入流

(2)public static map<?, ?> objecttomap(object obj);

用途:將物件轉為map

引數:obj,(必填)待轉換物件

(3)public static string cellvalueformat(object obj, excelconfig config);

用途:**資料格式化

引數:obj,(必填)待格式化資料

config,(非必填)配置物件

1.資料列表的最大數量,目前支援的最大cell數(最大cell數=記錄數*每條記錄的cell數)限制為 size<500000;

2.無模板場景的config可以為空,元件會使用預設引數;

有模板場景的config為必填項,此處目的是為了保證使用者不會漏配正文的起始行數(startline)的引數,否則元件預設從第0行開始,即便生成了excel,也會覆蓋已有內容;

四. 測試類及測試檔案

原始碼+測試類+測試檔案》

匯出Excel或word文件

region 匯出檔案方法 匯出檔案方法 匯出檔案的名字 包括字尾名,word為 doc,excel為 xls 匯出的控制項 private void exportfile string exportfilename,string mime,control response.contentencod...

Vue專案匯出Excel元件

download元件目前只支援以下引數,後期根據功能需求再新增 引數 說明型別 可選值預設值 action string method 表單請求方法 string post get post params filed 請求引數欄位名 string params val 請求引數值 any actio...

poi匯出excel 之API整理

hssfworkbook wb new hssfworkbook hssfsheet sheet wb.createsheet hssfcellstyle setborder wb.createcellstyle 一 設定背景色 setborder.setfillforegroundcolor sh...