/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.quicksight.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* The configuration of a BarChartVisual
.
*
* The field wells of the visual. *
*/ private BarChartFieldWells fieldWells; /** *
* The sort configuration of a BarChartVisual
.
*
* 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.
*
* Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is * used in the visual. *
*/ private String barsArrangement; /** ** The palette (chart color) display setup of the visual. *
*/ private VisualPalette visualPalette; /** ** The small multiples setup for the visual. *
*/ private SmallMultiplesOptions smallMultiplesOptions; /** ** The label display options (grid line, range, scale, axis step) for bar chart category. *
*/ private AxisDisplayOptions categoryAxis; /** ** The label options (label text, label visibility and sort icon visibility) for a bar chart. *
*/ private ChartAxisLabelOptions categoryLabelOptions; /** ** The label display options (grid line, range, scale, axis step) for a bar chart value. *
*/ private AxisDisplayOptions valueAxis; /** ** The label options (label text, label visibility and sort icon visibility) for a bar chart value. *
*/ private ChartAxisLabelOptions valueLabelOptions; /** ** The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar * chart. *
*/ private ChartAxisLabelOptions colorLabelOptions; /** ** The legend display setup of the visual. *
*/ private LegendOptions legend; /** ** The options that determine if visual data labels are displayed. *
*/ private DataLabelOptions dataLabels; /** ** The tooltip display setup of the visual. *
*/ private TooltipOptions tooltip; /** ** The reference line setup of the visual. *
*/ private java.util.List* The contribution analysis (anomaly configuration) setup of the visual. *
*/ private java.util.List* The field wells of the visual. *
* * @param fieldWells * The field wells of the visual. */ public void setFieldWells(BarChartFieldWells fieldWells) { this.fieldWells = fieldWells; } /** ** The field wells of the visual. *
* * @return The field wells of the visual. */ public BarChartFieldWells getFieldWells() { return this.fieldWells; } /** ** The field wells of the visual. *
* * @param fieldWells * The field wells of the visual. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withFieldWells(BarChartFieldWells fieldWells) { setFieldWells(fieldWells); return this; } /** *
* The sort configuration of a BarChartVisual
.
*
BarChartVisual
.
*/
public void setSortConfiguration(BarChartSortConfiguration sortConfiguration) {
this.sortConfiguration = sortConfiguration;
}
/**
*
* The sort configuration of a BarChartVisual
.
*
BarChartVisual
.
*/
public BarChartSortConfiguration getSortConfiguration() {
return this.sortConfiguration;
}
/**
*
* The sort configuration of a BarChartVisual
.
*
BarChartVisual
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartConfiguration withSortConfiguration(BarChartSortConfiguration sortConfiguration) {
setSortConfiguration(sortConfiguration);
return this;
}
/**
* * 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is * used in the visual. *
* * @param barsArrangement * Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar * that is used in the visual. * @see BarsArrangement */ public void setBarsArrangement(String barsArrangement) { this.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. *
* * @return Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar * that is used in the visual. * @see BarsArrangement */ public String getBarsArrangement() { return this.barsArrangement; } /** ** Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is * used in the visual. *
* * @param barsArrangement * Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar * that is used in the visual. * @return Returns a reference to this object so that method calls can be chained together. * @see BarsArrangement */ public BarChartConfiguration withBarsArrangement(String barsArrangement) { setBarsArrangement(barsArrangement); return this; } /** ** Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is * used in the visual. *
* * @param barsArrangement * Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar * that is used in the visual. * @return Returns a reference to this object so that method calls can be chained together. * @see BarsArrangement */ public BarChartConfiguration withBarsArrangement(BarsArrangement barsArrangement) { this.barsArrangement = barsArrangement.toString(); return this; } /** ** The palette (chart color) display setup of the visual. *
* * @param visualPalette * The palette (chart color) display setup of the visual. */ public void setVisualPalette(VisualPalette visualPalette) { this.visualPalette = visualPalette; } /** ** The palette (chart color) display setup of the visual. *
* * @return The palette (chart color) display setup of the visual. */ public VisualPalette getVisualPalette() { return this.visualPalette; } /** ** The palette (chart color) display setup of the visual. *
* * @param visualPalette * The palette (chart color) display setup of the visual. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withVisualPalette(VisualPalette visualPalette) { setVisualPalette(visualPalette); return this; } /** ** The small multiples setup for the visual. *
* * @param smallMultiplesOptions * The small multiples setup for the visual. */ public void setSmallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions) { this.smallMultiplesOptions = smallMultiplesOptions; } /** ** The small multiples setup for the visual. *
* * @return The small multiples setup for the visual. */ public SmallMultiplesOptions getSmallMultiplesOptions() { return this.smallMultiplesOptions; } /** ** The small multiples setup for the visual. *
* * @param smallMultiplesOptions * The small multiples setup for the visual. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withSmallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions) { setSmallMultiplesOptions(smallMultiplesOptions); return this; } /** ** The label display options (grid line, range, scale, axis step) for bar chart category. *
* * @param categoryAxis * The label display options (grid line, range, scale, axis step) for bar chart category. */ public void setCategoryAxis(AxisDisplayOptions categoryAxis) { this.categoryAxis = categoryAxis; } /** ** The label display options (grid line, range, scale, axis step) for bar chart category. *
* * @return The label display options (grid line, range, scale, axis step) for bar chart category. */ public AxisDisplayOptions getCategoryAxis() { return this.categoryAxis; } /** ** The label display options (grid line, range, scale, axis step) for bar chart category. *
* * @param categoryAxis * The label display options (grid line, range, scale, axis step) for bar chart category. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withCategoryAxis(AxisDisplayOptions categoryAxis) { setCategoryAxis(categoryAxis); return this; } /** ** The label options (label text, label visibility and sort icon visibility) for a bar chart. *
* * @param categoryLabelOptions * The label options (label text, label visibility and sort icon visibility) for a bar chart. */ public void setCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions) { this.categoryLabelOptions = categoryLabelOptions; } /** ** The label options (label text, label visibility and sort icon visibility) for a bar chart. *
* * @return The label options (label text, label visibility and sort icon visibility) for a bar chart. */ public ChartAxisLabelOptions getCategoryLabelOptions() { return this.categoryLabelOptions; } /** ** The label options (label text, label visibility and sort icon visibility) for a bar chart. *
* * @param categoryLabelOptions * The label options (label text, label visibility and sort icon visibility) for a bar chart. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions) { setCategoryLabelOptions(categoryLabelOptions); return this; } /** ** The label display options (grid line, range, scale, axis step) for a bar chart value. *
* * @param valueAxis * The label display options (grid line, range, scale, axis step) for a bar chart value. */ public void setValueAxis(AxisDisplayOptions valueAxis) { this.valueAxis = valueAxis; } /** ** The label display options (grid line, range, scale, axis step) for a bar chart value. *
* * @return The label display options (grid line, range, scale, axis step) for a bar chart value. */ public AxisDisplayOptions getValueAxis() { return this.valueAxis; } /** ** The label display options (grid line, range, scale, axis step) for a bar chart value. *
* * @param valueAxis * The label display options (grid line, range, scale, axis step) for a bar chart value. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withValueAxis(AxisDisplayOptions valueAxis) { setValueAxis(valueAxis); return this; } /** ** The label options (label text, label visibility and sort icon visibility) for a bar chart value. *
* * @param valueLabelOptions * The label options (label text, label visibility and sort icon visibility) for a bar chart value. */ public void setValueLabelOptions(ChartAxisLabelOptions valueLabelOptions) { this.valueLabelOptions = valueLabelOptions; } /** ** The label options (label text, label visibility and sort icon visibility) for a bar chart value. *
* * @return The label options (label text, label visibility and sort icon visibility) for a bar chart value. */ public ChartAxisLabelOptions getValueLabelOptions() { return this.valueLabelOptions; } /** ** The label options (label text, label visibility and sort icon visibility) for a bar chart value. *
* * @param valueLabelOptions * The label options (label text, label visibility and sort icon visibility) for a bar chart value. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withValueLabelOptions(ChartAxisLabelOptions valueLabelOptions) { setValueLabelOptions(valueLabelOptions); return this; } /** ** The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar * chart. *
* * @param colorLabelOptions * The label options (label text, label visibility and sort icon visibility) for a color that is used in a * bar chart. */ public void setColorLabelOptions(ChartAxisLabelOptions colorLabelOptions) { this.colorLabelOptions = colorLabelOptions; } /** ** The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar * chart. *
* * @return The label options (label text, label visibility and sort icon visibility) for a color that is used in a * bar chart. */ public ChartAxisLabelOptions getColorLabelOptions() { return this.colorLabelOptions; } /** ** The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar * chart. *
* * @param colorLabelOptions * The label options (label text, label visibility and sort icon visibility) for a color that is used in a * bar chart. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withColorLabelOptions(ChartAxisLabelOptions colorLabelOptions) { setColorLabelOptions(colorLabelOptions); return this; } /** ** The legend display setup of the visual. *
* * @param legend * The legend display setup of the visual. */ public void setLegend(LegendOptions legend) { this.legend = legend; } /** ** The legend display setup of the visual. *
* * @return The legend display setup of the visual. */ public LegendOptions getLegend() { return this.legend; } /** ** The legend display setup of the visual. *
* * @param legend * The legend display setup of the visual. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withLegend(LegendOptions legend) { setLegend(legend); return this; } /** ** The options that determine if visual data labels are displayed. *
* * @param dataLabels * The options that determine if visual data labels are displayed. */ public void setDataLabels(DataLabelOptions dataLabels) { this.dataLabels = dataLabels; } /** ** The options that determine if visual data labels are displayed. *
* * @return The options that determine if visual data labels are displayed. */ public DataLabelOptions getDataLabels() { return this.dataLabels; } /** ** The options that determine if visual data labels are displayed. *
* * @param dataLabels * The options that determine if visual data labels are displayed. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withDataLabels(DataLabelOptions dataLabels) { setDataLabels(dataLabels); return this; } /** ** The tooltip display setup of the visual. *
* * @param tooltip * The tooltip display setup of the visual. */ public void setTooltip(TooltipOptions tooltip) { this.tooltip = tooltip; } /** ** The tooltip display setup of the visual. *
* * @return The tooltip display setup of the visual. */ public TooltipOptions getTooltip() { return this.tooltip; } /** ** The tooltip display setup of the visual. *
* * @param tooltip * The tooltip display setup of the visual. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withTooltip(TooltipOptions tooltip) { setTooltip(tooltip); return this; } /** ** The reference line setup of the visual. *
* * @return The reference line setup of the visual. */ public java.util.List* The reference line setup of the visual. *
* * @param referenceLines * The reference line setup of the visual. */ public void setReferenceLines(java.util.Collection* The reference line setup of the visual. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setReferenceLines(java.util.Collection)} or {@link #withReferenceLines(java.util.Collection)} if you want * to override the existing values. *
* * @param referenceLines * The reference line setup of the visual. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withReferenceLines(ReferenceLine... referenceLines) { if (this.referenceLines == null) { setReferenceLines(new java.util.ArrayList* The reference line setup of the visual. *
* * @param referenceLines * The reference line setup of the visual. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withReferenceLines(java.util.Collection* The contribution analysis (anomaly configuration) setup of the visual. *
* * @return The contribution analysis (anomaly configuration) setup of the visual. */ public java.util.List* The contribution analysis (anomaly configuration) setup of the visual. *
* * @param contributionAnalysisDefaults * The contribution analysis (anomaly configuration) setup of the visual. */ public void setContributionAnalysisDefaults(java.util.Collection* The contribution analysis (anomaly configuration) setup of the visual. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setContributionAnalysisDefaults(java.util.Collection)} or * {@link #withContributionAnalysisDefaults(java.util.Collection)} if you want to override the existing values. *
* * @param contributionAnalysisDefaults * The contribution analysis (anomaly configuration) setup of the visual. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withContributionAnalysisDefaults(ContributionAnalysisDefault... contributionAnalysisDefaults) { if (this.contributionAnalysisDefaults == null) { setContributionAnalysisDefaults(new java.util.ArrayList* The contribution analysis (anomaly configuration) setup of the visual. *
* * @param contributionAnalysisDefaults * The contribution analysis (anomaly configuration) setup of the visual. * @return Returns a reference to this object so that method calls can be chained together. */ public BarChartConfiguration withContributionAnalysisDefaults(java.util.Collection