aws-cdk-lib.aws_quicksight.CfnAnalysis.LayoutProperty

LayoutProperty Struct

A Layout defines the placement of elements within a sheet.

For more information, see Types of layout in the Amazon Quick Suite User Guide .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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';

declare const type: any;
const layoutProperty: quicksight.CfnAnalysis.LayoutProperty = {
  configuration: {
    freeFormLayout: {
      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,
        }],
      }],
    },
    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',
        },
      },
    },
    sectionBasedLayout: {
      bodySections: [{
        content: {
          layout: {
            freeFormLayout: {
              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',
              }],
            },
          },
        },
        sectionId: 'sectionId',

        // the properties below are optional
        pageBreakConfiguration: {
          after: {
            status: 'status',
          },
        },
        repeatConfiguration: {
          dimensionConfigurations: [{
            dynamicCategoryDimensionConfiguration: {
              column: {
                columnName: 'columnName',

                // the properties below are optional
                dataSetIdentifier: 'dataSetIdentifier',
                topicIdentifier: 'topicIdentifier',
              },

              // the properties below are optional
              limit: 123,
              sortByMetrics: [{
                direction: 'direction',
                sortBy: {
                  columnName: 'columnName',

                  // the properties below are optional
                  dataSetIdentifier: 'dataSetIdentifier',
                  topicIdentifier: 'topicIdentifier',
                },

                // the properties below are optional
                aggregationFunction: {
                  attributeAggregationFunction: {
                    simpleAttributeAggregation: 'simpleAttributeAggregation',
                    valueForMultipleValues: 'valueForMultipleValues',
                  },
                  categoricalAggregationFunction: 'categoricalAggregationFunction',
                  dateAggregationFunction: 'dateAggregationFunction',
                  numericalAggregationFunction: {
                    percentileAggregation: {
                      percentileValue: 123,
                    },
                    simpleNumericalAggregation: 'simpleNumericalAggregation',
                  },
                },
              }],
            },
            dynamicNumericDimensionConfiguration: {
              column: {
                columnName: 'columnName',

                // the properties below are optional
                dataSetIdentifier: 'dataSetIdentifier',
                topicIdentifier: 'topicIdentifier',
              },

              // the properties below are optional
              limit: 123,
              sortByMetrics: [{
                direction: 'direction',
                sortBy: {
                  columnName: 'columnName',

                  // the properties below are optional
                  dataSetIdentifier: 'dataSetIdentifier',
                  topicIdentifier: 'topicIdentifier',
                },

                // the properties below are optional
                aggregationFunction: {
                  attributeAggregationFunction: {
                    simpleAttributeAggregation: 'simpleAttributeAggregation',
                    valueForMultipleValues: 'valueForMultipleValues',
                  },
                  categoricalAggregationFunction: 'categoricalAggregationFunction',
                  dateAggregationFunction: 'dateAggregationFunction',
                  numericalAggregationFunction: {
                    percentileAggregation: {
                      percentileValue: 123,
                    },
                    simpleNumericalAggregation: 'simpleNumericalAggregation',
                  },
                },
              }],
            },
          }],
          nonRepeatingVisuals: ['nonRepeatingVisuals'],
          pageBreakConfiguration: {
            after: {
              status: 'status',
            },
          },
        },
        style: {
          height: 'height',
          padding: {
            bottom: 'bottom',
            left: 'left',
            right: 'right',
            top: 'top',
          },
        },
      }],
      canvasSizeOptions: {
        paperCanvasSizeOptions: {
          paperMargin: {
            bottom: 'bottom',
            left: 'left',
            right: 'right',
            top: 'top',
          },
          paperOrientation: 'paperOrientation',
          paperSize: 'paperSize',
        },
      },
      footerSections: [{
        layout: {
          freeFormLayout: {
            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',
            }],
          },
        },
        sectionId: 'sectionId',

        // the properties below are optional
        style: {
          height: 'height',
          padding: {
            bottom: 'bottom',
            left: 'left',
            right: 'right',
            top: 'top',
          },
        },
      }],
      headerSections: [{
        layout: {
          freeFormLayout: {
            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',
            }],
          },
        },
        sectionId: 'sectionId',

        // the properties below are optional
        style: {
          height: 'height',
          padding: {
            bottom: 'bottom',
            left: 'left',
            right: 'right',
            top: 'top',
          },
        },
      }],
    },
  },
};

Properties

configurationIResolvable | CfnAnalysis.LayoutConfigurationPropertyconfigurationtyping.Union[IResolvable, LayoutConfigurationProperty]configurationIResolvableConfigurationIResolvableConfigurationinterface{}required#

The configuration that determines what the type of layout for a sheet.