Struct aws_sdk_quicksight::types::BarChartConfiguration

#[non_exhaustive]
pub struct BarChartConfiguration {

    pub field_wells: Option<BarChartFieldWells>,
    pub sort_configuration: Option<BarChartSortConfiguration>,
    pub orientation: Option<BarChartOrientation>,
    pub bars_arrangement: Option<BarsArrangement>,
    pub visual_palette: Option<VisualPalette>,
    pub small_multiples_options: Option<SmallMultiplesOptions>,
    pub category_axis: Option<AxisDisplayOptions>,
    pub category_label_options: Option<ChartAxisLabelOptions>,
    pub value_axis: Option<AxisDisplayOptions>,
    pub value_label_options: Option<ChartAxisLabelOptions>,
    pub color_label_options: Option<ChartAxisLabelOptions>,
    pub legend: Option<LegendOptions>,
    pub data_labels: Option<DataLabelOptions>,
    pub tooltip: Option<TooltipOptions>,
    pub reference_lines: Option<Vec<ReferenceLine>>,
    pub contribution_analysis_defaults: Option<Vec<ContributionAnalysisDefault>>,
}

The configuration of a BarChartVisual.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

field_wells: Option<BarChartFieldWells>

The field wells of the visual.

sort_configuration: Option<BarChartSortConfiguration>

The sort configuration of a BarChartVisual.

orientation: Option<BarChartOrientation>

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.

bars_arrangement: Option<BarsArrangement>

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

visual_palette: Option<VisualPalette>

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

small_multiples_options: Option<SmallMultiplesOptions>

The small multiples setup for the visual.

category_axis: Option<AxisDisplayOptions>

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

category_label_options: Option<ChartAxisLabelOptions>

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

value_axis: Option<AxisDisplayOptions>

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

value_label_options: Option<ChartAxisLabelOptions>

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

color_label_options: Option<ChartAxisLabelOptions>

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

legend: Option<LegendOptions>

The legend display setup of the visual.

data_labels: Option<DataLabelOptions>

The options that determine if visual data labels are displayed.

tooltip: Option<TooltipOptions>

The tooltip display setup of the visual.

reference_lines: Option<Vec<ReferenceLine>>

The reference line setup of the visual.

contribution_analysis_defaults: Option<Vec<ContributionAnalysisDefault>>

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

Implementations

impl BarChartConfiguration

pub fn field_wells(&self) -> Option<&BarChartFieldWells>

The field wells of the visual.

pub fn sort_configuration(&self) -> Option<&BarChartSortConfiguration>

The sort configuration of a BarChartVisual.

pub fn orientation(&self) -> Option<&BarChartOrientation>

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.

pub fn bars_arrangement(&self) -> Option<&BarsArrangement>

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

pub fn visual_palette(&self) -> Option<&VisualPalette>

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

pub fn small_multiples_options(&self) -> Option<&SmallMultiplesOptions>

The small multiples setup for the visual.

pub fn category_axis(&self) -> Option<&AxisDisplayOptions>

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

pub fn category_label_options(&self) -> Option<&ChartAxisLabelOptions>

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

pub fn value_axis(&self) -> Option<&AxisDisplayOptions>

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

pub fn value_label_options(&self) -> Option<&ChartAxisLabelOptions>

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

pub fn color_label_options(&self) -> Option<&ChartAxisLabelOptions>

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

pub fn legend(&self) -> Option<&LegendOptions>

The legend display setup of the visual.

pub fn data_labels(&self) -> Option<&DataLabelOptions>

The options that determine if visual data labels are displayed.

pub fn tooltip(&self) -> Option<&TooltipOptions>

The tooltip display setup of the visual.

pub fn reference_lines(&self) -> &[ReferenceLine]

The reference line setup of the visual.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .reference_lines.is_none().

pub fn contribution_analysis_defaults(&self) -> &[ContributionAnalysisDefault]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .contribution_analysis_defaults.is_none().

impl BarChartConfiguration

pub fn builder() -> BarChartConfigurationBuilder

Creates a new builder-style object to manufacture BarChartConfiguration.

Trait Implementations

impl Clone for BarChartConfiguration

fn clone(&self) -> BarChartConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BarChartConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BarChartConfiguration

fn eq(&self, other: &BarChartConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BarChartConfiguration