Class CellImage

单元格图片

表示单元格中的图片值。如需向单元格添加图片，您必须使用 SpreadsheetApp.newCellImage() 和 CellImageBuilder 为图片创建新的图片值。然后，您可以使用 Range.setValue(value) 或 Range.setValues(values) 将图片值添加到单元格中。

属性

属性	类型	说明
valueType	ValueType	单元格图片的值类型，即 ValueType.IMAGE。

方法

方法	返回类型	简介
getAltTextDescription()	String	返回此图片的替代文本说明。
getAltTextTitle()	String	返回此图片的替代文本标题。
getContentUrl()	String	返回 Google 托管的图片网址。
toBuilder()	CellImageBuilder	根据当前图片属性创建单元格图片构建器。

已弃用的方法

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

详细文档

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

---

getContentUrl()

返回 Google 托管的图片网址。此网址会标记为请求者的账号，因此知道此网址的任何人都可以以原始请求者的身份有效访问图片。如果电子表格的共享设置发生变化，您可能会失去对图片的访问权限。返回的网址会在短时间后过期。

const range = SpreadsheetApp.getActiveSpreadsheet().getRange("Sheet1!A1");
const value = range.getValue();
if (value.valueType == SpreadsheetApp.ValueType.IMAGE) {
  console.log(value.getContentUrl());
}

返回

String - 图片在 Google 上的托管网址。

---

toBuilder()

根据当前图片属性创建单元格图片构建器。使用 CellImageBuilder.setSourceUrl(url) 设置新图片的来源网址。然后，您可以使用 Range.setValue(value) 或 Range.setValues(values) 将其添加到单元格中。

const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange("Sheet1!A1");
const value = range.getValue();
if (value.valueType == SpreadsheetApp.ValueType.IMAGE) {
  const newImage =
      value.toBuilder()
          .setSourceUrl(
              'https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png',
              )
          .build();
  const newRange = ss.getRange("Sheet1!A2");
  newRange.setValue(newImage);
}

返回

CellImageBuilder - 一个构建器，用于根据给定的图片属性创建图片值类型。

已弃用的方法

getUrl()

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

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

返回

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

授权

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

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