Class CellImage

CelluleImage

Représente une valeur d'image dans une cellule. Pour ajouter une image à une cellule, vous devez créer une valeur d'image pour l'image à l'aide de SpreadsheetApp.newCellImage() et CellImageBuilder. Vous pouvez ensuite utiliser Range.setValue(value) ou Range.setValues(values) pour ajouter la valeur de l'image à la cellule.

Propriétés

PropriétéTypeDescription
valueTypeValueTypeType de valeur de l'image de la cellule, qui est ValueType.IMAGE.

Méthodes

MéthodeType renvoyéBrève description
getAltTextDescription()StringRenvoie la description du texte alternatif de cette image.
getAltTextTitle()StringRenvoie le titre du texte alternatif de cette image.
getContentUrl()StringRenvoie une URL hébergée par Google vers l'image.
toBuilder()CellImageBuilderCrée un outil de création d'images de cellule en fonction des propriétés d'image actuelles.

Documentation détaillée

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

getContentUrl()

Renvoie une URL hébergée par Google vers l'image. Cette URL est taguée avec le compte de la personne à l'origine de la demande. Par conséquent, toute personne disposant de l'URL accède à l'image en tant que personne à l'origine de la demande. L'accès à l'image peut être perdu si les paramètres de partage de la feuille de calcul changent. L'URL renvoyée expire au bout d'un court laps de temps. 

const range = SpreadsheetApp.getActiveSpreadsheet().getRange("Sheet1!A1");
const value = range.getValue();
if (value.valueType == SpreadsheetApp.ValueType.IMAGE) {
  console.log(value.getContentUrl());
}

Renvois

String : URL de l'image hébergée par Google.

toBuilder()

Crée un outil de création d'images de cellule en fonction des propriétés d'image actuelles. Utilisez CellImageBuilder.setSourceUrl(url) pour définir l'URL source de la nouvelle image. Vous pouvez ensuite l'ajouter à une cellule à l'aide de Range.setValue(value) ou de Range.setValues(values). 

const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange("Sheet1!A1");
const value = range.getValue();
if (value.valueType == SpreadsheetApp.ValueType.IMAGE) {
  const newImage =
      value.toBuilder()
          .setSourceUrl(
              'https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png',
              )
          .build();
  const newRange = ss.getRange("Sheet1!A2");
  newRange.setValue(newImage);
}

Renvois

CellImageBuilder : compilateur qui crée un type de valeur d'image en fonction des propriétés d'image données.

Méthodes obsolètes