Package software.amazon.awssdk.services.quicksight.model

Interface FreeFormLayoutElement.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FreeFormLayoutElement.Builder,FreeFormLayoutElement>, SdkBuilder<FreeFormLayoutElement.Builder,FreeFormLayoutElement>, SdkPojo

Enclosing class:

FreeFormLayoutElement

public static interface FreeFormLayoutElement.Builder
extends SdkPojo, CopyableBuilder<FreeFormLayoutElement.Builder,FreeFormLayoutElement>

Method Summary

Modifier and Type	Method	Description
default FreeFormLayoutElement.Builder	backgroundStyle(Consumer<FreeFormLayoutElementBackgroundStyle.Builder> backgroundStyle)	The background style configuration of a free-form layout element.
FreeFormLayoutElement.Builder	backgroundStyle(FreeFormLayoutElementBackgroundStyle backgroundStyle)	The background style configuration of a free-form layout element.
default FreeFormLayoutElement.Builder	borderStyle(Consumer<FreeFormLayoutElementBorderStyle.Builder> borderStyle)	The border style configuration of a free-form layout element.
FreeFormLayoutElement.Builder	borderStyle(FreeFormLayoutElementBorderStyle borderStyle)	The border style configuration of a free-form layout element.
FreeFormLayoutElement.Builder	elementId(String elementId)	A unique identifier for an element within a free-form layout.
FreeFormLayoutElement.Builder	elementType(String elementType)	The type of element.
FreeFormLayoutElement.Builder	elementType(LayoutElementType elementType)	The type of element.
FreeFormLayoutElement.Builder	height(String height)	The height of an element within a free-form layout.
default FreeFormLayoutElement.Builder	loadingAnimation(Consumer<LoadingAnimation.Builder> loadingAnimation)	The loading animation configuration of a free-form layout element.
FreeFormLayoutElement.Builder	loadingAnimation(LoadingAnimation loadingAnimation)	The loading animation configuration of a free-form layout element.
FreeFormLayoutElement.Builder	renderingRules(Collection<SheetElementRenderingRule> renderingRules)	The rendering rules that determine when an element should be displayed within a free-form layout.
FreeFormLayoutElement.Builder	renderingRules(Consumer<SheetElementRenderingRule.Builder>... renderingRules)	The rendering rules that determine when an element should be displayed within a free-form layout.
FreeFormLayoutElement.Builder	renderingRules(SheetElementRenderingRule... renderingRules)	The rendering rules that determine when an element should be displayed within a free-form layout.
default FreeFormLayoutElement.Builder	selectedBorderStyle(Consumer<FreeFormLayoutElementBorderStyle.Builder> selectedBorderStyle)	The border style configuration of a free-form layout element.
FreeFormLayoutElement.Builder	selectedBorderStyle(FreeFormLayoutElementBorderStyle selectedBorderStyle)	The border style configuration of a free-form layout element.
FreeFormLayoutElement.Builder	visibility(String visibility)	The visibility of an element within a free-form layout.
FreeFormLayoutElement.Builder	visibility(Visibility visibility)	The visibility of an element within a free-form layout.
FreeFormLayoutElement.Builder	width(String width)	The width of an element within a free-form layout.
FreeFormLayoutElement.Builder	xAxisLocation(String xAxisLocation)	The x-axis coordinate of the element.
FreeFormLayoutElement.Builder	yAxisLocation(String yAxisLocation)	The y-axis coordinate of the element.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

elementId

FreeFormLayoutElement.Builder elementId(String elementId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

elementType

FreeFormLayoutElement.Builder elementType(String elementType)

The type of element.

Parameters:

elementType - The type of element.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• LayoutElementType
• LayoutElementType

elementType

FreeFormLayoutElement.Builder elementType(LayoutElementType elementType)

The type of element.

Parameters:

elementType - The type of element.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• LayoutElementType
• LayoutElementType

xAxisLocation

FreeFormLayoutElement.Builder xAxisLocation(String xAxisLocation)

The x-axis coordinate of the element.

Parameters:

xAxisLocation - The x-axis coordinate of the element.

Returns:

Returns a reference to this object so that method calls can be chained together.

yAxisLocation

FreeFormLayoutElement.Builder yAxisLocation(String yAxisLocation)

The y-axis coordinate of the element.

Parameters:

yAxisLocation - The y-axis coordinate of the element.

Returns:

Returns a reference to this object so that method calls can be chained together.

width

FreeFormLayoutElement.Builder width(String width)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

height

FreeFormLayoutElement.Builder height(String height)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

visibility

FreeFormLayoutElement.Builder visibility(String visibility)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Visibility
• Visibility

visibility

FreeFormLayoutElement.Builder visibility(Visibility visibility)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Visibility
• Visibility

renderingRules

FreeFormLayoutElement.Builder renderingRules(Collection<SheetElementRenderingRule> renderingRules)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

renderingRules

FreeFormLayoutElement.Builder renderingRules(SheetElementRenderingRule... renderingRules)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

renderingRules

FreeFormLayoutElement.Builder renderingRules(Consumer<SheetElementRenderingRule.Builder>... renderingRules)

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

This is a convenience method that creates an instance of the SheetElementRenderingRule.Builder avoiding the need to create one manually via SheetElementRenderingRule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to renderingRules(List<SheetElementRenderingRule>).

Parameters:

renderingRules - a consumer that will call methods on SheetElementRenderingRule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• renderingRules(java.util.Collection<SheetElementRenderingRule>)

borderStyle

FreeFormLayoutElement.Builder borderStyle(FreeFormLayoutElementBorderStyle borderStyle)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

borderStyle

default FreeFormLayoutElement.Builder borderStyle(Consumer<FreeFormLayoutElementBorderStyle.Builder> borderStyle)

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

This is a convenience method that creates an instance of the FreeFormLayoutElementBorderStyle.Builder avoiding the need to create one manually via FreeFormLayoutElementBorderStyle.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to borderStyle(FreeFormLayoutElementBorderStyle).

Parameters:

borderStyle - a consumer that will call methods on FreeFormLayoutElementBorderStyle.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• borderStyle(FreeFormLayoutElementBorderStyle)

selectedBorderStyle

FreeFormLayoutElement.Builder selectedBorderStyle(FreeFormLayoutElementBorderStyle selectedBorderStyle)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

selectedBorderStyle

default FreeFormLayoutElement.Builder selectedBorderStyle(Consumer<FreeFormLayoutElementBorderStyle.Builder> selectedBorderStyle)

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

This is a convenience method that creates an instance of the FreeFormLayoutElementBorderStyle.Builder avoiding the need to create one manually via FreeFormLayoutElementBorderStyle.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to selectedBorderStyle(FreeFormLayoutElementBorderStyle).

Parameters:

selectedBorderStyle - a consumer that will call methods on FreeFormLayoutElementBorderStyle.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• selectedBorderStyle(FreeFormLayoutElementBorderStyle)

backgroundStyle

FreeFormLayoutElement.Builder backgroundStyle(FreeFormLayoutElementBackgroundStyle backgroundStyle)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

backgroundStyle

default FreeFormLayoutElement.Builder backgroundStyle(Consumer<FreeFormLayoutElementBackgroundStyle.Builder> backgroundStyle)

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

This is a convenience method that creates an instance of the FreeFormLayoutElementBackgroundStyle.Builder avoiding the need to create one manually via FreeFormLayoutElementBackgroundStyle.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to backgroundStyle(FreeFormLayoutElementBackgroundStyle).

Parameters:

backgroundStyle - a consumer that will call methods on FreeFormLayoutElementBackgroundStyle.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• backgroundStyle(FreeFormLayoutElementBackgroundStyle)

loadingAnimation

FreeFormLayoutElement.Builder loadingAnimation(LoadingAnimation loadingAnimation)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

loadingAnimation

default FreeFormLayoutElement.Builder loadingAnimation(Consumer<LoadingAnimation.Builder> loadingAnimation)

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

This is a convenience method that creates an instance of the LoadingAnimation.Builder avoiding the need to create one manually via LoadingAnimation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loadingAnimation(LoadingAnimation).

Parameters:

loadingAnimation - a consumer that will call methods on LoadingAnimation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• loadingAnimation(LoadingAnimation)