Class OverGridImage

SobreGradeImagem

Representa uma imagem sobre a grade em uma planilha.

Métodos

MétodoTipo de retornoBreve descrição
assignScript(functionName)OverGridImageAtribui a função com o nome especificado a esta imagem.
getAltTextDescription()StringRetorna a descrição do texto alternativo para essa imagem.
getAltTextTitle()StringRetorna o título do texto alternativo para essa imagem.
getAnchorCell()RangeRetorna a célula em que uma imagem está ancorada.
getAnchorCellXOffset()IntegerRetorna o deslocamento horizontal em pixels da célula de âncora.
getAnchorCellYOffset()IntegerRetorna o deslocamento vertical em pixels da célula de âncora.
getHeight()IntegerRetorna a altura real da imagem em pixels.
getInherentHeight()IntegerRetorna a altura inerente dessa imagem em pixels.
getInherentWidth()IntegerRetorna a altura inerente dessa imagem em pixels.
getScript()StringRetorna o nome da função atribuída a esta imagem.
getSheet()SheetRetorna a planilha em que a imagem aparece.
getWidth()IntegerRetorna a largura real da imagem em pixels.
remove()voidExclui essa imagem da planilha.
replace(blob)OverGridImageSubstitui esta imagem pela especificada pelo BlobSource fornecido.
replace(url)OverGridImageSubstitui esta imagem pela do URL especificado.
resetSize()OverGridImageRedefine a imagem para as dimensões inerentes.
setAltTextDescription(description)OverGridImageDefine a descrição do texto alternativo para essa imagem.
setAltTextTitle(title)OverGridImageDefine o título do texto alternativo para essa imagem.
setAnchorCell(cell)OverGridImageDefine a célula em que uma imagem está ancorada.
setAnchorCellXOffset(offset)OverGridImageDefine o deslocamento horizontal de pixels da célula de âncora.
setAnchorCellYOffset(offset)OverGridImageDefine o deslocamento vertical em pixels da célula de âncora.
setHeight(height)OverGridImageDefine a altura real da imagem em pixels.
setWidth(width)OverGridImageDefine a largura real da imagem em pixels.

Documentação detalhada

assignScript(functionName)

Atribui a função com o nome especificado a esta imagem.

Parâmetros

NomeTipoDescrição
functionNameStringO nome da função especificada. Ela precisa ser uma função pública de nível superior, não uma que termine em sublinhado, como privateFunction_.

Retornar

OverGridImage: 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

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

getAnchorCell()

Retorna a célula em que uma imagem está ancorada.

Retornar

Range: a célula âncora.

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

getAnchorCellXOffset()

Retorna o deslocamento horizontal em pixels da célula de âncora.

Retornar

Integer: o deslocamento horizontal em pixels.

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

getAnchorCellYOffset()

Retorna o deslocamento vertical em pixels da célula de âncora.

Retornar

Integer: o deslocamento vertical em pixels.

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

getHeight()

Retorna a altura real da imagem em pixels. 

// Logs the height of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getHeight());
}

Retornar

Integer: a altura da imagem em pixels.

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

getInherentHeight()

Retorna a altura inerente dessa imagem em pixels.

Retornar

Integer: a altura inerente em pixels.

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

getInherentWidth()

Retorna a altura inerente dessa imagem em pixels.

Retornar

Integer: a largura inerente em pixels.

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

getScript()

Retorna o nome da função atribuída a esta imagem.

Retornar

String: o nome da função.

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

getSheet()

Retorna a planilha em que a imagem aparece. 

// Logs the parent sheet of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getSheet());
}

Retornar

Sheet: a página em que a imagem aparece.

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

getWidth()

Retorna a largura real da imagem em pixels. 

// Logs the width of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getWidth());
}

Retornar

Integer: a largura da imagem em pixels.

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

remove()

Exclui essa imagem da planilha. Qualquer outra operação na imagem resulta em um erro de script. 

// Deletes all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  images[i].remove();
}

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

replace(blob)

Substitui esta imagem pela especificada pelo BlobSource fornecido. O tamanho máximo do blob aceito é 2 MB.

Parâmetros

NomeTipoDescrição
blobBlobSourceA nova imagem como um blob.

Retornar

OverGridImage: 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

replace(url)

Substitui esta imagem pela do URL especificado.

Parâmetros

NomeTipoDescrição
urlStringO URL da nova imagem.

Retornar

OverGridImage: 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

resetSize()

Redefine a imagem para as dimensões inerentes.

Retornar

OverGridImage: 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

setAltTextDescription(description)

Define a descrição do texto alternativo para essa imagem.

Parâmetros

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

Retornar

OverGridImage: 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

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

Retornar

OverGridImage: 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

setAnchorCell(cell)

Define a célula em que uma imagem está ancorada.

Parâmetros

NomeTipoDescrição
cellRangeA nova célula de âncora.

Retornar

OverGridImage: 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

setAnchorCellXOffset(offset)

Define o deslocamento horizontal de pixels da célula de âncora.

Parâmetros

NomeTipoDescrição
offsetIntegerO novo deslocamento horizontal em pixels.

Retornar

OverGridImage: 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

setAnchorCellYOffset(offset)

Define o deslocamento vertical em pixels da célula de âncora.

Parâmetros

NomeTipoDescrição
offsetIntegerO novo deslocamento vertical em pixels.

Retornar

OverGridImage: 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

setHeight(height)

Define a altura real da imagem em pixels.

Parâmetros

NomeTipoDescrição
heightIntegerA altura desejada em pixels.

Retornar

OverGridImage: a 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

setWidth(width)

Define a largura real da imagem em pixels.

Parâmetros

NomeTipoDescrição
widthIntegerA largura desejada em pixels.

Retornar

OverGridImage: a 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

Métodos obsoletos