Class Drawing

绘图

表示在电子表格中的工作表上绘制的图形。

方法

方法	返回类型	简介
getContainerInfo()	ContainerInfo	获取绘图在工作表中的位置信息。
getHeight()	Integer	返回此绘图的实际高度（以像素为单位）。
getOnAction()	String	返回附加在此绘图的宏的名称。
getSheet()	Sheet	返回此绘图显示在的电子表格。
getWidth()	Integer	返回此绘图的实际宽度（以像素为单位）。
getZIndex()	Number	返回此绘图的 z 轴索引。
remove()	void	从电子表格中删除此绘图。
setHeight(height)	Drawing	设置此绘图的实际高度（以像素为单位）。
setOnAction(macroName)	Drawing	为此绘图分配宏函数。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	Drawing	设置绘图在工作表中的显示位置。
setWidth(width)	Drawing	设置此绘图的实际宽度（以像素为单位）。
setZIndex(zIndex)	Drawing	设置此绘图的 z-index。

详细文档

getContainerInfo()

获取绘图在工作表中的位置信息。

返回

ContainerInfo - 一个对象，包含绘图的容器位置。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getHeight()

返回此绘图的实际高度（以像素为单位）。

// Logs the height of all drawings in a sheet
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getHeight());
}

返回

Integer - 绘图的高度（以像素为单位）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getOnAction()

返回附加在此绘图的宏的名称。

// Logs the macro name of all drawings on the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getOnAction());
}

返回

String - 此绘图附加的宏名称。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getSheet()

返回此绘图显示在的页面。

// Logs the parent sheet of all drawings on the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getSheet());
}

返回

Sheet - 绘图显示的页面。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getWidth()

返回此绘图的实际宽度（以像素为单位）。

// Logs the width of all drawings in a sheet
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getWidth());
}

返回

Integer - 绘图的宽度（以像素为单位）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getZIndex()

返回此绘图的 z 轴索引。

// Logs the z-index of all drawings on the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getZIndex());
}

返回

Number - 此绘图的 Z 编号。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

remove()

从电子表格中删除此绘图。对绘图执行的任何进一步操作都会导致脚本错误。

// Deletes all drawings from the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  drawings[i].remove();
}

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setHeight(height)

设置此绘图的实际高度（以像素为单位）。

参数

名称	类型	说明
height	Integer	所需的高度（以像素为单位）。

返回

Drawing - 此绘图，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setOnAction(macroName)

为此绘图分配宏函数。

参数

名称	类型	说明
macroName	String	宏函数的名称。

返回

Drawing - 此绘图，用于链式调用。

---

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

设置绘图在工作表上的显示位置。锚点行和列位置索引从 1 开始编号。

参数

名称	类型	说明
anchorRowPos	Integer	绘图的顶部会固定在此行。
anchorColPos	Integer	绘图的顶部会固定在此列中。
offsetX	Integer	相对于单元格角的水平偏移量（以像素为单位）。
offsetY	Integer	相对于单元格角的垂直偏移量（以像素为单位）。

返回

Drawing - 此绘图，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setWidth(width)

设置此绘图的实际宽度（以像素为单位）。

参数

名称	类型	说明
width	Integer	所需的宽度（以像素为单位）。

返回

Drawing - 此绘图，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setZIndex(zIndex)

设置此绘图的 z-index。

参数

名称	类型	说明
zIndex	Number	此绘图的 Z 编号。

返回

Drawing - 此绘图，用于链式调用。