-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathcategory_api.html
More file actions
349 lines (318 loc) · 22 KB
/
category_api.html
File metadata and controls
349 lines (318 loc) · 22 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
<!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" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>matplotlib.category — Matplotlib 3.3.4 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.4" 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" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-rendered-html.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.3.4 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.cbook" href="cbook_api.html" />
<link rel="prev" title="matplotlib.blocking_input" href="blocking_input_api.html" />
<link rel="top" title="Matplotlib 3.3.4 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/category_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.4). For the latest version see <a href="https://matplotlib.org/stable/api/category_api.html">https://matplotlib.org/stable/api/category_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.4</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="cbook_api.html" title="matplotlib.cbook"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="blocking_input_api.html" title="matplotlib.blocking_input"
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>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.category</span></code></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="blocking_input_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.blocking_input</span></code></a></li>
<li>Next: <a href="cbook_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.cbook</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/category_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="module-matplotlib.category">
<span id="matplotlib-category"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.category</span></code><a class="headerlink" href="#module-matplotlib.category" title="Permalink to this headline">¶</a></h1>
<p>Plotting of string "category" data: <code class="docutils literal notranslate"><span class="pre">plot(['d',</span> <span class="pre">'f',</span> <span class="pre">'a'],</span> <span class="pre">[1,</span> <span class="pre">2,</span> <span class="pre">3])</span></code> will
plot three points with x-axis values of 'd', 'f', 'a'.</p>
<p>See <a class="reference internal" href="../gallery/lines_bars_and_markers/categorical_variables.html"><span class="doc">Plotting categorical variables</span></a> for an
example.</p>
<p>The module uses Matplotlib's <a class="reference internal" href="units_api.html#module-matplotlib.units" title="matplotlib.units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.units</span></code></a> mechanism to convert from
strings to integers and provides a tick locator, a tick formatter, and the
<a class="reference internal" href="#matplotlib.category.UnitData" title="matplotlib.category.UnitData"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnitData</span></code></a> class that creates and stores the string-to-integer mapping.</p>
<dl class="py class">
<dt id="matplotlib.category.StrCategoryConverter">
<em class="property">class </em><code class="descclassname">matplotlib.category.</code><code class="descname">StrCategoryConverter</code><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryConverter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryConverter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="units_api.html#matplotlib.units.ConversionInterface" title="matplotlib.units.ConversionInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.units.ConversionInterface</span></code></a></p>
<dl class="py method">
<dt id="matplotlib.category.StrCategoryConverter.axisinfo">
<em class="property">static </em><code class="descname">axisinfo</code><span class="sig-paren">(</span><em><span class="n">unit</span></em>, <em><span class="n">axis</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryConverter.axisinfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryConverter.axisinfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the default axis ticks and labels.</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>unit</strong><span class="classifier"><a class="reference internal" href="#matplotlib.category.UnitData" title="matplotlib.category.UnitData"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnitData</span></code></a></span></dt><dd><p>object string unit information for value</p>
</dd>
<dt><strong>axis</strong><span class="classifier"><a class="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a></span></dt><dd><p>axis for which information is being set</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><a class="reference internal" href="units_api.html#matplotlib.units.AxisInfo" title="matplotlib.units.AxisInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AxisInfo</span></code></a></dt><dd><p>Information to support default tick labeling</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.category.StrCategoryConverter.convert">
<em class="property">static </em><code class="descname">convert</code><span class="sig-paren">(</span><em><span class="n">value</span></em>, <em><span class="n">unit</span></em>, <em><span class="n">axis</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryConverter.convert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryConverter.convert" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert strings in <em>value</em> to floats using mapping information stored
in the <em>unit</em> 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>value</strong><span class="classifier">str or iterable</span></dt><dd><p>Value or list of values to be converted.</p>
</dd>
<dt><strong>unit</strong><span class="classifier"><a class="reference internal" href="#matplotlib.category.UnitData" title="matplotlib.category.UnitData"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnitData</span></code></a></span></dt><dd><p>An object mapping strings to integers.</p>
</dd>
<dt><strong>axis</strong><span class="classifier"><a class="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a></span></dt><dd><p>The axis on which the converted value is plotted.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><em>axis</em> is unused.</p>
</div>
</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>float or ndarray[float]</dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.category.StrCategoryConverter.default_units">
<em class="property">static </em><code class="descname">default_units</code><span class="sig-paren">(</span><em><span class="n">data</span></em>, <em><span class="n">axis</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryConverter.default_units"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryConverter.default_units" title="Permalink to this definition">¶</a></dt>
<dd><p>Set and update the <a class="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a> units.</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>data</strong><span class="classifier">str or iterable of str</span></dt><dd></dd>
<dt><strong>axis</strong><span class="classifier"><a class="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a></span></dt><dd><p>axis on which the data is plotted</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><a class="reference internal" href="#matplotlib.category.UnitData" title="matplotlib.category.UnitData"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnitData</span></code></a></dt><dd><p>object storing string to integer mapping</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.category.StrCategoryFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.category.</code><code class="descname">StrCategoryFormatter</code><span class="sig-paren">(</span><em><span class="n">units_mapping</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>String representation of the data at every tick.</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>units_mapping</strong><span class="classifier">dict</span></dt><dd><p>Mapping of category names (str) to indices (int).</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.category.StrCategoryFormatter.format_ticks">
<code class="descname">format_ticks</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">values</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryFormatter.format_ticks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryFormatter.format_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tick labels for all the ticks at once.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.category.StrCategoryLocator">
<em class="property">class </em><code class="descclassname">matplotlib.category.</code><code class="descname">StrCategoryLocator</code><span class="sig-paren">(</span><em><span class="n">units_mapping</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryLocator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Tick at every integer mapping of the string data.</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>units_mapping</strong><span class="classifier">dict</span></dt><dd><p>Mapping of category names (str) to indices (int).</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.category.StrCategoryLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">vmin</span></em>, <em><span class="n">vmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryLocator.tick_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the values of the located ticks given <strong>vmin</strong> and <strong>vmax</strong>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>To get tick locations with the vmin and vmax values defined
automatically for the associated <code class="xref py py-attr docutils literal notranslate"><span class="pre">axis</span></code> simply call
the Locator instance:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">loc</span><span class="p">))</span>
<span class="go"><type 'Locator'></span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">loc</span><span class="p">())</span>
<span class="go">[1, 2, 3, 4]</span>
</pre></div>
</div>
</div>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.category.UnitData">
<em class="property">class </em><code class="descclassname">matplotlib.category.</code><code class="descname">UnitData</code><span class="sig-paren">(</span><em><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#UnitData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.UnitData" 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.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Create mapping between unique categorical values and integer ids.</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>data</strong><span class="classifier">iterable</span></dt><dd><p>sequence of string values</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.category.UnitData.update">
<code class="descname">update</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">data</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#UnitData.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.UnitData.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Map new values to integer identifiers.</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>data</strong><span class="classifier">iterable of str or bytes</span></dt><dd></dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><dl class="first last docutils">
<dt>TypeError</dt><dd><p>If elements in <em>data</em> are neither str nor bytes.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</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 - 2021 The Matplotlib development team.
<br />
Last updated on Jan 28, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.
Doc version v3.3.4.
</div>
</footer>
</body>
</html>