GridArea class

Package:

@microsoft/teams.cards

Defines an area in a Layout.AreaGrid layout.

Constructors

GridArea(IGridArea)

Properties

column	The start column index of the area. Column indices start at 1.
columnSpan	Defines how many columns the area should span.
name	The name of the area. To place an element in this area, set its grid.area property to match the name of the area.
row	The start row index of the area. Row indices start at 1.
rowSpan	Defines how many rows the area should span.

Methods

from(IGridArea)
withColumn(number)
withColumnSpan(number)
withName(string)
withRow(number)
withRowSpan(number)

Constructor Details

GridArea(IGridArea)

new GridArea(options?: IGridArea)

Parameters

options

IGridArea

Property Details

column

The start column index of the area. Column indices start at 1.

column?: number

Property Value

number

columnSpan

Defines how many columns the area should span.

columnSpan?: number

Property Value

number

name

The name of the area. To place an element in this area, set its grid.area property to match the name of the area.

name?: string

Property Value

string

row

The start row index of the area. Row indices start at 1.

row?: number

Property Value

number

rowSpan

Defines how many rows the area should span.

rowSpan?: number

Property Value

number

Method Details

from(IGridArea)

static function from(options: IGridArea): GridArea

Parameters

options

IGridArea

Returns

GridArea

withColumn(number)

function withColumn(column: number): GridArea

Parameters

column

number

Returns

GridArea

withColumnSpan(number)

function withColumnSpan(columnSpan: number): GridArea

Parameters

columnSpan

number

Returns

GridArea

withName(string)

function withName(name: string): GridArea

Parameters

name

string

Returns

GridArea

withRow(number)

function withRow(row: number): GridArea

Parameters

row

number

Returns

GridArea

withRowSpan(number)

function withRowSpan(rowSpan: number): GridArea

Parameters

rowSpan

number

Returns

GridArea