类型定义
TiledWatermark
平铺水印对象。
line1不为空时,平铺水印为平铺文本水印。picUrl不为空时,平铺水印为平铺图片水印。line1和picUrl同时不为空,平铺水印为平铺文本水印。line1和picUrl同时为空,平铺水印为使用默认配置的平铺文本水印。
平铺文本水印
| 属性 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| line1 | 字符串 | 是 | 水印内容。默认为空 |
| line2 | 字符串 | 否 | 水印内容2。默认为空。 |
| line3 | 字符串 | 否 | 水印内容3。默认为空。 |
| line4 | 字符串 | 否 | 水印内容4。默认为空。 |
| withDate | 布尔值 | 是 | 水印是否带日期。默认值true。 |
| font | 字符串 | 是 | 字体。默认黑体。 |
| fontcolor | 字符串 | 是 | 字体颜色。颜色值为6位十六进制颜色值 |
| fontsize | 字符串 | 是 | 字号。默认值16。 |
| isFontBold | 布尔值 | 否 | 水印字体是否加粗。仅在操作图片、ofd时支持。 |
| isFontItalic | 布尔值 | 否 | 水印字体是否为斜体。仅在操作图片、ofd时支持 |
| transparent | 数字 | 是 | 水印透明度。默认值70。 |
| rotation | 数字 | 是 | 水印倾斜角度。默认值315。 |
| spacing | 数字 | 是 | 水印间距。默认值50。 |
平铺图片水印
| 属性 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| picUrl | 字符串 | 是 | 图片下载地址。下载图片请求会按照【[tokenType和tokenValue说明](#2.0.2.2 tokenType和tokenValue说明)】设置token |
| picName | 字符串 | 是 | 带后缀的图片。支持png/jpeg。名。 |
| picScale | 数字 | 否 | 图片缩放比例。在操作图片时,参数值范围为(0-200) |
| transparent | 数字 | 是 | 水印透明度 在操作图片时,参数值范围为(0-100) |
| rotation | 数字 | 是 | 旋转角度。 |
| spacing | 数字 | 是 | 图片间隔。 |
TextWatermark
位置文本水印
| 属性 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| text | 字符串 | 是 | 水印内容 |
| fontcolor | 字符串 | 是 | 字体颜色。颜色值为6位十六进制颜色值 |
| fontsize | 字符串 | 是 | 字号。取值范围[1, 72],值越大水印越大。ofd格式默认16 |
| font | 字符串 | 是 | 字体。 |
| isFontBold | 布尔值 | 否 | 水印字体是否加粗。仅在操作图片、ofd时支持。 |
| isFontItalic | 布尔值 | 否 | 水印字体是否为斜体。仅在操作图片、ofd时支持 |
| transparent | 数字 | 否 | 水印透明度, 取值范围[0, 100] |
| rotation | 数字 | 否 | 旋转角度 |
| position | 枚举值 | 否 | 水印位置,参数说明见【类型/WatermarkPosition】 |
MsPicWatermark
位置图片水印
| 属性 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| picUrl | 字符串 | 是 | 图片下载地址。下载图片请求会按照【[tokenType和tokenValue说明](#2.0.2.2 tokenType和tokenValue说明)】设置token |
| picName | 字符串 | 是 | 带后缀的图片名。支持jpg/jpeg/png/bmp 源文件类型为docx/wps/doc仅支持jpg/png |
| picScale | 数字 | 否 | 图片缩放比例(0-200) 源文件类型为docx/wps/doc支持范围为[50, 500] |
| isErosion | 布尔值 | 否 | 是否有冲蚀效果,默认false 仅在源文件类型为docx/wps/doc支持 |
| transparent | 数字 | 否 | 水印透明度(0-100)。源文件类型为docx/wps/doc不支持 |
| rotation | 数字 | 否 | 图片旋转角度。 |
| position | 枚举值 | 否 | 水印位置,默认CENTER,参数说明见【类型/WatermarkPosition】 |
| widthInCm | 数字 | 否 | 图片宽度,单位cm 仅在源文件类型为docx/wps/doc支持 |
| heightInCm | 数字 | 否 | 图片高度,单位cm 仅在源文件类型为docx/wps/doc支持 |
WatermarkPosition
水印位置枚举
| 值 | 说明 |
|---|---|
| TOP_LEFT | 顶部靠左 |
| TOP_CENTER | 顶部中间 |
| TOP_RIGHT | 顶部靠右 |
| CENTER_LEFT | 中间靠左 |
| CENTER | 正中 |
| CENTER_RIGHT | 中间靠右 |
| BOTTOM_LEFT | 底部靠左 |
| BOTTOM_CENTER | 底部中间 |
| BOTTOM_RIGHT | 底部靠右 |
Excel2PdfOptions
| 属性 | 选项类型 | 是否必须 | 说明 |
|---|---|---|---|
| type | 枚举值 | 否 | 打印类型,可选值: * range: 打印指定区间,区间在selectRange中设置 * allSheet: 打印整个工作簿,默认值 |
| selectRange | Range | type为range时必须 | 打印区间 |
| paperSize | 数字 | 否 | 纸张类型,默认纸张大小A4。可选值: * 1: 信纸 * 8: A3 * 9: A4 * 12: B4 * 13: B5 |
| orientation | 枚举值 | 否 | 纸张方向,默认值portrait。可选值: * portrait: 纵向 * landscape: 横向 |
| centerOnPageType | CenterOnPageType | 否 | 页面居中方式 |
| showGridLine | 布尔 | 否 | 是否显示网格线,默认为false |
| order | 枚举值 | 否 | 打印顺序,默认值overThenDown。可选值: * downThenOver: 先列后行 * overThenDown: 先行后列 |
| locale | 枚举值 | 否 | 语言环境,默认语言简体中文。可选值 * zh-cn: 简体中文 * zh-tw: 繁体中文 * zh-hk: 香港中文 * en: 英语 * en-us: 美国英语 * ja: 日文 |
| customPagePadding | PagePadding | 否 | 纸张边距 |
示例
-
打印全部sheet
{
"excel2pdfOptions": {
"type": "allSheet"
}
} -
打印Sheet1的B5:G19之间的内容
{
"excel2pdfOptions": {
"type": "range",
"selectRange": {
"sheetName": "Sheet1",
"startRow": 5,
"startCol": 2,
"endRow": 19,
"endCol": 7
}
}
} -
B4纸横向打印全部sheet,并且显示网格线,打印顺序先列后行
{
"excel2pdfOptions": {
"type": "allSheet",
"paperSize": 12,
"orientation": "landscape",
"showGridLine": true,
"order": "downThenOver"
}
}
Range
设置Range时,下方所有参数必须设置| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| sheetName | 字符串 | 待打印的工作表名称 |
| startRow | 数字 | 打印区间的开始行 |
| startCol | 数字 | 打印区间的开始列 |
| endRow | 数字 | 打印区间的结束行 |
| endCol | 数字 | 打印区间的结束列 |
CenterOnPageType
| 参数名称 | 参数类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| verticalCentered | 布尔 | 否 | 是否垂直居中(默认false) |
| horizontalCentered | 布尔 | 否 | 是否水平居中(默认false) |
PagePadding
设置PagePadding时,下方所有参数必须设置| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| top | 数字 | 上边距(默认1.91cm) |
| bottom | 数字 | 下边距(默认1.91cm) |
| left | 数字 | 左边距(默认1.78cm) |
| right | 数字 | 右边距(默认1.78cm) |
| header | 数字 | 页眉(默认0.76cm) |
| footer | 数字 | 页脚(默认0.76cm) |
toPicOptions
| 属性 | 选项类型 | 是否必须 | 说明 |
|---|---|---|---|
| start | 数字 | 否 | 转换起始页,从 1 开始计数,控制输出范围。 |
| end | 数字 | 否 | 转换结束页,end需要大于等于 start,(start和end不传默认为全部转换) |
| longPicType | 枚举值 | 否 | 转换后拼接图片,拼接方式(可选值:MD/TD)(纵向/横向), 不传默认不拼接。word转图片不支持拼接。 |