FreeFormLayoutElement - Amazon QuickSight
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

FreeFormLayoutElement

An element within a free-form layout.

Contents

Note

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

ElementId

A unique identifier for an element within a free-form layout.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

ElementType

The type of element.

Type: String

Valid Values: VISUAL | FILTER_CONTROL | PARAMETER_CONTROL | TEXT_BOX

Required: Yes

Height

The height of an element within a free-form layout.

Type: String

Required: Yes

Width

The width of an element within a free-form layout.

Type: String

Required: Yes

XAxisLocation

The x-axis coordinate of the element.

Type: String

Required: Yes

YAxisLocation

The y-axis coordinate of the element.

Type: String

Required: Yes

BackgroundStyle

The background style configuration of a free-form layout element.

Type: FreeFormLayoutElementBackgroundStyle object

Required: No

BorderStyle

The border style configuration of a free-form layout element.

Type: FreeFormLayoutElementBorderStyle object

Required: No

LoadingAnimation

The loading animation configuration of a free-form layout element.

Type: LoadingAnimation object

Required: No

RenderingRules

The rendering rules that determine when an element should be displayed within a free-form layout.

Type: Array of SheetElementRenderingRule objects

Array Members: Maximum number of 10000 items.

Required: No

SelectedBorderStyle

The border style configuration of a free-form layout element. This border style is used when the element is selected.

Type: FreeFormLayoutElementBorderStyle object

Required: No

Visibility

The visibility of an element within a free-form layout.

Type: String

Valid Values: HIDDEN | VISIBLE

Required: No

See Also

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