interface BodySectionConfigurationProperty

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

The configuration of a body section.

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 bodySectionConfigurationProperty: quicksight.CfnTemplate.BodySectionConfigurationProperty = {
  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',
    },
  },
};

Properties

Name	Type	Description
content	`IResolvable` `\|` `BodySectionContentProperty`	The configuration of content in a body section.
sectionId	`string`	The unique identifier of a body section.
pageBreakConfiguration?	`IResolvable` `\|` `SectionPageBreakConfigurationProperty`	The configuration of a page break for a section.
repeatConfiguration?	`IResolvable` `\|` `BodySectionRepeatConfigurationProperty`	Describes the configurations that are required to declare a section as repeating.
style?	`IResolvable` `\|` `SectionStyleProperty`	The style options of a body section.

content

Type: IResolvable | BodySectionContentProperty

The configuration of content in a body section.

sectionId

Type: string

The unique identifier of a body section.

pageBreakConfiguration?

Type: IResolvable | SectionPageBreakConfigurationProperty (optional)

The configuration of a page break for a section.

repeatConfiguration?

Type: IResolvable | BodySectionRepeatConfigurationProperty (optional)

Describes the configurations that are required to declare a section as repeating.

style?

Type: IResolvable | SectionStyleProperty (optional)

The style options of a body section.

Select your cookie preferences