Esta página foi traduzida pela API Cloud Translation.

Class Drawing

Representa um desenho sobre uma página em 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`	Retorna o nome da macro anexada a este 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 este desenho da planilha.
`setHeight(height)`	`Drawing`	Define a altura real deste desenho em pixels.
`setOnAction(macroName)`	`Drawing`	Atribui uma função de macro a este 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 deste desenho em pixels.
`setZIndex(zIndex)`	`Drawing`	Define o Z-index do desenho.

Documentação detalhada

`getContainerInfo()`

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

Retorno

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
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getHeight());
}

Retorno

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 este desenho.

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

Retorno

String: o nome da macro anexado a este 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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getSheet());
}

Retorno

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
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getWidth());
}

Retorno

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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getZIndex());
}

Retorno

Number: índice Z deste 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 este desenho da planilha. Qualquer outra operação no desenho resulta em um erro de script.

// Deletes all drawings from the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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 deste desenho em pixels.

Parâmetros

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

Retorno

Drawing: este 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 este desenho.

Parâmetros

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

Retorno

Drawing: este 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 da âncora são indexados em 1.

Parâmetros

Nome	Tipo	Descrição
`anchorRowPos`	`Integer`	A parte de cima do desenho está ancorada nessa linha.
`anchorColPos`	`Integer`	A parte de cima do desenho está ancorada nesta 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.

Retorno

Drawing: este 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 deste desenho em pixels.

Parâmetros

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

Retorno

Drawing: este 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 do desenho.

Parâmetros

Nome	Tipo	Descrição
`zIndex`	`Number`	Z-Index deste desenho.

Retorno

Drawing: este desenho, para encadeamento.