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

Class OverGridImage

Représente une image sur la grille d'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 pour cette image.
`getAltTextTitle()`	`String`	Affiche le titre du texte alternatif pour cette image.
`getAnchorCell()`	`Range`	Renvoie la cellule dans laquelle une image est ancrée.
`getAnchorCellXOffset()`	`Integer`	Renvoie le décalage horizontal en pixels de la cellule d'ancrage.
`getAnchorCellYOffset()`	`Integer`	Renvoie le décalage vertical en pixels de la cellule d'ancrage.
`getHeight()`	`Integer`	Renvoie la hauteur réelle de cette image, en pixels.
`getInherentHeight()`	`Integer`	Renvoie la hauteur intrinsèque de cette image, en pixels.
`getInherentWidth()`	`Integer`	Renvoie la hauteur intrinsèque de cette image, en pixels.
`getScript()`	`String`	Renvoie le nom de la fonction attribuée à cette image.
`getSheet()`	`Sheet`	Affiche la feuille sur laquelle cette image apparaît.
`getUrl()`	`String`	Récupère l'URL source de l'image. Renvoie `null` si l'URL n'est pas disponible.
`getWidth()`	`Integer`	Renvoie la largeur réelle de l'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 le `BlobSource` fourni.
`replace(url)`	`OverGridImage`	Remplace cette image par celle de l'URL spécifiée.
`resetSize()`	`OverGridImage`	Réinitialise cette image dans son format standard.
`setAltTextDescription(description)`	`OverGridImage`	Définit la description du texte alternatif pour cette image.
`setAltTextTitle(title)`	`OverGridImage`	Définit le titre du texte alternatif pour cette image.
`setAnchorCell(cell)`	`OverGridImage`	Définit la cellule dans laquelle une image est ancrée.
`setAnchorCellXOffset(offset)`	`OverGridImage`	Définit le décalage horizontal en pixels de la cellule d'ancrage.
`setAnchorCellYOffset(offset)`	`OverGridImage`	Définit le décalage du pixel vertical par rapport à la cellule d'ancrage.
`setHeight(height)`	`OverGridImage`	Définit la hauteur réelle de l'image en pixels.
`setWidth(width)`	`OverGridImage`	Définit la largeur réelle de l'image, en pixels.

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 publique de niveau supérieur, et non d'un trait de soulignement comme `privateFunction_`.

Aller-retour

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 pour cette image.

Aller-retour

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

Affiche le titre du texte alternatif pour cette image.

Aller-retour

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.

Aller-retour

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 de la cellule d'ancrage.

Aller-retour

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 de la cellule d'ancrage.

Aller-retour

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
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var i = 0; i < images.length; i++) {
  Logger.log(images[i].getHeight());
}

Aller-retour

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 intrinsèque de cette image, en pixels.

Aller-retour

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 intrinsèque de cette image, en pixels.

Aller-retour

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.

Aller-retour

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

Affiche la feuille sur laquelle cette image apparaît.

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

Aller-retour

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

`getUrl()`

Récupère l'URL source de l'image. Renvoie null si l'URL n'est pas disponible. Si l'image a été insérée via une API à l'aide d'une API, cette méthode renvoie l'URL fournie lors de l'insertion de l'image.

Aller-retour

String : URL de l'image si celle-ci est disponible. Renvoie null si l'image n'est pas disponible ou ne possède pas d'URL source.

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 l'image, en pixels.

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

Aller-retour

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
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var 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 le BlobSource fourni. La taille maximale d'un blob est de 2 Mo.

Paramètres

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

Aller-retour

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.

Aller-retour

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éinitialise cette image dans son format standard.

Aller-retour

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 pour l'image.

Aller-retour

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 pour cette image.

Paramètres

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

Aller-retour

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 dans laquelle une image est ancrée.

Paramètres

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

Aller-retour

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 de la cellule d'ancrage.

Paramètres

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

Aller-retour

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 du pixel vertical par rapport à la cellule d'ancrage.

Paramètres

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

Aller-retour

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

Paramètres

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

Aller-retour

OverGridImage : image de chaîne

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 l'image, en pixels.

Paramètres

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

Aller-retour

OverGridImage : image de chaîne

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