Esta página foi traduzida pela API Cloud Translation.

Class CellImageBuilder

Builder para a classe CellImage. Esse builder cria o valor da imagem necessário para adicionar uma imagem a uma 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
`build()`	`CellImage`	Cria o tipo de valor de imagem necessário para adicionar uma imagem a uma célula.
`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.
`setAltTextDescription(description)`	`CellImage`	Define a descrição do texto alternativo para essa imagem.
`setAltTextTitle(title)`	`CellImage`	Define o título do texto alternativo para essa imagem.
`setSourceUrl(url)`	`CellImageBuilder`	Define o URL da origem da imagem.
`toBuilder()`	`CellImageBuilder`	Cria um builder de imagem de célula com base nas propriedades de imagem atuais.

Métodos obsoletos

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

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 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 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 mudarem. 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.

`setAltTextDescription(description)`

Define a descrição do texto alternativo para essa 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 essa 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 da origem da imagem.

Parâmetros

Nome	Tipo	Descrição
`url`	`String`	O URL da imagem.

Retornar

CellImageBuilder: este builder, para encadeamento.

`toBuilder()`

Cria um builder de imagens de célula com base nas propriedades de imagem atuais. Use 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 recém-inseridas, o URL da origem não está disponível.

Consegue o URL de origem da imagem. Retorna uma string vazia se o URL estiver indisponível. Para a maioria das imagens recém inseridas, o URL da origem fica indisponí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