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

Interface HeatMapConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

HeatMapConfiguration

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

Method Summary

Modifier and Type	Method	Description
default HeatMapConfiguration.Builder	colorScale(Consumer<ColorScale.Builder> colorScale)	The color options (gradient color, point of divergence) in a heat map.
HeatMapConfiguration.Builder	colorScale(ColorScale colorScale)	The color options (gradient color, point of divergence) in a heat map.
default HeatMapConfiguration.Builder	columnLabelOptions(Consumer<ChartAxisLabelOptions.Builder> columnLabelOptions)	The label options of the column that is displayed in a heat map.
HeatMapConfiguration.Builder	columnLabelOptions(ChartAxisLabelOptions columnLabelOptions)	The label options of the column that is displayed in a heat map.
default HeatMapConfiguration.Builder	dataLabels(Consumer<DataLabelOptions.Builder> dataLabels)	The options that determine if visual data labels are displayed.
HeatMapConfiguration.Builder	dataLabels(DataLabelOptions dataLabels)	The options that determine if visual data labels are displayed.
default HeatMapConfiguration.Builder	fieldWells(Consumer<HeatMapFieldWells.Builder> fieldWells)	The field wells of the visual.
HeatMapConfiguration.Builder	fieldWells(HeatMapFieldWells fieldWells)	The field wells of the visual.
default HeatMapConfiguration.Builder	interactions(Consumer<VisualInteractionOptions.Builder> interactions)	The general visual interactions setup for a visual.
HeatMapConfiguration.Builder	interactions(VisualInteractionOptions interactions)	The general visual interactions setup for a visual.
default HeatMapConfiguration.Builder	legend(Consumer<LegendOptions.Builder> legend)	The legend display setup of the visual.
HeatMapConfiguration.Builder	legend(LegendOptions legend)	The legend display setup of the visual.
default HeatMapConfiguration.Builder	rowLabelOptions(Consumer<ChartAxisLabelOptions.Builder> rowLabelOptions)	The label options of the row that is displayed in a heat map.
HeatMapConfiguration.Builder	rowLabelOptions(ChartAxisLabelOptions rowLabelOptions)	The label options of the row that is displayed in a heat map.
default HeatMapConfiguration.Builder	sortConfiguration(Consumer<HeatMapSortConfiguration.Builder> sortConfiguration)	The sort configuration of a heat map.
HeatMapConfiguration.Builder	sortConfiguration(HeatMapSortConfiguration sortConfiguration)	The sort configuration of a heat map.
default HeatMapConfiguration.Builder	tooltip(Consumer<TooltipOptions.Builder> tooltip)	The tooltip display setup of the visual.
HeatMapConfiguration.Builder	tooltip(TooltipOptions tooltip)	The tooltip display setup of the visual.

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

fieldWells

HeatMapConfiguration.Builder fieldWells(HeatMapFieldWells fieldWells)

The field wells of the visual.

Parameters:

fieldWells - The field wells of the visual.

Returns:

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

fieldWells

default HeatMapConfiguration.Builder fieldWells(Consumer<HeatMapFieldWells.Builder> fieldWells)

The field wells of the visual.

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

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

Parameters:

fieldWells - a consumer that will call methods on HeatMapFieldWells.Builder

Returns:

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

See Also:

• fieldWells(HeatMapFieldWells)

sortConfiguration

HeatMapConfiguration.Builder sortConfiguration(HeatMapSortConfiguration sortConfiguration)

The sort configuration of a heat map.

Parameters:

sortConfiguration - The sort configuration of a heat map.

Returns:

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

sortConfiguration

default HeatMapConfiguration.Builder sortConfiguration(Consumer<HeatMapSortConfiguration.Builder> sortConfiguration)

The sort configuration of a heat map.

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

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

Parameters:

sortConfiguration - a consumer that will call methods on HeatMapSortConfiguration.Builder

Returns:

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

See Also:

• sortConfiguration(HeatMapSortConfiguration)

rowLabelOptions

HeatMapConfiguration.Builder rowLabelOptions(ChartAxisLabelOptions rowLabelOptions)

The label options of the row that is displayed in a heat map.

Parameters:

rowLabelOptions - The label options of the row that is displayed in a heat map.

Returns:

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

rowLabelOptions

default HeatMapConfiguration.Builder rowLabelOptions(Consumer<ChartAxisLabelOptions.Builder> rowLabelOptions)

The label options of the row that is displayed in a heat map.

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

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

Parameters:

rowLabelOptions - a consumer that will call methods on ChartAxisLabelOptions.Builder

Returns:

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

See Also:

• rowLabelOptions(ChartAxisLabelOptions)

columnLabelOptions

HeatMapConfiguration.Builder columnLabelOptions(ChartAxisLabelOptions columnLabelOptions)

The label options of the column that is displayed in a heat map.

Parameters:

columnLabelOptions - The label options of the column that is displayed in a heat map.

Returns:

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

columnLabelOptions

default HeatMapConfiguration.Builder columnLabelOptions(Consumer<ChartAxisLabelOptions.Builder> columnLabelOptions)

The label options of the column that is displayed in a heat map.

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

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

Parameters:

columnLabelOptions - a consumer that will call methods on ChartAxisLabelOptions.Builder

Returns:

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

See Also:

• columnLabelOptions(ChartAxisLabelOptions)

colorScale

HeatMapConfiguration.Builder colorScale(ColorScale colorScale)

The color options (gradient color, point of divergence) in a heat map.

Parameters:

colorScale - The color options (gradient color, point of divergence) in a heat map.

Returns:

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

colorScale

default HeatMapConfiguration.Builder colorScale(Consumer<ColorScale.Builder> colorScale)

The color options (gradient color, point of divergence) in a heat map.

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

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

Parameters:

colorScale - a consumer that will call methods on ColorScale.Builder

Returns:

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

See Also:

• colorScale(ColorScale)

legend

HeatMapConfiguration.Builder legend(LegendOptions legend)

The legend display setup of the visual.

Parameters:

legend - The legend display setup of the visual.

Returns:

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

legend

default HeatMapConfiguration.Builder legend(Consumer<LegendOptions.Builder> legend)

The legend display setup of the visual.

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

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

Parameters:

legend - a consumer that will call methods on LegendOptions.Builder

Returns:

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

See Also:

• legend(LegendOptions)

dataLabels

HeatMapConfiguration.Builder dataLabels(DataLabelOptions dataLabels)

The options that determine if visual data labels are displayed.

Parameters:

dataLabels - The options that determine if visual data labels are displayed.

Returns:

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

dataLabels

default HeatMapConfiguration.Builder dataLabels(Consumer<DataLabelOptions.Builder> dataLabels)

The options that determine if visual data labels are displayed.

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

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

Parameters:

dataLabels - a consumer that will call methods on DataLabelOptions.Builder

Returns:

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

See Also:

• dataLabels(DataLabelOptions)

tooltip

HeatMapConfiguration.Builder tooltip(TooltipOptions tooltip)

The tooltip display setup of the visual.

Parameters:

tooltip - The tooltip display setup of the visual.

Returns:

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

tooltip

default HeatMapConfiguration.Builder tooltip(Consumer<TooltipOptions.Builder> tooltip)

The tooltip display setup of the visual.

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

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

Parameters:

tooltip - a consumer that will call methods on TooltipOptions.Builder

Returns:

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

See Also:

• tooltip(TooltipOptions)

interactions

HeatMapConfiguration.Builder interactions(VisualInteractionOptions interactions)

The general visual interactions setup for a visual.

Parameters:

interactions - The general visual interactions setup for a visual.

Returns:

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

interactions

default HeatMapConfiguration.Builder interactions(Consumer<VisualInteractionOptions.Builder> interactions)

The general visual interactions setup for a visual.

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

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

Parameters:

interactions - a consumer that will call methods on VisualInteractionOptions.Builder

Returns:

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

See Also:

• interactions(VisualInteractionOptions)