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

Interface SmallMultiplesOptions.Builder

All Superinterfaces:

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

Enclosing class:

SmallMultiplesOptions

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

Method Summary

Modifier and Type	Method	Description
SmallMultiplesOptions.Builder	maxVisibleColumns(Long maxVisibleColumns)	Sets the maximum number of visible columns to display in the grid of small multiples panels.
SmallMultiplesOptions.Builder	maxVisibleRows(Long maxVisibleRows)	Sets the maximum number of visible rows to display in the grid of small multiples panels.
default SmallMultiplesOptions.Builder	panelConfiguration(Consumer<PanelConfiguration.Builder> panelConfiguration)	Configures the display options for each small multiples panel.
SmallMultiplesOptions.Builder	panelConfiguration(PanelConfiguration panelConfiguration)	Configures the display options for each small multiples panel.
default SmallMultiplesOptions.Builder	xAxis(Consumer<SmallMultiplesAxisProperties.Builder> xAxis)	The properties of a small multiples X axis.
SmallMultiplesOptions.Builder	xAxis(SmallMultiplesAxisProperties xAxis)	The properties of a small multiples X axis.
default SmallMultiplesOptions.Builder	yAxis(Consumer<SmallMultiplesAxisProperties.Builder> yAxis)	The properties of a small multiples Y axis.
SmallMultiplesOptions.Builder	yAxis(SmallMultiplesAxisProperties yAxis)	The properties of a small multiples Y axis.

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

maxVisibleRows

SmallMultiplesOptions.Builder maxVisibleRows(Long maxVisibleRows)

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto, which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

Parameters:

maxVisibleRows - Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto, which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

Returns:

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

maxVisibleColumns

SmallMultiplesOptions.Builder maxVisibleColumns(Long maxVisibleColumns)

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

Parameters:

maxVisibleColumns - Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

Returns:

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

panelConfiguration

SmallMultiplesOptions.Builder panelConfiguration(PanelConfiguration panelConfiguration)

Configures the display options for each small multiples panel.

Parameters:

panelConfiguration - Configures the display options for each small multiples panel.

Returns:

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

panelConfiguration

default SmallMultiplesOptions.Builder panelConfiguration(Consumer<PanelConfiguration.Builder> panelConfiguration)

Configures the display options for each small multiples panel.

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

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

Parameters:

panelConfiguration - a consumer that will call methods on PanelConfiguration.Builder

Returns:

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

See Also:

panelConfiguration(PanelConfiguration)

xAxis

SmallMultiplesOptions.Builder xAxis(SmallMultiplesAxisProperties xAxis)

The properties of a small multiples X axis.

Parameters:

xAxis - The properties of a small multiples X axis.

Returns:

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

xAxis

default SmallMultiplesOptions.Builder xAxis(Consumer<SmallMultiplesAxisProperties.Builder> xAxis)

The properties of a small multiples X axis.

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

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

Parameters:

xAxis - a consumer that will call methods on SmallMultiplesAxisProperties.Builder

Returns:

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

See Also:

xAxis(SmallMultiplesAxisProperties)

yAxis

SmallMultiplesOptions.Builder yAxis(SmallMultiplesAxisProperties yAxis)

The properties of a small multiples Y axis.

Parameters:

yAxis - The properties of a small multiples Y axis.

Returns:

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

yAxis

default SmallMultiplesOptions.Builder yAxis(Consumer<SmallMultiplesAxisProperties.Builder> yAxis)

The properties of a small multiples Y axis.

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

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

Parameters:

yAxis - a consumer that will call methods on SmallMultiplesAxisProperties.Builder

Returns:

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

See Also:

yAxis(SmallMultiplesAxisProperties)