Button

Button

Button(
    *,
    action: ExternalAction,
    widget_id: Optional[str] = None,
    icon: Optional[TemplatedStringItem] = None,
    label: Optional[TemplatedStringItem] = None
)

Spec for Button widget.

Construct spec for Button widget.

Parameters:

Name	Type	Description	Default
action	ExternalAction	Type of action to be performed on the button.	required
widget_id	Optional[str]	unique widget id in a dashboard.	None
icon	Optional[TemplatedStringItem]	icon spec.	None
label	Optional[TemplatedStringItem]	label to be displayed in the button.	None

Examples:

Create a minimal Button widget

import pandas as pd
from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import button
from engineai.sdk.dashboard.widgets import table

table_widget = table.Table(
    pd.DataFrame({"text": ["text"]}),
    columns=["text"],
)

button_widget = button.Button(
    action=button.ExternalAction(
        event_type="text",
        event_data=table_widget.selected.text,
    ),
)

Dashboard(content=[table_widget, button_widget])

Create a Button widget with icon and label

import pandas as pd
from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import button
from engineai.sdk.dashboard.widgets import table

table_widget = table.Table(
    pd.DataFrame({"text": ["text"]}),
    columns=["text"],
)

button_widget = button.Button(
    action=button.ExternalAction(
        event_type="text",
        event_data=table_widget.selected.text,
    ),
    icon="Lock",
    label="Button",
)

Dashboard(content=[table_widget, button_widget])

ExternalAction

ExternalAction(
    *,
    event_type: TemplatedStringItem,
    event_data: Union[WidgetField, RouteLink]
)

Spec for Button Action.

Construct spec for Button Action.

Parameters:

Name	Type	Description	Default
event_type	TemplatedStringItem	event type spec.	required
event_data	Union[WidgetField, RouteLink]	event data spec.	required