Skip to content

data_node_selector class

Displays a list of the Data Node entities that can be selected.

Methods

__init__()

__init__(
    value=None,
    display_cycles=True,
    show_primary_flag=True,
    on_change=None,
    height="50vh",
    show_pins=True,
    scenario=None,
    datanodes=None,
    multiple=False,
    filter="*",
    show_search=True,
    sort="*",
    id=None,
    class_name=None,
) -> None

Create a new data_node_selector element.

Parameters:

Name Type Description Default
value DataNode|list[DataNode]
dynamic

Bound to the selected s, or None if there is none.

None
display_cycles bool

If False, the cycles are not shown in the selector.

True
show_primary_flag bool

If False, the primary scenarios are not identified with specific visual hint.

True
on_change Union[str, Callable]

A function or the name of a function that is triggered when a data node is selected.
The parameters of that function are all optional:

  • state (State): the state instance.
  • var_name (str): the variable name.
  • value (DataNode): the selected data node.
None
height str

The maximum height, in CSS units, of the control.

50vh
show_pins bool

If True, a pin is shown on each item of the selector and allows to restrict the number of displayed items.

True
scenario Scenario|list[Scenario]
dynamic
None
datanodes list[DataNode|Scenario|Cycle]
dynamic
None
multiple bool
False
filter bool | str | DataNodeFilter | list[str | DataNodeFilter]
*
show_search bool
True
sort bool | str | DataNodeFilter | list[str | DataNodeFilter]
*
id str

The identifier that will be assigned to the rendered HTML component.

None
class_name str
dynamic

The list of CSS class names associated with the generated HTML Element.
These class names will be added to the default taipy_gui_core-<element_type>.

None