Toggle

Toggle

Toggle(
    data: DataType | DataFrame,
    *,
    id_column: str = "id",
    label: str | WidgetField = "",
    label_column: str | None = None,
    widget_id: str | None = None,
    default_selection: str | None = None,
)

Enables selection from list, toggling between entries/settings.

Enables users to select from a list of entries, providing a mechanism to toggle between different selections or settings.

Constructor for Toggle widget.

Parameters:

Name	Type	Description	Default
id_column	str	Column name in pandas DataFrame used as entries ids.	'id'
data	DataType | DataFrame	data source for the widget.	required
label	str | WidgetField	toggle widget label.	''
label_column	str | None	Column name in pandas DataFrame used for the widget labeling.	None
widget_id	str | None	unique widget id in a dashboard.	None
default_selection	str | None	pre selected entities on initial state.	None

Examples:

Create a minimal Toggle widget

import pandas as pd
from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import toggle

df = pd.DataFrame(
    {
        "id": ["1", "2", "3"],
    }
)

toggle_widget = toggle.Toggle(df)

Dashboard(
    workspace_slug="my-workspace",
    app_slug="my-app",
    slug="first-dashboard",
    content=toggle_widget,
)

Create a Toggle with customized labels for each entry

import pandas as pd
from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import toggle

df = pd.DataFrame(
    {
        "id": ["1", "2", "3"],
        "label": ["First", "Second", "Third"],
    }
)

toggle_widget = toggle.Toggle(df, label_column="label")

Dashboard(
    workspace_slug="my-workspace",
    app_slug="my-app",
    slug="first-dashboard",
    content=toggle_widget,
)