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
不再使用 'new' 来创建，而是使用 create 代替。
Parameters
- Optionaloptions: Options
Returns AnnotList
Example
```
const annotList = await AnnotList.create();
```

Properties

options

options: Options

Methods

destroy

destroy(): Promise<void>
销毁注释列表。

Returns Promise<void>
Implementation of AnnotListType.destroy

getAnnotByDict

getAnnotByDict(
pageIndex: number,
annotDict: PDFDictionaryType,
): Promise<null | AnnotType>
通过指定的字典获取注释。
Parameters
- pageIndex: number
  页索引，从 0 开始。
- annotDict: PDFDictionaryType
  注释字典。
Returns Promise<null | AnnotType>
Implementation of AnnotListType.getAnnotByDict

getAt

getAt(index: number): Promise<null | AnnotType>
获取指定位置的注释。
Parameters
- index: number
  注释列表中的从零开始的索引。
Returns Promise<null | AnnotType>
Implementation of AnnotListType.getAt

getCount

getCount(): Promise<number>
获取注释列表中的注释数量。

Returns Promise<number>
- 注释列表中的注释数量。
Implementation of AnnotListType.getCount

getDoc

getDoc(): Promise<null | DocType>
获取 PDF 文档。

Returns Promise<null | DocType>
- PDF 文档
Implementation of AnnotListType.getDoc

getIndex

getIndex(annot: AnnotType): Promise<number>
获取注释的索引。
Parameters
- annot: AnnotType
  输入的注释对象。
Returns Promise<number>
- 注释列表中的从零开始的索引。
Implementation of AnnotListType.getIndex

getPage

getPage(): Promise<null | PageType>
获取 PDF 页面。

Returns Promise<null | PageType>
- PDF 页面。
Implementation of AnnotListType.getPage

insert

insert(annot: AnnotType, index?: number): Promise<void>
在指定索引之前插入，如果索引等于当前数量，则追加到末尾。
Parameters
- annot: AnnotType
- Optionalindex: number
  要在其之前插入的从零开始的索引。
Returns Promise<void>
Implementation of AnnotListType.insert

moveTo

moveTo(index: number, newIndex: number): Promise<void>
将注释移动到指定位置。
Parameters
- index: number
  要移动的注释的位置
- newIndex: number
  要移动到的新位置
Returns Promise<void>
Implementation of AnnotListType.moveTo

moveToFirst

moveToFirst(index: number): Promise<void>
将注释移动到注释列表的第一个位置。
Parameters
- index: number
  要移动的注释的从零开始的索引。
Returns Promise<void>
Implementation of AnnotListType.moveToFirst

moveToLast

moveToLast(index: number): Promise<void>
将注释移动到注释列表的最后。
Parameters
- index: number
  要移动的注释的从零开始的索引。
Returns Promise<void>
Implementation of AnnotListType.moveToLast

remove

remove(index: number): Promise<void>
删除注释。
Parameters
- index: number
  要删除的注释的从零开始的索引。
Returns Promise<void>
Implementation of AnnotListType.remove

removeAll

removeAll(): Promise<void>
移除所有注解。

Returns Promise<void>
Implementation of AnnotListType.removeAll

replace

replace(index: number, annot: AnnotType): Promise<void>
将指定位置的注释替换为新的注释。
Parameters
- index: number
  注释列表中的从零开始的索引。
- annot: AnnotType
  新的注释。
Returns Promise<void>
Implementation of AnnotListType.replace

`Static`create

create(options?: Options): Promise<AnnotListType>
从 PDF 页面创建注释列表。
Parameters
- Optionaloptions: Options
  输入的 PDF 页面
Returns Promise<AnnotListType>
Example
```
{"page": pdfPage}
```