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)

说明

设置表格内容。

类型定义

sdk.version.createRevision(options?)

说明

创建表格版本。

类型定义

sdk.presentation

说明

表格演示模式能力。

类型定义

sdk.workbook

说明

工作簿能力。

类型定义

示例

sdk.activeSheet

说明

当前工作表能力。

类型定义

range: SheetRangeFacade

说明

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

API 一览表

API	说明
`range.getText(format?: 'plain' \| 'matrix'): Promise<string \| string[][]>`	获取文本
`range.setText(text: SheetRangeText): Promise<void>`	设置文本
`range.getHtml(): Promise<string>`	获取 HTML
`range.setHtml(html: string): Promise<void>`	设置 HTML
`range.getValue(): Promise<(SheetCellValue \| null)[][]>`	获取值
`range.setValue(values: (SheetWritableCellValue \| null)[][]): Promise<void>`	设置值
`range.getData(): Promise<SheetCellData[][]>`	获取数据
`range.getFormula(): Promise<(string \| null)[][]>`	获取公式
`range.setFormula(formula: (string \| null)[][]): Promise<void>`	设置公式
`range.setData(data: SheetWritableCellData[][]): Promise<void>`	设置数据
`range.setSpan(): Promise<void>`	合并单元格
`range.removeSpan(): Promise<void>`	取消合并
`range.getSpans(): Promise<SheetCellRange[] \| null>`	获取合并区域
`range.clearContent(): Promise<void>`	清除内容
`range.clearStyle(): Promise<void>`	清除样式
`range.clearAll(): Promise<void>`	清除全部

逐条类型定义

range.getText(format?)

功能说明：获取当前范围的文本内容。

range.setText(text)

功能说明：设置当前范围的文本内容。

range.getHtml()

功能说明：获取当前范围的 HTML 内容。

range.setHtml(html)

功能说明：设置当前范围的 HTML 内容。

range.getValue()

功能说明：获取当前范围的单元格值矩阵。

range.setValue(values)

功能说明：批量设置当前范围的单元格值。

range.getData()

功能说明：获取当前范围的完整单元格数据。

range.getFormula()

功能说明：获取当前范围内的公式矩阵。

range.setFormula(formula)

功能说明：批量设置当前范围内的公式。

range.setData(data)

功能说明：批量设置当前范围的单元格数据。

range.setSpan()

功能说明：合并当前范围内的单元格。

range.removeSpan()

功能说明：取消当前范围内的单元格合并。

range.getSpans()

功能说明：获取当前范围内的合并区域信息。

range.clearContent()

功能说明：清除当前范围的内容。

range.clearStyle()

功能说明：清除当前范围的样式。

range.clearAll()

功能说明：清除当前范围的内容和样式。

cell: SheetCellFacade

说明

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

API 一览表

API	说明
`cell.getCellText(): Promise<string>`	获取文本
`cell.setCellText(text: string): Promise<void>`	设置文本
`cell.getCellValue(): Promise<SheetCellValue \| null>`	获取值
`cell.getCellData(): Promise<SheetCellData>`	获取数据
`cell.getCellFormula(): Promise<string \| null>`	获取公式
`cell.setCellFormula(formula: string): Promise<void>`	设置公式
`cell.setCellValue(value: SheetWritableCellValue \| null): Promise<void>`	设置值
`cell.setCellData(data: SheetWritableCellData): Promise<void>`	设置数据
`cell.setCheckbox(checked: boolean): Promise<void>`	设置复选框
`cell.setScore(score: 0 \| 1 \| 2 \| 3 \| 4 \| 5): Promise<void>`	设置评分
`cell.setProgress(progress: number): Promise<void>`	设置进度
`cell.insertImage(data: File \| string): Promise<void>`	插入图片
`cell.insertMention(userId: number, userName: string): Promise<void>`	插入提及
`cell.insertAttachmentLink(data: File): Promise<void>`	插入附件链接
`cell.clearContent(): Promise<void>`	清除内容
`cell.clearStyle(): Promise<void>`	清除样式
`cell.clearAll(): Promise<void>`	清除全部

逐条类型定义

cell.getCellText()

功能说明：获取当前单元格的文本内容。

cell.setCellText(text)

功能说明：设置当前单元格的文本内容。

cell.getCellValue()

功能说明：获取当前单元格的值。

cell.getCellData()

功能说明：获取当前单元格的完整数据。

cell.getCellFormula()

功能说明：获取当前单元格的公式。

cell.setCellFormula(formula)

功能说明：设置当前单元格的公式。

cell.setCellValue(value)

功能说明：设置当前单元格的值。

cell.setCellData(data)

功能说明：设置当前单元格的完整数据。

cell.setCheckbox(checked)

功能说明：设置当前单元格复选框的勾选状态。

cell.setScore(score)

功能说明：设置当前单元格的评分值。

cell.setProgress(progress)

功能说明：设置当前单元格的进度值。

cell.insertImage(data)

功能说明：向当前单元格插入图片。

cell.insertMention(userId, userName)

功能说明：向当前单元格插入提及内容。

cell.insertAttachmentLink(data)

功能说明：向当前单元格插入附件链接。

cell.clearContent()

功能说明：清除当前单元格的内容。

cell.clearStyle()

功能说明：清除当前单元格的样式。

cell.clearAll()

功能说明：清除当前单元格的内容和样式。

sdk.charts

说明

图表能力。

类型定义

sdk.selections

说明

多选区能力。

类型定义

sdk.batchChanges(callback)

说明

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

类型定义

sdk.print

说明

打印表格。

类型定义

sdk.export(type)

说明

导出表格。

类型定义

sdk.setFocus(isFocus)

说明

设置表格聚焦状态。

表格

API#

方法#

方法列表#

API 调用方式#

新旧兼容#

旧方法兼容#

新增 API 方法#

sdk.history.show()#

说明#

类型定义#

sdk.history.hide()#

说明#

类型定义#

sdk.comments.show(type?)#

说明#

类型定义#

sdk.comments.hide(type?)#

说明#

类型定义#

sdk.locks#

说明#

类型定义#

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

说明#

类型定义#

sdk.content.setContent(content)#

说明#

类型定义#

相关类型#

sdk.version.createRevision(options?)#

说明#

类型定义#

sdk.presentation#

说明#

类型定义#

sdk.workbook#

说明#

类型定义#

相关类型#

示例#

sdk.activeSheet#

说明#

类型定义#

相关类型#

range: SheetRangeFacade#

说明#

API 一览表#

逐条类型定义#

range.getText(format?)#

range.setText(text)#

range.getHtml()#

range.setHtml(html)#

range.getValue()#

range.setValue(values)#

range.getData()#

range.getFormula()#

range.setFormula(formula)#

range.setData(data)#

range.setSpan()#

range.removeSpan()#

range.getSpans()#

range.clearContent()#

range.clearStyle()#

range.clearAll()#

相关类型#

cell: SheetCellFacade#

说明#

API 一览表#

逐条类型定义#

cell.getCellText()#

cell.setCellText(text)#

cell.getCellValue()#

cell.getCellData()#

cell.getCellFormula()#

cell.setCellFormula(formula)#

cell.setCellValue(value)#

cell.setCellData(data)#

cell.setCheckbox(checked)#

cell.setScore(score)#

API

方法

方法列表

API 调用方式

新旧兼容

旧方法兼容

新增 API 方法

sdk.history.show()

说明

类型定义

sdk.history.hide()

说明

类型定义

sdk.comments.show(type?)

说明

类型定义

sdk.comments.hide(type?)

说明

类型定义

sdk.locks

说明

类型定义

sdk.mention.locateCellByGuid(guid, notificationType?)

说明

类型定义

sdk.content.setContent(content)

说明

类型定义

相关类型

sdk.version.createRevision(options?)

说明

类型定义

sdk.presentation

说明

类型定义

sdk.workbook

说明

类型定义

相关类型

示例

sdk.activeSheet

说明

类型定义

相关类型

range: SheetRangeFacade

说明

API 一览表

逐条类型定义

range.getText(format?)

range.setText(text)

range.getHtml()

range.setHtml(html)

range.getValue()

range.setValue(values)

range.getData()

range.getFormula()

range.setFormula(formula)

range.setData(data)

range.setSpan()

range.removeSpan()

range.getSpans()

range.clearContent()

range.clearStyle()

range.clearAll()

相关类型

cell: SheetCellFacade

说明

API 一览表

逐条类型定义

cell.getCellText()

cell.setCellText(text)

cell.getCellValue()

cell.getCellData()

cell.getCellFormula()

cell.setCellFormula(formula)

cell.setCellValue(value)

cell.setCellData(data)

cell.setCheckbox(checked)

cell.setScore(score)

cell.setProgress(progress)