register_jupyter_backend

register_jupyter_backend(name: str, handler: Callable[..., object]) → None

Register a custom Jupyter backend handler.

Added in version 0.48.0.

Parameters:

namestr

Name of the backend (e.g. 'custom'). Must not collide with a built-in backend name.

handlercallable()

A callable with signature handler(plotter, **kwargs) that returns an IPython-displayable object.

Raises:

ValueError

If name collides with a built-in backend.

Examples

>>> import pyvista as pv
>>> def my_handler(plotter, **kwargs): ...
>>> pv.register_jupyter_backend('my_backend', my_handler)