{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathstyle_api.html
More file actions
264 lines (238 loc) · 14.2 KB
/
Copy pathstyle_api.html
File metadata and controls
264 lines (238 loc) · 14.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
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.style — Matplotlib 3.3.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.0-3-g8994f1b60" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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="../_static/clipboard.min.js"></script>
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script async="async" 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 3.3.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="next" title="matplotlib.table" href="table_api.html" />
<link rel="prev" title="matplotlib.spines" href="spines_api.html" />
<link rel="top" title="Matplotlib 3.3.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/style_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<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.3.0). For the latest version see <a href="https://matplotlib.org/stable/api/style_api.html">https://matplotlib.org/stable/api/style_api.html</a></div>
<!--
<div id="annc-banner">
</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.3.0</span></div>
<img src="../_static/logo2_compressed.svg" 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>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<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="table_api.html" title="matplotlib.table"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="spines_api.html" title="matplotlib.spines"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="spines_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.spines</span></code></a></li>
<li>Next: <a href="table_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.table</span></code></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/style_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" role="main">
<div class="section" id="matplotlib-style">
<h1><code class="docutils literal notranslate"><span class="pre">matplotlib.style</span></code><a class="headerlink" href="#matplotlib-style" title="Permalink to this headline">¶</a></h1>
<p>Styles are predefined sets of <a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a> that define the visual appearance of
a plot.</p>
<p><a class="reference internal" href="../tutorials/introductory/customizing.html"><span class="doc">Customizing Matplotlib with style sheets and rcParams</span></a> describes the mechanism and usage
of styles.</p>
<p>The <a class="reference internal" href="../gallery/style_sheets/style_sheets_reference.html"><span class="doc">Style sheets reference</span></a> gives an overview of
the builtin styles.</p>
<span class="target" id="module-matplotlib.style"></span><dl class="function">
<dt id="matplotlib.style.context">
<code class="descclassname">matplotlib.style.</code><code class="descname">context</code><span class="sig-paren">(</span><em>style</em>, <em>after_reset=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/style/core.html#context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.style.context" title="Permalink to this definition">¶</a></dt>
<dd><p>Context manager for using style settings temporarily.</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>style</strong><span class="classifier">str, dict, Path or list</span></dt><dd><p>A style specification. Valid options are:</p>
<table border="1" class="docutils align-default">
<colgroup>
<col width="9%" />
<col width="91%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>str</td>
<td>The name of a style or a path/URL to a style file. For a
list of available style names, see <code class="xref py py-obj docutils literal notranslate"><span class="pre">style.available</span></code>.</td>
</tr>
<tr class="row-even"><td>dict</td>
<td>Dictionary with valid key/value pairs for
<a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.rcParams</span></code></a>.</td>
</tr>
<tr class="row-odd"><td>Path</td>
<td>A path-like object which is a path to a style file.</td>
</tr>
<tr class="row-even"><td>list</td>
<td>A list of style specifiers (str, Path or dict) applied from
first to last in the list.</td>
</tr>
</tbody>
</table>
</dd>
<dt><strong>after_reset</strong><span class="classifier">bool</span></dt><dd><p>If True, apply style after resetting settings to their defaults;
otherwise, apply style on top of the current settings.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.style.reload_library">
<code class="descclassname">matplotlib.style.</code><code class="descname">reload_library</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/style/core.html#reload_library"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.style.reload_library" title="Permalink to this definition">¶</a></dt>
<dd><p>Reload the style library.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.style.use">
<code class="descclassname">matplotlib.style.</code><code class="descname">use</code><span class="sig-paren">(</span><em>style</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/style/core.html#use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.style.use" title="Permalink to this definition">¶</a></dt>
<dd><p>Use Matplotlib style settings from a style specification.</p>
<p>The style name of 'default' is reserved for reverting back to
the default style settings.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This updates the <a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a> with the settings from the style.
<a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a> not defined in the style are kept.</p>
</div>
<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>style</strong><span class="classifier">str, dict, Path or list</span></dt><dd><p>A style specification. Valid options are:</p>
<table border="1" class="docutils align-default">
<colgroup>
<col width="9%" />
<col width="91%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>str</td>
<td>The name of a style or a path/URL to a style file. For a
list of available style names, see <code class="xref py py-obj docutils literal notranslate"><span class="pre">style.available</span></code>.</td>
</tr>
<tr class="row-even"><td>dict</td>
<td>Dictionary with valid key/value pairs for
<a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.rcParams</span></code></a>.</td>
</tr>
<tr class="row-odd"><td>Path</td>
<td>A path-like object which is a path to a style file.</td>
</tr>
<tr class="row-even"><td>list</td>
<td>A list of style specifiers (str, Path or dict) applied from
first to last in the list.</td>
</tr>
</tbody>
</table>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="data">
<dt id="matplotlib.style.matplotlib.style.library">
<code class="descclassname">matplotlib.style.</code><code class="descname">library</code><a class="headerlink" href="#matplotlib.style.matplotlib.style.library" title="Permalink to this definition">¶</a></dt>
<dd><p>A dict mapping from style name to <a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.RcParams" title="matplotlib.RcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RcParams</span></code></a> defining that style.</p>
<p>This is meant to be read-only. Use <a class="reference internal" href="#matplotlib.style.reload_library" title="matplotlib.style.reload_library"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reload_library</span></code></a> to update.</p>
</dd></dl>
<dl class="data">
<dt id="matplotlib.style.matplotlib.style.available">
<code class="descclassname">matplotlib.style.</code><code class="descname">available</code><a class="headerlink" href="#matplotlib.style.matplotlib.style.available" title="Permalink to this definition">¶</a></dt>
<dd><p>List of the names of the available styles.</p>
<p>This is meant to be read-only. Use <a class="reference internal" href="#matplotlib.style.reload_library" title="matplotlib.style.reload_library"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reload_library</span></code></a> to update.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2020 The Matplotlib development team.
<br />
Last updated on Jul 17, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
Doc version v3.3.0-3-g8994f1b60.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.