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.version.createRevision	创建版本（PC only，`co-1.8+`）
sdk.presentation	演示模式能力（PC only，`co-1.8+`）
sdk.slides	幻灯片集合能力（PC only，`co-1.8+`）
slide: PresentationSlideFacade	单个幻灯片对象能力（PC only，`co-1.8+`）
sdk.selection	选区能力（PC only，`co-1.8+`）
textRange: PresentationTextRangeFacade	文本范围对象能力（PC only，`co-1.8+`）
sdk.text	文本格式能力（PC only，`co-1.8+`）
sdk.zoom	缩放能力（PC only，`co-1.8+`）
sdk.eventSubscription	事件订阅能力（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+`）

API 调用方式

新旧兼容

旧方法兼容

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

旧方法	说明	推荐新写法
`sdk.getEditor().showHistory()`	显示历史侧边栏	`sdk.history?.show()`
`sdk.getEditor().hideHistory()`	隐藏历史侧边栏	`sdk.history?.hide()`
`sdk.getEditor().createRevision(options?)`	创建版本	`sdk.version?.createRevision(options?)`
`sdk.getEditor().startDemonstration()`	启动本地演示	`sdk.presentation?.start(index?)`
`sdk.getEditor().endDemonstration()`	退出本地演示	`sdk.presentation?.quit()`
`sdk.getEditor().print()`	打印	`sdk.print?.()`
`sdk.getEditor().export(type)`	导出	`sdk.export?.(type)`

新增 API 方法

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

sdk.history.show()

说明

显示演示文稿历史侧边栏。

类型定义

sdk.history.hide()

说明

隐藏演示文稿历史侧边栏。

类型定义

sdk.comments.show(type?)

说明

显示评论能力入口。

类型定义

sdk.comments.hide(type?)

说明

隐藏评论能力入口。

类型定义

sdk.version.createRevision(options?)

说明

创建演示文稿版本。

类型定义

sdk.presentation

说明

演示模式能力。

类型定义

说明补充

sdk.presentation?.startRemoteLive() 当前未在 presentation 套件承接

sdk.slides

说明

幻灯片集合能力。

类型定义

说明补充

上述 slides API 继续对外保留；其中 addSlide、duplicateSlide、deleteSlide、hideSlide 需等待底层 runtime 承接后再复测。

slide: PresentationSlideFacade

说明

通过 const slide = await sdk.slides?.getCurrentSlide()、getSlideById()、getSlides() 等方法获取 slide: PresentationSlideFacade，再调用其上的实例 API。

API 一览表

API	说明
`slide.id: string`	幻灯片 ID
`slide.getIndex(): Promise<number>`	获取页码
`slide.getShapes(): Promise<PresentationShape[]>`	获取形状列表
`slide.getTables(): Promise<PresentationTableItem[]>`	获取表格列表
`slide.insertShape(options: PresentationInsertShapeOptions): Promise<PresentationShape>`	插入形状
`slide.insertTextBox(options: PresentationTextBoxOptions): Promise<PresentationShape>`	插入文本框
`slide.insertTable(options: PresentationTableOptions): Promise<PresentationTableItem>`	插入表格
`slide.insertImage(image: File, size?: PresentationSize, offset?: PresentationOffset): Promise<void>`	插入图片
`slide.insertAudio(data: File, size?: PresentationSize, offset?: PresentationOffset, name?: string): Promise<void>`	插入音频
`slide.insertVideo(data: File, size?: PresentationSize, offset?: PresentationOffset, name?: string): Promise<void>`	插入视频
`slide.insertAttachment(file: File, size?: PresentationSize, offset?: PresentationOffset, name?: string): Promise<void>`	插入附件

逐条类型定义

slide.id

功能说明：表示当前幻灯片对象的唯一 ID。

slide.getIndex()

功能说明：获取当前幻灯片的页码位置。

slide.getShapes()

功能说明：获取当前幻灯片中的形状列表。

slide.getTables()

功能说明：获取当前幻灯片中的表格列表。

slide.insertShape(options)

功能说明：在当前幻灯片中插入一个形状。线条类型返回 PresentationShapeBase，可承载文本的形状返回 PresentationTextShape。

slide.insertTextBox(options)

功能说明：在当前幻灯片中插入一个文本框，并返回可编辑文本内容的形状对象。

slide.insertTable(options)

功能说明：在当前幻灯片中插入一个表格。

slide.insertImage(image, size?, offset?)

功能说明：在当前幻灯片中插入图片。

slide.insertAudio(data, size?, offset?, name?)

功能说明：在当前幻灯片中插入音频。

slide.insertVideo(data, size?, offset?, name?)

功能说明：在当前幻灯片中插入视频。

slide.insertAttachment(file, size?, offset?, name?)

功能说明：在当前幻灯片中插入附件。

说明补充

上述 slide API 继续对外保留；getTables 和各类插入/写入接口需等待底层 runtime 承接后再复测。

sdk.selection

说明

演示文稿选区能力。

类型定义

textRange: PresentationTextRangeFacade

说明

这里的 sdk.selection.textRange 仅用于文档章节索引，并不是可直接通过 sdk.selection.textRange 调用的模块；实际应先通过 const textRange = await sdk.selection?.getTextRange() 获取 textRange: PresentationTextRangeFacade，再调用其上的实例 API。

API 一览表

API	说明
`range.start: string`	起始位置
`range.end: string`	结束位置
`range.getText(): Promise<string>`	获取文本
`range.setText(text: string): Promise<void>`	设置文本
`range.getHtml(): Promise<string>`	获取 HTML
`range.setHtml(html: string): Promise<void>`	设置 HTML
`range.getBounding(): Promise<{ left: number; top: number; width: number; height: number } \| null>`	获取选区位置
`range.setStyle(style: PresentationTextStyle): Promise<void>`	设置文本样式
`range.setVerticalAlign(vertical: PresentationVerticalAlign): Promise<void>`	设置垂直对齐
`range.setHorizontalAlign(align: PresentationHorizontalAlign): Promise<void>`	设置水平对齐
`range.setListStyle(style: PresentationListType): Promise<void>`	设置列表样式
`range.setLineSpacing(spacing: PresentationParagraphLineSpacing): Promise<void>`	设置行距
`range.increaseIndent(): Promise<void>`	增加缩进
`range.decreaseIndent(): Promise<void>`	减少缩进
`range.setTextDirection(direction: 'ltr' \| 'rtl'): Promise<void>`	设置文字方向
`range.clearStyle(): Promise<void>`	清除样式
`range.clearContent(): Promise<void>`	清除内容
`range.clearAll(): Promise<void>`	清除全部
`range.insertLink(url: string, text: string): Promise<void>`	插入链接

逐条类型定义

range.start

功能说明：表示当前文本选区的起始位置。

range.end

功能说明：表示当前文本选区的结束位置。

range.getText()

功能说明：获取当前文本选区的文本内容。

range.setText(text)

功能说明：设置当前文本选区的文本内容。

range.getHtml()

功能说明：获取当前文本选区的 HTML 内容。

range.setHtml(html)

功能说明：设置当前文本选区的 HTML 内容。

range.getBounding()

功能说明：获取当前文本选区在页面中的位置信息。

range.setStyle(style)

功能说明：设置当前文本选区的文本样式。

range.setVerticalAlign(vertical)

功能说明：设置当前文本选区的垂直对齐方式。

range.setHorizontalAlign(align)

功能说明：设置当前文本选区的水平对齐方式。

range.setListStyle(style)

功能说明：设置当前文本选区的列表样式。

range.setLineSpacing(spacing)

功能说明：设置当前文本选区的段落行距。

range.increaseIndent()

功能说明：增加当前文本选区的段落缩进。

range.decreaseIndent()

功能说明：减少当前文本选区的段落缩进。

range.setTextDirection(direction)

功能说明：设置当前文本选区的文字方向。

range.clearStyle()

功能说明：清除当前文本选区的样式。

range.clearContent()

功能说明：清除当前文本选区的内容。

range.clearAll()

功能说明：清除当前文本选区的内容和样式。

range.insertLink(url, text)

功能说明：在当前文本选区插入链接。

sdk.text

说明

文本格式能力。

类型定义

sdk.zoom

说明

缩放能力。

类型定义

sdk.eventSubscription

说明

事件订阅能力。

类型定义

sdk.batchChanges(callback)

说明

将一组演示文稿变更放在同一个批处理中执行。

类型定义

sdk.print

说明

打印演示文稿。

类型定义

sdk.export(type)

说明

导出演示文稿。

类型定义

PresentationShape

PresentationShape 为 PresentationShapeBase | PresentationTextShape 联合类型。

幻灯片

API#

方法#

方法列表#

API 调用方式#

新旧兼容#

旧方法兼容#

新增 API 方法#

sdk.history.show()#

说明#

类型定义#

sdk.history.hide()#

说明#

类型定义#

sdk.comments.show(type?)#

说明#

类型定义#

sdk.comments.hide(type?)#

说明#

类型定义#

sdk.version.createRevision(options?)#

说明#

类型定义#

sdk.presentation#

说明#

类型定义#

说明补充#

sdk.slides#

说明#

类型定义#

相关类型#

说明补充#

slide: PresentationSlideFacade#

说明#

API 一览表#

逐条类型定义#

slide.id#

slide.getIndex()#

slide.getShapes()#

slide.getTables()#

slide.insertShape(options)#

slide.insertTextBox(options)#

slide.insertTable(options)#

slide.insertImage(image, size?, offset?)#

slide.insertAudio(data, size?, offset?, name?)#

slide.insertVideo(data, size?, offset?, name?)#

slide.insertAttachment(file, size?, offset?, name?)#

相关类型#

说明补充#

sdk.selection#

说明#

类型定义#

相关类型#

textRange: PresentationTextRangeFacade#

说明#

API 一览表#

逐条类型定义#

range.start#

range.end#

range.getText()#

range.setText(text)#

range.getHtml()#

range.setHtml(html)#

range.getBounding()#

range.setStyle(style)#

range.setVerticalAlign(vertical)#

range.setHorizontalAlign(align)#

range.setListStyle(style)#

range.setLineSpacing(spacing)#

range.increaseIndent()#

range.decreaseIndent()#

range.setTextDirection(direction)#

range.clearStyle()#

range.clearContent()#

range.clearAll()#

range.insertLink(url, text)#

相关类型#

sdk.text#

说明#

类型定义#

API

方法

方法列表

API 调用方式

新旧兼容

旧方法兼容

新增 API 方法

sdk.history.show()

说明

类型定义

sdk.history.hide()

说明

类型定义

sdk.comments.show(type?)

说明

类型定义

sdk.comments.hide(type?)

说明

类型定义

sdk.version.createRevision(options?)

说明

类型定义

sdk.presentation

说明

类型定义

说明补充

sdk.slides

说明

类型定义

相关类型

说明补充

slide: PresentationSlideFacade

说明

API 一览表

逐条类型定义

slide.id

slide.getIndex()

slide.getShapes()

slide.getTables()

slide.insertShape(options)

slide.insertTextBox(options)

slide.insertTable(options)

slide.insertImage(image, size?, offset?)

slide.insertAudio(data, size?, offset?, name?)

slide.insertVideo(data, size?, offset?, name?)

slide.insertAttachment(file, size?, offset?, name?)

相关类型

说明补充

sdk.selection

说明

类型定义

相关类型

textRange: PresentationTextRangeFacade

说明

API 一览表

逐条类型定义

range.start

range.end

range.getText()

range.setText(text)

range.getHtml()

range.setHtml(html)

range.getBounding()

range.setStyle(style)

range.setVerticalAlign(vertical)

range.setHorizontalAlign(align)

range.setListStyle(style)

range.setLineSpacing(spacing)

range.increaseIndent()

range.decreaseIndent()

range.setTextDirection(direction)

range.clearStyle()

range.clearContent()

range.clearAll()

range.insertLink(url, text)

相关类型

sdk.text

说明

类型定义

相关类型