Class GridItem Stay organized with collections Save and categorize content based on your preferences.
Page Summary
GridItems are interactive elements within a grid widget, available for Google Workspace add-ons and Google Chat apps.
Enums like
CardService.GridItemLayout.TEXT_BELOWare called by referencing their parent class, name, and property.GridItem objects can be configured using methods such as
setIdentifier,setImage,setLayout,setSubtitle,setTextAlignment, andsetTitle.The
setIdentifiermethod assigns an ID that is returned in the parent grid's on_click callback.Methods like
setLayoutandsetTextAlignmenthave default values if not explicitly set.
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.
constgridItem=CardService.newGridItem().setIdentifier('itemA').setTitle('This is a cat').setImage(CardService.newImageComponent()).setLayout(CardService.GridItemLayout.TEXT_BELOW);
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Grid | Sets the identifier for the grid item. |
set | Grid | Sets the image for this grid item. |
set | Grid | Sets the layout of text and image for the grid item. |
set | Grid | Sets the subtitle of the grid item. |
set | Grid | Sets the horizontal alignment of the grid item. |
set | Grid | 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 returnedin the parent grid's on_click call back parameters.
Parameters
| Name | Type | Description |
|---|---|---|
id | String | The ID. |
Return
Grid — This object, for chaining.
setImage(image)
Sets the image for this grid item.
Parameters
| Name | Type | Description |
|---|---|---|
image | Image | The ImageComponent object. |
Return
Grid — 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 | Grid | The layout setting. |
Return
Grid — This object, for chaining.
setSubtitle(subtitle)
Sets the subtitle of the grid item.
Parameters
| Name | Type | Description |
|---|---|---|
subtitle | String | The subtitle text. |
Return
Grid — This object, for chaining.
setTextAlignment(alignment)
Sets the horizontal alignment of the grid item. Default is START.
Parameters
| Name | Type | Description |
|---|---|---|
alignment | Horizontal | The alignment setting. |
Return
Grid — This object, for chaining.
setTitle(title)
Sets the title text of the grid item.
Parameters
| Name | Type | Description |
|---|---|---|
title | String | The title text. |
Return
Grid — This object, for chaining.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.