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

Interface LegendOptions.Builder

All Superinterfaces:

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

Enclosing class:

LegendOptions

@Mutable
@NotThreadSafe
public static interface LegendOptions.Builder
extends SdkPojo, CopyableBuilder<LegendOptions.Builder,LegendOptions>

Method Summary

Modifier and Type	Method	Description
LegendOptions.Builder	height(String height)	The height of the legend.
LegendOptions.Builder	position(String position)	The positions for the legend.
LegendOptions.Builder	position(LegendPosition position)	The positions for the legend.
default LegendOptions.Builder	title(Consumer<LabelOptions.Builder> title)	The custom title for the legend.
LegendOptions.Builder	title(LabelOptions title)	The custom title for the legend.
default LegendOptions.Builder	valueFontConfiguration(Consumer<FontConfiguration.Builder> valueFontConfiguration)	Sets the value of the ValueFontConfiguration property for this object.
LegendOptions.Builder	valueFontConfiguration(FontConfiguration valueFontConfiguration)	Sets the value of the ValueFontConfiguration property for this object.
LegendOptions.Builder	visibility(String visibility)	Determines whether or not the legend is visible.
LegendOptions.Builder	visibility(Visibility visibility)	Determines whether or not the legend is visible.
LegendOptions.Builder	width(String width)	The width of the legend.

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, sdkFieldNameToField, sdkFields

Method Detail

visibility

LegendOptions.Builder visibility(String visibility)

Determines whether or not the legend is visible.

Parameters:

visibility - Determines whether or not the legend is visible.

Returns:

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

See Also:

Visibility, Visibility

visibility

LegendOptions.Builder visibility(Visibility visibility)

Determines whether or not the legend is visible.

Parameters:

visibility - Determines whether or not the legend is visible.

Returns:

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

See Also:

Visibility, Visibility

title

LegendOptions.Builder title(LabelOptions title)

The custom title for the legend.

Parameters:

title - The custom title for the legend.

Returns:

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

title

default LegendOptions.Builder title(Consumer<LabelOptions.Builder> title)

The custom title for the legend.

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

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

Parameters:

title - a consumer that will call methods on LabelOptions.Builder

Returns:

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

See Also:

title(LabelOptions)

position

LegendOptions.Builder position(String position)

The positions for the legend. Choose one of the following options:

• AUTO

• RIGHT

• BOTTOM

• LEFT

Parameters:

position - The positions for the legend. Choose one of the following options:

• AUTO

• RIGHT

• BOTTOM

• LEFT

Returns:

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

See Also:

LegendPosition, LegendPosition

position

LegendOptions.Builder position(LegendPosition position)

The positions for the legend. Choose one of the following options:

• AUTO

• RIGHT

• BOTTOM

• LEFT

Parameters:

position - The positions for the legend. Choose one of the following options:

• AUTO

• RIGHT

• BOTTOM

• LEFT

Returns:

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

See Also:

LegendPosition, LegendPosition

width

LegendOptions.Builder width(String width)

The width of the legend. If this value is omitted, a default width is used when rendering.

Parameters:

width - The width of the legend. If this value is omitted, a default width is used when rendering.

Returns:

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

height

LegendOptions.Builder height(String height)

The height of the legend. If this value is omitted, a default height is used when rendering.

Parameters:

height - The height of the legend. If this value is omitted, a default height is used when rendering.

Returns:

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

valueFontConfiguration

LegendOptions.Builder valueFontConfiguration(FontConfiguration valueFontConfiguration)

Sets the value of the ValueFontConfiguration property for this object.

Parameters:

valueFontConfiguration - The new value for the ValueFontConfiguration property for this object.

Returns:

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

valueFontConfiguration

default LegendOptions.Builder valueFontConfiguration(Consumer<FontConfiguration.Builder> valueFontConfiguration)

Sets the value of the ValueFontConfiguration property for this object. This is a convenience method that creates an instance of the FontConfiguration.Builder avoiding the need to create one manually via FontConfiguration.builder().

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

Parameters:

valueFontConfiguration - a consumer that will call methods on FontConfiguration.Builder

Returns:

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

See Also:

valueFontConfiguration(FontConfiguration)