{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathtextpath_api.html
More file actions
308 lines (271 loc) · 22.1 KB
/
Copy pathtextpath_api.html
File metadata and controls
308 lines (271 loc) · 22.1 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
<!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.textpath — 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.ticker" href="ticker_api.html" />
<link rel="prev" title="matplotlib.texmanager" href="texmanager_api.html" />
<link rel="top" title="Matplotlib 3.3.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/textpath_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/textpath_api.html">https://matplotlib.org/stable/api/textpath_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="ticker_api.html" title="matplotlib.ticker"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="texmanager_api.html" title="matplotlib.texmanager"
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="texmanager_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.texmanager</span></code></a></li>
<li>Next: <a href="ticker_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.ticker</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/textpath_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.textpath">
<span id="matplotlib-textpath"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.textpath</span></code><a class="headerlink" href="#module-matplotlib.textpath" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="matplotlib.textpath.TextPath">
<em class="property">class </em><code class="descclassname">matplotlib.textpath.</code><code class="descname">TextPath</code><span class="sig-paren">(</span><em>xy</em>, <em>s</em>, <em>size=None</em>, <em>prop=None</em>, <em>_interpolation_steps=1</em>, <em>usetex=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextPath" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.path.Path</span></code></a></p>
<p>Create a path from the text.</p>
<p>Create a path from the text. Note that it simply is a path,
not an artist. You need to use the <a class="reference internal" href="_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PathPatch</span></code></a> (or other artists)
to draw this path onto the canvas.</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>xy</strong><span class="classifier">tuple or array of two float values</span></dt><dd><p>Position of the text. For no offset, use <code class="docutils literal notranslate"><span class="pre">xy=(0,</span> <span class="pre">0)</span></code>.</p>
</dd>
<dt><strong>s</strong><span class="classifier">str</span></dt><dd><p>The text to convert to a path.</p>
</dd>
<dt><strong>size</strong><span class="classifier">float, optional</span></dt><dd><p>Font size in points. Defaults to the size specified via the font
properties <em>prop</em>.</p>
</dd>
<dt><strong>prop</strong><span class="classifier"><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.font_manager.FontProperties</span></code></a>, optional</span></dt><dd><p>Font property. If not provided, will use a default
<code class="docutils literal notranslate"><span class="pre">FontProperties</span></code> with parameters from the
<a class="reference internal" href="../tutorials/introductory/customizing.html#matplotlib-rcparams"><span class="std std-ref">rcParams</span></a>.</p>
</dd>
<dt><strong>_interpolation_steps</strong><span class="classifier">int, optional</span></dt><dd><p>(Currently ignored)</p>
</dd>
<dt><strong>usetex</strong><span class="classifier">bool, default: False</span></dt><dd><p>Whether to use tex rendering.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<p>The following creates a path from the string "ABC" with Helvetica
font face; and another path from the latex fraction 1/2:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib.textpath</span> <span class="k">import</span> <span class="n">TextPath</span>
<span class="kn">from</span> <span class="nn">matplotlib.font_manager</span> <span class="k">import</span> <span class="n">FontProperties</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">FontProperties</span><span class="p">(</span><span class="n">family</span><span class="o">=</span><span class="s2">"Helvetica"</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="s2">"italic"</span><span class="p">)</span>
<span class="n">path1</span> <span class="o">=</span> <span class="n">TextPath</span><span class="p">((</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">),</span> <span class="s2">"ABC"</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="mi">12</span><span class="p">,</span> <span class="n">prop</span><span class="o">=</span><span class="n">fp</span><span class="p">)</span>
<span class="n">path2</span> <span class="o">=</span> <span class="n">TextPath</span><span class="p">((</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="sa">r</span><span class="s2">"$\frac</span><span class="si">{1}{2}</span><span class="s2">$"</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="mi">12</span><span class="p">,</span> <span class="n">usetex</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>Also see <a class="reference internal" href="../gallery/text_labels_and_annotations/demo_text_path.html"><span class="doc">Demo Text Path</span></a>.</p>
<dl class="method">
<dt id="matplotlib.textpath.TextPath.codes">
<em class="property">property </em><code class="descname">codes</code><a class="headerlink" href="#matplotlib.textpath.TextPath.codes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the codes</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.textpath.TextPath.get_size">
<code class="descname">get_size</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextPath.get_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextPath.get_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the text size.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.textpath.TextPath.set_size">
<code class="descname">set_size</code><span class="sig-paren">(</span><em>self</em>, <em>size</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextPath.set_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextPath.set_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text size.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.textpath.TextPath.vertices">
<em class="property">property </em><code class="descname">vertices</code><a class="headerlink" href="#matplotlib.textpath.TextPath.vertices" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the cached path after updating it if necessary.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.textpath.TextToPath">
<em class="property">class </em><code class="descclassname">matplotlib.textpath.</code><code class="descname">TextToPath</code><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextToPath" 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A class that converts strings to paths.</p>
<dl class="attribute">
<dt id="matplotlib.textpath.TextToPath.DPI">
<code class="descname">DPI</code><em class="property"> = 72</em><a class="headerlink" href="#matplotlib.textpath.TextToPath.DPI" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.textpath.TextToPath.FONT_SCALE">
<code class="descname">FONT_SCALE</code><em class="property"> = 100.0</em><a class="headerlink" href="#matplotlib.textpath.TextToPath.FONT_SCALE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.textpath.TextToPath.get_glyphs_mathtext">
<code class="descname">get_glyphs_mathtext</code><span class="sig-paren">(</span><em>self</em>, <em>prop</em>, <em>s</em>, <em>glyph_map=None</em>, <em>return_new_glyphs_only=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_glyphs_mathtext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_glyphs_mathtext" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse mathtext string <em>s</em> and convert it to a (vertices, codes) pair.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.textpath.TextToPath.get_glyphs_tex">
<code class="descname">get_glyphs_tex</code><span class="sig-paren">(</span><em>self</em>, <em>prop</em>, <em>s</em>, <em>glyph_map=None</em>, <em>return_new_glyphs_only=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_glyphs_tex"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_glyphs_tex" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the string <em>s</em> to vertices and codes using usetex mode.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.textpath.TextToPath.get_glyphs_with_font">
<code class="descname">get_glyphs_with_font</code><span class="sig-paren">(</span><em>self</em>, <em>font</em>, <em>s</em>, <em>glyph_map=None</em>, <em>return_new_glyphs_only=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_glyphs_with_font"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_glyphs_with_font" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert string <em>s</em> to vertices and codes using the provided ttf font.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.textpath.TextToPath.get_texmanager">
<code class="descname">get_texmanager</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_texmanager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_texmanager" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the cached <a class="reference internal" href="texmanager_api.html#matplotlib.texmanager.TexManager" title="matplotlib.texmanager.TexManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TexManager</span></code></a> instance.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.textpath.TextToPath.get_text_path">
<code class="descname">get_text_path</code><span class="sig-paren">(</span><em>self</em>, <em>prop</em>, <em>s</em>, <em>ismath=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_text_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_text_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert text <em>s</em> to path (a tuple of vertices and codes for
matplotlib.path.Path).</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>prop</strong><span class="classifier"><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a></span></dt><dd><p>The font properties for the text.</p>
</dd>
<dt><strong>s</strong><span class="classifier">str</span></dt><dd><p>The text to be converted.</p>
</dd>
<dt><strong>ismath</strong><span class="classifier">{False, True, "TeX"}</span></dt><dd><p>If True, use mathtext parser. If "TeX", use tex for rendering.</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>verts</strong><span class="classifier">list</span></dt><dd><p>A list of numpy arrays containing the x and y coordinates of the
vertices.</p>
</dd>
<dt><strong>codes</strong><span class="classifier">list</span></dt><dd><p>A list of path codes.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<p>Create a list of vertices and codes from a text, and create a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a>
from those:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib.path</span> <span class="k">import</span> <span class="n">Path</span>
<span class="kn">from</span> <span class="nn">matplotlib.textpath</span> <span class="k">import</span> <span class="n">TextToPath</span>
<span class="kn">from</span> <span class="nn">matplotlib.font_manager</span> <span class="k">import</span> <span class="n">FontProperties</span>
<span class="n">fp</span> <span class="o">=</span> <span class="n">FontProperties</span><span class="p">(</span><span class="n">family</span><span class="o">=</span><span class="s2">"Humor Sans"</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="s2">"italic"</span><span class="p">)</span>
<span class="n">verts</span><span class="p">,</span> <span class="n">codes</span> <span class="o">=</span> <span class="n">TextToPath</span><span class="p">()</span><span class="o">.</span><span class="n">get_text_path</span><span class="p">(</span><span class="n">fp</span><span class="p">,</span> <span class="s2">"ABC"</span><span class="p">)</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">verts</span><span class="p">,</span> <span class="n">codes</span><span class="p">,</span> <span class="n">closed</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
<p>Also see <a class="reference internal" href="#matplotlib.textpath.TextPath" title="matplotlib.textpath.TextPath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TextPath</span></code></a> for a more direct way to create a path from a text.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.textpath.TextToPath.get_text_width_height_descent">
<code class="descname">get_text_width_height_descent</code><span class="sig-paren">(</span><em>self</em>, <em>s</em>, <em>prop</em>, <em>ismath</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_text_width_height_descent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_text_width_height_descent" title="Permalink to this definition">¶</a></dt>
<dd></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 - 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.