class_docstr: Organize Renderers for ``pyvista.Plotter``.
  
  Parameters
  ----------
  plotter : str
      The PyVista plotter.
  
  shape : tuple[int], optional
      The initial shape of the PyVista plotter, (rows, columns).
  
  splitting_position : float, optional
      The position to place the splitting line between plots.
  
  row_weights : sequence, optional
      The weights of the rows when the plot window is resized.
  
  col_weights : sequence, optional
      The weights of the columns when the plot window is resized.
  
  groups : list, optional
      A list of sequences that defines the grouping of the sub-datasets.
  
  border : bool, optional
      Whether or not a border should be added around each subplot.
  
  border_color : str, optional
      The color of the border around each subplot.
  
  border_width : float, optional
      The width of the border around each subplot.
class_docstr_tok: ["Organize","Renderers","for","``","pyvista.Plotter","``",".","Parameters","--","--","--","--","--","plotter",":","str","The","PyVista","plotter",".","shape",":","tuple","[","int","]",",","optional","The","initial","shape","of","the","PyVista","plotter",",","(","rows",",","columns",")",".","splitting_position",":","float",",","optional","The","position","to","place","the","splitting","line","between","plots",".","row_weights",":","sequence",",","optional","The","weights","of","the","rows","when","the","plot","window","is","resized",".","col_weights",":","sequence",",","optional","The","weights","of","the","columns","when","the","plot","window","is","resized",".","groups",":","list",",","optional","A","list","of","sequences","that","defines","the","grouping","of","the","sub-datasets",".","border",":","bool",",","optional","Whether","or","not","a","border","should","be","added","around","each","subplot",".","border_color",":","str",",","optional","The","color","of","the","border","around","each","subplot",".","border_width",":","float",",","optional","The","width","of","the","border","around","each","subplot","."]
docstr: Set the background color.
  
  Parameters
  ----------
  color : ColorLike, 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'``
  
  top : ColorLike, 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.
  
  right : ColorLike, optional
      If given, this will enable a gradient background where the
      ``color`` argument is at the left and the color given in ``right``
      will be the color at the right of the renderer.
  
  side : ColorLike, optional
      If given, this will enable a gradient background where the
      ``color`` argument is at the center and the color given in ``side``
      will be the color at the side of the renderer.
  
  corner : ColorLike, optional
      If given, this will enable a gradient background where the
      ``color`` argument is at the center and the color given in ``corner``
      will be the color at the corner of the renderer.
  
  all_renderers : bool, default: True
      If ``True``, applies to all renderers in subplots. If ``False``,
      then only applies to the active renderer.
  
  Examples
  --------
  Set the background color to black.
  
  >>> import pyvista as pv
  >>> plotter = pv.Plotter()
  >>> plotter.set_background('black')
  >>> plotter.background_color
  Color(name='black', hex='#000000ff', opacity=255)
  >>> plotter.close()
  
  Set the background color at the bottom to black and white at
  the top.  Display a cone as well.
  
  >>> import pyvista as pv
  >>> pl = pv.Plotter()
  >>> actor = pl.add_mesh(pv.Cone())
  >>> pl.set_background('black', top='white')
  >>> pl.show()
docstr_tok: ["Set","the","background","color",".","Parameters","--","--","--","--","--","color",":","ColorLike",",","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","'","``","top",":","ColorLike",",","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",".","right",":","ColorLike",",","optional","If","given",",","this","will","enable","a","gradient","background","where","the","``","color","``","argument","is","at","the","left","and","the","color","given","in","``","right","``","will","be","the","color","at","the","right","of","the","renderer",".","side",":","ColorLike",",","optional","If","given",",","this","will","enable","a","gradient","background","where","the","``","color","``","argument","is","at","the","center","and","the","color","given","in","``","side","``","will","be","the","color","at","the","side","of","the","renderer",".","corner",":","ColorLike",",","optional","If","given",",","this","will","enable","a","gradient","background","where","the","``","color","``","argument","is","at","the","center","and","the","color","given","in","``","corner","``","will","be","the","color","at","the","corner","of","the","renderer",".","all_renderers",":","bool",",","default",":","True","If","``","True","``",",","applies","to","all","renderers","in","subplots",".","If","``","False","``",",","then","only","applies","to","the","active","renderer",".","Examples","--","--","--","--","Set","the","background","color","to","black",".",">",">",">","import","pyvista","as","pv",">",">",">","plotter","=","pv.Plotter","(",")",">",">",">","plotter.set_background","(","'black","'",")",">",">",">","plotter.background_color","Color","(","name='black","'",",","hex=","'","#","000000ff","'",",","opacity=255",")",">",">",">","plotter.close","(",")","Set","the","background","color","at","the","bottom","to","black","and","white","at","the","top",".","Display","a","cone","as","well",".",">",">",">","import","pyvista","as","pv",">",">",">","pl","=","pv.Plotter","(",")",">",">",">","actor","=","pl.add_mesh","(","pv.Cone","(",")",")",">",">",">","pl.set_background","(","'black","'",",","top='white","'",")",">",">",">","pl.show","(",")"]
code: def set_background(
      self,
      color,
      top=None,
      right=None,
      side=None,
      corner=None,
      all_renderers=True,
  ):
      """Set the background color.
  
      Parameters
      ----------
      color : ColorLike, 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'``
  
      top : ColorLike, 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.
  
      right : ColorLike, optional
          If given, this will enable a gradient background where the
          ``color`` argument is at the left and the color given in ``right``
          will be the color at the right of the renderer.
  
      side : ColorLike, optional
          If given, this will enable a gradient background where the
          ``color`` argument is at the center and the color given in ``side``
          will be the color at the side of the renderer.
  
      corner : ColorLike, optional
          If given, this will enable a gradient background where the
          ``color`` argument is at the center and the color given in ``corner``
          will be the color at the corner of the renderer.
  
      all_renderers : bool, default: True
          If ``True``, applies to all renderers in subplots. If ``False``,
          then only applies to the active renderer.
  
      Examples
      --------
      Set the background color to black.
  
      >>> import pyvista as pv
      >>> plotter = pv.Plotter()
      >>> plotter.set_background('black')
      >>> plotter.background_color
      Color(name='black', hex='#000000ff', opacity=255)
      >>> plotter.close()
  
      Set the background color at the bottom to black and white at
      the top.  Display a cone as well.
  
      >>> import pyvista as pv
      >>> pl = pv.Plotter()
      >>> actor = pl.add_mesh(pv.Cone())
      >>> pl.set_background('black', top='white')
      >>> pl.show()
  
      """
      if all_renderers:
          for renderer in self:
              renderer.set_background(
                  color, top=top, right=right, side=side, corner=corner
              )
          self._shadow_renderer.set_background(color)
      else:
          self.active_renderer.set_background(
              color, top=top, right=right, side=side, corner=corner
          )
  
imports: import collections
  from itertools import product
  from weakref import proxy
  import numpy
  import pyvista
  from .background_renderer import BackgroundRenderer
  from .renderer import Renderer
label_desc: Use image node_id 23 for calling the Renderers obj's underlying member method code with example usage: obj.set_background(color, top, right, side, corner, all_renderers) without return types