shyft.dashboard.widgets.selector_models

Classes

LabelDataSelector(presenter[, logger, ...])
LabelDataSelectorClickPolicy(value[, names, ...])

class shyft.dashboard.widgets.selector_models.LabelDataSelectorClickPolicy(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

SEND_SELECTED = 1

REMOVE_SELECTED_AND_SEND_REST = 2

class shyft.dashboard.widgets.selector_models.LabelDataSelector(presenter: SelectorPresenter, logger=None, on_click_policy: LabelDataSelectorClickPolicy = LabelDataSelectorClickPolicy.SEND_SELECTED, sort: bool = True)

Bases: SelectorModelBase

__init__(presenter: SelectorPresenter, logger=None, on_click_policy: LabelDataSelectorClickPolicy = LabelDataSelectorClickPolicy.SEND_SELECTED, sort: bool = True) → None

Simple label selector model showing a label data in the selector view. Label data is a list of str.

The Selector provides 2 on_click_policies:

• SEND_SELECTED: (default) send the selection via send_selected_labels port

• REMOVE_SELECTED_AND_SEND_REST: remove the selected values and send the remaining via send_labels port

Ports

send_selected_labels:

(Sender) send selected labels

send_labels:

(Sender) send all available labels

receive_labels:

(Receiver)receive a new list of labels to set

receive_labels_to_add:

(Receiver) receive additional labels to show in the view. This will trigger send_labels

Parameters:

• presenter – SelectorPresenter instance

• logger – Optional logger

• on_click_policy – on click selected policy

• sort – sort labels or not

on_change_selected(selected_values: List[str]) → None