interface GridLayoutElementProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDashboard.GridLayoutElementProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_GridLayoutElementProperty
Java	software.amazon.awscdk.services.quicksight.CfnDashboard.GridLayoutElementProperty
Python	aws_cdk.aws_quicksight.CfnDashboard.GridLayoutElementProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnDashboard » GridLayoutElementProperty

An element within a grid layout.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html

Example

// 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.CfnDashboard.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

Name	Type	Description
columnSpan	number	The width of a grid element expressed as a number of grid columns.
elementId	string	A unique identifier for an element within a grid layout.
elementType	string	The type of element.
rowSpan	number	The height of a grid element expressed as a number of grid rows.
backgroundStyle?	IResolvable | GridLayoutElementBackgroundStyleProperty	The background style configuration of a grid layout element.
borderRadius?	string	The border radius of a grid layout element.
borderStyle?	IResolvable | GridLayoutElementBorderStyleProperty	The border style configuration of a grid layout element.
columnIndex?	number	The column index for the upper left corner of an element.
loadingAnimation?	IResolvable | LoadingAnimationProperty
padding?	string	The padding of a grid layout element.
rowIndex?	number	The row index for the upper left corner of an element.
selectedBorderStyle?	IResolvable | GridLayoutElementBorderStyleProperty	The border style configuration of a grid layout element.

---

columnSpan

Type: number

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-columnspan

---

elementId

Type: string

A unique identifier for an element within a grid layout.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-elementid

---

elementType

Type: string

The type of element.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-elementtype

---

rowSpan

Type: number

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-rowspan

---

backgroundStyle?

Type: IResolvable | GridLayoutElementBackgroundStyleProperty (optional)

The background style configuration of a grid layout element.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-backgroundstyle

---

borderRadius?

Type: string (optional)

The border radius of a grid layout element.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-borderradius

---

borderStyle?

Type: IResolvable | GridLayoutElementBorderStyleProperty (optional)

The border style configuration of a grid layout element.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-borderstyle

---

columnIndex?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-columnindex

---

loadingAnimation?

Type: IResolvable | LoadingAnimationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-loadinganimation

---

padding?

Type: string (optional)

The padding of a grid layout element.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-padding

---

rowIndex?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-rowindex

---

selectedBorderStyle?

Type: IResolvable | GridLayoutElementBorderStyleProperty (optional)

The border style configuration of a grid layout element.

This border style is used when the element is selected.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-selectedborderstyle