Class Column

  • Columns are available for Google Chat apps and Google Workspace add-ons.

  • You can add various widgets like TextParagraph, Image, and TextInput to a column using the addWidget() method.

  • The appearance of a column can be customized using methods like setHorizontalAlignment(), setHorizontalSizeStyle(), and setVerticalAlignment().

  • Each method returns the Column object for chaining.
Column

A column.

Available for Google Chat apps and Google Workspace add-ons. 

const columnWidget = CardService.newTextParagraph();
const column =
    CardService.newColumn()
        .setHorizontalSizeStyle(
            CardService.HorizontalSizeStyle.FILL_AVAILABLE_SPACE)
        .setHorizontalAlignment(CardService.HorizontalAlignment.CENTER)
        .setVerticalAlignment(CardService.VerticalAlignment.CENTER)
        .addWidget(columnWidget);

Methods

MethodReturn typeBrief description
addWidget(widget)ColumnAdds a widget to the column.
setHorizontalAlignment(horizontalAlignment)ColumnSets the HorizontalAlignment of the Column.
setHorizontalSizeStyle(horizontalSizeStyle)ColumnSets the HorizontalSizeStyle of the Column.
setVerticalAlignment(verticalAlignment)ColumnSets the VerticalAlignment of the Column.

Detailed documentation

addWidget(widget)

Adds a widget to the column.

Widgets are displayed in the order they are added. You can add the following widgets to a column: 

const column = CardService.newColumn().addWidget(
    CardService.newTextParagraph().setText('This is a text paragraph widget'),
);

Parameters

NameTypeDescription
widgetWidgetThe widget to add to the column.

Return

Column — This object, for chaining.

setHorizontalAlignment(horizontalAlignment)

Sets the HorizontalAlignment of the Column. Optional. 

const column = CardService.newColumn().setHorizontalAlignment(
    CardService.HorizontalAlignment.CENTER,
);

Parameters

NameTypeDescription
horizontalAlignmentHorizontalAlignmentThe horizontal alignment of the column.

Return

Column — This object, for chaining.

setHorizontalSizeStyle(horizontalSizeStyle)

Sets the HorizontalSizeStyle of the Column. Optional. 

const column = CardService.newColumn().setHorizontalSizeStyle(
    CardService.HorizontalSizeStyle.FILL_AVAILABLE_SPACE,
);

Parameters

NameTypeDescription
horizontalSizeStyleHorizontalSizeStyleThe horizontal size of the column.

Return

Column — This object, for chaining.

setVerticalAlignment(verticalAlignment)

Sets the VerticalAlignment of the Column. Optional. 

const column = CardService.newColumn().setVerticalAlignment(
    CardService.VerticalAlignment.CENTER,
);

Parameters

NameTypeDescription
verticalAlignmentVerticalAlignmentThe vertical alignment of the column.

Return

Column — This object, for chaining.