Class Drawing

绘图

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

方法

方法返回类型简介
getContainerInfo()ContainerInfo获取有关图纸中绘图位置的信息。
getHeight()Integer返回相应绘制对象的实际高度(以像素为单位)。
getOnAction()String|null返回附加到相应绘图的宏的名称。
getSheet()Sheet返回此绘图所在的工作表。
getWidth()Integer返回相应绘制对象的实际宽度(以像素为单位)。
getZIndex()Number返回相应绘制的 z-index。
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|null - 附加到相应绘图的宏名称。

授权

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

  • 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-index。

// 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-index。

授权

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

  • 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)

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

参数

名称类型说明
heightInteger所需的高度(以像素为单位)。

返回

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

授权

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

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

setOnAction(macroName)

为相应图形分配宏函数。

参数

名称类型说明
macroNameString宏函数的名称。

返回

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


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

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

参数

名称类型说明
anchorRowPosInteger绘图的顶部固定在此行中。
anchorColPosInteger绘图的顶部固定在此列中。
offsetXInteger单元格角部的水平偏移量(以像素为单位)。
offsetYInteger单元格角部的垂直偏移量(以像素为单位)。

返回

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

授权

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

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

setWidth(width)

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

参数

名称类型说明
widthInteger所需的宽度(以像素为单位)。

返回

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

授权

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

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

setZIndex(zIndex)

设置相应绘制内容的 z-index。

参数

名称类型说明
zIndexNumber相应绘制对象的 Z-Index。

返回

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