AWS::QuickSight::Template FreeFormLayoutElement
An element within a free-form layout.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "BackgroundStyle" :
FreeFormLayoutElementBackgroundStyle
, "BorderStyle" :FreeFormLayoutElementBorderStyle
, "ElementId" :String
, "ElementType" :String
, "Height" :String
, "LoadingAnimation" :LoadingAnimation
, "RenderingRules" :[ SheetElementRenderingRule, ... ]
, "SelectedBorderStyle" :FreeFormLayoutElementBorderStyle
, "Visibility" :String
, "Width" :String
, "XAxisLocation" :String
, "YAxisLocation" :String
}
YAML
BackgroundStyle:
FreeFormLayoutElementBackgroundStyle
BorderStyle:FreeFormLayoutElementBorderStyle
ElementId:String
ElementType:String
Height:String
LoadingAnimation:LoadingAnimation
RenderingRules:- SheetElementRenderingRule
SelectedBorderStyle:FreeFormLayoutElementBorderStyle
Visibility:String
Width:String
XAxisLocation:String
YAxisLocation:String
Properties
BackgroundStyle
-
The background style configuration of a free-form layout element.
Required: No
Type: FreeFormLayoutElementBackgroundStyle
Update requires: No interruption
BorderStyle
-
The border style configuration of a free-form layout element.
Required: No
Type: FreeFormLayoutElementBorderStyle
Update requires: No interruption
ElementId
-
A unique identifier for an element within a free-form layout.
Required: Yes
Type: String
Pattern:
^[\w\-]+$
Minimum:
1
Maximum:
512
Update requires: No interruption
ElementType
-
The type of element.
Required: Yes
Type: String
Allowed values:
VISUAL | FILTER_CONTROL | PARAMETER_CONTROL | TEXT_BOX | IMAGE
Update requires: No interruption
Height
-
The height of an element within a free-form layout.
Required: Yes
Type: String
Update requires: No interruption
LoadingAnimation
-
The loading animation configuration of a free-form layout element.
Required: No
Type: LoadingAnimation
Update requires: No interruption
RenderingRules
-
The rendering rules that determine when an element should be displayed within a free-form layout.
Required: No
Type: Array of SheetElementRenderingRule
Minimum:
0
Maximum:
10000
Update requires: No interruption
SelectedBorderStyle
-
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Required: No
Type: FreeFormLayoutElementBorderStyle
Update requires: No interruption
Visibility
-
The visibility of an element within a free-form layout.
Required: No
Type: String
Allowed values:
HIDDEN | VISIBLE
Update requires: No interruption
Width
-
The width of an element within a free-form layout.
Required: Yes
Type: String
Update requires: No interruption
XAxisLocation
-
The x-axis coordinate of the element.
Required: Yes
Type: String
Update requires: No interruption
YAxisLocation
-
The y-axis coordinate of the element.
Required: Yes
Type: String
Update requires: No interruption