Class CardHeader

En-tête de carte

En-tête d'un Card.

var cardHeader = CardService.newCardHeader()
    .setTitle("Card header title")
    .setSubtitle("Card header subtitle")
    .setImageStyle(CardService.ImageStyle.CIRCLE)
    .setImageUrl("https://image.png");

Méthodes

MéthodeType renvoyéBrève description
setImageAltText(imageAltText)CardHeaderDéfinit le texte de substitution de l'image d'en-tête.
setImageStyle(imageStyle)CardHeaderDéfinit le recadrage de l'icône dans l'en-tête de la fiche.
setImageUrl(imageUrl)CardHeaderDéfinit l'image à utiliser dans l'en-tête en indiquant son URL ou sa chaîne de données.
setSubtitle(subtitle)CardHeaderDéfinit le sous-titre de l'en-tête de la fiche.
setTitle(title)CardHeaderDéfinit le titre de l'en-tête de la fiche.

Documentation détaillée

setImageAltText(imageAltText)

Définit le texte de substitution de l'image d'en-tête.

Paramètres

NomTypeDescription
imageAltTextStringTexte alternatif de l'image d'en-tête.

Aller-retour

CardHeader : cet objet, pour le chaînage


setImageStyle(imageStyle)

Définit le recadrage de l'icône dans l'en-tête de la fiche. La valeur par défaut est "Aucun recadrage". Facultatif.

Paramètres

NomTypeDescription
imageStyleImageStyleParamètre de style.

Aller-retour

CardHeader : cet objet, pour le chaînage


setImageUrl(imageUrl)

Définit l'image à utiliser dans l'en-tête en indiquant son URL ou sa chaîne de données.

L'URL fournie peut être une URL accessible au public ou une chaîne d'image encodée en base64. Le second vous permet de créer une chaîne d'image encodée à partir d'une image de votre Google Drive, puis de la stocker pour une utilisation ultérieure avec setImageUrl(imageUrl). Cette méthode évite que votre module complémentaire n'ait besoin d'accéder à une URL d'image accessible au public:

// The following assumes you have the image to use in Google Drive and have its ID.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var encodedImageURL = "data:image/jpeg;base64," + Utilities.base64Encode(imageBytes);

// You can store encodeImageURL and use it as a parameter to CardHeader.setImageUrl(imageUrl).

Paramètres

NomTypeDescription
imageUrlStringAdresse URL d'une image hébergée à utiliser ou chaîne d'image encodée.

Aller-retour

CardHeader : cet objet, pour le chaînage


setSubtitle(subtitle)

Définit le sous-titre de l'en-tête de la fiche. Facultatif.

Paramètres

NomTypeDescription
subtitleStringTexte du sous-titre.

Aller-retour

CardHeader : cet objet, pour le chaînage


setTitle(title)

Définit le titre de l'en-tête de la fiche. Obligatoire.

Paramètres

NomTypeDescription
titleStringTexte de l'en-tête.

Aller-retour

CardHeader : cet objet, pour le chaînage