DsPdfJS API v9.1.3

DsPdfJS API / WatermarkAnnotationProperties

Type Alias: WatermarkAnnotationProperties

WatermarkAnnotationProperties = AnnotationBaseProperties & object

Defines properties of a WatermarkAnnotation.

Type Declaration

horzTranslate?

optional horzTranslate: number

The amount to translate the associated content horizontally, as a percentage of the width of the target media (or if unknown, the width of the page's MediaBox). 1.0 represents 100% and 0.0 represents 0%. Negative values are not recommended, since they may cause content to be drawn off the page.

image?

optional image: ImageOrBitmap

The image if watermark annotation, if both 'text' and 'image' are specified then 'image' is used as watermark content.

matrix?

optional matrix: number[]

The matrix used to transform the annotation's rectangle before rendering.

text?

optional text: string

The text of watermark annotation, if both 'text' and 'image' are specified then 'image' is used as watermark content.

textFormat?

optional textFormat: Format | FormatProperties

The Format object that specifies the formatting of the annotation's text.

Note that this object itself is not persisted in the PDF, just its properties are used to generate the appearance of this watermark annotation.

type

type: "watermark"

vertTranslate?

optional vertTranslate: number

The amount to translate the associated content vertically, as a percentage of the height of the target media (or if unknown, the height of the page's MediaBox). 1.0 represents 100% and 0.0 represents 0%. Negative values are not recommended, since they may cause content to be drawn off the page.