matplotlib.github.com/3.3.0/api/textpath_api.html at gh-pages · matplotlib/matplotlib.github.com

History

317 lines (278 loc) · 22.4 KB

Raw

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.textpath — Matplotlib 3.3.0 documentation</title>

title="Search within Matplotlib 3.3.0 documentation"

href="../_static/opensearch.xml"/>

</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>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.3.0</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<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>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="ticker_api.html" title="matplotlib.ticker"

accesskey="N">next</a> |</li>

<a href="texmanager_api.html" title="matplotlib.texmanager"

accesskey="P">previous</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>

<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">matplotlib.texmanager</code></a></li>

<li>Next: <a href="ticker_api.html" title="next chapter"><code class="docutils literal notranslate">matplotlib.ticker</code></a></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>

<h1><code class="docutils literal notranslate">matplotlib.textpath</code><a class="headerlink" href="#module-matplotlib.textpath" title="Permalink to this headline">¶</a></h1>

class <code class="descclassname">matplotlib.textpath.</code><code class="descname">TextPath</code>(xy, s, size=None, prop=None, _interpolation_steps=1, usetex=False)<a class="reference internal" href="../_modules/matplotlib/textpath.html#TextPath">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextPath" title="Permalink to this definition">¶</a></dt>

<dd>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">matplotlib.path.Path</code></a>

Create a path from the text.

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">PathPatch</code></a> (or other artists)

to draw this path onto the canvas.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>xytuple or array of two float values</dt><dd>Position of the text. For no offset, use <code class="docutils literal notranslate">xy=(0, 0)</code>.

</dd>

<dt>sstr</dt><dd>The text to convert to a path.

</dd>

<dt>sizefloat, optional</dt><dd>Font size in points. Defaults to the size specified via the font

properties prop.

</dd>

<dt>prop<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">matplotlib.font_manager.FontProperties</code></a>, optional</dt><dd>Font property. If not provided, will use a default

<code class="docutils literal notranslate">FontProperties</code> with parameters from the

<a class="reference internal" href="../tutorials/introductory/customizing.html#matplotlib-rcparams">rcParams</a>.

</dd>

<dt>_interpolation_stepsint, optional</dt><dd>(Currently ignored)

</dd>

<dt>usetexbool, default: False</dt><dd>Whether to use tex rendering.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Examples

The following creates a path from the string "ABC" with Helvetica

font face; and another path from the latex fraction 1/2:

<div class="highlight-default notranslate"><div class="highlight"><pre>from matplotlib.textpath import TextPath

from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Helvetica", style="italic")

path1 = TextPath((12, 12), "ABC", size=12, prop=fp)

path2 = TextPath((0, 0), r"$\frac{1}{2}$", size=12, usetex=True)

</pre></div>

</div>

Also see <a class="reference internal" href="../gallery/text_labels_and_annotations/demo_text_path.html">Demo Text Path</a>.

property <code class="descname">codes</code><a class="headerlink" href="#matplotlib.textpath.TextPath.codes" title="Permalink to this definition">¶</a></dt>

<dd>Return the codes

</dd></dl>

<code class="descname">get_size</code>(self)<a class="reference internal" href="../_modules/matplotlib/textpath.html#TextPath.get_size">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextPath.get_size" title="Permalink to this definition">¶</a></dt>

<dd>Get the text size.

</dd></dl>

<code class="descname">set_size</code>(self, size)<a class="reference internal" href="../_modules/matplotlib/textpath.html#TextPath.set_size">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextPath.set_size" title="Permalink to this definition">¶</a></dt>

<dd>Set the text size.

</dd></dl>

property <code class="descname">vertices</code><a class="headerlink" href="#matplotlib.textpath.TextPath.vertices" title="Permalink to this definition">¶</a></dt>

<dd>Return the cached path after updating it if necessary.

</dd></dl>

class <code class="descclassname">matplotlib.textpath.</code><code class="descname">TextToPath</code><a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextToPath" title="Permalink to this definition">¶</a></dt>

<dd>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">object</code></a>

A class that converts strings to paths.

<code class="descname">FONT_SCALE</code> = 100.0<a class="headerlink" href="#matplotlib.textpath.TextToPath.FONT_SCALE" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_glyphs_mathtext</code>(self, prop, s, glyph_map=None, return_new_glyphs_only=False)<a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_glyphs_mathtext">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_glyphs_mathtext" title="Permalink to this definition">¶</a></dt>

<dd>Parse mathtext string s and convert it to a (vertices, codes) pair.

</dd></dl>

<code class="descname">get_glyphs_tex</code>(self, prop, s, glyph_map=None, return_new_glyphs_only=False)<a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_glyphs_tex">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_glyphs_tex" title="Permalink to this definition">¶</a></dt>

<dd>Convert the string s to vertices and codes using usetex mode.

</dd></dl>

<code class="descname">get_glyphs_with_font</code>(self, font, s, glyph_map=None, return_new_glyphs_only=False)<a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_glyphs_with_font">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_glyphs_with_font" title="Permalink to this definition">¶</a></dt>

<dd>Convert string s to vertices and codes using the provided ttf font.

</dd></dl>

<code class="descname">get_texmanager</code>(self)<a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_texmanager">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_texmanager" title="Permalink to this definition">¶</a></dt>

<dd>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">TexManager</code></a> instance.

</dd></dl>

<code class="descname">get_text_path</code>(self, prop, s, ismath=False)<a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_text_path">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_text_path" title="Permalink to this definition">¶</a></dt>

<dd>Convert text s to path (a tuple of vertices and codes for

matplotlib.path.Path).

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>prop<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">FontProperties</code></a></dt><dd>The font properties for the text.

</dd>

<dt>sstr</dt><dd>The text to be converted.

</dd>

<dt>ismath{False, True, "TeX"}</dt><dd>If True, use mathtext parser. If "TeX", use tex for rendering.

</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>vertslist</dt><dd>A list of numpy arrays containing the x and y coordinates of the

vertices.

</dd>

<dt>codeslist</dt><dd>A list of path codes.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Examples

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">Path</code></a>

from those:

<div class="highlight-default notranslate"><div class="highlight"><pre>from matplotlib.path import Path

from matplotlib.textpath import TextToPath

from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Humor Sans", style="italic")

verts, codes = TextToPath().get_text_path(fp, "ABC")

path = Path(verts, codes, closed=False)

</pre></div>

</div>

Also see <a class="reference internal" href="#matplotlib.textpath.TextPath" title="matplotlib.textpath.TextPath"><code class="xref py py-obj docutils literal notranslate">TextPath</code></a> for a more direct way to create a path from a text.

</dd></dl>

<code class="descname">get_text_width_height_descent</code>(self, s, prop, ismath)<a class="reference internal" href="../_modules/matplotlib/textpath.html#TextToPath.get_text_width_height_descent">[source]</a><a class="headerlink" href="#matplotlib.textpath.TextToPath.get_text_width_height_descent" title="Permalink to this definition">¶</a></dt>

</dd></dl>

</div>

</div>

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>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

textpath_api.html

Latest commit

History

textpath_api.html

File metadata and controls