Interface AnnotType

interface AnnotType {
    destroy: () => Promise<void>;
    getAnnotDict: () => Promise<null | PDFDictionaryType>;
    getAnnotList: (page: PageType) => Promise<null | AnnotListType>;
    getBorderStyle: () => Promise<number>;
    getBorderWidth: () => Promise<number>;
    getFlags: () => Promise<number>;
    getRect: () => Promise<Rect>;
    getSubType: () => Promise<string>;
    getType: () => Promise<string>;
    getWidget: () => Promise<null | FormWidgetType>;
    isSelected: () => Promise<boolean>;
    options?: Options;
    setBorderStyle: (style: number) => Promise<void>;
    setBorderWidth: (width: number) => Promise<void>;
    setVisible: (show: boolean) => Promise<void>;
}

Implemented by

Properties

destroy getAnnotDict getAnnotList getBorderStyle getBorderWidth getFlags getRect getSubType getType getWidget isSelected options? setBorderStyle setBorderWidth setVisible

Properties

destroy

destroy: () => Promise<void>

销毁注释。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getAnnotDict

getAnnotDict: () => Promise<null | PDFDictionaryType>

从 FDF 文档中根据特定过滤条件和索引获取注释字典。

Type declaration

getAnnotList

getAnnotList: (page: PageType) => Promise<null | AnnotListType>

获取“回复对象”的批注列表。

Type declaration

getBorderStyle

getBorderStyle: () => Promise<number>

获取注解边框样式。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 注解的边框样式。

getBorderWidth

getBorderWidth: () => Promise<number>

获取注解边框宽度。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 注解的边框宽度。

getFlags

getFlags: () => Promise<number>

获取注释标志。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 注释标志。

getRect

getRect: () => Promise<Rect>

获取用户空间中的注释边界框。

Type declaration

    • (): Promise<Rect>

    • Returns Promise<Rect>

      • 注释的边界框。

getSubType

getSubType: () => Promise<string>

获取注释子类型名称。

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      • 注释子类型名称

getType

getType: () => Promise<string>

获取输入 UI 层注解对象的类型。

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      • 注解的类型。

getWidget

getWidget: () => Promise<null | FormWidgetType>

获取表单控件的注释对象。

Type declaration

isSelected

isSelected: () => Promise<boolean>

检查输入的 UI 图层注释对象是否被选中。

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

      • 如果输入的 UI 图层注释对象被选中则为 TRUE，否则为 FALSE。

Optionaloptions

options?: Options

setBorderStyle

setBorderStyle: (style: number) => Promise<void>

设置批注边框样式。

Type declaration

Example

await annot.setBorderStyle(0);

setBorderWidth

setBorderWidth: (width: number) => Promise<void>

设置注释边框宽度。

Type declaration

    • (width: number): Promise<void>

    • Parameters

      • width: number

        要设置的边框宽度。

      Returns Promise<void>

Example

await annot.setBorderWidth(1);

setVisible

setVisible: (show: boolean) => Promise<void>

设置输入 UI 图层注释对象是否可见。

Type declaration

    • (show: boolean): Promise<void>

    • Parameters

      • show: boolean

        指示该注释是否可见。

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties