Class CellImageBuilder

Outil de créationd'imagesde cellules

Compilateur pour CellImage. Ce compilateur crée la valeur d'image nécessaire pour ajouter une image à une 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
build()CellImageCrée le type de valeur d'image requis pour ajouter une image à une cellule.
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.
setAltTextDescription(description)CellImageDéfinit la description du texte alternatif pour cette image.
setAltTextTitle(title)CellImageDéfinit le titre du texte alternatif de cette image.
setSourceUrl(url)CellImageBuilderDéfinit l'URL de la source d'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

build()

Crée le type de valeur d'image requis pour ajouter une image à une cellule. La valeur de l'image est créée à partir des propriétés d'image ajoutées au compilateur, telles que l'URL source.

Renvois

CellImage : représentation de l'image à ajouter à une cellule.

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 demandeur d'origine. 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.

setAltTextDescription(description)

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

Paramètres

NomTypeDescription
descriptionStringNouvelle description du texte alternatif de l'image.

Renvois

CellImage : 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

NomTypeDescription
titleStringNouveau titre du texte alternatif de l'image.

Renvois

CellImage : 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

setSourceUrl(url)

Définit l'URL de la source d'image.

Paramètres

NomTypeDescription
urlStringURL de l'image.

Renvois

CellImageBuilder : ce générateur, pour le chaînage.

toBuilder()

Crée un outil de création d'images de cellule en fonction des propriétés d'image actuelles. Utilisez 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