API参考MarginNote核心

DocumentController

单个文档的控制器,提供当前文档与选区。

管理单个打开的文档,通过 ReaderController.currentDocumentController 获取当前显示的文档控制器。

实例成员 (Instance members)

属性(只读)

属性类型说明
documentMbBook | undefined当前文档对象。
docMd5string当前文档MD5。
notebookIdstring当前笔记本ID。
focusNoteMbBookNote | undefined当前焦点笔记。
visibleFocusNoteMbBookNote | undefined当前可见的焦点笔记。
lastFocusNoteMbBookNote | undefined上一次的焦点笔记。
selectionTextstring | undefined用户在 PDF 中当前选中的文本。
currPageNonumber当前页码(默认从 1 开始)。
currPageIndexnumber当前页索引(默认从 0 开始)。
isSelectionTextboolean当前是否存在文本选区。

方法

方法参数返回值说明
imageFromSelection()—NSData从当前选区导出图片数据(若可用)。
imageFromFocusNote()—NSData从当前焦点笔记导出图片数据(若可用)。
setPageAtIndex(index)index: number—跳转到指定页索引。
indicesFromPageNo(pageNo)pageNo: numberNSArray<number>由页码得到会的页索引列表。
indexFromPageNo(pageNo)pageNo: numbernumber由页码得到页索引。
pageNoFromIndex(index)index: numbernumber由页索引得到页码。
highlightFromSelection()—MbBookNote | undefined从当前选区创建或定位高亮笔记并返回该笔记。

highlightFromSelection

highlightFromSelection(): MbBookNote | undefined

定义:

从当前文档选区创建或定位一条高亮笔记并返回。

返回:

  • 有有效选区时返回MbBookNote。
  • 无选区时返回undefined。

行为:

  • 调用前可通过selectionText与isSelectionText读取当前选区状态。
  • 调用后可直接读取返回对象的noteId确认结果。

副作用:

  • 会更新当前焦点笔记或当前笔记状态。
  • 会刷新与选区相关的界面状态。

最小验证:

  1. 读取selectionText与isSelectionText。
  2. 调用highlightFromSelection()。
  3. 检查返回对象是否存在且包含noteId。
  4. 清空选区后重复调用,确认返回undefined。

类成员 (Class members)

当前接口未额外暴露 DocumentController 的类成员。

相关

头文件API清单

正在加载...

协议:JSBDocumentController,来源:-