DOM node to connect.
Formats the payload of an action.
Original payload.
Modified payload.
Called on click events. When a button is wired, this function is overwritten with the actual function that is triggered on click events.
a random id for the process that could be started
Determine the name of the action that should be associated with the node.
The action name is determined from
the tag's data-action, name or id attribute (in that order).
A HTML element.
Name of action or null.
Determine the name of the signal that should be listened to from the backend.
The signal name is determined from the data-signal,
data-action, name or id attribute (in that order.)
For all attributes apart from data-signal, the value is wrapped in an
object like { data: value-of-attribute }. The data-signal value
can contain a : which will be used to create an object as well. That means
that data-signal="data:myvalue" gives the same result as data-action="myvalue".
A HTML element.
Name of a signal or null.
Determine whether to skip this element.
This can be forced by adding a data-skipwire=true attribute
to the HTML tag.
A HTML element.
Wire all buttons.
Generated using TypeDoc
A button, and usually wired to any
<button>with an action name.This button also binds to process IDs of the backend. That means that the button is disabled (using the CSS class
disabled) while the backend is processing the action that got started when it was clicked. A simple example is below.In
index.html:<button data-action="run">Run</button>In
analysis.py:@ databench.on def run(self): """Run when button is pressed.""" passIn this form, Databench finds the button automatically and connects it to the backend. No additional JavaScript code is required.