Class Annot

constructor

• new Annot(options?: Options): Annot

  不再使用 'new' 来创建，而应使用 create。

  Parameters

  • Optionaloptions: Options

  Returns Annot

  Example

  const annot = await Annot.create();
  Copy

options

destroy

• destroy(): Promise<void>

  销毁注解。

  Returns Promise<void>

getAnnotDict

• getAnnotDict(): Promise<null | PDFDictionaryType>

  通过特定过滤器和索引，从 FDF 文档中获取注释字典。

  Returns Promise<null | PDFDictionaryType>

  • FDF 注释字典。

getAnnotList

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

  获取“回复”注释列表。

  Parameters

  • page: PageType

  Returns Promise<null | AnnotListType>

  • 注释列表

getBorderStyle

• getBorderStyle(): Promise<number>

  获取注解边框样式。

  Returns Promise<number>

  • 注解的边框样式。

getBorderWidth

• getBorderWidth(): Promise<number>

  获取注释边框宽度。

  Returns Promise<number>

  • 注释的边框宽度。

getFlags

• getFlags(): Promise<number>

  获取注解标志。

  Returns Promise<number>

  • 注解标志。

getRect

• getRect(): Promise<Rect>

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

  Returns Promise<Rect>

  • 注释的边界框。

getSubType

• getSubType(): Promise<string>

  获取注释的子类型名称。

  Returns Promise<string>

  • 注释子类型名称

getType

• getType(): Promise<string>

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

  Returns Promise<string>

  • 注解的类型。

getWidget

• getWidget(): Promise<null | FormWidgetType>

  获取表单控件的 FRAnnot。

  Returns Promise<null | FormWidgetType>

isSelected

• isSelected(): Promise<boolean>

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

  Returns Promise<boolean>

  • TRUE 如果输入的 UI 图层标注对象被选中，否则返回 false。

setBorderStyle

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

  设置批注边框样式。

  Parameters

  • style: number

    要设置的边框样式。有效值为：DefineConst.FRBBS_SOLID, DefineConst.FRBBS_DASH, DefineConst.FRBBS_BEVELED, DefineConst.FRBBS_INSET, DefineConst.FRBBS_UNDERLINE。

  Returns Promise<void>

  Example

  await annot.setBorderStyle(0);
  Copy

setBorderWidth

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

  设置批注边框宽度。

  Parameters

  • width: number

    要设置的边框宽度。

  Returns Promise<void>

  Example

  await annot.setBorderWidth(1);
  Copy

setVisible

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

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

  Parameters

  • show: boolean

    表示注释是否可见。

  Returns Promise<void>

Staticcreate

• create(options?: Options): Promise<AnnotType>

  不再使用 'new' 来创建，而是使用 create。

  Parameters

  • Optionaloptions: Options

  Returns Promise<AnnotType>

  使用指定的选项创建一个注释实例。

  Example

  const annot = await Annot.create();
  Copy