Class Drawing

Desenho

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

Métodos

MétodoTipo de retornoBreve descrição
getContainerInfo()ContainerInfoRecebe informações sobre onde o desenho está posicionado na página.
getHeight()IntegerRetorna a altura real desse desenho em pixels.
getOnAction()StringRetorna o nome da macro anexada a este desenho.
getSheet()SheetRetorna a página em que esse desenho aparece.
getWidth()IntegerRetorna a largura real desse desenho em pixels.
getZIndex()NumberRetorna o índice z desse desenho.
remove()voidExclui esse desenho da planilha.
setHeight(height)DrawingDefine a altura real desse desenho em pixels.
setOnAction(macroName)DrawingAtribui uma função de macro a este desenho.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)DrawingDefine a posição em que o desenho aparece na página.
setWidth(width)DrawingDefine a largura real desse desenho em pixels.
setZIndex(zIndex)DrawingDefine o índice Z 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 este 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: o nome da macro anexada 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.
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 índice z 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 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 esse desenho da planilha. Qualquer outra operação na exibição 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

NomeTipoDescrição
heightIntegerA altura desejada em pixels.

Retornar

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

NomeTipoDescrição
macroNameStringNome da função da macro.

Retornar

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 de linha e coluna de âncora são indexados por 1.

Parâmetros

NomeTipoDescrição
anchorRowPosIntegerA parte de cima do desenho está ancorada nessa linha.
anchorColPosIntegerO lado de cima do desenho está ancorado nessa coluna.
offsetXIntegerO deslocamento horizontal do canto da célula em pixels.
offsetYIntegerO deslocamento vertical do canto da célula em pixels.

Retornar

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

Parâmetros

NomeTipoDescrição
widthIntegerA largura desejada em pixels.

Retornar

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 índice Z desse desenho.

Parâmetros

NomeTipoDescrição
zIndexNumberZ-Index deste desenho.

Retornar

Drawing: este desenho, para encadeamento.