register_jupyter_backend

register_jupyter_backend(

name: str,

handler: Callable[[...], object],

*,

override: bool = False,

) → 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 unless override=True is passed.

handlercallable()

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

overridebool, default: False

If True, allow registering a name that collides with a built-in backend. Also silences the warning emitted when replacing an existing custom registration.

Raises:

ValueError

If name collides with a built-in backend and override is False.

Warns:

UserWarning

If name already refers to a registered custom backend. The new registration replaces the old one (last wins); pass override=True to silence the warning.

Examples

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