matplotlib.github.com/2.2.3/api/patches_api.html at refs/heads/main · matplotlib/matplotlib.github.com · GitHub

History

253 lines (229 loc) · 17.6 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

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

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

<head>

<title>patches — Matplotlib 2.2.3 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.2.3',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.2.3 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.3). 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 style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.3</span></div>

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

</div>

<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="_as_gen/matplotlib.patches.Arc.html" title="matplotlib.patches.Arc"

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

<a href="offsetbox_api.html" title="offsetbox"

accesskey="P">previous</a> |</li>

<li><a href="../gallery/index.html">examples</a>| </li>

<li><a href="../tutorials/index.html">tutorials</a>| </li>

<li><a href="pyplot_summary.html">pyplot</a>| </li>

<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<h3><a href="../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">patches</a><ul>

<li><a class="reference internal" href="#module-matplotlib.patches"><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>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

<li><a href="../contents.html">Documentation overview</a><ul>

<li><a href="index.html">The Matplotlib API</a><ul>

<li>Previous: <a href="offsetbox_api.html" title="previous chapter">offsetbox</a></li>

<li>Next: <a href="_as_gen/matplotlib.patches.Arc.html" title="next chapter">matplotlib.patches.Arc</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/patches_api.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<h1>patches<a class="headerlink" href="#patches" title="Permalink to this headline">¶</a></h1>

<span id="matplotlib-patches"></span><h2><a class="reference internal" href="#module-matplotlib.patches" title="matplotlib.patches"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.patches</span></code></a><a class="headerlink" href="#module-matplotlib.patches" title="Permalink to this headline">¶</a></h2>

<h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h3>

</colgroup>

<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.</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></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-class 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></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-class 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-class 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 <a class="reference internal" href="_as_gen/matplotlib.patches.ConnectionPatch.html#matplotlib.patches.ConnectionPatch" title="matplotlib.patches.ConnectionPatch"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionPatch</span></code></a> class is to make connecting lines between 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></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-class 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>Draw a fancy box around a rectangle with lower left at <em>xy*=(*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.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-even"><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>Draw a rectangle with lower left at <em>xy</em> = (<em>x</em>, <em>y</em>) with specified <em>width</em>, <em>height</em> and rotation <em>angle</em>.</td>

</tr>

<tr class="row-odd"><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-even"><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> offset by <em>ox</em>, <em>oy</em>.</td>

</tr>

<tr class="row-odd"><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>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.YAArrow.html#matplotlib.patches.YAArrow" title="matplotlib.patches.YAArrow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">YAArrow</span></code></a>(figure, xytip, xybase[, width, ...])</td>

<td>Yet another arrow class.</td>

</tr>

</tbody>

</table>

</div>

<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3>

</colgroup>

<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>This is a debug function to draw a rectangle around the bounding box returned by <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-meth docutils literal notranslate"><span class="pre">get_window_extent()</span></code></a> of an artist, 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>

</tr>

</tbody>

</table>

</div>

</div>

<br />

Last updated on Aug 11, 2018.

Created using

<ahref="http://sphinx-doc.org/">Sphinx</a> 1.7.6.

Doc version v2.2.3-1-gd47e15e7a.

</div>

</body>

</footer>

</html>

matplotlib.github.com/2.2.3/api/patches_api.html at refs/heads/main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

patches_api.html

Latest commit

History

Breadcrumbs

patches_api.html

File metadata and controls