Plotter.set_background(color, top=None, all_renderers=True)#

Set the background color.

colorcolor_like, optional

Either a string, rgb list, or hex color string. Defaults to current theme parameters. For example:

  • color='white'

  • color='w'

  • color=[1.0, 1.0, 1.0]

  • color='#FFFFFF'

topcolor_like, optional

If given, this will enable a gradient background where the color argument is at the bottom and the color given in top will be the color at the top of the renderer.


If True, applies to all renderers in subplots. If False, then only applies to the active renderer.


Set the background color to black.

>>> import pyvista
>>> plotter = pyvista.Plotter()
>>> plotter.set_background('black')
>>> plotter.background_color
Color(name='black', hex='#000000ff')

Set the background color at the bottom to black and white at the top. Display a cone as well.

>>> import pyvista
>>> pl = pyvista.Plotter()
>>> actor = pl.add_mesh(pyvista.Cone())
>>> pl.set_background('black', top='white')