Interface BarChartConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<BarChartConfiguration.Builder,
,BarChartConfiguration> SdkBuilder<BarChartConfiguration.Builder,
,BarChartConfiguration> SdkPojo
- Enclosing class:
BarChartConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionbarsArrangement
(String barsArrangement) Determines the arrangement of the bars.barsArrangement
(BarsArrangement barsArrangement) Determines the arrangement of the bars.default BarChartConfiguration.Builder
categoryAxis
(Consumer<AxisDisplayOptions.Builder> categoryAxis) The label display options (grid line, range, scale, axis step) for bar chart category.categoryAxis
(AxisDisplayOptions categoryAxis) The label display options (grid line, range, scale, axis step) for bar chart category.default BarChartConfiguration.Builder
categoryLabelOptions
(Consumer<ChartAxisLabelOptions.Builder> categoryLabelOptions) The label options (label text, label visibility and sort icon visibility) for a bar chart.categoryLabelOptions
(ChartAxisLabelOptions categoryLabelOptions) The label options (label text, label visibility and sort icon visibility) for 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.colorLabelOptions
(ChartAxisLabelOptions colorLabelOptions) The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.contributionAnalysisDefaults
(Collection<ContributionAnalysisDefault> contributionAnalysisDefaults) The contribution analysis (anomaly configuration) setup of the visual.contributionAnalysisDefaults
(Consumer<ContributionAnalysisDefault.Builder>... contributionAnalysisDefaults) The contribution analysis (anomaly configuration) setup of the visual.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.dataLabels
(DataLabelOptions dataLabels) The options that determine if visual data labels are displayed.default BarChartConfiguration.Builder
fieldWells
(Consumer<BarChartFieldWells.Builder> fieldWells) The field wells of the visual.fieldWells
(BarChartFieldWells fieldWells) The field wells of the visual.default BarChartConfiguration.Builder
interactions
(Consumer<VisualInteractionOptions.Builder> interactions) The general visual interactions setup for a visual.interactions
(VisualInteractionOptions interactions) The general visual interactions setup for a visual.default BarChartConfiguration.Builder
legend
(Consumer<LegendOptions.Builder> legend) The legend display setup of the visual.legend
(LegendOptions legend) The legend display setup of the visual.orientation
(String orientation) The orientation of the bars in a bar chart visual.orientation
(BarChartOrientation orientation) The orientation of the bars in a bar chart visual.referenceLines
(Collection<ReferenceLine> referenceLines) The reference line setup of the visual.referenceLines
(Consumer<ReferenceLine.Builder>... referenceLines) The reference line setup of the visual.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.smallMultiplesOptions
(SmallMultiplesOptions smallMultiplesOptions) The small multiples setup for the visual.default BarChartConfiguration.Builder
sortConfiguration
(Consumer<BarChartSortConfiguration.Builder> sortConfiguration) The sort configuration of aBarChartVisual
.sortConfiguration
(BarChartSortConfiguration sortConfiguration) The sort configuration of aBarChartVisual
.default BarChartConfiguration.Builder
tooltip
(Consumer<TooltipOptions.Builder> tooltip) The tooltip display setup of the visual.tooltip
(TooltipOptions tooltip) The tooltip display setup of the visual.default BarChartConfiguration.Builder
valueAxis
(Consumer<AxisDisplayOptions.Builder> valueAxis) The label display options (grid line, range, scale, axis step) for a bar chart value.valueAxis
(AxisDisplayOptions valueAxis) The label display options (grid line, range, scale, axis step) 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.valueLabelOptions
(ChartAxisLabelOptions 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.visualPalette
(VisualPalette visualPalette) The palette (chart color) 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
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
The field wells of the visual.
This is a convenience method that creates an instance of theBarChartFieldWells.Builder
avoiding the need to create one manually viaBarChartFieldWells.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofieldWells(BarChartFieldWells)
.- Parameters:
fieldWells
- a consumer that will call methods onBarChartFieldWells.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortConfiguration
The sort configuration of a
BarChartVisual
.- Parameters:
sortConfiguration
- The sort configuration of aBarChartVisual
.- 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
This is a convenience method that creates an instance of theBarChartVisual
.BarChartSortConfiguration.Builder
avoiding the need to create one manually viaBarChartSortConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosortConfiguration(BarChartSortConfiguration)
.- Parameters:
sortConfiguration
- a consumer that will call methods onBarChartSortConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
-
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:
-
-
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
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:
-
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
The palette (chart color) display setup of the visual.
This is a convenience method that creates an instance of theVisualPalette.Builder
avoiding the need to create one manually viaVisualPalette.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovisualPalette(VisualPalette)
.- Parameters:
visualPalette
- a consumer that will call methods onVisualPalette.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theSmallMultiplesOptions.Builder
avoiding the need to create one manually viaSmallMultiplesOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosmallMultiplesOptions(SmallMultiplesOptions)
.- Parameters:
smallMultiplesOptions
- a consumer that will call methods onSmallMultiplesOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theAxisDisplayOptions.Builder
avoiding the need to create one manually viaAxisDisplayOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocategoryAxis(AxisDisplayOptions)
.- Parameters:
categoryAxis
- a consumer that will call methods onAxisDisplayOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theChartAxisLabelOptions.Builder
avoiding the need to create one manually viaChartAxisLabelOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocategoryLabelOptions(ChartAxisLabelOptions)
.- Parameters:
categoryLabelOptions
- a consumer that will call methods onChartAxisLabelOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theAxisDisplayOptions.Builder
avoiding the need to create one manually viaAxisDisplayOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalueAxis(AxisDisplayOptions)
.- Parameters:
valueAxis
- a consumer that will call methods onAxisDisplayOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theChartAxisLabelOptions.Builder
avoiding the need to create one manually viaChartAxisLabelOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalueLabelOptions(ChartAxisLabelOptions)
.- Parameters:
valueLabelOptions
- a consumer that will call methods onChartAxisLabelOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theChartAxisLabelOptions.Builder
avoiding the need to create one manually viaChartAxisLabelOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocolorLabelOptions(ChartAxisLabelOptions)
.- Parameters:
colorLabelOptions
- a consumer that will call methods onChartAxisLabelOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The legend display setup of the visual.
This is a convenience method that creates an instance of theLegendOptions.Builder
avoiding the need to create one manually viaLegendOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolegend(LegendOptions)
.- Parameters:
legend
- a consumer that will call methods onLegendOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The options that determine if visual data labels are displayed.
This is a convenience method that creates an instance of theDataLabelOptions.Builder
avoiding the need to create one manually viaDataLabelOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataLabels(DataLabelOptions)
.- Parameters:
dataLabels
- a consumer that will call methods onDataLabelOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The tooltip display setup of the visual.
This is a convenience method that creates an instance of theTooltipOptions.Builder
avoiding the need to create one manually viaTooltipOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totooltip(TooltipOptions)
.- Parameters:
tooltip
- a consumer that will call methods onTooltipOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
The reference line setup of the visual.
This is a convenience method that creates an instance of theReferenceLine.Builder
avoiding the need to create one manually viaReferenceLine.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toreferenceLines(List<ReferenceLine>)
.- Parameters:
referenceLines
- a consumer that will call methods onReferenceLine.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theContributionAnalysisDefault.Builder
avoiding the need to create one manually viaContributionAnalysisDefault.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocontributionAnalysisDefaults(List<ContributionAnalysisDefault>)
.- Parameters:
contributionAnalysisDefaults
- a consumer that will call methods onContributionAnalysisDefault.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 BarChartConfiguration.Builder interactions(Consumer<VisualInteractionOptions.Builder> interactions) The general visual interactions setup for a visual.
This is a convenience method that creates an instance of theVisualInteractionOptions.Builder
avoiding the need to create one manually viaVisualInteractionOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tointeractions(VisualInteractionOptions)
.- Parameters:
interactions
- a consumer that will call methods onVisualInteractionOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-