Skip to content
v2.275.0

SheetControlLayoutProperty Struct ​

A grid layout to define the placement of sheet control.

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 sheetControlLayoutProperty: quicksight.CfnTemplate.SheetControlLayoutProperty = {
  configuration: {
    gridLayout: {
      elements: [{
        columnSpan: 123,
        elementId: 'elementId',
        elementType: 'elementType',
        rowSpan: 123,

        // the properties below are optional
        backgroundStyle: {
          color: 'color',
          visibility: 'visibility',
        },
        borderRadius: 'borderRadius',
        borderStyle: {
          color: 'color',
          visibility: 'visibility',
          width: 'width',
        },
        columnIndex: 123,
        loadingAnimation: {
          visibility: 'visibility',
        },
        padding: 'padding',
        rowIndex: 123,
        selectedBorderStyle: {
          color: 'color',
          visibility: 'visibility',
          width: 'width',
        },
      }],

      // the properties below are optional
      canvasSizeOptions: {
        screenCanvasSizeOptions: {
          resizeOption: 'resizeOption',

          // the properties below are optional
          optimizedViewPortWidth: 'optimizedViewPortWidth',
        },
      },
    },
  },
};

Properties ​

configurationIResolvable | CfnTemplate.SheetControlLayoutConfigurationPropertyconfigurationtyping.Union[IResolvable, SheetControlLayoutConfigurationProperty]configurationIResolvableConfigurationIResolvableConfigurationinterface{}required#
The configuration that determines the elements and canvas size options of sheet control.