aws-cdk-lib.aws_quicksight.CfnAnalysis.FreeFormLayoutElementProperty

FreeFormLayoutElementProperty Struct

An element within a free-form layout.

Source

Generated code

Type last changed

v2.272.0 · 30 Sep 2026

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 freeFormLayoutElementProperty: quicksight.CfnAnalysis.FreeFormLayoutElementProperty = {
  elementId: 'elementId',
  elementType: 'elementType',
  height: 'height',
  width: 'width',
  xAxisLocation: 'xAxisLocation',
  yAxisLocation: 'yAxisLocation',

  // the properties below are optional
  backgroundStyle: {
    color: 'color',
    visibility: 'visibility',
  },
  borderRadius: 'borderRadius',
  borderStyle: {
    color: 'color',
    visibility: 'visibility',
    width: 'width',
  },
  loadingAnimation: {
    visibility: 'visibility',
  },
  padding: 'padding',
  renderingRules: [{
    configurationOverrides: {
      visibility: 'visibility',
    },
    expression: 'expression',
  }],
  selectedBorderStyle: {
    color: 'color',
    visibility: 'visibility',
    width: 'width',
  },
  visibility: 'visibility',
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

free_form_layout_element_property = quicksight.CfnAnalysis.FreeFormLayoutElementProperty(
    element_id="elementId",
    element_type="elementType",
    height="height",
    width="width",
    x_axis_location="xAxisLocation",
    y_axis_location="yAxisLocation",

    # the properties below are optional
    background_style=quicksight.CfnAnalysis.FreeFormLayoutElementBackgroundStyleProperty(
        color="color",
        visibility="visibility"
    ),
    border_radius="borderRadius",
    border_style=quicksight.CfnAnalysis.FreeFormLayoutElementBorderStyleProperty(
        color="color",
        visibility="visibility",
        width="width"
    ),
    loading_animation=quicksight.CfnAnalysis.LoadingAnimationProperty(
        visibility="visibility"
    ),
    padding="padding",
    rendering_rules=[quicksight.CfnAnalysis.SheetElementRenderingRuleProperty(
        configuration_overrides=quicksight.CfnAnalysis.SheetElementConfigurationOverridesProperty(
            visibility="visibility"
        ),
        expression="expression"
    )],
    selected_border_style=quicksight.CfnAnalysis.FreeFormLayoutElementBorderStyleProperty(
        color="color",
        visibility="visibility",
        width="width"
    ),
    visibility="visibility"
)

// 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())
        .borderRadius("borderRadius")
        .borderStyle(FreeFormLayoutElementBorderStyleProperty.builder()
                .color("color")
                .visibility("visibility")
                .width("width")
                .build())
        .loadingAnimation(LoadingAnimationProperty.builder()
                .visibility("visibility")
                .build())
        .padding("padding")
        .renderingRules(List.of(SheetElementRenderingRuleProperty.builder()
                .configurationOverrides(SheetElementConfigurationOverridesProperty.builder()
                        .visibility("visibility")
                        .build())
                .expression("expression")
                .build()))
        .selectedBorderStyle(FreeFormLayoutElementBorderStyleProperty.builder()
                .color("color")
                .visibility("visibility")
                .width("width")
                .build())
        .visibility("visibility")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var freeFormLayoutElementProperty = new FreeFormLayoutElementProperty {
    ElementId = "elementId",
    ElementType = "elementType",
    Height = "height",
    Width = "width",
    XAxisLocation = "xAxisLocation",
    YAxisLocation = "yAxisLocation",

    // the properties below are optional
    BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
        Color = "color",
        Visibility = "visibility"
    },
    BorderRadius = "borderRadius",
    BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
        Color = "color",
        Visibility = "visibility",
        Width = "width"
    },
    LoadingAnimation = new LoadingAnimationProperty {
        Visibility = "visibility"
    },
    Padding = "padding",
    RenderingRules = new [] { new SheetElementRenderingRuleProperty {
        ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
            Visibility = "visibility"
        },
        Expression = "expression"
    } },
    SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
        Color = "color",
        Visibility = "visibility",
        Width = "width"
    },
    Visibility = "visibility"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

freeFormLayoutElementProperty := &FreeFormLayoutElementProperty{
	ElementId: jsii.String("elementId"),
	ElementType: jsii.String("elementType"),
	Height: jsii.String("height"),
	Width: jsii.String("width"),
	XAxisLocation: jsii.String("xAxisLocation"),
	YAxisLocation: jsii.String("yAxisLocation"),

	// the properties below are optional
	BackgroundStyle: &FreeFormLayoutElementBackgroundStyleProperty{
		Color: jsii.String("color"),
		Visibility: jsii.String("visibility"),
	},
	BorderRadius: jsii.String("borderRadius"),
	BorderStyle: &FreeFormLayoutElementBorderStyleProperty{
		Color: jsii.String("color"),
		Visibility: jsii.String("visibility"),
		Width: jsii.String("width"),
	},
	LoadingAnimation: &LoadingAnimationProperty{
		Visibility: jsii.String("visibility"),
	},
	Padding: jsii.String("padding"),
	RenderingRules: []interface{}{
		&SheetElementRenderingRuleProperty{
			ConfigurationOverrides: &SheetElementConfigurationOverridesProperty{
				Visibility: jsii.String("visibility"),
			},
			Expression: jsii.String("expression"),
		},
	},
	SelectedBorderStyle: &FreeFormLayoutElementBorderStyleProperty{
		Color: jsii.String("color"),
		Visibility: jsii.String("visibility"),
		Width: jsii.String("width"),
	},
	Visibility: jsii.String("visibility"),
}

Properties

backgroundStyle?optionalIResolvable | CfnAnalysis.FreeFormLayoutElementBackgroundStylePropertybackground_style?optionaltyping.Union[IResolvable, FreeFormLayoutElementBackgroundStyleProperty]backgroundStyle?optionalIResolvableBackgroundStyle?optionalIResolvableBackgroundStyle?optionalinterface{}#

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

borderRadius?optionalstringborder_radius?optionalstrborderRadius?optionalStringBorderRadius?optionalstringBorderRadius?optional*string#

borderStyle?optionalIResolvable | CfnAnalysis.FreeFormLayoutElementBorderStylePropertyborder_style?optionaltyping.Union[IResolvable, FreeFormLayoutElementBorderStyleProperty]borderStyle?optionalIResolvableBorderStyle?optionalIResolvableBorderStyle?optionalinterface{}#

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

elementIdstringelement_idstrelementIdStringElementIdstringElementId*stringrequired#

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

elementTypestringelement_typestrelementTypeStringElementTypestringElementType*stringrequired#

The type of element.

heightstringheightstrheightStringHeightstringHeight*stringrequired#

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

loadingAnimation?optionalIResolvable | CfnAnalysis.LoadingAnimationPropertyloading_animation?optionaltyping.Union[IResolvable, LoadingAnimationProperty]loadingAnimation?optionalIResolvableLoadingAnimation?optionalIResolvableLoadingAnimation?optionalinterface{}#

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

padding?optionalstringpadding?optionalstrpadding?optionalStringPadding?optionalstringPadding?optional*string#

renderingRules?optionalIResolvable | IResolvable | CfnAnalysis.SheetElementRenderingRuleProperty[]rendering_rules?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetElementRenderingRuleProperty]]]renderingRules?optionalIResolvableRenderingRules?optionalIResolvableRenderingRules?optionalinterface{}#

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

selectedBorderStyle?optionalIResolvable | CfnAnalysis.FreeFormLayoutElementBorderStylePropertyselected_border_style?optionaltyping.Union[IResolvable, FreeFormLayoutElementBorderStyleProperty]selectedBorderStyle?optionalIResolvableSelectedBorderStyle?optionalIResolvableSelectedBorderStyle?optionalinterface{}#

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

This border style is used when the element is selected.

visibility?optionalstringvisibility?optionalstrvisibility?optionalStringVisibility?optionalstringVisibility?optional*string#

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

widthstringwidthstrwidthStringWidthstringWidth*stringrequired#

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

xAxisLocationstringx_axis_locationstrxAxisLocationStringXAxisLocationstringXAxisLocation*stringrequired#

The x-axis coordinate of the element.

yAxisLocationstringy_axis_locationstryAxisLocationStringYAxisLocationstringYAxisLocation*stringrequired#

The y-axis coordinate of the element.