Google is committed to advancing racial equity for Black communities. See how.

Class GridItem

GridItem

The items users interact with within a grid widget.

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

Methods

MethodReturn typeBrief description
setIdentifier(id)GridItemSets the identifier for the grid item.
setImage(image)GridItemSets the image for this grid item.
setLayout(layout)GridItemSets the layout of text and image for the grid item.
setSubtitle(subtitle)GridItemSets the subtitle of the grid item.
setTextAlignment(alignment)GridItemSets the horizontal alignment of the grid item.
setTitle(title)GridItemSets 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

NameTypeDescription
idStringThe ID.

Return

GridItem — This object, for chaining.


setImage(image)

Sets the image for this grid item.

Parameters

NameTypeDescription
imageImageComponentThe 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

NameTypeDescription
layoutGridItemLayoutThe layout setting.

Return

GridItem — This object, for chaining.


setSubtitle(subtitle)

Sets the subtitle of the grid item.

Parameters

NameTypeDescription
subtitleStringThe subtitle text.

Return

GridItem — This object, for chaining.


setTextAlignment(alignment)

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

Parameters

NameTypeDescription
alignmentHorizontalAlignmentThe alignment setting.

Return

GridItem — This object, for chaining.


setTitle(title)

Sets the title text of the grid item.

Parameters

NameTypeDescription
titleStringThe title text.

Return

GridItem — This object, for chaining.