Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BookMark

Index

Accessors

children

  • brief

    An array of Bookmark objects that are the children of this bookmark in the bookmark tree

    see

    BookMark

    Returns Promise<BookMark[]>

    • BookMark

color

  • get color(): Promise<string>
  • brief

    The color of the bookmark text. text: #FFFFFF.

    see

    BookMark

    Returns Promise<string>

destination

parent

  • brief

    The parent bookmark of the bookmark or null if the bookmark is the root bookmark

    see

    BookMark

    Returns Promise<BookMark>

title

  • get title(): Promise<string>
  • brief

    The text string for the bookmark that the user sees in the navigational panel.

    see

    BookMark

    Returns Promise<string>

Methods

createChild

  • Creates a new child bookmark at the specified location.

    see

    BookMark

    see

    Destionation

    Parameters

    • title: string

      The name of the bookmark that the user sees in the navigation panel.

    • destionation: Destionation

      page position to jump to after clicking

    • index: number

      (optional) The 0-based index into the children array of the bookmark at which to create the new child. The default is 0.

    Returns Promise<null | BookMark>

insertChild

  • insertChild(bookMark: BookMark, index: number): Promise<undefined | null | BookMark>
  • Inserts the specified bookmark as a child of this bookmark.

    see

    BookMark

    Parameters

    • bookMark: BookMark

      A bookmark object to add as the child of this bookmark

    • index: number

      0-based index into the children array of the bookmark at which to

    Returns Promise<undefined | null | BookMark>

    void

remove

  • remove(): Promise<boolean>
  • Removes the bookmark and all its children from the bookmark tree

    see

    BookMark

    Returns Promise<boolean>

setProperty

  • Set specity bookmark properties. t Will trigger Event Events.bookmarkUpdated.

    see

    BookMark

    see

    Property

    see

    FontStyle

    Parameters

    • data: Property

      the properties.
      the data format: {title:string, color: *, style: number}
      Supported color format:
      number, such as 0xff0000, 16711680
      PDF color array, such as ['RGB',1,1,1] which means white.
      HTML color format, such as '#ff0000', 'rgb(255,0,0)', 'rgba(255,0,0,1)'.

    Returns Promise<null | BookMark>