Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

The options that determine the sizing of the canvas used in a grid 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.*;
 GridLayoutScreenCanvasSizeOptionsProperty gridLayoutScreenCanvasSizeOptionsProperty = GridLayoutScreenCanvasSizeOptionsProperty.builder()
         .resizeOption("resizeOption")
         // the properties below are optional
         .optimizedViewPortWidth("optimizedViewPortWidth")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty.Builder	builder()
default String	getOptimizedViewPortWidth()	The width that the view port will be optimized for when the layout renders.
String	getResizeOption()	This value determines the layout behavior when the viewport is resized.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResizeOption

@Stability(Stable)
@NotNull
String getResizeOption()

This value determines the layout behavior when the viewport is resized.

• FIXED : A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic .
• RESPONSIVE : The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled .

getOptimizedViewPortWidth

@Stability(Stable)
@Nullable
default String getOptimizedViewPortWidth()

The width that the view port will be optimized for when the layout renders.

builder

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

Returns:

a CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty.Builder of CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty