这是注释器 API。

概述

方法

名称概述定义者

annotate()

使用数据在当前选区应用注释

Annotator

annotationChanged()

当当前选区与注释匹配或不匹配时执行指定的回调函数。

Annotator

getAll()

检索给定名称的所有注释

Annotator

register()

按名称注册特定的注释器

Annotator

remove()

从当前选区中删除与名称匹配的所有注释

Annotator

removeAll()

从整个文档中删除所有与指定名称匹配的注释。

Annotator

方法

annotate()

annotate(name: String, data: Object)

使用数据在当前选区应用注释

参数

  • name (String) - 要应用的注释的名称

  • data (Object) - 传递给此特定注释的信息


annotationChanged()

annotationChanged(name: String, callback: Function)

当当前选区与注释匹配或不匹配时执行指定的回调函数。

参数

  • name (String) - 要监听的注释的名称

  • callback (Function) - 当光标处的注释发生变化时触发的回调函数,参数为 (state, name 和 data)。如果 state 为 false,则不会提供 data。


getAll()

getAll(name: String): Object

检索给定名称的所有注释

参数

  • name (String) - 要检索的注释的名称

返回值

  • Object - 注释的索引,从 uid 指向 DOM 节点


register()

register(name: String, settings: Object)

按名称注册特定的注释器

参数

  • name (String) - 注释的名称

  • settings (Object) - 注释的设置(例如 decorate)


remove()

remove(name: String)

从当前选区中删除与名称匹配的所有注释

参数

  • name (String) - 要删除的注释的名称


removeAll()

removeAll(name: String)

从整个文档中删除所有与指定名称匹配的注释。

参数

  • name (String) - 要删除的注释的名称