AnnotationManager Class

The Dynamsoft.DDV.annotationManager instance will be created automatically as soon as DDV is initialized. Please refer to annotationManager.

Please note that it is undefined if the annotation plugin is not installed.

API Index

Methods

Events

Integrated Events

Methods

applyRedactions()

Apply redaction annotations.

Syntax

applyRedactions(pageUid: string, annotationUids?: string[]): Promise<boolean>;

Parameters

pageUid: Specify the page to apply redaction annotations.

annotationUids: Specify the array of uids of redaction annotations to apply for one page. If it is empty, all the redaction annotations on the specified page will be used.

Return value

A Promise object which indicates whether the operation is successful or not.

Exception

createAnnotation()

Create an annotation instance and add the created instance to the specified page.

Syntax

createAnnotation<K extends keyof AnnotationsTypeMapOuter>(pageUid: string, type: K, annotationOptions?: AnnotationsTypeMapOuter[K]["options"]): AnnotationsTypeMapOuter[K]["return"];

Parameters

pageUid: Specify the page to add the annotation.

type: Specify the type of annotation to create.

type AnnotationType = "rectangle" | "redaction" | "ellipse" | "polygon" | "polyline" | "line" | "ink" | "textBox" | "textTypewriter" | "stamp" | "highlight" | "underline"| "strikeout";

annotationOptions: The annotation options. Please refer to the options list.

Return value

The instance of annotation. Please refer to Annotation.

Code Snippet

• To creat new annotations.

    // Given that editViewer is an existing instance of EditViewer and a document is currently open.
    const pageUid = editViewer.indexToUid(0);
  
    const rect = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "rectangle");
    const ellipse = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "ellipse");
    const polygon = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "polygon");
    const polyline = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "polyline");
    const line = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "line");
    const ink = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "ink");
    const textBox = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "textBox");
    const textTypewriter = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "textTypewriter");
    const highlight = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "highlight");
    const underline = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "underline");
    const strikeout = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "strikeout");
    const redaction = Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "redaction");
    const stamp = await Dynamsoft.DDV.annotationManager.createAnnotation(pageUid, "stamp");
  

Exception

getAnnotationsByUids()

Get annotations by annotation uids.

Syntax

getAnnotationsByUids(annotationUids: string[]): Annotation[];

Parameters

annotationUids: The array of the annotation uids.

Return value

An array of Annotation objects.

Warning

getAnnotationsByPage()

Get annotations in specified page.

Syntax

getAnnotationsByPage(pageUid: string): Annotation[];

Parameters

pageUid: Specify the page.

Return value

An array of Annotation object.

Warning

getAnnotationsByDoc()

Get all annotations in specified document.

Syntax

getAnnotationsByDoc(docUid: string): Annotation[];

docUid: Specify the doc.

Return value

An array of Annotation objects.

Warning

deleteAnnotations()

Delete specified annotations.

Syntax

deleteAnnotations(annotationUids: string[]): boolean;

Parameters

annotationUids: Specify the array of annotation uids to delete.

Return value

true

false

Warning

bringAnnotationForward()

Bring the specified annotation forward.

Syntax

bringAnnotationForward(annotationUid: string): boolean;

Parameters

annotationUid: Specify the annotation uid to bring forward.

Return value

true: Successfully.

false: Failed.

Warning

sendAnnotationBackward()

Send the specified annotation backward.

Syntax

sendAnnotationBackward(annotationUid: string): boolean;

Parameters

annotationUid: Specify the annotation uid to send backward.

Return value

true: Successfully.

false: Failed.

Warning

bringAnnotationToFront()

Bring the specified annotation in front of all other annotations.

Syntax

bringAnnotationToFront(annotationUid: string): boolean;

Parameters

annotationUid: Specify the annotation uid to bring to front.

Return value

true: Successfully.

false: Failed.

Warning

sendAnnotationToBack()

Send the specified annotation behind all other annotations.

Syntax

sendAnnotationToBack(annotationUid: string): boolean;

Parameters

annotationUid: Specify the annotation uid to send to back.

Return value

true: Successfully.

false: Failed.

Warning

Events

on()

Bind a listener to the specified event.

Syntax

on(eventName: EventName, listener:(event:EventObject)=>void): void;

Parameters

eventName: Specify the event name. It should be an integrated event name.

listener: Specify the listener.

Code Snippet

// Bind a listener to the integrated event annotationsModified.
const eventFunc = (e)=>{
    console.log(e);
    console.log(e.modifiedAnnotations[0].uid);
    console.log(e.modifiedAnnotations[0].newOptions);
    console.log(e.actions);
};

Dynamsoft.DDV.annotationManager.on("annotationsModified", eventFunc);

Warning

off()

Unbind event listener(s) from the specified event.

Syntax

off(eventName: EventName, listener?:(event:EventObject)=>void): void;

Parameters

eventName: Specify the event name. It should be an integrated event name.

listener: Specify the listener. If no listener is specified, unbind all event listeners from the specified event

Code Snippet

const eventFunc = (e)=>{
    console.log(e);
    console.log(e.modifiedAnnotations[0].uid);
    console.log(e.modifiedAnnotations[0].newOptions);
    console.log(e.actions);
};

Dynamsoft.DDV.annotationManager.on("annotationsModified", eventFunc);

// Unbind the specified event listener.
Dynamsoft.DDV.annotationManager.off("annotationsModified", eventFunc);

Warning

Integrated events

annotationsAdded

Triggered when new annotation(s) is added.

Callback

An EventObject.

Attributes

annotationUids: The array of new added annotations uids.

annotationsDeleted

Triggered when annotation(s) is deleted.

Callback

An EventObject.

Attributes

annotationUids: The array of deleted annotations uids.

annotationLayerChanged

Triggered when annotation’s layer is changed.

Callback

An EventObject.

Attributes

oldAnnotationUidList : The list of old annotation uids, arranged in hierarchical order from bottom to top for each page.

newAnnotationUidList: The list of new annotation uids, arranged in hierarchical order from bottom to top for each page.

annotationsModified

Triggered when annotation(s) is modified.

Callback

An EventObject.

Attributes

modifiedAnnotations: The array of the objects which include below properties.

• uid: The modified annotation uid.
• oldOptions: The modified annotation old options.
• newOptions: The modified annotation new options.

actions: The array of actions. Supported actions:

• moved
• resized
• rotated
• flagsChanged
• appearanceChanged
• contentChanged