Class ImageItem

ImageItem

Élément de mise en page qui affiche une image. Les éléments sont accessibles ou peuvent être créés à partir d'un Form. 

// Open a form by ID and add a new image item
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const img = UrlFetchApp.fetch('https://www.google.com/images/srpr/logo4w.png');
form.addImageItem()
    .setTitle('Google')
    .setHelpText('Google Logo')  // The help text is the image description
    .setImage(img);

Méthodes

MéthodeType renvoyéBrève description
duplicate()ImageItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getAlignment()AlignmentRécupère l'alignement horizontal de l'image.
getHelpText()StringObtient le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
getId()IntegerObtient l'identifiant unique de l'élément.
getImage()BlobRécupère l'image actuellement attribuée à l'élément.
getIndex()IntegerObtient l'index de l'élément parmi tous les éléments du formulaire.
getTitle()StringObtient le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'un SectionHeaderItem).
getType()ItemTypeObtient le type de l'élément, représenté sous la forme d'un ItemType.
getWidth()IntegerRécupère la largeur de l'image en pixels.
setAlignment(alignment)ImageItemDéfinit l'alignement horizontal de l'image.
setHelpText(text)ImageItemDéfinit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
setImage(image)ImageItemDéfinit l'image elle-même.
setTitle(title)ImageItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).
setWidth(width)ImageItemDéfinit la largeur de l'image en pixels.

Documentation détaillée

duplicate()

Crée une copie de cet élément et l'ajoute à la fin du formulaire.

Renvois

ImageItem : un double de ce ImageItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getAlignment()

Récupère l'alignement horizontal de l'image.

Renvois

Alignment : alignement horizontal

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getHelpText()

Obtient le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Renvois

String : texte d'aide ou description de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getId()

Obtient l'identifiant unique de l'élément.

Renvois

Integer : ID de l'article

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getImage()

Récupère l'image actuellement attribuée à l'élément.

Renvois

Blob : données d'image

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getIndex()

Obtient l'index de l'élément parmi tous les éléments du formulaire.

Renvois

Integer : index de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getTitle()

Obtient le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'un SectionHeaderItem).

Renvois

String : titre ou texte d'en-tête de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getType()

Obtient le type de l'élément, représenté sous la forme d'un ItemType.

Renvois

ItemType : type de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getWidth()

Récupère la largeur de l'image en pixels.

Renvois

Integer : largeur en pixels

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setAlignment(alignment)

Définit l'alignement horizontal de l'image.

Paramètres

NomTypeDescription
alignmentAlignmentl'alignement horizontal ;

Renvois

ImageItem : ImageItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setHelpText(text)

Définit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Paramètres

NomTypeDescription
textStringle nouveau texte d'aide ;

Renvois

ImageItem : ImageItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setImage(image)

Définit l'image elle-même.

Paramètres

NomTypeDescription
imageBlobSourceles données d'image.

Renvois

ImageItem : ImageItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setTitle(title)

Définit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).

Paramètres

NomTypeDescription
titleStringle nouveau titre ou texte d'en-tête.

Renvois

ImageItem : ImageItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setWidth(width)

Définit la largeur de l'image en pixels. Seule la largeur de l'image peut être définie. La hauteur est définie automatiquement pour conserver les proportions de l'image.

Paramètres

NomTypeDescription
widthIntegerla largeur en pixels.

Renvois

ImageItem : ImageItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms