GridLayoutConfigurationProperty Struct
The configuration for a grid layout. Also called a tiled 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.
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 gridLayoutConfigurationProperty: quicksight.CfnTemplate.GridLayoutConfigurationProperty = {
elements: [{
columnSpan: 123,
elementId: 'elementId',
elementType: 'elementType',
rowSpan: 123,
// the properties below are optional
backgroundStyle: {
color: 'color',
visibility: 'visibility',
},
borderRadius: 'borderRadius',
borderStyle: {
color: 'color',
visibility: 'visibility',
width: 'width',
},
columnIndex: 123,
loadingAnimation: {
visibility: 'visibility',
},
padding: 'padding',
rowIndex: 123,
selectedBorderStyle: {
color: 'color',
visibility: 'visibility',
width: 'width',
},
}],
// the properties below are optional
canvasSizeOptions: {
screenCanvasSizeOptions: {
resizeOption: 'resizeOption',
// the properties below are optional
optimizedViewPortWidth: 'optimizedViewPortWidth',
},
},
};
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
grid_layout_configuration_property = quicksight.CfnTemplate.GridLayoutConfigurationProperty(
elements=[quicksight.CfnTemplate.GridLayoutElementProperty(
column_span=123,
element_id="elementId",
element_type="elementType",
row_span=123,
# the properties below are optional
background_style=quicksight.CfnTemplate.GridLayoutElementBackgroundStyleProperty(
color="color",
visibility="visibility"
),
border_radius="borderRadius",
border_style=quicksight.CfnTemplate.GridLayoutElementBorderStyleProperty(
color="color",
visibility="visibility",
width="width"
),
column_index=123,
loading_animation=quicksight.CfnTemplate.LoadingAnimationProperty(
visibility="visibility"
),
padding="padding",
row_index=123,
selected_border_style=quicksight.CfnTemplate.GridLayoutElementBorderStyleProperty(
color="color",
visibility="visibility",
width="width"
)
)],
# the properties below are optional
canvas_size_options=quicksight.CfnTemplate.GridLayoutCanvasSizeOptionsProperty(
screen_canvas_size_options=quicksight.CfnTemplate.GridLayoutScreenCanvasSizeOptionsProperty(
resize_option="resizeOption",
# the properties below are optional
optimized_view_port_width="optimizedViewPortWidth"
)
)
)
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.*;
GridLayoutConfigurationProperty gridLayoutConfigurationProperty = GridLayoutConfigurationProperty.builder()
.elements(List.of(GridLayoutElementProperty.builder()
.columnSpan(123)
.elementId("elementId")
.elementType("elementType")
.rowSpan(123)
// the properties below are optional
.backgroundStyle(GridLayoutElementBackgroundStyleProperty.builder()
.color("color")
.visibility("visibility")
.build())
.borderRadius("borderRadius")
.borderStyle(GridLayoutElementBorderStyleProperty.builder()
.color("color")
.visibility("visibility")
.width("width")
.build())
.columnIndex(123)
.loadingAnimation(LoadingAnimationProperty.builder()
.visibility("visibility")
.build())
.padding("padding")
.rowIndex(123)
.selectedBorderStyle(GridLayoutElementBorderStyleProperty.builder()
.color("color")
.visibility("visibility")
.width("width")
.build())
.build()))
// the properties below are optional
.canvasSizeOptions(GridLayoutCanvasSizeOptionsProperty.builder()
.screenCanvasSizeOptions(GridLayoutScreenCanvasSizeOptionsProperty.builder()
.resizeOption("resizeOption")
// the properties below are optional
.optimizedViewPortWidth("optimizedViewPortWidth")
.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 gridLayoutConfigurationProperty = new GridLayoutConfigurationProperty {
Elements = new [] { new GridLayoutElementProperty {
ColumnSpan = 123,
ElementId = "elementId",
ElementType = "elementType",
RowSpan = 123,
// the properties below are optional
BackgroundStyle = new GridLayoutElementBackgroundStyleProperty {
Color = "color",
Visibility = "visibility"
},
BorderRadius = "borderRadius",
BorderStyle = new GridLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility",
Width = "width"
},
ColumnIndex = 123,
LoadingAnimation = new LoadingAnimationProperty {
Visibility = "visibility"
},
Padding = "padding",
RowIndex = 123,
SelectedBorderStyle = new GridLayoutElementBorderStyleProperty {
Color = "color",
Visibility = "visibility",
Width = "width"
}
} },
// the properties below are optional
CanvasSizeOptions = new GridLayoutCanvasSizeOptionsProperty {
ScreenCanvasSizeOptions = new GridLayoutScreenCanvasSizeOptionsProperty {
ResizeOption = "resizeOption",
// the properties below are optional
OptimizedViewPortWidth = "optimizedViewPortWidth"
}
}
};
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"
gridLayoutConfigurationProperty := &GridLayoutConfigurationProperty{
Elements: []interface{}{
&GridLayoutElementProperty{
ColumnSpan: jsii.Number(123),
ElementId: jsii.String("elementId"),
ElementType: jsii.String("elementType"),
RowSpan: jsii.Number(123),
// the properties below are optional
BackgroundStyle: &GridLayoutElementBackgroundStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
},
BorderRadius: jsii.String("borderRadius"),
BorderStyle: &GridLayoutElementBorderStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
Width: jsii.String("width"),
},
ColumnIndex: jsii.Number(123),
LoadingAnimation: &LoadingAnimationProperty{
Visibility: jsii.String("visibility"),
},
Padding: jsii.String("padding"),
RowIndex: jsii.Number(123),
SelectedBorderStyle: &GridLayoutElementBorderStyleProperty{
Color: jsii.String("color"),
Visibility: jsii.String("visibility"),
Width: jsii.String("width"),
},
},
},
// the properties below are optional
CanvasSizeOptions: &GridLayoutCanvasSizeOptionsProperty{
ScreenCanvasSizeOptions: &GridLayoutScreenCanvasSizeOptionsProperty{
ResizeOption: jsii.String("resizeOption"),
// the properties below are optional
OptimizedViewPortWidth: jsii.String("optimizedViewPortWidth"),
},
},
}
Properties
canvasSizeOptionsoptionalIResolvable | CfnTemplate.GridLayoutCanvasSizeOptionsPropertycanvas_size_optionsoptionaltyping.Union[IResolvable, GridLayoutCanvasSizeOptionsProperty]canvasSizeOptionsoptionalIResolvableCanvasSizeOptionsoptionalIResolvableCanvasSizeOptionsoptionalinterface{}#elementsIResolvable | IResolvable | CfnTemplate.GridLayoutElementProperty[]elementstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, GridLayoutElementProperty]]]elementsIResolvableElementsIResolvableElementsinterface{}required#The elements that are included in a grid layout.