Skip to content

TooltipOptions

Source code in docs_src/capo_quicksight/types/tooltip_options.py
class TooltipOptions(TypedDict, closed=True):
    tooltip_visibility: NotRequired["capo_quicksight.types.visibility.Visibility"]
    """<p>Determines whether or not the tooltip is visible.</p>"""
    selected_tooltip_type: NotRequired[
        "capo_quicksight.types.selected_tooltip_type.SelectedTooltipType"
    ]
    """<p>The selected type for the tooltip. Choose one of the following options:</p> <ul> <li> <p> <code>BASIC</code>: A basic tooltip.</p> </li> <li> <p> <code>DETAILED</code>: A detailed tooltip.</p> </li> </ul>"""
    field_based_tooltip: NotRequired[
        "capo_quicksight.types.field_based_tooltip.FieldBasedTooltip"
    ]
    """<p>The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.</p>"""
    sheet_tooltip: NotRequired["capo_quicksight.types.sheet_tooltip.SheetTooltip"]

field_based_tooltip instance-attribute

field_based_tooltip: NotRequired[FieldBasedTooltip]

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

selected_tooltip_type instance-attribute

selected_tooltip_type: NotRequired[SelectedTooltipType]

The selected type for the tooltip. Choose one of the following options:

  • BASIC: A basic tooltip.

  • DETAILED: A detailed tooltip.

sheet_tooltip instance-attribute

sheet_tooltip: NotRequired[SheetTooltip]

tooltip_visibility instance-attribute

tooltip_visibility: NotRequired[Visibility]

Determines whether or not the tooltip is visible.