aws-cdk-lib.aws_quicksight.CfnTemplate.GridLayoutConfigurationProperty

GridLayoutConfigurationProperty Struct

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.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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';
const gridLayoutConfigurationProperty: quicksight.CfnTemplate.GridLayoutConfigurationProperty = {
  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

canvasSizeOptionsIResolvable | CfnTemplate.GridLayoutCanvasSizeOptionsPropertycanvas_size_optionstyping.Union[IResolvable, GridLayoutCanvasSizeOptionsProperty]canvasSizeOptionsIResolvableCanvasSizeOptionsIResolvableCanvasSizeOptionsinterface{}#

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

The elements that are included in a grid layout.