AWS CDK Reference

Appearance

v2.273.0

FreeFormLayoutElementProperty Struct ​

An element within a free-form layout.

Source
Generated code
Type last changed
v2.234.0 · 8 Jan 2026

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 freeFormLayoutElementProperty: quicksight.CfnDashboard.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',
};

Properties ​

backgroundStyleIResolvable | CfnDashboard.FreeFormLayoutElementBackgroundStylePropertybackground_styletyping.Union[IResolvable, FreeFormLayoutElementBackgroundStyleProperty]backgroundStyleIResolvableBackgroundStyleIResolvableBackgroundStyleinterface{}#
The background style configuration of a free-form layout element.
borderRadiusstringborder_radiusstrborderRadiusStringBorderRadiusstringBorderRadius*string#
The border radius of a free-form layout element.
borderStyleIResolvable | CfnDashboard.FreeFormLayoutElementBorderStylePropertyborder_styletyping.Union[IResolvable, FreeFormLayoutElementBorderStyleProperty]borderStyleIResolvableBorderStyleIResolvableBorderStyleinterface{}#
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.
loadingAnimationIResolvable | CfnDashboard.LoadingAnimationPropertyloading_animationtyping.Union[IResolvable, LoadingAnimationProperty]loadingAnimationIResolvableLoadingAnimationIResolvableLoadingAnimationinterface{}#
The loading animation configuration of a free-form layout element.
paddingstringpaddingstrpaddingStringPaddingstringPadding*string#
The padding of a free-form layout element.
renderingRulesIResolvable | IResolvable | CfnDashboard.SheetElementRenderingRuleProperty[]rendering_rulestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetElementRenderingRuleProperty]]]renderingRulesIResolvableRenderingRulesIResolvableRenderingRulesinterface{}#
The rendering rules that determine when an element should be displayed within a free-form layout.
selectedBorderStyleIResolvable | CfnDashboard.FreeFormLayoutElementBorderStylePropertyselected_border_styletyping.Union[IResolvable, FreeFormLayoutElementBorderStyleProperty]selectedBorderStyleIResolvableSelectedBorderStyleIResolvableSelectedBorderStyleinterface{}#
The border style configuration of a free-form layout element.

This border style is used when the element is selected.

visibilitystringvisibilitystrvisibilityStringVisibilitystringVisibility*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.