Type Alias: StampAnnotationProperties

type StampAnnotationProperties = MarkupAnnotationProperties & object;

Defines properties of a StampAnnotation.

Type Declaration

borderWidth?

optional borderWidth?: number;

The border width.

font?

optional font?: Font;

A font to draw the stamp. Note: This property is not persisted in the document and is used when the annotation's appearance is generated.

icon?

optional icon?: string;

A string specifying the name of an icon used to display the annotation. The PDF specification provides a predefined set of icons: "Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret".

In practice though this entry often contains names of custom icons specific to the application that created the document.

showCreationDate?

optional showCreationDate?: boolean;

A value indicating whether to show MarkupAnnotation#creationDate on the stamp. Note: This property is not persisted in the document and is used when the annotation's appearance is generated.

showUserName?

optional showUserName?: boolean;

A value indicating whether to show MarkupAnnotation#userName on the stamp. Note: This property is not persisted in the document and is used when the annotation's appearance is generated.

type

type: "stamp";