-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathmatplotlib_configuration_api.html
More file actions
454 lines (408 loc) · 46.9 KB
/
matplotlib_configuration_api.html
File metadata and controls
454 lines (408 loc) · 46.9 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
<!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>The top level matplotlib module — Matplotlib 2.2.5 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/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.5',
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>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.5 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 2.2.5 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="afm (Adobe Font Metrics interface)" href="afm_api.html" />
<link rel="prev" title="API Changes" href="api_changes.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/matplotlib_configuration_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 (v2.2.5). For the latest version see <a href="https://matplotlib.org/stable/api/matplotlib_configuration_api.html">https://matplotlib.org/stable/api/matplotlib_configuration_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 2.2.5</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="afm_api.html" title="afm (Adobe Font Metrics interface)"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="api_changes.html" title="API Changes"
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="pyplot_summary.html">pyplot</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><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="api_changes.html" title="previous chapter">API Changes</a></li>
<li>Next: <a href="afm_api.html" title="next chapter">afm (Adobe Font Metrics interface)</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/matplotlib_configuration_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="the-top-level-matplotlib-module">
<h1>The top level <code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib</span></code> module<a class="headerlink" href="#the-top-level-matplotlib-module" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="matplotlib.use">
<code class="descclassname">matplotlib.</code><code class="descname">use</code><span class="sig-paren">(</span><em>arg</em>, <em>warn=True</em>, <em>force=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.use" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the matplotlib backend to one of the known backends.</p>
<p>The argument is case-insensitive. <em>warn</em> specifies whether a
warning should be issued if a backend has already been set up.
<em>force</em> is an <strong>experimental</strong> flag that tells matplotlib to
attempt to initialize a new backend by reloading the backend
module.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This function must be called <em>before</em> importing pyplot for
the first time; or, if you are not using pyplot, it must be called
before importing matplotlib.backends. If warn is True, a warning
is issued if you try and call this after pylab or pyplot have been
loaded. In certain black magic use cases, e.g.
<a class="reference internal" href="_as_gen/matplotlib.pyplot.switch_backend.html#matplotlib.pyplot.switch_backend" title="matplotlib.pyplot.switch_backend"><code class="xref py py-func docutils literal notranslate"><span class="pre">pyplot.switch_backend()</span></code></a>, we are doing the reloading necessary to
make the backend switch work (in some cases, e.g., pure image
backends) so one can set warn=False to suppress the warnings.</p>
</div>
<p>To find out which backend is currently set, see
<a class="reference internal" href="#matplotlib.get_backend" title="matplotlib.get_backend"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.get_backend()</span></code></a>.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.get_backend">
<code class="descclassname">matplotlib.</code><code class="descname">get_backend</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#get_backend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.get_backend" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the name of the current backend.</p>
</dd></dl>
<dl class="data">
<dt id="matplotlib.rcParams">
<code class="descclassname">matplotlib.</code><code class="descname">rcParams</code><a class="headerlink" href="#matplotlib.rcParams" title="Permalink to this definition">¶</a></dt>
<dd><p>An instance of <a class="reference internal" href="#matplotlib.RcParams" title="matplotlib.RcParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">RcParams</span></code></a> for handling default matplotlib values.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rc_context">
<code class="descclassname">matplotlib.</code><code class="descname">rc_context</code><span class="sig-paren">(</span><em>rc=None</em>, <em>fname=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#rc_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rc_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a context manager for managing rc settings.</p>
<p>This allows one to do:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">mpl</span><span class="o">.</span><span class="n">rc_context</span><span class="p">(</span><span class="n">fname</span><span class="o">=</span><span class="s1">'screen.rc'</span><span class="p">):</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">a</span><span class="p">)</span>
<span class="k">with</span> <span class="n">mpl</span><span class="o">.</span><span class="n">rc_context</span><span class="p">(</span><span class="n">fname</span><span class="o">=</span><span class="s1">'print.rc'</span><span class="p">):</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span>
</pre></div>
</div>
<p>The 'a' vs 'x' and 'c' vs 'x' plots would have settings from
'screen.rc', while the 'b' vs 'x' plot would have settings from
'print.rc'.</p>
<p>A dictionary can also be passed to the context manager:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">mpl</span><span class="o">.</span><span class="n">rc_context</span><span class="p">(</span><span class="n">rc</span><span class="o">=</span><span class="p">{</span><span class="s1">'text.usetex'</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span> <span class="n">fname</span><span class="o">=</span><span class="s1">'screen.rc'</span><span class="p">):</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
<p>The 'rc' dictionary takes precedence over the settings loaded from
'fname'. Passing a dictionary only is also valid. For example a
common usage is:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">mpl</span><span class="o">.</span><span class="n">rc_context</span><span class="p">(</span><span class="n">rc</span><span class="o">=</span><span class="p">{</span><span class="s1">'interactive'</span><span class="p">:</span> <span class="kc">False</span><span class="p">}):</span>
<span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span>
<span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">),</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">))</span>
<span class="n">fig</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="s1">'A.png'</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'png'</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="n">fig</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rc">
<code class="descclassname">matplotlib.</code><code class="descname">rc</code><span class="sig-paren">(</span><em>group</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#rc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rc" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the current rc params. Group is the grouping for the rc, e.g.,
for <code class="docutils literal notranslate"><span class="pre">lines.linewidth</span></code> the group is <code class="docutils literal notranslate"><span class="pre">lines</span></code>, for
<code class="docutils literal notranslate"><span class="pre">axes.facecolor</span></code>, the group is <code class="docutils literal notranslate"><span class="pre">axes</span></code>, and so on. Group may
also be a list or tuple of group names, e.g., (<em>xtick</em>, <em>ytick</em>).
<em>kwargs</em> is a dictionary attribute name/value pairs, e.g.,:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rc</span><span class="p">(</span><span class="s1">'lines'</span><span class="p">,</span> <span class="n">linewidth</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'r'</span><span class="p">)</span>
</pre></div>
</div>
<p>sets the current rc params and is equivalent to:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'lines.linewidth'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">2</span>
<span class="n">rcParams</span><span class="p">[</span><span class="s1">'lines.color'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'r'</span>
</pre></div>
</div>
<p>The following aliases are available to save typing for interactive
users:</p>
<table border="1" class="docutils">
<colgroup>
<col width="23%" />
<col width="77%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Alias</th>
<th class="head">Property</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>'lw'</td>
<td>'linewidth'</td>
</tr>
<tr class="row-odd"><td>'ls'</td>
<td>'linestyle'</td>
</tr>
<tr class="row-even"><td>'c'</td>
<td>'color'</td>
</tr>
<tr class="row-odd"><td>'fc'</td>
<td>'facecolor'</td>
</tr>
<tr class="row-even"><td>'ec'</td>
<td>'edgecolor'</td>
</tr>
<tr class="row-odd"><td>'mew'</td>
<td>'markeredgewidth'</td>
</tr>
<tr class="row-even"><td>'aa'</td>
<td>'antialiased'</td>
</tr>
</tbody>
</table>
<p>Thus you could abbreviate the above rc command as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rc</span><span class="p">(</span><span class="s1">'lines'</span><span class="p">,</span> <span class="n">lw</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="s1">'r'</span><span class="p">)</span>
</pre></div>
</div>
<p>Note you can use python's kwargs dictionary facility to store
dictionaries of default parameters. e.g., you can customize the
font rc as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">font</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'family'</span> <span class="p">:</span> <span class="s1">'monospace'</span><span class="p">,</span>
<span class="s1">'weight'</span> <span class="p">:</span> <span class="s1">'bold'</span><span class="p">,</span>
<span class="s1">'size'</span> <span class="p">:</span> <span class="s1">'larger'</span><span class="p">}</span>
<span class="n">rc</span><span class="p">(</span><span class="s1">'font'</span><span class="p">,</span> <span class="o">**</span><span class="n">font</span><span class="p">)</span> <span class="c1"># pass in the font dict as kwargs</span>
</pre></div>
</div>
<p>This enables you to easily switch between several configurations. Use
<code class="docutils literal notranslate"><span class="pre">matplotlib.style.use('default')</span></code> or <a class="reference internal" href="#matplotlib.rcdefaults" title="matplotlib.rcdefaults"><code class="xref py py-func docutils literal notranslate"><span class="pre">rcdefaults()</span></code></a> to
restore the default rc params after changes.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rc_file">
<code class="descclassname">matplotlib.</code><code class="descname">rc_file</code><span class="sig-paren">(</span><em>fname</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#rc_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rc_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Update rc params from file.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rcdefaults">
<code class="descclassname">matplotlib.</code><code class="descname">rcdefaults</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#rcdefaults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rcdefaults" title="Permalink to this definition">¶</a></dt>
<dd><p>Restore the rc params from Matplotlib's internal defaults.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="#matplotlib.rc_file_defaults" title="matplotlib.rc_file_defaults"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rc_file_defaults</span></code></a></dt>
<dd>Restore the rc params from the rc file originally loaded by Matplotlib.</dd>
<dt><a class="reference internal" href="style_api.html#matplotlib.style.use" title="matplotlib.style.use"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.style.use</span></code></a></dt>
<dd>Use a specific style file. Call <code class="docutils literal notranslate"><span class="pre">style.use('default')</span></code> to restore the default style.</dd>
</dl>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rc_file_defaults">
<code class="descclassname">matplotlib.</code><code class="descname">rc_file_defaults</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#rc_file_defaults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rc_file_defaults" title="Permalink to this definition">¶</a></dt>
<dd><p>Restore the rc params from the original rc file loaded by Matplotlib.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.RcParams">
<em class="property">class </em><code class="descclassname">matplotlib.</code><code class="descname">RcParams</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#RcParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.RcParams" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary object including validation</p>
<p>validating functions are defined and associated with rc parameters in
<a class="reference internal" href="rcsetup_api.html#module-matplotlib.rcsetup" title="matplotlib.rcsetup"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.rcsetup</span></code></a></p>
<dl class="method">
<dt id="matplotlib.RcParams.find_all">
<code class="descname">find_all</code><span class="sig-paren">(</span><em>pattern</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#RcParams.find_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.RcParams.find_all" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the subset of this RcParams dictionary whose keys match,
using <a class="reference external" href="https://docs.python.org/3/library/re.html#re.search" title="(in Python v3.8)"><code class="xref py py-func docutils literal notranslate"><span class="pre">re.search()</span></code></a>, the given <code class="docutils literal notranslate"><span class="pre">pattern</span></code>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Changes to the returned dictionary are <em>not</em> propagated to
the parent RcParams dictionary.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.RcParams.msg_backend_obsolete">
<code class="descname">msg_backend_obsolete</code><em class="property"> = 'The {} rcParam was deprecated in version 2.2. In order to force the use of a specific Qt binding, either import that binding first, or set the QT_API environment variable.'</em><a class="headerlink" href="#matplotlib.RcParams.msg_backend_obsolete" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.RcParams.msg_depr">
<code class="descname">msg_depr</code><em class="property"> = '%s is deprecated and replaced with %s; please use the latter.'</em><a class="headerlink" href="#matplotlib.RcParams.msg_depr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.RcParams.msg_depr_ignore">
<code class="descname">msg_depr_ignore</code><em class="property"> = '%s is deprecated and ignored. Use %s instead.'</em><a class="headerlink" href="#matplotlib.RcParams.msg_depr_ignore" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.RcParams.msg_depr_set">
<code class="descname">msg_depr_set</code><em class="property"> = '%s is deprecated. Please remove it from your matplotlibrc and/or style files.'</em><a class="headerlink" href="#matplotlib.RcParams.msg_depr_set" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.RcParams.msg_obsolete">
<code class="descname">msg_obsolete</code><em class="property"> = '%s is obsolete. Please remove it from your matplotlibrc and/or style files.'</em><a class="headerlink" href="#matplotlib.RcParams.msg_obsolete" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.RcParams.validate">
<code class="descname">validate</code><em class="property"> = {'_internal.classic_mode': <function validate_bool>, 'agg.path.chunksize': <function validate_int>, 'animation.avconv_args': <function _listify_validator.<locals>.f>, 'animation.avconv_path': <function validate_animation_writer_path>, 'animation.bitrate': <function validate_int>, 'animation.codec': <function validate_string>, 'animation.convert_args': <function _listify_validator.<locals>.f>, 'animation.convert_path': <function validate_animation_writer_path>, 'animation.embed_limit': <function validate_float>, 'animation.ffmpeg_args': <function _listify_validator.<locals>.f>, 'animation.ffmpeg_path': <function validate_animation_writer_path>, 'animation.frame_format': <matplotlib.rcsetup.ValidateInStrings object>, 'animation.html': <matplotlib.rcsetup.ValidateInStrings object>, 'animation.html_args': <function _listify_validator.<locals>.f>, 'animation.writer': <matplotlib.rcsetup.ValidateInStrings object>, 'axes.autolimit_mode': <matplotlib.rcsetup.ValidateInStrings object>, 'axes.axisbelow': <function validate_axisbelow>, 'axes.edgecolor': <function validate_color>, 'axes.facecolor': <function validate_color>, 'axes.formatter.limits': <matplotlib.rcsetup.validate_nseq_int object>, 'axes.formatter.min_exponent': <function validate_int>, 'axes.formatter.offset_threshold': <function validate_int>, 'axes.formatter.use_locale': <function validate_bool>, 'axes.formatter.use_mathtext': <function validate_bool>, 'axes.formatter.useoffset': <function validate_bool>, 'axes.grid': <function validate_bool>, 'axes.grid.axis': <matplotlib.rcsetup.ValidateInStrings object>, 'axes.grid.which': <matplotlib.rcsetup.ValidateInStrings object>, 'axes.hold': <function deprecate_axes_hold>, 'axes.labelcolor': <function validate_color>, 'axes.labelpad': <function validate_float>, 'axes.labelsize': <function validate_fontsize>, 'axes.labelweight': <function validate_string>, 'axes.linewidth': <function validate_float>, 'axes.prop_cycle': <function validate_cycler>, 'axes.spines.bottom': <function validate_bool>, 'axes.spines.left': <function validate_bool>, 'axes.spines.right': <function validate_bool>, 'axes.spines.top': <function validate_bool>, 'axes.titlepad': <function validate_float>, 'axes.titlesize': <function validate_fontsize>, 'axes.titleweight': <function validate_string>, 'axes.unicode_minus': <function validate_bool>, 'axes.xmargin': <matplotlib.rcsetup.ValidateInterval object>, 'axes.ymargin': <matplotlib.rcsetup.ValidateInterval object>, 'axes3d.grid': <function validate_bool>, 'backend': <function validate_backend>, 'backend.qt4': <function validate_qt4>, 'backend.qt5': <function validate_qt5>, 'backend_fallback': <function validate_bool>, 'boxplot.bootstrap': <function validate_int_or_None>, 'boxplot.boxprops.color': <function validate_color>, 'boxplot.boxprops.linestyle': <function _validate_linestyle>, 'boxplot.boxprops.linewidth': <function validate_float>, 'boxplot.capprops.color': <function validate_color>, 'boxplot.capprops.linestyle': <function _validate_linestyle>, 'boxplot.capprops.linewidth': <function validate_float>, 'boxplot.flierprops.color': <function validate_color>, 'boxplot.flierprops.linestyle': <function _validate_linestyle>, 'boxplot.flierprops.linewidth': <function validate_float>, 'boxplot.flierprops.marker': <function validate_string>, 'boxplot.flierprops.markeredgecolor': <function validate_color>, 'boxplot.flierprops.markerfacecolor': <function validate_color_or_auto>, 'boxplot.flierprops.markersize': <function validate_float>, 'boxplot.meanline': <function validate_bool>, 'boxplot.meanprops.color': <function validate_color>, 'boxplot.meanprops.linestyle': <function _validate_linestyle>, 'boxplot.meanprops.linewidth': <function validate_float>, 'boxplot.meanprops.marker': <function validate_string>, 'boxplot.meanprops.markeredgecolor': <function validate_color>, 'boxplot.meanprops.markerfacecolor': <function validate_color>, 'boxplot.meanprops.markersize': <function validate_float>, 'boxplot.medianprops.color': <function validate_color>, 'boxplot.medianprops.linestyle': <function _validate_linestyle>, 'boxplot.medianprops.linewidth': <function validate_float>, 'boxplot.notch': <function validate_bool>, 'boxplot.patchartist': <function validate_bool>, 'boxplot.showbox': <function validate_bool>, 'boxplot.showcaps': <function validate_bool>, 'boxplot.showfliers': <function validate_bool>, 'boxplot.showmeans': <function validate_bool>, 'boxplot.vertical': <function validate_bool>, 'boxplot.whiskerprops.color': <function validate_color>, 'boxplot.whiskerprops.linestyle': <function _validate_linestyle>, 'boxplot.whiskerprops.linewidth': <function validate_float>, 'boxplot.whiskers': <function validate_whiskers>, 'contour.corner_mask': <function validate_bool>, 'contour.negative_linestyle': <function _validate_linestyle>, 'datapath': <function validate_path_exists>, 'date.autoformatter.day': <function validate_string>, 'date.autoformatter.hour': <function validate_string>, 'date.autoformatter.microsecond': <function validate_string>, 'date.autoformatter.minute': <function validate_string>, 'date.autoformatter.month': <function validate_string>, 'date.autoformatter.second': <function validate_string>, 'date.autoformatter.year': <function validate_string>, 'docstring.hardcopy': <function validate_bool>, 'errorbar.capsize': <function validate_float>, 'examples.directory': <function validate_string>, 'figure.autolayout': <function validate_bool>, 'figure.constrained_layout.h_pad': <function validate_float>, 'figure.constrained_layout.hspace': <matplotlib.rcsetup.ValidateInterval object>, 'figure.constrained_layout.use': <function validate_bool>, 'figure.constrained_layout.w_pad': <function validate_float>, 'figure.constrained_layout.wspace': <matplotlib.rcsetup.ValidateInterval object>, 'figure.dpi': <function validate_float>, 'figure.edgecolor': <function validate_color>, 'figure.facecolor': <function validate_color>, 'figure.figsize': <matplotlib.rcsetup.validate_nseq_float object>, 'figure.frameon': <function validate_bool>, 'figure.max_open_warning': <function validate_int>, 'figure.subplot.bottom': <matplotlib.rcsetup.ValidateInterval object>, 'figure.subplot.hspace': <matplotlib.rcsetup.ValidateInterval object>, 'figure.subplot.left': <matplotlib.rcsetup.ValidateInterval object>, 'figure.subplot.right': <matplotlib.rcsetup.ValidateInterval object>, 'figure.subplot.top': <matplotlib.rcsetup.ValidateInterval object>, 'figure.subplot.wspace': <matplotlib.rcsetup.ValidateInterval object>, 'figure.titlesize': <function validate_fontsize>, 'figure.titleweight': <function validate_string>, 'font.cursive': <function _listify_validator.<locals>.f>, 'font.family': <function _listify_validator.<locals>.f>, 'font.fantasy': <function _listify_validator.<locals>.f>, 'font.monospace': <function _listify_validator.<locals>.f>, 'font.sans-serif': <function _listify_validator.<locals>.f>, 'font.serif': <function _listify_validator.<locals>.f>, 'font.size': <function validate_float>, 'font.stretch': <function validate_string>, 'font.style': <function validate_string>, 'font.variant': <function validate_string>, 'font.weight': <function validate_string>, 'grid.alpha': <function validate_float>, 'grid.color': <function validate_color>, 'grid.linestyle': <function _validate_linestyle>, 'grid.linewidth': <function validate_float>, 'hatch.color': <function validate_color>, 'hatch.linewidth': <function validate_float>, 'hist.bins': <function validate_hist_bins>, 'image.aspect': <function validate_aspect>, 'image.cmap': <function validate_string>, 'image.composite_image': <function validate_bool>, 'image.interpolation': <function validate_string>, 'image.lut': <function validate_int>, 'image.origin': <function validate_string>, 'image.resample': <function validate_bool>, 'interactive': <function validate_bool>, 'keymap.all_axes': <function _listify_validator.<locals>.f>, 'keymap.back': <function _listify_validator.<locals>.f>, 'keymap.forward': <function _listify_validator.<locals>.f>, 'keymap.fullscreen': <function _listify_validator.<locals>.f>, 'keymap.grid': <function _listify_validator.<locals>.f>, 'keymap.grid_minor': <function _listify_validator.<locals>.f>, 'keymap.home': <function _listify_validator.<locals>.f>, 'keymap.pan': <function _listify_validator.<locals>.f>, 'keymap.quit': <function _listify_validator.<locals>.f>, 'keymap.quit_all': <function _listify_validator.<locals>.f>, 'keymap.save': <function _listify_validator.<locals>.f>, 'keymap.xscale': <function _listify_validator.<locals>.f>, 'keymap.yscale': <function _listify_validator.<locals>.f>, 'keymap.zoom': <function _listify_validator.<locals>.f>, 'legend.borderaxespad': <function validate_float>, 'legend.borderpad': <function validate_float>, 'legend.columnspacing': <function validate_float>, 'legend.edgecolor': <function validate_color_or_inherit>, 'legend.facecolor': <function validate_color_or_inherit>, 'legend.fancybox': <function validate_bool>, 'legend.fontsize': <function validate_fontsize>, 'legend.framealpha': <function validate_float_or_None>, 'legend.frameon': <function validate_bool>, 'legend.handleheight': <function validate_float>, 'legend.handlelength': <function validate_float>, 'legend.handletextpad': <function validate_float>, 'legend.labelspacing': <function validate_float>, 'legend.loc': <matplotlib.rcsetup.ValidateInStrings object>, 'legend.markerscale': <function validate_float>, 'legend.numpoints': <function validate_int>, 'legend.scatterpoints': <function validate_int>, 'legend.shadow': <function validate_bool>, 'lines.antialiased': <function validate_bool>, 'lines.color': <function validate_color>, 'lines.dash_capstyle': <matplotlib.rcsetup.ValidateInStrings object>, 'lines.dash_joinstyle': <matplotlib.rcsetup.ValidateInStrings object>, 'lines.dashdot_pattern': <matplotlib.rcsetup.validate_nseq_float object>, 'lines.dashed_pattern': <matplotlib.rcsetup.validate_nseq_float object>, 'lines.dotted_pattern': <matplotlib.rcsetup.validate_nseq_float object>, 'lines.linestyle': <function _validate_linestyle>, 'lines.linewidth': <function validate_float>, 'lines.marker': <function validate_string>, 'lines.markeredgewidth': <function validate_float>, 'lines.markersize': <function validate_float>, 'lines.scale_dashes': <function validate_bool>, 'lines.solid_capstyle': <matplotlib.rcsetup.ValidateInStrings object>, 'lines.solid_joinstyle': <matplotlib.rcsetup.ValidateInStrings object>, 'markers.fillstyle': <matplotlib.rcsetup.ValidateInStrings object>, 'mathtext.bf': <function validate_font_properties>, 'mathtext.cal': <function validate_font_properties>, 'mathtext.default': <matplotlib.rcsetup.ValidateInStrings object>, 'mathtext.fallback_to_cm': <function validate_bool>, 'mathtext.fontset': <matplotlib.rcsetup.ValidateInStrings object>, 'mathtext.it': <function validate_font_properties>, 'mathtext.rm': <function validate_font_properties>, 'mathtext.sf': <function validate_font_properties>, 'mathtext.tt': <function validate_font_properties>, 'patch.antialiased': <function validate_bool>, 'patch.edgecolor': <function validate_color>, 'patch.facecolor': <function validate_color>, 'patch.force_edgecolor': <function validate_bool>, 'patch.linewidth': <function validate_float>, 'path.effects': <function validate_any>, 'path.simplify': <function validate_bool>, 'path.simplify_threshold': <matplotlib.rcsetup.ValidateInterval object>, 'path.sketch': <function validate_sketch>, 'path.snap': <function validate_bool>, 'pdf.compression': <function validate_int>, 'pdf.fonttype': <function validate_fonttype>, 'pdf.inheritcolor': <function validate_bool>, 'pdf.use14corefonts': <function validate_bool>, 'pgf.debug': <function validate_bool>, 'pgf.preamble': <function _listify_validator.<locals>.f>, 'pgf.rcfonts': <function validate_bool>, 'pgf.texsystem': <matplotlib.rcsetup.ValidateInStrings object>, 'polaraxes.grid': <function validate_bool>, 'ps.distiller.res': <function validate_int>, 'ps.fonttype': <function validate_fonttype>, 'ps.papersize': <matplotlib.rcsetup.ValidateInStrings object>, 'ps.useafm': <function validate_bool>, 'ps.usedistiller': <function validate_ps_distiller>, 'savefig.bbox': <function validate_bbox>, 'savefig.directory': <function validate_string>, 'savefig.dpi': <function validate_dpi>, 'savefig.edgecolor': <function validate_color>, 'savefig.facecolor': <function validate_color>, 'savefig.format': <function update_savefig_format>, 'savefig.frameon': <function validate_bool>, 'savefig.jpeg_quality': <function validate_int>, 'savefig.orientation': <matplotlib.rcsetup.ValidateInStrings object>, 'savefig.pad_inches': <function validate_float>, 'savefig.transparent': <function validate_bool>, 'scatter.marker': <function validate_string>, 'svg.fonttype': <function validate_svg_fonttype>, 'svg.hashsalt': <function validate_string_or_None>, 'svg.image_inline': <function validate_bool>, 'text.antialiased': <function validate_bool>, 'text.color': <function validate_color>, 'text.hinting': <function validate_hinting>, 'text.hinting_factor': <function validate_int>, 'text.latex.preamble': <function _listify_validator.<locals>.f>, 'text.latex.preview': <function validate_bool>, 'text.latex.unicode': <function validate_bool>, 'text.usetex': <function validate_bool>, 'timezone': <function validate_string>, 'tk.window_focus': <function validate_bool>, 'toolbar': <function validate_toolbar>, 'verbose.fileo': <function validate_string>, 'verbose.level': <matplotlib.rcsetup.ValidateInStrings object>, 'webagg.address': <function validate_webagg_address>, 'webagg.open_in_browser': <function validate_bool>, 'webagg.port': <function validate_int>, 'webagg.port_retries': <function validate_int>, 'xtick.alignment': <matplotlib.rcsetup.ValidateInStrings object>, 'xtick.bottom': <function validate_bool>, 'xtick.color': <function validate_color>, 'xtick.direction': <function validate_string>, 'xtick.labelbottom': <function validate_bool>, 'xtick.labelsize': <function validate_fontsize>, 'xtick.labeltop': <function validate_bool>, 'xtick.major.bottom': <function validate_bool>, 'xtick.major.pad': <function validate_float>, 'xtick.major.size': <function validate_float>, 'xtick.major.top': <function validate_bool>, 'xtick.major.width': <function validate_float>, 'xtick.minor.bottom': <function validate_bool>, 'xtick.minor.pad': <function validate_float>, 'xtick.minor.size': <function validate_float>, 'xtick.minor.top': <function validate_bool>, 'xtick.minor.visible': <function validate_bool>, 'xtick.minor.width': <function validate_float>, 'xtick.top': <function validate_bool>, 'ytick.alignment': <matplotlib.rcsetup.ValidateInStrings object>, 'ytick.color': <function validate_color>, 'ytick.direction': <function validate_string>, 'ytick.labelleft': <function validate_bool>, 'ytick.labelright': <function validate_bool>, 'ytick.labelsize': <function validate_fontsize>, 'ytick.left': <function validate_bool>, 'ytick.major.left': <function validate_bool>, 'ytick.major.pad': <function validate_float>, 'ytick.major.right': <function validate_bool>, 'ytick.major.size': <function validate_float>, 'ytick.major.width': <function validate_float>, 'ytick.minor.left': <function validate_bool>, 'ytick.minor.pad': <function validate_float>, 'ytick.minor.right': <function validate_bool>, 'ytick.minor.size': <function validate_float>, 'ytick.minor.visible': <function validate_bool>, 'ytick.minor.width': <function validate_float>, 'ytick.right': <function validate_bool>}</em><a class="headerlink" href="#matplotlib.RcParams.validate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rc_params">
<code class="descclassname">matplotlib.</code><code class="descname">rc_params</code><span class="sig-paren">(</span><em>fail_on_error=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#rc_params"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rc_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="#matplotlib.RcParams" title="matplotlib.RcParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.RcParams</span></code></a> instance from the
default matplotlib rc file.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.rc_params_from_file">
<code class="descclassname">matplotlib.</code><code class="descname">rc_params_from_file</code><span class="sig-paren">(</span><em>fname</em>, <em>fail_on_error=False</em>, <em>use_default_template=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#rc_params_from_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.rc_params_from_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <a class="reference internal" href="#matplotlib.RcParams" title="matplotlib.RcParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.RcParams</span></code></a> from the contents of the given file.</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 last docutils">
<dt><strong>fname</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">Name of file parsed for matplotlib settings.</p>
</dd>
<dt><strong>fail_on_error</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">If True, raise an error when the parser fails to convert a parameter.</p>
</dd>
<dt><strong>use_default_template</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">If True, initialize with default parameters before updating with those
in the given file. If False, the configuration class only contains the
parameters specified in the file. (Useful for updating dicts.)</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.matplotlib_fname">
<code class="descclassname">matplotlib.</code><code class="descname">matplotlib_fname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#matplotlib_fname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.matplotlib_fname" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the location of the config file.</p>
<p>The file location is determined in the following order</p>
<ul>
<li><p class="first"><code class="xref py py-obj docutils literal notranslate"><span class="pre">$PWD/matplotlibrc</span></code></p>
</li>
<li><p class="first"><code class="xref py py-obj docutils literal notranslate"><span class="pre">$MATPLOTLIBRC</span></code> if it is a file (or a named pipe, which can be created
e.g. by process substitution)</p>
</li>
<li><p class="first"><code class="xref py py-obj docutils literal notranslate"><span class="pre">$MATPLOTLIBRC/matplotlibrc</span></code></p>
</li>
<li><p class="first"><code class="xref py py-obj docutils literal notranslate"><span class="pre">$MPLCONFIGDIR/matplotlibrc</span></code></p>
</li>
<li><p class="first">On Linux,</p>
<blockquote>
<div><ul class="simple">
<li><code class="xref py py-obj docutils literal notranslate"><span class="pre">$XDG_CONFIG_HOME/matplotlib/matplotlibrc</span></code> (if
$XDG_CONFIG_HOME is defined)</li>
<li>or <code class="xref py py-obj docutils literal notranslate"><span class="pre">$HOME/.config/matplotlib/matplotlibrc</span></code> (if
$XDG_CONFIG_HOME is not defined)</li>
</ul>
</div></blockquote>
</li>
<li><p class="first">On other platforms,</p>
<blockquote>
<div><ul class="simple">
<li><code class="xref py py-obj docutils literal notranslate"><span class="pre">$HOME/.matplotlib/matplotlibrc</span></code> if <code class="xref py py-obj docutils literal notranslate"><span class="pre">$HOME</span></code> is defined.</li>
</ul>
</div></blockquote>
</li>
<li><p class="first">Lastly, it looks in <code class="xref py py-obj docutils literal notranslate"><span class="pre">$MATPLOTLIBDATA/matplotlibrc</span></code> for a
system-defined copy.</p>
</li>
</ul>
</dd></dl>
<dl class="function">
<dt id="matplotlib.interactive">
<code class="descclassname">matplotlib.</code><code class="descname">interactive</code><span class="sig-paren">(</span><em>b</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#interactive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.interactive" title="Permalink to this definition">¶</a></dt>
<dd><p>Set interactive mode to boolean b.</p>
<p>If b is True, then draw after every plotting command, e.g., after xlabel</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.is_interactive">
<code class="descclassname">matplotlib.</code><code class="descname">is_interactive</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib.html#is_interactive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.is_interactive" title="Permalink to this definition">¶</a></dt>
<dd><p>Return true if plot mode is interactive</p>
</dd></dl>
</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 Feb 09, 2020.
Created using
<ahref="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v2.2.5-2-ga847ffac5.
</div>
</body>
<footer>
</footer>
</html>