software.amazon.awssdk.services.quicksight.model

Interface ComboChartConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ComboChartConfiguration

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

Method Summary

Modifier and Type	Method and Description
default ComboChartConfiguration.Builder	barDataLabels(Consumer<DataLabelOptions.Builder> barDataLabels) The options that determine if visual data labels are displayed.
ComboChartConfiguration.Builder	barDataLabels(DataLabelOptions barDataLabels) The options that determine if visual data labels are displayed.
ComboChartConfiguration.Builder	barsArrangement(BarsArrangement barsArrangement) Determines the bar arrangement in a combo chart.
ComboChartConfiguration.Builder	barsArrangement(String barsArrangement) Determines the bar arrangement in a combo chart.
ComboChartConfiguration.Builder	categoryAxis(AxisDisplayOptions categoryAxis) The category axis of a combo chart.
default ComboChartConfiguration.Builder	categoryAxis(Consumer<AxisDisplayOptions.Builder> categoryAxis) The category axis of a combo chart.
ComboChartConfiguration.Builder	categoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions) The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
default ComboChartConfiguration.Builder	categoryLabelOptions(Consumer<ChartAxisLabelOptions.Builder> categoryLabelOptions) The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
ComboChartConfiguration.Builder	colorLabelOptions(ChartAxisLabelOptions colorLabelOptions) The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
default ComboChartConfiguration.Builder	colorLabelOptions(Consumer<ChartAxisLabelOptions.Builder> colorLabelOptions) The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
ComboChartConfiguration.Builder	fieldWells(ComboChartFieldWells fieldWells) The field wells of the visual.
default ComboChartConfiguration.Builder	fieldWells(Consumer<ComboChartFieldWells.Builder> fieldWells) The field wells of the visual.
default ComboChartConfiguration.Builder	legend(Consumer<LegendOptions.Builder> legend) The legend display setup of the visual.
ComboChartConfiguration.Builder	legend(LegendOptions legend) The legend display setup of the visual.
default ComboChartConfiguration.Builder	lineDataLabels(Consumer<DataLabelOptions.Builder> lineDataLabels) The options that determine if visual data labels are displayed.
ComboChartConfiguration.Builder	lineDataLabels(DataLabelOptions lineDataLabels) The options that determine if visual data labels are displayed.
ComboChartConfiguration.Builder	primaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions) The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
default ComboChartConfiguration.Builder	primaryYAxisDisplayOptions(Consumer<AxisDisplayOptions.Builder> primaryYAxisDisplayOptions) The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
ComboChartConfiguration.Builder	primaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions) The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
default ComboChartConfiguration.Builder	primaryYAxisLabelOptions(Consumer<ChartAxisLabelOptions.Builder> primaryYAxisLabelOptions) The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
ComboChartConfiguration.Builder	referenceLines(Collection<ReferenceLine> referenceLines) The reference line setup of the visual.
ComboChartConfiguration.Builder	referenceLines(Consumer<ReferenceLine.Builder>... referenceLines) The reference line setup of the visual.
ComboChartConfiguration.Builder	referenceLines(ReferenceLine... referenceLines) The reference line setup of the visual.
ComboChartConfiguration.Builder	secondaryYAxisDisplayOptions(AxisDisplayOptions secondaryYAxisDisplayOptions) The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
default ComboChartConfiguration.Builder	secondaryYAxisDisplayOptions(Consumer<AxisDisplayOptions.Builder> secondaryYAxisDisplayOptions) The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
ComboChartConfiguration.Builder	secondaryYAxisLabelOptions(ChartAxisLabelOptions secondaryYAxisLabelOptions) The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
default ComboChartConfiguration.Builder	secondaryYAxisLabelOptions(Consumer<ChartAxisLabelOptions.Builder> secondaryYAxisLabelOptions) The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
ComboChartConfiguration.Builder	sortConfiguration(ComboChartSortConfiguration sortConfiguration) The sort configuration of a ComboChartVisual.
default ComboChartConfiguration.Builder	sortConfiguration(Consumer<ComboChartSortConfiguration.Builder> sortConfiguration) The sort configuration of a ComboChartVisual.
default ComboChartConfiguration.Builder	tooltip(Consumer<TooltipOptions.Builder> tooltip) The legend display setup of the visual.
ComboChartConfiguration.Builder	tooltip(TooltipOptions tooltip) The legend display setup of the visual.
default ComboChartConfiguration.Builder	visualPalette(Consumer<VisualPalette.Builder> visualPalette) The palette (chart color) display setup of the visual.
ComboChartConfiguration.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

ComboChartConfiguration.Builder fieldWells(ComboChartFieldWells 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 ComboChartConfiguration.Builder fieldWells(Consumer<ComboChartFieldWells.Builder> fieldWells)

The field wells of the visual.

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

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

Parameters:

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

Returns:

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

See Also:

fieldWells(ComboChartFieldWells)

sortConfiguration

ComboChartConfiguration.Builder sortConfiguration(ComboChartSortConfiguration sortConfiguration)

The sort configuration of a ComboChartVisual.

Parameters:

sortConfiguration - The sort configuration of a ComboChartVisual.

Returns:

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

sortConfiguration

default ComboChartConfiguration.Builder sortConfiguration(Consumer<ComboChartSortConfiguration.Builder> sortConfiguration)

The sort configuration of a ComboChartVisual.

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

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

Parameters:

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

Returns:

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

See Also:

sortConfiguration(ComboChartSortConfiguration)

barsArrangement

ComboChartConfiguration.Builder barsArrangement(String barsArrangement)

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

• CLUSTERED: For clustered bar combo charts.

• STACKED: For stacked bar combo charts.

• STACKED_PERCENT: Do not use. If you use this value, the operation returns a validation error.

Parameters:

barsArrangement - Determines the bar arrangement in a combo chart. The following are valid values in this structure:

• CLUSTERED: For clustered bar combo charts.

• STACKED: For stacked bar combo charts.

• STACKED_PERCENT: Do not use. If you use this value, the operation returns a validation error.

Returns:

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

See Also:

BarsArrangement, BarsArrangement

barsArrangement

ComboChartConfiguration.Builder barsArrangement(BarsArrangement barsArrangement)

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

• CLUSTERED: For clustered bar combo charts.

• STACKED: For stacked bar combo charts.

• STACKED_PERCENT: Do not use. If you use this value, the operation returns a validation error.

Parameters:

barsArrangement - Determines the bar arrangement in a combo chart. The following are valid values in this structure:

• CLUSTERED: For clustered bar combo charts.

• STACKED: For stacked bar combo charts.

• STACKED_PERCENT: Do not use. If you use this value, the operation returns a validation error.

Returns:

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

See Also:

BarsArrangement, BarsArrangement

categoryAxis

ComboChartConfiguration.Builder categoryAxis(AxisDisplayOptions categoryAxis)

The category axis of a combo chart.

Parameters:

categoryAxis - The category axis of a combo chart.

Returns:

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

categoryAxis

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

The category axis of a combo chart.

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

ComboChartConfiguration.Builder categoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

Parameters:

categoryLabelOptions - The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

Returns:

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

categoryLabelOptions

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

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

ComboChartConfiguration.Builder primaryYAxisDisplayOptions(AxisDisplayOptions primaryYAxisDisplayOptions)

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

Parameters:

primaryYAxisDisplayOptions - The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

Returns:

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

primaryYAxisDisplayOptions

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

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

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

ComboChartConfiguration.Builder primaryYAxisLabelOptions(ChartAxisLabelOptions primaryYAxisLabelOptions)

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

Parameters:

primaryYAxisLabelOptions - The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

Returns:

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

primaryYAxisLabelOptions

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

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)

secondaryYAxisDisplayOptions

ComboChartConfiguration.Builder secondaryYAxisDisplayOptions(AxisDisplayOptions secondaryYAxisDisplayOptions)

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

Parameters:

secondaryYAxisDisplayOptions - The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

Returns:

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

secondaryYAxisDisplayOptions

default ComboChartConfiguration.Builder secondaryYAxisDisplayOptions(Consumer<AxisDisplayOptions.Builder> secondaryYAxisDisplayOptions)

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

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

Parameters:

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

secondaryYAxisDisplayOptions(AxisDisplayOptions)

secondaryYAxisLabelOptions

ComboChartConfiguration.Builder secondaryYAxisLabelOptions(ChartAxisLabelOptions secondaryYAxisLabelOptions)

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

Parameters:

secondaryYAxisLabelOptions - The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

Returns:

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

secondaryYAxisLabelOptions

default ComboChartConfiguration.Builder secondaryYAxisLabelOptions(Consumer<ChartAxisLabelOptions.Builder> secondaryYAxisLabelOptions)

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

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

Parameters:

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

secondaryYAxisLabelOptions(ChartAxisLabelOptions)

colorLabelOptions

ComboChartConfiguration.Builder colorLabelOptions(ChartAxisLabelOptions colorLabelOptions)

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

Parameters:

colorLabelOptions - The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

Returns:

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

colorLabelOptions

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

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

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

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

barDataLabels

ComboChartConfiguration.Builder barDataLabels(DataLabelOptions barDataLabels)

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

Parameters:

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

The data label options for a bar in a combo chart.

Returns:

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

barDataLabels

default ComboChartConfiguration.Builder barDataLabels(Consumer<DataLabelOptions.Builder> barDataLabels)

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

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 barDataLabels(DataLabelOptions).

Parameters:

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

barDataLabels(DataLabelOptions)

lineDataLabels

ComboChartConfiguration.Builder lineDataLabels(DataLabelOptions lineDataLabels)

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

Parameters:

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

The data label options for a line in a combo chart.

Returns:

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

lineDataLabels

default ComboChartConfiguration.Builder lineDataLabels(Consumer<DataLabelOptions.Builder> lineDataLabels)

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

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 lineDataLabels(DataLabelOptions).

Parameters:

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

lineDataLabels(DataLabelOptions)

tooltip

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

referenceLines

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

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

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

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