Skip to content
v2.277.0

FreeFormLayoutConfigurationProperty Struct ​

The configuration of a free-form layout.

Example ​

ts
// 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 freeFormLayoutConfigurationProperty: quicksight.CfnAnalysis.FreeFormLayoutConfigurationProperty = {
  elements: [{
    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 properties below are optional
  canvasSizeOptions: {
    screenCanvasSizeOptions: {
      optimizedViewPortWidth: 'optimizedViewPortWidth',
    },
  },
  groups: [{
    id: 'id',
    members: [{
      id: 'id',
      type: 'type',
    }],
  }],
};
python
# 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_configuration_property = quicksight.CfnAnalysis.FreeFormLayoutConfigurationProperty(
    elements=[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 properties below are optional
    canvas_size_options=quicksight.CfnAnalysis.FreeFormLayoutCanvasSizeOptionsProperty(
        screen_canvas_size_options=quicksight.CfnAnalysis.FreeFormLayoutScreenCanvasSizeOptionsProperty(
            optimized_view_port_width="optimizedViewPortWidth"
        )
    ),
    groups=[quicksight.CfnAnalysis.SheetLayoutGroupProperty(
        id="id",
        members=[quicksight.CfnAnalysis.SheetLayoutGroupMemberProperty(
            id="id",
            type="type"
        )]
    )]
)
java
// 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.*;

FreeFormLayoutConfigurationProperty freeFormLayoutConfigurationProperty = FreeFormLayoutConfigurationProperty.builder()
        .elements(List.of(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()))

        // the properties below are optional
        .canvasSizeOptions(FreeFormLayoutCanvasSizeOptionsProperty.builder()
                .screenCanvasSizeOptions(FreeFormLayoutScreenCanvasSizeOptionsProperty.builder()
                        .optimizedViewPortWidth("optimizedViewPortWidth")
                        .build())
                .build())
        .groups(List.of(SheetLayoutGroupProperty.builder()
                .id("id")
                .members(List.of(SheetLayoutGroupMemberProperty.builder()
                        .id("id")
                        .type("type")
                        .build()))
                .build()))
        .build();
csharp
// 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 freeFormLayoutConfigurationProperty = new FreeFormLayoutConfigurationProperty {
    Elements = new [] { 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"
    } },

    // the properties below are optional
    CanvasSizeOptions = new FreeFormLayoutCanvasSizeOptionsProperty {
        ScreenCanvasSizeOptions = new FreeFormLayoutScreenCanvasSizeOptionsProperty {
            OptimizedViewPortWidth = "optimizedViewPortWidth"
        }
    },
    Groups = new [] { new SheetLayoutGroupProperty {
        Id = "id",
        Members = new [] { new SheetLayoutGroupMemberProperty {
            Id = "id",
            Type = "type"
        } }
    } }
};
go
// 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"

freeFormLayoutConfigurationProperty := &FreeFormLayoutConfigurationProperty{
	Elements: []interface{}{
		&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"),
		},
	},

	// the properties below are optional
	CanvasSizeOptions: &FreeFormLayoutCanvasSizeOptionsProperty{
		ScreenCanvasSizeOptions: &FreeFormLayoutScreenCanvasSizeOptionsProperty{
			OptimizedViewPortWidth: jsii.String("optimizedViewPortWidth"),
		},
	},
	Groups: []interface{}{
		&SheetLayoutGroupProperty{
			Id: jsii.String("id"),
			Members: []interface{}{
				&SheetLayoutGroupMemberProperty{
					Id: jsii.String("id"),
					Type: jsii.String("type"),
				},
			},
		},
	},
}

Properties ​

canvasSizeOptionsoptionalIResolvable | CfnAnalysis.FreeFormLayoutCanvasSizeOptionsPropertycanvas_size_optionsoptionaltyping.Union[IResolvable, FreeFormLayoutCanvasSizeOptionsProperty]canvasSizeOptionsoptionalIResolvableCanvasSizeOptionsoptionalIResolvableCanvasSizeOptionsoptionalinterface{} #
elementsIResolvable | IResolvable | CfnAnalysis.FreeFormLayoutElementProperty[]elementstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FreeFormLayoutElementProperty]]]elementsIResolvableElementsIResolvableElementsinterface{} required #
The elements that are included in a free-form layout.
groupsoptionalIResolvable | IResolvable | CfnAnalysis.SheetLayoutGroupProperty[]groupsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetLayoutGroupProperty]]]groupsoptionalIResolvableGroupsoptionalIResolvableGroupsoptionalinterface{} #