Skip to content

KPIOptions

Source code in docs_src/capo_quicksight/types/kpi_options.py
class KPIOptions(TypedDict, closed=True):
    progress_bar: NotRequired[
        "capo_quicksight.types.progress_bar_options.ProgressBarOptions"
    ]
    """<p>The options that determine the presentation of the progress bar of a KPI visual.</p>"""
    trend_arrows: NotRequired[
        "capo_quicksight.types.trend_arrow_options.TrendArrowOptions"
    ]
    """<p>The options that determine the presentation of trend arrows in a KPI visual.</p>"""
    secondary_value: NotRequired[
        "capo_quicksight.types.secondary_value_options.SecondaryValueOptions"
    ]
    """<p>The options that determine the presentation of the secondary value of a KPI visual.</p>"""
    comparison: NotRequired[
        "capo_quicksight.types.comparison_configuration.ComparisonConfiguration"
    ]
    """<p>The comparison configuration of a KPI visual.</p>"""
    primary_value_display_type: NotRequired[
        "capo_quicksight.types.primary_value_display_type.PrimaryValueDisplayType"
    ]
    """<p>The options that determine the primary value display type.</p>"""
    primary_value_font_configuration: NotRequired[
        "capo_quicksight.types.font_configuration.FontConfiguration"
    ]
    """<p>The options that determine the primary value font configuration.</p>"""
    secondary_value_font_configuration: NotRequired[
        "capo_quicksight.types.font_configuration.FontConfiguration"
    ]
    """<p>The options that determine the secondary value font configuration.</p>"""
    sparkline: NotRequired[
        "capo_quicksight.types.kpi_sparkline_options.KPISparklineOptions"
    ]
    """<p>The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.</p>"""
    visual_layout_options: NotRequired[
        "capo_quicksight.types.kpi_visual_layout_options.KPIVisualLayoutOptions"
    ]
    """<p>The options that determine the layout a KPI visual.</p>"""

comparison instance-attribute

comparison: NotRequired[ComparisonConfiguration]

The comparison configuration of a KPI visual.

primary_value_display_type instance-attribute

primary_value_display_type: NotRequired[PrimaryValueDisplayType]

The options that determine the primary value display type.

primary_value_font_configuration instance-attribute

primary_value_font_configuration: NotRequired[FontConfiguration]

The options that determine the primary value font configuration.

progress_bar instance-attribute

progress_bar: NotRequired[ProgressBarOptions]

The options that determine the presentation of the progress bar of a KPI visual.

secondary_value instance-attribute

secondary_value: NotRequired[SecondaryValueOptions]

The options that determine the presentation of the secondary value of a KPI visual.

secondary_value_font_configuration instance-attribute

secondary_value_font_configuration: NotRequired[FontConfiguration]

The options that determine the secondary value font configuration.

sparkline instance-attribute

sparkline: NotRequired[KPISparklineOptions]

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

trend_arrows instance-attribute

trend_arrows: NotRequired[TrendArrowOptions]

The options that determine the presentation of trend arrows in a KPI visual.

visual_layout_options instance-attribute

visual_layout_options: NotRequired[KPIVisualLayoutOptions]

The options that determine the layout a KPI visual.