Builder para a classe CellImage
. Esse builder cria o valor de imagem necessário para adicionar uma
imagem a uma célula.
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
valueType | ValueType | Um campo definido como ValueType.IMAGE , representando o tipo de valor da imagem. |
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | CellImage | Cria o tipo de valor da imagem necessário para adicionar uma imagem a uma célula. |
getAltTextDescription() | String | Retorna a descrição de texto alternativo desta imagem. |
getAltTextTitle() | String | Retorna o título do texto alternativo desta imagem. |
getContentUrl() | String | Retorna um URL hospedado pelo Google para a imagem. |
getUrl() | String | Recebe o URL de origem da imagem. Retorna null se o URL não estiver disponível. |
setAltTextDescription(description) | CellImage | Define a descrição do texto alternativo desta imagem. |
setAltTextTitle(title) | CellImage | Define o título do texto alternativo para esta imagem. |
setSourceUrl(url) | CellImageBuilder | Define o URL de origem da imagem. |
toBuilder() | CellImageBuilder | Cria um builder que transforma uma imagem em um tipo de valor de imagem para que você possa colocá-la em uma célula. |
Documentação detalhada
build()
Cria o tipo de valor da imagem necessário para adicionar uma imagem a uma célula. O valor da imagem é criado com base nas propriedades de imagem adicionadas ao builder, como o URL de origem.
Retornar
CellImage
: uma representação da imagem a ser adicionada a uma célula.
getAltTextDescription()
Retorna a descrição de texto alternativo desta imagem.
Retornar
String
: a descrição do texto alternativo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAltTextTitle()
Retorna o título do texto alternativo desta imagem.
Retornar
String
: o título do texto alternativo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getContentUrl()
Retorna um URL hospedado pelo Google para a imagem. Esse URL é marcado com a conta do solicitante. Assim, qualquer pessoa com o URL acessa a imagem como o solicitante original. O acesso à imagem poderá ser perdido se as configurações de compartilhamento da planilha mudarem. O URL retornado expira após um curto período.
Retornar
String
: o URL hospedado pela Google da imagem.
getUrl()
Recebe o URL de origem da imagem. Retorna null
se o URL não estiver disponível. Se a imagem tiver sido inserida pelo URL usando uma API, esse método retornará o URL fornecido durante a inserção da imagem.
Retornar
String
: o URL da imagem, se disponível. Retorna null
se a imagem não está disponível ou não tem um URL de origem.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAltTextDescription(description)
Define a descrição do texto alternativo desta imagem.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
description | String | A nova descrição do texto alternativo da imagem. |
Retornar
CellImage
: esta imagem, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAltTextTitle(title)
Define o título do texto alternativo para esta imagem.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | O novo título do texto alternativo da imagem. |
Retornar
CellImage
: esta imagem, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSourceUrl(url)
Define o URL de origem da imagem.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
url | String | URL da imagem. |
Retornar
CellImageBuilder
: este builder, para encadeamento.
toBuilder()
Cria um builder que transforma uma imagem em um tipo de valor de imagem para que você possa colocá-la em uma
célula. Antes de ser colocada em uma célula, a imagem precisa ser criada como um tipo de valor de imagem.
Depois, você pode adicioná-lo a uma célula usando Range.setValue(value)
ou Range.setValues(values)
.
Retornar
CellImageBuilder
: um builder que cria um tipo de valor de imagem com base nas propriedades de imagem fornecidas.