Skip to content

SparklinesOptions

Source code in docs_src/capo_quicksight/types/sparklines_options.py
class SparklinesOptions(TypedDict, closed=True):
    field_id: "capo_quicksight.types.field_id.FieldId"
    """<p>The field ID of the value column that the sparkline is applied to.</p>"""
    x_axis_field: "capo_quicksight.types.dimension_field.DimensionField"
    y_axis_behavior: NotRequired[
        "capo_quicksight.types.sparkline_axis_behavior.SparklineAxisBehavior"
    ]
    """<p>Determines whether the Y axis is shared across all sparklines or independent for each sparkline.</p>"""
    visual_type: NotRequired[
        "capo_quicksight.types.sparkline_visual_type.SparklineVisualType"
    ]
    """<p>The type of the sparkline. Valid values are <code>LINE</code> and <code>AREA_LINE</code>.</p>"""
    line_color: NotRequired["capo_quicksight.types.hex_color.HexColor"]
    """<p>The color of the sparkline line.</p>"""
    line_interpolation: NotRequired[
        "capo_quicksight.types.line_interpolation.LineInterpolation"
    ]
    """<p>The interpolation style for the sparkline line.</p>"""
    all_points_marker: NotRequired[
        "capo_quicksight.types.line_chart_marker_style_settings.LineChartMarkerStyleSettings"
    ]
    max_value_marker: NotRequired[
        "capo_quicksight.types.line_chart_marker_style_settings.LineChartMarkerStyleSettings"
    ]
    min_value_marker: NotRequired[
        "capo_quicksight.types.line_chart_marker_style_settings.LineChartMarkerStyleSettings"
    ]

all_points_marker instance-attribute

all_points_marker: NotRequired[LineChartMarkerStyleSettings]

field_id instance-attribute

field_id: FieldId

The field ID of the value column that the sparkline is applied to.

line_color instance-attribute

line_color: NotRequired[HexColor]

The color of the sparkline line.

line_interpolation instance-attribute

line_interpolation: NotRequired[LineInterpolation]

The interpolation style for the sparkline line.

max_value_marker instance-attribute

max_value_marker: NotRequired[LineChartMarkerStyleSettings]

min_value_marker instance-attribute

min_value_marker: NotRequired[LineChartMarkerStyleSettings]

visual_type instance-attribute

visual_type: NotRequired[SparklineVisualType]

The type of the sparkline. Valid values are LINE and AREA_LINE.

x_axis_field instance-attribute

x_axis_field: DimensionField

y_axis_behavior instance-attribute

y_axis_behavior: NotRequired[SparklineAxisBehavior]

Determines whether the Y axis is shared across all sparklines or independent for each sparkline.