waveform_editor.gui.editor.WaveformEditor¶

class waveform_editor.gui.editor.WaveformEditor(config)¶

Bases: Viewer

A Panel interface for waveform editing.

__init__(config)¶

Methods

__init__(config)
handle_exceptions(waveform)
on_value_change(event)	Update the plot based on the YAML editor input.
save_waveform()	Store the waveform into the WaveformConfiguration.
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_waveform(waveform)	Start editing a waveform.
show([title, port, address, ...])	Starts a Bokeh server and displays the Viewable in a new tab.

Attributes

alert_type
error_message
has_changed
name
param
stored_string
waveform

on_value_change(event)¶

Update the plot based on the YAML editor input.

Parameters:

event¶

Event containing the code editor value input.

save_waveform()¶

Store the waveform into the WaveformConfiguration.

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_waveform(waveform: str | None) → None¶

Start editing a waveform.

Parameters:

waveform: str | None¶

Name of the waveform to edit. Can be set to None to disable the editor.

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)