registered_themes

registered_themes#

registered_themes() → tuple[ThemeRegistration, ...][source]#

Return all registered themes.

Use this to discover which names can be passed to set_plot_theme() or the PYVISTA_PLOT_THEME environment variable. Entry-point plugins are loaded on the first call so they appear in the result.

Returns:
tuple[pyvista.ThemeRegistration, …]

One record per registered theme, sorted by name. Each record exposes name, kind, and source.

Examples

List available theme names.

>>> import pyvista as pv
>>> for record in pv.registered_themes():
...     print(record.name)
dark
default
document
document_build
document_pro
paraview
testing
vtk

Inspect how a name became registered.

>>> next(r for r in pv.registered_themes() if r.name == 'dark').kind
'subclass'
Contents