Stamp Class

API Index

uid

Return the uid of the annotation.

Syntax

readonly uid: string;

pageUid

Return the uid of the page where the annotation is located.

Syntax

readonly pageUid: string;

Remark

• It will return '', if the annotation is be deleted.

creationDate

Return the creation date of the annotation.

Syntax

readonly creationDate: string;

Remark

• The string would be D:YYYYMMDDHHmmSSOHH'mm', like D:20230101085959-08'00'.

flattened

Flattens the annotation onto the image layer, or inspect if the annotation is flattened.

Syntax

flattened: boolean;  //Default value is `false`.

Remark

Flattened annotations move below all unflattened annotations on the page, and are stacked amongst themselves accordingly.

Flattened annotations become part of the page layer upon file export and cease to be annotations.

modificationDate

Return the modification date of the annotation.

Syntax

readonly modificationDate: string;

Remark

• The string would be D:YYYYMMDDHHmmSSOHH'mm', like D:20230101085959-08'00'.
• It will return '', if the annotation is be deleted.
• If the annotation is created but not be modified after adding, it equals to creationDate.

getOptions()

Get the annotation options.

Syntax

getOptions(): StampAnnotationOptions;

Return value

The object of stamp annotation options. Please refer to StampAnnotationOptions.

Code Snippet

// Given that editViewer is an existing instance of EditViewer and a document is currently open.
const pageUid = editViewer.indexToUid(0);
const stamp = await Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "stamp"); // Create a default Stamp annotation instance.
const stampOptions = stamp.getOptions();

updateOptions()

Update the annotation options.

Syntax

updateOptions(stampAnnotationOptions: StampAnnotationOptions): Promise<void>;

Parameters

stampAnnotationOptions: The new stamp annotation options. Please refer to StampAnnotationOptions.

Return value

A promise that resolves when the operation succeeds.

Code Snippet

// Given that editViewer is an existing instance of EditViewer and a document is currently open.
const pageUid = editViewer.indexToUid(0);
const stamp = await Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "stamp"); // Create a default Stamp annotation instance.
const stampOptions = {
    stamp: Dynamsoft.DDV.EnumStampIcon.APPROVED,
};
await stamp.updateOptions(stampOptions); // Update the stamp icon to 'APPROVED'.

Warning