Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.LayoutProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnAnalysis.LayoutProperty.Jsii$Proxy
Enclosing class:
CfnAnalysis
@Stability(Stable) public static interface CfnAnalysis.LayoutProperty extends software.amazon.jsii.JsiiSerializable
A Layout defines the placement of elements within a sheet.

For more information, see Types of layout in the Amazon QuickSight User Guide .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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.*;
 LayoutProperty layoutProperty = LayoutProperty.builder()
         .configuration(LayoutConfigurationProperty.builder()
                 .freeFormLayout(FreeFormLayoutConfigurationProperty.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()))
                         // the properties below are optional
                         .canvasSizeOptions(FreeFormLayoutCanvasSizeOptionsProperty.builder()
                                 .screenCanvasSizeOptions(FreeFormLayoutScreenCanvasSizeOptionsProperty.builder()
                                         .optimizedViewPortWidth("optimizedViewPortWidth")
                                         .build())
                                 .build())
                         .build())
                 .gridLayout(GridLayoutConfigurationProperty.builder()
                         .elements(List.of(GridLayoutElementProperty.builder()
                                 .columnSpan(123)
                                 .elementId("elementId")
                                 .elementType("elementType")
                                 .rowSpan(123)
                                 // the properties below are optional
                                 .columnIndex(123)
                                 .rowIndex(123)
                                 .build()))
                         // the properties below are optional
                         .canvasSizeOptions(GridLayoutCanvasSizeOptionsProperty.builder()
                                 .screenCanvasSizeOptions(GridLayoutScreenCanvasSizeOptionsProperty.builder()
                                         .resizeOption("resizeOption")
                                         // the properties below are optional
                                         .optimizedViewPortWidth("optimizedViewPortWidth")
                                         .build())
                                 .build())
                         .build())
                 .sectionBasedLayout(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())
                 .build())
         .build();

See Also: