Skip to content

TooltipSheetDefinition

Source code in docs_src/capo_quicksight/types/tooltip_sheet_definition.py
class TooltipSheetDefinition(TypedDict, closed=True):
    sheet_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The unique identifier of a tooltip sheet.</p>"""
    name: NotRequired["capo_quicksight.types.sheet_name.SheetName"]
    """<p>The name of the tooltip sheet. This name is displayed on the sheet's tab in the Quick console.</p>"""
    visuals: NotRequired[
        "capo_quicksight.types.tooltip_sheet_visual_list.TooltipSheetVisualList"
    ]
    """<p>A list of the visuals that are on a tooltip sheet.</p>"""
    text_boxes: NotRequired[
        "capo_quicksight.types.tooltip_sheet_text_box_list.TooltipSheetTextBoxList"
    ]
    """<p>The text boxes that are on a tooltip sheet.</p>"""
    images: NotRequired[
        "capo_quicksight.types.tooltip_sheet_image_list.TooltipSheetImageList"
    ]
    """<p>A list of images on a tooltip sheet.</p>"""
    layouts: NotRequired["capo_quicksight.types.layout_list.LayoutList"]
    """<p>Layouts define how the components of a tooltip sheet are arranged.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html">Types of layout</a> in the <i>Amazon Quick Suite User Guide</i>.</p>"""

images instance-attribute

images: NotRequired[TooltipSheetImageList]

A list of images on a tooltip sheet.

layouts instance-attribute

layouts: NotRequired[LayoutList]

Layouts define how the components of a tooltip sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

name instance-attribute

name: NotRequired[SheetName]

The name of the tooltip sheet. This name is displayed on the sheet's tab in the Quick console.

sheet_id instance-attribute

The unique identifier of a tooltip sheet.

text_boxes instance-attribute

text_boxes: NotRequired[TooltipSheetTextBoxList]

The text boxes that are on a tooltip sheet.

visuals instance-attribute

visuals: NotRequired[TooltipSheetVisualList]

A list of the visuals that are on a tooltip sheet.