registered_plotter_components

registered_plotter_components() → tuple[ComponentRegistration, ...]

Return every plotter component currently registered.

Forces discovery of any pending entry-point plugins so the returned list reflects every plugin visible to PyVista, not just the ones that have been touched already via attribute access. A plugin that fails to import emits a UserWarning and is skipped; the rest still appear in the result.

Added in version 0.48.0.

Returns:

tuple[ComponentRegistration, …]

Ordered by registration time. Each record exposes name, target, component, and source.

Examples

Download Python source code | Download Jupyter notebook

>>> import pyvista as pv
>>> @pv.register_plotter_component('demo_listed')
... class DemoListedComponent:
...     def __init__(self, plotter):
...         self._plotter = plotter
>>> [
...     r.name
...     for r in pv.registered_plotter_components()
...     if r.name == 'demo_listed'
... ]
['demo_listed']
>>> pv.unregister_plotter_component('demo_listed')