Supervisely
About SuperviselyEcosystemContact usSlack
  • 💻Supervisely Developer Portal
  • 🎉Getting Started
    • Installation
    • Basics of authentication
    • Intro to Python SDK
    • Environment variables
    • Supervisely annotation format
      • Project Structure
      • Project Meta: Classes, Tags, Settings
      • Objects
      • Tags
      • Image Annotation
      • Video Annotation
      • Point Clouds Annotation
      • Point Cloud Episode Annotation
      • Volumes Annotation
    • Python SDK tutorials
      • Images
        • Images
        • Image and object tags
        • Spatial labels on images
        • Keypoints (skeletons)
        • Multispectral images
        • Multiview images
        • Advanced: Optimized Import
        • Advanced: Export
      • Videos
        • Videos
        • Video and object tags
        • Spatial labels on videos
      • Point Clouds
        • Point Clouds (LiDAR)
        • Point Cloud Episodes and object tags
        • 3D point cloud object segmentation based on sensor fusion and 2D mask guidance
        • 3D segmentation masks projection on 2D photo context image
      • Volumes
        • Volumes (DICOM)
        • Spatial labels on volumes
      • Common
        • Iterate over a project
        • Iterate over a local project
        • Progress Bar tqdm
        • Cloning projects for development
    • Command Line Interface (CLI)
      • Enterprise CLI Tool
        • Instance administration
        • Workflow automation
      • Supervisely SDK CLI
    • Connect your computer
      • Linux
      • Windows WSL
      • Troubleshooting
  • 🔥App development
    • Basics
      • Create app from any py-script
      • Configuration file
        • config.json
        • Example 1. Headless
        • Example 2. App with GUI
        • v1 - Legacy
          • Example 1. v1 Modal Window
          • Example 2. v1 app with GUI
      • Add private app
      • Add public app
      • App Compatibility
    • Apps with GUI
      • Hello World!
      • App in the Image Labeling Tool
      • App in the Video Labeling Tool
      • In-browser app in the Labeling Tool
    • Custom import app
      • Overview
      • From template - simple
      • From scratch - simple
      • From scratch GUI - advanced
      • Finding directories with specific markers
    • Custom export app
      • Overview
      • From template - simple
      • From scratch - advanced
    • Neural Network integration
      • Overview
      • Serving App
        • Introduction
        • Instance segmentation
        • Object detection
        • Semantic segmentation
        • Pose estimation
        • Point tracking
        • Object tracking
        • Mask tracking
        • Image matting
        • How to customize model inference
        • Example: Custom model inference with probability maps
      • Serving App with GUI
        • Introduction
        • How to use default GUI template
        • Default GUI template customization
        • How to create custom user interface
      • Inference API
      • Training App
        • Overview
        • Tensorboard template
        • Object detection
      • High level scheme
      • Custom inference pipeline
      • Train and predict automation model pipeline
    • Advanced
      • Advanced debugging
      • How to make your own widget
      • Tutorial - App Engine v1
        • Chapter 1 Headless
          • Part 1 — Hello world! [From your Python script to Supervisely APP]
          • Part 2 — Errors handling [Catching all bugs]
          • Part 3 — Site Packages [Customize your app]
          • Part 4 — SDK Preview [Lemons counter app]
          • Part 5 — Integrate custom tracker into Videos Annotator tool [OpenCV Tracker]
        • Chapter 2 Modal Window
          • Part 1 — Modal window [What is it?]
          • Part 2 — States and Widgets [Customize modal window]
        • Chapter 3 UI
          • Part 1 — While True Script [It's all what you need]
          • Part 2 — UI Rendering [Simplest UI Application]
          • Part 3 — APP Handlers [Handle Events and Errors]
          • Part 4 — State and Data [Mutable Fields]
          • Part 5 — Styling your app [Customizing the UI]
        • Chapter 4 Additionals
          • Part 1 — Remote Developing with PyCharm [Docker SSH Server]
      • Custom Configuration
        • Fixing SSL Certificate Errors in Supervisely
        • Fixing 400 HTTP errors when using HTTP instead of HTTPS
      • Autostart
      • Coordinate System
      • MLOps Workflow integration
    • Widgets
      • Input
        • Input
        • InputNumber
        • InputTag
        • BindedInputNumber
        • DatePicker
        • DateTimePicker
        • ColorPicker
        • TimePicker
        • ClassesMapping
        • ClassesColorMapping
      • Controls
        • Button
        • Checkbox
        • RadioGroup
        • Switch
        • Slider
        • TrainValSplits
        • FileStorageUpload
        • Timeline
        • Pagination
      • Text Elements
        • Text
        • TextArea
        • Editor
        • Copy to Clipboard
        • Markdown
        • Tooltip
        • ElementTag
        • ElementTagsList
      • Media
        • Image
        • LabeledImage
        • GridGallery
        • Video
        • VideoPlayer
        • ImagePairSequence
        • Icons
        • ObjectClassView
        • ObjectClassesList
        • ImageSlider
        • Carousel
        • TagMetaView
        • TagMetasList
        • ImageAnnotationPreview
        • ClassesMappingPreview
        • ClassesListPreview
        • TagsListPreview
        • MembersListPreview
      • Selection
        • Select
        • SelectTeam
        • SelectWorkspace
        • SelectProject
        • SelectDataset
        • SelectItem
        • SelectTagMeta
        • SelectAppSession
        • SelectString
        • Transfer
        • DestinationProject
        • TeamFilesSelector
        • FileViewer
        • Dropdown
        • Cascader
        • ClassesListSelector
        • TagsListSelector
        • MembersListSelector
        • TreeSelect
        • SelectCudaDevice
      • Thumbnails
        • ProjectThumbnail
        • DatasetThumbnail
        • VideoThumbnail
        • FolderThumbnail
        • FileThumbnail
      • Status Elements
        • Progress
        • NotificationBox
        • DoneLabel
        • DialogMessage
        • TaskLogs
        • Badge
        • ModelInfo
        • Rate
        • CircleProgress
      • Layouts and Containers
        • Card
        • Container
        • Empty
        • Field
        • Flexbox
        • Grid
        • Menu
        • OneOf
        • Sidebar
        • Stepper
        • RadioTabs
        • Tabs
        • TabsDynamic
        • ReloadableArea
        • Collapse
        • Dialog
        • IFrame
      • Tables
        • Table
        • ClassicTable
        • RadioTable
        • ClassesTable
        • RandomSplitsTable
        • FastTable
      • Charts and Plots
        • LineChart
        • GridChart
        • HeatmapChart
        • ApexChart
        • ConfusionMatrix
        • LinePlot
        • GridPlot
        • ScatterChart
        • TreemapChart
        • PieChart
      • Compare Data
        • MatchDatasets
        • MatchTagMetas
        • MatchObjClasses
        • ClassBalance
        • CompareAnnotations
      • Widgets demos on github
  • 😎Advanced user guide
    • Objects binding
    • Automate with Python SDK & API
      • Start and stop app
      • User management
      • Labeling Jobs
  • 🖥️UI widgets
    • Element UI library
    • Supervisely UI widgets
    • Apexcharts - modern & interactive charts
    • Plotly graphing library
  • 📚API References
    • REST API Reference
    • Python SDK Reference
Powered by GitBook
On this page
  • Introduction
  • Function signature
  • Parameters
  • items
  • multiple_select
  • flat
  • always_open
  • widget_id
  • Methods and attributes
  • Mini app example
  • Import libraries
  • Init API client
  • Prepare the items
  • Initialize the TreeSelect widget
  • Dynamically add items
  • Show selected items in UI
  • Create an event handler for the TreeSelect widget
  • Create app layout
  • Create an app using the layout

Was this helpful?

Edit on GitHub
  1. App development
  2. Widgets
  3. Selection

TreeSelect

PreviousMembersListSelectorNextSelectCudaDevice

Last updated 10 months ago

Was this helpful?

Introduction

The TreeSelect widget in Supervisely is a user interface element that allows users to select items from a tree-like structure that can be useful when working with hierarchical data. The TreeSelect widget has event handlers that are triggered when items in the right lists are changed. This can be useful for applications that require dynamic change handling, such as showing data from the selected items.

Function signature

TreeSelect(
    items = None,
    multiple_select = False,
    flat = False,
    always_open = False,
    widget_id = None,
)
default

Parameters

Parameters
Type
Description

items

Optional[List[TreeSelect.Item]]

A list of TreeSelect.Item to be displayed in the widget.

multiple_select

bool

If True, multiple items can be selected. Default is False.

flat

bool

If True, selecting a parent item will not select its children. Default is False.

always_open

bool

If True, the tree will be opened when the widget is initialized.

widget_id

str

An optional ID for the widget.

items

Determine the list of TreeSelect.Item items, each of which must have a unique id and an optional label to be displayed in the widget. The children field is a list of TreeSelect.Item items that are children of the current item.

type: Optional[List[TreeSelect.Item]]

default value: None

Prepare the items:

items = [
    TreeSelect.Item(id="1", label="Item 1"),
    TreeSelect.Item(id="2", label="Item 2"),
    TreeSelect.Item(id="3", label="Item 3", children=[
        TreeSelect.Item(id="4", label="Item 3.1"),
        TreeSelect.Item(id="5", label="Item 3.2"),
    ]),
]

Initialize the widget with the items:

widget = TreeSelect(items=items)

multiple_select

If True, multiple items can be selected. Default is False.

type: bool

default value: False

Initialize the widget with multiple selection:

widget = TreeSelect(items=items, multiple_select=True)

flat

If True, selecting a parent item will not select its children. Default is False.

type: bool

default value: False

Initialize the widget with the flat option:

widget = TreeSelect(items=items, flat=True)

always_open

If True, the tree will be opened when the widget is initialized.

type: bool

default value: False

Initialize the widget with the always open option:

widget = TreeSelect(items=items, always_open=True)

widget_id

An optional ID for the widget.

type: str

default value: None

Initialize the widget with an ID:

widget = TreeSelect(items=items, widget_id="tree_select")

Methods and attributes

Methods and attributes
Description

set_items(items: List[TreeSelect.Item])

Set the items to be displayed in the widget (overrides current).

add_items(items: List[TreeSelect.Item])

Add items to the current list of items in the widget.

clear_items()

Clear all items from the widget.

get_selected()

Get the selected items in the widget.

set_selected(value: Union[List[TreeSelect.Item], TreeSelect.Item])

Set the selected items in the widget.

Mini app example

You can find this example in our GitHub repository:

Import libraries

import os

import supervisely as sly
from dotenv import load_dotenv
from typing import List
from supervisely.app.widgets import Card, TreeSelect, Container, Text, Button, Flexbox

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 the items

Prepare the items to be displayed in the TreeSelect widget:

domestic_animals = [
    TreeSelect.Item(
        id="cat",
        label="Cat",
        children=[
            TreeSelect.Item(id="siamese", label="Siamese"),
            TreeSelect.Item(id="persian", label="Persian"),
        ],
    ),
    TreeSelect.Item(
        id="dog",
        label="Dog",
        children=[
            TreeSelect.Item(id="bulldog", label="Bulldog"),
            TreeSelect.Item(id="beagle", label="Beagle"),
        ],
    ),
    TreeSelect.Item(id="cow", label="Cow"),
    TreeSelect.Item(id="sheep", label="Sheep"),
]

Initialize the TreeSelect widget

Let's initialize the TreeSelect widget without the items:

tree_select = TreeSelect(
    multiple_select=True,
    flat=True,
    always_open=False,
)

And then set the items:

tree_select.set_items(domestic_animals)

Dynamically add items

Let's prepare a new list of items, which will be added dynamically to the widget.

wild_animals = [
    TreeSelect.Item(
        id="mouse",
        label="Mouse",
        children=[
            TreeSelect.Item(id="field_mouse", label="Field mouse"),
            TreeSelect.Item(id="house_mouse", label="House mouse"),
        ],
    ),
    TreeSelect.Item(id="bird", label="Bird"),
]

And prepare a button, which will add the new items to the widget.

add_button = Button("Add wild animals")

We also need to set the handler for the button click event.

@add_button.click
def add_wild_animals():
    print("Adding wild animals")
    tree_select.add_items(wild_animals)

    add_button.disable()

Show selected items in UI

Now, let's create a button, which will show selected items in UI. And create a simple text widget to show the selected items.

show_selected_button = Button("Show selected")
selected_info = Text(status="info")
selected_info.hide()

Same as for the previous button, we need to set the handler for the click event.

@show_selected_button.click
def show_selected():
    print("Showing selected items")
    selected_items = tree_select.get_selected()
    if selected_items and isinstance(selected_items, list):
        labels = ", ".join([item.label for item in selected_items])
        text = "Selected items: {}".format(labels)

        selected_info.text = text
        selected_info.show()
    else:
        selected_info.hide()

Create an event handler for the TreeSelect widget

Now, let's create a event handler for the TreeSelect widget, when the value of the widget is changed.

value_changed_info = Text(status="info")
value_changed_info.hide()


@tree_select.value_changed
def new_items_selected(items: List[TreeSelect.Item]):
    print("Value changed")
    if items:
        # We're processing the event the same way as for the button click event.
        labels = ", ".join([item.label for item in items])
        text = "Value changed: {}".format(labels)

        # Setting the text to the widget and showing it.
        value_changed_info.text = text
        value_changed_info.show()
    else:
        value_changed_info.hide()

Create app layout

Prepare a layout for the app using Card widget with the content parameter and place widget that we've just created in the Container widget. Let's group our buttons in a Flexbox widget to make them look better.

buttons_flexbox = Flexbox(
    widgets=[add_button, show_selected_button],
)

card = Card(
    title="TreeSelect",
    content=Container(widgets=[buttons_flexbox, selected_info, value_changed_info, tree_select]),
)

layout = Container(widgets=[card])

Create an app using the layout

Create an app object with the layout parameter.

app = sly.Application(layout=layout)
multiple_select

mini_app
🔥
supervisely-ecosystem/ui-widgets-demos/selection/021_tree_select/src/main.py