aws-cdk-lib.aws_quicksight.CfnAnalysis.SectionBasedLayoutConfigurationProperty

SectionBasedLayoutConfigurationProperty Struct

The configuration for a section-based layout.

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 sectionBasedLayoutConfigurationProperty: quicksight.CfnAnalysis.SectionBasedLayoutConfigurationProperty = {
  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

bodySectionsIResolvable | IResolvable | CfnAnalysis.BodySectionConfigurationProperty[]body_sectionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BodySectionConfigurationProperty]]]bodySectionsIResolvableBodySectionsIResolvableBodySectionsinterface{}required#

A list of body section configurations.

canvasSizeOptionsIResolvable | CfnAnalysis.SectionBasedLayoutCanvasSizeOptionsPropertycanvas_size_optionstyping.Union[IResolvable, SectionBasedLayoutCanvasSizeOptionsProperty]canvasSizeOptionsIResolvableCanvasSizeOptionsIResolvableCanvasSizeOptionsinterface{}required#

The options for the canvas of a section-based layout.

footerSectionsIResolvable | IResolvable | CfnAnalysis.HeaderFooterSectionConfigurationProperty[]footer_sectionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HeaderFooterSectionConfigurationProperty]]]footerSectionsIResolvableFooterSectionsIResolvableFooterSectionsinterface{}required#

A list of footer section configurations.

headerSectionsIResolvable | IResolvable | CfnAnalysis.HeaderFooterSectionConfigurationProperty[]header_sectionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HeaderFooterSectionConfigurationProperty]]]headerSectionsIResolvableHeaderSectionsIResolvableHeaderSectionsinterface{}required#

A list of header section configurations.