Class CardSection

卡片部分

卡片部分包含一组 widget,并提供它们之间的视觉分隔。

适用于 Google Workspace 插件和 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);

方法

方法返回类型简介
addWidget(widget)CardSection将指定 widget 添加到相应部分。
setCollapseControl(collapseControl)CardSection设置版块的可自定义展开和收起按钮。
setCollapsible(collapsible)CardSection设置相应部分是否可以收起。
setHeader(header)CardSection设置相应部分的标题。
setId(id)CardSection设置用于标识要发生变异的版块的唯一 ID。
setNumUncollapsibleWidgets(numUncollapsibleWidgets)CardSection设置当此部分折叠时仍显示的 widget 数量。

详细文档

addWidget(widget)

将指定 widget 添加到相应部分。微件会按照添加顺序显示。您无法向卡片部分添加超过 100 个 widget。

参数

名称类型说明
widgetWidget要添加到版块中的 widget。

返回

CardSection - 此对象,用于链式调用。


setCollapseControl(collapseControl)

设置版块的可自定义展开和收起按钮。仅当相应部分可折叠时,系统才会显示这些按钮。如果未设置此字段,系统会使用默认按钮。

适用于 Google Chat 应用。在 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),
        );

参数

名称类型说明
collapseControlCollapseControl折叠控制设置。

返回

CardSection - 此对象,用于链式调用。


setCollapsible(collapsible)

设置相应部分是否可以收起。

参数

名称类型说明
collapsibleBoolean可收起设置。

返回

CardSection - 此对象,用于链式调用。


setHeader(header)

设置相应部分的标题。可选。

参数

名称类型说明
headerString标题文字。

返回

CardSection - 此对象,用于链式调用。


setId(id)

设置用于标识要发生变异的部分的唯一 ID。仅在插件中支持部分突变。

参数

名称类型说明
idString版块的 ID,最多 64 个字符,格式为 `[a-zA-Z0-9-]+`。

返回

CardSection - 此对象,用于链式调用。


setNumUncollapsibleWidgets(numUncollapsibleWidgets)

设置此部分折叠时仍显示的 widget 数量。显示的 widget 始终是最初添加的 widget。

参数

名称类型说明
numUncollapsibleWidgetsInteger要显示的 widget 数量。

返回

CardSection - 此对象,用于链式调用。