Class CellImage

CellImage

Representa um valor de imagem em uma célula. Para adicionar uma imagem a uma célula, crie um novo valor de 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

Propriedade	Tipo	Descrição
valueType	ValueType	O tipo de valor da imagem da célula, que é ValueType.IMAGE.

Métodos

Método	Tipo de retorno	Breve descrição
getAltTextDescription()	String	Retorna a descrição do texto alternativo para essa imagem.
getAltTextTitle()	String	Retorna o título do texto alternativo para essa imagem.
getContentUrl()	String	Retorna um URL hospedado pelo Google para a imagem.
toBuilder()	CellImageBuilder	Cria um builder de imagem de célula com base nas propriedades da imagem atual.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
getUrl()	String	Recebe o URL de origem da imagem.

Documentação detalhada

getAltTextDescription()

Retorna a descrição do texto alternativo para essa 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 para essa 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 pode ser perdido se as configurações de compartilhamento da planilha forem alteradas. O URL retornado expira após um curto período.

const range = SpreadsheetApp.getActiveSpreadsheet().getRange("Sheet1!A1");
const value = range.getValue();
if (value.valueType == SpreadsheetApp.ValueType.IMAGE) {
  console.log(value.getContentUrl());
}

Retornar

String — O URL da imagem hospedado pelo Google.

---

toBuilder()

Cria um builder de imagem de célula com base nas propriedades da imagem atual. Use CellImageBuilder.setSourceUrl(url) para definir o URL de origem da nova imagem. Em seguida, adicione-o a uma célula usando Range.setValue(value) ou 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);
}

Retornar

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

Métodos obsoletos

getUrl()

Obsoleto. Para a maioria das imagens inseridas recentemente, o URL de origem não está disponível.

Recebe o URL de origem da imagem. Retorna uma string vazia se o URL não estiver disponível. Para a maioria das imagens inseridas recentemente, o URL de origem não está disponível, independentemente de como a imagem é inserida.

Retornar

String — O URL de origem da imagem, se disponível. Caso contrário, retorna uma string vazia.

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