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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description BarChartConfiguration.BuilderbarsArrangement(String barsArrangement)Determines the arrangement of the bars.BarChartConfiguration.BuilderbarsArrangement(BarsArrangement barsArrangement)Determines the arrangement of the bars.default BarChartConfiguration.BuildercategoryAxis(Consumer<AxisDisplayOptions.Builder> categoryAxis)The label display options (grid line, range, scale, axis step) for bar chart category.BarChartConfiguration.BuildercategoryAxis(AxisDisplayOptions categoryAxis)The label display options (grid line, range, scale, axis step) for bar chart category.default BarChartConfiguration.BuildercategoryLabelOptions(Consumer<ChartAxisLabelOptions.Builder> categoryLabelOptions)The label options (label text, label visibility and sort icon visibility) for a bar chart.BarChartConfiguration.BuildercategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions)The label options (label text, label visibility and sort icon visibility) for a bar chart.default BarChartConfiguration.BuildercolorLabelOptions(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.BuildercolorLabelOptions(ChartAxisLabelOptions colorLabelOptions)The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.BarChartConfiguration.BuildercontributionAnalysisDefaults(Collection<ContributionAnalysisDefault> contributionAnalysisDefaults)The contribution analysis (anomaly configuration) setup of the visual.BarChartConfiguration.BuildercontributionAnalysisDefaults(Consumer<ContributionAnalysisDefault.Builder>... contributionAnalysisDefaults)The contribution analysis (anomaly configuration) setup of the visual.BarChartConfiguration.BuildercontributionAnalysisDefaults(ContributionAnalysisDefault... contributionAnalysisDefaults)The contribution analysis (anomaly configuration) setup of the visual.default BarChartConfiguration.BuilderdataLabels(Consumer<DataLabelOptions.Builder> dataLabels)The options that determine if visual data labels are displayed.BarChartConfiguration.BuilderdataLabels(DataLabelOptions dataLabels)The options that determine if visual data labels are displayed.default BarChartConfiguration.BuilderfieldWells(Consumer<BarChartFieldWells.Builder> fieldWells)The field wells of the visual.BarChartConfiguration.BuilderfieldWells(BarChartFieldWells fieldWells)The field wells of the visual.default BarChartConfiguration.Builderlegend(Consumer<LegendOptions.Builder> legend)The legend display setup of the visual.BarChartConfiguration.Builderlegend(LegendOptions legend)The legend display setup of the visual.BarChartConfiguration.Builderorientation(String orientation)The orientation of the bars in a bar chart visual.BarChartConfiguration.Builderorientation(BarChartOrientation orientation)The orientation of the bars in a bar chart visual.BarChartConfiguration.BuilderreferenceLines(Collection<ReferenceLine> referenceLines)The reference line setup of the visual.BarChartConfiguration.BuilderreferenceLines(Consumer<ReferenceLine.Builder>... referenceLines)The reference line setup of the visual.BarChartConfiguration.BuilderreferenceLines(ReferenceLine... referenceLines)The reference line setup of the visual.default BarChartConfiguration.BuildersmallMultiplesOptions(Consumer<SmallMultiplesOptions.Builder> smallMultiplesOptions)The small multiples setup for the visual.BarChartConfiguration.BuildersmallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions)The small multiples setup for the visual.default BarChartConfiguration.BuildersortConfiguration(Consumer<BarChartSortConfiguration.Builder> sortConfiguration)The sort configuration of aBarChartVisual.BarChartConfiguration.BuildersortConfiguration(BarChartSortConfiguration sortConfiguration)The sort configuration of aBarChartVisual.default BarChartConfiguration.Buildertooltip(Consumer<TooltipOptions.Builder> tooltip)The tooltip display setup of the visual.BarChartConfiguration.Buildertooltip(TooltipOptions tooltip)The tooltip display setup of the visual.default BarChartConfiguration.BuildervalueAxis(Consumer<AxisDisplayOptions.Builder> valueAxis)The label display options (grid line, range, scale, axis step) for a bar chart value.BarChartConfiguration.BuildervalueAxis(AxisDisplayOptions valueAxis)The label display options (grid line, range, scale, axis step) for a bar chart value.default BarChartConfiguration.BuildervalueLabelOptions(Consumer<ChartAxisLabelOptions.Builder> valueLabelOptions)The label options (label text, label visibility and sort icon visibility) for a bar chart value.BarChartConfiguration.BuildervalueLabelOptions(ChartAxisLabelOptions valueLabelOptions)The label options (label text, label visibility and sort icon visibility) for a bar chart value.default BarChartConfiguration.BuildervisualPalette(Consumer<VisualPalette.Builder> visualPalette)The palette (chart color) display setup of the visual.BarChartConfiguration.BuildervisualPalette(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 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 theBarChartFieldWells.Builderavoiding the need to create one manually viaBarChartFieldWells.builder().When the
Consumercompletes,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:
fieldWells(BarChartFieldWells)
-
sortConfiguration
BarChartConfiguration.Builder sortConfiguration(BarChartSortConfiguration 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.Builderavoiding the need to create one manually viaBarChartSortConfiguration.builder().When the
Consumercompletes,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:
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 theVisualPalette.Builderavoiding the need to create one manually viaVisualPalette.builder().When the
Consumercompletes,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:
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 theSmallMultiplesOptions.Builderavoiding the need to create one manually viaSmallMultiplesOptions.builder().When the
Consumercompletes,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:
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 theAxisDisplayOptions.Builderavoiding the need to create one manually viaAxisDisplayOptions.builder().When the
Consumercompletes,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:
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 theChartAxisLabelOptions.Builderavoiding the need to create one manually viaChartAxisLabelOptions.builder().When the
Consumercompletes,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:
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 theAxisDisplayOptions.Builderavoiding the need to create one manually viaAxisDisplayOptions.builder().When the
Consumercompletes,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:
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 theChartAxisLabelOptions.Builderavoiding the need to create one manually viaChartAxisLabelOptions.builder().When the
Consumercompletes,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:
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 theChartAxisLabelOptions.Builderavoiding the need to create one manually viaChartAxisLabelOptions.builder().When the
Consumercompletes,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:
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 theLegendOptions.Builderavoiding the need to create one manually viaLegendOptions.builder().When the
Consumercompletes,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:
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 theDataLabelOptions.Builderavoiding the need to create one manually viaDataLabelOptions.builder().When the
Consumercompletes,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:
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 theTooltipOptions.Builderavoiding the need to create one manually viaTooltipOptions.builder().When the
Consumercompletes,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:
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 theReferenceLine.Builderavoiding the need to create one manually viaReferenceLine.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#referenceLines(List.) - 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:
#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 theContributionAnalysisDefault.Builderavoiding the need to create one manually viaContributionAnalysisDefault.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#contributionAnalysisDefaults(List.) - 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:
#contributionAnalysisDefaults(java.util.Collection)
-
-