Ink 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'.

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(): InkAnnotationOptions;

Return value

The object of ink annotation options. Please refer to InkAnnotationOptions.

Code Snippet

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

updateOptions()

Update the annotation options.

Syntax

updateOptions(inkAnnotationOptions: InkAnnotationOptions): boolean;

Parameters

inkAnnotationOptions: The new ink annotation options. Please refer to InkAnnotationOptions.

Return value

true: Successfully.

false: Failed.

Code Snippet

// Given that editViewer is an existing instance of EditViewer and a document is currently open.
const pageUid = editViewer.indexToUid(0);
const ink = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid,  "ink"); // Create a default Ink annotation instance.
const inkOptions = {
    borderColor: "red",
};
ink.updateOptions(inkOptions); // Update the border color of the ink to red.

Warning