GridLayoutElement - Amazon Quick Sight
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GridLayoutElement

An element within a grid layout.

Contents

Note

In the following list, the required parameters are described first.

ColumnSpan

The width of a grid element expressed as a number of grid columns.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 36.

Required: Yes

ElementId

A unique identifier for an element within a grid layout.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

ElementType

The type of element.

Type: String

Valid Values: VISUAL | FILTER_CONTROL | PARAMETER_CONTROL | TEXT_BOX | IMAGE

Required: Yes

RowSpan

The height of a grid element expressed as a number of grid rows.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 21.

Required: Yes

BackgroundStyle

The background style configuration of a grid layout element.

Type: GridLayoutElementBackgroundStyle object

Required: No

BorderRadius

The border radius of a grid layout element.

Type: String

Length Constraints: Maximum length of 50.

Required: No

BorderStyle

The border style configuration of a grid layout element.

Type: GridLayoutElementBorderStyle object

Required: No

ColumnIndex

The column index for the upper left corner of an element.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 35.

Required: No

LoadingAnimation

The configuration of loading animation in free-form layout.

Type: LoadingAnimation object

Required: No

Padding

The padding of a grid layout element.

Type: String

Length Constraints: Maximum length of 200.

Required: No

RowIndex

The row index for the upper left corner of an element.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 9009.

Required: No

SelectedBorderStyle

The border style configuration of a grid layout element. This border style is used when the element is selected.

Type: GridLayoutElementBorderStyle object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: