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

Class OverGridImage

Représente une image superposée à la grille dans une feuille de calcul.

Méthodes

Méthode	Type renvoyé	Brève description
`assignScript(functionName)`	`OverGridImage`	Attribue la fonction portant le nom de fonction spécifié à cette image.
`getAltTextDescription()`	`String`	Renvoie la description du texte alternatif de cette image.
`getAltTextTitle()`	`String`	Renvoie le titre du texte alternatif de cette image.
`getAnchorCell()`	`Range`	Renvoie la cellule dans laquelle une image est ancrée.
`getAnchorCellXOffset()`	`Integer`	Renvoie le décalage horizontal en pixels par rapport à la cellule d'ancrage.
`getAnchorCellYOffset()`	`Integer`	Renvoie le décalage vertical en pixels par rapport à la cellule d'ancrage.
`getHeight()`	`Integer`	Renvoie la hauteur réelle de cette image, en pixels.
`getInherentHeight()`	`Integer`	Renvoie la hauteur inhérente de cette image en pixels.
`getInherentWidth()`	`Integer`	Renvoie la hauteur inhérente de cette image en pixels.
`getScript()`	`String`	Renvoie le nom de la fonction attribuée à cette image.
`getSheet()`	`Sheet`	Renvoie la feuille sur laquelle cette image s'affiche.
`getWidth()`	`Integer`	Renvoie la largeur réelle de cette image en pixels.
`remove()`	`void`	Supprime cette image de la feuille de calcul.
`replace(blob)`	`OverGridImage`	Remplace cette image par celle spécifiée par l'`BlobSource` fourni.
`replace(url)`	`OverGridImage`	Remplace cette image par celle de l'URL spécifiée.
`resetSize()`	`OverGridImage`	Rétablit les dimensions inhérentes de cette image.
`setAltTextDescription(description)`	`OverGridImage`	Définit la description du texte alternatif pour cette image.
`setAltTextTitle(title)`	`OverGridImage`	Définit le titre du texte alternatif de cette image.
`setAnchorCell(cell)`	`OverGridImage`	Définit la cellule à laquelle une image est ancrée.
`setAnchorCellXOffset(offset)`	`OverGridImage`	Définit le décalage horizontal en pixels par rapport à la cellule d'ancrage.
`setAnchorCellYOffset(offset)`	`OverGridImage`	Définit le décalage vertical en pixels par rapport à la cellule d'ancrage.
`setHeight(height)`	`OverGridImage`	Définit la hauteur réelle de cette image, en pixels.
`setWidth(width)`	`OverGridImage`	Définit la largeur réelle de cette image en pixels.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`getUrl()`	`String`	Récupère l'URL source de l'image.

Documentation détaillée

`assignScript(functionName)`

Attribue la fonction portant le nom de fonction spécifié à cette image.

Paramètres

Nom	Type	Description
`functionName`	`String`	Nom de la fonction spécifiée. Il doit s'agir d'une fonction de premier niveau publique, et non d'une fonction se terminant par un trait de soulignement, comme `privateFunction_`.

Renvois

OverGridImage : cette image, 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

`getAltTextDescription()`

Renvoie la description du texte alternatif de cette image.

Renvois

String : description du texte alternatif.

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

`getAltTextTitle()`

Renvoie le titre du texte alternatif de cette image.

Renvois

String : titre du texte alternatif.

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

`getAnchorCell()`

Renvoie la cellule dans laquelle une image est ancrée.

Renvois

Range : cellule d'ancrage.

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

`getAnchorCellXOffset()`

Renvoie le décalage horizontal en pixels par rapport à la cellule d'ancrage.

Renvois

Integer : décalage horizontal 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

`getAnchorCellYOffset()`

Renvoie le décalage vertical en pixels par rapport à la cellule d'ancrage.

Renvois

Integer : décalage vertical 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

`getHeight()`

Renvoie la hauteur réelle de cette image, en pixels.

// Logs the height of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getHeight());
}

Renvois

Integer : hauteur de l'image 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

`getInherentHeight()`

Renvoie la hauteur inhérente de cette image en pixels.

Renvois

Integer : hauteur inhérente 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

`getInherentWidth()`

Renvoie la hauteur inhérente de cette image en pixels.

Renvois

Integer : largeur inhérente 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

`getScript()`

Renvoie le nom de la fonction attribuée à cette image.

Renvois

String : nom de la fonction.

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

// Logs the parent sheet of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getSheet());
}

Renvois

Sheet : feuille sur laquelle l'image 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 cette image en pixels.

// Logs the width of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getWidth());
}

Renvois

Integer : largeur de l'image 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

`remove()`

Supprime cette image de la feuille de calcul. Toute autre opération sur l'image entraîne une erreur de script.

// Deletes all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  images[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

`replace(blob)`

Remplace cette image par celle spécifiée par l'BlobSource fourni. La taille maximale autorisée pour les blobs est de 2 Mo.

Paramètres

Nom	Type	Description
`blob`	`BlobSource`	Nouvelle image sous forme de blob.

Renvois

OverGridImage : cette image, 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

`replace(url)`

Remplace cette image par celle de l'URL spécifiée.

Paramètres

Nom	Type	Description
`url`	`String`	URL de la nouvelle image.

Renvois

OverGridImage : cette image, 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

`resetSize()`

Rétablit les dimensions inhérentes de cette image.

Renvois

OverGridImage : cette image, 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

`setAltTextDescription(description)`

Définit la description du texte alternatif pour cette image.

Paramètres

Nom	Type	Description
`description`	`String`	Nouvelle description du texte alternatif de l'image.

Renvois

OverGridImage : cette image, 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

`setAltTextTitle(title)`

Définit le titre du texte alternatif de cette image.

Paramètres

Nom	Type	Description
`title`	`String`	Nouveau titre du texte alternatif de l'image.

Renvois

OverGridImage : cette image, 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

`setAnchorCell(cell)`

Définit la cellule à laquelle une image est ancrée.

Paramètres

Nom	Type	Description
`cell`	`Range`	Nouvelle cellule d'ancrage.

Renvois

OverGridImage : cette image, 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

`setAnchorCellXOffset(offset)`

Définit le décalage horizontal en pixels par rapport à la cellule d'ancrage.

Paramètres

Nom	Type	Description
`offset`	`Integer`	Nouveau décalage horizontal en pixels.

Renvois

OverGridImage : cette image, 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

`setAnchorCellYOffset(offset)`

Définit le décalage vertical en pixels par rapport à la cellule d'ancrage.

Paramètres

Nom	Type	Description
`offset`	`Integer`	Nouveau décalage vertical en pixels.

Renvois

OverGridImage : cette image, 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

`setHeight(height)`

Définit la hauteur réelle de cette image, en pixels.

Paramètres

Nom	Type	Description
`height`	`Integer`	Hauteur souhaitée en pixels.

Renvois

OverGridImage : image à associer.

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 cette image en pixels.

Paramètres

Nom	Type	Description
`width`	`Integer`	Largeur souhaitée en pixels.

Renvois

OverGridImage : image à associer.

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

Méthodes obsolètes

`getUrl()`

Obsolète. Pour la plupart des images nouvellement insérées, l'URL source n'est pas disponible.

Récupère l'URL source de l'image. Renvoie une chaîne vide si l'URL n'est pas disponible. Pour la plupart des images nouvellement insérées, l'URL source n'est pas disponible, quelle que soit la méthode d'insertion.

Renvois

String : URL source de l'image, le cas échéant. Sinon, renvoie une chaîne vide.

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