Class CellImageBuilder

CellImageBuilder

CellImage 的构建器。此构建器会创建将图片添加到单元格所需的图片值。

属性

属性类型说明
valueTypeValueType单元格图片的类型,即 ValueType.IMAGE

方法

方法返回值类型简介
build()CellImage创建将图片添加到单元格所需的图片值类型。
getAltTextDescription()String返回此图片的替代文本说明。
getAltTextTitle()String返回此图片的替代文本标题。
getContentUrl()String返回 Google 托管的图片网址。
setAltTextDescription(description)CellImage设置此图片的替代文本说明。
setAltTextTitle(title)CellImage设置此图片的替代文本标题。
setSourceUrl(url)CellImageBuilder设置图片来源网址。
toBuilder()CellImageBuilder根据当前图片属性创建单元格图片构建器。

详细文档

build()

创建将图片添加到单元格所需的图片值类型。图片值是根据添加到构建器的图片属性(例如来源网址)构建的。

返回

CellImage:要添加到单元格的图片的表示形式。


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 托管的图片网址。


setAltTextDescription(description)

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

参数

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

返回

CellImage:此图片,用于链接操作。

授权

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

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

setAltTextTitle(title)

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

参数

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

返回

CellImage:此图片,用于链接操作。

授权

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

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

setSourceUrl(url)

设置图片来源网址。

参数

名称类型说明
urlString图片的网址。

返回

CellImageBuilder:此构建器,用于链接操作。


toBuilder()

根据当前图片属性创建单元格图片构建器。使用 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:一个构建器,用于根据给定的图片属性创建图片值类型。

已弃用的方法