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 or reset the color cycler.
  
  This color cycler is iterated over by each sequential :class:`add_mesh() <pyvista.Plotter.add_mesh>`
  call to set the default color of the dataset being plotted.
  
  When setting, the value must be either a list of color-like objects,
  or a cycler of color-like objects. If the value passed is a single
  string, it must be one of:
  
      * ``'default'`` - Use the default color cycler (matches matplotlib's default)
      * ``'matplotlib`` - Dynamically get matplotlib's current theme's color cycler.
      * ``'all'`` - Cycle through all of the available colors in ``pyvista.plotting.colors.hexcolors``
  
  Setting to ``None`` will disable the use of the color cycler on this
  renderer.
  
  Parameters
  ----------
  color_cycler : str | cycler.Cycler | sequence[ColorLike]
      The colors to cycle through.
  
  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 default color cycler to iterate through red, green, and blue.
  
  >>> import pyvista as pv
  >>> pl = pv.Plotter()
  >>> pl.set_color_cycler(['red', 'green', 'blue'])
  >>> _ = pl.add_mesh(pv.Cone(center=(0, 0, 0)))  # red
  >>> _ = pl.add_mesh(pv.Cube(center=(1, 0, 0)))  # green
  >>> _ = pl.add_mesh(pv.Sphere(center=(1, 1, 0)))  # blue
  >>> _ = pl.add_mesh(pv.Cylinder(center=(0, 1, 0)))  # red again
  >>> pl.show()
docstr_tok: ["Set","or","reset","the","color","cycler",".","This","color","cycler","is","iterated","over","by","each","sequential",":","class",":","`","add_mesh","(",")","<","pyvista.Plotter.add_mesh",">","`","call","to","set","the","default","color","of","the","dataset","being","plotted",".","When","setting",",","the","value","must","be","either","a","list","of","color-like","objects",",","or","a","cycler","of","color-like","objects",".","If","the","value","passed","is","a","single","string",",","it","must","be","one","of",":","*","``","'default","'","``","-","Use","the","default","color","cycler","(","matches","matplotlib","'s","default",")","*","``","'matplotlib","``","-","Dynamically","get","matplotlib","'s","current","theme","'s","color","cycler",".","*","``","'all","'","``","-","Cycle","through","all","of","the","available","colors","in","``","pyvista.plotting.colors.hexcolors","``","Setting","to","``","None","``","will","disable","the","use","of","the","color","cycler","on","this","renderer",".","Parameters","--","--","--","--","--","color_cycler",":","str","|","cycler.Cycler","|","sequence","[","ColorLike","]","The","colors","to","cycle","through",".","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","default","color","cycler","to","iterate","through","red",",","green",",","and","blue",".",">",">",">","import","pyvista","as","pv",">",">",">","pl","=","pv.Plotter","(",")",">",">",">","pl.set_color_cycler","(","[","'red","'",",","'green","'",",","'blue","'","]",")",">",">",">","_","=","pl.add_mesh","(","pv.Cone","(","center=","(","0",",","0",",","0",")",")",")","#","red",">",">",">","_","=","pl.add_mesh","(","pv.Cube","(","center=","(","1",",","0",",","0",")",")",")","#","green",">",">",">","_","=","pl.add_mesh","(","pv.Sphere","(","center=","(","1",",","1",",","0",")",")",")","#","blue",">",">",">","_","=","pl.add_mesh","(","pv.Cylinder","(","center=","(","0",",","1",",","0",")",")",")","#","red","again",">",">",">","pl.show","(",")"]
code: def set_color_cycler(self, color_cycler, all_renderers=True):
      """Set or reset the color cycler.
  
      This color cycler is iterated over by each sequential :class:`add_mesh() <pyvista.Plotter.add_mesh>`
      call to set the default color of the dataset being plotted.
  
      When setting, the value must be either a list of color-like objects,
      or a cycler of color-like objects. If the value passed is a single
      string, it must be one of:
  
          * ``'default'`` - Use the default color cycler (matches matplotlib's default)
          * ``'matplotlib`` - Dynamically get matplotlib's current theme's color cycler.
          * ``'all'`` - Cycle through all of the available colors in ``pyvista.plotting.colors.hexcolors``
  
      Setting to ``None`` will disable the use of the color cycler on this
      renderer.
  
      Parameters
      ----------
      color_cycler : str | cycler.Cycler | sequence[ColorLike]
          The colors to cycle through.
  
      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 default color cycler to iterate through red, green, and blue.
  
      >>> import pyvista as pv
      >>> pl = pv.Plotter()
      >>> pl.set_color_cycler(['red', 'green', 'blue'])
      >>> _ = pl.add_mesh(pv.Cone(center=(0, 0, 0)))  # red
      >>> _ = pl.add_mesh(pv.Cube(center=(1, 0, 0)))  # green
      >>> _ = pl.add_mesh(pv.Sphere(center=(1, 1, 0)))  # blue
      >>> _ = pl.add_mesh(pv.Cylinder(center=(0, 1, 0)))  # red again
      >>> pl.show()
  
      """
      if all_renderers:
          for renderer in self:
              renderer.set_color_cycler(color_cycler)
      else:
          self.active_renderer.set_color_cycler(color_cycler)
  
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 24 for calling the Renderers obj's underlying member method code with example usage: obj.set_color_cycler(color_cycler, all_renderers) without return types