Sheet

工作表对象

属性

name

工作表名称

语法

sheet.name

sheet：工作表对象

返回值

sheetName: string

示例

async function example() {
  const sheet = await Application.ActiveWorkbook.getActiveSheet();
  const sheetName = sheet.name;
}

Names

返回当前工作表范围的名称集合

语法

sheet.Names

sheet: 工作表对象

返回值

Promise<Names>

示例

async function example() {
  // 活动工作簿中的活动工作表
  const sheet = await Application.ActiveWorkbook.getActiveSheet();
  // 返回一个Names集合，该集合代表工作表特定的名称
  const names = await sheet.Names
}

RangePermissions

返回当前工作表所有保护区域的集合

语法

sheet.RangePermissions

sheet:工作表对象

返回值

Promise<RangePermissions>

示例

async function example() {
  // 活动工作表
  const sheet = await Application.ActiveWorkbook.getActiveSheet();
  // 活动工作表所有保护区域的集合
  const rangePermissions = await sheet.RangePermissions;
}

Shapes

返回当前工作表形状对象的集合

语法

sheet.Shapes

sheet: 工作表对象

返回值

Promise<Shapes>

示例

async function example() {
  // 活动工作簿中的活动工作表
  const sheet = await Application.ActiveWorkbook.getActiveSheet();
  // 返回一个形状对象的集合
  const shapes = await sheet.Shapes;
}

方法

activate

切换活动工作表

语法

sheet.activate()

sheet：工作表对象

返回值

无

示例

async function example(sheetName) {
  const sheet = await Application.ActiveWorkbook.getSheetByName(sheetName);
  await sheet.activate();
}

show

显示工作表

语法

sheet.show()

sheet：工作表对象

返回值

Promise<boolean>

示例

async function example(sheetName) {
  const sheet = await Application.ActiveWorkbook.getSheetByName(sheetName);
  const success = await sheet.show();
}

hide

隐藏工作表

语法

sheet.hide()

sheet：工作表对象

返回值

Promise<boolean>

示例

async function example(sheetName) {
  const sheet = await Application.ActiveWorkbook.getSheetByName(sheetName);
  const success = await sheet.hide();
}

setName

设置工作表名称

语法

sheet.setName(name)

sheet：工作表对象

参数

属性	数据类型	必填	说明
name	string	是	新的工作表名称

返回值

Promise<boolean>

示例

async function example(sheetName, rName) {
  const sheet = await Application.ActiveWorkbook.getSheetByName(sheetName);
  const success = await sheet.setName(rName);
}

isHidden

工作表是否隐藏

语法

sheet.isHidden()

sheet：工作表对象

返回值

Promise<boolean>

true: 隐藏
false: 没有隐藏

示例

async function example(sheetName) {
  const sheet = await Application.ActiveWorkbook.getSheetByName(sheetName);
  const isHidden = await sheet.isHidden();
}

insertSheet

在工作表后面插入工作表

语法

sheet.insertSheet(name)

sheet：工作表对象

参数

属性	数据类型	必填	说明
name	string	是	要插入的工作表的名称

返回值

Promise<boolean>

示例

async function example(rName) {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.insertSheet(rName);
  console.log(success);
}

delete

删除工作表

语法

sheet.delete()

sheet：工作表对象

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.delete();
}

setActiveRange

选中区域

语法

sheet.setActiveRange(range)

sheet：工作表对象

参数

属性	数据类型	必填	说明
range	Excel.Range (只能通过Sheet.getRange拿到一个Range)	是	活动工作表的一块区域

返回值

无

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const range = activeSheet.getRange(1, 1, 5, 5);
  await activeSheet.setActiveRange(range);
}

getActiveRange

获取选中区域

语法

sheet.getActiveRange()

sheet：工作表对象

返回值

Promise<Excel.Range>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const range = await activeSheet.getActiveRange();
}

getActiveCell

获取选中区域中左上角单元格

语法

sheet.getActiveCell()

sheet：工作表对象

返回值

Promise<Excel.Range>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const cell = await activeSheet.getActiveCell();
}

getIndex

获取工作表序号

语法

sheet.getIndex()

sheet：工作表对象

返回值

index: Promise<number>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const index = await activeSheet.getIndex();
}

getRange

获取一块区域

语法

sheet.getRange(startRow, startCol, endRow, endCol)

sheet：工作表对象

参数

属性	数据类型	必填	说明
startRow	number	是	开始行号（从1开始，下同）
startCol	number	是	开始列号
endRow	number	是	结束行号
endCol	number	是	结束列号

返回值

Excel.Range

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const range = activeSheet.getRange(1, 1, 3, 4);
}

setFreezeRow

设置冻结行

语法

sheet.setFreezeRow(rowIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
rowIndex	number	是	冻结行号（起始行号为1，rowIndex为0代表取消冻结行）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.setFreezeRow(5);
}

getFreezeRow

获取冻结行

语法

sheet.getFreezeRow()

sheet：工作表对象

返回值

Promise<number>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const index = await activeSheet.getFreezeRow();
}

setFreezeColumn

设置冻结列

语法

sheet.setFreezeColumn(colIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
colIndex	number	是	冻结列号（起始行号为1，colIndex为0代表取消冻结列）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.setFreezeColumn(5);
}

getFreezeColumn

获取冻结列

语法

sheet.getFreezeColumn()

sheet：工作表对象

返回值

Promise<number>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const index = await activeSheet.getFreezeColumn();
}

hideRow

隐藏行

语法

sheet.hideRow(rowIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
rowIndex	number	是	隐藏行号（起始行号为1）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.hideRow(5);
}

hideRows

隐藏多行

语法

sheet.hideRows(startIndex, endIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
startIndex	number	是	隐藏开始行号（起始行号为1，下同）
endIndex	number	是	隐藏结束行号

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.hideRows(1, 5);
}

showRow

显示行

语法

sheet.showRow(rowIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
rowIndex	number	是	显示行号（起始行号为1）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.showRow(5);
}

showRows

显示多行

语法

sheet.showRows(startIndex, endIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
startIndex	number	是	显示开始行号（起始行号为1，下同）
endIndex	number	是	显示结束行号

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.showRows(1, 5);
}

insertRow

插入一行

语法

sheet.insertRow(rowIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
rowIndex	number	是	插入行号（起始行号为1）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.insertRow(5);
}

insertRows

插入多行

语法

sheet.insertRows(rowIndex, count)

sheet：工作表对象

参数

属性	数据类型	必填	说明
rowIndex	number	是	插入行号（起始行号为1，下同）
count	number	是	插入行数，最大为29999行

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.insertRows(5, 2);
}

deleteRow

删除行

语法

sheet.deleteRow(rowIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
rowIndex	number	是	删除行号（起始行号为1）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.deleteRow(5);
}

deleteRows

删除多行

语法

sheet.deleteRows(rowIndex, count)

sheet：工作表对象

参数

属性	数据类型	必填	说明
rowIndex	number	是	删除行号（起始行号为1，下同）
count	number	是	删除行数，最大为29999行

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.deleteRows(2, 5);
}

hideColumn

隐藏列

语法

sheet.hideColumn(colIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
colIndex	number	是	隐藏列号（起始列号为1）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.hideColumn(5);
}

hideColumns

隐藏多列

语法

sheet.hideColumns(startIndex, endIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
startIndex	number	是	隐藏开始列号（起始列号为1，下同）
endIndex	number	是	隐藏结束列号

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.hideColumns(1, 5);
}

showColumn

显示列

语法

sheet.showColumn(colIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
colIndex	number	是	显示列号（起始列号为1）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.showColumn(5);
}

showColumns

显示多列

语法

sheet.showColumns(startIndex, endIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
startIndex	number	是	显示开始列号（起始行号为1，下同）
endIndex	number	是	显示结束列号

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.showColumns(1, 5);
}

insertColumn

插入一列

语法

sheet.insertColumn(colIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
colIndex	number	是	插入列号（起始列号为1）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.insertRow(5);
}

insertColumns

插入多列

语法

sheet.insertColumns(colIndex, count)

sheet：工作表对象

参数

属性	数据类型	必填	说明
colIndex	number	是	插入列号（起始列号为1，下同）
count	number	是	插入列数，最大为1023行

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.insertColumns(5, 2);
}

deleteColumn

删除列

语法

sheet.deleteColumn(colIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
colIndex	number	是	删除列号（起始列号为1）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.deleteColumn(5);
}

deleteColumns

删除多列

语法

sheet.deleteColumns(colIndex, count)

sheet：工作表对象

参数

属性	数据类型	必填	说明
colIndex	number	是	删除列号（起始列号为1，下同）
count	number	是	删除列数，最大为29999列

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.deleteColumns(2, 5);
}

setColumnWidth

设置列宽

语法

sheet.setColumnWidth(colIndex, width)

sheet：工作表对象

参数

属性	数据类型	必填	说明
colIndex	number	是	列号（起始列号为1）
width	number	是	列宽值，介于0和2045之间（单位：像素）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.setColumnWidth(5, 30);
}

setColumnWidths

设置多列列宽

语法

sheet.setColumnWidths(startIndex, endIndex, width)

sheet：工作表对象

参数

属性	数据类型	必填	说明
startIndex	number	是	开始列号（起始列号为1，下同）
endIndex	number	是	结束列号
width	number	是	列宽值，介于0和2045之间（单位：像素）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.setColumnWidths(1, 5, 30);
}

getColumnWidth

获取列宽

语法

sheet.getColumnWidth(colIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
colIndex	number	是	列号（起始列号为1）

返回值

Promise<number>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const width = await activeSheet.getColumnWidth(5);
}

setRowHeight

设置行高

语法

sheet.setRowHeight(rowIndex, height)

sheet：工作表对象

参数

属性	数据类型	必填	说明
rowIndex	number	是	行号（起始行号为1）
height	number	是	行高值，介于0和546之间（单位：像素）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.setRowHeight(5, 30);
}

setRowHeights

设置多行行高

语法

sheet.setRowHeights(startIndex, endIndex, height)

sheet：工作表对象

参数

属性	数据类型	必填	说明
startIndex	number	是	开始行号（起始行号为1，下同）
endIndex	number	是	结束行号
height	number	是	行高值，介于0和546之间（单位：像素）

返回值

Promise<boolean>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const success = await activeSheet.setRowHeights(1, 5, 30);
}

getRowHeight

获取行高

语法

sheet.getRowHeight(rowIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
rowIndex	number	是	行号（起始行号为1)

返回值

Promise<number>

示例

async function example() {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  const height = await activeSheet.getRowHeight(5);
}

insertImage

JSSDK: 1.1.0、zOffice2022.2 支持

插入浮动图片

语法

sheet.insertImage(image, rowIndex, colIndex, offsetX, offsetY)

sheet：工作表对象

参数

属性	数据类型	必填	说明
image	Blob 或者 string	是	Blob可通过设置input元素的type为file或其他方式获得；string为图片的url（因为浏览器安全限制，不支持本地图片的url）
rowIndex	number	是	插入行号（起始行号为1)
colIndex	number	是	插入列号（起始列号为1)
offsetX	number	否	可选参数，介于0-20
offsetY	number	否	可选参数，介于0-72

返回值

无

示例

async function exampleA(imageBlob: Blob) {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  await activeSheet.insertImage(imageBlob, 3, 3);
}
async function exampleB(imageUrl: string) {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  await activeSheet.insertImage(imageUrl, 3, 3, 10, 5);
}

insertCellImage

JSSDK: 1.1.0、zOffice2022.2 支持

插入单元格图片

语法

sheet.insertCellImage(image, rowIndex, colIndex)

sheet：工作表对象

参数

属性	数据类型	必填	说明
image	Blob 或者 string	是	Blob可通过设置input元素的type为file或其他方式获得；string为图片的url（因为浏览器安全限制，不支持本地图片的url）
rowIndex	number	是	插入行号（起始行号为1)
colIndex	number	是	插入列号（起始列号为1)

返回值

无

示例

async function exampleA(imageBlob: Blob) {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  await activeSheet.insertCellImage(imageBlob, 3, 3);
}
async function exampleB(imageUrl: string) {
  const activeSheet = await Application.ActiveWorkbook.getActiveSheet();
  await activeSheet.insertCellImage(imageUrl, 3, 3);
}

getHtml

获取当前工作表的HTML格式内容

语法

sheet.getHtml(dataOnly)

sheet：工作表对象

参数

属性	数据类型	必填	说明
dataOnly	boolean	否	是否只获取当前工作表内数据区域的HTML格式内容，默认为false

返回值

Promise<string>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 活动工作表
  const activeWorksheet = await activeWorkbook.getActiveSheet()
  // 获取当前工作表的HTML格式内容
  const htmlStr = await activeWorksheet.getHtml(true);
  console.log(htmlStr);
}

Sheet​

属性​

name​

Names​

RangePermissions​

Shapes​

方法​

activate​

show​

hide​

setName​

isHidden​

insertSheet​

delete​

setActiveRange​

getActiveRange​

getActiveCell​

getIndex​

getRange​

setFreezeRow​

getFreezeRow​

setFreezeColumn​

getFreezeColumn​

hideRow​

hideRows​

showRow​

showRows​

insertRow​

insertRows​

deleteRow​

deleteRows​

hideColumn​

hideColumns​

showColumn​

showColumns​

insertColumn​

insertColumns​

deleteColumn​

deleteColumns​

setColumnWidth​

setColumnWidths​

getColumnWidth​

setRowHeight​

setRowHeights​

getRowHeight​

insertImage​

insertCellImage​

getHtml​

Sheet

属性

name

Names

RangePermissions

Shapes

方法

activate

show

hide

setName

isHidden

insertSheet

delete

setActiveRange

getActiveRange

getActiveCell

getIndex

getRange

setFreezeRow

getFreezeRow

setFreezeColumn

getFreezeColumn

hideRow

hideRows

showRow

showRows

insertRow

insertRows

deleteRow

deleteRows

hideColumn

hideColumns

showColumn

showColumns

insertColumn

insertColumns

deleteColumn

deleteColumns

setColumnWidth

setColumnWidths

getColumnWidth

setRowHeight

setRowHeights

getRowHeight

insertImage

insertCellImage

getHtml