waveform_editor.gui.selector.selection_group.SelectionGroup¶

class waveform_editor.gui.selector.selection_group.SelectionGroup(selector: WaveformSelector, group: WaveformConfiguration | WaveformGroup, path: list[str])¶

Bases: Viewer

User Interface for selecting waveforms in a single waveform group

__init__(selector: WaveformSelector, group: WaveformConfiguration | WaveformGroup, path: list[str])¶

Methods

__init__(selector, group, path)
add_group(group)	Add a sub-group to this UI element.
deselect_all([event])	Deselect all waveforms.
get_selection([recursive])	Get a list of the selected waveforms.
remove_group(group)	Remove a group from this UI element
select_all([event])	Select all waveforms.
servable([title, location, area, target])	Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.
set_selection(selection)	Select a list of waveforms.
show([title, port, address, ...])	Starts a Bokeh server and displays the Viewable in a new tab.
sync_waveforms([event])	Update waveform selector options and selected values

Attributes

name
param
visible

add_group(group: WaveformGroup) → None¶

Add a sub-group to this UI element.

deselect_all(event=None) → None¶

Deselect all waveforms.

get_selection(recursive=False) → list[str]¶

Get a list of the selected waveforms.

Parameters:

recursive=False¶

Include selection in sub-groups as well.

remove_group(group: str) → None¶

Remove a group from this UI element

select_all(event=None) → None¶

Select all waveforms.

servable(title: str | None = None, location: bool | Location = True, area: str = 'main', target: str | None = None) → Viewable¶

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters¶

titlestr

A string title to give the Document (if served as an app)

locationboolean or panel.io.location.Location

Whether to create a Location component to observe and set the URL location.

area: str (deprecated)

The area of a template to add the component too. Only has an effect if pn.config.template has been set.

target: str

Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns¶

The Panel object itself

set_selection(selection: list[str]) → None¶

Select a list of waveforms.

Parameters:

selection: list[str]¶

List of waveform names to select.

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | Location = True, **kwargs) → threading.Thread | Server¶

Starts a Bokeh server and displays the Viewable in a new tab.

Parameters¶

titlestr | None

A string title to give the Document (if served as an app)

port: int (optional, default=0)

Allows specifying a specific port

addressstr

The address the server should listen on for HTTP requests.

websocket_origin: str or list(str) (optional)

A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, "localhost" is used.

threaded: boolean (optional, default=False)

Whether to launch the Server on a separate thread, allowing interactive use.

verbose: boolean (optional, default=True)

Whether to print the address and port

openboolean (optional, default=True)

Whether to open the server in a new browser tab

locationboolean or panel.io.location.Location

Whether to create a Location component to observe and set the URL location.

Returns¶

server: bokeh.server.Server or panel.io.server.StoppableThread

Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

sync_waveforms(event=None)¶

Update waveform selector options and selected values