1. 编辑器API
石墨文档中台(SDK)
CO-1.4
  • >=CO-1.6
  • CO-1.5
  • CO-1.4
  • CO-1.2-1.3
  • <CO-1.2
  • 一文认识石墨文档中台
  • 文档中台支持的格式
  • 10 分钟创建协同文档
  • 10分钟创建预览文档
  • 示例代码仓库
  • 更新日志
  • 典型场景案例
    • 云盘场景
    • IM场景
  • 接口文档
    • 接口文档概览
    • 错误码说明
    • 石墨后端API
      • 请求签名凭证
        • 签名凭证类型
        • 签名凭证-Signature
        • 签名凭证-Token
      • 系统管理
        • 应用管理
          • 获取应用详情
          • 更新应用回调地址
        • 用户席位管理
          • 用户席位状态说明
          • 获取用户列表和席位状态
          • 激活用户席位​
          • 取消用户席位​
          • 批量设置用户席位
      • 协同文档创建删除
        • 访问协同文档
        • 创建协同文档
        • 创建协同文档副本
        • 删除协同文档
      • 预览文件
        • 访问预览文件
        • 创建文件预览缓存
      • 文档导入导出
        • 文档导入
          • 文档导入说明
          • 创建导入任务
          • 获取导入进度
          • 创建导入任务（旧版）
          • 获取导入进度（旧版）
        • 文档导出
          • 文档导出流程
          • 创建导出任务
          • 获取导出进度
      • 文档操作
        • 专业表格（Excel）
          • 专业表格接口参数说明
          • 获取表格内容
          • 获取表格中的评论数
          • 更新表格内容
          • 追加表格内容
          • 删除表格行
          • 新增表格工作表
        • 轻文档（Markdown）
          • 获取文档中的评论列表
        • 通用
          • 获取文件纯文本内容
          • 文件纯文本字数统计
          • 获取历史列表
          • 获取版本列表
          • 获取文档内容中所有的at人信息列表
        • 传统文档（Word）
          • 传统文档书签说明
          • 读取传统文档书签内容
          • 替换传统文档书签内容
    • 石墨前端API
      • 【前端】JS-API
      • 编辑器API
        • 表单
        • 应用表格
        • 表格
        • 轻文档
        • 幻灯片
        • 传统文档
    • 回调接口（接入方需实现）
      • 【后端】回调接口说明
      • 【后端】回调总览
      • 文件信息
        • 获取文件元信息-协同文档
        • 获取文件元信息-预览文档
        • 获取当前用户的文件列表
        • 获取文件的协作者列表
        • 获取接入方指定文件的完整访问地址
        • 获取文件元信息-协同文档自动任务(admin)
        • 根据指定用户获取文件元信息-协同文档(admin)
      • 用户信息
        • 批量获取用户信息(admin)
        • 获取当前用户信息
        • 获取当前用户所在团队信息
        • 获取指定用户信息
        • 获取用户水印信息
        • 获取用户部门路径
        • 批量获取用户信息
      • 团队和部门
        • 获取团队下的成员列表
        • 获取部门信息
        • 获取部门的下级部门节点
        • 获取部门下的成员分页列表
      • 搜索功能
        • 获取与文件相关的用户列表
        • 获取与文件相关的文件列表
        • 按关键字搜索文件和用户列表
      • 消息推送
        • 评论（Comment）
          • 轻文档
            • 添加评论
            • 删除评论
            • 结束评论
            • 对于评论的回复评论
          • 表格
            • 添加评论
            • 删除评论
            • 结束评论
            • 对于评论的回复评论
          • 传统文档
            • 添加评论
            • 更新评论
            • 删除评论
            • 对于评论的回复评论
          • 幻灯片
            • 添加评论
            • 删除评论
            • 结束评论
            • 对于评论的回复评论
          • 应用表格
            • 添加评论
            • 对于评论的回复评论
            • 删除评论
        • 讨论（Discussion）
          • 轻文档
            • 发送讨论消息
        • 提及（MentionAt @ 人）
          • 轻文档
            • 在评论中 at
            • 在讨论中 at
            • 在正文中 at
          • 表格
            • 在评论中 at
            • 在正文中 at
          • 传统文档
            • 在评论中 at
            • 在正文中 at
          • 应用表格
            • 在评论中 at
            • 在正文中 at
        • 日期提醒 (DateMention)
          • 轻文档
            • 创建
            • 修改
            • 删除
          • 表格
            • 创建
            • 修改
            • 删除
          • 传统文档
            • 创建
            • 修改
            • 删除
        • 文件内容更新 (FileContent)
          • 文件内容更新
        • 文档协作者协同状态变化 (Collaborator)
          • 文档协作者协同状态变化
        • 版本 (Revision)
          • 版本
        • 系统事件 (System)
          • 系统事件
        • (实验性) 回调请求错误
          • 回调请求错误
  • 常见问题
    • 复制粘贴、全屏操作不正常
    • 如何实现文档模板功能
    • 文档内容何时保存
    • 移动端不支持blob协议导致预览失败
    • 如何实现文件重命名
    • @人员时如何直接跳转至对应锚点
    • 访问接口提示 signature 无效怎么办
    • 文件预览或导入报错如何处理
    • 首次接入 SDK 报错 应该排查哪些接口
    • 文档预览如何做防盗链
    • 如何通过接口修改文档内容
  1. 编辑器API

传统文档

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#

说明#

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

类型定义#

参数#

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

示例#

getComment#

说明#

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

类型定义#

参数#

commentId: 评论 ID
includeChapterTitle: 是否包含对应的标题信息

示例#

getCommentBySelection#

说明#

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

类型定义#

返回值#

返回评论 ID 字符串

示例#

addComment#

说明#

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

类型定义#

参数#

text: 评论内容

示例#

replyComment#

说明#

对指定评论添加回复。

类型定义#

参数#

commentId: 要回复的评论 ID
text: 回复内容

示例#

removeComment#

说明#

删除指定的评论。

类型定义#

参数#

commentId: 要删除的评论 ID

示例#

removeReply#

说明#

删除指定的回复。

类型定义#

参数#

commentDataId: 要删除的回复数据 ID

示例#

updateComment#

说明#

更新评论或回复的内容。

类型定义#

参数#

commentDataId: 评论数据或回复数据的 ID
text: 新的评论内容

示例#

goToComment#

说明#

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

类型定义#

参数#

commentId: 评论 ID
shouldScrollToComment: 是否滚动到评论所在位置（默认为 true）
shouldSelectComment: 是否需要选中评论正文（默认为 false）

示例#

getSelectedText#

说明#

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

类型定义#

示例#

goToPage#

说明#

跳转到指定页面。

类型定义#

参数#

pageNum: 页码

示例#

goToTop#

说明#

跳转到文档顶部。

类型定义#

示例#

addPageNum#

说明#

在指定位置添加页码。

类型定义#

参数#

position: 页码的插入位置（0-正文, 1-页眉, 2-页脚）
alignment: 页码的对齐方式（0-右对齐, 1-左对齐, 2-居中对齐，默认为 1）

示例#

removeAllPageNums#

说明#

删除文档中的所有页码。

类型定义#

示例#

showToc#

说明#

显示文档结构（目录）。

类型定义#

参数#

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

示例#

hideToc#

说明#

隐藏文档结构图。

类型定义#

示例#

zoom#

说明#

设置文档缩放比例。

类型定义#

参数#

percent: 缩放百分比

示例#

setBold#

说明#

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

类型定义#

参数#

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

示例#

setItalic#

说明#

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

类型定义#

参数#

isItalic: 是否斜体

示例#

print#

说明#

打印指定页面。

类型定义#

参数#

pageNums: 要打印的页码列表

示例#

printAll#

说明#

打印文档的所有页面。

类型定义#

示例#

createRevision#

说明#

创建文档版本。

类型定义#

参数#

name: 版本名称（可选）

示例#

showHistory#

说明#

预览历史版本。

类型定义#

示例#

hideHistory#

说明#

关闭历史版本预览。

类型定义#

示例#

updateSignature#

说明#

更新文档中的签名图片。

类型定义#

参数#

payload: 签名更新载荷
url: 签名图片的 data URL，传 null 则清除签名图片
id: 签名图片的唯一 ID

示例#

export#

说明#

导出传统文档为指定格式。

类型定义#

参数#

type: 导出类型
'image': 导出为图片
'imagePdf': 导出为 PDF

示例#

EventMap#

事件列表#

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

selectionEnded#

说明#

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

类型定义#

示例#

documentChanged#

说明#

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

类型定义#

示例#

commentClicked#

说明#

当用户点击评论时触发。

类型定义#

示例#

documentRecalculated#

说明#

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

类型定义#

示例#

error#

说明#

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

类型定义#

示例#

MouseMove#

说明#

当鼠标在文档中移动时触发。（PC only）

类型定义#

示例#

VerticalScroll#

说明#

当文档发生垂直滚动时触发。（PC only）

类型定义#

示例#

HorizontalScroll#

说明#

当文档发生水平滚动时触发。（PC only）

类型定义#

示例#

showSignatureComponent#

说明#

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

类型定义#

参数说明#

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

示例#

saveStatusChanged#

说明#

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

类型定义#

参数说明#

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

示例#

修改于 2026-04-02 03:44:48
上一页
幻灯片
下一页
【后端】回调接口说明
Built with