Skip to content

BarChartConfiguration

Source code in docs_src/capo_quicksight/types/bar_chart_configuration.py
class BarChartConfiguration(TypedDict, closed=True):
    field_wells: NotRequired[
        "capo_quicksight.types.bar_chart_field_wells.BarChartFieldWells"
    ]
    """<p>The field wells of the visual.</p>"""
    sort_configuration: NotRequired[
        "capo_quicksight.types.bar_chart_sort_configuration.BarChartSortConfiguration"
    ]
    """<p>The sort configuration of a <code>BarChartVisual</code>.</p>"""
    orientation: NotRequired[
        "capo_quicksight.types.bar_chart_orientation.BarChartOrientation"
    ]
    """<p>The orientation of the bars in a bar chart visual. There are two valid values in this structure:</p> <ul> <li> <p> <code>HORIZONTAL</code>: 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.</p> </li> <li> <p> <code>VERTICAL</code>: 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.</p> </li> </ul>"""
    bars_arrangement: NotRequired[
        "capo_quicksight.types.bars_arrangement.BarsArrangement"
    ]
    """<p>Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.</p>"""
    visual_palette: NotRequired["capo_quicksight.types.visual_palette.VisualPalette"]
    """<p>The palette (chart color) display setup of the visual.</p>"""
    small_multiples_options: NotRequired[
        "capo_quicksight.types.small_multiples_options.SmallMultiplesOptions"
    ]
    """<p>The small multiples setup for the visual.</p>"""
    category_axis: NotRequired[
        "capo_quicksight.types.axis_display_options.AxisDisplayOptions"
    ]
    """<p>The label display options (grid line, range, scale, axis step) for bar chart category.</p>"""
    category_label_options: NotRequired[
        "capo_quicksight.types.chart_axis_label_options.ChartAxisLabelOptions"
    ]
    """<p>The label options (label text, label visibility and sort icon visibility) for a bar chart.</p>"""
    value_axis: NotRequired[
        "capo_quicksight.types.axis_display_options.AxisDisplayOptions"
    ]
    """<p>The label display options (grid line, range, scale, axis step) for a bar chart value.</p>"""
    value_label_options: NotRequired[
        "capo_quicksight.types.chart_axis_label_options.ChartAxisLabelOptions"
    ]
    """<p>The label options (label text, label visibility and sort icon visibility) for a bar chart value.</p>"""
    color_label_options: NotRequired[
        "capo_quicksight.types.chart_axis_label_options.ChartAxisLabelOptions"
    ]
    """<p>The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.</p>"""
    default_series_settings: NotRequired[
        "capo_quicksight.types.bar_chart_default_series_settings.BarChartDefaultSeriesSettings"
    ]
    """<p>The options that determine the default presentation of all bar series in <code>BarChartVisual</code>.</p>"""
    series: NotRequired["capo_quicksight.types.bar_series_item_list.BarSeriesItemList"]
    """<p>The series item configuration of a <code>BarChartVisual</code>.</p>"""
    legend: NotRequired["capo_quicksight.types.legend_options.LegendOptions"]
    """<p>The legend display setup of the visual.</p>"""
    data_labels: NotRequired[
        "capo_quicksight.types.data_label_options.DataLabelOptions"
    ]
    """<p>The options that determine if visual data labels are displayed.</p>"""
    tooltip: NotRequired["capo_quicksight.types.tooltip_options.TooltipOptions"]
    """<p>The tooltip display setup of the visual.</p>"""
    reference_lines: NotRequired[
        "capo_quicksight.types.reference_line_list.ReferenceLineList"
    ]
    """<p>The reference line setup of the visual.</p>"""
    contribution_analysis_defaults: NotRequired[
        "capo_quicksight.types.contribution_analysis_default_list.ContributionAnalysisDefaultList"
    ]
    """<p>The contribution analysis (anomaly configuration) setup of the visual.</p>"""
    interactions: NotRequired[
        "capo_quicksight.types.visual_interaction_options.VisualInteractionOptions"
    ]
    """<p>The general visual interactions setup for a visual.</p>"""

bars_arrangement instance-attribute

bars_arrangement: NotRequired[BarsArrangement]

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

category_axis instance-attribute

category_axis: NotRequired[AxisDisplayOptions]

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

category_label_options instance-attribute

category_label_options: NotRequired[ChartAxisLabelOptions]

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

color_label_options instance-attribute

color_label_options: NotRequired[ChartAxisLabelOptions]

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

contribution_analysis_defaults instance-attribute

contribution_analysis_defaults: NotRequired[ContributionAnalysisDefaultList]

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

data_labels instance-attribute

data_labels: NotRequired[DataLabelOptions]

The options that determine if visual data labels are displayed.

default_series_settings instance-attribute

default_series_settings: NotRequired[BarChartDefaultSeriesSettings]

The options that determine the default presentation of all bar series in BarChartVisual.

field_wells instance-attribute

field_wells: NotRequired[BarChartFieldWells]

The field wells of the visual.

interactions instance-attribute

interactions: NotRequired[VisualInteractionOptions]

The general visual interactions setup for a visual.

legend instance-attribute

legend: NotRequired[LegendOptions]

The legend display setup of the visual.

orientation instance-attribute

orientation: NotRequired[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.

reference_lines instance-attribute

reference_lines: NotRequired[ReferenceLineList]

The reference line setup of the visual.

series instance-attribute

series: NotRequired[BarSeriesItemList]

The series item configuration of a BarChartVisual.

small_multiples_options instance-attribute

small_multiples_options: NotRequired[SmallMultiplesOptions]

The small multiples setup for the visual.

sort_configuration instance-attribute

sort_configuration: NotRequired[BarChartSortConfiguration]

The sort configuration of a BarChartVisual.

tooltip instance-attribute

tooltip: NotRequired[TooltipOptions]

The tooltip display setup of the visual.

value_axis instance-attribute

value_axis: NotRequired[AxisDisplayOptions]

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

value_label_options instance-attribute

value_label_options: NotRequired[ChartAxisLabelOptions]

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

visual_palette instance-attribute

visual_palette: NotRequired[VisualPalette]

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