SelectWorkspace
Introduction
SelectWorkspace
widget in Supervisely is a dropdown menu that allows users to select a workspace from a list of available workspaces. Clicking on it can be processed from python code. This widget is particularly useful when working with multiple workspaces in Supervisely and allows to easily switch between workspaces in applications.
Function signature
SelectWorkspace(
default_id=None,
team_id=None,
compact=False,
show_label=True,
size=None,
widget_id=None
)

Parameters
default_id
int
Workspace
ID
team_id
int
Team
ID
compact
bool
Show only workspace select
show_label
bool
Show label
size
Literal["large", "small", "mini", None]
Selector size (large/small/mini)
widget_id
str
ID of the widget
default_id
Determine Workspace
will be selected by default.
type: int
default value: None
select_workspace = SelectWorkspace(default_id=workspace_id)

team_id
Determine Team
will be selected by default.
type: int
default value: None
select_workspace = SelectWorkspace(team_id=team_id)

compact
Show only Workspace
select.
type: bool
default value: false
select_workspace = SelectWorkspace(default_id=workspace_id, compact=True)

show_label
Determine show text Workspace
on widget or not, work only if compact
is True.
type: bool
default value: True
select_workspace = SelectWorkspace(
default_id=workspace_id, team_id=team_id, compact=True, show_label=False
)

size
Size of input.
type: Literal["large", "small", "mini", None]
default value: None
select_workspace = SelectWorkspace(default_id=workspace_id, compact=True, show_label=False)
select_workspace_mini = SelectWorkspace(
default_id=workspace_id, compact=True, show_label=False, size="mini"
)
select_workspace_small = SelectWorkspace(
default_id=workspace_id, compact=True, show_label=False, size="small"
)
select_workspace_large = SelectWorkspace(
default_id=workspace_id, compact=True, show_label=False, size="large"
)
card = Card(
title="Select Workspace",
content=Container(
widgets=[
select_workspace,
select_workspace_mini,
select_workspace_small,
select_workspace_large,
]
),
)

widget_id
ID of the widget.
type: str
default value: None
Methods and attributes
get_selected_id()
Return selected workspace id.
Mini App Example
You can find this example in our Github repository:
ui-widgets-demos/selection/003_select_workspace/src/main.py
Import libraries
import os
import supervisely as sly
from dotenv import load_dotenv
from supervisely.app.widgets import Card, Container, SelectWorkspace
Init API client
First, we load environment variables with credentials and init API for communicating with Supervisely Instance:
load_dotenv("local.env")
load_dotenv(os.path.expanduser("~/supervisely.env"))
api = sly.Api()
Prepare team_id
and workspace_id
team_id
and workspace_id
team_id = sly.env.team_id()
workspace_id = sly.env.workspace_id()
Initialize SelectWorkspace
widget
SelectWorkspace
widgetselect_workspace = SelectWorkspace(
default_id=workspace_id,
team_id=team_id,
)
Create app layout
Prepare a layout for app using Card
widget with the content
parameter and place widget that we've just created in the Container
widget.
card = Card(
title="Select Workspace",
content=Container(widgets=[select_project]),
)
layout = Container(widgets=[card])
Create app using layout
Create an app object with layout parameter.
app = sly.Application(layout=layout)

Last updated
Was this helpful?