Class Drawing

Desenho

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

Métodos

MétodoTipo de retornoBreve descrição
getContainerInfo()ContainerInfoRecebe informações sobre onde o desenho está posicionado na planilha.
getHeight()IntegerRetorna a altura real do desenho em pixels.
getOnAction()String|nullRetorna o nome da macro anexada a este desenho.
getSheet()SheetRetorna a página em que o desenho aparece.
getWidth()IntegerRetorna a largura real do desenho em pixels.
getZIndex()NumberRetorna o z-index deste desenho.
remove()voidExclui o desenho da planilha.
setHeight(height)DrawingDefine a altura real do 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 planilha.
setWidth(width)DrawingDefine a largura real do desenho em pixels.
setZIndex(zIndex)DrawingDefine o z-index deste desenho.

Documentação detalhada

getContainerInfo()

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

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 do 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|null: 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 o 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 do 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 deste 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 o 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 do 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 de macro.

Retornar

Drawing: este desenho, para encadeamento.

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

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

Parâmetros

NomeTipoDescrição
anchorRowPosIntegerA parte de cima do desenho está fixada nessa linha.
anchorColPosIntegerA parte de cima do desenho está fixada 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 do 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 z-index deste desenho.

Parâmetros

NomeTipoDescrição
zIndexNumberO Z-index deste desenho.

Retornar

Drawing: este desenho, para encadeamento.