trame.html.simput

These auto-generated docs only show this module’s objects, which rely on keyword arguments (**kwargs) for configuration. You can find more information in the modules section here.

class trame.html.simput.Simput(ui_manager, domains_manager=None, prefix=None, children=None, **kwargs)

Bases: trame.html.AbstractElement

Simput data management component. This must be set as the root of a layout to provide children with Simput data. See simput docs here for more info.

Parameters

• ui_manager – See simput docs here for more info

• domains_manager – See simput docs here for more info

• prefix (str | None) – Constructing a Simput component will set several variables, optionally prefixed by a namespace

• query (str) – String filtering

• children (str | list[trame.html.*] | trame.html.* | None) – The children nested within this element

>>> layout.root = simput.Simput(ui_manager, prefix="myForm")

property controller

Simput helper object

apply(**kwargs)

Flush modified properties so they can be pushed to their concrete objects

reset(**kwargs)

Unapply properties

push(id=None, type=None, domains=None, proxy=None, **kwargs)

Ask server to push data, ui, or constraints

update(change_set, **kwargs)

List of properties and value to update

>>> change_set = [
... {"id":"12", "name":"Radius", "value": 0.75},
... {"id": "12", "name":"Resolution", "value": 24}
... ]

refresh(id=0, property='', **kwargs)

property changeset

All unapplied changesets

property has_changes

Does the changeset have content?

property auto_update

Whether to automatically apply changes

class trame.html.simput.SimputItem(children=None, extract=[], **kwargs)

Bases: trame.html.AbstractElement

Simput data display component. This must be child of a Simput component to have access to Simput data. See simput docs here for more info.

Parameters

• itemId (str) – The simput id of the data to display

• extract (list[str]) – Columns to make available from this component to its children

• no_ui (bool) – Whether to show simput template UI

• children (str | list[trame.html.*] | trame.html.* | None) – The children nested within this element

Events

Parameters

dirty (function) – Function to call when itemId is changed