matplotlib.rcsetup
#
The rcsetup module contains the validation code for customization using Matplotlib's rc settings.
Each rc setting is assigned a function used to validate any attempted changes to that setting. The 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.
The default values of the rc settings are set in the default matplotlibrc file.
Any additions or deletions to the parameter set listed here should also be
propagated to the lib/matplotlib/mpl-data/matplotlibrc
in Matplotlib's
root source directory.
- class matplotlib.rcsetup.ValidateInStrings(key, valid, ignorecase=False, *, _deprecated_since=None)[source]#
Bases:
object
valid is a list of legal strings.
- matplotlib.rcsetup.cycler(*args, **kwargs)[source]#
Create a
Cycler
object much likecycler.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:
- cyclerCycler
Copy constructor for Cycler.
- labelstr
The property key. Must be a valid
Artist
property. For example, 'color' or 'linestyle'. Aliases are allowed, such as 'c' for 'color' and 'lw' for 'linewidth'.- valuesiterable
Finite-length iterable of the property values. These values are validated and will raise a ValueError if invalid.
- Returns:
- Cycler
A new
Cycler
for the given properties.
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_cycler(s)[source]#
Return a Cycler object from a string repr or the object itself.
- matplotlib.rcsetup.validate_dpi(s)[source]#
Confirm s is string 'figure' or convert s to float or raise.
- 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)[source]#
Validate a hatch pattern. A hatch pattern string can have any sequence of the following characters:
\ / | - + * . x o O
.
- matplotlib.rcsetup.validate_markevery(s)[source]#
Validate the markevery property of a Line2D object.
- Parameters:
- sNone, int, (int, int), slice, float, (float, float), or list[int]
- Returns:
- None, int, (int, int), slice, float, (float, float), or list[int]