Skip to content

LegendOptions

Source code in docs_src/capo_quicksight/types/legend_options.py
class LegendOptions(TypedDict, closed=True):
    visibility: NotRequired["capo_quicksight.types.visibility.Visibility"]
    """<p>Determines whether or not the legend is visible.</p>"""
    title: NotRequired["capo_quicksight.types.label_options.LabelOptions"]
    """<p>The custom title for the legend.</p>"""
    position: NotRequired["capo_quicksight.types.legend_position.LegendPosition"]
    """<p>The positions for the legend. Choose one of the following options:</p> <ul> <li> <p> <code>AUTO</code> </p> </li> <li> <p> <code>RIGHT</code> </p> </li> <li> <p> <code>BOTTOM</code> </p> </li> <li> <p> <code>LEFT</code> </p> </li> </ul>"""
    width: NotRequired["capo_quicksight.types.pixel_length.PixelLength"]
    """<p>The width of the legend. If this value is omitted, a default width is used when rendering.</p>"""
    height: NotRequired["capo_quicksight.types.pixel_length.PixelLength"]
    """<p>The height of the legend. If this value is omitted, a default height is used when rendering.</p>"""
    value_font_configuration: NotRequired[
        "capo_quicksight.types.font_configuration.FontConfiguration"
    ]

height instance-attribute

height: NotRequired[PixelLength]

The height of the legend. If this value is omitted, a default height is used when rendering.

position instance-attribute

position: NotRequired[LegendPosition]

The positions for the legend. Choose one of the following options:

  • AUTO

  • RIGHT

  • BOTTOM

  • LEFT

title instance-attribute

title: NotRequired[LabelOptions]

The custom title for the legend.

value_font_configuration instance-attribute

value_font_configuration: NotRequired[FontConfiguration]

visibility instance-attribute

visibility: NotRequired[Visibility]

Determines whether or not the legend is visible.

width instance-attribute

width: NotRequired[PixelLength]

The width of the legend. If this value is omitted, a default width is used when rendering.