Class Drawing

Dessin

Représente un dessin sur une feuille de calcul.

Méthodes

MéthodeType renvoyéBrève description
getContainerInfo()ContainerInfoObtient des informations sur la position du dessin dans la feuille.
getHeight()IntegerRenvoie la hauteur réelle de ce dessin en pixels.
getOnAction()String|nullRenvoie le nom de la macro associée à ce dessin.
getSheet()SheetRenvoie la feuille sur laquelle ce dessin apparaît.
getWidth()IntegerRenvoie la largeur réelle de ce dessin en pixels.
getZIndex()NumberRenvoie l'index Z de ce dessin.
remove()voidSupprime ce dessin de la feuille de calcul.
setHeight(height)DrawingDéfinit la hauteur réelle de ce dessin en pixels.
setOnAction(macroName)DrawingAttribue une fonction de macro à ce dessin.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)DrawingDéfinit la position où le dessin apparaît sur la feuille.
setWidth(width)DrawingDéfinit la largeur réelle de ce dessin en pixels.
setZIndex(zIndex)DrawingDéfinit le z-index de ce dessin.

Documentation détaillée

getContainerInfo()

Obtient des informations sur la position du dessin dans la feuille.

Renvois

ContainerInfo : objet contenant la position du conteneur du dessin.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getHeight()

Renvoie la hauteur réelle de ce dessin en 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());
}

Renvois

Integer : hauteur du dessin en pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getOnAction()

Renvoie le nom de la macro associée à ce dessin. 

// 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());
}

Renvois

String|null : nom de la macro associée à ce dessin.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheet()

Renvoie la feuille sur laquelle ce dessin apparaît. 

// 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());
}

Renvois

Sheet : feuille sur laquelle le dessin apparaît.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getWidth()

Renvoie la largeur réelle de ce dessin en 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());
}

Renvois

Integer : largeur du dessin en pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getZIndex()

Renvoie l'index Z de ce dessin. 

// 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());
}

Renvois

Number : z-index de ce dessin.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

Supprime ce dessin de la feuille de calcul. Toute autre opération sur le dessin entraîne une erreur 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();
}

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setHeight(height)

Définit la hauteur réelle de ce dessin en pixels.

Paramètres

NomTypeDescription
heightIntegerHauteur souhaitée en pixels.

Renvois

Drawing : ce dessin, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setOnAction(macroName)

Attribue une fonction de macro à ce dessin.

Paramètres

NomTypeDescription
macroNameStringNom de la fonction de macro.

Renvois

Drawing : ce dessin, pour le chaînage.

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Définit la position où le dessin apparaît sur la feuille. Les indices de position de la ligne et de la colonne d'ancrage sont indexés à partir de 1.

Paramètres

NomTypeDescription
anchorRowPosIntegerLe haut du dessin est ancré dans cette ligne.
anchorColPosIntegerLe haut du dessin est ancré dans cette colonne.
offsetXIntegerDécalage horizontal par rapport à l'angle de la cellule, en pixels.
offsetYIntegerDécalage vertical par rapport à l'angle de la cellule, en pixels.

Renvois

Drawing : ce dessin, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWidth(width)

Définit la largeur réelle de ce dessin en pixels.

Paramètres

NomTypeDescription
widthIntegerLargeur souhaitée en pixels.

Renvois

Drawing : ce dessin, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setZIndex(zIndex)

Définit le z-index de ce dessin.

Paramètres

NomTypeDescription
zIndexNumberIndex Z de ce dessin.

Renvois

Drawing : ce dessin, pour le chaînage.