Class AnnotList

Implements

AnnotListType

Index

Constructors

Properties

Methods

destroy getAnnotByDict getAt getCount getDoc getIndex getPage insert moveTo moveToFirst moveToLast remove removeAll replace create

Constructors

constructor

new AnnotList(options?: Options): AnnotList
No longer use 'new' to create, but use create instead.
Parameters
- Optionaloptions: Options
Returns AnnotList
Example
```
const annotList = await AnnotList.create();
```

Properties

options

options: Options

Methods

destroy

destroy(): Promise<void>
Destroys an annotation list.

Returns Promise<void>
Implementation of AnnotListType.destroy

getAnnotByDict

getAnnotByDict(
pageIndex: number,
annotDict: PDFDictionaryType,
): Promise<null | AnnotType>
Get the annot by specified dictionary.
Parameters
- pageIndex: number
  Page index, starting from 0.
- annotDict: PDFDictionaryType
  The annotation dictionary.
Returns Promise<null | AnnotType>
Implementation of AnnotListType.getAnnotByDict

getAt

getAt(index: number): Promise<null | AnnotType>
Gets an annotation at specified position.
Parameters
- index: number
  The zero-based index in the annotation list.
Returns Promise<null | AnnotType>
Implementation of AnnotListType.getAt

getCount

getCount(): Promise<number>
Gets the count of annotations in the annotation list.

Returns Promise<number>
- The count of annotations in the annotation list.
Implementation of AnnotListType.getCount

getDoc

getDoc(): Promise<null | DocType>
Gets the PDF document.

Returns Promise<null | DocType>
- The PDF document
Implementation of AnnotListType.getDoc

getIndex

getIndex(annot: AnnotType): Promise<number>
Gets the annotation's index.
Parameters
- annot: AnnotType
  The input annotation.
Returns Promise<number>
- The zero-based index in the annotation list.
Implementation of AnnotListType.getIndex

getPage

getPage(): Promise<null | PageType>
Get the PDF Page.

Returns Promise<null | PageType>
- the PDF Page.
Implementation of AnnotListType.getPage

insert

insert(annot: AnnotType, index?: number): Promise<void>
Inserts BEFORE the index, if index equals to current count, then append.
Parameters
- annot: AnnotType
- Optionalindex: number
  The zero-based index to insert before.
Returns Promise<void>
Implementation of AnnotListType.insert

moveTo

moveTo(index: number, newIndex: number): Promise<void>
Moves an annotation to specified position.
Parameters
- index: number
  The annotation of position wanna to move
- newIndex: number
  The new position to move to
Returns Promise<void>
Implementation of AnnotListType.moveTo

moveToFirst

moveToFirst(index: number): Promise<void>
Moves an annotation to the first of the annotation list.
Parameters
- index: number
  The zero-based index of the annotation to be moved.
Returns Promise<void>
Implementation of AnnotListType.moveToFirst

moveToLast

moveToLast(index: number): Promise<void>
Moves an annotation to the last of the annotation list.
Parameters
- index: number
  The zero-based index of the annotation to be moved.
Returns Promise<void>
Implementation of AnnotListType.moveToLast

remove

remove(index: number): Promise<void>
Removes an annotation.
Parameters
- index: number
  The zero-based index of the annotation to be removed.
Returns Promise<void>
Implementation of AnnotListType.remove

removeAll

removeAll(): Promise<void>
Removes all the annotation.

Returns Promise<void>
Implementation of AnnotListType.removeAll

replace

replace(index: number, annot: AnnotType): Promise<void>
Replaces the specified position with a new annotation.
Parameters
- index: number
  The zero-based index in the annotation list.
- annot: AnnotType
  The new annotation.
Returns Promise<void>
Implementation of AnnotListType.replace

`Static`create

create(options?: Options): Promise<AnnotListType>
Creates an annotation list from a PDF page.
Parameters
- Optionaloptions: Options
  The input PDF page
Returns Promise<AnnotListType>
Example
```
{"page": pdfPage}
```