Class CellImageBuilder

CellImageBuilder

Builder para a classe CellImage. Ele cria o valor da imagem necessário para adicionar uma imagem a uma célula.

Propriedades

PropriedadeTipoDescrição
valueTypeValueTypeUm campo definido como ValueType.IMAGE, representando o tipo de valor da imagem.

Métodos

MétodoTipo de retornoBreve descrição
build()CellImageCria o tipo de valor de imagem necessário para adicionar uma imagem a uma célula.
getAltTextDescription()StringRetorna a descrição do texto alternativo para esta imagem.
getAltTextTitle()StringRetorna o título do texto alternativo para esta imagem.
getContentUrl()StringRetorna um URL hospedado pelo Google para a imagem.
getUrl()StringRecebe o URL de origem da imagem. Retorna null se o URL não estiver disponível.
setAltTextDescription(description)CellImageDefine a descrição do texto alternativo para a imagem.
setAltTextTitle(title)CellImageDefine o título do texto alternativo para a imagem.
setSourceUrl(url)CellImageBuilderDefine o URL de origem da imagem.
toBuilder()CellImageBuilderCria 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 de imagem necessário para adicionar uma imagem a uma célula. O valor da imagem é criado com base nas propriedades da imagem adicionadas ao criador, como o URL de origem.

Retorno

CellImage: uma representação da imagem a ser adicionada a uma célula.


getAltTextDescription()

Retorna a descrição do texto alternativo para esta imagem.

Retorno

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 para esta imagem.

Retorno

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.

Retorno

String: o URL da imagem hospedado pelo Google.


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.

Retorno

String: o URL da imagem, se disponível. Retorna null se a imagem não estiver disponível ou não tiver 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 para a imagem.

Parâmetros

NomeTipoDescrição
descriptionStringA nova descrição do texto alternativo para a imagem.

Retorno

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 a imagem.

Parâmetros

NomeTipoDescrição
titleStringO novo título do texto alternativo para a imagem.

Retorno

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

NomeTipoDescrição
urlStringO URL da imagem.

Retorno

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 uma imagem ser colocada em uma célula, ela precisa ser criada como um tipo de valor de imagem. Em seguida, é possível adicioná-lo a uma célula usando Range.setValue(value) ou Range.setValues(values).

Retorno

CellImageBuilder: um builder que cria um tipo de valor de imagem com base nas propriedades de imagem fornecidas.