{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathspines_api.html
More file actions
512 lines (468 loc) · 43.6 KB
/
Copy pathspines_api.html
File metadata and controls
512 lines (468 loc) · 43.6 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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>matplotlib.spines — Matplotlib 3.4.2 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.4.2-2-gf801f04d09-dirty" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.4.2 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="next" title="matplotlib.style" href="style_api.html" />
<link rel="prev" title="matplotlib.sphinxext.plot_directive" href="sphinxext_plot_directive_api.html" />
<link rel="top" title="Matplotlib 3.4.2 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/spines_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<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 (v3.4.2). 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 id="annc-banner">
</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 3.4.2</span></div>
<img src="../_static/logo2_compressed.svg" 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>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<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="matplotlib.style"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="sphinxext_plot_directive_api.html" title="matplotlib.sphinxext.plot_directive"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.spines</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<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" role="main">
<div class="section" id="module-matplotlib.spines">
<span id="matplotlib-spines"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.spines</span></code><a class="headerlink" href="#module-matplotlib.spines" title="Permalink to this headline">¶</a></h1>
<dl class="py 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><span class="n">axes</span></em>, <em><span class="n">spine_type</span></em>, <em><span class="n">path</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></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 <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',</span> <span class="pre">0)</span></code>.</p>
<p>Spines are subclasses of <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
<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>, <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
<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>
<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"><dl class="first docutils">
<dt><strong>axes</strong><span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a></span></dt><dd><p>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> instance containing the spine.</p>
</dd>
<dt><strong>spine_type</strong><span class="classifier">str</span></dt><dd><p>The spine type.</p>
</dd>
<dt><strong>path</strong><span class="classifier"><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></span></dt><dd><p>The <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> instance used to draw the spine.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Other Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>**kwargs</strong></dt><dd><p>Valid keyword arguments are:</p>
<table border="1" class="property-table docutils align-default">
<colgroup>
<col width="40%" />
<col width="60%" />
</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.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal notranslate"><span class="pre">alpha</span></code></a></td>
<td>scalar 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>unknown</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><a class="reference internal" href="_enums_api.html#matplotlib._enums.CapStyle" title="matplotlib._enums.CapStyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CapStyle</span></code></a> or {'butt', 'projecting', 'round'}</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 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></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>Patch or (Path, Transform) or 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>color</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>unknown</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>color or 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>color or None</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 class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></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>str</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.artist.Artist.set_in_layout.html#matplotlib.artist.Artist.set_in_layout" title="matplotlib.artist.Artist.set_in_layout"><code class="xref py py-meth docutils literal notranslate"><span class="pre">in_layout</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_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><a class="reference internal" href="_enums_api.html#matplotlib._enums.JoinStyle" title="matplotlib._enums.JoinStyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">JoinStyle</span></code></a> or {'miter', 'round', 'bevel'}</td>
</tr>
<tr class="row-even"><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-odd"><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>{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}</td>
</tr>
<tr class="row-even"><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</td>
</tr>
<tr class="row-odd"><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-even"><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 or bool or float or callable</td>
</tr>
<tr class="row-odd"><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</td>
</tr>
<tr class="row-even"><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-odd"><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-even"><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-odd"><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>str</td>
</tr>
<tr class="row-even"><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-odd"><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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.spines.Spine.arc_spine">
<em class="property">classmethod </em><code class="descname">arc_spine</code><span class="sig-paren">(</span><em><span class="n">axes</span></em>, <em><span class="n">spine_type</span></em>, <em><span class="n">center</span></em>, <em><span class="n">radius</span></em>, <em><span class="n">theta1</span></em>, <em><span class="n">theta2</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></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>Create and return an arc <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Spine</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.circular_spine">
<em class="property">classmethod </em><code class="descname">circular_spine</code><span class="sig-paren">(</span><em><span class="n">axes</span></em>, <em><span class="n">center</span></em>, <em><span class="n">radius</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></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>Create and return a circular <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Spine</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.cla">
<code class="descname">cla</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.4: </span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear the current spine.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span></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 Artist (and its children) using the given renderer.</p>
<p>This has no effect if the artist is not visible (<a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_visible.html#matplotlib.artist.Artist.get_visible" title="matplotlib.artist.Artist.get_visible"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist.get_visible</span></code></a>
returns False).</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"><dl class="first last docutils">
<dt><strong>renderer</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RendererBase</span></code></a> subclass.</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>This method is overridden in the Artist subclasses.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.get_bounds">
<code class="descname">get_bounds</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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="py method">
<dt id="matplotlib.spines.Spine.get_patch_transform">
<code class="descname">get_patch_transform</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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-obj docutils literal notranslate"><span class="pre">Transform</span></code></a> instance mapping 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="py method">
<dt id="matplotlib.spines.Spine.get_path">
<code class="descname">get_path</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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="py method">
<dt id="matplotlib.spines.Spine.get_position">
<code class="descname">get_position</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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>Return the spine position.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.get_spine_transform">
<code class="descname">get_spine_transform</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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>Return the spine transform.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">renderer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spine.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the window extent of the spines in display space, including
padding for ticks (but not their labels)</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.get_tightbbox.html#matplotlib.axes.Axes.get_tightbbox" title="matplotlib.axes.Axes.get_tightbbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.get_tightbbox</span></code></a></dt><dd></dd>
<dt><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.get_window_extent.html#matplotlib.axes.Axes.get_window_extent" title="matplotlib.axes.Axes.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.get_window_extent</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.linear_spine">
<em class="property">classmethod </em><code class="descname">linear_spine</code><span class="sig-paren">(</span><em><span class="n">axes</span></em>, <em><span class="n">spine_type</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></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>Create and return a linear <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Spine</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.register_axis">
<code class="descname">register_axis</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">axis</span></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="py method">
<dt id="matplotlib.spines.Spine.set_bounds">
<code class="descname">set_bounds</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">low</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">high</span><span class="o">=</span><span class="default_value">None</span></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 spine bounds.</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"><dl class="first last docutils">
<dt><strong>low</strong><span class="classifier">float or None, optional</span></dt><dd><p>The lower spine bound. Passing <em>None</em> leaves the limit unchanged.</p>
<p>The bounds may also be passed as the tuple (<em>low</em>, <em>high</em>) as the
first positional argument.</p>
</dd>
<dt><strong>high</strong><span class="classifier">float or None, optional</span></dt><dd><p>The higher spine bound. Passing <em>None</em> leaves the limit unchanged.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.set_color">
<code class="descname">set_color</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">c</span></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>
<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"><dl class="first last docutils">
<dt><strong>c</strong><span class="classifier">color</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>This method does not modify the facecolor (which defaults to "none"),
unlike the <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-obj docutils literal notranslate"><span class="pre">Patch.set_color</span></code></a> method defined in the parent class. Use
<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-obj docutils literal notranslate"><span class="pre">Patch.set_facecolor</span></code></a> to set the facecolor.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.spines.Spine.set_patch_arc">
<code class="descname">set_patch_arc</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">center</span></em>, <em><span class="n">radius</span></em>, <em><span class="n">theta1</span></em>, <em><span class="n">theta2</span></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="py method">
<dt id="matplotlib.spines.Spine.set_patch_circle">
<code class="descname">set_patch_circle</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">center</span></em>, <em><span class="n">radius</span></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="py method">
<dt id="matplotlib.spines.Spine.set_patch_line">
<code class="descname">set_patch_line</code><span class="sig-paren">(</span><em><span class="n">self</span></em><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="py method">
<dt id="matplotlib.spines.Spine.set_position">
<code class="descname">set_position</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">position</span></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 place the spine inwards.)</li>
<li>'axes': place the spine at the specified Axes coordinate (0 to 1).</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>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.spines.Spines">
<em class="property">class </em><code class="descclassname">matplotlib.spines.</code><code class="descname">Spines</code><span class="sig-paren">(</span><em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spines" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.MutableMapping" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">collections.abc.MutableMapping</span></code></a></p>
<p>The container of all <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Spine</span></code></a>s in an Axes.</p>
<p>The interface is dict-like mapping names (e.g. 'left') to <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Spine</span></code></a> objects.
Additionally it implements some pandas.Series-like features like accessing
elements by attribute:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">spines</span><span class="p">[</span><span class="s1">'top'</span><span class="p">]</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="n">spines</span><span class="o">.</span><span class="n">top</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
<p>Multiple spines can be addressed simultaneously by passing a list:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">spines</span><span class="p">[[</span><span class="s1">'top'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">]]</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
<p>Use an open slice to address all spines:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">spines</span><span class="p">[:]</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
<p>The latter two indexing methods will return a <a class="reference internal" href="#matplotlib.spines.SpinesProxy" title="matplotlib.spines.SpinesProxy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SpinesProxy</span></code></a> that broadcasts
all <code class="docutils literal notranslate"><span class="pre">set_*</span></code> calls to its members, but cannot be used for any other
operation.</p>
<dl class="py method">
<dt id="matplotlib.spines.Spines.from_dict">
<em class="property">classmethod </em><code class="descname">from_dict</code><span class="sig-paren">(</span><em><span class="n">d</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#Spines.from_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.Spines.from_dict" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.spines.SpinesProxy">
<em class="property">class </em><code class="descclassname">matplotlib.spines.</code><code class="descname">SpinesProxy</code><span class="sig-paren">(</span><em><span class="n">spine_dict</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/spines.html#SpinesProxy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.spines.SpinesProxy" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A proxy to broadcast <code class="docutils literal notranslate"><span class="pre">set_*</span></code> method calls to all contained <a class="reference internal" href="#matplotlib.spines.Spines" title="matplotlib.spines.Spines"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Spines</span></code></a>.</p>
<p>The proxy cannot be used for any other operations on its members.</p>
<p>The supported methods are determined dynamically based on the contained
spines. If not all spines support a given method, it's executed only on
the subset of spines that support it.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.
<br />
Last updated on May 08, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.
Doc version v3.4.2-2-gf801f04d09-dirty.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.