Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.LayoutConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.LayoutConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.LayoutConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration that determines what the type of layout will be used on a sheet.

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.*;
 LayoutConfigurationProperty layoutConfigurationProperty = 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())
                         .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.LayoutConfigurationProperty.Builder	builder()
default Object	getFreeFormLayout()	A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
default Object	getGridLayout()	A type of layout that can be used on a sheet.
default Object	getSectionBasedLayout()	A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFreeFormLayout

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

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

getGridLayout

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

A type of layout that can be used on a sheet.

In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE .

getSectionBasedLayout

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

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

builder

@Stability(Stable)
static CfnTemplate.LayoutConfigurationProperty.Builder builder()

Returns:

a CfnTemplate.LayoutConfigurationProperty.Builder of CfnTemplate.LayoutConfigurationProperty