interface GridLayoutConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.GridLayoutConfigurationProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.GridLayoutConfigurationProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.GridLayoutConfigurationProperty
TypeScript	@aws-cdk/aws-quicksight » CfnTemplate » GridLayoutConfigurationProperty

The configuration for a grid layout. Also called a tiled layout.

Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const gridLayoutConfigurationProperty: quicksight.CfnTemplate.GridLayoutConfigurationProperty = {
  elements: [{
    columnSpan: 123,
    elementId: 'elementId',
    elementType: 'elementType',
    rowSpan: 123,

    // the properties below are optional
    columnIndex: 123,
    rowIndex: 123,
  }],

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

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

Properties

Name	Type	Description
elements	IResolvable | IResolvable | GridLayoutElementProperty[]	The elements that are included in a grid layout.
canvasSizeOptions?	IResolvable | GridLayoutCanvasSizeOptionsProperty	CfnTemplate.GridLayoutConfigurationProperty.CanvasSizeOptions.

---

elements

Type: IResolvable | IResolvable | GridLayoutElementProperty[]

The elements that are included in a grid layout.

---

canvasSizeOptions?

Type: IResolvable | GridLayoutCanvasSizeOptionsProperty (optional)

CfnTemplate.GridLayoutConfigurationProperty.CanvasSizeOptions.