Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.HeaderFooterSectionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.HeaderFooterSectionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.HeaderFooterSectionConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.quicksight.*;
 HeaderFooterSectionConfigurationProperty headerFooterSectionConfigurationProperty = HeaderFooterSectionConfigurationProperty.builder()
         .layout(SectionLayoutConfigurationProperty.builder()
                 .freeFormLayout(FreeFormSectionLayoutConfigurationProperty.builder()
                         .elements(List.of(FreeFormLayoutElementProperty.builder()
                                 .elementId("elementId")
                                 .elementType("elementType")
                                 .height("height")
                                 .width("width")
                                 .xAxisLocation("xAxisLocation")
                                 .yAxisLocation("yAxisLocation")
                                 // the properties below are optional
                                 .backgroundStyle(FreeFormLayoutElementBackgroundStyleProperty.builder()
                                         .color("color")
                                         .visibility("visibility")
                                         .build())
                                 .borderStyle(FreeFormLayoutElementBorderStyleProperty.builder()
                                         .color("color")
                                         .visibility("visibility")
                                         .build())
                                 .loadingAnimation(LoadingAnimationProperty.builder()
                                         .visibility("visibility")
                                         .build())
                                 .renderingRules(List.of(SheetElementRenderingRuleProperty.builder()
                                         .configurationOverrides(SheetElementConfigurationOverridesProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .expression("expression")
                                         .build()))
                                 .selectedBorderStyle(FreeFormLayoutElementBorderStyleProperty.builder()
                                         .color("color")
                                         .visibility("visibility")
                                         .build())
                                 .visibility("visibility")
                                 .build()))
                         .build())
                 .build())
         .sectionId("sectionId")
         // the properties below are optional
         .style(SectionStyleProperty.builder()
                 .height("height")
                 .padding(SpacingProperty.builder()
                         .bottom("bottom")
                         .left("left")
                         .right("right")
                         .top("top")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.HeaderFooterSectionConfigurationProperty.Builder	A builder for CfnDashboard.HeaderFooterSectionConfigurationProperty
static final class	CfnDashboard.HeaderFooterSectionConfigurationProperty.Jsii$Proxy	An implementation for CfnDashboard.HeaderFooterSectionConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.HeaderFooterSectionConfigurationProperty.Builder	builder()
Object	getLayout()	The layout configuration of the header or footer section.
String	getSectionId()	The unique identifier of the header or footer section.
default Object	getStyle()	The style options of a header or footer section.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLayout

@Stability(Stable)
@NotNull
Object getLayout()

The layout configuration of the header or footer section.

Returns union: either IResolvable or CfnDashboard.SectionLayoutConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html#cfn-quicksight-dashboard-headerfootersectionconfiguration-layout

getSectionId

@Stability(Stable)
@NotNull
String getSectionId()

The unique identifier of the header or footer section.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html#cfn-quicksight-dashboard-headerfootersectionconfiguration-sectionid

getStyle

@Stability(Stable)
@Nullable
default Object getStyle()

The style options of a header or footer section.

Returns union: either IResolvable or CfnDashboard.SectionStyleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-headerfootersectionconfiguration.html#cfn-quicksight-dashboard-headerfootersectionconfiguration-style

builder

@Stability(Stable)
static CfnDashboard.HeaderFooterSectionConfigurationProperty.Builder builder()

Returns:

a CfnDashboard.HeaderFooterSectionConfigurationProperty.Builder of CfnDashboard.HeaderFooterSectionConfigurationProperty