software.amazon.awssdk.services.quicksight.model

Interface BarChartConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

BarChartConfiguration

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

Method Summary

Modifier and Type	Method and Description
BarChartConfiguration.Builder	barsArrangement(BarsArrangement barsArrangement) Determines the arrangement of the bars.
BarChartConfiguration.Builder	barsArrangement(String barsArrangement) Determines the arrangement of the bars.
BarChartConfiguration.Builder	categoryAxis(AxisDisplayOptions categoryAxis) The label display options (grid line, range, scale, axis step) for bar chart category.
default BarChartConfiguration.Builder	categoryAxis(Consumer<AxisDisplayOptions.Builder> categoryAxis) The label display options (grid line, range, scale, axis step) for bar chart category.
BarChartConfiguration.Builder	categoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions) The label options (label text, label visibility and sort icon visibility) for a bar chart.
default BarChartConfiguration.Builder	categoryLabelOptions(Consumer<ChartAxisLabelOptions.Builder> categoryLabelOptions) The label options (label text, label visibility and sort icon visibility) for a bar chart.
BarChartConfiguration.Builder	colorLabelOptions(ChartAxisLabelOptions colorLabelOptions) The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
default BarChartConfiguration.Builder	colorLabelOptions(Consumer<ChartAxisLabelOptions.Builder> colorLabelOptions) The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
BarChartConfiguration.Builder	contributionAnalysisDefaults(Collection<ContributionAnalysisDefault> contributionAnalysisDefaults) The contribution analysis (anomaly configuration) setup of the visual.
BarChartConfiguration.Builder	contributionAnalysisDefaults(Consumer<ContributionAnalysisDefault.Builder>... contributionAnalysisDefaults) The contribution analysis (anomaly configuration) setup of the visual.
BarChartConfiguration.Builder	contributionAnalysisDefaults(ContributionAnalysisDefault... contributionAnalysisDefaults) The contribution analysis (anomaly configuration) setup of the visual.
default BarChartConfiguration.Builder	dataLabels(Consumer<DataLabelOptions.Builder> dataLabels) The options that determine if visual data labels are displayed.
BarChartConfiguration.Builder	dataLabels(DataLabelOptions dataLabels) The options that determine if visual data labels are displayed.
BarChartConfiguration.Builder	fieldWells(BarChartFieldWells fieldWells) The field wells of the visual.
default BarChartConfiguration.Builder	fieldWells(Consumer<BarChartFieldWells.Builder> fieldWells) The field wells of the visual.
default BarChartConfiguration.Builder	legend(Consumer<LegendOptions.Builder> legend) The legend display setup of the visual.
BarChartConfiguration.Builder	legend(LegendOptions legend) The legend display setup of the visual.
BarChartConfiguration.Builder	orientation(BarChartOrientation orientation) The orientation of the bars in a bar chart visual.
BarChartConfiguration.Builder	orientation(String orientation) The orientation of the bars in a bar chart visual.
BarChartConfiguration.Builder	referenceLines(Collection<ReferenceLine> referenceLines) The reference line setup of the visual.
BarChartConfiguration.Builder	referenceLines(Consumer<ReferenceLine.Builder>... referenceLines) The reference line setup of the visual.
BarChartConfiguration.Builder	referenceLines(ReferenceLine... referenceLines) The reference line setup of the visual.
default BarChartConfiguration.Builder	smallMultiplesOptions(Consumer<SmallMultiplesOptions.Builder> smallMultiplesOptions) The small multiples setup for the visual.
BarChartConfiguration.Builder	smallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions) The small multiples setup for the visual.
BarChartConfiguration.Builder	sortConfiguration(BarChartSortConfiguration sortConfiguration) The sort configuration of a BarChartVisual.
default BarChartConfiguration.Builder	sortConfiguration(Consumer<BarChartSortConfiguration.Builder> sortConfiguration) The sort configuration of a BarChartVisual.
default BarChartConfiguration.Builder	tooltip(Consumer<TooltipOptions.Builder> tooltip) The tooltip display setup of the visual.
BarChartConfiguration.Builder	tooltip(TooltipOptions tooltip) The tooltip display setup of the visual.
BarChartConfiguration.Builder	valueAxis(AxisDisplayOptions valueAxis) The label display options (grid line, range, scale, axis step) for a bar chart value.
default BarChartConfiguration.Builder	valueAxis(Consumer<AxisDisplayOptions.Builder> valueAxis) The label display options (grid line, range, scale, axis step) for a bar chart value.
BarChartConfiguration.Builder	valueLabelOptions(ChartAxisLabelOptions valueLabelOptions) The label options (label text, label visibility and sort icon visibility) for a bar chart value.
default BarChartConfiguration.Builder	valueLabelOptions(Consumer<ChartAxisLabelOptions.Builder> valueLabelOptions) The label options (label text, label visibility and sort icon visibility) for a bar chart value.
default BarChartConfiguration.Builder	visualPalette(Consumer<VisualPalette.Builder> visualPalette) The palette (chart color) display setup of the visual.
BarChartConfiguration.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

BarChartConfiguration.Builder fieldWells(BarChartFieldWells 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 BarChartConfiguration.Builder fieldWells(Consumer<BarChartFieldWells.Builder> fieldWells)

The field wells of the visual.

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

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

Parameters:

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

Returns:

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

See Also:

fieldWells(BarChartFieldWells)

sortConfiguration

BarChartConfiguration.Builder sortConfiguration(BarChartSortConfiguration sortConfiguration)

The sort configuration of a BarChartVisual.

Parameters:

sortConfiguration - The sort configuration of a BarChartVisual.

Returns:

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

sortConfiguration

default BarChartConfiguration.Builder sortConfiguration(Consumer<BarChartSortConfiguration.Builder> sortConfiguration)

The sort configuration of a BarChartVisual.

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

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

Parameters:

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

Returns:

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

See Also:

sortConfiguration(BarChartSortConfiguration)

orientation

BarChartConfiguration.Builder orientation(String orientation)

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

• HORIZONTAL: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.

• VERTICAL: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

Parameters:

orientation - The orientation of the bars in a bar chart visual. There are two valid values in this structure:

• HORIZONTAL: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.

• VERTICAL: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

Returns:

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

See Also:

BarChartOrientation, BarChartOrientation

orientation

BarChartConfiguration.Builder orientation(BarChartOrientation orientation)

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

• HORIZONTAL: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.

• VERTICAL: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

Parameters:

orientation - The orientation of the bars in a bar chart visual. There are two valid values in this structure:

• HORIZONTAL: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.

• VERTICAL: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

Returns:

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

See Also:

BarChartOrientation, BarChartOrientation

barsArrangement

BarChartConfiguration.Builder barsArrangement(String barsArrangement)

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

Parameters:

barsArrangement - Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

Returns:

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

See Also:

BarsArrangement, BarsArrangement

barsArrangement

BarChartConfiguration.Builder barsArrangement(BarsArrangement barsArrangement)

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

Parameters:

barsArrangement - Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

Returns:

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

See Also:

BarsArrangement, BarsArrangement

visualPalette

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

smallMultiplesOptions

BarChartConfiguration.Builder smallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions)

The small multiples setup for the visual.

Parameters:

smallMultiplesOptions - The small multiples setup for the visual.

Returns:

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

smallMultiplesOptions

default BarChartConfiguration.Builder smallMultiplesOptions(Consumer<SmallMultiplesOptions.Builder> smallMultiplesOptions)

The small multiples setup for the visual.

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

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

Parameters:

smallMultiplesOptions - a consumer that will call methods on SmallMultiplesOptions.Builder

Returns:

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

See Also:

smallMultiplesOptions(SmallMultiplesOptions)

categoryAxis

BarChartConfiguration.Builder categoryAxis(AxisDisplayOptions categoryAxis)

The label display options (grid line, range, scale, axis step) for bar chart category.

Parameters:

categoryAxis - The label display options (grid line, range, scale, axis step) for bar chart category.

Returns:

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

categoryAxis

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

The label display options (grid line, range, scale, axis step) for bar chart 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

BarChartConfiguration.Builder categoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)

The label options (label text, label visibility and sort icon visibility) for a bar chart.

Parameters:

categoryLabelOptions - The label options (label text, label visibility and sort icon visibility) for a bar chart.

Returns:

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

categoryLabelOptions

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

The label options (label text, label visibility and sort icon visibility) for a bar chart.

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)

valueAxis

BarChartConfiguration.Builder valueAxis(AxisDisplayOptions valueAxis)

The label display options (grid line, range, scale, axis step) for a bar chart value.

Parameters:

valueAxis - The label display options (grid line, range, scale, axis step) for a bar chart value.

Returns:

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

valueAxis

default BarChartConfiguration.Builder valueAxis(Consumer<AxisDisplayOptions.Builder> valueAxis)

The label display options (grid line, range, scale, axis step) for a bar chart value.

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

Parameters:

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

valueAxis(AxisDisplayOptions)

valueLabelOptions

BarChartConfiguration.Builder valueLabelOptions(ChartAxisLabelOptions valueLabelOptions)

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

Parameters:

valueLabelOptions - The label options (label text, label visibility and sort icon visibility) for a bar chart value.

Returns:

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

valueLabelOptions

default BarChartConfiguration.Builder valueLabelOptions(Consumer<ChartAxisLabelOptions.Builder> valueLabelOptions)

The label options (label text, label visibility and sort icon visibility) for a bar chart 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 valueLabelOptions(ChartAxisLabelOptions).

Parameters:

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

valueLabelOptions(ChartAxisLabelOptions)

colorLabelOptions

BarChartConfiguration.Builder colorLabelOptions(ChartAxisLabelOptions colorLabelOptions)

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

Parameters:

colorLabelOptions - The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

Returns:

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

colorLabelOptions

default BarChartConfiguration.Builder colorLabelOptions(Consumer<ChartAxisLabelOptions.Builder> colorLabelOptions)

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

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

Parameters:

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

colorLabelOptions(ChartAxisLabelOptions)

legend

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

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

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

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

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

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

contributionAnalysisDefaults

BarChartConfiguration.Builder contributionAnalysisDefaults(Collection<ContributionAnalysisDefault> contributionAnalysisDefaults)

The contribution analysis (anomaly configuration) setup of the visual.

Parameters:

contributionAnalysisDefaults - The contribution analysis (anomaly configuration) setup of the visual.

Returns:

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

contributionAnalysisDefaults

BarChartConfiguration.Builder contributionAnalysisDefaults(ContributionAnalysisDefault... contributionAnalysisDefaults)

The contribution analysis (anomaly configuration) setup of the visual.

Parameters:

contributionAnalysisDefaults - The contribution analysis (anomaly configuration) setup of the visual.

Returns:

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

contributionAnalysisDefaults

BarChartConfiguration.Builder contributionAnalysisDefaults(Consumer<ContributionAnalysisDefault.Builder>... contributionAnalysisDefaults)

The contribution analysis (anomaly configuration) setup of the visual.

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

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

Parameters:

contributionAnalysisDefaults - a consumer that will call methods on ContributionAnalysisDefault.Builder

Returns:

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

See Also:

#contributionAnalysisDefaults(java.util.Collection)