Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathspines_api.html
More file actions
443 lines (398 loc) · 33.8 KB
/
Copy pathspines_api.html
File metadata and controls
443 lines (398 loc) · 33.8 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
<!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>spines — Matplotlib 2.2.4 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.4 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="top" title="Matplotlib 2.2.4 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="style" href="style_api.html" />
<link rel="prev" title="scale" href="scale_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/spines_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 (v2.2.4). For the latest version see <a href="https://matplotlib.org/stable/api/spines_api.html">https://matplotlib.org/stable/api/spines_api.html</a></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 2.2.4</span></div>
<img src="../_static/logo2.png" 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>
<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="style_api.html" title="style"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="scale_api.html" title="scale"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</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="../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">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">spines</a><ul>
<li><a class="reference internal" href="#module-matplotlib.spines"><code class="docutils literal notranslate"><span class="pre">matplotlib.spines</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="scale_api.html" title="previous chapter">scale</a></li>
<li>Next: <a href="style_api.html" title="next chapter">style</a></li>
</ul></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/spines_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">
<div class="section" id="spines">
<h1>spines<a class="headerlink" href="#spines" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.spines">
<span id="matplotlib-spines"></span><h2><a class="reference internal" href="#module-matplotlib.spines" title="matplotlib.spines"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.spines</span></code></a><a class="headerlink" href="#module-matplotlib.spines" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="matplotlib.spines.Spine">
<em class="property">class </em><code class="descclassname">matplotlib.spines.</code><code class="descname">Spine</code><span class="sig-paren">(</span><em>axes</em>, <em>spine_type</em>, <em>path</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.patches.Patch</span></code></a></p>
<p>an axis spine -- the line noting the data area boundaries</p>
<p>Spines are the lines connecting the axis tick marks and noting the
boundaries of the data area. They can be placed at arbitrary
positions. See function:<a class="reference internal" href="#matplotlib.spines.Spine.set_position" title="matplotlib.spines.Spine.set_position"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_position</span></code></a>
for more information.</p>
<p>The default position is <code class="docutils literal notranslate"><span class="pre">('outward',0)</span></code>.</p>
<p>Spines are subclasses of class:<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>, and
inherit much of their behavior.</p>
<p>Spines draw a line, a circle, or an arc depending if
function:<a class="reference internal" href="#matplotlib.spines.Spine.set_patch_line" title="matplotlib.spines.Spine.set_patch_line"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_patch_line</span></code></a>,
function:<a class="reference internal" href="#matplotlib.spines.Spine.set_patch_circle" title="matplotlib.spines.Spine.set_patch_circle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_patch_circle</span></code></a>, or
function:<a class="reference internal" href="#matplotlib.spines.Spine.set_patch_arc" title="matplotlib.spines.Spine.set_patch_arc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_patch_arc</span></code></a> has been called.
Line-like is the default.</p>
<ul class="simple">
<li><em>axes</em> : the Axes instance containing the spine</li>
<li><em>spine_type</em> : a string specifying the spine type</li>
<li><em>path</em> : the path instance used to draw the spine</li>
</ul>
<p>Valid kwargs are:</p>
<blockquote>
<div><table border="1" class="property-table docutils">
<colgroup>
<col width="32%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">agg_filter</span></code></a></td>
<td>a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_alpha" title="matplotlib.patches.Patch.set_alpha"><code class="xref py py-meth docutils literal notranslate"><span class="pre">alpha</span></code></a></td>
<td>float or None</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal notranslate"><span class="pre">animated</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_antialiased" title="matplotlib.patches.Patch.set_antialiased"><code class="xref py py-meth docutils literal notranslate"><span class="pre">antialiased</span></code></a> or aa</td>
<td>bool or None</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_capstyle" title="matplotlib.patches.Patch.set_capstyle"><code class="xref py py-meth docutils literal notranslate"><span class="pre">capstyle</span></code></a></td>
<td>['butt' | 'round' | 'projecting']</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_clip_box.html#matplotlib.artist.Artist.set_clip_box" title="matplotlib.artist.Artist.set_clip_box"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_box</span></code></a></td>
<td>a <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_clip_on.html#matplotlib.artist.Artist.set_clip_on" title="matplotlib.artist.Artist.set_clip_on"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_on</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_clip_path.html#matplotlib.artist.Artist.set_clip_path" title="matplotlib.artist.Artist.set_clip_path"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_path</span></code></a></td>
<td>[(<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a>) | <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> | None]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_color" title="matplotlib.patches.Patch.set_color"><code class="xref py py-meth docutils literal notranslate"><span class="pre">color</span></code></a></td>
<td>matplotlib color spec</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal notranslate"><span class="pre">contains</span></code></a></td>
<td>a callable function</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_edgecolor" title="matplotlib.patches.Patch.set_edgecolor"><code class="xref py py-meth docutils literal notranslate"><span class="pre">edgecolor</span></code></a> or ec</td>
<td>mpl color spec, None, 'none', or 'auto'</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_facecolor" title="matplotlib.patches.Patch.set_facecolor"><code class="xref py py-meth docutils literal notranslate"><span class="pre">facecolor</span></code></a> or fc</td>
<td>mpl color spec, or None for default, or 'none' for no color</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal notranslate"><span class="pre">figure</span></code></a></td>
<td>a <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_fill" title="matplotlib.patches.Patch.set_fill"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fill</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_gid.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal notranslate"><span class="pre">gid</span></code></a></td>
<td>an id string</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_hatch" title="matplotlib.patches.Patch.set_hatch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">hatch</span></code></a></td>
<td>['/' | '\' | '|' | '-' | '+' | 'x' | 'o' | 'O' | '.' | '*']</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_joinstyle" title="matplotlib.patches.Patch.set_joinstyle"><code class="xref py py-meth docutils literal notranslate"><span class="pre">joinstyle</span></code></a></td>
<td>['miter' | 'round' | 'bevel']</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_label.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal notranslate"><span class="pre">label</span></code></a></td>
<td>object</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_linestyle" title="matplotlib.patches.Patch.set_linestyle"><code class="xref py py-meth docutils literal notranslate"><span class="pre">linestyle</span></code></a> or ls</td>
<td>['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) | <code class="docutils literal notranslate"><span class="pre">'-'</span></code> | <code class="docutils literal notranslate"><span class="pre">'--'</span></code> | <code class="docutils literal notranslate"><span class="pre">'-.'</span></code> | <code class="docutils literal notranslate"><span class="pre">':'</span></code> | <code class="docutils literal notranslate"><span class="pre">'None'</span></code> | <code class="docutils literal notranslate"><span class="pre">'</span> <span class="pre">'</span></code> | <code class="docutils literal notranslate"><span class="pre">''</span></code>]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_linewidth" title="matplotlib.patches.Patch.set_linewidth"><code class="xref py py-meth docutils literal notranslate"><span class="pre">linewidth</span></code></a> or lw</td>
<td>float or None for default</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_path_effects.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal notranslate"><span class="pre">path_effects</span></code></a></td>
<td><a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AbstractPathEffect</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal notranslate"><span class="pre">picker</span></code></a></td>
<td>[None | bool | float | callable]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rasterized</span></code></a></td>
<td>bool or None</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sketch_params</span></code></a></td>
<td>(scale: float, length: float, randomness: float)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_snap.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal notranslate"><span class="pre">snap</span></code></a></td>
<td>bool or None</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_url.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">url</span></code></a></td>
<td>a url string</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_visible.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal notranslate"><span class="pre">visible</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_zorder.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">zorder</span></code></a></td>
<td>float</td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="classmethod">
<dt id="matplotlib.spines.Spine.arc_spine">
<em class="property">classmethod </em><code class="descname">arc_spine</code><span class="sig-paren">(</span><em>axes</em>, <em>spine_type</em>, <em>center</em>, <em>radius</em>, <em>theta1</em>, <em>theta2</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.arc_spine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.arc_spine" title="Permalink to this definition">¶</a></dt>
<dd><p>(classmethod) Returns an arc <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spine</span></code></a>.</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.spines.Spine.circular_spine">
<em class="property">classmethod </em><code class="descname">circular_spine</code><span class="sig-paren">(</span><em>axes</em>, <em>center</em>, <em>radius</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.circular_spine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.circular_spine" title="Permalink to this definition">¶</a></dt>
<dd><p>(staticmethod) Returns a circular <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spine</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.cla">
<code class="descname">cla</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.cla"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.cla" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear the current spine</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the <code class="xref py py-class docutils literal notranslate"><span class="pre">Patch</span></code> to the given <em>renderer</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.get_bounds">
<code class="descname">get_bounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_bounds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.get_bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the bounds of the spine.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.get_patch_transform">
<code class="descname">get_patch_transform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_patch_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.get_patch_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate"><span class="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>
<dl class="method">
<dt id="matplotlib.spines.Spine.get_path">
<code class="descname">get_path</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_path"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="method">
<dt id="matplotlib.spines.Spine.get_position">
<code class="descname">get_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_position"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.get_position" title="Permalink to this definition">¶</a></dt>
<dd><p>get the spine position</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.get_smart_bounds">
<code class="descname">get_smart_bounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_smart_bounds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.get_smart_bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>get whether the spine has smart bounds</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.get_spine_transform">
<code class="descname">get_spine_transform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_spine_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.get_spine_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>get the spine transform</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.is_frame_like">
<code class="descname">is_frame_like</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.is_frame_like"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="classmethod">
<dt id="matplotlib.spines.Spine.linear_spine">
<em class="property">classmethod </em><code class="descname">linear_spine</code><span class="sig-paren">(</span><em>axes</em>, <em>spine_type</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.linear_spine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.linear_spine" title="Permalink to this definition">¶</a></dt>
<dd><p>(staticmethod) Returns a linear <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spine</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.register_axis">
<code class="descname">register_axis</code><span class="sig-paren">(</span><em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.register_axis"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="method">
<dt id="matplotlib.spines.Spine.set_bounds">
<code class="descname">set_bounds</code><span class="sig-paren">(</span><em>low</em>, <em>high</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_bounds"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="method">
<dt id="matplotlib.spines.Spine.set_color">
<code class="descname">set_color</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_color"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.set_color" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the edgecolor.</p>
<p>ACCEPTS: matplotlib color arg or sequence of rgba tuples</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_facecolor()</span></code>, <code class="xref py py-meth docutils literal notranslate"><span class="pre">set_edgecolor()</span></code></dt>
<dd>For setting the edge or face color individually.</dd>
</dl>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.set_patch_arc">
<code class="descname">set_patch_arc</code><span class="sig-paren">(</span><em>center</em>, <em>radius</em>, <em>theta1</em>, <em>theta2</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_patch_arc"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="method">
<dt id="matplotlib.spines.Spine.set_patch_circle">
<code class="descname">set_patch_circle</code><span class="sig-paren">(</span><em>center</em>, <em>radius</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_patch_circle"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="method">
<dt id="matplotlib.spines.Spine.set_patch_line">
<code class="descname">set_patch_line</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_patch_line"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="method">
<dt id="matplotlib.spines.Spine.set_position">
<code class="descname">set_position</code><span class="sig-paren">(</span><em>position</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_position"><span class="viewcode-link">[source]</span></a><a class="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>
<ul class="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>
<ul class="simple">
<li>'center' -> ('axes',0.5)</li>
<li>'zero' -> ('data', 0.0)</li>
</ul>
</dd></dl>
<dl class="method">
<dt id="matplotlib.spines.Spine.set_smart_bounds">
<code class="descname">set_smart_bounds</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_smart_bounds"><span class="viewcode-link">[source]</span></a><a class="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>
</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 - 2018 The Matplotlib development team.
<br />
Last updated on Feb 28, 2019.
Created using
<ahref="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
Doc version v2.2.4-2-g38a93e9a0-dirty.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.