Interface AnnotListType

interface AnnotListType {
    destroy: () => Promise<void>;
    getAnnotByDict: (
        pageIndex: number,
        annotDict: PDFDictionaryType,
    ) => Promise<null | AnnotType>;
    getAt: (index: number) => Promise<null | AnnotType>;
    getCount: () => Promise<number>;
    getDoc: () => Promise<null | DocType>;
    getIndex: (annot: AnnotType) => Promise<number>;
    getPage: () => Promise<null | PageType>;
    insert: (annot: AnnotType, index?: number) => Promise<void>;
    moveTo: (index: number, newIndex: number) => Promise<void>;
    moveToFirst: (index: number) => Promise<void>;
    moveToLast: (index: number) => Promise<void>;
    options: Options;
    remove: (index: number) => Promise<void>;
    removeAll: () => Promise<void>;
    replace: (index: number, annot: AnnotType) => Promise<void>;
}

Implemented by

Properties

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

Properties

destroy

destroy: () => Promise<void>

销毁注释列表。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getAnnotByDict

getAnnotByDict: (
    pageIndex: number,
    annotDict: PDFDictionaryType,
) => Promise<null | AnnotType>

通过指定的字典获取注释。

Type declaration

getAt

getAt: (index: number) => Promise<null | AnnotType>

在指定位置获取注释。

Type declaration

    • (index: number): Promise<null | AnnotType>

    • Parameters

      • index: number

        注释列表中的从零开始的索引。

      Returns Promise<null | AnnotType>

getCount

getCount: () => Promise<number>

获取注释列表中的注释数量。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 注释列表中的注释数量。

getDoc

getDoc: () => Promise<null | DocType>

获取 PDF 文档。

Type declaration

    • (): Promise<null | DocType>

    • Returns Promise<null | DocType>

      • PDF 文档

getIndex

getIndex: (annot: AnnotType) => Promise<number>

获取批注的索引。

Type declaration

    • (annot: AnnotType): Promise<number>

    • Parameters

      Returns Promise<number>

      • 批注列表中的从零开始的索引。

getPage

getPage: () => Promise<null | PageType>

获取 PDF 页面。

Type declaration

insert

insert: (annot: AnnotType, index?: number) => Promise<void>

在指定索引之前插入，如果索引等于当前数量，则追加到末尾。

Type declaration

    • (annot: AnnotType, index?: number): Promise<void>

    • Parameters

      • annot: AnnotType
      • Optionalindex: number

        要在其之前插入的从零开始的索引。

      Returns Promise<void>

moveTo

moveTo: (index: number, newIndex: number) => Promise<void>

将注释移动到指定位置。

Type declaration

    • (index: number, newIndex: number): Promise<void>

    • Parameters

      • index: number

        要移动的注释位置

      • newIndex: number

        要移动到的新位置

      Returns Promise<void>

moveToFirst

moveToFirst: (index: number) => Promise<void>

将注释移动到注释列表的第一个位置。

Type declaration

    • (index: number): Promise<void>

    • Parameters

      • index: number

        要移动的注释的从零开始的索引。

      Returns Promise<void>

moveToLast

moveToLast: (index: number) => Promise<void>

将注释移动到注释列表的最后。

Type declaration

    • (index: number): Promise<void>

    • Parameters

      • index: number

        要移动的注释的从零开始的索引。

      Returns Promise<void>

options

options: Options

remove

remove: (index: number) => Promise<void>

移除一个注释。

Type declaration

    • (index: number): Promise<void>

    • Parameters

      • index: number

        要移除的注释的从零开始的索引。

      Returns Promise<void>

removeAll

removeAll: () => Promise<void>

移除所有注解。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

replace

replace: (index: number, annot: AnnotType) => Promise<void>

将指定位置替换为新的注解。

Type declaration

    • (index: number, annot: AnnotType): Promise<void>

    • Parameters

      • index: number

        注解列表中的从零开始的索引。

      • annot: AnnotType

        新的注解。

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties