Class CellImage

CellImage

Representa uma imagem a ser adicionada a uma célula. Para adicionar uma imagem a uma célula, é preciso criar um novo valor de imagem para a imagem usando SpreadsheetApp.newCellImage() e CellImageBuilder. Em seguida, use Range.setValue(value) ou Range.setValues(values) para adicionar o valor da imagem à 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
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.
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

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

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.