Class Annot

constructor

• new Annot(options?: Options): Annot

  No longer use 'new' to create, but use create instead.

  Parameters

  • Optionaloptions: Options

  Returns Annot

  Example

  const annot = await Annot.create();
  Copy

options

destroy

• destroy(): Promise<void>

  Destroys an annotation.

  Returns Promise<void>

getAnnotDict

• getAnnotDict(): Promise<null | PDFDictionaryType>

  Get an annotation dictionary from FDF document by specific filter and index.

  Returns Promise<null | PDFDictionaryType>

  • The FDF annotation dictionary.

getAnnotList

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

  Get the "in reply to" annotation list.

  Parameters

  • page: PageType

  Returns Promise<null | AnnotListType>

  • the annotation list

getBorderStyle

• getBorderStyle(): Promise<number>

  Gets the annotation border style.

  Returns Promise<number>

  • The border style of the annotation.

getBorderWidth

• getBorderWidth(): Promise<number>

  Gets the annotation border width.

  Returns Promise<number>

  • The border width of the annotation.

getFlags

• getFlags(): Promise<number>

  Gets the annotation flags.

  Returns Promise<number>

  • The annotation flags.

getRect

• getRect(): Promise<Rect>

  Gets annotation bounding box in user space.

  Returns Promise<Rect>

  • The bounding box of the annotation.

getSubType

• getSubType(): Promise<string>

  Gets the annotation sub-type name.

  Returns Promise<string>

  • The annotation sub-type name

getType

• getType(): Promise<string>

  Gets the type of the input UI layer annotation object.

  Returns Promise<string>

  • The type of the annotation.

getWidget

• getWidget(): Promise<null | FormWidgetType>

  Gets the FRAnnot of the form widget.

  Returns Promise<null | FormWidgetType>

isSelected

• isSelected(): Promise<boolean>

  Checks whether the input UI layer annotation object is selected.

  Returns Promise<boolean>

  • TRUE If the input UI layer annotation object is selected, otherwise not.

setBorderStyle

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

  Sets the annotation border style.

  Parameters

  • style: number

    The border style to set. The valid values are: 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>

  Sets the annotation border width.

  Parameters

  • width: number

    The border width to set.

  Returns Promise<void>

  Example

  await annot.setBorderWidth(1);
  Copy

setVisible

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

  Sets the input UI layer annotation object to be visible or not.

  Parameters

  • show: boolean

    It indicates whether the annotation is visible.

  Returns Promise<void>

Staticcreate

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

  No longer use 'new' to create, but use create instead.

  Parameters

  • Optionaloptions: Options

  Returns Promise<AnnotType>

  Create an annotation instance with the specified options.

  Example

  const annot = await Annot.create();
  Copy