Class OverGridImage

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Imagem em grade

Representa uma imagem na grade de uma planilha.

Métodos

MétodoTipo de retornoBreve descrição
assignScript(functionName)OverGridImageAtribui a função com o nome de função especificado a esta imagem.
getAltTextDescription()StringRetorna a descrição de texto alternativo desta imagem.
getAltTextTitle()StringRetorna o título do texto alternativo desta imagem.
getAnchorCell()RangeRetorna a célula em que uma imagem está fixada.
getAnchorCellXOffset()IntegerRetorna o deslocamento horizontal de pixels da célula âncora.
getAnchorCellYOffset()IntegerRetorna o deslocamento vertical do pixel da célula âncora.
getHeight()IntegerRetorna a altura real da imagem em pixels.
getInherentHeight()IntegerRetorna a altura inerente da imagem em pixels.
getInherentWidth()IntegerRetorna a altura inerente da imagem em pixels.
getScript()StringRetorna o nome da função atribuída a esta imagem.
getSheet()SheetRetorna a página em que esta imagem aparece.
getUrl()StringRecebe o URL de origem da imagem. Retorna null se o URL não estiver disponível.
getWidth()IntegerRetorna a largura real da imagem em pixels.
remove()voidExclui esta imagem da planilha.
replace(blob)OverGridImageSubstitui essa imagem pela especificada pelo BlobSource fornecido.
replace(url)OverGridImageSubstitui essa imagem pela do URL especificado.
resetSize()OverGridImageRedefine esta imagem para as dimensões inerentes.
setAltTextDescription(description)OverGridImageDefine a descrição do texto alternativo desta imagem.
setAltTextTitle(title)OverGridImageDefine o título do texto alternativo para esta imagem.
setAnchorCell(cell)OverGridImageDefine a célula em que uma imagem está fixada.
setAnchorCellXOffset(offset)OverGridImageDefine o deslocamento horizontal do pixel da célula âncora.
setAnchorCellYOffset(offset)OverGridImageDefine o deslocamento do pixel vertical da célula â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 de função especificado a esta imagem.

Parâmetros

NomeTipoDescrição
functionNameStringNome da função que está sendo especificada. Essa função precisa ser de nível superior público, e 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 de texto alternativo desta 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 desta 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á fixada.

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 de pixels da célula âncora.

Retornar

Integer: o deslocamento horizontal do pixel.

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 do pixel da célula âncora.

Retornar

Integer: o deslocamento vertical do pixel.

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
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var 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 da 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 da 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 página em que esta imagem aparece.

// Logs the parent sheet of all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var 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

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.

Retornar

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

getWidth()

Retorna a largura real da imagem em pixels.

// Logs the width of all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var 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 esta imagem da planilha. Qualquer outra operação na imagem resulta em um erro de script.

// Deletes all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var 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 essa imagem pela especificada pelo BlobSource fornecido. O tamanho máximo permitido do blob é 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 essa imagem pela do URL especificado.

Parâmetros

NomeTipoDescrição
urlStringURL 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 esta 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 desta 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 esta 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á fixada.

Parâmetros

NomeTipoDescrição
cellRangeA nova célula â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 do pixel da célula âncora.

Parâmetros

NomeTipoDescrição
offsetIntegerO novo deslocamento de pixel horizonal.

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 do pixel vertical da célula âncora.

Parâmetros

NomeTipoDescrição
offsetIntegerO novo deslocamento vertical do pixel.

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
heightIntegerÉ a altura desejada em pixels.

Retornar

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