aws-cdk-lib.aws_quicksight.CfnDashboard.FreeFormLayoutConfigurationProperty

FreeFormLayoutConfigurationProperty Struct

The configuration of 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';

declare const type: any;
const freeFormLayoutConfigurationProperty: quicksight.CfnDashboard.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,
    }],
  }],
};

Properties

canvasSizeOptionsIResolvable | CfnDashboard.FreeFormLayoutCanvasSizeOptionsPropertycanvas_size_optionstyping.Union[IResolvable, FreeFormLayoutCanvasSizeOptionsProperty]canvasSizeOptionsIResolvableCanvasSizeOptionsIResolvableCanvasSizeOptionsinterface{}#

elementsIResolvable | IResolvable | CfnDashboard.FreeFormLayoutElementProperty[]elementstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FreeFormLayoutElementProperty]]]elementsIResolvableElementsIResolvableElementsinterface{}required#

The elements that are included in a free-form layout.

groupsIResolvable | IResolvable | CfnDashboard.SheetLayoutGroupProperty[]groupstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SheetLayoutGroupProperty]]]groupsIResolvableGroupsIResolvableGroupsinterface{}#