Class BookmarkPanel

constructor

• new BookmarkPanel(options?: Options): BookmarkPanel

  创建一个 BookmarkPanel 实例。

  Parameters

  • Optionaloptions: Options

    用于创建 BookmarkPanel 实例的选项。使用 create 来创建实例。

  Returns BookmarkPanel

  使用指定的选项创建一个 BookmarkPanel 实例

  Example

  const bookmarkPanel = await BookmarkPanel.create();
  Copy

options

addBookmark

• addBookmark(doc: DocType, title: string): Promise<null | BookmarkType>

  添加书签节点。

  Parameters

  • doc: DocType

    文档。
  • title: string

    书签的标题。

  Returns Promise<null | BookmarkType>

  • 书签节点。

deleteBookmark

• deleteBookmark(doc: DocType, bookmark: BookmarkType): Promise<boolean>

  删除书签节点。

  Parameters

  • doc: DocType

    文档。
  • bookmark: BookmarkType

    书签节点。

  Returns Promise<boolean>

  • 操作是否成功。

insertBookmark

• insertBookmark(
      doc: DocType,
      title: string,
      left: null | BookmarkType,
      parent: null | BookmarkType,
  ): Promise<null | BookmarkType>

  插入一个书签节点。left 和 parent 参数是可选的。

  • 如果 left 为空且父节点不为空，则书签将被插入到父节点的第一个子节点中。
  • 如果 parent 为空且 left 不为空，则书签将被插入到 left 节点之前。
  • 如果 left 和 parent 都为空，则书签将被插入到根节点下的第一个子节点中。
  • 如果 left 和 parent 都不为空，则以 left 为最高优先级，parent 无效，书签将被插入到 left 节点之前。

  Parameters

  • doc: DocType

    文档。
  • title: string

    书签标题。
  • left: null | BookmarkType

    左侧书签节点。
  • parent: null | BookmarkType

    父级书签节点。

  Returns Promise<null | BookmarkType>

  • 书签节点。

moveBookmark

• moveBookmark(
      doc: DocType,
      node: BookmarkType,
      left: null | BookmarkType,
      parent: null | BookmarkType,
  ): Promise<boolean>

  移动书签节点。

  • 如果 left 为空且父节点不为空，书签将移动到父节点的第一个子节点。
  • 如果 parent 为空且 left 不为空，书签将移动到 left 节点之前。
  • 如果 left 和 parent 都为空，书签将移动到根节点下的第一个子节点。
  • 如果 left 和 parent 都不为空，则以 left 为最高优先级，parent 无效，书签将移动到 left 节点之前。

  Parameters

  • doc: DocType

    文档。
  • node: BookmarkType

    书签节点。
  • left: null | BookmarkType

    左侧书签节点。
  • parent: null | BookmarkType

    父级书签节点。

  Returns Promise<boolean>

  • 操作是否成功。

Staticcreate

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

  创建一个 BookmarkPanel 实例。 不要通过 new 模式创建实例，请使用 create 来创建实例。

  Parameters

  • Optionaloptions: Options

    用于创建 BookmarkPanel 实例的配置项。

  Returns Promise<BookmarkPanel>

  使用指定配置项创建的 BookmarkPanel 实例

  Example

   const bookmarkPanel = await BookmarkPanel.create();
  Copy