Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.SectionBasedLayoutConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.SectionBasedLayoutConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

The configuration for a section-based layout.

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.*;
 SectionBasedLayoutConfigurationProperty sectionBasedLayoutConfigurationProperty = SectionBasedLayoutConfigurationProperty.builder()
         .bodySections(List.of(BodySectionConfigurationProperty.builder()
                 .content(BodySectionContentProperty.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())
                         .build())
                 .sectionId("sectionId")
                 // the properties below are optional
                 .pageBreakConfiguration(SectionPageBreakConfigurationProperty.builder()
                         .after(SectionAfterPageBreakProperty.builder()
                                 .status("status")
                                 .build())
                         .build())
                 .repeatConfiguration(BodySectionRepeatConfigurationProperty.builder()
                         .dimensionConfigurations(List.of(BodySectionRepeatDimensionConfigurationProperty.builder()
                                 .dynamicCategoryDimensionConfiguration(BodySectionDynamicCategoryDimensionConfigurationProperty.builder()
                                         .column(ColumnIdentifierProperty.builder()
                                                 .columnName("columnName")
                                                 .dataSetIdentifier("dataSetIdentifier")
                                                 .build())
                                         // the properties below are optional
                                         .limit(123)
                                         .sortByMetrics(List.of(ColumnSortProperty.builder()
                                                 .direction("direction")
                                                 .sortBy(ColumnIdentifierProperty.builder()
                                                         .columnName("columnName")
                                                         .dataSetIdentifier("dataSetIdentifier")
                                                         .build())
                                                 // the properties below are optional
                                                 .aggregationFunction(AggregationFunctionProperty.builder()
                                                         .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                                                                 .simpleAttributeAggregation("simpleAttributeAggregation")
                                                                 .valueForMultipleValues("valueForMultipleValues")
                                                                 .build())
                                                         .categoricalAggregationFunction("categoricalAggregationFunction")
                                                         .dateAggregationFunction("dateAggregationFunction")
                                                         .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                                                 .percentileAggregation(PercentileAggregationProperty.builder()
                                                                         .percentileValue(123)
                                                                         .build())
                                                                 .simpleNumericalAggregation("simpleNumericalAggregation")
                                                                 .build())
                                                         .build())
                                                 .build()))
                                         .build())
                                 .dynamicNumericDimensionConfiguration(BodySectionDynamicNumericDimensionConfigurationProperty.builder()
                                         .column(ColumnIdentifierProperty.builder()
                                                 .columnName("columnName")
                                                 .dataSetIdentifier("dataSetIdentifier")
                                                 .build())
                                         // the properties below are optional
                                         .limit(123)
                                         .sortByMetrics(List.of(ColumnSortProperty.builder()
                                                 .direction("direction")
                                                 .sortBy(ColumnIdentifierProperty.builder()
                                                         .columnName("columnName")
                                                         .dataSetIdentifier("dataSetIdentifier")
                                                         .build())
                                                 // the properties below are optional
                                                 .aggregationFunction(AggregationFunctionProperty.builder()
                                                         .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                                                                 .simpleAttributeAggregation("simpleAttributeAggregation")
                                                                 .valueForMultipleValues("valueForMultipleValues")
                                                                 .build())
                                                         .categoricalAggregationFunction("categoricalAggregationFunction")
                                                         .dateAggregationFunction("dateAggregationFunction")
                                                         .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                                                 .percentileAggregation(PercentileAggregationProperty.builder()
                                                                         .percentileValue(123)
                                                                         .build())
                                                                 .simpleNumericalAggregation("simpleNumericalAggregation")
                                                                 .build())
                                                         .build())
                                                 .build()))
                                         .build())
                                 .build()))
                         .nonRepeatingVisuals(List.of("nonRepeatingVisuals"))
                         .pageBreakConfiguration(BodySectionRepeatPageBreakConfigurationProperty.builder()
                                 .after(SectionAfterPageBreakProperty.builder()
                                         .status("status")
                                         .build())
                                 .build())
                         .build())
                 .style(SectionStyleProperty.builder()
                         .height("height")
                         .padding(SpacingProperty.builder()
                                 .bottom("bottom")
                                 .left("left")
                                 .right("right")
                                 .top("top")
                                 .build())
                         .build())
                 .build()))
         .canvasSizeOptions(SectionBasedLayoutCanvasSizeOptionsProperty.builder()
                 .paperCanvasSizeOptions(SectionBasedLayoutPaperCanvasSizeOptionsProperty.builder()
                         .paperMargin(SpacingProperty.builder()
                                 .bottom("bottom")
                                 .left("left")
                                 .right("right")
                                 .top("top")
                                 .build())
                         .paperOrientation("paperOrientation")
                         .paperSize("paperSize")
                         .build())
                 .build())
         .footerSections(List.of(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()))
         .headerSections(List.of(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()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.SectionBasedLayoutConfigurationProperty.Builder	builder()
Object	getBodySections()	A list of body section configurations.
Object	getCanvasSizeOptions()	The options for the canvas of a section-based layout.
Object	getFooterSections()	A list of footer section configurations.
Object	getHeaderSections()	A list of header section configurations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBodySections

@Stability(Stable)
@NotNull
Object getBodySections()

A list of body section configurations.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDashboard.BodySectionConfigurationProperty>

See Also:

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

getCanvasSizeOptions

@Stability(Stable)
@NotNull
Object getCanvasSizeOptions()

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

Returns union: either IResolvable or CfnDashboard.SectionBasedLayoutCanvasSizeOptionsProperty

See Also:

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

getFooterSections

@Stability(Stable)
@NotNull
Object getFooterSections()

A list of footer section configurations.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDashboard.HeaderFooterSectionConfigurationProperty>

See Also:

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

getHeaderSections

@Stability(Stable)
@NotNull
Object getHeaderSections()

A list of header section configurations.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDashboard.HeaderFooterSectionConfigurationProperty>

See Also:

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

builder

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

Returns:

a CfnDashboard.SectionBasedLayoutConfigurationProperty.Builder of CfnDashboard.SectionBasedLayoutConfigurationProperty