Class Drawing

Desenho

Representa um desenho em uma página de uma planilha.

Métodos

Método	Tipo de retorno	Breve descrição
getContainerInfo()	ContainerInfo	Recebe informações sobre onde o desenho está posicionado na página.
getHeight()	Integer	Retorna a altura real desse desenho em pixels.
getOnAction()	String|null	Retorna o nome da macro anexada a esse desenho.
getSheet()	Sheet	Retorna a página em que esse desenho aparece.
getWidth()	Integer	Retorna a largura real desse desenho em pixels.
getZIndex()	Number	Retorna o z-index desse desenho.
remove()	void	Exclui esse desenho da planilha.
setHeight(height)	Drawing	Define a altura real desse desenho em pixels.
setOnAction(macroName)	Drawing	Atribui uma função de macro a esse desenho.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	Drawing	Define a posição em que o desenho aparece na página.
setWidth(width)	Drawing	Define a largura real desse desenho em pixels.
setZIndex(zIndex)	Drawing	Define o z-index desse desenho.

Documentação detalhada

getContainerInfo()

Recebe informações sobre onde o desenho está posicionado na página.

Retornar

ContainerInfo — Um objeto que contém a posição do contêiner do desenho.

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 desse desenho em pixels.

// Logs the height of all drawings in a sheet
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getHeight());
}

Retornar

Integer — A altura do desenho 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

---

getOnAction()

Retorna o nome da macro anexada a esse desenho.

// Logs the macro name of all drawings on the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getOnAction());
}

Retornar

String|null — O nome da macro anexada a esse desenho.

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 esse desenho aparece.

// Logs the parent sheet of all drawings on the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getSheet());
}

Retornar

Sheet — A página em que o desenho 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 desse desenho em pixels.

// Logs the width of all drawings in a sheet
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getWidth());
}

Retornar

Integer — A largura do desenho 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

---

getZIndex()

Retorna o z-index desse desenho.

// Logs the z-index of all drawings on the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getZIndex());
}

Retornar

Number — Z-index desse desenho.

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 esse desenho da planilha. Qualquer outra operação no desenho resulta em um erro de script.

// Deletes all drawings from the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  drawings[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

---

setHeight(height)

Define a altura real desse desenho em pixels.

Parâmetros

Nome	Tipo	Descrição
height	Integer	A altura desejada em pixels.

Retornar

Drawing — Esse desenho, 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

---

setOnAction(macroName)

Atribui uma função de macro a esse desenho.

Parâmetros

Nome	Tipo	Descrição
macroName	String	Nome da função de macro.

Retornar

Drawing — Esse desenho, para encadeamento.

---

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Define a posição em que o desenho aparece na página. Os índices de posição da linha e da coluna de ancoragem são indexados em 1.

Parâmetros

Nome	Tipo	Descrição
anchorRowPos	Integer	O lado superior do desenho está ancorado nessa linha.
anchorColPos	Integer	O lado superior do desenho está ancorado nessa coluna.
offsetX	Integer	O deslocamento horizontal do canto da célula em pixels.
offsetY	Integer	O deslocamento vertical do canto da célula em pixels.

Retornar

Drawing — Esse desenho, 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 desse desenho em pixels.

Parâmetros

Nome	Tipo	Descrição
width	Integer	A largura desejada em pixels.

Retornar

Drawing — Esse desenho, 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

---

setZIndex(zIndex)

Define o z-index desse desenho.

Parâmetros

Nome	Tipo	Descrição
zIndex	Number	Z-index desse desenho.

Retornar

Drawing — Esse desenho, para encadeamento.