Interface WatermarkElementInfoType

Watermark element information.

Example

const watermarkElementInfo = {
    type: 0,
    pathName: 'pathName',
    page: 0,
    text: 'text',
    fontName: 'fontName',
    fontSize: 0,
    textColor: 0,
    rotation: 0,
    opacity: 0,
    scale: 0,
    top: true,
    verticalDistance: 0,
    verticalDistanceFrom: 0,
    horizontalDistance: 0,
    horizontalDistanceFrom: 0,
    start: 0,
    end: 0,
    even: true,
    odd: true,
    onScreen: true,
    onPrint: true,
    fixedPrint: true,
    percentage: true,
    pontUnit: true,
    specifyWatermarkDicValue: ''
};
interface WatermarkElementInfoType {
    end?: number;
    even?: boolean;
    fixedPrint?: boolean;
    fontName?: string;
    fontSize?: number;
    horizontalDistance?: number;
    horizontalDistanceFrom?: number;
    odd?: boolean;
    onPrint?: boolean;
    onScreen?: boolean;
    opacity?: number;
    page?: number;
    pathName?: string;
    percentage?: boolean;
    pontUnit?: boolean;
    rotation?: number;
    scale?: number;
    specifyWatermarkDicValue?: string;
    start?: number;
    text?: string;
    textColor?: number;
    top?: boolean;
    type?: number;
    verticalDistance?: number;
    verticalDistanceFrom?: number;
}

Properties

end? even? fixedPrint? fontName? fontSize? horizontalDistance? horizontalDistanceFrom? odd? onPrint? onScreen? opacity? page? pathName? percentage? pontUnit? rotation? scale? specifyWatermarkDicValue? start? text? textColor? top? type? verticalDistance? verticalDistanceFrom?

Properties

Optionalend

end?: number

Page end position: start from 0."

Optionaleven

even?: boolean

If only even pages, set bOdd to false.

OptionalfixedPrint

fixedPrint?: boolean

Whether to fix print.

OptionalfontName

fontName?: string

The font name of watermark text.

OptionalfontSize

fontSize?: number

The font size of watermark text.

OptionalhorizontalDistance

horizontalDistance?: number

The distance of horizontal, default unit is Inches.

OptionalhorizontalDistanceFrom

horizontalDistanceFrom?: number

Horizontal distance reference: Left 0, Center 1, Right 2.

Optionalodd

odd?: boolean

If only odd pages, set bEven to false.

OptionalonPrint

onPrint?: boolean

Whether to print.

OptionalonScreen

onScreen?: boolean

Whether to display on screen.

Optionalopacity

opacity?: number

Opacity,range from 0 to 1 percentage

Optionalpage

page?: number

The pages index will use for setting watermark.(0~nPageCount)

OptionalpathName

pathName?: string

Image or pdf absolute path, valid when nType is 1

Optionalpercentage

percentage?: boolean

Whether to display as a percentage of the page.

OptionalpontUnit

pontUnit?: boolean

Whether to use points as the unit.

Optionalrotation

rotation?: number

The watermak text range (0~360 degree)

Optionalscale

scale?: number

Scale relative to target page, range from 0 to 1 percentage

OptionalspecifyWatermarkDicValue

specifyWatermarkDicValue?: string

Set watermark dictionary value.

Optionalstart

start?: number

Page start position: start from 0.

Optionaltext

text?: string

The watermark text, valid when nType is 0.

OptionaltextColor

textColor?: number

The color of watermark text.

Optionaltop

top?: boolean

Set to FALSE to appear behind the page, or TRUE to appear on top of the page.

Optionaltype

type?: number

Types of watermark elements.0-Text, 1-File

OptionalverticalDistance

verticalDistance?: number

The distance of vertical , default unit is Inches.

OptionalverticalDistanceFrom

verticalDistanceFrom?: number

Vertical distance reference: Top 0, Center 1, Bottom 2.

Settings

Member Visibility

On This Page

Properties