Skip to content

Widget

Source code in docs_src/capo_bcm_dashboards/types/widget.py
class Widget(TypedDict, closed=True):
    id: NotRequired["capo_bcm_dashboards.types.widget_id.WidgetId"]
    """<p>The unique identifier for the widget.</p>"""
    title: "capo_bcm_dashboards.types.widget_title.WidgetTitle"
    """<p>The title of the widget.</p>"""
    description: NotRequired["capo_bcm_dashboards.types.description.Description"]
    """<p>A description of the widget's purpose or the data it displays.</p>"""
    width: "capo_bcm_dashboards.types.widget_width.WidgetWidth"
    """<p>The width of the widget in column spans. The dashboard layout consists of a grid system.</p>"""
    height: "capo_bcm_dashboards.types.widget_height.WidgetHeight"
    """<p>The height of the widget in row spans. The dashboard layout consists of a grid system.</p>"""
    horizontal_offset: "int"
    """<p>Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.</p>"""
    configs: "capo_bcm_dashboards.types.widget_config_list.WidgetConfigList"
    """<p>An array of configurations that define the data queries and display settings for the widget.</p>"""

configs instance-attribute

An array of configurations that define the data queries and display settings for the widget.

description instance-attribute

description: NotRequired[Description]

A description of the widget's purpose or the data it displays.

height instance-attribute

height: WidgetHeight

The height of the widget in row spans. The dashboard layout consists of a grid system.

horizontal_offset instance-attribute

horizontal_offset: int

Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.

id instance-attribute

id: NotRequired[WidgetId]

The unique identifier for the widget.

title instance-attribute

title: WidgetTitle

The title of the widget.

width instance-attribute

width: WidgetWidth

The width of the widget in column spans. The dashboard layout consists of a grid system.