<divid="unreleased-message"> You are reading an old version of the documentation (v2.1.2). For the latest version see <ahref="https://matplotlib.org/stable/api/rcsetup_api.html">https://matplotlib.org/stable/api/rcsetup_api.html</a></div>
<spanid="matplotlib-rcsetup"></span><h2><aclass="reference internal" href="#module-matplotlib.rcsetup" title="matplotlib.rcsetup"><codeclass="xref py py-mod docutils literal"><spanclass="pre">matplotlib.rcsetup</span></code></a><aclass="headerlink" href="#module-matplotlib.rcsetup" title="Permalink to this headline">¶</a></h2>
<p>The rcsetup module contains the default values and the validation code for
customization using matplotlib’s rc settings.</p>
<p>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.</p>
<p>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
<codeclass="file docutils literal"><spanclass="pre">matplotlibrc.template</span></code> in matplotlib’s root source directory.</p>
<dlclass="class">
<dtid="matplotlib.rcsetup.ValidateInStrings">
<emclass="property">class </em><codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">ValidateInStrings</code><spanclass="sig-paren">(</span><em>key</em>, <em>valid</em>, <em>ignorecase=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.ValidateInStrings" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">ValidateInterval</code><spanclass="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>closedmin=True</em>, <em>closedmax=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.ValidateInterval" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">cycler</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.cycler" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <codeclass="xref py py-class docutils literal"><spanclass="pre">cycler.Cycler</span></code> object much like <codeclass="xref py py-func docutils literal"><spanclass="pre">cycler.cycler()</span></code>,
but includes input validation.</p>
<p>cycler(arg)
cycler(label, itr)
cycler(label1=itr1[, label2=itr2[, …]])</p>
<p>Form 1 simply copies a given <codeclass="xref py py-obj docutils literal"><spanclass="pre">Cycler</span></code> object.</p>
<p>Form 2 creates a <codeclass="xref py py-obj docutils literal"><spanclass="pre">Cycler</span></code> from a label and an iterable.</p>
<p>Form 3 composes a <codeclass="xref py py-obj docutils literal"><spanclass="pre">Cycler</span></code> as an inner product of the
pairs of keyword arguments. In other words, all of the
iterables are cycled simultaneously, as if through zip().</p>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">deprecate_axes_colorcycle</code><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.deprecate_axes_colorcycle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.deprecate_axes_hold">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">deprecate_axes_hold</code><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.deprecate_axes_hold" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">deprecate_svg_embed_char_paths</code><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.deprecate_svg_embed_char_paths" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">deprecate_svg_image_noscale</code><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.deprecate_svg_image_noscale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.update_savefig_format">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">update_savefig_format</code><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.update_savefig_format" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_animation_writer_path</code><spanclass="sig-paren">(</span><em>p</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_animation_writer_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_any">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_any</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_any" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_anylist">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_anylist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_anylist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_aspect">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_aspect</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_aspect" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_axisbelow">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_axisbelow</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_axisbelow" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_backend">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_backend</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_backend" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_bbox">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_bbox</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_bbox" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_bool">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_bool</code><spanclass="sig-paren">(</span><em>b</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_bool" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_bool_maybe_none</code><spanclass="sig-paren">(</span><em>b</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_bool_maybe_none" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert b to a boolean or raise</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_capstylelist">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_capstylelist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_capstylelist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_color">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_color</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_color" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_color_for_prop_cycle</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_color_for_prop_cycle" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_color_or_auto</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_color_or_auto" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_color_or_inherit</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_color_or_inherit" title="Permalink to this definition">¶</a></dt>
<dd><p>return a valid color arg</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_colorlist">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_colorlist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_colorlist" title="Permalink to this definition">¶</a></dt>
<dd><p>return a list of colorspecs</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_corner_mask">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_corner_mask</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_corner_mask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_cycler">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_cycler</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_cycler" title="Permalink to this definition">¶</a></dt>
<dd><p>return a Cycler object from a string repr or the object itself</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_dashlist">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_dashlist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_dashlist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_dpi">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_dpi</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_dpi" title="Permalink to this definition">¶</a></dt>
<dd><p>confirm s is string ‘figure’ or convert s to float or raise</p>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_fillstylelist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_fillstylelist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_float">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_float</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_float" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_float_or_None</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_float_or_None" title="Permalink to this definition">¶</a></dt>
<dd><p>convert s to float, None or raise</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_floatlist">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_floatlist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_floatlist" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_font_properties</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_font_properties" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_fontsize">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_fontsize</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_fontsize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_fontsizelist">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_fontsizelist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_fontsizelist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_fonttype">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_fonttype</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_fonttype" title="Permalink to this definition">¶</a></dt>
<dd><p>confirm that this is a Postscript of PDF font type that we know how to
convert to</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_hatch">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_hatch</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_hatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Validate a hatch pattern.
A hatch pattern string can have any sequence of the following
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_hatchlist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_hatchlist" title="Permalink to this definition">¶</a></dt>
<dd><p>Validate a hatch pattern.
A hatch pattern string can have any sequence of the following
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_hinting</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_hinting" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_hist_bins">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_hist_bins</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_hist_bins" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_int">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_int</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_int" title="Permalink to this definition">¶</a></dt>
<dd><p>convert s to int or raise</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_int_or_None">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_int_or_None</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_int_or_None" title="Permalink to this definition">¶</a></dt>
<dd><p>if not None, tries to validate as an int</p>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_joinstylelist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_joinstylelist" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_negative_linestyle</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_negative_linestyle" title="Permalink to this definition">¶</a></dt>
<dd><divclass="deprecated">
<p><spanclass="versionmodified">Deprecated since version 2.1: </span>The validate_negative_linestyle function was deprecated in version 2.1. See ‘validate_negative_linestyle_legacy’ deprecation warning for more information.</p>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_negative_linestyle_legacy</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_negative_linestyle_legacy" title="Permalink to this definition">¶</a></dt>
<dd><divclass="deprecated">
<p><spanclass="versionmodified">Deprecated since version 2.1: </span>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.</p>
</div>
<p></p>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.rcsetup.validate_nseq_float">
<emclass="property">class </em><codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_nseq_float</code><spanclass="sig-paren">(</span><em>n=None</em>, <em>allow_none=False</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_nseq_float" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_nseq_int</code><spanclass="sig-paren">(</span><em>n=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_nseq_int" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_path_exists</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_path_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>If s is a path, return s, else False</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_ps_distiller">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_ps_distiller</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_ps_distiller" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_sketch">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_sketch</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_sketch" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_string_or_None</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_string_or_None" title="Permalink to this definition">¶</a></dt>
<dd><p>convert s to string or raise</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_stringlist">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_stringlist</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_stringlist" title="Permalink to this definition">¶</a></dt>
<dd><p>return a list</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_toolbar">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_toolbar</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_toolbar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="matplotlib.rcsetup.validate_whiskers">
<codeclass="descclassname">matplotlib.rcsetup.</code><codeclass="descname">validate_whiskers</code><spanclass="sig-paren">(</span><em>s</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.rcsetup.validate_whiskers" title="Permalink to this definition">¶</a></dt>