Skip to content

KPIVisual

Source code in docs_src/capo_quicksight/types/kpi_visual.py
class KPIVisual(TypedDict, closed=True):
    visual_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"""
    title: NotRequired[
        "capo_quicksight.types.visual_title_label_options.VisualTitleLabelOptions"
    ]
    """<p>The title that is displayed on the visual.</p>"""
    subtitle: NotRequired[
        "capo_quicksight.types.visual_subtitle_label_options.VisualSubtitleLabelOptions"
    ]
    """<p>The subtitle that is displayed on the visual.</p>"""
    chart_configuration: NotRequired[
        "capo_quicksight.types.kpi_configuration.KPIConfiguration"
    ]
    """<p>The configuration of a KPI visual.</p>"""
    conditional_formatting: NotRequired[
        "capo_quicksight.types.kpi_conditional_formatting.KPIConditionalFormatting"
    ]
    """<p>The conditional formatting of a KPI visual.</p>"""
    actions: NotRequired[
        "capo_quicksight.types.visual_custom_action_list.VisualCustomActionList"
    ]
    """<p>The list of custom actions that are configured for a visual.</p>"""
    column_hierarchies: NotRequired[
        "capo_quicksight.types.column_hierarchy_list.ColumnHierarchyList"
    ]
    """<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"""
    visual_content_alt_text: NotRequired[
        "capo_quicksight.types.long_plain_text.LongPlainText"
    ]
    """<p>The alt text for the visual.</p>"""

actions instance-attribute

actions: NotRequired[VisualCustomActionList]

The list of custom actions that are configured for a visual.

chart_configuration instance-attribute

chart_configuration: NotRequired[KPIConfiguration]

The configuration of a KPI visual.

column_hierarchies instance-attribute

column_hierarchies: NotRequired[ColumnHierarchyList]

The column hierarchy that is used during drill-downs and drill-ups.

conditional_formatting instance-attribute

conditional_formatting: NotRequired[KPIConditionalFormatting]

The conditional formatting of a KPI visual.

subtitle instance-attribute

subtitle: NotRequired[VisualSubtitleLabelOptions]

The subtitle that is displayed on the visual.

title instance-attribute

title: NotRequired[VisualTitleLabelOptions]

The title that is displayed on the visual.

visual_content_alt_text instance-attribute

visual_content_alt_text: NotRequired[LongPlainText]

The alt text for the visual.

visual_id instance-attribute

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.