CustomStampSettings

9 Jul 20262 minutes to read

The CustomStampSettings module is used to provide the properties to customstamp annotation.

<div id="pdfViewer" style="height: 100%;width: 100%;"></div>
 let viewer: PdfViewer = new PdfViewer();
 // Change the custom stamp annotation settings.
 viewer.customStampSettings = {
     offset: { x:0, y:0 },
     pageNumber: 1,
     opacity: 1,
     author: 'Guest',
     width: 0,
     height: 0,
     left: 0,
     top: 0,
     isAddToMenu: false,
     minHeight: 0,
     minWidth: 0,
     maxWidth: 0,
     maxHeight: 0,
     isLock: false,
     customStamps: '',
     enableCustomStamp: true,
     allowedInteractions: ['None'],
     isPrint: true,
     subject: ''
 };
 viewer.appendTo("#pdfViewer");

Properties

allowedInteractions AllowedInteraction[]

Gets or sets the allowed interactions for the locked custom stamp annotations.
IsLock can be configured using custom stamp settings.

Defaults to [‘None’]

author string

specifies the author of the annotation.

Defaults to ‘Guest’

customStamps CustomStampModel[]

Define the custom image path and it’s name to be displayed in the menu items.

Defaults to ’’

enableCustomStamp boolean

If it is set as false. then the custom stamp items won’t be visible in the annotation toolbar stamp menu items.

Defaults to true

height number

specifies the height of the annotation.

Defaults to 0

isAddToMenu boolean

Specifies to maintain the newly added custom stamp element in the menu items.

Defaults to false

isLock boolean

specifies the locked action of the annotation.

Defaults to false

isPrint boolean

specifies whether the individual annotations are included or not in print actions.

Defaults to true

left number

specifies the left position of the annotation.

Defaults to 0

maxHeight number

specifies the maxHeight of the annotation.

Defaults to 0

maxWidth number

specifies the maxWidth of the annotation.

Defaults to 0

minHeight number

specifies the minHeight of the annotation.

Defaults to 0

minWidth number

specifies the minWidth of the annotation.

Defaults to 0

offset IPoint

Get or set offset of the annotation.

Defaults to { x: 0, y: 0}

opacity number

specifies the opacity of the annotation.

Defaults to 1

pageNumber number

Get or set page number of the annotation.

Defaults to 1

subject string

specifies the subject of the annotation.

Defaults to ’’

top number

specifies the top position of the annotation.

Defaults to 0

width number

specifies the width of the annotation.

Defaults to 0