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

Return value

The object of polygon annotation options. Please refer to PolygonAnnotationOptions.

Code Snippet

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

updateOptions()

Update the annotation options.

Syntax

updateOptions(polygonAnnotationOptions: PolygonAnnotationOptions): boolean;

Parameters

polygonAnnotationOptions: The new polygon annotation options. Please refer to PolygonAnnotationOptions.

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 polygon = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "polygon"); // Create a default Polygon annotation instance.
const polygonOptions = {
    background: "red",
};
polygon.updateOptions(polygonOptions); // Update the background of the polygon to red.

Warning