Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileAttachment

Hierarchy

Index

Methods

Methods

destroy

  • destroy(): Promise<boolean>

  • Delete the annot of the page

    see

    Annot

    Returns Promise<boolean>

    bool is true of false

getAnnot

getIconName

  • getIconName(): Promise<string>

  • Get annotation's icon name which decide how annotation to display.

    Returns Promise<string>

    string

getProps

  • Export the current annotation to a Json object.

    see

    Annot

    Returns Promise<AnnotOptions>

    • A json object of annotation's property. The key and value formats try to follow XFDF specifications

setIconName

  • setIconName(iconName: string): Promise<boolean>

  • Set annotation's icon name which decide how annotation to display.

    Parameters

    • iconName: string

      Icon name string.
      Graph Graph icon.
      PushPin Push pin icon.
      Paperclip Paperclip icon.
      Tag Tag icon.

    Returns Promise<boolean>

    boolean

setProps

  • Set the properties of annot

    see

    Annot

    Parameters

    Returns Promise<void>

    underfined