interface SectionBasedLayoutConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnAnalysis.SectionBasedLayoutConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_SectionBasedLayoutConfigurationProperty
Java	software.amazon.awscdk.services.quicksight.CfnAnalysis.SectionBasedLayoutConfigurationProperty
Python	aws_cdk.aws_quicksight.CfnAnalysis.SectionBasedLayoutConfigurationProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnAnalysis » SectionBasedLayoutConfigurationProperty

The configuration for a section-based layout.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html

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',
            },
            borderStyle: {
              color: 'color',
              visibility: 'visibility',
            },
            loadingAnimation: {
              visibility: 'visibility',
            },
            renderingRules: [{
              configurationOverrides: {
                visibility: 'visibility',
              },
              expression: 'expression',
            }],
            selectedBorderStyle: {
              color: 'color',
              visibility: 'visibility',
            },
            visibility: 'visibility',
          }],
        },
      },
    },
    sectionId: 'sectionId',

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

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

            // 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',
            dataSetIdentifier: 'dataSetIdentifier',
          },

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

            // 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',
          },
          borderStyle: {
            color: 'color',
            visibility: 'visibility',
          },
          loadingAnimation: {
            visibility: 'visibility',
          },
          renderingRules: [{
            configurationOverrides: {
              visibility: 'visibility',
            },
            expression: 'expression',
          }],
          selectedBorderStyle: {
            color: 'color',
            visibility: 'visibility',
          },
          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',
          },
          borderStyle: {
            color: 'color',
            visibility: 'visibility',
          },
          loadingAnimation: {
            visibility: 'visibility',
          },
          renderingRules: [{
            configurationOverrides: {
              visibility: 'visibility',
            },
            expression: 'expression',
          }],
          selectedBorderStyle: {
            color: 'color',
            visibility: 'visibility',
          },
          visibility: 'visibility',
        }],
      },
    },
    sectionId: 'sectionId',

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

Properties

Name	Type	Description
bodySections	IResolvable | (IResolvable | BodySectionConfigurationProperty)[]	A list of body section configurations.
canvasSizeOptions	IResolvable | SectionBasedLayoutCanvasSizeOptionsProperty	The options for the canvas of a section-based layout.
footerSections	IResolvable | (IResolvable | HeaderFooterSectionConfigurationProperty)[]	A list of footer section configurations.
headerSections	IResolvable | (IResolvable | HeaderFooterSectionConfigurationProperty)[]	A list of header section configurations.

---

bodySections

Type: IResolvable | (IResolvable | BodySectionConfigurationProperty)[]

A list of body section configurations.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html#cfn-quicksight-analysis-sectionbasedlayoutconfiguration-bodysections

---

canvasSizeOptions

Type: IResolvable | SectionBasedLayoutCanvasSizeOptionsProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html#cfn-quicksight-analysis-sectionbasedlayoutconfiguration-canvassizeoptions

---

footerSections

Type: IResolvable | (IResolvable | HeaderFooterSectionConfigurationProperty)[]

A list of footer section configurations.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html#cfn-quicksight-analysis-sectionbasedlayoutconfiguration-footersections

---

headerSections

Type: IResolvable | (IResolvable | HeaderFooterSectionConfigurationProperty)[]

A list of header section configurations.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sectionbasedlayoutconfiguration.html#cfn-quicksight-analysis-sectionbasedlayoutconfiguration-headersections