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

方法#

方法列表#

方法说明
showComments展示评论侧边栏（PC only）
hideComments关闭评论侧边栏（PC only）
showHistory展示历史侧边栏（PC only）
hideHistory关闭历史侧边栏（PC only）
showLocks展示锁定侧边栏（PC only）
hideLocks关闭锁定侧边栏（PC only）
createRevision创建版本（PC only）
startDemonstration进入演示模式（PC only）
endDemonstration离开演示模式（PC only）
print打印（PC only）
addRangeLock创建单元格锁定
addSheetLock创建工作表锁定
removeRangeLocksInRanges删除指定范围内的所有单元格锁定
removeSheetLock删除工作表锁定
getActiveSheetId获取当前激活 sheet 的 id
getSheetIds获取所有工作表的 id
getSheetIdByIndex根据工作表 index 获取工作表 id
getRangeValues获取工作表指定范围内的单元格的值
getCellValue获取指定单元格的值
getRowCount获取指定工作表行数量
getColumnCount获取指定工作表列数量
isSheetVisible获取指定工作表是否可见
updateRuntimeEnv更新环境变量
setContent设置文件内容（PC only）
setFocus设置聚焦状态（PC only）
exportCsv导出 csv（PC only）
search查找表格内容并高亮
locateCell定位单元格
cancelSearchHighlights取消搜索高亮
locateCellByGuid通过通知的 guid 定位单元格
setActiveSheet设置激活工作表
getSheetList获取工作表列表信息
getSelections获取当前表格选中的范围
getRangeData获取工作表指定范围内的单元格的数据
paste粘贴内容（PC only）
getViewportSize获取表格视图区域大小
export导出（PC only）

showComments#

说明#

展示评论侧边栏，用于查看和管理表格中的评论。（PC only）

类型定义#

示例#

hideComments#

说明#

关闭评论侧边栏。（PC only）

类型定义#

示例#

showHistory#

说明#

展示历史侧边栏，查看表格的历史版本。（PC only）

类型定义#

示例#

hideHistory#

说明#

关闭历史侧边栏。（PC only）

类型定义#

示例#

showLocks#

说明#

展示锁定侧边栏，查看和管理表格的锁定设置。（PC only）

类型定义#

示例#

hideLocks#

说明#

关闭锁定侧边栏。（PC only）

类型定义#

示例#

createRevision#

说明#

创建表格版本，保存当前状态为版本快照。（PC only）

类型定义#

示例#

startDemonstration#

说明#

进入演示模式，开始表格演示。（PC only）

类型定义#

示例#

endDemonstration#

说明#

离开演示模式，结束表格演示。（PC only）

类型定义#

示例#

print#

说明#

打印表格。（PC only）

类型定义#

示例#

addRangeLock#

说明#

创建单元格范围锁定，限制指定用户或部门对特定单元格的访问权限。

类型定义#

参数#

userPermissions: 用户 id 对应的权限
ranges: 单元格范围（默认当前选中区域范围）
sheetId: 工作表 id（默认当前工作表 id）
description: 对该锁定的描述
departmentPermissions: 部门 id 对应的权限
visitorPermission: 其他访问者的权限（默认为 1）

示例#

addSheetLock#

说明#

创建工作表锁定，限制对整个工作表的访问权限。

类型定义#

参数#

userPermissions: 用户 id 对应的权限
sheetId: 工作表 id（默认当前工作表 id）
description: 对该锁定的描述
departmentPermissions: 部门 id 对应的权限
visitorPermission: 其他访问者的权限（默认为 1）

示例#

removeRangeLocksInRanges#

说明#

删除指定范围内的所有单元格锁定。

类型定义#

参数#

sheetId: 工作表 id（默认当前工作表 id）
ranges: 单元格范围（默认当前选中区域范围）

示例#

removeSheetLock#

说明#

删除工作表锁定。

类型定义#

参数#

sheetId: 工作表 id（默认当前工作表 id）

示例#

getActiveSheetId#

说明#

获取当前激活工作表的 ID。

类型定义#

示例#

getSheetIds#

说明#

获取所有工作表的 ID 列表。

类型定义#

示例#

getSheetIdByIndex#

说明#

根据工作表索引获取工作表 ID。

类型定义#

参数#

index: 工作表索引（从 0 开始）

示例#

getRangeValues#

说明#

获取工作表指定范围内单元格的值。

类型定义#

参数#

sheetId: 工作表 id（默认当前工作表 id）
range: 单元格范围（默认当前选中范围）

示例#

getCellValue#

说明#

获取指定单元格的值。

类型定义#

参数#

sheetId: 工作表 id（默认当前工作表 id）
row: 行索引（从 0 开始）
column: 列索引（从 0 开始）

示例#

getRowCount#

说明#

获取指定工作表的行数量。

类型定义#

参数#

sheetId: 工作表 id（默认当前工作表 id）

示例#

getColumnCount#

说明#

获取指定工作表的列数量。

类型定义#

参数#

sheetId: 工作表 id（默认当前工作表 id）

示例#

isSheetVisible#

说明#

获取指定工作表是否可见。

类型定义#

参数#

sheetId: 工作表 id（默认当前工作表 id）

示例#

updateRuntimeEnv#

说明#

更新表格的运行时环境变量。

类型定义#

参数#

env: 要更新的环境变量对象

示例#

setContent#

说明#

设置表格文件内容，会替换当前内容。（PC only）

类型定义#

参数#

content: 要设置的文件内容，实际类型接受 string | Delta

示例#

setFocus#

说明#

设置表格的聚焦状态。（PC only）

类型定义#

参数#

isFocus: 设置表格聚焦状态（默认为 true）

示例#

exportCsv#

说明#

导出表格为 CSV 格式。（PC only）

类型定义#

示例#

search#

说明#

在表格中查找指定内容并高亮显示。

类型定义#

参数#

text: 要查找的内容
range: 查找的范围（默认当前选中的范围）

示例#

locateCell#

说明#

定位到指定的单元格。

类型定义#

参数#

row: 要定位的单元格行坐标
column: 要定位的单元格列坐标
sheetId: 要定位的工作表 id（默认当前激活工作表 id）

示例#

cancelSearchHighlights#

说明#

取消搜索高亮显示。

类型定义#

示例#

locateCellByGuid#

说明#

通过通知的 GUID 定位单元格，主要用于处理@提及等通知。

类型定义#

参数#

notificationType: 通知类型（'comment' | 'mention_at' | 'date_mention'）
guid: 锚点 GUID

示例#

setActiveSheet#

说明#

设置激活的工作表。

类型定义#

参数#

sheetId: 要激活的工作表 ID

示例#

getSheetList#

说明#

获取工作表列表信息，包含名称和 ID。

类型定义#

示例#

getSelections#

说明#

获取当前表格选中的范围。

类型定义#

示例#

getRangeData#

说明#

获取工作表指定范围内单元格的完整数据信息，包括值、格式等。

类型定义#

参数#

range: 范围（默认当前选中的范围）

示例#

paste#

说明#

将剪贴板内容粘贴到表格中。（PC only）

类型定义#

参数#

html: 从剪贴板获取的 text/html
text: 从剪贴板获取的 text/plain
base64File: 从剪贴板获取的文件（转换为 base64）
removeTrailingEmptyRows: 是否删除末尾空白行
removeTrailingEmptyCols: 是否删除末尾空白列

示例#

getViewportSize#

说明#

获取表格视图区域的大小。

类型定义#

示例#

export#

说明#

导出表格为指定格式。（PC only）

类型定义#

参数#

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

示例#

EventMap#

事件列表#

事件名说明载荷类型
error错误事件{ data?: any, code: number }
MouseMove鼠标移动事件（PC only）MouseMovePayload
VerticalScroll垂直滚动事件（PC only）MouseMovePayload
HorizontalScroll水平滚动事件（PC only）MouseMovePayload

error#

说明#

当表格编辑器发生错误时触发此事件。

类型定义#

示例#

MouseMove#

说明#

当鼠标在表格中移动时触发此事件。（PC only）

类型定义#

示例#

VerticalScroll#

说明#

当表格发生垂直滚动时触发此事件。（PC only）

类型定义#

示例#

HorizontalScroll#

说明#

当表格发生水平滚动时触发此事件。（PC only）

类型定义#

示例#

修改于 2026-04-02 03:25:19
上一页
传统文档
下一页
轻文档
Built with