Cycle¶
-
Cycle
(*args, N=None, samples=None, name=None, marker=None, alpha=None, dashes=None, linestyle=None, linewidth=None, markersize=None, markeredgewidth=None, markeredgecolor=None, markerfacecolor=None, **kwargs)[source]¶ Generate and merge
Cycler
instances in a variety of ways. Used to interpret thecycle
andcycle_kw
arguments when passed to any plotting method wrapped bycycle_changer
.If you just want a list of colors instead of a
Cycler
instance, use theColors
function. If you want aCycler
instance that imposes black as the default color and cycles through properties likelinestyle
instead, call this function without any positional arguments.- Parameters
*args (colormap-spec or cycle-spec, optional) – Positional arguments control the colors in the
Cycler
object. If more than one argument is passed, the resulting cycles are merged. Arguments are interpreted as follows:If a
Cycler
, nothing more is done.If a list of RGB tuples or color strings, these colors are used.
If a
ListedColormap
, colors from thecolors
attribute are used.If a string cycle name, that
ListedColormap
is looked up and itscolors
attribute is used.In all other cases, the argument is passed to
Colormap
, and colors from the resultingLinearSegmentedColormap
are used. See thesamples
argument.
If the last positional argument is numeric, it is used for the
samples
keyword argument.N, samples (float or list of float, optional) – For
ListedColormap
s, this is the number of colors to select. For example,Cycle('538', 4)
returns the first 4 colors of the'538'
color cycle.For
LinearSegmentedColormap
s, this is the a list of sample coordinates used to draw colors from the map, or an integer number of colors to draw. If the latter, the sample coordinates arenp.linspace(0, 1, samples)
. For example,Cycle('Reds', 5)
divides the'Reds'
colormap into five evenly spaced colors.marker, alpha, dashes, linestyle, linewidth, markersize, markeredgewidth, markeredgecolor, markerfacecolor (list of specs, optional) – Lists of
Line2D
properties that can be added to theCycler
instance. If the lists have unequal length, they will be filled to match the length of the longest list. Seeset_prop_cycle
for more info on cyclers. Also see the line style reference, the marker reference, and the custom dashes reference.
- Other Parameters
**kwargs – If the input is not already a
Cycler
instance, these are passed toColormap
and used to build theListedColormap
from which the cycler will draw its colors.- Returns
Cycler
– A cycler instance that can be passed toset_prop_cycle
.