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
         .backgroundStyle(GridLayoutElementBackgroundStyleProperty.builder()
                 .color("color")
                 .visibility("visibility")
                 .build())
         .borderRadius("borderRadius")
         .borderStyle(GridLayoutElementBorderStyleProperty.builder()
                 .color("color")
                 .visibility("visibility")
                 .width("width")
                 .build())
         .columnIndex(123)
         .loadingAnimation(LoadingAnimationProperty.builder()
                 .visibility("visibility")
                 .build())
         .padding("padding")
         .rowIndex(123)
         .selectedBorderStyle(GridLayoutElementBorderStyleProperty.builder()
                 .color("color")
                 .visibility("visibility")
                 .width("width")
                 .build())
         .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 Object	getBackgroundStyle()	The background style configuration of a grid layout element.
default String	getBorderRadius()	The border radius of a grid layout element.
default Object	getBorderStyle()	The border style configuration of a grid layout element.
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 Object	getLoadingAnimation()	Returns union: either IResolvable or CfnDashboard.LoadingAnimationProperty
default String	getPadding()	The padding of a grid layout 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.
default Object	getSelectedBorderStyle()	The border style configuration of a grid layout element.

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

getBackgroundStyle

@Stability(Stable)
@Nullable
default Object getBackgroundStyle()

The background style configuration of a grid layout element.

Returns union: either IResolvable or CfnDashboard.GridLayoutElementBackgroundStyleProperty

See Also:

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

getBorderRadius

@Stability(Stable)
@Nullable
default String getBorderRadius()

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

getBorderStyle

@Stability(Stable)
@Nullable
default Object getBorderStyle()

The border style configuration of a grid layout element.

Returns union: either IResolvable or CfnDashboard.GridLayoutElementBorderStyleProperty

See Also:

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

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

getLoadingAnimation

@Stability(Stable)
@Nullable
default Object getLoadingAnimation()

Returns union: either IResolvable or CfnDashboard.LoadingAnimationProperty

See Also:

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

getPadding

@Stability(Stable)
@Nullable
default String getPadding()

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

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

getSelectedBorderStyle

@Stability(Stable)
@Nullable
default Object getSelectedBorderStyle()

The border style configuration of a grid layout element.

This border style is used when the element is selected.

Returns union: either IResolvable or CfnDashboard.GridLayoutElementBorderStyleProperty

See Also:

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

builder

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

Returns:

a CfnDashboard.GridLayoutElementProperty.Builder of CfnDashboard.GridLayoutElementProperty