本文档由 石墨办公 提供。
文档
文档 API
方法
方法列表
| 方法 | 说明 |
|---|---|
| sdk.title.addChangedListener | 监听标题变化（PC only，co-1.8+） |
| sdk.title.setTitle | 设置标题（PC only，co-1.8+） |
| 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.discussion.show | 显示讨论（PC only，co-1.8+） |
| sdk.discussion.hide | 隐藏讨论（PC only，co-1.8+） |
| sdk.version | 版本能力（PC only，co-1.8+） |
| sdk.presentation.start | 启动演示（PC only，co-1.8+） |
| sdk.selection | 选区能力（PC only，co-1.8+） |
| range: DocsRangeFacade | 选区范围对象能力（PC only，co-1.8+） |
| sdk.search | 搜索与替换（PC only，co-1.8+） |
| sdk.outline | 目录能力（PC only，co-1.8+） |
| sdk.sidebar | 侧边栏能力（PC only，co-1.8+） |
| sdk.collaborator.show | 显示编写者信息（PC only，co-1.8+） |
| sdk.collaborator.hide | 隐藏编写者信息（PC only，co-1.8+） |
| sdk.externalApp.insert | 插入第三方应用（PC only，co-1.8+） |
| sdk.tables | 表格集合能力（PC only，co-1.8+） |
| table: DocsTableFacade | 单个表格对象能力（PC only，co-1.8+） |
| cell: DocsTableCellFacade | 表格单元格对象能力（PC only，co-1.8+） |
| range: DocsTableRangeFacade | 表格范围对象能力（PC only，co-1.8+） |
| sdk.settings | 文档设置能力（PC only，co-1.8+） |
| sdk.batchChanges | 批量变更（PC only，co-1.8+） |
| sdk.print | 打印（PC only，co-1.8+） |
API 调用方式
新旧兼容
旧方法兼容
| 旧方法 | 说明 | 推荐新写法 |
|---|---|---|
sdk.getEditor().setTitle(title) | 设置文档标题 | sdk.title?.setTitle(title) |
sdk.getEditor().showComments() | 显示评论侧边栏 | sdk.comments?.show() |
sdk.getEditor().hideComments() | 隐藏评论侧边栏 | sdk.comments?.hide() |
sdk.getEditor().startDemonstration() | 启动演示 | sdk.presentation?.start(index?) |
sdk.getEditor().showHistory() | 显示历史侧边栏 | sdk.history?.show() |
sdk.getEditor().hideHistory() | 隐藏历史侧边栏 | sdk.history?.hide() |
sdk.getEditor().showRevision() | 显示版本侧边栏 | sdk.version?.show?.() |
sdk.getEditor().hideRevision() | 隐藏版本侧边栏 | sdk.version?.hide?.() |
sdk.getEditor().showDiscussion() | 显示讨论侧边栏 | sdk.discussion?.show() |
sdk.getEditor().hideDiscussion() | 隐藏讨论侧边栏 | sdk.discussion?.hide() |
sdk.getEditor().showToc() | 显示目录 | sdk.outline?.show() |
sdk.getEditor().hideToc() | 隐藏目录 | sdk.outline?.hide() |
sdk.getEditor().createRevision(options?) | 创建版本 | sdk.version?.createRevision(options?) |
sdk.getEditor().endDemonstration() | 退出演示 | sdk.presentation?.quit() |
sdk.getEditor().print() | 打印 | sdk.print?.() |
sdk.getEditor().showCollaborator() | 显示编写者信息 | sdk.collaborator?.show() |
sdk.getEditor().hideCollaborator() | 隐藏编写者信息 | sdk.collaborator?.hide() |
sdk.getEditor().insertExternalApp(url, params?) | 插入第三方应用 | sdk.externalApp?.insert(url, params?) |
新增 API 方法
sdk.title.addChangedListener(listener)
说明
类型定义
参数
listener: 标题变化时触发的回调函数返回值
() => void：取消监听函数sdk.title.setTitle(title)
说明
类型定义
参数
title: 要设置的新标题sdk.history.show()
说明
类型定义
sdk.history.hide()
说明
类型定义
sdk.comments.show(type?)
说明
类型定义
参数
type: 可选的评论展示类型sdk.comments.hide(type?)
说明
类型定义
参数
type: 可选的评论展示类型sdk.discussion.show()
说明
类型定义
sdk.discussion.hide()
说明
类型定义
sdk.version
说明
类型定义
相关类型
sdk.presentation.start(index?)
说明
类型定义
参数
index: 可选的起始位置参数sdk.presentation.quit()
说明
类型定义
sdk.selection
说明
类型定义
相关类型
示例
range: DocsRangeFacade
说明
const range = await sdk.selection?.getRange() 或 const range = await sdk.selection?.getWholeRange() 获取 range: DocsRangeFacade，再调用其上的实例 API。API 一览表
| API | 说明 |
|---|---|
range.start: number | 起始位置 |
range.end: number | 结束位置 |
range.isCaret: boolean | 是否为光标 |
range.getText(): Promise<string> | 获取文本 |
range.getHtml(): Promise<string> | 获取 HTML |
range.setText(text: string): Promise<void> | 设置文本 |
range.setHtml(html: string): Promise<void> | 设置 HTML |
range.getBounding(): Promise<DocsRangeBounding | null> | 获取选区位置 |
range.setStyle(style: DocsTextStyle): Promise<void> | 设置文本样式 |
range.continueWriting(content: string, type: DocsContinueWritingType, abort?: () => void): Promise<boolean> | 续写内容 |
range.setListStyle(style: DocsListStyle): Promise<void> | 设置列表样式 |
range.insertLink(href: string, text: string, viewType: 'link' | 'card' | 'preview'): Promise<void> | 插入链接 |
range.insertImage(data: File | string): Promise<void> | 插入图片 |
range.insertAttachment(data: File, viewType: 'link' | 'card' | 'preview'): Promise<void> | 插入附件 |
range.setParagraphType(type: DocsParagraphType): Promise<void> | 设置段落类型 |
range.clearStyle(): Promise<void> | 清除样式 |
range.clearContent(): Promise<void> | 清除内容 |
range.clearAll(): Promise<void> | 清除全部 |
range.insertHorizontalRule(): Promise<void> | 插入分割线 |
range.insertQuote(): Promise<void> | 插入引用 |
逐条类型定义
range.start
range.end
range.isCaret
range.getText()
range.getHtml()
range.setText(text)
range.setHtml(html)
range.getBounding()
range.setStyle(style)
range.continueWriting(content, type, abort?)
range.setListStyle(style)
range.insertLink(href, text, viewType)
range.insertImage(data)
range.insertAttachment(data, viewType)
range.setParagraphType(type)
range.clearStyle()
range.clearContent()
range.clearAll()
range.insertHorizontalRule()
range.insertQuote()
相关类型
示例
sdk.search
说明
类型定义
相关类型
sdk.outline
说明
类型定义
相关类型
sdk.sidebar
说明
类型定义
相关类型
sdk.collaborator.show()
说明
类型定义
sdk.collaborator.hide()
说明
类型定义
sdk.externalApp.insert(url, params?)
说明
类型定义
参数
url: 第三方应用地址params: 可选的应用展示参数相关类型
sdk.tables
说明
类型定义
相关类型
示例
table: DocsTableFacade
说明
const table = await sdk.tables?.getOne(tableId) 或 const tables = await sdk.tables?.getAll() 获取 table: DocsTableFacade，再调用其上的实例 API。API 一览表
| API | 说明 |
|---|---|
table.tableId: string | 表格 ID |
table.insertRows(index: number, count: number, placement?: 'before' | 'after'): Promise<void> | 插入行 |
table.insertColumns(index: number, count: number, placement?: 'before' | 'after'): Promise<void> | 插入列 |
table.deleteRows(index: number, count: number): Promise<void> | 删除行 |
table.deleteColumns(index: number, count: number): Promise<void> | 删除列 |
table.setRowHeight(index: number, height: number): Promise<void> | 设置行高 |
table.setColumnWidth(index: number, width: number): Promise<void> | 设置列宽 |
table.setFullscreen(status: boolean): Promise<void> | 设置全屏 |
table.getCell(row: number, column: number): Promise<DocsTableCellFacade | null> | 获取单元格 |
table.getRange(selection: DocsTableSelection): Promise<DocsTableRangeFacade | null> | 获取范围 |
逐条类型定义
table.tableId
table.insertRows(index, count, placement?)
table.insertColumns(index, count, placement?)
table.deleteRows(index, count)
table.deleteColumns(index, count)
table.setRowHeight(index, height)
table.setColumnWidth(index, width)
table.setFullscreen(status)
table.getCell(row, column)
table.getRange(selection)
相关类型
cell: DocsTableCellFacade
说明
const cell = await table?.getCell(row, column) 获取 cell: DocsTableCellFacade，再调用其上的实例 API。API 一览表
| API | 说明 |
|---|---|
cell.tableId: string | 表格 ID |
cell.row: number | 行号 |
cell.column: number | 列号 |
cell.setFormula(formula: 'sum' | 'average', ranges: DocsTableSelection[]): Promise<void> | 设置公式 |
cell.removeFormula(): Promise<void> | 移除公式 |
cell.setStyle(style: DocsTableCellStyle): Promise<void> | 设置单元格样式 |
cell.clearStyle(): Promise<void> | 清除单元格样式 |
逐条类型定义
cell.tableId
cell.row
cell.column
cell.setFormula(formula, ranges)
cell.removeFormula()
cell.setStyle(style)
cell.clearStyle()
相关类型
range: DocsTableRangeFacade
说明
const range = await table?.getRange(selection) 获取 range: DocsTableRangeFacade，再调用其上的实例 API。API 一览表
| API | 说明 |
|---|---|
range.tableId: string | 表格 ID |
range.selection: DocsTableSelection | 范围选择 |
range.setStyle(style: DocsTableCellStyle): Promise<void> | 设置范围样式 |
range.clearStyle(): Promise<void> | 清除范围样式 |
range.setSpan(): Promise<void> | 合并单元格 |
range.removeSpan(): Promise<void> | 取消合并 |
逐条类型定义
range.tableId
range.selection
range.setStyle(style)
range.clearStyle()
range.setSpan()
range.removeSpan()
相关类型
sdk.settings
说明
类型定义
相关类型
sdk.batchChanges(callback)
说明
类型定义
示例
sdk.print
说明
类型定义
类型定义
DocumentErrorMessage
RevisionCreateOptions
ExternalAppParams
DocsRangeValue
DocsRangeFacade
DocsRangeBounding
DocsContinueWritingType
DocsTextStyle
DocsListStyle
DocsParagraphType
DocsCodeBlockInsertOptions
DocsSearchParams
DocsSearchResult
DocsReplaceParams
DocsReplaceResult
DocsTOCItem
DocsSidebarState
DocsTableFacade
DocsTableCellFacade
DocsTableRangeFacade
DocsTableSelection
DocsTableCellStyle
DocsPageWidth
DocsDefaultStyle
修改于 2026-08-13 06:27:15