Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.FreeFormLayoutElementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.FreeFormLayoutElementProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

An element within a free-form 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.*;
 FreeFormLayoutElementProperty freeFormLayoutElementProperty = FreeFormLayoutElementProperty.builder()
         .elementId("elementId")
         .elementType("elementType")
         .height("height")
         .width("width")
         .xAxisLocation("xAxisLocation")
         .yAxisLocation("yAxisLocation")
         // the properties below are optional
         .backgroundStyle(FreeFormLayoutElementBackgroundStyleProperty.builder()
                 .color("color")
                 .visibility("visibility")
                 .build())
         .borderStyle(FreeFormLayoutElementBorderStyleProperty.builder()
                 .color("color")
                 .visibility("visibility")
                 .build())
         .loadingAnimation(LoadingAnimationProperty.builder()
                 .visibility("visibility")
                 .build())
         .renderingRules(List.of(SheetElementRenderingRuleProperty.builder()
                 .configurationOverrides(SheetElementConfigurationOverridesProperty.builder()
                         .visibility("visibility")
                         .build())
                 .expression("expression")
                 .build()))
         .selectedBorderStyle(FreeFormLayoutElementBorderStyleProperty.builder()
                 .color("color")
                 .visibility("visibility")
                 .build())
         .visibility("visibility")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.FreeFormLayoutElementProperty.Builder	builder()
default Object	getBackgroundStyle()	The background style configuration of a free-form layout element.
default Object	getBorderStyle()	The border style configuration of a free-form layout element.
String	getElementId()	A unique identifier for an element within a free-form layout.
String	getElementType()	The type of element.
String	getHeight()	The height of an element within a free-form layout.
default Object	getLoadingAnimation()	The loading animation configuration of a free-form layout element.
default Object	getRenderingRules()	The rendering rules that determine when an element should be displayed within a free-form layout.
default Object	getSelectedBorderStyle()	The border style configuration of a free-form layout element.
default String	getVisibility()	The visibility of an element within a free-form layout.
String	getWidth()	The width of an element within a free-form layout.
String	getXAxisLocation()	The x-axis coordinate of the element.
String	getYAxisLocation()	The y-axis coordinate of the element.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getElementId

@Stability(Stable)
@NotNull
String getElementId()

A unique identifier for an element within a free-form layout.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-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-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-elementtype

getHeight

@Stability(Stable)
@NotNull
String getHeight()

The height of an element within a free-form layout.

See Also:

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

getWidth

@Stability(Stable)
@NotNull
String getWidth()

The width of an element within a free-form layout.

See Also:

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

getXAxisLocation

@Stability(Stable)
@NotNull
String getXAxisLocation()

The x-axis coordinate of the element.

See Also:

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

getYAxisLocation

@Stability(Stable)
@NotNull
String getYAxisLocation()

The y-axis coordinate of the element.

See Also:

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

getBackgroundStyle

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

The background style configuration of a free-form layout element.

See Also:

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

getBorderStyle

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

The border style configuration of a free-form layout element.

See Also:

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

getLoadingAnimation

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

The loading animation configuration of a free-form layout element.

See Also:

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

getRenderingRules

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

The rendering rules that determine when an element should be displayed within a free-form layout.

See Also:

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

getSelectedBorderStyle

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

The border style configuration of a free-form 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-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-selectedborderstyle

getVisibility

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

The visibility of an element within a free-form layout.

See Also:

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

builder

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

Returns:

a CfnDashboard.FreeFormLayoutElementProperty.Builder of CfnDashboard.FreeFormLayoutElementProperty