工具类函数

工具类函数包含一系列与编辑弱相关的函数，包括生成 objectId、获取所有图片、获取预览文本、根据 objectId 删除元素等。

工具类函数仍然是以实例方法的形式作为编辑器类 Editor 的成员，所以你需要通过编辑器对象进行调用。

genObjectId

• 说明

根据文件名和和文件类型（用途）生成 objectId，objectId 用于 对象存储。

• 定义

// aka getObjectId
genObjectId(
  fileName: string,
  type: 'image' | 'attachment' | 'audio'
): string

• 参数

  • fileName: 文件名，包含后缀。
  • type: 文件类型，参考：存储目录。

• 返回

objectId 字符串，形如 "image/${uuid}.jpg"。

getAllImages

• 说明

获取编辑器内容中所有的图片，以 objectId 的形式返回。

可用于图片预览、批量下载等功能。

• 定义

// aka getImageObectIds
getAllImages(): string[]

• 参数

无。

• 返回

objectId 数组。

getPreviewText

• 说明

获取用于文档内容预览的文字。当前的实现逻辑是获取内容开头指定长度的纯文本。

• 定义

getPreviewText(length: number = 200): string

• 参数

  • length: 文本长度
    • > 0: 从文档开头指定的长度。
    • -1: 整篇文档的长度。

• 返回

文档内容对应参数长度的纯文本。

deleteByObjectId

• 说明

通过 objectId 删除文档中的文件元素，包括图片、附件和音频。

• 定义

deleteByObjectId(objectId: string): Delta

• 参数

  • objectId: 文件元素的 ID。

• 返回

删除产生的变更 Delta 数据。