LayoutConfiguration

PDF

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.

Contents

Note

In the following list, the required parameters are described first.

FreeFormLayout

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

Type: FreeFormLayoutConfiguration object

Required: No

GridLayout

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.

Type: GridLayoutConfiguration object

Required: No

SectionBasedLayout

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

Type: SectionBasedLayoutConfiguration object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3