Class OverGridImage

在网格图片上方

表示电子表格中网格上方的图片。

方法

方法	返回类型	简介
assignScript(functionName)	OverGridImage	将具有指定函数名称的函数分配给此图片。
getAltTextDescription()	String	返回此图片的替代文本说明。
getAltTextTitle()	String	返回此图片的替代文本标题。
getAnchorCell()	Range	返回图片锚定的单元格。
getAnchorCellXOffset()	Integer	返回相对于锚点单元格的水平像素偏移量。
getAnchorCellYOffset()	Integer	返回相对于锚定单元格的垂直像素偏移量。
getHeight()	Integer	返回此图片的实际高度（以像素为单位）。
getInherentHeight()	Integer	返回此图片的固有高度（以像素为单位）。
getInherentWidth()	Integer	返回此图片的固有高度（以像素为单位）。
getScript()	String	返回分配给此图片的函数的名称。
getSheet()	Sheet	返回此图片显示的页面。
getWidth()	Integer	返回此图片的实际宽度（以像素为单位）。
remove()	void	从电子表格中删除此图片。
replace(blob)	OverGridImage	将此图片替换为由提供的 BlobSource 指定的图片。
replace(url)	OverGridImage	将此图片替换为指定网址中的图片。
resetSize()	OverGridImage	将此图片重置为其固有尺寸。
setAltTextDescription(description)	OverGridImage	设置此图片的替代文本说明。
setAltTextTitle(title)	OverGridImage	设置此图片的替代文本标题。
setAnchorCell(cell)	OverGridImage	设置图片锚定的单元格。
setAnchorCellXOffset(offset)	OverGridImage	设置相对于锚点单元格的水平像素偏移量。
setAnchorCellYOffset(offset)	OverGridImage	设置相对于锚点单元格的垂直像素偏移量。
setHeight(height)	OverGridImage	设置此图片的实际高度（以像素为单位）。
setWidth(width)	OverGridImage	设置此图片的实际宽度（以像素为单位）。

已弃用的方法

方法	返回类型	简介
getUrl()	String	获取图片的来源网址。

详细文档

assignScript(functionName)

将具有指定函数名称的函数分配给此图片。

参数

名称	类型	说明
functionName	String	要指定的函数的名称。此函数必须是公共顶级函数，而不是以下划线结尾的函数，例如 privateFunction_。

返回

OverGridImage - 此图片，用于链式调用。

授权

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

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

---

getAltTextDescription()

返回此图片的替代文本说明。

返回

String - 替代文本说明。

授权

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

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

---

getAltTextTitle()

返回此图片的替代文本标题。

返回

String - 替代文本标题。

授权

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

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

---

getAnchorCell()

返回图片锚定的单元格。

返回

Range - 锚定单元格。

授权

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

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

---

getAnchorCellXOffset()

返回相对于锚点单元格的水平像素偏移量。

返回

Integer - 水平像素偏移量。

授权

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

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

---

getAnchorCellYOffset()

返回相对于锚定单元格的垂直像素偏移量。

返回

Integer - 垂直像素偏移量。

授权

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

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

---

getHeight()

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

// Logs the height of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getHeight());
}

返回

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

授权

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

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

---

getInherentHeight()

返回此图片的固有高度（以像素为单位）。

返回

Integer - 固有高度（以像素为单位）。

授权

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

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

---

getInherentWidth()

返回此图片的固有高度（以像素为单位）。

返回

Integer - 固有宽度（以像素为单位）。

授权

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

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

---

getScript()

返回分配给此图片的函数的名称。

返回

String - 函数的名称。

授权

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

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

---

getSheet()

返回此图片显示的页面。

// Logs the parent sheet of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getSheet());
}

返回

Sheet - 图片显示的页面。

授权

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

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

---

getWidth()

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

// Logs the width of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getWidth());
}

返回

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

授权

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

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

---

remove()

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

// Deletes all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  images[i].remove();
}

授权

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

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

---

replace(blob)

将此图片替换为由提供的 BlobSource 指定的图片。支持的 BLOB 大小上限为 2MB。

参数

名称	类型	说明
blob	BlobSource	新图片（作为 Blob）。

返回

OverGridImage - 此图片，用于链式调用。

授权

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

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

---

replace(url)

将此图片替换为指定网址中的图片。

参数

名称	类型	说明
url	String	新图片的网址。

返回

OverGridImage - 此图片，用于链式调用。

授权

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

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

---

resetSize()

将此图片重置为其固有尺寸。

返回

OverGridImage - 此图片，用于链式调用。

授权

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

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

---

setAltTextDescription(description)

设置此图片的替代文本说明。

参数

名称	类型	说明
description	String	图片的新替代文本说明。

返回

OverGridImage - 此图片，用于链式调用。

授权

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

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

---

setAltTextTitle(title)

设置此图片的替代文本标题。

参数

名称	类型	说明
title	String	图片的新替代文本标题。

返回

OverGridImage - 此图片，用于链式调用。

授权

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

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

---

setAnchorCell(cell)

设置图片锚定的单元格。

参数

名称	类型	说明
cell	Range	新的锚点单元格。

返回

OverGridImage - 此图片，用于链式调用。

授权

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

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

---

setAnchorCellXOffset(offset)

设置相对于锚点单元格的水平像素偏移量。

参数

名称	类型	说明
offset	Integer	新的水平像素偏移量。

返回

OverGridImage - 此图片，用于链式调用。

授权

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

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

---

setAnchorCellYOffset(offset)

设置相对于锚点单元格的垂直像素偏移量。

参数

名称	类型	说明
offset	Integer	新的垂直像素偏移量。

返回

OverGridImage - 此图片，用于链式调用。

授权

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

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

---

setHeight(height)

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

参数

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

返回

OverGridImage - 用于链接的图片。

授权

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

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

---

setWidth(width)

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

参数

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

返回

OverGridImage - 用于链接的图片。

授权

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

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

已弃用的方法

getUrl()

已弃用。对于大多数新插入的图片，来源网址不可用。

获取图片的来源网址。如果网址不可用，则返回空字符串。对于大多数新插入的图片，无论以何种方式插入，源网址均不可用。

返回

String - 图片的来源网址（如果有）；否则返回空字符串。

授权

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

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