| 程序包 | 说明 |
|---|---|
| org.ttzero.excel.entity | |
| org.ttzero.excel.entity.csv | |
| org.ttzero.excel.entity.e7 |
| 限定符和类型 | 字段和说明 |
|---|---|
protected Workbook |
Sheet.workbook
工作薄
|
| 限定符和类型 | 方法和说明 |
|---|---|
Workbook |
Workbook.addContentType(ContentType.Type type)
添加资源类型,导出图片时按照图片格式添加不同的资源类型,一般情况下开发者不需要关心
|
Workbook |
Workbook.addContentTypeRel(Relationship rel)
添加ContentType关系,一般情况下开发者不需要关心
|
Workbook |
Workbook.addSheet(Sheet sheet)
添加一个工作表
Sheet,新添加的工作表总是排在队列最后,
可以使用insertSheet(int, org.ttzero.excel.entity.Sheet)插入到指定位置 |
Workbook |
Workbook.bestSpeed()
将压缩等级设为
1以获取更快的速度 |
Workbook |
Workbook.cancelZebraLine()
取消斑马线
|
Workbook |
Workbook.defaultZebraLine()
指定以默认斑马线输出,默认背景颜色为
#EFF5EB |
Workbook |
Workbook.forceExport()
强制导出
注意:设置此标记后将无视安全规则导出Java对象中的所有字段,请根据实际情况谨慎使用
|
Workbook |
Sheet.getWorkbook()
获取当前工作表对应的工作薄
|
Workbook |
Workbook.insertSheet(int index,
Sheet sheet)
在指定下标插入一个工作表
Sheet |
Workbook |
Workbook.markAsReadOnly()
文档保护-标记只读
|
Workbook |
Workbook.onProgress(BiConsumer<Sheet,Integer> progressConsumer)
添加一个进度监听器,可以在较大导出时展示进度
new Workbook().onProgress((sheet, row) -> {
System.out.println(sheet + " write " + row + " rows");
})
|
Workbook |
Workbook.putCustomProperties(Map<String,Object> properties)
添加自定义属性,自定义属性可以从"信息"->"属性"->"自定义属性"查看
注意:只支持
"文本"、"数字"、"日期"以及"布尔值",其它数据类型将使用toString强转换为文本 |
Workbook |
Workbook.putCustomProperty(String key,
Object value)
添加自定义属性,自定义属性可以从"信息"->"属性"->"自定义属性"查看
注意:只支持
"文本"、"数字"、"日期"以及"布尔值",其它数据类型将使用toString强转换为文本 |
Workbook |
Workbook.remove(int index)
移除指定位置的工作表
Sheet |
Workbook |
Workbook.saveAsCSV()
另存为Comma-Separated Values格式,默认使用','逗号分隔
|
Workbook |
Workbook.saveAsCSV(Charset charset)
以指定字符集保存为Comma-Separated Values格式,默认使用','逗号分隔
|
Workbook |
Workbook.saveAsCSVWithBom()
另存为Comma-Separated Values格式并保存BOM,默认使用','逗号分隔
|
Workbook |
Workbook.saveAsCSVWithBom(Charset charset)
以指定字符集保存为Comma-Separated Values格式并保存BOM,默认使用','逗号分隔
|
Workbook |
Workbook.setAutoSize(boolean autoSize)
设置全局自适应列宽
|
Workbook |
Workbook.setCompany(String company)
设置公司名,建议控制在64个字符以内
|
Workbook |
Workbook.setCore(Core core)
设置文档属性,包含主题,关键词,分类等信息
|
Workbook |
Workbook.setCreator(String creator)
设置作者
设置作者后可以通过查看文件属性来查看作者
|
Workbook |
Workbook.setName(String name)
设置工作薄名称,如果writeTo方法指定的Path或File为文件夹时该名称将作为最终文件名
|
Workbook |
Workbook.setStyles(Styles styles)
设置全局样式
Styles |
Workbook |
Workbook.setWatermark(Watermark watermark)
设置水印
Watermark,可以使用Watermark.of(java.lang.String)静态方法创建 |
Workbook |
Workbook.setWaterMark(Watermark watermark)
已过时。
|
Workbook |
Workbook.setWorkbookWriter(IWorkbookWriter workbookWriter)
设置自定义工作薄输出协议
|
Workbook |
Workbook.setZebraLine(Fill fill)
设置斑马线背景,斑马线是由相同间隔的背景色造成的视觉效果,有助于从视觉上区分每行数据,
但刺眼的背景色可能造成相反的效果,设置之前最好在Office中提前预览效果
|
| 限定符和类型 | 方法和说明 |
|---|---|
Sheet |
Sheet.setWorkbook(Workbook workbook)
设置工作薄,一般在调用
addSheet(org.ttzero.excel.entity.Sheet)时设置工作薄,Workbook包含
样式、共享字符区、资源类型等全局配置,为了方便读取所以每个worksheet均包含Workbook句柄 |
void |
IWorkbookWriter.setWorkbook(Workbook workbook)
设置工作薄
|
| 限定符和类型 | 字段和说明 |
|---|---|
protected Workbook |
CSVWorkbookWriter.workbook |
| 限定符和类型 | 方法和说明 |
|---|---|
void |
CSVWorkbookWriter.setWorkbook(Workbook workbook) |
| 构造器和说明 |
|---|
CSVWorkbookWriter(Workbook workbook) |
CSVWorkbookWriter(Workbook workbook,
boolean withBom) |
| 限定符和类型 | 字段和说明 |
|---|---|
protected Workbook |
XMLWorkbookWriter.workbook |
| 限定符和类型 | 方法和说明 |
|---|---|
Workbook |
XMLWorkbookWriter.getWorkbook() |
| 限定符和类型 | 方法和说明 |
|---|---|
void |
XMLWorkbookWriter.setWorkbook(Workbook workbook)
Setting workbook
|
| 构造器和说明 |
|---|
XMLWorkbookWriter(Workbook workbook) |
Copyright © 2025. All rights reserved.