matplotlib.rcsetup
¶The rcsetup module contains the default values and the validation code for customization using matplotlib's rc settings.
Each rc setting is assigned a default value and a function used to validate any attempted changes to that setting. The default values and validation functions are defined in the rcsetup module, and are used to construct the rcParams global object which stores the settings and is referenced throughout matplotlib.
These default values should be consistent with the default matplotlibrc file
that actually reflects the values given here. Any additions or deletions to the
parameter set listed here should also be visited to the
matplotlibrc.template
in matplotlib's root source directory.
matplotlib.rcsetup.
ValidateInStrings
(key, valid, ignorecase=False)[source]¶Bases: object
valid is a list of legal strings
matplotlib.rcsetup.
ValidateInterval
(vmin, vmax, closedmin=True, closedmax=True)[source]¶Bases: object
Value must be in interval
matplotlib.rcsetup.
cycler
(*args, **kwargs)[source]¶Creates a Cycler
object much like cycler.cycler()
,
but includes input validation.
Call signatures:
cycler(cycler)
cycler(label=values[, label2=values2[, ...]])
cycler(label, values)
Form 1 copies a given Cycler
object.
Form 2 creates a Cycler
which cycles over one or more
properties simultaneously. If multiple properties are given, their
value lists must have the same length.
Form 3 creates a Cycler
for a single property. This form
exists for compatibility with the original cycler. Its use is
discouraged in favor of the kwarg form, i.e. cycler(label=values)
.
Parameters: |
|
---|---|
Returns: |
|
Examples
Creating a cycler for a single property:
>>> c = cycler(color=['red', 'green', 'blue'])
Creating a cycler for simultaneously cycling over multiple properties (e.g. red circle, green plus, blue cross):
>>> c = cycler(color=['red', 'green', 'blue'],
... marker=['o', '+', 'x'])
matplotlib.rcsetup.
validate_anylist
(s)¶matplotlib.rcsetup.
validate_capstylelist
(s)¶matplotlib.rcsetup.
validate_colorlist
(s)¶return a list of colorspecs
matplotlib.rcsetup.
validate_cycler
(s)[source]¶Return a Cycler object from a string repr or the object itself.
matplotlib.rcsetup.
validate_dashlist
(s)¶matplotlib.rcsetup.
validate_dpi
(s)[source]¶Confirm s is string 'figure' or convert s to float or raise.
matplotlib.rcsetup.
validate_fillstylelist
(s)¶matplotlib.rcsetup.
validate_floatlist
(s)¶Convert s to float or raise.
matplotlib.rcsetup.
validate_fontsizelist
(s)¶matplotlib.rcsetup.
validate_fonttype
(s)[source]¶Confirm that this is a Postscript or PDF font type that we know how to convert to.
matplotlib.rcsetup.
validate_hatch
(s)[source]¶Validate a hatch pattern.
A hatch pattern string can have any sequence of the following
characters: \ / | - + * . x o O
.
matplotlib.rcsetup.
validate_hatchlist
(s)¶Validate a hatch pattern.
A hatch pattern string can have any sequence of the following
characters: \ / | - + * . x o O
.
matplotlib.rcsetup.
validate_int_or_None
(s)[source]¶Return None if s is None or return int(s)
, otherwise raise.
matplotlib.rcsetup.
validate_joinstylelist
(s)¶matplotlib.rcsetup.
validate_markevery
(s)[source]¶Validate the markevery property of a Line2D object.
Parameters: |
|
---|---|
Returns: |
|
matplotlib.rcsetup.
validate_markeverylist
(s)¶Validate the markevery property of a Line2D object.
Parameters: |
|
---|---|
Returns: |
|
matplotlib.rcsetup.
validate_stringlist
(s)¶return a list