Type Definitions

TiledWatermark

Tiled watermark object.

• When line1 is not empty, tiled watermark is tiled text watermark.
• When picUrl is not empty, tiled watermark is tiled image watermark.
• When both line1 and picUrl are not empty, tiled watermark is tiled text watermark.
• When both line1 and picUrl are empty, tiled watermark is tiled text watermark using default configuration.

Tiled Text Watermark

Attribute	Type	Required	Description
line1	string	Yes	Watermark content. Default empty
line2	string	No	Watermark content 2. Default empty.
line3	string	No	Watermark content 3. Default empty.
line4	string	No	Watermark content 4. Default empty.
withDate	boolean	Yes	Whether watermark includes date. Default value true.
font	string	Yes	Font. Default SimHei.
fontcolor	string	Yes	Font color. Color value is 6-digit hexadecimal color value
fontsize	string	Yes	Font size. Default value 16.
isFontBold	boolean	No	Whether watermark font is bold. Only supported when operating images, ofd.
isFontItalic	boolean	No	Whether watermark font is italic. Only supported when operating images, ofd
transparent	number	Yes	Watermark transparency. Default value 70.
rotation	number	Yes	Watermark tilt angle. Default value 315.
spacing	number	Yes	Watermark spacing. Default value 50.

Tiled Image Watermark

Attribute	Type	Required	Description
picUrl	string	Yes	Image download address. Download image request will set token according to tokenType and tokenValue description
picName	string	Yes	Image name with extension. Supports png/jpeg.
picScale	number	No	Image scaling ratio. When operating images, parameter value range is (0-200)
transparent	number	Yes	Watermark transparency When operating images, parameter value range is (0-100)
rotation	number	Yes	Rotation angle.
spacing	number	Yes	Image spacing.

TextWatermark

Position text watermark

Attribute	Type	Required	Description
text	string	Yes	Watermark content
fontcolor	string	Yes	Font color. Color value is 6-digit hexadecimal color value
fontsize	string	Yes	Font size. Value range [1, 72], larger value means larger watermark. ofd format default 16
font	string	Yes	Font.
isFontBold	boolean	No	Whether watermark font is bold. Only supported when operating images, ofd.
isFontItalic	boolean	No	Whether watermark font is italic. Only supported when operating images, ofd
transparent	number	No	Watermark transparency, value range [0, 100]
rotation	number	No	Rotation angle
position	enum	No	Watermark position, parameter description see Type/WatermarkPosition

MsPicWatermark

Position image watermark

Attribute	Type	Required	Description
picUrl	string	Yes	Image download address. Download image request will set token according to tokenType and tokenValue description
picName	string	Yes	Image name with extension. Supports jpg/jpeg/png/bmp Source file type docx/wps/doc only supports jpg/png
picScale	number	No	Image scaling ratio (0-200) Source file type docx/wps/doc supports range [50, 500]
isErosion	boolean	No	Whether there is erosion effect, default false Only supported when source file type is docx/wps/doc
transparent	number	No	Watermark transparency (0-100). Source file type docx/wps/doc does not support
rotation	number	No	Image rotation angle.
position	enum	No	Watermark position, default CENTER, parameter description see Type/WatermarkPosition
widthInCm	number	No	Image width, unit cm Only supported when source file type is docx/wps/doc
heightInCm	number	No	Image height, unit cm Only supported when source file type is docx/wps/doc

WatermarkPosition

Watermark position enum

Value	Description
TOP_LEFT	Top left
TOP_CENTER	Top center
TOP_RIGHT	Top right
CENTER_LEFT	Center left
CENTER	Center
CENTER_RIGHT	Center right
BOTTOM_LEFT	Bottom left
BOTTOM_CENTER	Bottom center
BOTTOM_RIGHT	Bottom right

Excel2PdfOptions

Attribute	Option Type	Required	Description
type	enum	No	Print type, optional values: * range: print specified range, range set in selectRange * allSheet: print entire workbook, default value
selectRange	Range	Required when type is range	Print range
paperSize	number	No	Paper type, default paper size A4. Optional values: * 1: Letter * 8: A3 * 9: A4 * 12: B4 * 13: B5
orientation	enum	No	Paper orientation, default value portrait. Optional values: * portrait: Portrait * landscape: Landscape
centerOnPageType	CenterOnPageType	No	Page centering method
showGridLine	boolean	No	Whether to show grid lines, default is false
order	enum	No	Print order, default value overThenDown. Optional values: * downThenOver: Column first then row * overThenDown: Row first then column
locale	enum	No	Locale, default language Simplified Chinese. Optional values * zh-cn: Simplified Chinese * zh-tw: Traditional Chinese * zh-hk: Hong Kong Chinese * en: English * en-us: US English * ja: Japanese
customPagePadding	PagePadding	No	Paper margins

Example

1. Print all sheets

   {
       "excel2pdfOptions": {
           "type": "allSheet"
       }
   }

2. Print content between B5:G19 in Sheet1

   {
       "excel2pdfOptions": {
           "type": "range",
           "selectRange": {
               "sheetName": "Sheet1",
               "startRow": 5,
               "startCol": 2,
               "endRow": 19,
               "endCol": 7
           }
       }
   }

3. Print all sheets on B4 paper landscape, and show grid lines, print order column first then row

   {
       "excel2pdfOptions": {
           "type": "allSheet",
           "paperSize": 12,
           "orientation": "landscape",
           "showGridLine": true,
           "order": "downThenOver"
       }
   }

Range

When setting Range, all parameters below must be set

Parameter Name	Parameter Type	Parameter Description
sheetName	string	Worksheet name to print
startRow	number	Starting row of print range
startCol	number	Starting column of print range
endRow	number	Ending row of print range
endCol	number	Ending column of print range

CenterOnPageType

Parameter Name	Parameter Type	Required	Parameter Description
verticalCentered	boolean	No	Whether vertically centered (default false)
horizontalCentered	boolean	No	Whether horizontally centered (default false)

PagePadding

When setting PagePadding, all parameters below must be set

Parameter Name	Parameter Type	Parameter Description
top	number	Top margin (default 1.91cm)
bottom	number	Bottom margin (default 1.91cm)
left	number	Left margin (default 1.78cm)
right	number	Right margin (default 1.78cm)
header	number	Header (default 0.76cm)
footer	number	Footer (default 0.76cm)

toPicOptions

Attribute	Option Type	Required	Description
start	number	No	Conversion starting page, counting from 1, controls output range.
end	number	No	Conversion ending page, end needs to be greater than or equal to start, (if start and end are not passed, default is convert all)
longPicType	enum	No	Stitch images after conversion, stitching method (optional values: MD/TD) (vertical/horizontal), if not passed default is no stitching. Word to image does not support stitching.