Class Columns

Columns widget 最多可在卡片或对话框中显示 2 列。您可以向每个 Column 添加 widget;widget 会按照指定的顺序显示。如需查看 Google Chat 应用中的示例,请参阅

每列的高度由较高的列决定。例如,如果第一列高于第二列,则两列的高度都与第一列相同。由于每列可以包含不同数量的 widget,因此您无法定义行或在列之间对齐 widget。

列并排显示。您可以使用 HorizontalSizeStyle 字段自定义每列的宽度。如果用户的屏幕宽度过窄,第二列会换行到第一列下方:

  • 在网页上,如果屏幕宽度小于或等于 480 像素,第二列会换行。
  • 在 iOS 设备上,如果屏幕宽度小于或等于 300 pt,则第二列会换行。
  • 在 Android 设备上,如果屏幕宽度小于或等于 320 dp ,第二列会换行。

适用于 Google Chat 应用和 Google Workspace 插件。支持列的插件界面包括:

  • 用户从电子邮件草稿中打开插件时显示的对话框。
  • 用户从 添加附件 菜单中打开插件时显示的对话框(位于 Google 日历活动 中)。
    // Build a column that is aligned in the center and fills the space:
    const column =
        CardService.newColumn()
            .setHorizontalSizeStyle(
                CardService.HorizontalSizeStyle.FILL_AVAILABLE_SPACE)
            .setHorizontalAlignment(CardService.HorizontalAlignment.CENTER)
            .setVerticalAlignment(CardService.VerticalAlignment.CENTER);
    const columns = CardService.newColumns().addColumn(column).setWrapStyle(
        CardService.WrapStyle.WRAP);

方法

方法返回值类型简介
addColumn(column)Columns向 Columns widget 添加 Column
addEventAction(eventAction)Widget添加可对 widget 执行的事件操作。
setId(id)Widget设置分配的唯一 ID,用于标识要发生突变的 widget。
setVisibility(visibility)Widget设置 widget 的可见性。
setWrapStyle(wrapStyle)Columns设置列的换行样式,控制列如何根据屏幕宽度调整大小。

详细文档

addColumn(column)

向 Columns widget 添加 Column。列会按照添加顺序显示。您最多可以添加两列。

const columns = CardService.newColumns().addColumn(CardService.newColumn());

参数

名称类型说明
columnColumn要添加到 Columns widget 的子列。

返回

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


addEventAction(eventAction)

添加可对 widget 执行的事件操作。

参数

名称类型说明
eventActionEventAction要添加的 EventAction

返回

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


setId(id)

设置分配的唯一 ID,用于标识要发生突变的 widget。只有插件支持 widget 突变。

参数

名称类型说明
idStringwidget 的 ID,长度上限为 64 个字符,格式为 `[a-zA-Z0-9-]+`。

返回

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


setVisibility(visibility)

设置 widget 的可见性。默认值为 `VISIBLE`。

参数

名称类型说明
visibilityVisibilitywidget 的 Visibility

返回

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


setWrapStyle(wrapStyle)

设置列的换行样式,控制列如何根据屏幕宽度调整大小。

const columns = CardService.newColumns()
                    .addColumn(CardService.newColumn())
                    .setWrapStyle(CardService.WrapStyle.WRAP);

参数

名称类型说明
wrapStyleWrapStyle要为列设置的换行样式。

返回

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