跳到主要内容

类型定义

TiledWatermark

平铺水印对象。

  • line1不为空时,平铺水印为平铺文本水印。
  • picUrl不为空时,平铺水印为平铺图片水印。
  • line1picUrl同时不为空,平铺水印为平铺文本水印。
  • line1picUrl同时为空,平铺水印为使用默认配置的平铺文本水印。

平铺文本水印

属性类型是否必须说明
line1字符串水印内容。默认为空
line2字符串水印内容2。默认为空。
line3字符串水印内容3。默认为空。
line4字符串水印内容4。默认为空。
withDate布尔值水印是否带日期。默认值true。
font字符串字体。默认黑体。
fontcolor字符串字体颜色。颜色值为6位十六进制颜色值
fontsize字符串字号。默认值16。
isFontBold布尔值水印字体是否加粗。支持操作图片、ofd、pdf时生效
其中在v8.2版本之前,仅支持操作图片、ofd
isFontItalic布尔值水印字体是否为斜体。支持操作图片、ofd、pdf时生效
其中在v8.2版本之前,仅支持操作图片、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、pdf时生效
其中在v8.2版本之前,仅支持操作图片、ofd
isFontItalic布尔值水印字体是否为斜体。支持操作图片、ofd、pdf时生效
其中在v8.2版本之前,仅支持操作图片、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导出为pdf、ofd时生效
其中在v8.2版本之前,仅支持导出为pdf
heightInCm数字图片高度,单位cm。支持源文件类型为docx/wps/doc导出为pdf、ofd时生效
其中在v8.2版本之前,仅支持导出为pdf

WatermarkPosition

水印位置枚举,包含两类位置:

内容区域位置

基于页面内容区域的边距对齐,适用于大多数场景。

说明
TOP_LEFT顶部靠左
TOP_CENTER顶部中间
TOP_RIGHT顶部靠右
CENTER_LEFT中间靠左
CENTER正中
CENTER_RIGHT中间靠右
BOTTOM_LEFT底部靠左
BOTTOM_CENTER底部中间
BOTTOM_RIGHT底部靠右

页面边缘位置

贴近页面边缘,上下左右均固定 2mm 间距。适用于需要水印紧贴页面边缘的场景,目标格式为pdf、ofd。
v8.2版本开始支持

说明
PAGE_TOP_LEFT页面顶部靠左(距顶部、左侧各 2mm)
PAGE_TOP_CENTER页面顶部中间(距顶部 2mm,水平居中)
PAGE_TOP_RIGHT页面顶部靠右(距顶部、右侧各 2mm)
PAGE_BOTTOM_LEFT页面底部靠左(距底部、左侧各 2mm)
PAGE_BOTTOM_CENTER页面底部中间(距底部 2mm,水平居中)
PAGE_BOTTOM_RIGHT页面底部靠右(距底部、右侧各 2mm)

toPicOptions

属性选项类型是否必须说明
start数字转换起始页,从 1 开始计数,控制输出范围。
end数字转换结束页,end需要大于等于 start,(start和end不传默认为全部转换)
longPicType枚举值转换后拼接图片,拼接方式(可选值:MD/TD)(纵向/横向), 不传默认不拼接。word转图片不支持拼接。