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 à cette image la fonction avec le nom de fonction spécifié.
`getAltTextDescription()`	`String`	Affiche la description du texte alternatif pour cette image.
`getAltTextTitle()`	`String`	Affiche le titre du texte alternatif pour cette image.
`getAnchorCell()`	`Range`	Affiche la cellule dans laquelle une image est ancrée.
`getAnchorCellXOffset()`	`Integer`	Renvoie le décalage de pixels horizontal à partir de la cellule d'ancrage.
`getAnchorCellYOffset()`	`Integer`	Renvoie le décalage de pixels vertical à partir de la cellule d'ancrage.
`getHeight()`	`Integer`	Renvoie la hauteur réelle de cette image en pixels.
`getInherentHeight()`	`Integer`	Renvoie la hauteur inhérente à cette image en pixels.
`getInherentWidth()`	`Integer`	Renvoie la hauteur inhérente à 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 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 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'élément `BlobSource` fourni.
`replace(url)`	`OverGridImage`	Remplace cette image par celle de l'URL spécifiée.
`resetSize()`	`OverGridImage`	Réinitialise l'image à ses dimensions inhérentes.
`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 de pixels horizontal par rapport à la cellule d'ancrage.
`setAnchorCellYOffset(offset)`	`OverGridImage`	Définit le décalage vertical des 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.

Documentation détaillée

`assignScript(functionName)`

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

Paramètres

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

Renvois

OverGridImage : cette image, utilisée pour le chaînage.

Autorisation

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

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

`getAltTextDescription()`

Affiche la description du texte alternatif pour cette image.

Renvois

String : texte alternatif descriptif.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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.

Renvois

String : titre du texte alternatif.

Autorisation

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

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

`getAnchorCell()`

Affiche 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 correspondant à 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 de pixels horizontal à partir de la cellule d'ancrage.

Renvois

Integer : décalage de pixels horizontal.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 de pixels vertical à partir de la cellule d'ancrage.

Renvois

Integer : décalage vertical des pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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());
}

Renvois

Integer : hauteur de l'image en pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 à cette image en pixels.

Renvois

Integer : hauteur inhérente en pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 à cette image en pixels.

Renvois

Integer : largeur inhérente en pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 correspondant à 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 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());
}

Renvois

Sheet : feuille sur laquelle l'image apparaît.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 était insérée par une URL à l'aide d'une API, cette méthode renvoie l'URL fournie lors de l'insertion de l'image.

Renvois

String : URL de l'image, si disponible renvoie null si l'image n'est pas disponible ou n'est pas ont une URL source.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var 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 correspondant à 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 génère un 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 correspondant à 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'élément BlobSource fourni. La valeur la taille de blob acceptée est de 2 Mo.

Paramètres

Nom	Type	Description
`blob`	`BlobSource`	Nouvelle image en tant qu'objet Blob.

Renvois

OverGridImage : cette image, utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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, utilisée pour le chaînage.

Autorisation

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

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

`resetSize()`

Réinitialise l'image à ses dimensions inhérentes.

Renvois

OverGridImage : cette image, utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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.

Renvois

OverGridImage : cette image, utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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`	Nouveau titre du texte alternatif pour l'image.

Renvois

OverGridImage : cette image, utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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.

Renvois

OverGridImage : cette image, utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 de pixels horizontal par rapport à la cellule d'ancrage.

Paramètres

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

Renvois

OverGridImage : cette image, utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 des pixels par rapport à la cellule d'ancrage.

Paramètres

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

Renvois

OverGridImage : cette image, utilisée pour le chaînage.

Autorisation

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

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