Representa uma imagem sobre a grade em uma planilha.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
assignScript(functionName) | OverGridImage | Atribui a função com o nome especificado à imagem. |
getAltTextDescription() | String | Retorna a descrição do texto alternativo para esta imagem. |
getAltTextTitle() | String | Retorna o título do texto alternativo para esta imagem. |
getAnchorCell() | Range | Retorna a célula em que uma imagem está ancorada. |
getAnchorCellXOffset() | Integer | Retorna o deslocamento de pixel horizontal da célula âncora. |
getAnchorCellYOffset() | Integer | Retorna o deslocamento de pixels verticais da célula âncora. |
getHeight() | Integer | Retorna a altura real desta imagem em pixels. |
getInherentHeight() | Integer | Retorna a altura inerente desta imagem em pixels. |
getInherentWidth() | Integer | Retorna a altura inerente desta imagem em pixels. |
getScript() | String | Retorna o nome da função atribuída a essa imagem. |
getSheet() | Sheet | Retorna a página em que a imagem aparece. |
getUrl() | String | Recebe o URL de origem da imagem. Retorna null se o URL não estiver disponível. |
getWidth() | Integer | Retorna a largura real dessa imagem em pixels. |
remove() | void | Exclui essa imagem da planilha. |
replace(blob) | OverGridImage | Substitui essa imagem pela especificada pelo BlobSource fornecido. |
replace(url) | OverGridImage | Substitui esta imagem pela do URL especificado. |
resetSize() | OverGridImage | Redefine a imagem com as dimensões inerentes. |
setAltTextDescription(description) | OverGridImage | Define a descrição do texto alternativo para a imagem. |
setAltTextTitle(title) | OverGridImage | Define o título do texto alternativo para a imagem. |
setAnchorCell(cell) | OverGridImage | Define a célula em que uma imagem está ancorada. |
setAnchorCellXOffset(offset) | OverGridImage | Define o deslocamento horizontal dos pixels a partir da célula âncora. |
setAnchorCellYOffset(offset) | OverGridImage | Define o deslocamento de pixels verticais a partir da célula âncora. |
setHeight(height) | OverGridImage | Define a altura real desta imagem em pixels. |
setWidth(width) | OverGridImage | Define a largura real dessa imagem em pixels. |
Documentação detalhada
assignScript(functionName)
Atribui a função com o nome especificado à imagem.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
functionName | String | Nome da função especificada. Precisa ser uma função pública de nível
superior, não uma que termine em sublinhado, como privateFunction_ . |
Retorno
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 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
getAnchorCell()
getAnchorCellXOffset()
Retorna o deslocamento de pixel horizontal da célula âncora.
Retorno
Integer
: o deslocamento horizontal dos 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 de pixels verticais da célula âncora.
Retorno
Integer
: o deslocamento vertical dos 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 desta 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()); }
Retorno
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 desta imagem em pixels.
Retorno
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 desta imagem em pixels.
Retorno
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 essa imagem.
Retorno
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 a 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()); }
Retorno
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.
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
getWidth()
Retorna a largura real dessa 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()); }
Retorno
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 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 de blob com suporte é 2 MB.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
blob | BlobSource | A nova imagem como um Blob. |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
url | String | O URL da nova imagem. |
Retorno
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 com as dimensões inerentes.
Retorno
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 a imagem.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
description | String | A nova descrição do texto alternativo para a imagem. |
Retorno
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 a imagem.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | O novo título do texto alternativo para a imagem. |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
cell | Range | A nova célula âncora. |
Retorno
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 dos pixels a partir da célula âncora.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | O novo deslocamento de pixel horizontal. |
Retorno
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 de pixels verticais a partir da célula âncora.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | O novo deslocamento vertical de pixels. |
Retorno
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 desta imagem em pixels.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
height | Integer | A altura desejada em pixels. |
Retorno
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 dessa imagem em pixels.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
width | Integer | A largura desejada em pixels. |
Retorno
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