1. 编辑器 API
石墨文档中台-开发文档
  • 1. 适用范围
  • 00. 概述
    • 石墨文档中台能做什么?
    • 三种典型的业务接入场景
    • 石墨文档中台支持哪些格式?
  • 01. 快速开始
    • 基本概念
    • 场景一:10 分钟创建预览文件
    • 场景二:10 分钟创建协同编辑文件
  • 02. 鉴权与安全
    • 整体概述
    • 签名凭证 Token
    • 签名凭证 Signature
  • 03. 文件预览
    • 整体概述
    • 如何预热预览缓存
    • 如何防盗链
    • 常见问题处理
  • 04. 文件编辑
    • 整体概述
    • 协同文档权限设计
    • 协同文件保存与更新机制
    • 协同文件复制与删除
  • 05. 文件导入导出
    • 整体概述
    • 常见问题处理
  • 06. 石墨前端 API
    • 整体概述
    • 公共 API
      • 公共处理方法
      • 顶部栏定制 HeaderBars
    • 编辑器 API
      • 轻文档
      • 传统文档
      • 表格
      • 幻灯片
      • 表单
      • 应用表格
  • 07. 石墨后端 API
    • 整体概述
    • 错误码说明
    • 文件-预览 API
      • 访问预览文件
      • 创建文件预览缓存
    • 文件-协同编辑文件管理 API
      • 访问协同编辑文件
      • 创建协同文件
      • 创建协同文件副本
      • 删除协同文件
    • 文件-导入导出 API
      • 文件导入
        • 文件导入说明
        • 创建导入任务
        • 获取导入进度
        • 创建导入任务(旧版)
        • 获取导入进度(旧版)
      • 文件导出
        • 文件导出流程
        • 创建导出任务
        • 获取导出进度
    • 文件-表格文件(Excel) API
      • 表格接口参数说明
      • 获取表格内容
      • 获取表格中的评论数
      • 更新表格内容
      • 追加表格内容
      • 删除表格行
      • 新增表格工作表
    • 文件-文稿文件(Word) API
      • 文稿书签说明
      • 读取文稿书签内容
      • 替换文稿书签内容
    • 文件-文档文件(类 Markdown) API
      • 获取文档中的评论列表
    • 文件-应用表格文件(多维表格)API
      • 应用表格列及单元格值结构
      • 应用表格接口调用规则
      • 获取数据表列表
      • 创建数据表
      • 获取字段列表
      • 创建字段
      • 更新字段
      • 删除字段
      • 新增行
      • 获取单行
      • 更新行
      • 删除行
    • 文件-获取额外信息 API
      • 获取文件的纯文本内容
      • 文件纯文本字数统计
      • 获取文件的历史列表
      • 获取文件的版本列表
      • 获取文件内容中所有的 @ 人信息列表
      • 还原文件历史版本
    • 系统管理 API
      • 应用管理
        • 获取应用详情
        • 更新应用回调地址
      • 用户席位管理
        • 用户席位状态说明
        • 获取用户列表和席位状态
        • 激活用户席位​
        • 取消用户席位​
        • 批量设置用户席位
    • 其他 API
      • 上报事件
      • 创建行为历史
      • 推送文件内全部的用户
      • 推送用户全部的 websocket 连接
    • 获取行列表
  • 08. 回调接口(你的应用需实现的接口)
    • 整体概述
    • 文件信息
      • 文件权限说明
      • [重要] 获取文件元信息-协同文档
      • [重要] 获取文件元信息-预览文档
      • 获取当前用户的文件列表
      • 获取文件的协作者列表
      • 获取接入方指定文件的完整访问地址
      • 获取文件元信息-协同文档自动任务(admin)
      • 根据指定用户获取文件元信息-协同文档(admin)
    • 用户信息
      • 批量获取用户信息(admin)
      • [重要] 获取当前用户信息
      • 获取当前用户所在团队信息
      • 获取指定用户信息
      • 获取用户水印信息
      • 获取用户部门路径
      • 批量获取用户信息
    • 团队和部门
      • 特殊部门 ID 说明
      • 获取团队下的成员列表
      • 获取部门信息
      • 获取部门的下级部门节点
      • 获取部门下的成员分页列表
    • 搜索功能
      • 获取与文件相关的用户列表
      • 获取与文件相关的文件列表
      • 按关键字搜索文件和用户列表
    • 事件推送
      • 整体概述
      • 评论(Comment)
        • 轻文档
          • 添加评论
          • 删除评论
          • 结束评论
          • 对于评论的回复评论
        • 表格
          • 添加评论
          • 删除评论
          • 结束评论
          • 对于评论的回复评论
        • 传统文档
          • 对于评论的回复评论
          • 添加评论
          • 更新评论
          • 删除评论
        • 幻灯片
          • 添加评论
          • 删除评论
          • 结束评论
          • 对于评论的回复评论
        • 应用表格
          • 添加评论
          • 对于评论的回复评论
          • 删除评论
      • 讨论(Discussion)
        • 轻文档
          • 发送讨论消息
      • 提及(MentionAt @ 人)
        • 轻文档
          • 在评论中 at
          • 在讨论中 at
          • 在正文中 at
        • 表格
          • 在评论中 at
          • 在正文中 at
        • 传统文档
          • 在评论中 at
          • 在正文中 at
        • 应用表格
          • 在评论中 at
          • 在正文中 at
      • 日期提醒 (DateMention)
        • 轻文档
          • 创建
          • 修改
          • 删除
        • 表格
          • 创建
          • 修改
          • 删除
        • 传统文档
          • 创建
          • 修改
          • 删除
      • 文件内容更新 (FileContent)
        • 文件内容更新
      • 文档协作者协同状态变化 (Collaborator)
        • 文档协作者协同状态变化
      • 文件版本 (Revision)
        • 版本
      • 系统事件 (System)
        • 系统事件
      • 回调请求错误(实验性)
        • 回调请求错误
  • 09. 核心模型
    • 你的应用如何设计应用(app)模型?
    • 你的应用如何设计文件数据模型?
    • 你的应用如何设计通讯录模型?
    • 你的应用系统如何设计文件权限模型?
  • 10. 典型场景方案
    • 云盘场景
    • IM 场景
    • 示例代码仓库
  • 11. 常见问题
    • 访问接口提示 Signature
    • 文件预览或导入报错
    • 首次接入 SDK 报错
    • 文档预览如何做防盗链
    • 复制粘贴、全屏操作不正常
    • 如何实现文档模板功能
    • 文档内容何时保存
    • 移动端不支持 blob 协议导致预览失败
    • 如何实现文件重命名
    • 如何通过接口修改文档内容
    • @人员时如何直接跳转至对应锚点
  1. 编辑器 API

表格

API#

方法#

方法列表#

方法说明
sdk.history.show显示历史(PC only,co-1.8+)
sdk.history.hide隐藏历史(PC only,co-1.8+)
sdk.comments.show显示评论(PC only,co-1.8+)
sdk.comments.hide隐藏评论(PC only,co-1.8+)
sdk.locks锁定能力(PC only,co-1.8+)
sdk.mention.locateCellByGuid按通知定位单元格(PC only,co-1.8+)
sdk.content.setContent设置内容(PC only,co-1.8+)
sdk.version.createRevision创建版本(PC only,co-1.8+)
sdk.presentation演示模式能力(PC only,co-1.8+)
sdk.workbook工作簿能力(PC only,co-1.8+)
sdk.activeSheet当前工作表能力(PC only,co-1.8+)
range: SheetRangeFacade工作表范围对象能力(PC only,co-1.8+)
cell: SheetCellFacade工作表单元格对象能力(PC only,co-1.8+)
sdk.charts图表能力(PC only,co-1.8+)
sdk.selections多选区能力(PC only,co-1.8+)
sdk.batchChanges批量变更(PC only,co-1.8+)
sdk.print打印(PC only,co-1.8+)
sdk.export导出(PC only,co-1.8+)
sdk.setFocus设置聚焦状态(PC only,co-1.8+)

API 调用方式#

新旧兼容#

旧方法兼容#

以下旧方法调用方式继续保留说明;如存在根级 facade,优先使用新写法。
旧方法说明推荐新写法
sdk.getEditor().showHistory()显示历史侧边栏sdk.history?.show()
sdk.getEditor().hideHistory()隐藏历史侧边栏sdk.history?.hide()
sdk.getEditor().showComments()显示评论侧边栏sdk.comments?.show()
sdk.getEditor().hideComments()隐藏评论侧边栏sdk.comments?.hide()
sdk.getEditor().showLocks()显示锁定侧边栏sdk.locks?.show()
sdk.getEditor().hideLocks()隐藏锁定侧边栏sdk.locks?.hide()
sdk.getEditor().addRangeLock(options)创建单元格锁定sdk.locks?.addRangeLock(options)
sdk.getEditor().addSheetLock(options)创建工作表锁定sdk.locks?.addSheetLock(options)
sdk.getEditor().removeRangeLocksInRanges(options)删除范围锁定sdk.locks?.removeRangeLocksInRanges(options)
sdk.getEditor().removeSheetLock(options)删除工作表锁定sdk.locks?.removeSheetLock(options)
sdk.getEditor().locateCellByGuid(guid, notificationType?)按通知定位单元格sdk.mention?.locateCellByGuid(guid, notificationType?)
sdk.getEditor().setContent(content)设置内容sdk.content?.setContent(content)
sdk.getEditor().createRevision(options?)创建版本sdk.version?.createRevision(options?)
sdk.getEditor().startDemonstration()启动演示sdk.presentation?.start(index?)
sdk.getEditor().endDemonstration()退出演示sdk.presentation?.quit()

新增 API 方法#

以下方法为本次补充的根级 API 调用方式。

sdk.history.show()#

说明#

显示表格历史侧边栏。

类型定义#


sdk.history.hide()#

说明#

隐藏表格历史侧边栏。

类型定义#


sdk.comments.show(type?)#

说明#

显示评论能力入口。

类型定义#


sdk.comments.hide(type?)#

说明#

隐藏评论能力入口。

类型定义#


sdk.locks#

说明#

表格锁定能力。

类型定义#


sdk.mention.locateCellByGuid(guid, notificationType?)#

说明#

根据通知 guid 定位到对应单元格。

类型定义#


sdk.content.setContent(content)#

说明#

设置表格内容。

类型定义#

相关类型#

Content

sdk.version.createRevision(options?)#

说明#

创建表格版本。

类型定义#


sdk.presentation#

说明#

表格演示模式能力。

类型定义#


sdk.workbook#

说明#

工作簿能力。

类型定义#

相关类型#

SheetWorksheetFacade
EditorSaveResult

示例#


sdk.activeSheet#

说明#

当前工作表能力。

类型定义#

相关类型#

SheetSelection
SheetRangeValue
SheetRangeFacade
SheetCellFacade
ClipboardPasteParams
SheetWritableCellData
SheetAppendDataAxis

range: SheetRangeFacade#

说明#

通过 const range = await sdk.activeSheet?.getRange(value) 获取 range: SheetRangeFacade,再调用其上的实例 API。

类型定义#

相关类型#

SheetRangeFacade
SheetRangeText
SheetCellValue
SheetWritableCellValue
SheetCellData
SheetWritableCellData
SheetCellRange

cell: SheetCellFacade#

说明#

通过 const cell = await sdk.activeSheet?.getCell(row, column) 或 const cell = await sdk.activeSheet?.getActiveCell() 获取 cell: SheetCellFacade,再调用其上的实例 API。

类型定义#

相关类型#

SheetCellFacade
SheetCellValue
SheetCellData
SheetWritableCellValue
SheetWritableCellData

sdk.charts#

说明#

图表能力。

类型定义#

相关类型#

AddChartFromSelectionParams
AddChartFromSelectionResult

sdk.selections#

说明#

多选区能力。

类型定义#

相关类型#

SheetRangeValue

sdk.batchChanges(callback)#

说明#

将一组表格变更放在同一个批处理中执行。

类型定义#


sdk.print#

说明#

打印表格。

类型定义#


sdk.export(type)#

说明#

导出表格。

类型定义#


sdk.setFocus(isFocus)#

说明#

设置表格聚焦状态。

类型定义#


类型定义#

Content#

EditorSaveResult#

SheetRangeFacade#

SheetWorksheetFacade#

SheetCellFacade#

SheetSelection#

SheetRangeValue#

ClipboardPasteParams#

SheetAppendDataAxis#

SheetRangeText#

SheetCellValue#

SheetWritableCellValue#

SheetCellRange#

SheetCellData#

SheetWritableCellMeta#

SheetWritableCellData#

AddChartFromSelectionParams#

AddChartFromSelectionResult#


修改于 2026-06-22 02:43:30
上一页
传统文档
下一页
幻灯片
Built with