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)¶Bases: object
valid is a list of legal strings
matplotlib.rcsetup.
ValidateInterval
(vmin, vmax, closedmin=True, closedmax=True)¶Bases: object
Value must be in interval
matplotlib.rcsetup.
cycler
(*args, **kwargs)¶Creates a cycler.Cycler
object much like cycler.cycler()
,
but includes input validation.
cycler(arg) cycler(label, itr) cycler(label1=itr1[, label2=itr2[, …]])
Form 1 simply copies a given Cycler
object.
Form 2 creates a Cycler
from a label and an iterable.
Form 3 composes a Cycler
as an inner product of the
pairs of keyword arguments. In other words, all of the
iterables are cycled simultaneously, as if through zip().
Parameters: | arg : Cycler
label : name
itr : iterable
|
---|---|
Returns: | cycler : Cycler
|
matplotlib.rcsetup.
deprecate_axes_colorcycle
(value)¶matplotlib.rcsetup.
deprecate_axes_hold
(value)¶matplotlib.rcsetup.
deprecate_svg_embed_char_paths
(value)¶matplotlib.rcsetup.
deprecate_svg_image_noscale
(value)¶matplotlib.rcsetup.
update_savefig_format
(value)¶matplotlib.rcsetup.
validate_animation_writer_path
(p)¶matplotlib.rcsetup.
validate_any
(s)¶matplotlib.rcsetup.
validate_anylist
(s)¶matplotlib.rcsetup.
validate_aspect
(s)¶matplotlib.rcsetup.
validate_axisbelow
(s)¶matplotlib.rcsetup.
validate_backend
(s)¶matplotlib.rcsetup.
validate_bbox
(s)¶matplotlib.rcsetup.
validate_bool
(b)¶Convert b to a boolean or raise
matplotlib.rcsetup.
validate_bool_maybe_none
(b)¶Convert b to a boolean or raise
matplotlib.rcsetup.
validate_capstylelist
(s)¶matplotlib.rcsetup.
validate_color
(s)¶return a valid color arg
matplotlib.rcsetup.
validate_color_for_prop_cycle
(s)¶matplotlib.rcsetup.
validate_color_or_auto
(s)¶matplotlib.rcsetup.
validate_color_or_inherit
(s)¶return a valid color arg
matplotlib.rcsetup.
validate_colorlist
(s)¶return a list of colorspecs
matplotlib.rcsetup.
validate_corner_mask
(s)¶matplotlib.rcsetup.
validate_cycler
(s)¶return a Cycler object from a string repr or the object itself
matplotlib.rcsetup.
validate_dashlist
(s)¶matplotlib.rcsetup.
validate_dpi
(s)¶confirm s is string ‘figure’ or convert s to float or raise
matplotlib.rcsetup.
validate_fillstylelist
(s)¶matplotlib.rcsetup.
validate_float
(s)¶convert s to float or raise
matplotlib.rcsetup.
validate_float_or_None
(s)¶convert s to float, None or raise
matplotlib.rcsetup.
validate_floatlist
(s)¶convert s to float or raise
matplotlib.rcsetup.
validate_font_properties
(s)¶matplotlib.rcsetup.
validate_fontsize
(s)¶matplotlib.rcsetup.
validate_fontsizelist
(s)¶matplotlib.rcsetup.
validate_fonttype
(s)¶confirm that this is a Postscript of PDF font type that we know how to convert to
matplotlib.rcsetup.
validate_hatch
(s)¶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_hinting
(s)¶matplotlib.rcsetup.
validate_hist_bins
(s)¶matplotlib.rcsetup.
validate_int
(s)¶convert s to int or raise
matplotlib.rcsetup.
validate_int_or_None
(s)¶if not None, tries to validate as an int
matplotlib.rcsetup.
validate_joinstylelist
(s)¶matplotlib.rcsetup.
validate_negative_linestyle
(s)¶Deprecated since version 2.1: The validate_negative_linestyle function was deprecated in version 2.1. See ‘validate_negative_linestyle_legacy’ deprecation warning for more information.
matplotlib.rcsetup.
validate_negative_linestyle_legacy
(s)¶Deprecated since version 2.1: The validate_negative_linestyle_legacy function was deprecated in version 2.1. The ‘contour.negative_linestyle’ rcParam now follows the same validation as the other rcParams that are related to line style.
matplotlib.rcsetup.
validate_path_exists
(s)¶If s is a path, return s, else False
matplotlib.rcsetup.
validate_ps_distiller
(s)¶matplotlib.rcsetup.
validate_sketch
(s)¶matplotlib.rcsetup.
validate_string_or_None
(s)¶convert s to string or raise
matplotlib.rcsetup.
validate_stringlist
(s)¶return a list
matplotlib.rcsetup.
validate_toolbar
(s)¶matplotlib.rcsetup.
validate_whiskers
(s)¶