Class CardSection

Sectionde la fiche

Une section de fiche contient des groupes de widgets et les sépare visuellement.

Disponible pour les modules complémentaires Google Workspace et les applications Google Chat. 

const image = CardService.newImage();
// Build image ...
const textParagraph = CardService.newTextParagraph();
// Build text paragraph ...

const cardSection = CardService.newCardSection()
                        .setHeader('Section header')
                        .addWidget(image)
                        .addWidget(textParagraph);

Méthodes

MéthodeType renvoyéBrève description
addWidget(widget)CardSectionAjoute le widget donné à cette section.
setCollapseControl(collapseControl)CardSectionDéfinit les boutons de développement et de réduction personnalisables de la section.
setCollapsible(collapsible)CardSectionIndique si la section peut être réduite.
setHeader(header)CardSectionDéfinit l'en-tête de la section.
setId(id)CardSectionDéfinit l'ID unique attribué qui est utilisé pour identifier la section à modifier.
setNumUncollapsibleWidgets(numUncollapsibleWidgets)CardSectionDéfinit le nombre de widgets qui restent affichés lorsque cette section est réduite.

Documentation détaillée

addWidget(widget)

Ajoute le widget donné à cette section. Les widgets s'affichent dans l'ordre dans lequel ils ont été ajoutés. Vous ne pouvez pas ajouter plus de 100 widgets à une section de carte.

Paramètres

NomTypeDescription
widgetWidgetWidget à ajouter à la section.

Renvois

CardSection : cet objet, pour le chaînage.

setCollapseControl(collapseControl)

Définit les boutons de développement et de réduction personnalisables de la section. Ces boutons ne s'affichent que si la section est réductible. Si ce champ n'est pas défini, les boutons par défaut sont utilisés.

Disponible pour les applications Google Chat. En preview développeur pour les modules complémentaires Google Workspace. 

const collapseButton =
    CardService.newTextButton()
        .setTextButtonStyle(CardService.TextButtonStyle.BORDERLESS)
        .setText('show less');

const expandButton =
    CardService.newImageButton()
        .setImageButtonStyle(CardService.ImageButtonStyle.FILLED)
        .setMaterialIcon(CardService.newMaterialIcon().setName('bug_report'));

const collapsibleSection =
    CardService.newCardSection()
        .setCollapsible(true)
        .setNumUncollapsibleWidgets(1)
        .setCollapseControl(
            CardService.newCollapseControl()
                .setHorizontalAlign(CardService.HorizontalAlignment.CENTER)
                .setCollapseButton(collapseButton)
                .setExpandButton(expandButton),
        );

Paramètres

NomTypeDescription
collapseControlCollapseControlParamètre de contrôle de l'état réduit.

Renvois

CardSection : cet objet, pour le chaînage.

setCollapsible(collapsible)

Indique si la section peut être réduite.

Paramètres

NomTypeDescription
collapsibleBooleanLe paramètre de réduction.

Renvois

CardSection : cet objet, pour le chaînage.

setHeader(header)

Définit l'en-tête de la section. Facultatif.

Paramètres

NomTypeDescription
headerStringTexte de l'en-tête.

Renvois

CardSection : cet objet, pour le chaînage.

setId(id)

Définit l'ID unique attribué qui est utilisé pour identifier la section à modifier. La mutation de section n'est compatible qu'avec les modules complémentaires.

Paramètres

NomTypeDescription
idStringID de la section, limité à 64 caractères et au format `[a-zA-Z0-9-]+`.

Renvois

CardSection : cet objet, pour le chaînage.

setNumUncollapsibleWidgets(numUncollapsibleWidgets)

Définit le nombre de widgets qui restent affichés lorsque cette section est réduite. Les widgets affichés sont toujours ceux qui ont été ajoutés en premier.

Paramètres

NomTypeDescription
numUncollapsibleWidgetsIntegerNombre de widgets à afficher.

Renvois

CardSection : cet objet, pour le chaînage.