Class Drawing

Dessin

Représente un dessin sur une feuille d'une feuille de calcul.

Méthodes

MéthodeType renvoyéBrève description
getContainerInfo()ContainerInfoRécupère des informations sur l'emplacement du dessin dans la feuille.
getHeight()IntegerRenvoie la hauteur réelle de ce dessin en pixels.
getOnAction()StringRenvoie le nom de la macro associée à ce dessin.
getSheet()SheetAffiche la feuille sur laquelle ce dessin apparaît.
getWidth()IntegerRenvoie la largeur réelle de ce dessin en pixels.
getZIndex()NumberRenvoie le z-index 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 du dessin 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()

Récupère des informations sur l'emplacement du dessin dans la feuille.

Aller-retour

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

Aller-retour

Integer : hauteur du dessin en pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getOnAction());
}

Aller-retour

String : 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 champs d'application suivants :

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

getSheet()

Affiche la feuille sur laquelle ce dessin apparaît.

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

Aller-retour

Sheet : feuille dans laquelle le dessin apparaît.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getWidth());
}

Aller-retour

Integer : largeur du dessin en pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

getZIndex()

Renvoie le z-index de ce dessin.

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

Aller-retour

Number : z-index de ce dessin.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var 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 champs d'application 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.

Aller-retour

Drawing : ce dessin est enchaîné.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

Aller-retour

Drawing : ce dessin est enchaîné.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Définit la position du dessin sur la feuille. Les indices de position des lignes et des colonnes d'ancrage sont indexés sur 1.

Paramètres

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

Aller-retour

Drawing : ce dessin est enchaîné.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

Aller-retour

Drawing : ce dessin est enchaîné.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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
zIndexNumberz-index de ce dessin.

Aller-retour

Drawing : ce dessin est enchaîné.