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 调用方式

新旧兼容

旧方法兼容

以下旧方法调用方式继续保留说明；如存在根级 facade，优先使用新写法。

旧方法	说明	推荐新写法
`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 方法

以下方法为本次补充的根级 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。

类型定义

示例

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。

类型定义

cell: DocsTableCellFacade

说明

通过 const cell = await table?.getCell(row, column) 获取 cell: DocsTableCellFacade，再调用其上的实例 API。

类型定义

range: DocsTableRangeFacade

说明

通过 const range = await table?.getRange(selection) 获取 range: DocsTableRangeFacade，再调用其上的实例 API。

轻文档

API#

方法#

方法列表#

API 调用方式#

新旧兼容#

旧方法兼容#

新增 API 方法#

sdk.title.addChangedListener(listener)#

说明#

类型定义#

参数#

返回值#

sdk.title.setTitle(title)#

说明#

类型定义#

参数#

sdk.history.show()#

说明#

类型定义#

sdk.history.hide()#

说明#

类型定义#

sdk.comments.show(type?)#

说明#

类型定义#

参数#

sdk.comments.hide(type?)#

说明#

类型定义#

参数#

sdk.discussion.show()#

说明#

类型定义#

sdk.discussion.hide()#

说明#

类型定义#

sdk.version#

说明#

类型定义#

相关类型#

sdk.presentation.start(index?)#

说明#

类型定义#

参数#

sdk.presentation.quit()#

说明#

类型定义#

sdk.selection#

说明#

类型定义#

相关类型#

示例#

range: DocsRangeFacade#

说明#

类型定义#

相关类型#

示例#

sdk.search#

说明#

类型定义#

相关类型#

sdk.outline#

说明#

类型定义#

相关类型#

sdk.sidebar#

说明#

类型定义#

相关类型#

sdk.collaborator.show()#

说明#

类型定义#

sdk.collaborator.hide()#

说明#

类型定义#

sdk.externalApp.insert(url, params?)#

说明#

类型定义#

参数#

API

方法

方法列表

API 调用方式

新旧兼容

旧方法兼容

新增 API 方法

sdk.title.addChangedListener(listener)

说明

类型定义

参数

返回值

sdk.title.setTitle(title)

说明

类型定义

参数

sdk.history.show()

说明

类型定义

sdk.history.hide()

说明

类型定义

sdk.comments.show(type?)

说明

类型定义

参数

sdk.comments.hide(type?)

说明

类型定义

参数

sdk.discussion.show()

说明

类型定义

sdk.discussion.hide()

说明

类型定义

sdk.version

说明

类型定义

相关类型

sdk.presentation.start(index?)

说明

类型定义

参数

sdk.presentation.quit()

说明

类型定义

sdk.selection

说明

类型定义

相关类型

示例

range: DocsRangeFacade

说明

类型定义

相关类型

示例

sdk.search

说明

类型定义

相关类型

sdk.outline

说明

类型定义

相关类型

sdk.sidebar

说明

类型定义

相关类型

sdk.collaborator.show()

说明

类型定义

sdk.collaborator.hide()

说明

类型定义

sdk.externalApp.insert(url, params?)

说明

类型定义

参数

相关类型