Skip to content
v2.274.0

FreeFormLayoutElementProperty Struct ​

An element within 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 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',
};

Properties ​

backgroundStyleoptionalIResolvable | CfnAnalysis.FreeFormLayoutElementBackgroundStylePropertybackground_styleoptionaltyping.Union[IResolvable, FreeFormLayoutElementBackgroundStyleProperty]backgroundStyleoptionalIResolvableBackgroundStyleoptionalIResolvableBackgroundStyleoptionalinterface{}#
The background style configuration of a free-form layout element.
borderRadiusoptionalstringborder_radiusoptionalstrborderRadiusoptionalStringBorderRadiusoptionalstringBorderRadiusoptional*string#
borderStyleoptionalIResolvable | CfnAnalysis.FreeFormLayoutElementBorderStylePropertyborder_styleoptionaltyping.Union[IResolvable, FreeFormLayoutElementBorderStyleProperty]borderStyleoptionalIResolvableBorderStyleoptionalIResolvableBorderStyleoptionalinterface{}#
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.
loadingAnimationoptionalIResolvable | CfnAnalysis.LoadingAnimationPropertyloading_animationoptionaltyping.Union[IResolvable, LoadingAnimationProperty]loadingAnimationoptionalIResolvableLoadingAnimationoptionalIResolvableLoadingAnimationoptionalinterface{}#
The loading animation configuration of a free-form layout element.
paddingoptionalstringpaddingoptionalstrpaddingoptionalStringPaddingoptionalstringPaddingoptional*string#
renderingRulesoptionalIResolvable | IResolvable | CfnAnalysis.SheetElementRenderingRuleProperty[]rendering_rulesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetElementRenderingRuleProperty]]]renderingRulesoptionalIResolvableRenderingRulesoptionalIResolvableRenderingRulesoptionalinterface{}#
The rendering rules that determine when an element should be displayed within a free-form layout.
selectedBorderStyleoptionalIResolvable | CfnAnalysis.FreeFormLayoutElementBorderStylePropertyselected_border_styleoptionaltyping.Union[IResolvable, FreeFormLayoutElementBorderStyleProperty]selectedBorderStyleoptionalIResolvableSelectedBorderStyleoptionalIResolvableSelectedBorderStyleoptionalinterface{}#
The border style configuration of a free-form layout element.

This border style is used when the element is selected.

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