<divid="unreleased-message"> You are reading an old version of the documentation (v3.0.2). For the latest version see <ahref="https://matplotlib.org/stable/api/spines_api.html">https://matplotlib.org/stable/api/spines_api.html</a></div>
<p>The default position is <codeclass="docutils literal notranslate"><spanclass="pre">('outward',0)</span></code>.</p>
<p>Spines are subclasses of class:<aclass="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Patch</span></code></a>, and
inherit much of their behavior.</p>
<p>Spines draw a line, a circle, or an arc depending if
<codeclass="descname">cla</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.cla"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.cla" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear the current spine</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.draw">
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Patch</span></code> to the given <em>renderer</em>.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.get_bounds">
<codeclass="descname">get_bounds</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_bounds"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.get_bounds" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_patch_transform</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_patch_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.get_patch_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Transform</span></code></a> instance which
takes patch coordinates to data coordinates.</p>
<p>For example, one may define a patch of a circle which represents a
radius of 5 by providing coordinates for a unit circle, and a
transform which scales the coordinates (the patch coordinate) by 5.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.get_path">
<codeclass="descname">get_path</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_path"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.get_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the path of this patch</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.get_position">
<codeclass="descname">get_position</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_position"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.get_position" title="Permalink to this definition">¶</a></dt>
<dd><p>get the spine position</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.get_smart_bounds">
<codeclass="descname">get_smart_bounds</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_smart_bounds"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.get_smart_bounds" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_spine_transform</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_spine_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.get_spine_transform" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_window_extent</code><spanclass="sig-paren">(</span><em>renderer=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_window_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the axes bounding box in display space.
Subclasses should override for inclusion in the bounding box
"tight" calculation. Default is to return an empty bounding
box at 0, 0.</p>
<p>Be careful when using this function, the results will not update
if the artist window extent of the artist changes. The extent
can change due to any changes in the transform stack, such as
changing the axes limits, the figure size, or the canvas used
(as is done when saving a figure). This can lead to unexpected
behavior where interactive figures will look fine on the screen,
but will save incorrectly.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.is_frame_like">
<codeclass="descname">is_frame_like</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.is_frame_like"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.is_frame_like" title="Permalink to this definition">¶</a></dt>
<dd><p>return True if directly on axes frame</p>
<p>This is useful for determining if a spine is the edge of an
old style MPL plot. If so, this function will return True.</p>
</dd></dl>
<dlclass="classmethod">
<dtid="matplotlib.spines.Spine.linear_spine">
<emclass="property">classmethod </em><codeclass="descname">linear_spine</code><spanclass="sig-paren">(</span><em>axes</em>, <em>spine_type</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.linear_spine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.linear_spine" title="Permalink to this definition">¶</a></dt>
<dd><p>(staticmethod) Returns a linear <aclass="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Spine</span></code></a>.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.register_axis">
<codeclass="descname">register_axis</code><spanclass="sig-paren">(</span><em>axis</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.register_axis"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.register_axis" title="Permalink to this definition">¶</a></dt>
<dd><p>register an axis</p>
<p>An axis should be registered with its corresponding spine from
the Axes instance. This allows the spine to clear any axis
properties when needed.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.set_bounds">
<codeclass="descname">set_bounds</code><spanclass="sig-paren">(</span><em>low</em>, <em>high</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_bounds"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.set_bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the bounds of the spine.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.set_color">
<codeclass="descname">set_color</code><spanclass="sig-paren">(</span><em>c</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_color"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.set_color" title="Permalink to this definition">¶</a></dt>
<dd><pclass="first last">For setting the edge or face color individually.</p>
</dd>
</dl>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.set_patch_arc">
<codeclass="descname">set_patch_arc</code><spanclass="sig-paren">(</span><em>center</em>, <em>radius</em>, <em>theta1</em>, <em>theta2</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_patch_arc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.set_patch_arc" title="Permalink to this definition">¶</a></dt>
<dd><p>set the spine to be arc-like</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.set_patch_circle">
<codeclass="descname">set_patch_circle</code><spanclass="sig-paren">(</span><em>center</em>, <em>radius</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_patch_circle"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.set_patch_circle" title="Permalink to this definition">¶</a></dt>
<dd><p>set the spine to be circular</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.set_patch_line">
<codeclass="descname">set_patch_line</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_patch_line"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.set_patch_line" title="Permalink to this definition">¶</a></dt>
<dd><p>set the spine to be linear</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.set_position">
<codeclass="descname">set_position</code><spanclass="sig-paren">(</span><em>position</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_position"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.set_position" title="Permalink to this definition">¶</a></dt>
<dd><p>set the position of the spine</p>
<p>Spine position is specified by a 2 tuple of (position type,
amount). The position types are:</p>
<ulclass="simple">
<li>'outward' : place the spine out from the data area by the
specified number of points. (Negative values specify placing the
spine inward.)</li>
<li>'axes' : place the spine at the specified Axes coordinate (from
0.0-1.0).</li>
<li>'data' : place the spine at the specified data coordinate.</li>
</ul>
<p>Additionally, shorthand notations define a special positions:</p>
<ulclass="simple">
<li>'center' -> ('axes',0.5)</li>
<li>'zero' -> ('data', 0.0)</li>
</ul>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.spines.Spine.set_smart_bounds">
<codeclass="descname">set_smart_bounds</code><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_smart_bounds"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.spines.Spine.set_smart_bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>set the spine and associated axis to have smart bounds</p>