-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathrcsetup_api.html
More file actions
568 lines (490 loc) · 43.2 KB
/
rcsetup_api.html
File metadata and controls
568 lines (490 loc) · 43.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>rcsetup — Matplotlib 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '3.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.0.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 3.0.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="sankey" href="sankey_api.html" />
<link rel="prev" title="projections" href="projections_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/rcsetup_api.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.0.0). For the latest version see <a href="https://matplotlib.org/stable/api/rcsetup_api.html">https://matplotlib.org/stable/api/rcsetup_api.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.0.0</span></div>
<img src="../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="sankey_api.html" title="sankey"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="projections_api.html" title="projections"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="api_overview.html">API</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">rcsetup</a><ul>
<li><a class="reference internal" href="#module-matplotlib.rcsetup"><code class="docutils literal notranslate"><span class="pre">matplotlib.rcsetup</span></code></a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li>Previous: <a href="projections_api.html" title="previous chapter">projections</a></li>
<li>Next: <a href="sankey_api.html" title="next chapter">sankey</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/rcsetup_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="rcsetup">
<h1>rcsetup<a class="headerlink" href="#rcsetup" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.rcsetup">
<span id="matplotlib-rcsetup"></span><h2><a class="reference internal" href="#module-matplotlib.rcsetup" title="matplotlib.rcsetup"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.rcsetup</span></code></a><a class="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
<code class="file docutils literal notranslate"><span class="pre">matplotlibrc.template</span></code> in matplotlib's root source directory.</p>
<dl class="class">
<dt id="matplotlib.rcsetup.ValidateInStrings">
<em class="property">class </em><code class="descclassname">matplotlib.rcsetup.</code><code class="descname">ValidateInStrings</code><span class="sig-paren">(</span><em>key</em>, <em>valid</em>, <em>ignorecase=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#ValidateInStrings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.ValidateInStrings" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>valid is a list of legal strings</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.rcsetup.ValidateInterval">
<em class="property">class </em><code class="descclassname">matplotlib.rcsetup.</code><code class="descname">ValidateInterval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>closedmin=True</em>, <em>closedmax=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#ValidateInterval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.ValidateInterval" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Value must be in interval</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.cycler">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">cycler</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#cycler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.cycler" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <a class="reference external" href="https://matplotlib.org/cycler/generated/cycler.Cycler.html#cycler.Cycler" title="(in cycler v0.10.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Cycler</span></code></a> object much like <a class="reference external" href="https://matplotlib.org/cycler/generated/cycler.cycler.html#cycler.cycler" title="(in cycler v0.10.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">cycler.cycler()</span></code></a>,
but includes input validation.</p>
<p>Call signatures:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cycler</span><span class="p">(</span><span class="n">cycler</span><span class="p">)</span>
<span class="n">cycler</span><span class="p">(</span><span class="n">label</span><span class="o">=</span><span class="n">values</span><span class="p">[,</span> <span class="n">label2</span><span class="o">=</span><span class="n">values2</span><span class="p">[,</span> <span class="o">...</span><span class="p">]])</span>
<span class="n">cycler</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">values</span><span class="p">)</span>
</pre></div>
</div>
<p>Form 1 copies a given <a class="reference external" href="https://matplotlib.org/cycler/generated/cycler.Cycler.html#cycler.Cycler" title="(in cycler v0.10.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Cycler</span></code></a> object.</p>
<p>Form 2 creates a <a class="reference external" href="https://matplotlib.org/cycler/generated/cycler.Cycler.html#cycler.Cycler" title="(in cycler v0.10.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Cycler</span></code></a> which cycles over one or more
properties simultaneously. If multiple properties are given, their
value lists must have the same length.</p>
<p>Form 3 creates a <a class="reference external" href="https://matplotlib.org/cycler/generated/cycler.Cycler.html#cycler.Cycler" title="(in cycler v0.10.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Cycler</span></code></a> 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. <code class="docutils literal notranslate"><span class="pre">cycler(label=values)</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>cycler</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Cycler</span></dt>
<dd><p class="first last">Copy constructor for Cycler.</p>
</dd>
<dt><strong>label</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">The property key. Must be a valid <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a> property.
For example, 'color' or 'linestyle'. Aliases are allowed,
such as 'c' for 'color' and 'lw' for 'linewidth'.</p>
</dd>
<dt><strong>values</strong> <span class="classifier-delimiter">:</span> <span class="classifier">iterable</span></dt>
<dd><p class="first last">Finite-length iterable of the property values. These values
are validated and will raise a ValueError if invalid.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>cycler</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Cycler</span></dt>
<dd><p class="first last">A new <a class="reference external" href="https://matplotlib.org/cycler/generated/cycler.Cycler.html#cycler.Cycler" title="(in cycler v0.10.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cycler</span></code></a> for the given properties.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<p>Creating a cycler for a single property:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">c</span> <span class="o">=</span> <span class="n">cycler</span><span class="p">(</span><span class="n">color</span><span class="o">=</span><span class="p">[</span><span class="s1">'red'</span><span class="p">,</span> <span class="s1">'green'</span><span class="p">,</span> <span class="s1">'blue'</span><span class="p">])</span>
</pre></div>
</div>
<p>Creating a cycler for simultaneously cycling over multiple properties
(e.g. red circle, green plus, blue cross):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">c</span> <span class="o">=</span> <span class="n">cycler</span><span class="p">(</span><span class="n">color</span><span class="o">=</span><span class="p">[</span><span class="s1">'red'</span><span class="p">,</span> <span class="s1">'green'</span><span class="p">,</span> <span class="s1">'blue'</span><span class="p">],</span>
<span class="gp">... </span> <span class="n">marker</span><span class="o">=</span><span class="p">[</span><span class="s1">'o'</span><span class="p">,</span> <span class="s1">'+'</span><span class="p">,</span> <span class="s1">'x'</span><span class="p">])</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.update_savefig_format">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">update_savefig_format</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#update_savefig_format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.update_savefig_format" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_animation_writer_path">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_animation_writer_path</code><span class="sig-paren">(</span><em>p</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_animation_writer_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_animation_writer_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_any">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_any</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_any"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_any" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_anylist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_anylist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_anylist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_aspect">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_aspect</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_aspect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_aspect" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_axisbelow">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_axisbelow</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_axisbelow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_axisbelow" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_backend">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_backend</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_backend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_backend" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_bbox">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_bbox</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_bbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_bbox" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_bool">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_bool</code><span class="sig-paren">(</span><em>b</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_bool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_bool" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert b to a boolean or raise</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_bool_maybe_none">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_bool_maybe_none</code><span class="sig-paren">(</span><em>b</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_bool_maybe_none"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_capstylelist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_capstylelist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_capstylelist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_color">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_color</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_color"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_color" title="Permalink to this definition">¶</a></dt>
<dd><p>return a valid color arg</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_color_for_prop_cycle">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_color_for_prop_cycle</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_color_for_prop_cycle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_color_for_prop_cycle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_color_or_auto">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_color_or_auto</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_color_or_auto"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_color_or_auto" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_color_or_inherit">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_color_or_inherit</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_color_or_inherit"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_colorlist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_colorlist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_colorlist" title="Permalink to this definition">¶</a></dt>
<dd><p>return a list of colorspecs</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_cycler">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_cycler</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_cycler"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_dashlist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_dashlist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_dashlist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_dpi">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_dpi</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_dpi"><span class="viewcode-link">[source]</span></a><a class="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>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_fillstylelist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_fillstylelist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_fillstylelist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_float">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_float</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_float"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_float" title="Permalink to this definition">¶</a></dt>
<dd><p>convert s to float or raise</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_float_or_None">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_float_or_None</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_float_or_None"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_floatlist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_floatlist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_floatlist" title="Permalink to this definition">¶</a></dt>
<dd><p>convert s to float or raise</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_font_properties">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_font_properties</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_font_properties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_font_properties" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_fontsize">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_fontsize</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_fontsize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_fontsize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_fontsize_None">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_fontsize_None</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_fontsize_None"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_fontsize_None" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_fontsizelist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_fontsizelist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_fontsizelist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_fonttype">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_fonttype</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_fonttype"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_hatch">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_hatch</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_hatch"><span class="viewcode-link">[source]</span></a><a class="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
characters: <code class="docutils literal notranslate"><span class="pre">\</span> <span class="pre">/</span> <span class="pre">|</span> <span class="pre">-</span> <span class="pre">+</span> <span class="pre">*</span> <span class="pre">.</span> <span class="pre">x</span> <span class="pre">o</span> <span class="pre">O</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_hatchlist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_hatchlist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="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
characters: <code class="docutils literal notranslate"><span class="pre">\</span> <span class="pre">/</span> <span class="pre">|</span> <span class="pre">-</span> <span class="pre">+</span> <span class="pre">*</span> <span class="pre">.</span> <span class="pre">x</span> <span class="pre">o</span> <span class="pre">O</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_hinting">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_hinting</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_hinting"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_hinting" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_hist_bins">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_hist_bins</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_hist_bins"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_hist_bins" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_int">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_int</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_int"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_int" title="Permalink to this definition">¶</a></dt>
<dd><p>convert s to int or raise</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_int_or_None">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_int_or_None</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_int_or_None"><span class="viewcode-link">[source]</span></a><a class="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>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_joinstylelist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_joinstylelist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_joinstylelist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_markevery">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_markevery</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_markevery"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_markevery" title="Permalink to this definition">¶</a></dt>
<dd><p>Validate the markevery property of a Line2D object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>s</strong> <span class="classifier-delimiter">:</span> <span class="classifier">None, int, float, slice, length-2 tuple of ints,</span></dt>
<dd><p class="first last">length-2 tuple of floats, list of ints</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>s</strong> <span class="classifier-delimiter">:</span> <span class="classifier">None, int, float, slice, length-2 tuple of ints,</span></dt>
<dd><p class="first last">length-2 tuple of floats, list of ints</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_markeverylist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_markeverylist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_markeverylist" title="Permalink to this definition">¶</a></dt>
<dd><p>Validate the markevery property of a Line2D object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>s</strong> <span class="classifier-delimiter">:</span> <span class="classifier">None, int, float, slice, length-2 tuple of ints,</span></dt>
<dd><p class="first last">length-2 tuple of floats, list of ints</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>s</strong> <span class="classifier-delimiter">:</span> <span class="classifier">None, int, float, slice, length-2 tuple of ints,</span></dt>
<dd><p class="first last">length-2 tuple of floats, list of ints</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="matplotlib.rcsetup.validate_nseq_float">
<em class="property">class </em><code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_nseq_float</code><span class="sig-paren">(</span><em>n=None</em>, <em>allow_none=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_nseq_float"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_nseq_float" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.rcsetup.validate_nseq_int">
<em class="property">class </em><code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_nseq_int</code><span class="sig-paren">(</span><em>n=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_nseq_int"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_nseq_int" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_path_exists">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_path_exists</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_path_exists"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_ps_distiller">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_ps_distiller</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_ps_distiller"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_ps_distiller" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_qt4">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_qt4</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_qt4"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_qt4" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_qt5">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_qt5</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_qt5"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_qt5" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_sketch">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_sketch</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_sketch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_sketch" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_string">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_string</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_string" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_string_or_None">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_string_or_None</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_string_or_None"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_stringlist">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_stringlist</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rcsetup.validate_stringlist" title="Permalink to this definition">¶</a></dt>
<dd><p>return a list</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_svg_fonttype">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_svg_fonttype</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_svg_fonttype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_svg_fonttype" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_toolbar">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_toolbar</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_toolbar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_toolbar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_webagg_address">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_webagg_address</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_webagg_address"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_webagg_address" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.rcsetup.validate_whiskers">
<code class="descclassname">matplotlib.rcsetup.</code><code class="descname">validate_whiskers</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/rcsetup.html#validate_whiskers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcsetup.validate_whiskers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Sep 21, 2018.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.7.9.
Doc version v3.0.0-12-gea132530f.
</div>
</body>
<footer>
</footer>
</html>