{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathspines.html
More file actions
675 lines (578 loc) · 85.8 KB
/
Copy pathspines.html
File metadata and controls
675 lines (578 loc) · 85.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
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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
<!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>matplotlib.spines — Matplotlib 3.0.2 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" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.0.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="top" title="Matplotlib 3.0.2 documentation" href="../../index.html" />
<link rel="up" title="matplotlib" href="../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/_modules/matplotlib/spines.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 (v3.0.2). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</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 3.0.2</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><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="../../api/api_overview.html">API</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../matplotlib.html" accesskey="U">matplotlib</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><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
<li><a href="../matplotlib.html">matplotlib</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for matplotlib.spines</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">matplotlib</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">docstring</span><span class="p">,</span> <span class="n">rcParams</span>
<span class="kn">from</span> <span class="nn">matplotlib.artist</span> <span class="k">import</span> <span class="n">allow_rasterization</span>
<span class="kn">import</span> <span class="nn">matplotlib.transforms</span> <span class="k">as</span> <span class="nn">mtransforms</span>
<span class="kn">import</span> <span class="nn">matplotlib.patches</span> <span class="k">as</span> <span class="nn">mpatches</span>
<span class="kn">import</span> <span class="nn">matplotlib.path</span> <span class="k">as</span> <span class="nn">mpath</span>
<div class="viewcode-block" id="Spine"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine">[docs]</a><span class="k">class</span> <span class="nc">Spine</span><span class="p">(</span><span class="n">mpatches</span><span class="o">.</span><span class="n">Patch</span><span class="p">):</span>
<span class="sd">"""an axis spine -- the line noting the data area boundaries</span>
<span class="sd"> Spines are the lines connecting the axis tick marks and noting the</span>
<span class="sd"> boundaries of the data area. They can be placed at arbitrary</span>
<span class="sd"> positions. See function:`~matplotlib.spines.Spine.set_position`</span>
<span class="sd"> for more information.</span>
<span class="sd"> The default position is ``('outward',0)``.</span>
<span class="sd"> Spines are subclasses of class:`~matplotlib.patches.Patch`, and</span>
<span class="sd"> inherit much of their behavior.</span>
<span class="sd"> Spines draw a line, a circle, or an arc depending if</span>
<span class="sd"> function:`~matplotlib.spines.Spine.set_patch_line`,</span>
<span class="sd"> function:`~matplotlib.spines.Spine.set_patch_circle`, or</span>
<span class="sd"> function:`~matplotlib.spines.Spine.set_patch_arc` has been called.</span>
<span class="sd"> Line-like is the default.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">"Spine"</span>
<span class="nd">@docstring</span><span class="o">.</span><span class="n">dedent_interpd</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">axes</span><span class="p">,</span> <span class="n">spine_type</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> - *axes* : the Axes instance containing the spine</span>
<span class="sd"> - *spine_type* : a string specifying the spine type</span>
<span class="sd"> - *path* : the path instance used to draw the spine</span>
<span class="sd"> Valid kwargs are:</span>
<span class="sd"> %(Patch)s</span>
<span class="sd"> """</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axes</span> <span class="o">=</span> <span class="n">axes</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">figure</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="o">=</span> <span class="n">spine_type</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_facecolor</span><span class="p">(</span><span class="s1">'none'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_edgecolor</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'axes.edgecolor'</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_linewidth</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'axes.linewidth'</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_capstyle</span><span class="p">(</span><span class="s1">'projecting'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axis</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_zorder</span><span class="p">(</span><span class="mf">2.5</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_transform</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">transData</span><span class="p">)</span> <span class="c1"># default transform</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_bounds</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># default bounds</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_smart_bounds</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># Defer initial position determination. (Not much support for</span>
<span class="c1"># non-rectangular axes is currently implemented, and this lets</span>
<span class="c1"># them pass through the spines machinery without errors.)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_position</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">Path</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"'path' must be an instance of 'matplotlib.path.Path'"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">path</span>
<span class="c1"># To support drawing both linear and circular spines, this</span>
<span class="c1"># class implements Patch behavior three ways. If</span>
<span class="c1"># self._patch_type == 'line', behave like a mpatches.PathPatch</span>
<span class="c1"># instance. If self._patch_type == 'circle', behave like a</span>
<span class="c1"># mpatches.Ellipse instance. If self._patch_type == 'arc', behave like</span>
<span class="c1"># a mpatches.Arc instance.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_patch_type</span> <span class="o">=</span> <span class="s1">'line'</span>
<span class="c1"># Behavior copied from mpatches.Ellipse:</span>
<span class="c1"># Note: This cannot be calculated until this is added to an Axes</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_patch_transform</span> <span class="o">=</span> <span class="n">mtransforms</span><span class="o">.</span><span class="n">IdentityTransform</span><span class="p">()</span>
<div class="viewcode-block" id="Spine.set_smart_bounds"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.set_smart_bounds">[docs]</a> <span class="k">def</span> <span class="nf">set_smart_bounds</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""set the spine and associated axis to have smart bounds"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_smart_bounds</span> <span class="o">=</span> <span class="n">value</span>
<span class="c1"># also set the axis if possible</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">set_smart_bounds</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'top'</span><span class="p">,</span> <span class="s1">'bottom'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set_smart_bounds</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Spine.get_smart_bounds"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.get_smart_bounds">[docs]</a> <span class="k">def</span> <span class="nf">get_smart_bounds</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""get whether the spine has smart bounds"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_smart_bounds</span></div>
<div class="viewcode-block" id="Spine.set_patch_arc"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.set_patch_arc">[docs]</a> <span class="k">def</span> <span class="nf">set_patch_arc</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">center</span><span class="p">,</span> <span class="n">radius</span><span class="p">,</span> <span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">):</span>
<span class="sd">"""set the spine to be arc-like"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_patch_type</span> <span class="o">=</span> <span class="s1">'arc'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_center</span> <span class="o">=</span> <span class="n">center</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_width</span> <span class="o">=</span> <span class="n">radius</span> <span class="o">*</span> <span class="mi">2</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_height</span> <span class="o">=</span> <span class="n">radius</span> <span class="o">*</span> <span class="mi">2</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_theta1</span> <span class="o">=</span> <span class="n">theta1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_theta2</span> <span class="o">=</span> <span class="n">theta2</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">mpath</span><span class="o">.</span><span class="n">Path</span><span class="o">.</span><span class="n">arc</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">)</span>
<span class="c1"># arc drawn on axes transform</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_transform</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">transAxes</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Spine.set_patch_circle"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.set_patch_circle">[docs]</a> <span class="k">def</span> <span class="nf">set_patch_circle</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">center</span><span class="p">,</span> <span class="n">radius</span><span class="p">):</span>
<span class="sd">"""set the spine to be circular"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_patch_type</span> <span class="o">=</span> <span class="s1">'circle'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_center</span> <span class="o">=</span> <span class="n">center</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_width</span> <span class="o">=</span> <span class="n">radius</span> <span class="o">*</span> <span class="mi">2</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_height</span> <span class="o">=</span> <span class="n">radius</span> <span class="o">*</span> <span class="mi">2</span>
<span class="c1"># circle drawn on axes transform</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_transform</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">transAxes</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Spine.set_patch_line"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.set_patch_line">[docs]</a> <span class="k">def</span> <span class="nf">set_patch_line</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""set the spine to be linear"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_patch_type</span> <span class="o">=</span> <span class="s1">'line'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<span class="c1"># Behavior copied from mpatches.Ellipse:</span>
<span class="k">def</span> <span class="nf">_recompute_transform</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""NOTE: This cannot be called until after this has been added</span>
<span class="sd"> to an Axes, otherwise unit conversion will fail. This</span>
<span class="sd"> makes it very important to call the accessor method and</span>
<span class="sd"> not directly access the transformation member variable.</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_patch_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'arc'</span><span class="p">,</span> <span class="s1">'circle'</span><span class="p">)</span>
<span class="n">center</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">convert_xunits</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_center</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">convert_yunits</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_center</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
<span class="n">width</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">convert_xunits</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_width</span><span class="p">)</span>
<span class="n">height</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">convert_yunits</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_height</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_patch_transform</span> <span class="o">=</span> <span class="n">mtransforms</span><span class="o">.</span><span class="n">Affine2D</span><span class="p">()</span> \
<span class="o">.</span><span class="n">scale</span><span class="p">(</span><span class="n">width</span> <span class="o">*</span> <span class="mf">0.5</span><span class="p">,</span> <span class="n">height</span> <span class="o">*</span> <span class="mf">0.5</span><span class="p">)</span> \
<span class="o">.</span><span class="n">translate</span><span class="p">(</span><span class="o">*</span><span class="n">center</span><span class="p">)</span>
<div class="viewcode-block" id="Spine.get_patch_transform"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.get_patch_transform">[docs]</a> <span class="k">def</span> <span class="nf">get_patch_transform</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_patch_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'arc'</span><span class="p">,</span> <span class="s1">'circle'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_recompute_transform</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_patch_transform</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_patch_transform</span><span class="p">()</span></div>
<div class="viewcode-block" id="Spine.get_window_extent"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.get_window_extent">[docs]</a> <span class="k">def</span> <span class="nf">get_window_extent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># make sure the location is updated so that transforms etc are</span>
<span class="c1"># correct:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_adjust_location</span><span class="p">()</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_window_extent</span><span class="p">(</span><span class="n">renderer</span><span class="o">=</span><span class="n">renderer</span><span class="p">)</span></div>
<div class="viewcode-block" id="Spine.get_path"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.get_path">[docs]</a> <span class="k">def</span> <span class="nf">get_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span></div>
<span class="k">def</span> <span class="nf">_ensure_position_is_set</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_position</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># default position</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_position</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'outward'</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">)</span> <span class="c1"># in points</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_position</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_position</span><span class="p">)</span>
<div class="viewcode-block" id="Spine.register_axis"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.register_axis">[docs]</a> <span class="k">def</span> <span class="nf">register_axis</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">axis</span><span class="p">):</span>
<span class="sd">"""register an axis</span>
<span class="sd"> An axis should be registered with its corresponding spine from</span>
<span class="sd"> the Axes instance. This allows the spine to clear any axis</span>
<span class="sd"> properties when needed.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axis</span> <span class="o">=</span> <span class="n">axis</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">axis</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axis</span><span class="o">.</span><span class="n">cla</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Spine.cla"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.cla">[docs]</a> <span class="k">def</span> <span class="nf">cla</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Clear the current spine"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_position</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># clear position</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">axis</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axis</span><span class="o">.</span><span class="n">cla</span><span class="p">()</span></div>
<div class="viewcode-block" id="Spine.is_frame_like"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.is_frame_like">[docs]</a> <span class="k">def</span> <span class="nf">is_frame_like</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""return True if directly on axes frame</span>
<span class="sd"> This is useful for determining if a spine is the edge of an</span>
<span class="sd"> old style MPL plot. If so, this function will return True.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_ensure_position_is_set</span><span class="p">()</span>
<span class="n">position</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_position</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">position</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">if</span> <span class="n">position</span> <span class="o">==</span> <span class="s1">'center'</span><span class="p">:</span>
<span class="n">position</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'axes'</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">position</span> <span class="o">==</span> <span class="s1">'zero'</span><span class="p">:</span>
<span class="n">position</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'data'</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">position</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"position should be 2-tuple"</span><span class="p">)</span>
<span class="n">position_type</span><span class="p">,</span> <span class="n">amount</span> <span class="o">=</span> <span class="n">position</span>
<span class="k">if</span> <span class="n">position_type</span> <span class="o">==</span> <span class="s1">'outward'</span> <span class="ow">and</span> <span class="n">amount</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span></div>
<span class="k">def</span> <span class="nf">_adjust_location</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""automatically set spine bounds to the view interval"""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="o">==</span> <span class="s1">'circle'</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bounds</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">):</span>
<span class="n">low</span><span class="p">,</span> <span class="n">high</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">viewLim</span><span class="o">.</span><span class="n">intervaly</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'top'</span><span class="p">,</span> <span class="s1">'bottom'</span><span class="p">):</span>
<span class="n">low</span><span class="p">,</span> <span class="n">high</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">viewLim</span><span class="o">.</span><span class="n">intervalx</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'unknown spine spine_type: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span>
<span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_smart_bounds</span><span class="p">:</span>
<span class="c1"># attempt to set bounds in sophisticated way</span>
<span class="c1"># handle inverted limits</span>
<span class="n">viewlim_low</span><span class="p">,</span> <span class="n">viewlim_high</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">([</span><span class="n">low</span><span class="p">,</span> <span class="n">high</span><span class="p">])</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">):</span>
<span class="n">datalim_low</span><span class="p">,</span> <span class="n">datalim_high</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">dataLim</span><span class="o">.</span><span class="n">intervaly</span>
<span class="n">ticks</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">get_yticks</span><span class="p">()</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'top'</span><span class="p">,</span> <span class="s1">'bottom'</span><span class="p">):</span>
<span class="n">datalim_low</span><span class="p">,</span> <span class="n">datalim_high</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">dataLim</span><span class="o">.</span><span class="n">intervalx</span>
<span class="n">ticks</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">get_xticks</span><span class="p">()</span>
<span class="c1"># handle inverted limits</span>
<span class="n">ticks</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">ticks</span><span class="p">)</span>
<span class="n">datalim_low</span><span class="p">,</span> <span class="n">datalim_high</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">([</span><span class="n">datalim_low</span><span class="p">,</span> <span class="n">datalim_high</span><span class="p">])</span>
<span class="k">if</span> <span class="n">datalim_low</span> <span class="o"><</span> <span class="n">viewlim_low</span><span class="p">:</span>
<span class="c1"># Data extends past view. Clip line to view.</span>
<span class="n">low</span> <span class="o">=</span> <span class="n">viewlim_low</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Data ends before view ends.</span>
<span class="n">cond</span> <span class="o">=</span> <span class="p">(</span><span class="n">ticks</span> <span class="o"><=</span> <span class="n">datalim_low</span><span class="p">)</span> <span class="o">&</span> <span class="p">(</span><span class="n">ticks</span> <span class="o">>=</span> <span class="n">viewlim_low</span><span class="p">)</span>
<span class="n">tickvals</span> <span class="o">=</span> <span class="n">ticks</span><span class="p">[</span><span class="n">cond</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">tickvals</span><span class="p">):</span>
<span class="c1"># A tick is less than or equal to lowest data point.</span>
<span class="n">low</span> <span class="o">=</span> <span class="n">tickvals</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># No tick is available</span>
<span class="n">low</span> <span class="o">=</span> <span class="n">datalim_low</span>
<span class="n">low</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">low</span><span class="p">,</span> <span class="n">viewlim_low</span><span class="p">)</span>
<span class="k">if</span> <span class="n">datalim_high</span> <span class="o">></span> <span class="n">viewlim_high</span><span class="p">:</span>
<span class="c1"># Data extends past view. Clip line to view.</span>
<span class="n">high</span> <span class="o">=</span> <span class="n">viewlim_high</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Data ends before view ends.</span>
<span class="n">cond</span> <span class="o">=</span> <span class="p">(</span><span class="n">ticks</span> <span class="o">>=</span> <span class="n">datalim_high</span><span class="p">)</span> <span class="o">&</span> <span class="p">(</span><span class="n">ticks</span> <span class="o"><=</span> <span class="n">viewlim_high</span><span class="p">)</span>
<span class="n">tickvals</span> <span class="o">=</span> <span class="n">ticks</span><span class="p">[</span><span class="n">cond</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">tickvals</span><span class="p">):</span>
<span class="c1"># A tick is greater than or equal to highest data</span>
<span class="c1"># point.</span>
<span class="n">high</span> <span class="o">=</span> <span class="n">tickvals</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># No tick is available</span>
<span class="n">high</span> <span class="o">=</span> <span class="n">datalim_high</span>
<span class="n">high</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">high</span><span class="p">,</span> <span class="n">viewlim_high</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">low</span><span class="p">,</span> <span class="n">high</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bounds</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_patch_type</span> <span class="o">==</span> <span class="s1">'arc'</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'bottom'</span><span class="p">,</span> <span class="s1">'top'</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">direction</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">get_theta_direction</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="n">direction</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">offset</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">get_theta_offset</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">low</span> <span class="o">=</span> <span class="n">low</span> <span class="o">*</span> <span class="n">direction</span> <span class="o">+</span> <span class="n">offset</span>
<span class="n">high</span> <span class="o">=</span> <span class="n">high</span> <span class="o">*</span> <span class="n">direction</span> <span class="o">+</span> <span class="n">offset</span>
<span class="k">if</span> <span class="n">low</span> <span class="o">></span> <span class="n">high</span><span class="p">:</span>
<span class="n">low</span><span class="p">,</span> <span class="n">high</span> <span class="o">=</span> <span class="n">high</span><span class="p">,</span> <span class="n">low</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">mpath</span><span class="o">.</span><span class="n">Path</span><span class="o">.</span><span class="n">arc</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">rad2deg</span><span class="p">(</span><span class="n">low</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">rad2deg</span><span class="p">(</span><span class="n">high</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="o">==</span> <span class="s1">'bottom'</span><span class="p">:</span>
<span class="n">rmin</span><span class="p">,</span> <span class="n">rmax</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">viewLim</span><span class="o">.</span><span class="n">intervaly</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">rorigin</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">get_rorigin</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="n">rorigin</span> <span class="o">=</span> <span class="n">rmin</span>
<span class="n">scaled_diameter</span> <span class="o">=</span> <span class="p">(</span><span class="n">rmin</span> <span class="o">-</span> <span class="n">rorigin</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">rmax</span> <span class="o">-</span> <span class="n">rorigin</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_height</span> <span class="o">=</span> <span class="n">scaled_diameter</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_width</span> <span class="o">=</span> <span class="n">scaled_diameter</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'unable to set bounds for spine "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span>
<span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">v1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="o">.</span><span class="n">vertices</span>
<span class="k">assert</span> <span class="n">v1</span><span class="o">.</span><span class="n">shape</span> <span class="o">==</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="s1">'unexpected vertices shape'</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">]:</span>
<span class="n">v1</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">low</span>
<span class="n">v1</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">high</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'bottom'</span><span class="p">,</span> <span class="s1">'top'</span><span class="p">]:</span>
<span class="n">v1</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">low</span>
<span class="n">v1</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">high</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'unable to set bounds for spine "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span>
<span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span><span class="p">)</span>
<div class="viewcode-block" id="Spine.draw"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.draw">[docs]</a> <span class="nd">@allow_rasterization</span>
<span class="k">def</span> <span class="nf">draw</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_adjust_location</span><span class="p">()</span>
<span class="n">ret</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">draw</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">return</span> <span class="n">ret</span></div>
<span class="k">def</span> <span class="nf">_calc_offset_transform</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""calculate the offset transform performed by the spine"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_ensure_position_is_set</span><span class="p">()</span>
<span class="n">position</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_position</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">position</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">if</span> <span class="n">position</span> <span class="o">==</span> <span class="s1">'center'</span><span class="p">:</span>
<span class="n">position</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'axes'</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">position</span> <span class="o">==</span> <span class="s1">'zero'</span><span class="p">:</span>
<span class="n">position</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'data'</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">position</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">"position should be 2-tuple"</span>
<span class="n">position_type</span><span class="p">,</span> <span class="n">amount</span> <span class="o">=</span> <span class="n">position</span>
<span class="k">assert</span> <span class="n">position_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'axes'</span><span class="p">,</span> <span class="s1">'outward'</span><span class="p">,</span> <span class="s1">'data'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">position_type</span> <span class="o">==</span> <span class="s1">'outward'</span><span class="p">:</span>
<span class="k">if</span> <span class="n">amount</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="c1"># short circuit commonest case</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'identity'</span><span class="p">,</span>
<span class="n">mtransforms</span><span class="o">.</span><span class="n">IdentityTransform</span><span class="p">())</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">,</span> <span class="s1">'top'</span><span class="p">,</span> <span class="s1">'bottom'</span><span class="p">]:</span>
<span class="n">offset_vec</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'left'</span><span class="p">:</span> <span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="s1">'right'</span><span class="p">:</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="s1">'bottom'</span><span class="p">:</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">),</span>
<span class="s1">'top'</span><span class="p">:</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="p">}[</span><span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span><span class="p">]</span>
<span class="c1"># calculate x and y offset in dots</span>
<span class="n">offset_x</span> <span class="o">=</span> <span class="n">amount</span> <span class="o">*</span> <span class="n">offset_vec</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">/</span> <span class="mf">72.0</span>
<span class="n">offset_y</span> <span class="o">=</span> <span class="n">amount</span> <span class="o">*</span> <span class="n">offset_vec</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">/</span> <span class="mf">72.0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'post'</span><span class="p">,</span>
<span class="n">mtransforms</span><span class="o">.</span><span class="n">ScaledTranslation</span><span class="p">(</span>
<span class="n">offset_x</span><span class="p">,</span>
<span class="n">offset_y</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="o">.</span><span class="n">dpi_scale_trans</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'unknown spine type "</span><span class="si">%s</span><span class="s1">": no spine '</span>
<span class="s1">'offset performed'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'identity'</span><span class="p">,</span>
<span class="n">mtransforms</span><span class="o">.</span><span class="n">IdentityTransform</span><span class="p">())</span>
<span class="k">elif</span> <span class="n">position_type</span> <span class="o">==</span> <span class="s1">'axes'</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'pre'</span><span class="p">,</span>
<span class="n">mtransforms</span><span class="o">.</span><span class="n">Affine2D</span><span class="o">.</span><span class="n">from_values</span><span class="p">(</span>
<span class="c1"># keep y unchanged, fix x at</span>
<span class="c1"># amount</span>
<span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">amount</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'bottom'</span><span class="p">,</span> <span class="s1">'top'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'pre'</span><span class="p">,</span>
<span class="n">mtransforms</span><span class="o">.</span><span class="n">Affine2D</span><span class="o">.</span><span class="n">from_values</span><span class="p">(</span>
<span class="c1"># keep x unchanged, fix y at</span>
<span class="c1"># amount</span>
<span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">amount</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'unknown spine type "</span><span class="si">%s</span><span class="s1">": no spine '</span>
<span class="s1">'offset performed'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'identity'</span><span class="p">,</span>
<span class="n">mtransforms</span><span class="o">.</span><span class="n">IdentityTransform</span><span class="p">())</span>
<span class="k">elif</span> <span class="n">position_type</span> <span class="o">==</span> <span class="s1">'data'</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'right'</span><span class="p">,</span> <span class="s1">'top'</span><span class="p">):</span>
<span class="c1"># The right and top spines have a default position of 1 in</span>
<span class="c1"># axes coordinates. When specifying the position in data</span>
<span class="c1"># coordinates, we need to calculate the position relative to 0.</span>
<span class="n">amount</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'data'</span><span class="p">,</span>
<span class="n">mtransforms</span><span class="o">.</span><span class="n">Affine2D</span><span class="p">()</span><span class="o">.</span><span class="n">translate</span><span class="p">(</span>
<span class="n">amount</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'bottom'</span><span class="p">,</span> <span class="s1">'top'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'data'</span><span class="p">,</span>
<span class="n">mtransforms</span><span class="o">.</span><span class="n">Affine2D</span><span class="p">()</span><span class="o">.</span><span class="n">translate</span><span class="p">(</span>
<span class="mi">0</span><span class="p">,</span> <span class="n">amount</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'unknown spine type "</span><span class="si">%s</span><span class="s1">": no spine '</span>
<span class="s1">'offset performed'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'identity'</span><span class="p">,</span>
<span class="n">mtransforms</span><span class="o">.</span><span class="n">IdentityTransform</span><span class="p">())</span>
<div class="viewcode-block" id="Spine.set_position"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.set_position">[docs]</a> <span class="k">def</span> <span class="nf">set_position</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">position</span><span class="p">):</span>
<span class="sd">"""set the position of the spine</span>
<span class="sd"> Spine position is specified by a 2 tuple of (position type,</span>
<span class="sd"> amount). The position types are:</span>
<span class="sd"> * 'outward' : place the spine out from the data area by the</span>
<span class="sd"> specified number of points. (Negative values specify placing the</span>
<span class="sd"> spine inward.)</span>
<span class="sd"> * 'axes' : place the spine at the specified Axes coordinate (from</span>
<span class="sd"> 0.0-1.0).</span>
<span class="sd"> * 'data' : place the spine at the specified data coordinate.</span>
<span class="sd"> Additionally, shorthand notations define a special positions:</span>
<span class="sd"> * 'center' -> ('axes',0.5)</span>
<span class="sd"> * 'zero' -> ('data', 0.0)</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">position</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'center'</span><span class="p">,</span> <span class="s1">'zero'</span><span class="p">):</span>
<span class="c1"># special positions</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">position</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"position should be 'center' or 2-tuple"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">position</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'outward'</span><span class="p">,</span> <span class="s1">'axes'</span><span class="p">,</span> <span class="s1">'data'</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"position[0] should be one of 'outward', "</span>
<span class="s2">"'axes', or 'data' "</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_position</span> <span class="o">=</span> <span class="n">position</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_calc_offset_transform</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_transform</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_spine_transform</span><span class="p">())</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">axis</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axis</span><span class="o">.</span><span class="n">reset_ticks</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Spine.get_position"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.get_position">[docs]</a> <span class="k">def</span> <span class="nf">get_position</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""get the spine position"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_ensure_position_is_set</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_position</span></div>
<div class="viewcode-block" id="Spine.get_spine_transform"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.get_spine_transform">[docs]</a> <span class="k">def</span> <span class="nf">get_spine_transform</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""get the spine transform"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_ensure_position_is_set</span><span class="p">()</span>
<span class="n">what</span><span class="p">,</span> <span class="n">how</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_spine_transform</span>
<span class="k">if</span> <span class="n">what</span> <span class="o">==</span> <span class="s1">'data'</span><span class="p">:</span>
<span class="c1"># special case data based spine locations</span>
<span class="n">data_xform</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">transScale</span> <span class="o">+</span> \
<span class="p">(</span><span class="n">how</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">transLimits</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">transAxes</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">]:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">mtransforms</span><span class="o">.</span><span class="n">blended_transform_factory</span><span class="p">(</span>
<span class="n">data_xform</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">transData</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'top'</span><span class="p">,</span> <span class="s1">'bottom'</span><span class="p">]:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">mtransforms</span><span class="o">.</span><span class="n">blended_transform_factory</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">transData</span><span class="p">,</span> <span class="n">data_xform</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'unknown spine spine_type: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span>
<span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'left'</span><span class="p">,</span> <span class="s1">'right'</span><span class="p">]:</span>
<span class="n">base_transform</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">get_yaxis_transform</span><span class="p">(</span><span class="n">which</span><span class="o">=</span><span class="s1">'grid'</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'top'</span><span class="p">,</span> <span class="s1">'bottom'</span><span class="p">]:</span>
<span class="n">base_transform</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">get_xaxis_transform</span><span class="p">(</span><span class="n">which</span><span class="o">=</span><span class="s1">'grid'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'unknown spine spine_type: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span>
<span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span><span class="p">)</span>
<span class="k">if</span> <span class="n">what</span> <span class="o">==</span> <span class="s1">'identity'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">base_transform</span>
<span class="k">elif</span> <span class="n">what</span> <span class="o">==</span> <span class="s1">'post'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">base_transform</span> <span class="o">+</span> <span class="n">how</span>
<span class="k">elif</span> <span class="n">what</span> <span class="o">==</span> <span class="s1">'pre'</span><span class="p">:</span>
<span class="k">return</span> <span class="n">how</span> <span class="o">+</span> <span class="n">base_transform</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"unknown spine_transform type: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">what</span><span class="p">)</span></div>
<div class="viewcode-block" id="Spine.set_bounds"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.set_bounds">[docs]</a> <span class="k">def</span> <span class="nf">set_bounds</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">low</span><span class="p">,</span> <span class="n">high</span><span class="p">):</span>
<span class="sd">"""Set the bounds of the spine."""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spine_type</span> <span class="o">==</span> <span class="s1">'circle'</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">'set_bounds() method incompatible with circular spines'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_bounds</span> <span class="o">=</span> <span class="p">(</span><span class="n">low</span><span class="p">,</span> <span class="n">high</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Spine.get_bounds"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.get_bounds">[docs]</a> <span class="k">def</span> <span class="nf">get_bounds</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get the bounds of the spine."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bounds</span></div>
<div class="viewcode-block" id="Spine.linear_spine"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.linear_spine">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">linear_spine</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">axes</span><span class="p">,</span> <span class="n">spine_type</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> (staticmethod) Returns a linear :class:`Spine`.</span>
<span class="sd"> """</span>
<span class="c1"># all values of 0.999 get replaced upon call to set_bounds()</span>
<span class="k">if</span> <span class="n">spine_type</span> <span class="o">==</span> <span class="s1">'left'</span><span class="p">:</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">mpath</span><span class="o">.</span><span class="n">Path</span><span class="p">([(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.999</span><span class="p">),</span> <span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.999</span><span class="p">)])</span>
<span class="k">elif</span> <span class="n">spine_type</span> <span class="o">==</span> <span class="s1">'right'</span><span class="p">:</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">mpath</span><span class="o">.</span><span class="n">Path</span><span class="p">([(</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.999</span><span class="p">),</span> <span class="p">(</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.999</span><span class="p">)])</span>
<span class="k">elif</span> <span class="n">spine_type</span> <span class="o">==</span> <span class="s1">'bottom'</span><span class="p">:</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">mpath</span><span class="o">.</span><span class="n">Path</span><span class="p">([(</span><span class="mf">0.999</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">),</span> <span class="p">(</span><span class="mf">0.999</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">)])</span>
<span class="k">elif</span> <span class="n">spine_type</span> <span class="o">==</span> <span class="s1">'top'</span><span class="p">:</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">mpath</span><span class="o">.</span><span class="n">Path</span><span class="p">([(</span><span class="mf">0.999</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">),</span> <span class="p">(</span><span class="mf">0.999</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">)])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'unable to make path for spine "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="n">spine_type</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">axes</span><span class="p">,</span> <span class="n">spine_type</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">result</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'axes.spines.</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">spine_type</span><span class="p">)])</span>
<span class="k">return</span> <span class="n">result</span></div>
<div class="viewcode-block" id="Spine.arc_spine"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.arc_spine">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">arc_spine</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">axes</span><span class="p">,</span> <span class="n">spine_type</span><span class="p">,</span> <span class="n">center</span><span class="p">,</span> <span class="n">radius</span><span class="p">,</span> <span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> (classmethod) Returns an arc :class:`Spine`.</span>
<span class="sd"> """</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">mpath</span><span class="o">.</span><span class="n">Path</span><span class="o">.</span><span class="n">arc</span><span class="p">(</span><span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">axes</span><span class="p">,</span> <span class="n">spine_type</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">result</span><span class="o">.</span><span class="n">set_patch_arc</span><span class="p">(</span><span class="n">center</span><span class="p">,</span> <span class="n">radius</span><span class="p">,</span> <span class="n">theta1</span><span class="p">,</span> <span class="n">theta2</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span></div>
<div class="viewcode-block" id="Spine.circular_spine"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.circular_spine">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">circular_spine</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">axes</span><span class="p">,</span> <span class="n">center</span><span class="p">,</span> <span class="n">radius</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> (staticmethod) Returns a circular :class:`Spine`.</span>
<span class="sd"> """</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">mpath</span><span class="o">.</span><span class="n">Path</span><span class="o">.</span><span class="n">unit_circle</span><span class="p">()</span>
<span class="n">spine_type</span> <span class="o">=</span> <span class="s1">'circle'</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">axes</span><span class="p">,</span> <span class="n">spine_type</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">result</span><span class="o">.</span><span class="n">set_patch_circle</span><span class="p">(</span><span class="n">center</span><span class="p">,</span> <span class="n">radius</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span></div>
<div class="viewcode-block" id="Spine.set_color"><a class="viewcode-back" href="../../api/spines_api.html#matplotlib.spines.Spine.set_color">[docs]</a> <span class="k">def</span> <span class="nf">set_color</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">c</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the edgecolor.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> c : color or sequence of rgba tuples</span>
<span class="sd"> .. seealso::</span>
<span class="sd"> :meth:`set_facecolor`, :meth:`set_edgecolor`</span>
<span class="sd"> For setting the edge or face color individually.</span>
<span class="sd"> """</span>
<span class="c1"># The facecolor of a spine is always 'none' by default -- let</span>
<span class="c1"># the user change it manually if desired.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_edgecolor</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div></div>
</pre></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 Nov 11, 2018.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.1.
Doc version v3.0.2-2-g91e2d00a8.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.