Class ChipList

条状标签列表

包含一组以行显示、换行到下一行以实现水平滚动的 Chip 对象。

适用于 Google Chat 应用。在 Google Workspace 加购项的开发者预览版中。

const chip = CardService.newChip();
// Finish building the text chip...

const chipList = CardService.newChipList()
                     .setLayout(CardService.ChipListLayout.WRAPPED)
                     .addChip(chip);

方法

方法返回类型简介
addChip(chip)ChipList添加条状标签。
addEventAction(eventAction)Widget添加可在 widget 上执行的事件操作。
setId(id)Widget设置用于标识要发生变异的 widget 的唯一 ID。
setLayout(layout)ChipList设置 chip 列表布局。
setVisibility(visibility)Widget设置 widget 的可见性。

详细文档

addChip(chip)

添加条状标签。

参数

名称类型说明
chipChip要添加的条状标签。

返回

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


addEventAction(eventAction)

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

参数

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

返回

Widget - 用于链式调用的对象。


setId(id)

设置用于标识要发生变异的 widget 的唯一 ID。只有在插件中支持 widget 突变。

参数

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

返回

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


setLayout(layout)

设置 chip 列表布局。如果未设置,则默认为 ChipListLayout.WRAPPED 布局。

const chip = CardService.newChip();
// Finish building the text chip...

const chipList =
    CardService.newChipList()
        .setLayout(CardService.ChipListLayout.HORIZONTAL_SCROLLABLE)
        .addChip(chip);

参数

名称类型说明
layoutChipListLayout条状标签列表布局。

返回

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


setVisibility(visibility)

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

参数

名称类型说明
visibilityVisibility微件的 Visibility

返回

Widget - 用于链式调用的对象。