Redaction 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 deleted.

source

Return the source of the annotation. Possible values:

• user: the annotation is created by the user’s action
• file: the annotation is created from a PDF file
• api: the annotation is created with code

Remark

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

type

Return the type of the annotation: redaction.

All annotation types:

"rectangle" | "redaction" | "ellipse" | "line" | "polygon" | "polyline" | "ink" | "textBox" | "textTypewriter" | "stamp" | "highlight" | "underline" | "strikeout" | "incomplete" | "unknown"

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 deleted.
• If the annotation is created but not be modified after adding, it equals to creationDate.

getOptions()

Get the annotation options.

Syntax

getOptions(): RedactionAnnotationOptions;

Return value

The object of redaction annotation options. Please refer to RedactionAnnotationOptions.

Code Snippet

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

updateOptions()

Update the annotation options.

Syntax

updateOptions(redactionAnnotationOptions: RedactionAnnotationOptions): boolean;

Parameters

redactionAnnotationOptions: The new redaction annotation options. Please refer to RedactionAnnotationOptions.

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

Warning

Exception