final class Grid extends GeneratedMessageV3 with GridOrBuilder
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`][google.apps.card.v1.Columns]. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#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](https://developers.google.com/workspace/extend): 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" } } } ```
Protobuf type google.apps.card.v1.Grid
- Source
- Grid.java
- Alphabetic
- By Inheritance
- Grid
- GridOrBuilder
- GeneratedMessageV3
- Serializable
- AbstractMessage
- Message
- MessageOrBuilder
- AbstractMessageLite
- MessageLite
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: AnyRef): Boolean
- Definition Classes
- Grid → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def findInitializationErrors(): List[String]
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getAllFields(): Map[FieldDescriptor, AnyRef]
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getBorderStyle(): BorderStyle
The border style to apply to each grid item.
The border style to apply to each grid item.
.google.apps.card.v1.BorderStyle border_style = 3;
- returns
The borderStyle.
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getBorderStyleOrBuilder(): BorderStyleOrBuilder
The border style to apply to each grid item.
The border style to apply to each grid item.
.google.apps.card.v1.BorderStyle border_style = 3;
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getColumnCount(): 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).
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).
int32 column_count = 4;
- returns
The columnCount.
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getDefaultInstanceForType(): Grid
- Definition Classes
- Grid → MessageOrBuilder → MessageLiteOrBuilder
- Annotations
- @Override()
- def getDescriptorForType(): Descriptor
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getField(arg0: FieldDescriptor): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getInitializationErrorString(): String
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getItems(index: Int): GridItem
The items to display in the grid.
The items to display in the grid.
repeated .google.apps.card.v1.Grid.GridItem items = 2;
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getItemsCount(): Int
The items to display in the grid.
The items to display in the grid.
repeated .google.apps.card.v1.Grid.GridItem items = 2;
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getItemsList(): List[GridItem]
The items to display in the grid.
The items to display in the grid.
repeated .google.apps.card.v1.Grid.GridItem items = 2;
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getItemsOrBuilder(index: Int): GridItemOrBuilder
The items to display in the grid.
The items to display in the grid.
repeated .google.apps.card.v1.Grid.GridItem items = 2;
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getItemsOrBuilderList(): List[_ <: GridItemOrBuilder]
The items to display in the grid.
The items to display in the grid.
repeated .google.apps.card.v1.Grid.GridItem items = 2;
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getOnClick(): 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.
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 on_click = 5;
- returns
The onClick.
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getOnClickOrBuilder(): OnClickOrBuilder
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 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 on_click = 5;
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
- def getParserForType(): Parser[Grid]
- Definition Classes
- Grid → GeneratedMessageV3 → Message → MessageLite
- Annotations
- @Override()
- def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getRepeatedFieldCount(arg0: FieldDescriptor): Int
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getSerializedSize(): Int
- Definition Classes
- Grid → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
- def getTitle(): String
The text that displays in the grid header.
The text that displays in the grid header.
string title = 1;
- returns
The title.
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getTitleBytes(): ByteString
The text that displays in the grid header.
The text that displays in the grid header.
string title = 1;
- returns
The bytes for title.
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def getUnknownFields(): UnknownFieldSet
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def hasBorderStyle(): Boolean
The border style to apply to each grid item.
The border style to apply to each grid item.
.google.apps.card.v1.BorderStyle border_style = 3;
- returns
Whether the borderStyle field is set.
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def hasField(arg0: FieldDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def hasOnClick(): Boolean
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 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 on_click = 5;
- returns
Whether the onClick field is set.
- Definition Classes
- Grid → GridOrBuilder
- Annotations
- @Override()
- def hasOneof(arg0: OneofDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
- def hashCode(): Int
- Definition Classes
- Grid → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def internalGetFieldAccessorTable(): FieldAccessorTable
- def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- final def isInitialized(): Boolean
- Definition Classes
- Grid → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
- Annotations
- @Override()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def makeExtensionsImmutable(): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newBuilderForType(parent: BuilderParent): Builder
- def newBuilderForType(): Builder
- Definition Classes
- Grid → Message → MessageLite
- Annotations
- @Override()
- def newBuilderForType(arg0: BuilderParent): Builder
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3 → AbstractMessage
- def newInstance(unused: UnusedPrivateParameter): AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.IOException])
- def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.IOException])
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toBuilder(): Builder
- Definition Classes
- Grid → Message → MessageLite
- Annotations
- @Override()
- def toByteArray(): Array[Byte]
- Definition Classes
- AbstractMessageLite → MessageLite
- def toByteString(): ByteString
- Definition Classes
- AbstractMessageLite → MessageLite
- final def toString(): String
- Definition Classes
- AbstractMessage → Message → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def writeDelimitedTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])
- def writeReplace(): AnyRef
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.ObjectStreamException])
- def writeTo(output: CodedOutputStream): Unit
- Definition Classes
- Grid → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
- def writeTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])
Deprecated Value Members
- def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
- Deprecated