文稿 API

方法

方法列表

方法	说明
getComments	获取所有评论
getComment	获取单条评论
getCommentBySelection	获取一个选区已存在的评论
addComment	添加评论
replyComment	添加回复
removeComment	删除评论
removeReply	删除回复
updateComment	更新评论或回复
goToComment	跳转到评论所在位置
getSelectedText	获取选区文本
goToPage	跳转页面
goToTop	跳到文档顶部
addPageNum	添加页码
removeAllPageNums	删除所有页码
showToc	显示文档结构
hideToc	隐藏文档结构图
zoom	文档缩放
setBold	设置加粗
setItalic	设置斜体
print	打印
printAll	打印所有页面
createRevision	创建版本
showHistory	预览历史版本
hideHistory	关闭历史版本预览
updateSignature	更新签名图片
export	导出

getComments

说明

获取文档中的所有评论列表。

自 22.2.1 版本开始支持

类型定义

参数

includeChapterTitle: 是否包含对应的标题信息（默认为 false）

示例

getComment

说明

根据评论 ID 获取单条评论的详细信息。

自 22.2.1 版本开始支持

类型定义

参数

commentId: 评论 ID

includeChapterTitle: 是否包含对应的标题信息

示例

getCommentBySelection

说明

获取当前选中区域已存在的评论 ID。

自 22.2.1 版本开始支持

类型定义

返回值

返回评论 ID 字符串

示例

addComment

说明

在当前选中的文本上添加评论。

自 22.2.1 版本开始支持

类型定义

参数

text: 评论内容

示例

replyComment

说明

对指定评论添加回复。

自 22.2.1 版本开始支持

类型定义

参数

commentId: 要回复的评论 ID

text: 回复内容

示例

removeComment

说明

删除指定的评论。

自 22.2.1 版本开始支持

类型定义

参数

commentId: 要删除的评论 ID

示例

removeReply

说明

删除指定的回复。

自 22.2.1 版本开始支持

类型定义

参数

commentDataId: 要删除的回复数据 ID

示例

updateComment

说明

更新评论或回复的内容。

自 22.2.1 版本开始支持

类型定义

参数

commentDataId: 评论数据或回复数据的 ID

text: 新的评论内容

示例

goToComment

说明

跳转到指定评论所在的位置。

自 22.2.1 版本开始支持

类型定义

参数

commentId: 评论 ID

shouldScrollToComment: 是否滚动到评论所在位置（默认为 true）

shouldSelectComment: 是否需要选中评论正文（默认为 false）

示例

getSelectedText

说明

获取当前选区的文本内容。

自 22.2.1 版本开始支持

类型定义

示例

goToPage

说明

跳转到指定页面。

自 22.2.1 版本开始支持

类型定义

参数

pageNum: 页码

示例

goToTop

说明

跳转到文档顶部。

自 22.2.1 版本开始支持

类型定义

示例

addPageNum

说明

在指定位置添加页码。

自 22.2.1 版本开始支持

类型定义

参数

position: 页码的插入位置（0-正文, 1-页眉, 2-页脚）

alignment: 页码的对齐方式（0-右对齐, 1-左对齐, 2-居中对齐，默认为 1）

示例

removeAllPageNums

说明

删除文档中的所有页码。

自 22.2.1 版本开始支持

类型定义

示例

showToc

说明

显示文档结构（目录）。

自 22.2.1 版本开始支持

类型定义

参数

shouldDisableCache: 禁用文档结构图的默认缓存（默认为 true）

示例

hideToc

说明

隐藏文档结构图。

自 22.2.1 版本开始支持

类型定义

示例

zoom

说明

设置文档缩放比例。

自 22.2.1 版本开始支持

类型定义

参数

percent: 缩放百分比

示例

setBold

说明

设置选中文本的加粗样式。

自 22.2.1 版本开始支持

类型定义

参数

isBold: 是否加粗（默认为 false）

示例

setItalic

说明

设置选中文本的斜体样式。

自 22.2.1 版本开始支持

类型定义

参数

isItalic: 是否斜体

示例

print

说明

打印指定页面。

自 22.2.1 版本开始支持

类型定义

参数

pageNums: 要打印的页码列表

示例

printAll

说明

打印文档的所有页面。

自 22.2.1 版本开始支持

类型定义

示例

createRevision

说明

创建文档版本。

类型定义

参数

name: 版本名称（可选）

示例

showHistory

说明

预览历史版本。

类型定义

示例

hideHistory

说明

关闭历史版本预览。

类型定义

示例

updateSignature

说明

更新文档中的签名图片。

类型定义

参数

payload: 签名更新载荷

url: 签名图片的 data URL，传 null 则清除签名图片

id: 签名图片的唯一 ID

示例

export

说明

导出文稿为指定格式。

自 co-1.5 版本开始支持

类型定义

参数

type: 导出类型

'image': 导出为图片

'imagePdf': 导出为 PDF

示例

EventMap

事件列表

事件名	说明	载荷类型
selectionEnded	选择结束事件	`{}`
documentChanged	文档内容变更事件	`{}`
commentClicked	评论点击事件	`{ commentIds?: string[] }`
documentRecalculated	文档重新计算事件	`{}`
error	错误事件	`{ data?: any, code: number }`
MouseMove	鼠标移动事件	`MouseMovePayload`
VerticalScroll	垂直滚动事件	`MouseMovePayload`
HorizontalScroll	水平滚动事件	`MouseMovePayload`
showSignatureComponent	请求打开签名组件事件	`{ aspectRatio: number, id: string }`
saveStatusChanged	保存状态变更事件	`{ status: 'saving' \| 'saved' \| 'error' }`

selectionEnded

说明

当用户完成文本选择操作时触发。

类型定义

示例

documentChanged

说明

当文档内容发生变更时触发。

类型定义

示例

commentClicked

说明

当用户点击评论时触发。

自 22.2.1 版本开始支持

类型定义

示例

documentRecalculated

说明

当文档重新计算完成时触发。

类型定义

示例

error

说明

当编辑器发生错误时触发。

类型定义

示例

MouseMove

说明

当鼠标在文档中移动时触发。

类型定义

示例

VerticalScroll

说明

当文档发生垂直滚动时触发。

类型定义

示例

HorizontalScroll

说明

当文档发生水平滚动时触发。

类型定义

示例

showSignatureComponent

说明

当需要显示签名组件时触发此事件。

类型定义

参数说明

aspectRatio: 签名图片的宽高比

id: 签名图片的唯一 ID，用于在 updateSignature() 时指定想更新的签名组件

示例

saveStatusChanged

说明

当文档保存状态发生变更时触发。

类型定义

参数说明

status: 文档保存状态，可能的值包括 'saving'（正在保存）、'saved'（已保存）、'error'（保存出错）

文稿

文稿 API#

方法#

方法列表#

getComments#

说明#

类型定义#

参数#

示例#

getComment#

说明#

类型定义#

参数#

示例#

getCommentBySelection#

说明#

类型定义#

返回值#

示例#

addComment#

说明#

类型定义#

参数#

示例#

replyComment#

说明#

类型定义#

参数#

示例#

removeComment#

说明#

类型定义#

参数#

示例#

removeReply#

说明#

类型定义#

参数#

示例#

updateComment#

说明#

类型定义#

参数#

示例#

goToComment#

说明#

类型定义#

参数#

示例#

getSelectedText#

说明#

类型定义#

示例#

goToPage#

说明#

类型定义#

参数#

示例#

goToTop#

说明#

类型定义#

示例#

addPageNum#

说明#

类型定义#

参数#

示例#

removeAllPageNums#

说明#

类型定义#

示例#

showToc#

说明#

类型定义#

参数#

示例#

hideToc#

说明#

类型定义#

示例#

文稿 API

方法

方法列表

getComments

说明

类型定义

参数

示例

getComment

说明

类型定义

参数

示例

getCommentBySelection

说明

类型定义

返回值

示例

addComment

说明

类型定义

参数

示例

replyComment

说明

类型定义

参数

示例

removeComment

说明

类型定义

参数

示例

removeReply

说明

类型定义

参数

示例

updateComment

说明

类型定义

参数

示例

goToComment

说明

类型定义

参数

示例

getSelectedText

说明

类型定义

示例

goToPage

说明

类型定义

参数

示例

goToTop

说明

类型定义

示例

addPageNum

说明

类型定义

参数

示例

removeAllPageNums

说明

类型定义

示例

showToc

说明

类型定义

参数

示例

hideToc

说明

类型定义

示例

zoom