Line Class

API Index

API Name	Description
`uid`	Return the uid of the annotation.
`pageUid`	Return the uid of the page where the annotation is located.
`creationDate`	Return the creation date of the annotation.
`modificationDate`	Return the modification date of the annotation.
`getOptions()`	Get the annotation options.
`updateOptions()`	Update the annotation options.

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

Return value

The object of line annotation options. Please refer to LineAnnotationOptions.

Code Snippet

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

updateOptions()

Update the annotation options.

Syntax

updateOptions(lineAnnotationOptions: LineAnnotationOptions): boolean;

Parameters

lineAnnotationOptions: The new line annotation options. Please refer to LineAnnotationOptions.

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 line = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "line"); // Create a default Line annotation instance.
const lineOptions = {
    lineEnding: {
        end: Dynamsoft.DDV.EnumLineEnding.OPEN,
    },
};
line.updateOptions(lineOptions); // Update the line ending of the line to open.

Warning

Error Code	Error Message	API Return Value
-80100	XXX(API): XXX(ParameterName) is invalid.	`false`
-80102	XXX(API): XXX(ParameterName) is missing.	`false`