paraview

class trame.widgets.paraview.VtkAlgorithm(children=None, **kwargs): Bases: AbstractElement

class trame.widgets.paraview.VtkCellData(children=None, **kwargs): Bases: AbstractElement

class trame.widgets.paraview.VtkDataArray(**kwargs): Bases: AbstractElement

class trame.widgets.paraview.VtkFieldData(children=None, **kwargs): Bases: AbstractElement

class trame.widgets.paraview.VtkGeometryRepresentation(children=None, **kwargs): Bases: AbstractElement

class trame.widgets.paraview.VtkGlyphRepresentation(children=None, **kwargs): Bases: AbstractElement

class trame.widgets.paraview.VtkLocalView(view, ref=None, widgets=[], **kwargs)

Bases: AbstractElement

The VtkLocalView component relies on the server for defining the vtkRenderWindow but then only the geometry is exchanged with the client. The server does not need a GPU as no rendering is happening on the server. The vtkRenderWindow is only used to retrieve the scene data and parameters (coloring by, representations, …).

By relying on the same vtkRenderWindow, you can easily switch from a VtkRemoteView to a VtkLocalView or vice-versa. This component gives you controls on how you want to map mouse interaction with the camera. The default setting mimic default VTK interactor style so you will rarely have to override to the interactor_settings. The widgets argument allow to properly capture behavior for those assuming they can be handled by the client side.

>>> local_view = vtk.VtkLocalView(
...     view=...,  # Instance of the view (required)
...     widgets=[],  # List of vtkWidgets in view
...     # - VTK: vtkRenderWindow
...     # - Paraview: viewProxy
...     ref=...,  # Identifier for this component
...     context_name=...,  # Namespace for geometry cache
...     interactor_settings=...,  # Options for camera controls. See below.
...     interactor_events=(  # Enable vtk.js interactor events for method binding
...         "events",
...         ["EndAnimation"],
...     ),
...     EndAnimation=end,  # Bind method to the enabled event
...     box_selection=True,  # toggle selection box rendering
...     box_selection_change=fn,  # Bind method to get rect selection
... )

update(widgets=None, orientation_axis=0, **kwargs): Force geometry to be pushed

export(widgets=None, orientation_axis=0, format='zip', **kwargs)

Export standalone scene for OfflineViewer

Parameters:: format – Can be either be “zip” or “json”.

reset_camera(**kwargs): Move camera to center actors within the frame

class trame.widgets.paraview.VtkMesh(name, dataset=None, field_to_keep=None, point_arrays=None, cell_arrays=None, **kwargs)

Bases: AbstractElement

set_dataset(dataset): Change this mesh’s internal dataset and update shared state

update(**kwargs): Propagate changes in internal data to shared state

class trame.widgets.paraview.VtkPointData(children=None, **kwargs): Bases: AbstractElement

class trame.widgets.paraview.VtkPolyData(name, children=None, dataset=None, **kwargs)

Bases: AbstractElement

set_dataset(dataset): Change this polydata’s internal dataset and update shared state

update(): Propagate changes in internal data to shared state

class trame.widgets.paraview.VtkReader(**kwargs): Bases: AbstractElement

class trame.widgets.paraview.VtkRemoteLocalView(view, enable_rendering=True, widgets=[], **kwargs)

Bases: AbstractElement

The VtkRemoteLocalView component is a blend of VtkLocalView and VtkRemoteView where the user can choose dynamically which mode they want to be in. When instantiating a VtkRemoteLocalView several variables and triggers will be created for you to more easily control your view.

>>> rl_view = vtk.VtkRemoteLocalView(
...     # Instance of the view (required) [VTK: vtkRenderWindow | Paraview: viewProxy]
...     view=...,
...     # Just VtkRemoteLocalView params
...     namespace=...,  # Prefix for variables and triggers. See below. (required)
...     mode="local",  # Decide between local or remote. See below.
...     disable_auto_switch=True  # Skip automatic remote rendering switch while local rendering is pending
...     # VtkRemoteView params
...     ** remote_view_params,
...     # VtkLocalView params
...     **local_view_params,
... )

update_geometry(reset_camera=False, widgets=None, orientation_axis=0, **kwargs): Force update to geometry

export_geometry(widgets=None, orientation_axis=0, format='zip', **kwargs)

Export standalone scene for OfflineViewer

Parameters:: format – Can be either be “zip” or “json”.

update_image(reset_camera=False): Force update to image

property view: Get linked vtkRenderWindow instance

class trame.widgets.paraview.VtkRemoteView(view, ref=None, **kwargs)

Bases: AbstractElement

The VtkRemoteView component relies on the server for rendering by sending images to the client by binding your vtkRenderWindow to it. This component gives you control over the image size and quality to reduce latency while interacting.

>>> remote_view = vtk.vtkRemoteView(
...     # Instance of the view (required) [VTK: vtkRenderWindow | Paraview: viewProxy]
...     view=...,
...     ref=...,  # Identifier for this component
...     interactive_quality=60,  # [0, 100] 0 for fastest render, 100 for best quality
...     interactive_ratio=...,  # [0.1, 1] Image size scale factor while interacting
...     interactor_events=(  # Enable vtk.js interactor events for method binding
...         "events",
...         ["EndAnimation"],
...     ),
...     EndAnimation=end,  # Bind method to the enabled event
...     box_selection=True,  # toggle selection box rendering
...     box_selection_change=fn,  # Bind method to get rect selection
... )

update(**kwargs): Force image to be pushed to client

class trame.widgets.paraview.VtkShareDataset(children=None, **kwargs): Bases: AbstractElement

class trame.widgets.paraview.VtkView(children=None, ref=None, **kwargs)

Bases: AbstractElement

reset_camera(**kwargs): Move camera to center actors within the frame

set_camera(camera): Update camera (position, focalPoint, viewUp)