-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathpatches_api.html
More file actions
236 lines (214 loc) · 17.7 KB
/
patches_api.html
File metadata and controls
236 lines (214 loc) · 17.7 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
<!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.patches — Matplotlib 3.4.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.4.0-2-gcb03754703" 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/plot_directive.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 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.4.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.patches.Arc" href="_as_gen/matplotlib.patches.Arc.html" />
<link rel="prev" title="matplotlib.offsetbox" href="offsetbox_api.html" />
<link rel="top" title="Matplotlib 3.4.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/patches_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.4.0). For the latest version see <a href="https://matplotlib.org/stable/api/patches_api.html">https://matplotlib.org/stable/api/patches_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.4.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="_as_gen/matplotlib.patches.Arc.html" title="matplotlib.patches.Arc"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="offsetbox_api.html" title="matplotlib.offsetbox"
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.patches</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">matplotlib.patches</span></code></a><ul>
<li><a class="reference internal" href="#classes">Classes</a></li>
<li><a class="reference internal" href="#functions">Functions</a></li>
</ul>
</li>
</ul>
<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/patches_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.patches">
<span id="matplotlib-patches"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.patches</span></code><a class="headerlink" href="#module-matplotlib.patches" title="Permalink to this headline">¶</a></h1>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<table border="1" class="longtable docutils align-default">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Arc.html#matplotlib.patches.Arc" title="matplotlib.patches.Arc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Arc</span></code></a>(xy, width, height[, angle, theta1, theta2])</td>
<td>An elliptical arc, i.e. a segment of an ellipse.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Arrow.html#matplotlib.patches.Arrow" title="matplotlib.patches.Arrow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Arrow</span></code></a>(x, y, dx, dy[, width])</td>
<td>An arrow patch.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.ArrowStyle.html#matplotlib.patches.ArrowStyle" title="matplotlib.patches.ArrowStyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ArrowStyle</span></code></a>(stylename, **kw)</td>
<td><a class="reference internal" href="_as_gen/matplotlib.patches.ArrowStyle.html#matplotlib.patches.ArrowStyle" title="matplotlib.patches.ArrowStyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ArrowStyle</span></code></a> is a container class which defines several arrowstyle classes, which is used to create an arrow path along a given path.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.BoxStyle.html#matplotlib.patches.BoxStyle" title="matplotlib.patches.BoxStyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BoxStyle</span></code></a>(stylename, **kw)</td>
<td><a class="reference internal" href="_as_gen/matplotlib.patches.BoxStyle.html#matplotlib.patches.BoxStyle" title="matplotlib.patches.BoxStyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BoxStyle</span></code></a> is a container class which defines several boxstyle classes, which are used for <a class="reference internal" href="_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" title="matplotlib.patches.FancyBboxPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FancyBboxPatch</span></code></a>.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Circle.html#matplotlib.patches.Circle" title="matplotlib.patches.Circle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Circle</span></code></a>(xy[, radius])</td>
<td>A circle patch.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.CirclePolygon.html#matplotlib.patches.CirclePolygon" title="matplotlib.patches.CirclePolygon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CirclePolygon</span></code></a>(xy[, radius, resolution])</td>
<td>A polygon-approximation of a circle patch.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.ConnectionPatch.html#matplotlib.patches.ConnectionPatch" title="matplotlib.patches.ConnectionPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ConnectionPatch</span></code></a>(xyA, xyB, coordsA[, ...])</td>
<td>A patch that connects two points (possibly in different axes).</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.ConnectionStyle.html#matplotlib.patches.ConnectionStyle" title="matplotlib.patches.ConnectionStyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ConnectionStyle</span></code></a>(stylename, **kw)</td>
<td><a class="reference internal" href="_as_gen/matplotlib.patches.ConnectionStyle.html#matplotlib.patches.ConnectionStyle" title="matplotlib.patches.ConnectionStyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ConnectionStyle</span></code></a> is a container class which defines several connectionstyle classes, which is used to create a path between two points.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Ellipse.html#matplotlib.patches.Ellipse" title="matplotlib.patches.Ellipse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Ellipse</span></code></a>(xy, width, height[, angle])</td>
<td>A scale-free ellipse.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.FancyArrow.html#matplotlib.patches.FancyArrow" title="matplotlib.patches.FancyArrow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FancyArrow</span></code></a>(x, y, dx, dy[, width, ...])</td>
<td>Like Arrow, but lets you set head width and head height independently.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.FancyArrowPatch.html#matplotlib.patches.FancyArrowPatch" title="matplotlib.patches.FancyArrowPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FancyArrowPatch</span></code></a>([posA, posB, path, ...])</td>
<td>A fancy arrow patch.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" title="matplotlib.patches.FancyBboxPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FancyBboxPatch</span></code></a>(xy, width, height[, ...])</td>
<td>A fancy box around a rectangle with lower left at <em>xy</em> = (<em>x</em>, <em>y</em>) with specified width and height.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Patch</span></code></a>([edgecolor, facecolor, color, ...])</td>
<td>A patch is a 2D artist with a face color and an edge color.</td>
</tr>
<tr class="row-even"><td><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>(path, **kwargs)</td>
<td>A general polycurve path patch.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.StepPatch.html#matplotlib.patches.StepPatch" title="matplotlib.patches.StepPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StepPatch</span></code></a>(values, edges, *[, orientation, ...])</td>
<td>A path patch describing a stepwise constant function.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Polygon.html#matplotlib.patches.Polygon" title="matplotlib.patches.Polygon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Polygon</span></code></a>(xy[, closed])</td>
<td>A general polygon patch.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Rectangle</span></code></a>(xy, width, height[, angle])</td>
<td>A rectangle defined via an anchor point <em>xy</em> and its <em>width</em> and <em>height</em>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.RegularPolygon.html#matplotlib.patches.RegularPolygon" title="matplotlib.patches.RegularPolygon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RegularPolygon</span></code></a>(xy, numVertices[, radius, ...])</td>
<td>A regular polygon patch.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Shadow.html#matplotlib.patches.Shadow" title="matplotlib.patches.Shadow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Shadow</span></code></a>(patch, ox, oy[, props])</td>
<td>Create a shadow of the given <em>patch</em>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Wedge.html#matplotlib.patches.Wedge" title="matplotlib.patches.Wedge"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Wedge</span></code></a>(center, r, theta1, theta2[, width])</td>
<td>Wedge shaped patch.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>
<table border="1" class="longtable docutils align-default">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.bbox_artist.html#matplotlib.patches.bbox_artist" title="matplotlib.patches.bbox_artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bbox_artist</span></code></a>(artist, renderer[, props, fill])</td>
<td>A debug function to draw a rectangle around the bounding box returned by an artist's <a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_window_extent.html#matplotlib.artist.Artist.get_window_extent" title="matplotlib.artist.Artist.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist.get_window_extent</span></code></a> to test whether the artist is returning the correct bbox.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.draw_bbox.html#matplotlib.patches.draw_bbox" title="matplotlib.patches.draw_bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_bbox</span></code></a>(bbox, renderer[, color, trans])</td>
<td>A debug function to draw a rectangle around the bounding box returned by an artist's <a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_window_extent.html#matplotlib.artist.Artist.get_window_extent" title="matplotlib.artist.Artist.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist.get_window_extent</span></code></a> to test whether the artist is returning the correct bbox.</td>
</tr>
</tbody>
</table>
</div>
</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 Mar 26, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.
Doc version v3.4.0-2-gcb03754703.
</div>
</footer>
</body>
</html>