Class GridItem

Grid Item

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 .

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

Methods

Method Return type Brief description
Grid Item Sets the identifier for the grid item.
Grid Item Sets the image for this grid item.
Grid Item Sets the layout of text and image for the grid item.
Grid Item Sets the subtitle of the grid item.
Grid Item Sets the horizontal alignment of the grid item.
Grid Item Sets the title text of the grid item.

Detailed documentation

set Identifier(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

Grid Item — This object, for chaining.


set Image(image)

Sets the image for this grid item.

Parameters

Name Type Description
image
Image Component The ImageComponent object.

Return

Grid Item — This object, for chaining.


set Layout(layout)

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

Parameters

Name Type Description
layout
Grid Item Layout The layout setting.

Return

Grid Item — This object, for chaining.


set Subtitle(subtitle)

Sets the subtitle of the grid item.

Parameters

Name Type Description
subtitle
String The subtitle text.

Return

Grid Item — This object, for chaining.


set Text Alignment(alignment)

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

Parameters

Name Type Description
alignment
Horizontal Alignment The alignment setting.

Return

Grid Item — This object, for chaining.


set Title(title)

Sets the title text of the grid item.

Parameters

Name Type Description
title
String The title text.

Return

Grid Item — This object, for chaining.

Design a Mobile Site
View Site in Mobile | Classic
Share by: