aws-cdk-lib.aws_quicksight.CfnAnalysis.HeaderFooterSectionConfigurationProperty

interface HeaderFooterSectionConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnAnalysis.HeaderFooterSectionConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_HeaderFooterSectionConfigurationProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnAnalysis.HeaderFooterSectionConfigurationProperty
Pythonaws_cdk.aws_quicksight.CfnAnalysis.HeaderFooterSectionConfigurationProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnAnalysis » HeaderFooterSectionConfigurationProperty

The configuration of a header or footer 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 headerFooterSectionConfigurationProperty: quicksight.CfnAnalysis.HeaderFooterSectionConfigurationProperty = {
  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

NameTypeDescription
layoutIResolvable | SectionLayoutConfigurationPropertyThe layout configuration of the header or footer section.
sectionIdstringThe unique identifier of the header or footer section.
style?IResolvable | SectionStylePropertyThe style options of a header or footer section.

layout

Type: IResolvable | SectionLayoutConfigurationProperty

The layout configuration of the header or footer section.


sectionId

Type: string

The unique identifier of the header or footer section.


style?

Type: IResolvable | SectionStyleProperty (optional)

The style options of a header or footer section.