<divid="unreleased-message"> You are reading an old version of the documentation (v1.5.3). For the latest version see <ahref="https://matplotlib.org/stable/api/patheffects_api.html">https://matplotlib.org/stable/api/patheffects_api.html</a></div>
<emclass="property">class </em><codeclass="descclassname">matplotlib.patheffects.</code><codeclass="descname">AbstractPathEffect</code><spanclass="sig-paren">(</span><em>offset=(0.0</em>, <em>0.0)</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.AbstractPathEffect" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw_path</code><spanclass="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace=None</em><spanclass="sig-paren">)</span><aclass="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 <aclass="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase.draw_path" title="matplotlib.backend_bases.RendererBase.draw_path"><codeclass="xref py py-meth docutils literal"><spanclass="pre">matplotlib.backend_bases.RendererBase.draw_path()</span></code></a>
except the first argument is a renderer.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.patheffects.Normal">
<emclass="property">class </em><codeclass="descclassname">matplotlib.patheffects.</code><codeclass="descname">Normal</code><spanclass="sig-paren">(</span><em>offset=(0.0</em>, <em>0.0)</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.Normal" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.patheffects.</code><codeclass="descname">PathEffectRenderer</code><spanclass="sig-paren">(</span><em>path_effects</em>, <em>renderer</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.PathEffectRenderer" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">copy_with_path_effect</code><spanclass="sig-paren">(</span><em>path_effects</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.copy_with_path_effect" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw_path</code><spanclass="sig-paren">(</span><em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.draw_path" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw_path_collection</code><spanclass="sig-paren">(</span><em>gc</em>, <em>master_transform</em>, <em>paths</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.draw_path_collection" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">new_gc</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.new_gc" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">points_to_pixels</code><spanclass="sig-paren">(</span><em>points</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.PathEffectRenderer.points_to_pixels" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.patheffects.PathPatchEffect">
<emclass="property">class </em><codeclass="descclassname">matplotlib.patheffects.</code><codeclass="descname">PathPatchEffect</code><spanclass="sig-paren">(</span><em>offset=(0</em>, <em>0)</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.PathPatchEffect" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw_path</code><spanclass="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.PathPatchEffect.draw_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.patheffects.SimpleLineShadow">
<emclass="property">class </em><codeclass="descclassname">matplotlib.patheffects.</code><codeclass="descname">SimpleLineShadow</code><spanclass="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><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.SimpleLineShadow" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw_path</code><spanclass="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="class">
<dtid="matplotlib.patheffects.SimplePatchShadow">
<emclass="property">class </em><codeclass="descclassname">matplotlib.patheffects.</code><codeclass="descname">SimplePatchShadow</code><spanclass="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><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.SimplePatchShadow" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw_path</code><spanclass="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="class">
<dtid="matplotlib.patheffects.Stroke">
<emclass="property">class </em><codeclass="descclassname">matplotlib.patheffects.</code><codeclass="descname">Stroke</code><spanclass="sig-paren">(</span><em>offset=(0</em>, <em>0)</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.Stroke" title="Permalink to this definition">¶</a></dt>
<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>
<dlclass="method">
<dtid="matplotlib.patheffects.Stroke.draw_path">
<codeclass="descname">draw_path</code><spanclass="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.Stroke.draw_path" title="Permalink to this definition">¶</a></dt>
<p>Adds a simple <aclass="reference internal" href="#matplotlib.patheffects.SimplePatchShadow" title="matplotlib.patheffects.SimplePatchShadow"><codeclass="xref py py-class docutils literal"><spanclass="pre">SimplePatchShadow</span></code></a> and then draws the
original Artist to avoid needing to call <aclass="reference internal" href="#matplotlib.patheffects.Normal" title="matplotlib.patheffects.Normal"><codeclass="xref py py-class docutils literal"><spanclass="pre">Normal</span></code></a>.</p>
<codeclass="descname">draw_path</code><spanclass="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.withSimplePatchShadow.draw_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.patheffects.withStroke">
<emclass="property">class </em><codeclass="descclassname">matplotlib.patheffects.</code><codeclass="descname">withStroke</code><spanclass="sig-paren">(</span><em>offset=(0</em>, <em>0)</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.withStroke" title="Permalink to this definition">¶</a></dt>
<p>Adds a simple <aclass="reference internal" href="#matplotlib.patheffects.Stroke" title="matplotlib.patheffects.Stroke"><codeclass="xref py py-class docutils literal"><spanclass="pre">Stroke</span></code></a> and then draws the
original Artist to avoid needing to call <aclass="reference internal" href="#matplotlib.patheffects.Normal" title="matplotlib.patheffects.Normal"><codeclass="xref py py-class docutils literal"><spanclass="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
<codeclass="descname">draw_path</code><spanclass="sig-paren">(</span><em>renderer</em>, <em>gc</em>, <em>tpath</em>, <em>affine</em>, <em>rgbFace</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.patheffects.withStroke.draw_path" title="Permalink to this definition">¶</a></dt>