AnnotationManager Class

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

API Index

Methods

Events

Integrated Events

Methods

createAnnotation()

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

Syntax

createAnnotation(pageUid: string, type: AnnotationType, annotationOptions?: RectAnnotationOptions|EllipseAnnotationOptions|PolygonAnnotationOptions|PolylineAnnotationOptions|LineAnnotationOptions|InkAnnotationOptions|TextBoxAnnotationOptions|TextTypewriterAnnotationOptions):Rectangle|Ellipse|Polygon|Polyline|Line|Ink|TextBox|TextTypewriter;

createAnnotation(pageUid: string, "stamp", annotationOptions?: StampAnnotationOptions): Promise<Stamp>;

Parameters

pageUid: Specify the page to add the annotation.

type: Specify the type of annotation to create.

type AnnotationType = "rectangle" | "ellipse" | "polygon" | "polyline" | "line" | "ink" | "textBox" | "textTypewriter" | "stamp";

annotationOptions: The annotation options. Please refer to

• RectAnnotationOptions
• EllipseAnnotationOptions
• PolygonAnnotationOptions
• PolylineAnnotationOptions
• LineAnnotationOptions
• InkAnnotationOptions
• TextBoxAnnotationOptions
• TextTypewriterAnnotationOptions
• StampAnnotationOptions

Return value

The instance of annotation. Please refer to

• Rectangle
• Ellipse
• Polygon
• Polyline
• Line
• Ink
• TextBox
• TextTypewriter
• Stamp

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

Please refer to

• Rectangle
• Ellipse
• Polygon
• Polyline
• Line
• Ink
• TextBox
• TextTypewriter
• Stamp
• Incomplete
• Unknown

Warning

getAnnotationsByPage()

Get annotations in specified page.

Syntax

getAnnotationsByPage(pageUid: string): Annotation[];

Parameters

pageUid: Specify the page.

Return value

An array of Annotation object.

Please refer to

• Rectangle
• Ellipse
• Polygon
• Polyline
• Line
• Ink
• TextBox
• TextTypewriter
• Stamp
• Incomplete
• Unknown

Warning

getAnnotationsByDoc()

Get all annotations in specified document.

Syntax

getAnnotationsByDoc(docUid: string): Annotation[];

docUid: Specify the doc.

Return value

An array of Annotation objects.

Please refer to

• Rectangle
• Ellipse
• Polygon
• Polyline
• Line
• Ink
• TextBox
• TextTypewriter
• Stamp
• Incomplete
• Unknown

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

  The table presents the ‘actions’ returned by events triggered by changes in attributes associated with various types of annotations.

  action	Rectangle	Ellipse	Polygon	Polyline	Line	Ink	TextBox	TextTypewriter	Stamp
  moved	x, y	x, y	Overall translation of points	Overall translation of points	Overall translation of startPoint&endPoint	Overall translation of points	x, y	x, y	x, y
  resized	width,height	width, height	points	points	startPoint, endPoint	points or resized through annotation selection’s control points	width, height	N/A	width, height
  rotated	rotation	rotation	N/A	N/A	N/A	rotation	rotation	N/A	rotation
  flagsChanged	flags	flags	flags	flags	flags	flags	flags	flags	flags
  appearanceChanged	borderWidth, borderColor, background, opacity, lineDash	borderWidth, borderColor, background, opacity, lineDash	borderWidth, borderColor, background, opacity, lineDash	lineEnding，borderWidth, borderColor, background, opacity, lineDash	lineEnding，borderWidth, borderColor, background, opacity, lineDash	borderWidth, borderColor, opacity	textAlign, textContents(excludes content), borderWidth, borderColor, background, opacity, lineDash	textContents(excludes content), opacity	opacity
  contentChanged	N/A	N/A	N/A	N/A	N/A	N/A	content in textContents	content in textContents	stamp