Class GridItem

GridItem

The items users interact with within a grid widget.

Available for Google Workspace Add-ons and Google Chat apps.

To call an enum, you call its parent class, name, and property. For example, CardService.GridItemLayout.TEXT_BELOW .

var gridItem = CardService.newGridItem()
    .setIdentifier("itemA")
    .setTitle("This is a cat")
    .setImage(CardService.newImageComponent())
    .setLayout(CardService.GridItemLayout.TEXT_BELOW);

Methods

Method Return type Brief description
setIdentifier(id)
GridItem Sets the identifier for the grid item.
setImage(image)
GridItem Sets the image for this grid item.
setLayout(layout)
GridItem Sets the layout of text and image for the grid item.
setSubtitle(subtitle)
GridItem Sets the subtitle of the grid item.
setTextAlignment(alignment)
GridItem Sets the horizontal alignment of the grid item.
setTitle(title)
GridItem Sets the title text of the grid item.

Detailed documentation

setIdentifier(id)

Sets the identifier for the grid item. When a user clicks this grid item, this ID is returned in the parent grid's on_click call back parameters.

Parameters

Name Type Description
id
String The ID.

Return

GridItem — This object, for chaining.

setImage(image)

Sets the image for this grid item.

Parameters

Name Type Description
image
ImageComponent The ImageComponent object.

Return

GridItem — This object, for chaining.

setLayout(layout)

Sets the layout of text and image for the grid item. Default is TEXT_BELOW

Parameters

Name Type Description
layout
GridItemLayout The layout setting.

Return

GridItem — This object, for chaining.

setSubtitle(subtitle)

Sets the subtitle of the grid item.

Parameters

Name Type Description
subtitle
String The subtitle text.

Return

GridItem — This object, for chaining.

setTextAlignment(alignment)

Sets the horizontal alignment of the grid item. Default is START.

Parameters

Name Type Description
alignment
HorizontalAlignment The alignment setting.

Return

GridItem — This object, for chaining.

setTitle(title)

Sets the title text of the grid item.

Parameters

Name Type Description
title
String The title text.

Return

GridItem — This object, for chaining.