{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathpatheffects_api.html
More file actions
486 lines (436 loc) · 28.7 KB
/
Copy pathpatheffects_api.html
File metadata and controls
486 lines (436 loc) · 28.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
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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
<!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="Content-Type" content="text/html; charset=utf-8" />
<title>patheffects — Matplotlib 1.5.3 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.5.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.5.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="Matplotlib 1.5.3 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="projections" href="projections_api.html" />
<link rel="prev" title="path" href="path_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/patheffects_api.html" />
<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 (v1.5.3). For the latest version see <a href="https://matplotlib.org/stable/api/patheffects_api.html">https://matplotlib.org/stable/api/patheffects_api.html</a></div>
<div class="alert" style="background-color: #FEA46C; padding: 10px 0;
">
<h2>Matplotlib 2.0.0rc2 is available</h2>
<p><a href="../style_changes.html"
style="font-weight: bold;
color: #11557C;">Install the release candidate now!</a></p>
</div>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<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="projections_api.html" title="projections"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="path_api.html" title="path"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<a href="http://depsy.org/package/python/matplotlib">
<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">patheffects</a><ul>
<li><a class="reference internal" href="#module-matplotlib.patheffects"><code class="docutils literal"><span class="pre">matplotlib.patheffects</span></code></a></li>
</ul>
</li>
</ul>
<div class="relations">
<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="path_api.html" title="previous chapter">path</a></li>
<li>Next: <a href="projections_api.html" title="next chapter">projections</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/patheffects_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="patheffects">
<h1>patheffects<a class="headerlink" href="#patheffects" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.patheffects">
<span id="matplotlib-patheffects"></span><h2><a class="reference internal" href="../users/patheffects_guide.html#module-matplotlib.patheffects" title="matplotlib.patheffects"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.patheffects</span></code></a><a class="headerlink" href="#module-matplotlib.patheffects" title="Permalink to this headline">¶</a></h2>
<p>Defines classes for path effects. The path effects are supported in
<a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal"><span class="pre">Text</span></code></a>, <a class="reference internal" href="lines_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal"><span class="pre">Line2D</span></code></a>
and <a class="reference internal" href="patches_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal"><span class="pre">Patch</span></code></a>.</p>
<dl class="class">
<dt id="matplotlib.patheffects.AbstractPathEffect">
<em class="property">class </em><code class="descclassname">matplotlib.patheffects.</code><code class="descname">AbstractPathEffect</code><span class="sig-paren">(</span><em>offset=(0.0</em>, <em>0.0)</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.AbstractPathEffect" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A base class for path effects.</p>
<p>Subclasses should override the <code class="docutils literal"><span class="pre">draw_path</span></code> method to add effect
functionality.</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"><p class="first"><strong>offset</strong> : pair of floats</p>
<blockquote class="last">
<div><p>The offset to apply to the path, measured in points.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.patheffects.AbstractPathEffect.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.AbstractPathEffect.draw_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Derived should override this method. The arguments are the same
as <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase.draw_path" title="matplotlib.backend_bases.RendererBase.draw_path"><code class="xref py py-meth docutils literal"><span class="pre">matplotlib.backend_bases.RendererBase.draw_path()</span></code></a>
except the first argument is a renderer.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.patheffects.Normal">
<em class="property">class </em><code class="descclassname">matplotlib.patheffects.</code><code class="descname">Normal</code><span class="sig-paren">(</span><em>offset=(0.0</em>, <em>0.0)</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.Normal" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.AbstractPathEffect</span></code></a></p>
<p>The “identity” PathEffect.</p>
<p>The Normal PathEffect’s sole purpose is to draw the original artist with
no special path effect.</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"><p class="first"><strong>offset</strong> : pair of floats</p>
<blockquote class="last">
<div><p>The offset to apply to the path, measured in points.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="matplotlib.patheffects.PathEffectRenderer">
<em class="property">class </em><code class="descclassname">matplotlib.patheffects.</code><code class="descname">PathEffectRenderer</code><span class="sig-paren">(</span><em>path_effects</em>, <em>renderer</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.PathEffectRenderer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.backend_bases.RendererBase</span></code></a></p>
<p>Implements a Renderer which contains another renderer.</p>
<p>This proxy then intercepts draw calls, calling the appropriate
<a class="reference internal" href="#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-class docutils literal"><span class="pre">AbstractPathEffect</span></code></a> draw method.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Not all methods have been overridden on this RendererBase subclass.
It may be necessary to add further methods to extend the PathEffects
capabilities further.</p>
</div>
<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"><p class="first"><strong>path_effects</strong> : iterable of <a class="reference internal" href="#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-class docutils literal"><span class="pre">AbstractPathEffect</span></code></a></p>
<blockquote>
<div><p>The path effects which this renderer represents.</p>
</div></blockquote>
<p class="last"><strong>renderer</strong> : <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.backend_bases.RendererBase</span></code></a> instance</p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.patheffects.PathEffectRenderer.copy_with_path_effect">
<code class="descname">copy_with_path_effect</code><span class="sig-paren">(</span><em>path_effects</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.copy_with_path_effect" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.patheffects.PathEffectRenderer.draw_markers">
<code class="descname">draw_markers</code><span class="sig-paren">(</span><em>gc</em>, <em>marker_path</em>, <em>marker_trans</em>, <em>path</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.draw_markers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.patheffects.PathEffectRenderer.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.draw_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.patheffects.PathEffectRenderer.draw_path_collection">
<code class="descname">draw_path_collection</code><span class="sig-paren">(</span><em>gc</em>, <em>master_transform</em>, <em>paths</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.draw_path_collection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.patheffects.PathEffectRenderer.new_gc">
<code class="descname">new_gc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.new_gc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.patheffects.PathEffectRenderer.points_to_pixels">
<code class="descname">points_to_pixels</code><span class="sig-paren">(</span><em>points</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.points_to_pixels" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.patheffects.PathPatchEffect">
<em class="property">class </em><code class="descclassname">matplotlib.patheffects.</code><code class="descname">PathPatchEffect</code><span class="sig-paren">(</span><em>offset=(0</em>, <em>0)</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.PathPatchEffect" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.AbstractPathEffect</span></code></a></p>
<p>Draws a <a class="reference internal" href="patches_api.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><code class="xref py py-class docutils literal"><span class="pre">PathPatch</span></code></a> instance whose Path
comes from the original PathEffect artist.</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"><p class="first"><strong>offset</strong> : pair of floats</p>
<blockquote>
<div><p>The offset to apply to the path, in points.</p>
</div></blockquote>
<p><strong>**kwargs :</strong></p>
<blockquote class="last">
<div><p>All keyword arguments are passed through to the
<a class="reference internal" href="patches_api.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><code class="xref py py-class docutils literal"><span class="pre">PathPatch</span></code></a> constructor. The
properties which cannot be overridden are “path”, “clip_box”
“transform” and “clip_path”.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.patheffects.PathPatchEffect.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.PathPatchEffect.draw_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.patheffects.SimpleLineShadow">
<em class="property">class </em><code class="descclassname">matplotlib.patheffects.</code><code class="descname">SimpleLineShadow</code><span class="sig-paren">(</span><em>offset=(2</em>, <em>-2)</em>, <em>shadow_color='k'</em>, <em>alpha=0.3</em>, <em>rho=0.3</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.SimpleLineShadow" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.AbstractPathEffect</span></code></a></p>
<p>A simple shadow via a line.</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"><p class="first"><strong>offset</strong> : pair of floats</p>
<blockquote>
<div><p>The offset to apply to the path, in points.</p>
</div></blockquote>
<p><strong>shadow_color</strong> : color</p>
<blockquote>
<div><p>The shadow color. Default is black.
A value of <code class="docutils literal"><span class="pre">None</span></code> takes the original artist’s color
with a scale factor of <code class="xref py py-obj docutils literal"><span class="pre">rho</span></code>.</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>The alpha transparency of the created shadow patch.
Default is 0.3.</p>
</div></blockquote>
<p><strong>rho</strong> : float</p>
<blockquote>
<div><p>A scale factor to apply to the rgbFace color if <code class="xref py py-obj docutils literal"><span class="pre">shadow_rgbFace</span></code>
is <code class="docutils literal"><span class="pre">None</span></code>. Default is 0.3.</p>
</div></blockquote>
<p><strong>**kwargs</strong></p>
<blockquote class="last">
<div><p>Extra keywords are stored and passed through to
<code class="xref py py-meth docutils literal"><span class="pre">AbstractPathEffect._update_gc()</span></code>.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.patheffects.SimpleLineShadow.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.SimpleLineShadow.draw_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Overrides the standard draw_path to add the shadow offset and
necessary color changes for the shadow.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.patheffects.SimplePatchShadow">
<em class="property">class </em><code class="descclassname">matplotlib.patheffects.</code><code class="descname">SimplePatchShadow</code><span class="sig-paren">(</span><em>offset=(2</em>, <em>-2)</em>, <em>shadow_rgbFace=None</em>, <em>alpha=None</em>, <em>rho=0.3</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.SimplePatchShadow" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.AbstractPathEffect</span></code></a></p>
<p>A simple shadow via a filled patch.</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"><p class="first"><strong>offset</strong> : pair of floats</p>
<blockquote>
<div><p>The offset of the shadow in points.</p>
</div></blockquote>
<p><strong>shadow_rgbFace</strong> : color</p>
<blockquote>
<div><p>The shadow color.</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>The alpha transparency of the created shadow patch.
Default is 0.3.
<a class="reference external" href="http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html">http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html</a></p>
</div></blockquote>
<p><strong>rho</strong> : float</p>
<blockquote>
<div><p>A scale factor to apply to the rgbFace color if <code class="xref py py-obj docutils literal"><span class="pre">shadow_rgbFace</span></code>
is not specified. Default is 0.3.</p>
</div></blockquote>
<p><strong>**kwargs</strong></p>
<blockquote class="last">
<div><p>Extra keywords are stored and passed through to
<code class="xref py py-meth docutils literal"><span class="pre">AbstractPathEffect._update_gc()</span></code>.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.patheffects.SimplePatchShadow.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.SimplePatchShadow.draw_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Overrides the standard draw_path to add the shadow offset and
necessary color changes for the shadow.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.patheffects.Stroke">
<em class="property">class </em><code class="descclassname">matplotlib.patheffects.</code><code class="descname">Stroke</code><span class="sig-paren">(</span><em>offset=(0</em>, <em>0)</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.Stroke" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.AbstractPathEffect</span></code></a></p>
<p>A line based PathEffect which re-draws a stroke.</p>
<p>The path will be stroked with its gc updated with the given
keyword arguments, i.e., the keyword arguments should be valid
gc parameter values.</p>
<dl class="method">
<dt id="matplotlib.patheffects.Stroke.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.Stroke.draw_path" title="Permalink to this definition">¶</a></dt>
<dd><p>draw the path with updated gc.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.patheffects.withSimplePatchShadow">
<em class="property">class </em><code class="descclassname">matplotlib.patheffects.</code><code class="descname">withSimplePatchShadow</code><span class="sig-paren">(</span><em>offset=(2</em>, <em>-2)</em>, <em>shadow_rgbFace=None</em>, <em>alpha=None</em>, <em>rho=0.3</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.withSimplePatchShadow" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.patheffects.SimplePatchShadow" title="matplotlib.patheffects.SimplePatchShadow"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.SimplePatchShadow</span></code></a></p>
<p>Adds a simple <a class="reference internal" href="#matplotlib.patheffects.SimplePatchShadow" title="matplotlib.patheffects.SimplePatchShadow"><code class="xref py py-class docutils literal"><span class="pre">SimplePatchShadow</span></code></a> and then draws the
original Artist to avoid needing to call <a class="reference internal" href="#matplotlib.patheffects.Normal" title="matplotlib.patheffects.Normal"><code class="xref py py-class docutils literal"><span class="pre">Normal</span></code></a>.</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"><p class="first"><strong>offset</strong> : pair of floats</p>
<blockquote>
<div><p>The offset of the shadow in points.</p>
</div></blockquote>
<p><strong>shadow_rgbFace</strong> : color</p>
<blockquote>
<div><p>The shadow color.</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>The alpha transparency of the created shadow patch.
Default is 0.3.
<a class="reference external" href="http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html">http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html</a></p>
</div></blockquote>
<p><strong>rho</strong> : float</p>
<blockquote>
<div><p>A scale factor to apply to the rgbFace color if <code class="xref py py-obj docutils literal"><span class="pre">shadow_rgbFace</span></code>
is not specified. Default is 0.3.</p>
</div></blockquote>
<p><strong>**kwargs</strong></p>
<blockquote class="last">
<div><p>Extra keywords are stored and passed through to
<code class="xref py py-meth docutils literal"><span class="pre">AbstractPathEffect._update_gc()</span></code>.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.patheffects.withSimplePatchShadow.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.withSimplePatchShadow.draw_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.patheffects.withStroke">
<em class="property">class </em><code class="descclassname">matplotlib.patheffects.</code><code class="descname">withStroke</code><span class="sig-paren">(</span><em>offset=(0</em>, <em>0)</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.withStroke" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.patheffects.Stroke" title="matplotlib.patheffects.Stroke"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.Stroke</span></code></a></p>
<p>Adds a simple <a class="reference internal" href="#matplotlib.patheffects.Stroke" title="matplotlib.patheffects.Stroke"><code class="xref py py-class docutils literal"><span class="pre">Stroke</span></code></a> and then draws the
original Artist to avoid needing to call <a class="reference internal" href="#matplotlib.patheffects.Normal" title="matplotlib.patheffects.Normal"><code class="xref py py-class docutils literal"><span class="pre">Normal</span></code></a>.</p>
<p>The path will be stroked with its gc updated with the given
keyword arguments, i.e., the keyword arguments should be valid
gc parameter values.</p>
<dl class="method">
<dt id="matplotlib.patheffects.withStroke.draw_path">
<code class="descname">draw_path</code><span class="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.patheffects.withStroke.draw_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the matplotlib development team; 2012 - 2014 The matplotlib development team.
Last updated on Dec 19, 2016.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.4.3.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.