Reference documentation and code samples for the Google Apps Chat V1 Client class Grid.
Displays a grid with a collection of items. Items can only include text or
images. For responsive columns, or to include more than text or images, use Columns
. For an example in Google Chat apps,
see Display a Grid with a collection of
items
.
A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. Google Workspace Add-ons and Chat apps : For example, the following JSON creates a 2 column grid with a single item:
"grid": {
"title": "A fine collection of items",
"columnCount": 2,
"borderStyle": {
"type": "STROKE",
"cornerRadius": 4
},
"items": [
{
"image": {
"imageUri": "https://www.example.com/image.png",
"cropStyle": {
"type": "SQUARE"
},
"borderStyle": {
"type": "STROKE"
}
},
"title": "An item",
"textAlignment": "CENTER"
}
],
"onClick": {
"openLink": {
"url": "https://www.example.com"
}
}
}
Generated from protobuf message google.apps.card.v1.Grid
Namespace
Google \ Apps \ Card \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ title
string
The text that displays in the grid header.
↳ items
↳ border_style
↳ column_count
int
The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).
↳ on_click
Google\Apps\Card\V1\OnClick
This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
getTitle
The text that displays in the grid header.
string
setTitle
The text that displays in the grid header.
var
string
$this
getItems
The items to display in the grid.
setItems
The items to display in the grid.
$this
getBorderStyle
The border style to apply to each grid item.
hasBorderStyle
clearBorderStyle
setBorderStyle
The border style to apply to each grid item.
$this
getColumnCount
The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).
int
setColumnCount
The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).
var
int
$this
getOnClick
This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
hasOnClick
clearOnClick
setOnClick
This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
$this
