AWS CDK Reference

Appearance

v2.275.0

GridLayoutElementProperty Struct ​

An element within a grid layout.

Source
Generated code
Type last changed
v2.272.0 · 30 Sep 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const gridLayoutElementProperty: quicksight.CfnTemplate.GridLayoutElementProperty = {
  columnSpan: 123,
  elementId: 'elementId',
  elementType: 'elementType',
  rowSpan: 123,

  // the properties below are optional
  backgroundStyle: {
    color: 'color',
    visibility: 'visibility',
  },
  borderRadius: 'borderRadius',
  borderStyle: {
    color: 'color',
    visibility: 'visibility',
    width: 'width',
  },
  columnIndex: 123,
  loadingAnimation: {
    visibility: 'visibility',
  },
  padding: 'padding',
  rowIndex: 123,
  selectedBorderStyle: {
    color: 'color',
    visibility: 'visibility',
    width: 'width',
  },
};

Properties ​

backgroundStyleoptionalIResolvable | CfnTemplate.GridLayoutElementBackgroundStylePropertybackground_styleoptionaltyping.Union[IResolvable, GridLayoutElementBackgroundStyleProperty]backgroundStyleoptionalIResolvableBackgroundStyleoptionalIResolvableBackgroundStyleoptionalinterface{}#
borderRadiusoptionalstringborder_radiusoptionalstrborderRadiusoptionalStringBorderRadiusoptionalstringBorderRadiusoptional*string#
borderStyleoptionalIResolvable | CfnTemplate.GridLayoutElementBorderStylePropertyborder_styleoptionaltyping.Union[IResolvable, GridLayoutElementBorderStyleProperty]borderStyleoptionalIResolvableBorderStyleoptionalIResolvableBorderStyleoptionalinterface{}#
columnIndexoptionalnumbercolumn_indexoptionalint | floatcolumnIndexoptionalNumberColumnIndexoptionaldoubleColumnIndexoptional*float64#
The column index for the upper left corner of an element.
columnSpannumbercolumn_spanint | floatcolumnSpanNumberColumnSpandoubleColumnSpan*float64required#
The width of a grid element expressed as a number of grid columns.
elementIdstringelement_idstrelementIdStringElementIdstringElementId*stringrequired#
A unique identifier for an element within a grid layout.
elementTypestringelement_typestrelementTypeStringElementTypestringElementType*stringrequired#
The type of element.
loadingAnimationoptionalIResolvable | CfnTemplate.LoadingAnimationPropertyloading_animationoptionaltyping.Union[IResolvable, LoadingAnimationProperty]loadingAnimationoptionalIResolvableLoadingAnimationoptionalIResolvableLoadingAnimationoptionalinterface{}#
paddingoptionalstringpaddingoptionalstrpaddingoptionalStringPaddingoptionalstringPaddingoptional*string#
rowIndexoptionalnumberrow_indexoptionalint | floatrowIndexoptionalNumberRowIndexoptionaldoubleRowIndexoptional*float64#
The row index for the upper left corner of an element.
rowSpannumberrow_spanint | floatrowSpanNumberRowSpandoubleRowSpan*float64required#
The height of a grid element expressed as a number of grid rows.
selectedBorderStyleoptionalIResolvable | CfnTemplate.GridLayoutElementBorderStylePropertyselected_border_styleoptionaltyping.Union[IResolvable, GridLayoutElementBorderStyleProperty]selectedBorderStyleoptionalIResolvableSelectedBorderStyleoptionalIResolvableSelectedBorderStyleoptionalinterface{}#