Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.GridLayoutElementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.GridLayoutElementProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.GridLayoutElementProperty
extends software.amazon.jsii.JsiiSerializable

An element within a grid layout.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 GridLayoutElementProperty gridLayoutElementProperty = GridLayoutElementProperty.builder()
         .columnSpan(123)
         .elementId("elementId")
         .elementType("elementType")
         .rowSpan(123)
         // the properties below are optional
         .columnIndex(123)
         .rowIndex(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.GridLayoutElementProperty.Builder	A builder for CfnDashboard.GridLayoutElementProperty
static final class	CfnDashboard.GridLayoutElementProperty.Jsii$Proxy	An implementation for CfnDashboard.GridLayoutElementProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.GridLayoutElementProperty.Builder	builder()
default Number	getColumnIndex()	The column index for the upper left corner of an element.
Number	getColumnSpan()	The width of a grid element expressed as a number of grid columns.
String	getElementId()	A unique identifier for an element within a grid layout.
String	getElementType()	The type of element.
default Number	getRowIndex()	The row index for the upper left corner of an element.
Number	getRowSpan()	The height of a grid element expressed as a number of grid rows.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumnSpan

@Stability(Stable)
@NotNull
Number getColumnSpan()

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

getElementId

@Stability(Stable)
@NotNull
String getElementId()

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

getElementType

@Stability(Stable)
@NotNull
String getElementType()

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

getRowSpan

@Stability(Stable)
@NotNull
Number getRowSpan()

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

getColumnIndex

@Stability(Stable)
@Nullable
default Number getColumnIndex()

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

getRowIndex

@Stability(Stable)
@Nullable
default Number getRowIndex()

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

builder

@Stability(Stable)
static CfnDashboard.GridLayoutElementProperty.Builder builder()

Returns:

a CfnDashboard.GridLayoutElementProperty.Builder of CfnDashboard.GridLayoutElementProperty