/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace QuickSight { namespace Model { /** *

The configuration of a BarChartVisual.

See Also:

* AWS * API Reference

*/ class BarChartConfiguration { public: AWS_QUICKSIGHT_API BarChartConfiguration(); AWS_QUICKSIGHT_API BarChartConfiguration(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API BarChartConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The field wells of the visual.

*/ inline const BarChartFieldWells& GetFieldWells() const{ return m_fieldWells; } /** *

The field wells of the visual.

*/ inline bool FieldWellsHasBeenSet() const { return m_fieldWellsHasBeenSet; } /** *

The field wells of the visual.

*/ inline void SetFieldWells(const BarChartFieldWells& value) { m_fieldWellsHasBeenSet = true; m_fieldWells = value; } /** *

The field wells of the visual.

*/ inline void SetFieldWells(BarChartFieldWells&& value) { m_fieldWellsHasBeenSet = true; m_fieldWells = std::move(value); } /** *

The field wells of the visual.

*/ inline BarChartConfiguration& WithFieldWells(const BarChartFieldWells& value) { SetFieldWells(value); return *this;} /** *

The field wells of the visual.

*/ inline BarChartConfiguration& WithFieldWells(BarChartFieldWells&& value) { SetFieldWells(std::move(value)); return *this;} /** *

The sort configuration of a BarChartVisual.

*/ inline const BarChartSortConfiguration& GetSortConfiguration() const{ return m_sortConfiguration; } /** *

The sort configuration of a BarChartVisual.

*/ inline bool SortConfigurationHasBeenSet() const { return m_sortConfigurationHasBeenSet; } /** *

The sort configuration of a BarChartVisual.

*/ inline void SetSortConfiguration(const BarChartSortConfiguration& value) { m_sortConfigurationHasBeenSet = true; m_sortConfiguration = value; } /** *

The sort configuration of a BarChartVisual.

*/ inline void SetSortConfiguration(BarChartSortConfiguration&& value) { m_sortConfigurationHasBeenSet = true; m_sortConfiguration = std::move(value); } /** *

The sort configuration of a BarChartVisual.

*/ inline BarChartConfiguration& WithSortConfiguration(const BarChartSortConfiguration& value) { SetSortConfiguration(value); return *this;} /** *

The sort configuration of a BarChartVisual.

*/ inline BarChartConfiguration& WithSortConfiguration(BarChartSortConfiguration&& value) { SetSortConfiguration(std::move(value)); 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.

*/ inline const BarChartOrientation& GetOrientation() const{ return m_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.

*/ inline bool OrientationHasBeenSet() const { return m_orientationHasBeenSet; } /** *

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.

*/ inline void SetOrientation(const BarChartOrientation& value) { m_orientationHasBeenSet = true; m_orientation = value; } /** *

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.

*/ inline void SetOrientation(BarChartOrientation&& value) { m_orientationHasBeenSet = true; m_orientation = std::move(value); } /** *

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.

*/ inline BarChartConfiguration& WithOrientation(const BarChartOrientation& value) { SetOrientation(value); 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.

*/ inline BarChartConfiguration& WithOrientation(BarChartOrientation&& value) { SetOrientation(std::move(value)); 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.

*/ inline const BarsArrangement& GetBarsArrangement() const{ return m_barsArrangement; } /** *

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

*/ inline bool BarsArrangementHasBeenSet() const { return m_barsArrangementHasBeenSet; } /** *

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

*/ inline void SetBarsArrangement(const BarsArrangement& value) { m_barsArrangementHasBeenSet = true; m_barsArrangement = value; } /** *

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

*/ inline void SetBarsArrangement(BarsArrangement&& value) { m_barsArrangementHasBeenSet = true; m_barsArrangement = std::move(value); } /** *

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

*/ inline BarChartConfiguration& WithBarsArrangement(const BarsArrangement& value) { SetBarsArrangement(value); 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.

*/ inline BarChartConfiguration& WithBarsArrangement(BarsArrangement&& value) { SetBarsArrangement(std::move(value)); return *this;} /** *

The palette (chart color) display setup of the visual.

*/ inline const VisualPalette& GetVisualPalette() const{ return m_visualPalette; } /** *

The palette (chart color) display setup of the visual.

*/ inline bool VisualPaletteHasBeenSet() const { return m_visualPaletteHasBeenSet; } /** *

The palette (chart color) display setup of the visual.

*/ inline void SetVisualPalette(const VisualPalette& value) { m_visualPaletteHasBeenSet = true; m_visualPalette = value; } /** *

The palette (chart color) display setup of the visual.

*/ inline void SetVisualPalette(VisualPalette&& value) { m_visualPaletteHasBeenSet = true; m_visualPalette = std::move(value); } /** *

The palette (chart color) display setup of the visual.

*/ inline BarChartConfiguration& WithVisualPalette(const VisualPalette& value) { SetVisualPalette(value); return *this;} /** *

The palette (chart color) display setup of the visual.

*/ inline BarChartConfiguration& WithVisualPalette(VisualPalette&& value) { SetVisualPalette(std::move(value)); return *this;} /** *

The small multiples setup for the visual.

*/ inline const SmallMultiplesOptions& GetSmallMultiplesOptions() const{ return m_smallMultiplesOptions; } /** *

The small multiples setup for the visual.

*/ inline bool SmallMultiplesOptionsHasBeenSet() const { return m_smallMultiplesOptionsHasBeenSet; } /** *

The small multiples setup for the visual.

*/ inline void SetSmallMultiplesOptions(const SmallMultiplesOptions& value) { m_smallMultiplesOptionsHasBeenSet = true; m_smallMultiplesOptions = value; } /** *

The small multiples setup for the visual.

*/ inline void SetSmallMultiplesOptions(SmallMultiplesOptions&& value) { m_smallMultiplesOptionsHasBeenSet = true; m_smallMultiplesOptions = std::move(value); } /** *

The small multiples setup for the visual.

*/ inline BarChartConfiguration& WithSmallMultiplesOptions(const SmallMultiplesOptions& value) { SetSmallMultiplesOptions(value); return *this;} /** *

The small multiples setup for the visual.

*/ inline BarChartConfiguration& WithSmallMultiplesOptions(SmallMultiplesOptions&& value) { SetSmallMultiplesOptions(std::move(value)); return *this;} /** *

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

*/ inline const AxisDisplayOptions& GetCategoryAxis() const{ return m_categoryAxis; } /** *

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

*/ inline bool CategoryAxisHasBeenSet() const { return m_categoryAxisHasBeenSet; } /** *

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

*/ inline void SetCategoryAxis(const AxisDisplayOptions& value) { m_categoryAxisHasBeenSet = true; m_categoryAxis = value; } /** *

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

*/ inline void SetCategoryAxis(AxisDisplayOptions&& value) { m_categoryAxisHasBeenSet = true; m_categoryAxis = std::move(value); } /** *

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

*/ inline BarChartConfiguration& WithCategoryAxis(const AxisDisplayOptions& value) { SetCategoryAxis(value); return *this;} /** *

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

*/ inline BarChartConfiguration& WithCategoryAxis(AxisDisplayOptions&& value) { SetCategoryAxis(std::move(value)); return *this;} /** *

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

*/ inline const ChartAxisLabelOptions& GetCategoryLabelOptions() const{ return m_categoryLabelOptions; } /** *

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

*/ inline bool CategoryLabelOptionsHasBeenSet() const { return m_categoryLabelOptionsHasBeenSet; } /** *

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

*/ inline void SetCategoryLabelOptions(const ChartAxisLabelOptions& value) { m_categoryLabelOptionsHasBeenSet = true; m_categoryLabelOptions = value; } /** *

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

*/ inline void SetCategoryLabelOptions(ChartAxisLabelOptions&& value) { m_categoryLabelOptionsHasBeenSet = true; m_categoryLabelOptions = std::move(value); } /** *

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

*/ inline BarChartConfiguration& WithCategoryLabelOptions(const ChartAxisLabelOptions& value) { SetCategoryLabelOptions(value); return *this;} /** *

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

*/ inline BarChartConfiguration& WithCategoryLabelOptions(ChartAxisLabelOptions&& value) { SetCategoryLabelOptions(std::move(value)); return *this;} /** *

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

*/ inline const AxisDisplayOptions& GetValueAxis() const{ return m_valueAxis; } /** *

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

*/ inline bool ValueAxisHasBeenSet() const { return m_valueAxisHasBeenSet; } /** *

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

*/ inline void SetValueAxis(const AxisDisplayOptions& value) { m_valueAxisHasBeenSet = true; m_valueAxis = value; } /** *

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

*/ inline void SetValueAxis(AxisDisplayOptions&& value) { m_valueAxisHasBeenSet = true; m_valueAxis = std::move(value); } /** *

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

*/ inline BarChartConfiguration& WithValueAxis(const AxisDisplayOptions& value) { SetValueAxis(value); return *this;} /** *

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

*/ inline BarChartConfiguration& WithValueAxis(AxisDisplayOptions&& value) { SetValueAxis(std::move(value)); return *this;} /** *

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

*/ inline const ChartAxisLabelOptions& GetValueLabelOptions() const{ return m_valueLabelOptions; } /** *

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

*/ inline bool ValueLabelOptionsHasBeenSet() const { return m_valueLabelOptionsHasBeenSet; } /** *

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

*/ inline void SetValueLabelOptions(const ChartAxisLabelOptions& value) { m_valueLabelOptionsHasBeenSet = true; m_valueLabelOptions = value; } /** *

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

*/ inline void SetValueLabelOptions(ChartAxisLabelOptions&& value) { m_valueLabelOptionsHasBeenSet = true; m_valueLabelOptions = std::move(value); } /** *

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

*/ inline BarChartConfiguration& WithValueLabelOptions(const ChartAxisLabelOptions& value) { SetValueLabelOptions(value); return *this;} /** *

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

*/ inline BarChartConfiguration& WithValueLabelOptions(ChartAxisLabelOptions&& value) { SetValueLabelOptions(std::move(value)); return *this;} /** *

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

*/ inline const ChartAxisLabelOptions& GetColorLabelOptions() const{ return m_colorLabelOptions; } /** *

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

*/ inline bool ColorLabelOptionsHasBeenSet() const { return m_colorLabelOptionsHasBeenSet; } /** *

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

*/ inline void SetColorLabelOptions(const ChartAxisLabelOptions& value) { m_colorLabelOptionsHasBeenSet = true; m_colorLabelOptions = value; } /** *

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

*/ inline void SetColorLabelOptions(ChartAxisLabelOptions&& value) { m_colorLabelOptionsHasBeenSet = true; m_colorLabelOptions = std::move(value); } /** *

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

*/ inline BarChartConfiguration& WithColorLabelOptions(const ChartAxisLabelOptions& value) { SetColorLabelOptions(value); return *this;} /** *

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

*/ inline BarChartConfiguration& WithColorLabelOptions(ChartAxisLabelOptions&& value) { SetColorLabelOptions(std::move(value)); return *this;} /** *

The legend display setup of the visual.

*/ inline const LegendOptions& GetLegend() const{ return m_legend; } /** *

The legend display setup of the visual.

*/ inline bool LegendHasBeenSet() const { return m_legendHasBeenSet; } /** *

The legend display setup of the visual.

*/ inline void SetLegend(const LegendOptions& value) { m_legendHasBeenSet = true; m_legend = value; } /** *

The legend display setup of the visual.

*/ inline void SetLegend(LegendOptions&& value) { m_legendHasBeenSet = true; m_legend = std::move(value); } /** *

The legend display setup of the visual.

*/ inline BarChartConfiguration& WithLegend(const LegendOptions& value) { SetLegend(value); return *this;} /** *

The legend display setup of the visual.

*/ inline BarChartConfiguration& WithLegend(LegendOptions&& value) { SetLegend(std::move(value)); return *this;} /** *

The options that determine if visual data labels are displayed.

*/ inline const DataLabelOptions& GetDataLabels() const{ return m_dataLabels; } /** *

The options that determine if visual data labels are displayed.

*/ inline bool DataLabelsHasBeenSet() const { return m_dataLabelsHasBeenSet; } /** *

The options that determine if visual data labels are displayed.

*/ inline void SetDataLabels(const DataLabelOptions& value) { m_dataLabelsHasBeenSet = true; m_dataLabels = value; } /** *

The options that determine if visual data labels are displayed.

*/ inline void SetDataLabels(DataLabelOptions&& value) { m_dataLabelsHasBeenSet = true; m_dataLabels = std::move(value); } /** *

The options that determine if visual data labels are displayed.

*/ inline BarChartConfiguration& WithDataLabels(const DataLabelOptions& value) { SetDataLabels(value); return *this;} /** *

The options that determine if visual data labels are displayed.

*/ inline BarChartConfiguration& WithDataLabels(DataLabelOptions&& value) { SetDataLabels(std::move(value)); return *this;} /** *

The tooltip display setup of the visual.

*/ inline const TooltipOptions& GetTooltip() const{ return m_tooltip; } /** *

The tooltip display setup of the visual.

*/ inline bool TooltipHasBeenSet() const { return m_tooltipHasBeenSet; } /** *

The tooltip display setup of the visual.

*/ inline void SetTooltip(const TooltipOptions& value) { m_tooltipHasBeenSet = true; m_tooltip = value; } /** *

The tooltip display setup of the visual.

*/ inline void SetTooltip(TooltipOptions&& value) { m_tooltipHasBeenSet = true; m_tooltip = std::move(value); } /** *

The tooltip display setup of the visual.

*/ inline BarChartConfiguration& WithTooltip(const TooltipOptions& value) { SetTooltip(value); return *this;} /** *

The tooltip display setup of the visual.

*/ inline BarChartConfiguration& WithTooltip(TooltipOptions&& value) { SetTooltip(std::move(value)); return *this;} /** *

The reference line setup of the visual.

*/ inline const Aws::Vector& GetReferenceLines() const{ return m_referenceLines; } /** *

The reference line setup of the visual.

*/ inline bool ReferenceLinesHasBeenSet() const { return m_referenceLinesHasBeenSet; } /** *

The reference line setup of the visual.

*/ inline void SetReferenceLines(const Aws::Vector& value) { m_referenceLinesHasBeenSet = true; m_referenceLines = value; } /** *

The reference line setup of the visual.

*/ inline void SetReferenceLines(Aws::Vector&& value) { m_referenceLinesHasBeenSet = true; m_referenceLines = std::move(value); } /** *

The reference line setup of the visual.

*/ inline BarChartConfiguration& WithReferenceLines(const Aws::Vector& value) { SetReferenceLines(value); return *this;} /** *

The reference line setup of the visual.

*/ inline BarChartConfiguration& WithReferenceLines(Aws::Vector&& value) { SetReferenceLines(std::move(value)); return *this;} /** *

The reference line setup of the visual.

*/ inline BarChartConfiguration& AddReferenceLines(const ReferenceLine& value) { m_referenceLinesHasBeenSet = true; m_referenceLines.push_back(value); return *this; } /** *

The reference line setup of the visual.

*/ inline BarChartConfiguration& AddReferenceLines(ReferenceLine&& value) { m_referenceLinesHasBeenSet = true; m_referenceLines.push_back(std::move(value)); return *this; } /** *

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

*/ inline const Aws::Vector& GetContributionAnalysisDefaults() const{ return m_contributionAnalysisDefaults; } /** *

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

*/ inline bool ContributionAnalysisDefaultsHasBeenSet() const { return m_contributionAnalysisDefaultsHasBeenSet; } /** *

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

*/ inline void SetContributionAnalysisDefaults(const Aws::Vector& value) { m_contributionAnalysisDefaultsHasBeenSet = true; m_contributionAnalysisDefaults = value; } /** *

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

*/ inline void SetContributionAnalysisDefaults(Aws::Vector&& value) { m_contributionAnalysisDefaultsHasBeenSet = true; m_contributionAnalysisDefaults = std::move(value); } /** *

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

*/ inline BarChartConfiguration& WithContributionAnalysisDefaults(const Aws::Vector& value) { SetContributionAnalysisDefaults(value); return *this;} /** *

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

*/ inline BarChartConfiguration& WithContributionAnalysisDefaults(Aws::Vector&& value) { SetContributionAnalysisDefaults(std::move(value)); return *this;} /** *

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

*/ inline BarChartConfiguration& AddContributionAnalysisDefaults(const ContributionAnalysisDefault& value) { m_contributionAnalysisDefaultsHasBeenSet = true; m_contributionAnalysisDefaults.push_back(value); return *this; } /** *

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

*/ inline BarChartConfiguration& AddContributionAnalysisDefaults(ContributionAnalysisDefault&& value) { m_contributionAnalysisDefaultsHasBeenSet = true; m_contributionAnalysisDefaults.push_back(std::move(value)); return *this; } private: BarChartFieldWells m_fieldWells; bool m_fieldWellsHasBeenSet = false; BarChartSortConfiguration m_sortConfiguration; bool m_sortConfigurationHasBeenSet = false; BarChartOrientation m_orientation; bool m_orientationHasBeenSet = false; BarsArrangement m_barsArrangement; bool m_barsArrangementHasBeenSet = false; VisualPalette m_visualPalette; bool m_visualPaletteHasBeenSet = false; SmallMultiplesOptions m_smallMultiplesOptions; bool m_smallMultiplesOptionsHasBeenSet = false; AxisDisplayOptions m_categoryAxis; bool m_categoryAxisHasBeenSet = false; ChartAxisLabelOptions m_categoryLabelOptions; bool m_categoryLabelOptionsHasBeenSet = false; AxisDisplayOptions m_valueAxis; bool m_valueAxisHasBeenSet = false; ChartAxisLabelOptions m_valueLabelOptions; bool m_valueLabelOptionsHasBeenSet = false; ChartAxisLabelOptions m_colorLabelOptions; bool m_colorLabelOptionsHasBeenSet = false; LegendOptions m_legend; bool m_legendHasBeenSet = false; DataLabelOptions m_dataLabels; bool m_dataLabelsHasBeenSet = false; TooltipOptions m_tooltip; bool m_tooltipHasBeenSet = false; Aws::Vector m_referenceLines; bool m_referenceLinesHasBeenSet = false; Aws::Vector m_contributionAnalysisDefaults; bool m_contributionAnalysisDefaultsHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws