Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Card::V1::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"
}
}
}
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#border_style
def border_style() -> ::Google::Apps::Card::V1::BorderStyle
- (::Google::Apps::Card::V1::BorderStyle) — The border style to apply to each grid item.
#border_style=
def border_style=(value) -> ::Google::Apps::Card::V1::BorderStyle
- value (::Google::Apps::Card::V1::BorderStyle) — The border style to apply to each grid item.
- (::Google::Apps::Card::V1::BorderStyle) — The border style to apply to each grid item.
#column_count
def column_count() -> ::Integer
- (::Integer) — 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).
#column_count=
def column_count=(value) -> ::Integer
- value (::Integer) — 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).
- (::Integer) — 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).
#items
def items() -> ::Array<::Google::Apps::Card::V1::Grid::GridItem>
- (::Array<::Google::Apps::Card::V1::Grid::GridItem>) — The items to display in the grid.
#items=
def items=(value) -> ::Array<::Google::Apps::Card::V1::Grid::GridItem>
- value (::Array<::Google::Apps::Card::V1::Grid::GridItem>) — The items to display in the grid.
- (::Array<::Google::Apps::Card::V1::Grid::GridItem>) — The items to display in the grid.
#on_click
def on_click() -> ::Google::Apps::Card::V1::OnClick
- (::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.
#on_click=
def on_click=(value) -> ::Google::Apps::Card::V1::OnClick
- value (::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.
- (::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.
#title
def title() -> ::String
- (::String) — The text that displays in the grid header.
#title=
def title=(value) -> ::String
- value (::String) — The text that displays in the grid header.
- (::String) — The text that displays in the grid header.