Skip to content

ComboChartConfiguration

Source code in docs_src/capo_quicksight/types/combo_chart_configuration.py
class ComboChartConfiguration(TypedDict, closed=True):
    field_wells: NotRequired[
        "capo_quicksight.types.combo_chart_field_wells.ComboChartFieldWells"
    ]
    """<p>The field wells of the visual.</p>"""
    sort_configuration: NotRequired[
        "capo_quicksight.types.combo_chart_sort_configuration.ComboChartSortConfiguration"
    ]
    """<p>The sort configuration of a <code>ComboChartVisual</code>.</p>"""
    bars_arrangement: NotRequired[
        "capo_quicksight.types.bars_arrangement.BarsArrangement"
    ]
    """<p>Determines the bar arrangement in a combo chart. The following are valid values in this structure:</p> <ul> <li> <p> <code>CLUSTERED</code>: For clustered bar combo charts.</p> </li> <li> <p> <code>STACKED</code>: For stacked bar combo charts.</p> </li> <li> <p> <code>STACKED_PERCENT</code>: Do not use. If you use this value, the operation returns a validation error.</p> </li> </ul>"""
    category_axis: NotRequired[
        "capo_quicksight.types.axis_display_options.AxisDisplayOptions"
    ]
    """<p>The category axis of a combo chart.</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) of a combo chart category (group/color) field well.</p>"""
    primary_y_axis_display_options: NotRequired[
        "capo_quicksight.types.axis_display_options.AxisDisplayOptions"
    ]
    """<p>The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.</p>"""
    primary_y_axis_label_options: NotRequired[
        "capo_quicksight.types.chart_axis_label_options.ChartAxisLabelOptions"
    ]
    """<p>The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.</p>"""
    secondary_y_axis_display_options: NotRequired[
        "capo_quicksight.types.axis_display_options.AxisDisplayOptions"
    ]
    """<p>The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.</p>"""
    secondary_y_axis_label_options: NotRequired[
        "capo_quicksight.types.chart_axis_label_options.ChartAxisLabelOptions"
    ]
    """<p>The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.</p>"""
    single_axis_options: NotRequired[
        "capo_quicksight.types.single_axis_options.SingleAxisOptions"
    ]
    color_label_options: NotRequired[
        "capo_quicksight.types.chart_axis_label_options.ChartAxisLabelOptions"
    ]
    """<p>The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.</p>"""
    default_series_settings: NotRequired[
        "capo_quicksight.types.combo_chart_default_series_settings.ComboChartDefaultSeriesSettings"
    ]
    """<p>The options that determine the default presentation of all series in <code>ComboChartVisual</code>.</p>"""
    series: NotRequired[
        "capo_quicksight.types.combo_series_item_list.ComboSeriesItemList"
    ]
    """<p>The series item configuration of a <code>ComboChartVisual</code>.</p>"""
    legend: NotRequired["capo_quicksight.types.legend_options.LegendOptions"]
    """<p>The legend display setup of the visual.</p>"""
    bar_data_labels: NotRequired[
        "capo_quicksight.types.data_label_options.DataLabelOptions"
    ]
    """<p>The options that determine if visual data labels are displayed.</p> <p>The data label options for a bar in a combo chart.</p>"""
    line_data_labels: NotRequired[
        "capo_quicksight.types.data_label_options.DataLabelOptions"
    ]
    """<p>The options that determine if visual data labels are displayed.</p> <p>The data label options for a line in a combo chart.</p>"""
    tooltip: NotRequired["capo_quicksight.types.tooltip_options.TooltipOptions"]
    """<p>The legend 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>"""
    visual_palette: NotRequired["capo_quicksight.types.visual_palette.VisualPalette"]
    """<p>The palette (chart color) display setup of the visual.</p>"""
    interactions: NotRequired[
        "capo_quicksight.types.visual_interaction_options.VisualInteractionOptions"
    ]
    """<p>The general visual interactions setup for a visual.</p>"""

bar_data_labels instance-attribute

bar_data_labels: NotRequired[DataLabelOptions]

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

bars_arrangement instance-attribute

bars_arrangement: NotRequired[BarsArrangement]

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

  • CLUSTERED: For clustered bar combo charts.

  • STACKED: For stacked bar combo charts.

  • STACKED_PERCENT: Do not use. If you use this value, the operation returns a validation error.

category_axis instance-attribute

category_axis: NotRequired[AxisDisplayOptions]

The category axis of a combo chart.

category_label_options instance-attribute

category_label_options: NotRequired[ChartAxisLabelOptions]

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

color_label_options instance-attribute

color_label_options: NotRequired[ChartAxisLabelOptions]

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

default_series_settings instance-attribute

default_series_settings: NotRequired[ComboChartDefaultSeriesSettings]

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

field_wells instance-attribute

field_wells: NotRequired[ComboChartFieldWells]

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.

line_data_labels instance-attribute

line_data_labels: NotRequired[DataLabelOptions]

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

primary_y_axis_display_options instance-attribute

primary_y_axis_display_options: NotRequired[AxisDisplayOptions]

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

primary_y_axis_label_options instance-attribute

primary_y_axis_label_options: NotRequired[ChartAxisLabelOptions]

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

reference_lines instance-attribute

reference_lines: NotRequired[ReferenceLineList]

The reference line setup of the visual.

secondary_y_axis_display_options instance-attribute

secondary_y_axis_display_options: NotRequired[AxisDisplayOptions]

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

secondary_y_axis_label_options instance-attribute

secondary_y_axis_label_options: NotRequired[ChartAxisLabelOptions]

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

series instance-attribute

series: NotRequired[ComboSeriesItemList]

The series item configuration of a ComboChartVisual.

single_axis_options instance-attribute

single_axis_options: NotRequired[SingleAxisOptions]

sort_configuration instance-attribute

sort_configuration: NotRequired[ComboChartSortConfiguration]

The sort configuration of a ComboChartVisual.

tooltip instance-attribute

tooltip: NotRequired[TooltipOptions]

The legend display setup of the visual.

visual_palette instance-attribute

visual_palette: NotRequired[VisualPalette]

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