1. 编辑器API
石墨文档中台(SDK)
>=CO-1.6
  • >=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#

方法#

方法列表#

方法说明
showHistory显示历史 (PC only)
hideHistory隐藏历史 (PC only)
startDemonstration开始本地演示 (PC only)
endDemonstration结束本地演示 (PC only)
createRevision创建版本 (PC only)
export导出
print打印 (PC only)

showHistory#

说明#

显示历史侧边栏,用于查看文档的历史版本。(PC only)

类型定义#

示例#


hideHistory#

说明#

隐藏历史侧边栏。(PC only)

类型定义#

示例#


startDemonstration#

说明#

开始本地演示模式,进入演示文稿的播放状态。(PC only)

类型定义#

示例#


endDemonstration#

说明#

结束本地演示模式,退出演示文稿的播放状态。(PC only)

类型定义#

示例#


createRevision#

说明#

创建文档版本,保存当前状态为一个版本快照。(PC only)
支持 { name: string } 参数

类型定义#

示例#


export#

说明#

导出演示文稿为指定格式。支持导出为图片或 PDF 格式。

类型定义#

参数#

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

示例#


print#

说明#

打印演示文稿。(PC only)

类型定义#

示例#


EventMap#

事件列表#

事件名说明载荷类型
error错误事件{ data?: any, code: number }
saveStatusChanged保存状态变化 (PC only){ status?: 'saving' | 'saved' | 'error' }

error#

说明#

当演示文稿编辑器发生错误时触发此事件。可用于捕获和处理编辑器运行过程中的各种错误。

类型定义#

参数说明#

data: 错误的详细信息,可以是任意类型的数据
code: 错误代码,用于标识错误类型

示例#

saveStatusChanged#

说明#

当演示文稿的保存状态发生变化时触发此事件。可用于监听文档的保存进度,为用户提供保存状态的反馈。(PC only)

类型定义#

参数说明#

status: 保存状态,可选值:
'saving': 正在保存
'saved': 保存成功
'error': 保存失败

示例#

修改于 2026-04-01 11:14:44
上一页
【前端】JS-API
下一页
传统文档
Built with