Google Chat V1 API - Class Google::Apps::Card::V1::Grid (v0.3.1)

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
Returns

#border_style=

def border_style=(value) -> ::Google::Apps::Card::V1::BorderStyle
Parameter
Returns

#column_count

def column_count() -> ::Integer
Returns
  • (::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
Parameter
  • 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).
Returns
  • (::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>
Returns

#items=

def items=(value) -> ::Array<::Google::Apps::Card::V1::Grid::GridItem>
Parameter
Returns

#on_click

def on_click() -> ::Google::Apps::Card::V1::OnClick
Returns
  • (::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
Parameter
  • 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.
Returns
  • (::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
Returns
  • (::String) — The text that displays in the grid header.

#title=

def title=(value) -> ::String
Parameter
  • value (::String) — The text that displays in the grid header.
Returns
  • (::String) — The text that displays in the grid header.