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

Interface ScatterPlotConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ScatterPlotConfiguration

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

Method Summary

Modifier and Type	Method	Description
default ScatterPlotConfiguration.Builder	dataLabels(Consumer<DataLabelOptions.Builder> dataLabels)	The options that determine if visual data labels are displayed.
ScatterPlotConfiguration.Builder	dataLabels(DataLabelOptions dataLabels)	The options that determine if visual data labels are displayed.
default ScatterPlotConfiguration.Builder	fieldWells(Consumer<ScatterPlotFieldWells.Builder> fieldWells)	The field wells of the visual.
ScatterPlotConfiguration.Builder	fieldWells(ScatterPlotFieldWells fieldWells)	The field wells of the visual.
default ScatterPlotConfiguration.Builder	interactions(Consumer<VisualInteractionOptions.Builder> interactions)	The general visual interactions setup for a visual.
ScatterPlotConfiguration.Builder	interactions(VisualInteractionOptions interactions)	The general visual interactions setup for a visual.
default ScatterPlotConfiguration.Builder	legend(Consumer<LegendOptions.Builder> legend)	The legend display setup of the visual.
ScatterPlotConfiguration.Builder	legend(LegendOptions legend)	The legend display setup of the visual.
default ScatterPlotConfiguration.Builder	sortConfiguration(Consumer<ScatterPlotSortConfiguration.Builder> sortConfiguration)	The sort configuration of a scatter plot.
ScatterPlotConfiguration.Builder	sortConfiguration(ScatterPlotSortConfiguration sortConfiguration)	The sort configuration of a scatter plot.
default ScatterPlotConfiguration.Builder	tooltip(Consumer<TooltipOptions.Builder> tooltip)	The legend display setup of the visual.
ScatterPlotConfiguration.Builder	tooltip(TooltipOptions tooltip)	The legend display setup of the visual.
default ScatterPlotConfiguration.Builder	visualPalette(Consumer<VisualPalette.Builder> visualPalette)	The palette (chart color) display setup of the visual.
ScatterPlotConfiguration.Builder	visualPalette(VisualPalette visualPalette)	The palette (chart color) display setup of the visual.
default ScatterPlotConfiguration.Builder	xAxisDisplayOptions(Consumer<AxisDisplayOptions.Builder> xAxisDisplayOptions)	The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
ScatterPlotConfiguration.Builder	xAxisDisplayOptions(AxisDisplayOptions xAxisDisplayOptions)	The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
default ScatterPlotConfiguration.Builder	xAxisLabelOptions(Consumer<ChartAxisLabelOptions.Builder> xAxisLabelOptions)	The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
ScatterPlotConfiguration.Builder	xAxisLabelOptions(ChartAxisLabelOptions xAxisLabelOptions)	The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
default ScatterPlotConfiguration.Builder	yAxisDisplayOptions(Consumer<AxisDisplayOptions.Builder> yAxisDisplayOptions)	The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
ScatterPlotConfiguration.Builder	yAxisDisplayOptions(AxisDisplayOptions yAxisDisplayOptions)	The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
default ScatterPlotConfiguration.Builder	yAxisLabelOptions(Consumer<ChartAxisLabelOptions.Builder> yAxisLabelOptions)	The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
ScatterPlotConfiguration.Builder	yAxisLabelOptions(ChartAxisLabelOptions yAxisLabelOptions)	The label options (label text, label visibility, and sort icon visibility) of the scatter plot's 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

fieldWells

ScatterPlotConfiguration.Builder fieldWells(ScatterPlotFieldWells 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 ScatterPlotConfiguration.Builder fieldWells(Consumer<ScatterPlotFieldWells.Builder> fieldWells)

The field wells of the visual.

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

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

Parameters:

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

Returns:

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

See Also:

fieldWells(ScatterPlotFieldWells)

sortConfiguration

ScatterPlotConfiguration.Builder sortConfiguration(ScatterPlotSortConfiguration sortConfiguration)

The sort configuration of a scatter plot.

Parameters:

sortConfiguration - The sort configuration of a scatter plot.

Returns:

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

sortConfiguration

default ScatterPlotConfiguration.Builder sortConfiguration(Consumer<ScatterPlotSortConfiguration.Builder> sortConfiguration)

The sort configuration of a scatter plot.

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

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

Parameters:

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

Returns:

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

See Also:

sortConfiguration(ScatterPlotSortConfiguration)

xAxisLabelOptions

ScatterPlotConfiguration.Builder xAxisLabelOptions(ChartAxisLabelOptions xAxisLabelOptions)

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

Parameters:

xAxisLabelOptions - The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

Returns:

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

xAxisLabelOptions

default ScatterPlotConfiguration.Builder xAxisLabelOptions(Consumer<ChartAxisLabelOptions.Builder> xAxisLabelOptions)

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

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 xAxisLabelOptions(ChartAxisLabelOptions).

Parameters:

xAxisLabelOptions - 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:

xAxisLabelOptions(ChartAxisLabelOptions)

xAxisDisplayOptions

ScatterPlotConfiguration.Builder xAxisDisplayOptions(AxisDisplayOptions xAxisDisplayOptions)

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

Parameters:

xAxisDisplayOptions - The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

Returns:

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

xAxisDisplayOptions

default ScatterPlotConfiguration.Builder xAxisDisplayOptions(Consumer<AxisDisplayOptions.Builder> xAxisDisplayOptions)

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

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

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

Parameters:

xAxisDisplayOptions - a consumer that will call methods on AxisDisplayOptions.Builder

Returns:

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

See Also:

xAxisDisplayOptions(AxisDisplayOptions)

yAxisLabelOptions

ScatterPlotConfiguration.Builder yAxisLabelOptions(ChartAxisLabelOptions yAxisLabelOptions)

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

Parameters:

yAxisLabelOptions - The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

Returns:

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

yAxisLabelOptions

default ScatterPlotConfiguration.Builder yAxisLabelOptions(Consumer<ChartAxisLabelOptions.Builder> yAxisLabelOptions)

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

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 yAxisLabelOptions(ChartAxisLabelOptions).

Parameters:

yAxisLabelOptions - 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:

yAxisLabelOptions(ChartAxisLabelOptions)

yAxisDisplayOptions

ScatterPlotConfiguration.Builder yAxisDisplayOptions(AxisDisplayOptions yAxisDisplayOptions)

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

Parameters:

yAxisDisplayOptions - The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

Returns:

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

yAxisDisplayOptions

default ScatterPlotConfiguration.Builder yAxisDisplayOptions(Consumer<AxisDisplayOptions.Builder> yAxisDisplayOptions)

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

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

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

Parameters:

yAxisDisplayOptions - a consumer that will call methods on AxisDisplayOptions.Builder

Returns:

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

See Also:

yAxisDisplayOptions(AxisDisplayOptions)

legend

ScatterPlotConfiguration.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 ScatterPlotConfiguration.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

ScatterPlotConfiguration.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 ScatterPlotConfiguration.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

ScatterPlotConfiguration.Builder tooltip(TooltipOptions tooltip)

The legend display setup of the visual.

Parameters:

tooltip - The legend display setup of the visual.

Returns:

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

tooltip

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

The legend 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)

visualPalette

ScatterPlotConfiguration.Builder visualPalette(VisualPalette visualPalette)

The palette (chart color) display setup of the visual.

Parameters:

visualPalette - The palette (chart color) display setup of the visual.

Returns:

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

visualPalette

default ScatterPlotConfiguration.Builder visualPalette(Consumer<VisualPalette.Builder> visualPalette)

The palette (chart color) display setup of the visual.

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

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

Parameters:

visualPalette - a consumer that will call methods on VisualPalette.Builder

Returns:

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

See Also:

visualPalette(VisualPalette)

interactions

ScatterPlotConfiguration.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 ScatterPlotConfiguration.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)