software.amazon.awssdk.services.quicksight.model

Interface BoxPlotChartConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

BoxPlotChartConfiguration

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

Method Summary

Modifier and Type	Method and Description
BoxPlotChartConfiguration.Builder	boxPlotOptions(BoxPlotOptions boxPlotOptions) The box plot chart options for a box plot visual
default BoxPlotChartConfiguration.Builder	boxPlotOptions(Consumer<BoxPlotOptions.Builder> boxPlotOptions) The box plot chart options for a box plot visual
BoxPlotChartConfiguration.Builder	categoryAxis(AxisDisplayOptions categoryAxis) The label display options (grid line, range, scale, axis step) of a box plot category.
default BoxPlotChartConfiguration.Builder	categoryAxis(Consumer<AxisDisplayOptions.Builder> categoryAxis) The label display options (grid line, range, scale, axis step) of a box plot category.
BoxPlotChartConfiguration.Builder	categoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions) The label options (label text, label visibility and sort Icon visibility) of a box plot category.
default BoxPlotChartConfiguration.Builder	categoryLabelOptions(Consumer<ChartAxisLabelOptions.Builder> categoryLabelOptions) The label options (label text, label visibility and sort Icon visibility) of a box plot category.
BoxPlotChartConfiguration.Builder	fieldWells(BoxPlotFieldWells fieldWells) The field wells of the visual.
default BoxPlotChartConfiguration.Builder	fieldWells(Consumer<BoxPlotFieldWells.Builder> fieldWells) The field wells of the visual.
default BoxPlotChartConfiguration.Builder	legend(Consumer<LegendOptions.Builder> legend) Sets the value of the Legend property for this object.
BoxPlotChartConfiguration.Builder	legend(LegendOptions legend) Sets the value of the Legend property for this object.
BoxPlotChartConfiguration.Builder	primaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions) The label display options (grid line, range, scale, axis step) of a box plot category.
default BoxPlotChartConfiguration.Builder	primaryYAxisDisplayOptions(Consumer<AxisDisplayOptions.Builder> primaryYAxisDisplayOptions) The label display options (grid line, range, scale, axis step) of a box plot category.
BoxPlotChartConfiguration.Builder	primaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions) The label options (label text, label visibility and sort icon visibility) of a box plot value.
default BoxPlotChartConfiguration.Builder	primaryYAxisLabelOptions(Consumer<ChartAxisLabelOptions.Builder> primaryYAxisLabelOptions) The label options (label text, label visibility and sort icon visibility) of a box plot value.
BoxPlotChartConfiguration.Builder	referenceLines(Collection<ReferenceLine> referenceLines) The reference line setup of the visual.
BoxPlotChartConfiguration.Builder	referenceLines(Consumer<ReferenceLine.Builder>... referenceLines) The reference line setup of the visual.
BoxPlotChartConfiguration.Builder	referenceLines(ReferenceLine... referenceLines) The reference line setup of the visual.
BoxPlotChartConfiguration.Builder	sortConfiguration(BoxPlotSortConfiguration sortConfiguration) The sort configuration of a BoxPlotVisual.
default BoxPlotChartConfiguration.Builder	sortConfiguration(Consumer<BoxPlotSortConfiguration.Builder> sortConfiguration) The sort configuration of a BoxPlotVisual.
default BoxPlotChartConfiguration.Builder	tooltip(Consumer<TooltipOptions.Builder> tooltip) The tooltip display setup of the visual.
BoxPlotChartConfiguration.Builder	tooltip(TooltipOptions tooltip) The tooltip display setup of the visual.
default BoxPlotChartConfiguration.Builder	visualPalette(Consumer<VisualPalette.Builder> visualPalette) The palette (chart color) display setup of the visual.
BoxPlotChartConfiguration.Builder	visualPalette(VisualPalette visualPalette) The palette (chart color) display setup of the visual.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

fieldWells

BoxPlotChartConfiguration.Builder fieldWells(BoxPlotFieldWells 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 BoxPlotChartConfiguration.Builder fieldWells(Consumer<BoxPlotFieldWells.Builder> fieldWells)

The field wells of the visual.

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

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

Parameters:

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

Returns:

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

See Also:

fieldWells(BoxPlotFieldWells)

sortConfiguration

BoxPlotChartConfiguration.Builder sortConfiguration(BoxPlotSortConfiguration sortConfiguration)

The sort configuration of a BoxPlotVisual.

Parameters:

sortConfiguration - The sort configuration of a BoxPlotVisual.

Returns:

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

sortConfiguration

default BoxPlotChartConfiguration.Builder sortConfiguration(Consumer<BoxPlotSortConfiguration.Builder> sortConfiguration)

The sort configuration of a BoxPlotVisual.

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

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

Parameters:

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

Returns:

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

See Also:

sortConfiguration(BoxPlotSortConfiguration)

boxPlotOptions

BoxPlotChartConfiguration.Builder boxPlotOptions(BoxPlotOptions boxPlotOptions)

The box plot chart options for a box plot visual

Parameters:

boxPlotOptions - The box plot chart options for a box plot visual

Returns:

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

boxPlotOptions

default BoxPlotChartConfiguration.Builder boxPlotOptions(Consumer<BoxPlotOptions.Builder> boxPlotOptions)

The box plot chart options for a box plot visual

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

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

Parameters:

boxPlotOptions - a consumer that will call methods on BoxPlotOptions.Builder

Returns:

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

See Also:

boxPlotOptions(BoxPlotOptions)

categoryAxis

BoxPlotChartConfiguration.Builder categoryAxis(AxisDisplayOptions categoryAxis)

The label display options (grid line, range, scale, axis step) of a box plot category.

Parameters:

categoryAxis - The label display options (grid line, range, scale, axis step) of a box plot category.

Returns:

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

categoryAxis

default BoxPlotChartConfiguration.Builder categoryAxis(Consumer<AxisDisplayOptions.Builder> categoryAxis)

The label display options (grid line, range, scale, axis step) of a box plot category.

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 categoryAxis(AxisDisplayOptions).

Parameters:

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

categoryAxis(AxisDisplayOptions)

categoryLabelOptions

BoxPlotChartConfiguration.Builder categoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

Parameters:

categoryLabelOptions - The label options (label text, label visibility and sort Icon visibility) of a box plot category.

Returns:

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

categoryLabelOptions

default BoxPlotChartConfiguration.Builder categoryLabelOptions(Consumer<ChartAxisLabelOptions.Builder> categoryLabelOptions)

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

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

Parameters:

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

categoryLabelOptions(ChartAxisLabelOptions)

primaryYAxisDisplayOptions

BoxPlotChartConfiguration.Builder primaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)

The label display options (grid line, range, scale, axis step) of a box plot category.

Parameters:

primaryYAxisDisplayOptions - The label display options (grid line, range, scale, axis step) of a box plot category.

Returns:

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

primaryYAxisDisplayOptions

default BoxPlotChartConfiguration.Builder primaryYAxisDisplayOptions(Consumer<AxisDisplayOptions.Builder> primaryYAxisDisplayOptions)

The label display options (grid line, range, scale, axis step) of a box plot category.

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 primaryYAxisDisplayOptions(AxisDisplayOptions).

Parameters:

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

primaryYAxisDisplayOptions(AxisDisplayOptions)

primaryYAxisLabelOptions

BoxPlotChartConfiguration.Builder primaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)

The label options (label text, label visibility and sort icon visibility) of a box plot value.

Parameters:

primaryYAxisLabelOptions - The label options (label text, label visibility and sort icon visibility) of a box plot value.

Returns:

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

primaryYAxisLabelOptions

default BoxPlotChartConfiguration.Builder primaryYAxisLabelOptions(Consumer<ChartAxisLabelOptions.Builder> primaryYAxisLabelOptions)

The label options (label text, label visibility and sort icon visibility) of a box plot value.

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

Parameters:

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

primaryYAxisLabelOptions(ChartAxisLabelOptions)

legend

BoxPlotChartConfiguration.Builder legend(LegendOptions legend)

Sets the value of the Legend property for this object.

Parameters:

legend - The new value for the Legend property for this object.

Returns:

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

legend

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

Sets the value of the Legend property for this object. 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)

tooltip

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

referenceLines

BoxPlotChartConfiguration.Builder referenceLines(Collection<ReferenceLine> referenceLines)

The reference line setup of the visual.

Parameters:

referenceLines - The reference line setup of the visual.

Returns:

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

referenceLines

BoxPlotChartConfiguration.Builder referenceLines(ReferenceLine... referenceLines)

The reference line setup of the visual.

Parameters:

referenceLines - The reference line setup of the visual.

Returns:

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

referenceLines

BoxPlotChartConfiguration.Builder referenceLines(Consumer<ReferenceLine.Builder>... referenceLines)

The reference line setup of the visual.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #referenceLines(List).

Parameters:

referenceLines - a consumer that will call methods on ReferenceLine.Builder

Returns:

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

See Also:

#referenceLines(java.util.Collection)

visualPalette

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