Cette page a été traduite par l'API Cloud Translation.

Class Drawing

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

Méthodes

Méthode	Type renvoyé	Brève description
`getContainerInfo()`	`ContainerInfo`	Obtient des informations sur l'emplacement du dessin dans la feuille.
`getHeight()`	`Integer`	Renvoie la hauteur réelle de ce dessin, en pixels.
`getOnAction()`	`String`	Renvoie le nom de la macro associée à ce dessin.
`getSheet()`	`Sheet`	Renvoie la feuille sur laquelle s'affiche ce dessin.
`getWidth()`	`Integer`	Renvoie la largeur réelle de ce dessin en pixels.
`getZIndex()`	`Number`	Renvoie l'indice Z de ce dessin.
`remove()`	`void`	Supprime ce dessin de la feuille de calcul.
`setHeight(height)`	`Drawing`	Définit la hauteur réelle de ce dessin en pixels.
`setOnAction(macroName)`	`Drawing`	Attribue une fonction de macro à ce dessin.
`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`	`Drawing`	Définit la position à laquelle le dessin s'affiche sur la feuille.
`setWidth(width)`	`Drawing`	Définit la largeur réelle de ce dessin en pixels.
`setZIndex(zIndex)`	`Drawing`	Définit l'indice z de ce dessin.

Documentation détaillée

`getContainerInfo()`

Obtient des informations sur l'emplacement 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 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
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 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.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getOnAction());
}

Renvois

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()`

Renvoie la feuille sur laquelle s'affiche ce dessin.

// 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 s'affiche.

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

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

`getZIndex()`

Renvoie l'indice 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 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.
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 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

Nom	Type	Description
`height`	`Integer`	Hauteur 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 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

Nom	Type	Description
`macroName`	`String`	Nom de la fonction de macro.

Renvois

Drawing : ce dessin, pour le chaînage.

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

Définit la position à laquelle le dessin s'affiche sur la feuille. Les indices de position de ligne et de colonne d'ancrage sont indexés à 1.

Paramètres

Nom	Type	Description
`anchorRowPos`	`Integer`	Le haut du dessin est ancré sur cette ligne.
`anchorColPos`	`Integer`	La partie supérieure du dessin est ancrée dans cette colonne.
`offsetX`	`Integer`	Décalage horizontal par rapport au coin de la cellule, en pixels.
`offsetY`	`Integer`	Décalage vertical par rapport au coin 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 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

Nom	Type	Description
`width`	`Integer`	Largeur 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 champs d'application suivants:

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

`setZIndex(zIndex)`

Définit l'indice z de ce dessin.

Paramètres

Nom	Type	Description
`zIndex`	`Number`	Z-index de ce dessin.

Renvois

Drawing : ce dessin, pour le chaînage.