Skip to content

SheetImage

Source code in docs_src/capo_quicksight/types/sheet_image.py
class SheetImage(TypedDict, closed=True):
    sheet_image_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The ID of the sheet image.</p>"""
    source: "capo_quicksight.types.sheet_image_source.SheetImageSource"
    """<p>The source of the image.</p>"""
    scaling: NotRequired[
        "capo_quicksight.types.sheet_image_scaling_configuration.SheetImageScalingConfiguration"
    ]
    """<p>Determines how the image is scaled.</p>"""
    tooltip: NotRequired[
        "capo_quicksight.types.sheet_image_tooltip_configuration.SheetImageTooltipConfiguration"
    ]
    """<p>The tooltip to be shown when hovering over the image.</p>"""
    image_content_alt_text: NotRequired[
        "capo_quicksight.types.long_plain_text.LongPlainText"
    ]
    """<p>The alt text for the image.</p>"""
    interactions: NotRequired[
        "capo_quicksight.types.image_interaction_options.ImageInteractionOptions"
    ]
    """<p>The general image interactions setup for an image.</p>"""
    actions: NotRequired[
        "capo_quicksight.types.image_custom_action_list.ImageCustomActionList"
    ]
    """<p>A list of custom actions that are configured for an image.</p>"""

actions instance-attribute

actions: NotRequired[ImageCustomActionList]

A list of custom actions that are configured for an image.

image_content_alt_text instance-attribute

image_content_alt_text: NotRequired[LongPlainText]

The alt text for the image.

interactions instance-attribute

interactions: NotRequired[ImageInteractionOptions]

The general image interactions setup for an image.

scaling instance-attribute

scaling: NotRequired[SheetImageScalingConfiguration]

Determines how the image is scaled.

sheet_image_id instance-attribute

The ID of the sheet image.

source instance-attribute

The source of the image.

tooltip instance-attribute

tooltip: NotRequired[SheetImageTooltipConfiguration]

The tooltip to be shown when hovering over the image.