Class Annot

This class is pdf Annot object.

Hierarchy

Annot
- FileAttachment
- FreeText

Index

Methods

Methods

destroy

destroy(): Promise<boolean>

Delete the annot of the page

see

Annot

Returns Promise<boolean>

bool is true of false

getAnnot

getAnnot(): Promise<Annot | FreeText | FileAttachment>

Gets the annot instance.

Returns Promise<Annot | FreeText | FileAttachment>

PDF annot object

getProps

getProps(): Promise<AnnotOptions>

Export the current annotation to a Json object.

see

Annot

Returns Promise<AnnotOptions>
- A json object of annotation's property. The key and value formats try to follow XFDF specifications

setProps

setProps(propsJson: AnnotOptions): Promise<void>

Set the properties of annot

see

Annot

Parameters
- propsJson: AnnotOptions
  
  Attribute object
Returns Promise<void>

underfined