SectionBasedLayoutConfigurationProperty Struct
The configuration for a section-based layout.
| Source | |
|---|---|
| Type last changed |
Example
ts
// 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 sectionBasedLayoutConfigurationProperty: quicksight.CfnTemplate.SectionBasedLayoutConfigurationProperty = {
bodySections: [{
content: {
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
pageBreakConfiguration: {
after: {
status: 'status',
},
},
repeatConfiguration: {
dimensionConfigurations: [{
dynamicCategoryDimensionConfiguration: {
column: {
columnName: 'columnName',
// the properties below are optional
dataSetIdentifier: 'dataSetIdentifier',
topicIdentifier: 'topicIdentifier',
},
// the properties below are optional
limit: 123,
sortByMetrics: [{
direction: 'direction',
sortBy: {
columnName: 'columnName',
// the properties below are optional
dataSetIdentifier: 'dataSetIdentifier',
topicIdentifier: 'topicIdentifier',
},
// the properties below are optional
aggregationFunction: {
attributeAggregationFunction: {
simpleAttributeAggregation: 'simpleAttributeAggregation',
valueForMultipleValues: 'valueForMultipleValues',
},
categoricalAggregationFunction: 'categoricalAggregationFunction',
dateAggregationFunction: 'dateAggregationFunction',
numericalAggregationFunction: {
percentileAggregation: {
percentileValue: 123,
},
simpleNumericalAggregation: 'simpleNumericalAggregation',
},
},
}],
},
dynamicNumericDimensionConfiguration: {
column: {
columnName: 'columnName',
// the properties below are optional
dataSetIdentifier: 'dataSetIdentifier',
topicIdentifier: 'topicIdentifier',
},
// the properties below are optional
limit: 123,
sortByMetrics: [{
direction: 'direction',
sortBy: {
columnName: 'columnName',
// the properties below are optional
dataSetIdentifier: 'dataSetIdentifier',
topicIdentifier: 'topicIdentifier',
},
// the properties below are optional
aggregationFunction: {
attributeAggregationFunction: {
simpleAttributeAggregation: 'simpleAttributeAggregation',
valueForMultipleValues: 'valueForMultipleValues',
},
categoricalAggregationFunction: 'categoricalAggregationFunction',
dateAggregationFunction: 'dateAggregationFunction',
numericalAggregationFunction: {
percentileAggregation: {
percentileValue: 123,
},
simpleNumericalAggregation: 'simpleNumericalAggregation',
},
},
}],
},
}],
nonRepeatingVisuals: ['nonRepeatingVisuals'],
pageBreakConfiguration: {
after: {
status: 'status',
},
},
},
style: {
height: 'height',
padding: {
bottom: 'bottom',
left: 'left',
right: 'right',
top: 'top',
},
},
}],
canvasSizeOptions: {
paperCanvasSizeOptions: {
paperMargin: {
bottom: 'bottom',
left: 'left',
right: 'right',
top: 'top',
},
paperOrientation: 'paperOrientation',
paperSize: 'paperSize',
},
},
footerSections: [{
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',
},
},
}],
headerSections: [{
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',
},
},
}],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight
section_based_layout_configuration_property = quicksight.CfnTemplate.SectionBasedLayoutConfigurationProperty(
body_sections=[quicksight.CfnTemplate.BodySectionConfigurationProperty(
content=quicksight.CfnTemplate.BodySectionContentProperty(
layout=quicksight.CfnTemplate.SectionLayoutConfigurationProperty(
free_form_layout=quicksight.CfnTemplate.FreeFormSectionLayoutConfigurationProperty(
elements=[quicksight.CfnTemplate.FreeFormLayoutElementProperty(
element_id="elementId",
element_type="elementType",
height="height",
width="width",
x_axis_location="xAxisLocation",
y_axis_location="yAxisLocation",
# the properties below are optional
background_style=quicksight.CfnTemplate.FreeFormLayoutElementBackgroundStyleProperty(
color="color",
visibility="visibility"
),
border_style=quicksight.CfnTemplate.FreeFormLayoutElementBorderStyleProperty(
color="color",
visibility="visibility"
),
loading_animation=quicksight.CfnTemplate.LoadingAnimationProperty(
visibility="visibility"
),
rendering_rules=[quicksight.CfnTemplate.SheetElementRenderingRuleProperty(
configuration_overrides=quicksight.CfnTemplate.SheetElementConfigurationOverridesProperty(
visibility="visibility"
),
expression="expression"
)],
selected_border_style=quicksight.CfnTemplate.FreeFormLayoutElementBorderStyleProperty(
color="color",
visibility="visibility"
),
visibility="visibility"
)]
)
)
),
section_id="sectionId",
# the properties below are optional
page_break_configuration=quicksight.CfnTemplate.SectionPageBreakConfigurationProperty(
after=quicksight.CfnTemplate.SectionAfterPageBreakProperty(
status="status"
)
),
repeat_configuration=quicksight.CfnTemplate.BodySectionRepeatConfigurationProperty(
dimension_configurations=[quicksight.CfnTemplate.BodySectionRepeatDimensionConfigurationProperty(
dynamic_category_dimension_configuration=quicksight.CfnTemplate.BodySectionDynamicCategoryDimensionConfigurationProperty(
column=quicksight.CfnTemplate.ColumnIdentifierProperty(
column_name="columnName",
# the properties below are optional
data_set_identifier="dataSetIdentifier",
topic_identifier="topicIdentifier"
),
# the properties below are optional
limit=123,
sort_by_metrics=[quicksight.CfnTemplate.ColumnSortProperty(
direction="direction",
sort_by=quicksight.CfnTemplate.ColumnIdentifierProperty(
column_name="columnName",
# the properties below are optional
data_set_identifier="dataSetIdentifier",
topic_identifier="topicIdentifier"
),
# the properties below are optional
aggregation_function=quicksight.CfnTemplate.AggregationFunctionProperty(
attribute_aggregation_function=quicksight.CfnTemplate.AttributeAggregationFunctionProperty(
simple_attribute_aggregation="simpleAttributeAggregation",
value_for_multiple_values="valueForMultipleValues"
),
categorical_aggregation_function="categoricalAggregationFunction",
date_aggregation_function="dateAggregationFunction",
numerical_aggregation_function=quicksight.CfnTemplate.NumericalAggregationFunctionProperty(
percentile_aggregation=quicksight.CfnTemplate.PercentileAggregationProperty(
percentile_value=123
),
simple_numerical_aggregation="simpleNumericalAggregation"
)
)
)]
),
dynamic_numeric_dimension_configuration=quicksight.CfnTemplate.BodySectionDynamicNumericDimensionConfigurationProperty(
column=quicksight.CfnTemplate.ColumnIdentifierProperty(
column_name="columnName",
# the properties below are optional
data_set_identifier="dataSetIdentifier",
topic_identifier="topicIdentifier"
),
# the properties below are optional
limit=123,
sort_by_metrics=[quicksight.CfnTemplate.ColumnSortProperty(
direction="direction",
sort_by=quicksight.CfnTemplate.ColumnIdentifierProperty(
column_name="columnName",
# the properties below are optional
data_set_identifier="dataSetIdentifier",
topic_identifier="topicIdentifier"
),
# the properties below are optional
aggregation_function=quicksight.CfnTemplate.AggregationFunctionProperty(
attribute_aggregation_function=quicksight.CfnTemplate.AttributeAggregationFunctionProperty(
simple_attribute_aggregation="simpleAttributeAggregation",
value_for_multiple_values="valueForMultipleValues"
),
categorical_aggregation_function="categoricalAggregationFunction",
date_aggregation_function="dateAggregationFunction",
numerical_aggregation_function=quicksight.CfnTemplate.NumericalAggregationFunctionProperty(
percentile_aggregation=quicksight.CfnTemplate.PercentileAggregationProperty(
percentile_value=123
),
simple_numerical_aggregation="simpleNumericalAggregation"
)
)
)]
)
)],
non_repeating_visuals=["nonRepeatingVisuals"],
page_break_configuration=quicksight.CfnTemplate.BodySectionRepeatPageBreakConfigurationProperty(
after=quicksight.CfnTemplate.SectionAfterPageBreakProperty(
status="status"
)
)
),
style=quicksight.CfnTemplate.SectionStyleProperty(
height="height",
padding=quicksight.CfnTemplate.SpacingProperty(
bottom="bottom",
left="left",
right="right",
top="top"
)
)
)],
canvas_size_options=quicksight.CfnTemplate.SectionBasedLayoutCanvasSizeOptionsProperty(
paper_canvas_size_options=quicksight.CfnTemplate.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
paper_margin=quicksight.CfnTemplate.SpacingProperty(
bottom="bottom",
left="left",
right="right",
top="top"
),
paper_orientation="paperOrientation",
paper_size="paperSize"
)
),
footer_sections=[quicksight.CfnTemplate.HeaderFooterSectionConfigurationProperty(
layout=quicksight.CfnTemplate.SectionLayoutConfigurationProperty(
free_form_layout=quicksight.CfnTemplate.FreeFormSectionLayoutConfigurationProperty(
elements=[quicksight.CfnTemplate.FreeFormLayoutElementProperty(
element_id="elementId",
element_type="elementType",
height="height",
width="width",
x_axis_location="xAxisLocation",
y_axis_location="yAxisLocation",
# the properties below are optional
background_style=quicksight.CfnTemplate.FreeFormLayoutElementBackgroundStyleProperty(
color="color",
visibility="visibility"
),
border_style=quicksight.CfnTemplate.FreeFormLayoutElementBorderStyleProperty(
color="color",
visibility="visibility"
),
loading_animation=quicksight.CfnTemplate.LoadingAnimationProperty(
visibility="visibility"
),
rendering_rules=[quicksight.CfnTemplate.SheetElementRenderingRuleProperty(
configuration_overrides=quicksight.CfnTemplate.SheetElementConfigurationOverridesProperty(
visibility="visibility"
),
expression="expression"
)],
selected_border_style=quicksight.CfnTemplate.FreeFormLayoutElementBorderStyleProperty(
color="color",
visibility="visibility"
),
visibility="visibility"
)]
)
),
section_id="sectionId",
# the properties below are optional
style=quicksight.CfnTemplate.SectionStyleProperty(
height="height",
padding=quicksight.CfnTemplate.SpacingProperty(
bottom="bottom",
left="left",
right="right",
top="top"
)
)
)],
header_sections=[quicksight.CfnTemplate.HeaderFooterSectionConfigurationProperty(
layout=quicksight.CfnTemplate.SectionLayoutConfigurationProperty(
free_form_layout=quicksight.CfnTemplate.FreeFormSectionLayoutConfigurationProperty(
elements=[quicksight.CfnTemplate.FreeFormLayoutElementProperty(
element_id="elementId",
element_type="elementType",
height="height",
width="width",
x_axis_location="xAxisLocation",
y_axis_location="yAxisLocation",
# the properties below are optional
background_style=quicksight.CfnTemplate.FreeFormLayoutElementBackgroundStyleProperty(
color="color",
visibility="visibility"
),
border_style=quicksight.CfnTemplate.FreeFormLayoutElementBorderStyleProperty(
color="color",
visibility="visibility"
),
loading_animation=quicksight.CfnTemplate.LoadingAnimationProperty(
visibility="visibility"
),
rendering_rules=[quicksight.CfnTemplate.SheetElementRenderingRuleProperty(
configuration_overrides=quicksight.CfnTemplate.SheetElementConfigurationOverridesProperty(
visibility="visibility"
),
expression="expression"
)],
selected_border_style=quicksight.CfnTemplate.FreeFormLayoutElementBorderStyleProperty(
color="color",
visibility="visibility"
),
visibility="visibility"
)]
)
),
section_id="sectionId",
# the properties below are optional
style=quicksight.CfnTemplate.SectionStyleProperty(
height="height",
padding=quicksight.CfnTemplate.SpacingProperty(
bottom="bottom",
left="left",
right="right",
top="top"
)
)
)]
)
java
// 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")
// the properties below are optional
.dataSetIdentifier("dataSetIdentifier")
.topicIdentifier("topicIdentifier")
.build())
// the properties below are optional
.limit(123)
.sortByMetrics(List.of(ColumnSortProperty.builder()
.direction("direction")
.sortBy(ColumnIdentifierProperty.builder()
.columnName("columnName")
// the properties below are optional
.dataSetIdentifier("dataSetIdentifier")
.topicIdentifier("topicIdentifier")
.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")
// the properties below are optional
.dataSetIdentifier("dataSetIdentifier")
.topicIdentifier("topicIdentifier")
.build())
// the properties below are optional
.limit(123)
.sortByMetrics(List.of(ColumnSortProperty.builder()
.direction("direction")
.sortBy(ColumnIdentifierProperty.builder()
.columnName("columnName")
// the properties below are optional
.dataSetIdentifier("dataSetIdentifier")
.topicIdentifier("topicIdentifier")
.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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;
var sectionBasedLayoutConfigurationProperty = new SectionBasedLayoutConfigurationProperty {
BodySections = new [] { new BodySectionConfigurationProperty {
Content = new BodySectionContentProperty {
Layout = new SectionLayoutConfigurationProperty {
FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
Elements = new [] { new FreeFormLayoutElementProperty {
ElementId = "elementId",
ElementType = "elementType",
Height = "height",
Width = "width",
XAxisLocation = "xAxisLocation",
YAxisLocation = "yAxisLocation",
// the properties below are optional
BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
Color = "color",
Visibility = "visibility"
},
BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
LoadingAnimation = new LoadingAnimationProperty {
Visibility = "visibility"
},
RenderingRules = new [] { new SheetElementRenderingRuleProperty {
ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
Visibility = "visibility"
},
Expression = "expression"
} },
SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
Visibility = "visibility"
} }
}
}
},
SectionId = "sectionId",
// the properties below are optional
PageBreakConfiguration = new SectionPageBreakConfigurationProperty {
After = new SectionAfterPageBreakProperty {
Status = "status"
}
},
RepeatConfiguration = new BodySectionRepeatConfigurationProperty {
DimensionConfigurations = new [] { new BodySectionRepeatDimensionConfigurationProperty {
DynamicCategoryDimensionConfiguration = new BodySectionDynamicCategoryDimensionConfigurationProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
// the properties below are optional
DataSetIdentifier = "dataSetIdentifier",
TopicIdentifier = "topicIdentifier"
},
// the properties below are optional
Limit = 123,
SortByMetrics = new [] { new ColumnSortProperty {
Direction = "direction",
SortBy = new ColumnIdentifierProperty {
ColumnName = "columnName",
// the properties below are optional
DataSetIdentifier = "dataSetIdentifier",
TopicIdentifier = "topicIdentifier"
},
// the properties below are optional
AggregationFunction = new AggregationFunctionProperty {
AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
SimpleAttributeAggregation = "simpleAttributeAggregation",
ValueForMultipleValues = "valueForMultipleValues"
},
CategoricalAggregationFunction = "categoricalAggregationFunction",
DateAggregationFunction = "dateAggregationFunction",
NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
}
}
} }
},
DynamicNumericDimensionConfiguration = new BodySectionDynamicNumericDimensionConfigurationProperty {
Column = new ColumnIdentifierProperty {
ColumnName = "columnName",
// the properties below are optional
DataSetIdentifier = "dataSetIdentifier",
TopicIdentifier = "topicIdentifier"
},
// the properties below are optional
Limit = 123,
SortByMetrics = new [] { new ColumnSortProperty {
Direction = "direction",
SortBy = new ColumnIdentifierProperty {
ColumnName = "columnName",
// the properties below are optional
DataSetIdentifier = "dataSetIdentifier",
TopicIdentifier = "topicIdentifier"
},
// the properties below are optional
AggregationFunction = new AggregationFunctionProperty {
AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
SimpleAttributeAggregation = "simpleAttributeAggregation",
ValueForMultipleValues = "valueForMultipleValues"
},
CategoricalAggregationFunction = "categoricalAggregationFunction",
DateAggregationFunction = "dateAggregationFunction",
NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
PercentileAggregation = new PercentileAggregationProperty {
PercentileValue = 123
},
SimpleNumericalAggregation = "simpleNumericalAggregation"
}
}
} }
}
} },
NonRepeatingVisuals = new [] { "nonRepeatingVisuals" },
PageBreakConfiguration = new BodySectionRepeatPageBreakConfigurationProperty {
After = new SectionAfterPageBreakProperty {
Status = "status"
}
}
},
Style = new SectionStyleProperty {
Height = "height",
Padding = new SpacingProperty {
Bottom = "bottom",
Left = "left",
Right = "right",
Top = "top"
}
}
} },
CanvasSizeOptions = new SectionBasedLayoutCanvasSizeOptionsProperty {
PaperCanvasSizeOptions = new SectionBasedLayoutPaperCanvasSizeOptionsProperty {
PaperMargin = new SpacingProperty {
Bottom = "bottom",
Left = "left",
Right = "right",
Top = "top"
},
PaperOrientation = "paperOrientation",
PaperSize = "paperSize"
}
},
FooterSections = new [] { new HeaderFooterSectionConfigurationProperty {
Layout = new SectionLayoutConfigurationProperty {
FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
Elements = new [] { new FreeFormLayoutElementProperty {
ElementId = "elementId",
ElementType = "elementType",
Height = "height",
Width = "width",
XAxisLocation = "xAxisLocation",
YAxisLocation = "yAxisLocation",
// the properties below are optional
BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
Color = "color",
Visibility = "visibility"
},
BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
LoadingAnimation = new LoadingAnimationProperty {
Visibility = "visibility"
},
RenderingRules = new [] { new SheetElementRenderingRuleProperty {
ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
Visibility = "visibility"
},
Expression = "expression"
} },
SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
Visibility = "visibility"
} }
}
},
SectionId = "sectionId",
// the properties below are optional
Style = new SectionStyleProperty {
Height = "height",
Padding = new SpacingProperty {
Bottom = "bottom",
Left = "left",
Right = "right",
Top = "top"
}
}
} },
HeaderSections = new [] { new HeaderFooterSectionConfigurationProperty {
Layout = new SectionLayoutConfigurationProperty {
FreeFormLayout = new FreeFormSectionLayoutConfigurationProperty {
Elements = new [] { new FreeFormLayoutElementProperty {
ElementId = "elementId",
ElementType = "elementType",
Height = "height",
Width = "width",
XAxisLocation = "xAxisLocation",
YAxisLocation = "yAxisLocation",
// the properties below are optional
BackgroundStyle = new FreeFormLayoutElementBackgroundStyleProperty {
Color = "color",
Visibility = "visibility"
},
BorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
LoadingAnimation = new LoadingAnimationProperty {
Visibility = "visibility"
},
RenderingRules = new [] { new SheetElementRenderingRuleProperty {
ConfigurationOverrides = new SheetElementConfigurationOverridesProperty {
Visibility = "visibility"
},
Expression = "expression"
} },
SelectedBorderStyle = new FreeFormLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility"
},
Visibility = "visibility"
} }
}
},
SectionId = "sectionId",
// the properties below are optional
Style = new SectionStyleProperty {
Height = "height",
Padding = new SpacingProperty {
Bottom = "bottom",
Left = "left",
Right = "right",
Top = "top"
}
}
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sectionBasedLayoutConfigurationProperty := &SectionBasedLayoutConfigurationProperty{
BodySections: []interface{}{
&BodySectionConfigurationProperty{
Content: &BodySectionContentProperty{
Layout: &SectionLayoutConfigurationProperty{
FreeFormLayout: &FreeFormSectionLayoutConfigurationProperty{
Elements: []interface{}{
&FreeFormLayoutElementProperty{
ElementId: jsii.String("elementId"),
ElementType: jsii.String("elementType"),
Height: jsii.String("height"),
Width: jsii.String("width"),
XAxisLocation: jsii.String("xAxisLocation"),
YAxisLocation: jsii.String("yAxisLocation"),
// the properties below are optional
BackgroundStyle: &FreeFormLayoutElementBackgroundStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
BorderStyle: &FreeFormLayoutElementBorderStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
LoadingAnimation: &LoadingAnimationProperty{
Visibility: jsii.String("visibility"),
},
RenderingRules: []interface{}{
&SheetElementRenderingRuleProperty{
ConfigurationOverrides: &SheetElementConfigurationOverridesProperty{
Visibility: jsii.String("visibility"),
},
Expression: jsii.String("expression"),
},
},
SelectedBorderStyle: &FreeFormLayoutElementBorderStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
Visibility: jsii.String("visibility"),
},
},
},
},
},
SectionId: jsii.String("sectionId"),
// the properties below are optional
PageBreakConfiguration: &SectionPageBreakConfigurationProperty{
After: &SectionAfterPageBreakProperty{
Status: jsii.String("status"),
},
},
RepeatConfiguration: &BodySectionRepeatConfigurationProperty{
DimensionConfigurations: []interface{}{
&BodySectionRepeatDimensionConfigurationProperty{
DynamicCategoryDimensionConfiguration: &BodySectionDynamicCategoryDimensionConfigurationProperty{
Column: &ColumnIdentifierProperty{
ColumnName: jsii.String("columnName"),
// the properties below are optional
DataSetIdentifier: jsii.String("dataSetIdentifier"),
TopicIdentifier: jsii.String("topicIdentifier"),
},
// the properties below are optional
Limit: jsii.Number(123),
SortByMetrics: []interface{}{
&ColumnSortProperty{
Direction: jsii.String("direction"),
SortBy: &ColumnIdentifierProperty{
ColumnName: jsii.String("columnName"),
// the properties below are optional
DataSetIdentifier: jsii.String("dataSetIdentifier"),
TopicIdentifier: jsii.String("topicIdentifier"),
},
// the properties below are optional
AggregationFunction: &AggregationFunctionProperty{
AttributeAggregationFunction: &AttributeAggregationFunctionProperty{
SimpleAttributeAggregation: jsii.String("simpleAttributeAggregation"),
ValueForMultipleValues: jsii.String("valueForMultipleValues"),
},
CategoricalAggregationFunction: jsii.String("categoricalAggregationFunction"),
DateAggregationFunction: jsii.String("dateAggregationFunction"),
NumericalAggregationFunction: &NumericalAggregationFunctionProperty{
PercentileAggregation: &PercentileAggregationProperty{
PercentileValue: jsii.Number(123),
},
SimpleNumericalAggregation: jsii.String("simpleNumericalAggregation"),
},
},
},
},
},
DynamicNumericDimensionConfiguration: &BodySectionDynamicNumericDimensionConfigurationProperty{
Column: &ColumnIdentifierProperty{
ColumnName: jsii.String("columnName"),
// the properties below are optional
DataSetIdentifier: jsii.String("dataSetIdentifier"),
TopicIdentifier: jsii.String("topicIdentifier"),
},
// the properties below are optional
Limit: jsii.Number(123),
SortByMetrics: []interface{}{
&ColumnSortProperty{
Direction: jsii.String("direction"),
SortBy: &ColumnIdentifierProperty{
ColumnName: jsii.String("columnName"),
// the properties below are optional
DataSetIdentifier: jsii.String("dataSetIdentifier"),
TopicIdentifier: jsii.String("topicIdentifier"),
},
// the properties below are optional
AggregationFunction: &AggregationFunctionProperty{
AttributeAggregationFunction: &AttributeAggregationFunctionProperty{
SimpleAttributeAggregation: jsii.String("simpleAttributeAggregation"),
ValueForMultipleValues: jsii.String("valueForMultipleValues"),
},
CategoricalAggregationFunction: jsii.String("categoricalAggregationFunction"),
DateAggregationFunction: jsii.String("dateAggregationFunction"),
NumericalAggregationFunction: &NumericalAggregationFunctionProperty{
PercentileAggregation: &PercentileAggregationProperty{
PercentileValue: jsii.Number(123),
},
SimpleNumericalAggregation: jsii.String("simpleNumericalAggregation"),
},
},
},
},
},
},
},
NonRepeatingVisuals: []*string{
jsii.String("nonRepeatingVisuals"),
},
PageBreakConfiguration: &BodySectionRepeatPageBreakConfigurationProperty{
After: &SectionAfterPageBreakProperty{
Status: jsii.String("status"),
},
},
},
Style: &SectionStyleProperty{
Height: jsii.String("height"),
Padding: &SpacingProperty{
Bottom: jsii.String("bottom"),
Left: jsii.String("left"),
Right: jsii.String("right"),
Top: jsii.String("top"),
},
},
},
},
CanvasSizeOptions: &SectionBasedLayoutCanvasSizeOptionsProperty{
PaperCanvasSizeOptions: &SectionBasedLayoutPaperCanvasSizeOptionsProperty{
PaperMargin: &SpacingProperty{
Bottom: jsii.String("bottom"),
Left: jsii.String("left"),
Right: jsii.String("right"),
Top: jsii.String("top"),
},
PaperOrientation: jsii.String("paperOrientation"),
PaperSize: jsii.String("paperSize"),
},
},
FooterSections: []interface{}{
&HeaderFooterSectionConfigurationProperty{
Layout: &SectionLayoutConfigurationProperty{
FreeFormLayout: &FreeFormSectionLayoutConfigurationProperty{
Elements: []interface{}{
&FreeFormLayoutElementProperty{
ElementId: jsii.String("elementId"),
ElementType: jsii.String("elementType"),
Height: jsii.String("height"),
Width: jsii.String("width"),
XAxisLocation: jsii.String("xAxisLocation"),
YAxisLocation: jsii.String("yAxisLocation"),
// the properties below are optional
BackgroundStyle: &FreeFormLayoutElementBackgroundStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
BorderStyle: &FreeFormLayoutElementBorderStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
LoadingAnimation: &LoadingAnimationProperty{
Visibility: jsii.String("visibility"),
},
RenderingRules: []interface{}{
&SheetElementRenderingRuleProperty{
ConfigurationOverrides: &SheetElementConfigurationOverridesProperty{
Visibility: jsii.String("visibility"),
},
Expression: jsii.String("expression"),
},
},
SelectedBorderStyle: &FreeFormLayoutElementBorderStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
Visibility: jsii.String("visibility"),
},
},
},
},
SectionId: jsii.String("sectionId"),
// the properties below are optional
Style: &SectionStyleProperty{
Height: jsii.String("height"),
Padding: &SpacingProperty{
Bottom: jsii.String("bottom"),
Left: jsii.String("left"),
Right: jsii.String("right"),
Top: jsii.String("top"),
},
},
},
},
HeaderSections: []interface{}{
&HeaderFooterSectionConfigurationProperty{
Layout: &SectionLayoutConfigurationProperty{
FreeFormLayout: &FreeFormSectionLayoutConfigurationProperty{
Elements: []interface{}{
&FreeFormLayoutElementProperty{
ElementId: jsii.String("elementId"),
ElementType: jsii.String("elementType"),
Height: jsii.String("height"),
Width: jsii.String("width"),
XAxisLocation: jsii.String("xAxisLocation"),
YAxisLocation: jsii.String("yAxisLocation"),
// the properties below are optional
BackgroundStyle: &FreeFormLayoutElementBackgroundStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
BorderStyle: &FreeFormLayoutElementBorderStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
LoadingAnimation: &LoadingAnimationProperty{
Visibility: jsii.String("visibility"),
},
RenderingRules: []interface{}{
&SheetElementRenderingRuleProperty{
ConfigurationOverrides: &SheetElementConfigurationOverridesProperty{
Visibility: jsii.String("visibility"),
},
Expression: jsii.String("expression"),
},
},
SelectedBorderStyle: &FreeFormLayoutElementBorderStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
Visibility: jsii.String("visibility"),
},
},
},
},
SectionId: jsii.String("sectionId"),
// the properties below are optional
Style: &SectionStyleProperty{
Height: jsii.String("height"),
Padding: &SpacingProperty{
Bottom: jsii.String("bottom"),
Left: jsii.String("left"),
Right: jsii.String("right"),
Top: jsii.String("top"),
},
},
},
},
}
Properties
bodySectionsIResolvable | IResolvable | CfnTemplate.body_sectionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BodySectionConfigurationProperty]]]bodySectionsIResolvableBodySectionsIResolvableBodySectionsinterface{} required #A list of body section configurations.
canvasSizeOptionsIResolvable | CfnTemplate.canvas_size_optionstyping.Union[IResolvable, SectionBasedLayoutCanvasSizeOptionsProperty]canvasSizeOptionsIResolvableCanvasSizeOptionsIResolvableCanvasSizeOptionsinterface{} required #The options for the canvas of a section-based layout.
headerSectionsIResolvable | IResolvable | CfnTemplate.header_sectionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HeaderFooterSectionConfigurationProperty]]]headerSectionsIResolvableHeaderSectionsIResolvableHeaderSectionsinterface{} required #A list of header section configurations.