Class CellImageBuilder

CellImageBuilder

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

属性

属性类型说明
valueTypeValueType设置为 ValueType.IMAGE 的字段,表示图片值类型。

方法

方法返回类型简介
build()CellImage创建向单元格添加图片所需的图片值类型。
getAltTextDescription()String返回此图片的替代文本说明。
getAltTextTitle()String返回此图片的替代文本标题。
getContentUrl()String返回 Google 托管的图片网址。
getUrl()String获取图片的来源网址;如果网址不可用,则返回 null
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 托管的图片网址。此网址会标记为请求者的账号,因此知道此网址的任何人都可以以原始请求者的身份有效访问图片。如果电子表格的共享设置发生变化,您可能会失去对图片的访问权限。返回的网址会在短时间后过期。

返回

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


getUrl()

获取图片的来源网址;如果网址不可用,则返回 null。如果图片是使用 API 通过网址插入的,此方法会返回图片插入期间提供的网址。

返回

String - 图片网址(如果有);如果图片不可用或没有来源网址,则返回 null

授权

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

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

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

创建一个用于将图片转换为图片值类型的构建器,以便将其放入单元格中。在将图片放入单元格之前,需要将其创建为图片值类型。然后,您可以使用 Range.setValue(value)Range.setValues(values) 将其添加到单元格中。

返回

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