Theme.interactor_style

property Theme.interactor_style: str

Return or set the default interactor style.

The value must be the name of a built-in or registered interactor style. Built-in styles use names that mirror the public enable_*_style methods, such as 'terrain_style'.

Returns:

str

The default interactor style name.

Examples

Download Python source code | Download Jupyter notebook

Set the default interactor style to terrain.

>>> import pyvista as pv
>>> pv.global_theme.interactor_style = 'terrain_style'

Register and use a custom interactor style.

>>> def custom_style(interactor): ...
>>> pv.register_interactor_style(
...     'custom_style', custom_style
... )
>>> pv.global_theme.interactor_style = 'custom_style'