-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathartist_api.html
More file actions
6857 lines (6379 loc) · 482 KB
/
artist_api.html
File metadata and controls
6857 lines (6379 loc) · 482 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
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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>artists — Matplotlib 1.3.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.3.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.3.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.3.1 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="axes" href="axes_api.html" />
<link rel="prev" title="animation" href="animation_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/artist_api.html" />
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v1.3.1). For the latest version see <a href="https://matplotlib.org/stable/api/artist_api.html">https://matplotlib.org/stable/api/artist_api.html</a></div>
<!-- Piwik -->
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
}
</script>
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
piwik_action_name = '';
piwik_idsite = 1;
piwik_url = pkBaseURL + "piwik.php";
piwik_log(piwik_action_name, piwik_idsite, piwik_url);
document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));
}
</script>
<!-- End Piwik Tag -->
<link rel="shortcut icon" href="_static/favicon.ico">
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="axes_api.html" title="axes"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="animation_api.html" title="animation"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">artists</a><ul>
<li><a class="reference internal" href="#module-matplotlib.artist"><tt class="docutils literal"><span class="pre">matplotlib.artist</span></tt></a></li>
<li><a class="reference internal" href="#module-matplotlib.lines"><tt class="docutils literal"><span class="pre">matplotlib.lines</span></tt></a></li>
<li><a class="reference internal" href="#module-matplotlib.patches"><tt class="docutils literal"><span class="pre">matplotlib.patches</span></tt></a></li>
<li><a class="reference internal" href="#module-matplotlib.text"><tt class="docutils literal"><span class="pre">matplotlib.text</span></tt></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="animation_api.html"
title="previous chapter">animation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="axes_api.html"
title="next chapter">axes</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/artist_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<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>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="artists">
<span id="artist-api"></span><h1>artists<a class="headerlink" href="#artists" title="Permalink to this headline">¶</a></h1>
<p class="graphviz">
<img src="../_images/inheritance-928cd1fe4ed7e1c3f23e76e43d4643820a931699.png" alt="Inheritance diagram of matplotlib.patches, matplotlib.lines, matplotlib.text" usemap="#inheritance03ab0131b5" class="inheritance"/>
<map id="inheritance03ab0131b5" name="inheritance03ab0131b5">
<area shape="rect" id="node1" href="#matplotlib.patches.Patch" title="A patch is a 2D artist with a face color and an edge color." alt="" coords="221,260,326,284"/>
<area shape="rect" id="node4" href="#matplotlib.patches.Arrow" title="An arrow patch." alt="" coords="405,4,511,28"/>
<area shape="rect" id="node7" href="#matplotlib.patches.Ellipse" title="A scale-free ellipse." alt="" coords="403,51,513,75"/>
<area shape="rect" id="node10" href="#matplotlib.patches.FancyArrowPatch" title="A fancy arrow patch. It draws an arrow using the :class:ArrowStyle." alt="" coords="371,97,545,121"/>
<area shape="rect" id="node13" href="#matplotlib.patches.RegularPolygon" title="A regular polygon patch." alt="" coords="376,144,540,168"/>
<area shape="rect" id="node24" href="#matplotlib.patches.Polygon" title="A general polygon patch." alt="" coords="398,190,518,214"/>
<area shape="rect" id="node28" href="#matplotlib.patches.Shadow" title="patches.Shadow" alt="" coords="398,237,518,260"/>
<area shape="rect" id="node30" href="#matplotlib.patches.PathPatch" title="A general polycurve path patch." alt="" coords="392,283,524,307"/>
<area shape="rect" id="node32" href="#matplotlib.patches.Wedge" title="Wedge shaped patch." alt="" coords="402,329,514,353"/>
<area shape="rect" id="node35" href="#matplotlib.patches.Rectangle" title="Draw a rectangle with lower left at *xy* = (*x*, *y*) with" alt="" coords="393,376,523,400"/>
<area shape="rect" id="node39" href="#matplotlib.patches.FancyBboxPatch" title="Draw a fancy box around a rectangle with lower left at *xy*=(*x*," alt="" coords="373,422,543,446"/>
<area shape="rect" id="node46" href="#matplotlib.patches.YAArrow" title="Yet another arrow class." alt="" coords="398,469,518,493"/>
<area shape="rect" id="node2" href="#matplotlib.artist.Artist" title="Abstract base class for someone who renders into a" alt="" coords="46,515,134,539"/>
<area shape="rect" id="node16" href="#matplotlib.text.Text" title="Handle storing and drawing of text in window or data coordinates." alt="" coords="238,515,309,539"/>
<area shape="rect" id="node21" href="#matplotlib.lines.Line2D" title="A line - the line can have both a solid linestyle connecting all" alt="" coords="227,562,320,585"/>
<area shape="rect" id="node6" href="#matplotlib.patches.ConnectionStyle" title=":class:`ConnectionStyle` is a container class which defines" alt="" coords="5,469,176,493"/>
<area shape="rect" id="node18" href="#matplotlib.patches.Circle" title="A circle patch." alt="" coords="624,4,729,28"/>
<area shape="rect" id="node26" href="#matplotlib.patches.Arc" title="An elliptical arc.  Because it performs various optimizations, it" alt="" coords="630,51,723,75"/>
<area shape="rect" id="node9" href="#matplotlib.patches.ConnectionPatch" title="A :class:`~matplotlib.patches.ConnectionPatch` class is to make" alt="" coords="590,97,763,121"/>
<area shape="rect" id="node12" href="#matplotlib.patches.CirclePolygon" title="A polygon-approximation of a circle patch." alt="" coords="600,144,753,168"/>
<area shape="rect" id="node15" href="#matplotlib.text.TextWithDash" title="This is basically a :class:`~matplotlib.text.Text` with a dash" alt="" coords="394,515,522,539"/>
<area shape="rect" id="node42" href="#matplotlib.text.Annotation" title="A :class:`~matplotlib.text.Text` class to make annotating things" alt="" coords="401,562,515,585"/>
<area shape="rect" id="node20" href="#matplotlib.patches.BoxStyle" title=":class:`BoxStyle` is a container class which defines several" alt="" coords="28,422,153,446"/>
<area shape="rect" id="node37" href="#matplotlib.patches.FancyArrow" title="Like Arrow, but lets you set head width and head height independently." alt="" coords="606,190,747,214"/>
<area shape="rect" id="node34" href="#matplotlib.patches.ArrowStyle" title=":class:`ArrowStyle` is a container class which defines several" alt="" coords="22,376,159,400"/>
<area shape="rect" id="node41" href="#matplotlib.text.OffsetFrom" title="text.OffsetFrom" alt="" coords="33,329,147,353"/>
<area shape="rect" id="node48" href="#matplotlib.lines.VertexSelector" title="Manage the callbacks to maintain a list of selected vertices for" alt="" coords="20,283,161,307"/>
</map>
</p>
<div class="section" id="module-matplotlib.artist">
<span id="matplotlib-artist"></span><h2><a class="reference internal" href="#module-matplotlib.artist" title="matplotlib.artist"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.artist</span></tt></a><a class="headerlink" href="#module-matplotlib.artist" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="matplotlib.artist.Artist">
<em class="property">class </em><tt class="descclassname">matplotlib.artist.</tt><tt class="descname">Artist</tt><a class="headerlink" href="#matplotlib.artist.Artist" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>Abstract base class for someone who renders into a
<tt class="xref py py-class docutils literal"><span class="pre">FigureCanvas</span></tt>.</p>
<dl class="method">
<dt id="matplotlib.artist.Artist.add_callback">
<tt class="descname">add_callback</tt><big>(</big><em>func</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.add_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a callback function that will be called whenever one of
the <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a>‘s properties changes.</p>
<p>Returns an <em>id</em> that is useful for removing the callback with
<a class="reference internal" href="#matplotlib.artist.Artist.remove_callback" title="matplotlib.artist.Artist.remove_callback"><tt class="xref py py-meth docutils literal"><span class="pre">remove_callback()</span></tt></a> later.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.artist.Artist.aname">
<tt class="descname">aname</tt><em class="property"> = 'Artist'</em><a class="headerlink" href="#matplotlib.artist.Artist.aname" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.contains">
<tt class="descname">contains</tt><big>(</big><em>mouseevent</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the artist contains the mouse event.</p>
<p>Returns the truth value and a dictionary of artist specific details of
selection, such as which points are contained in the pick radius. See
individual artists for details.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.convert_xunits">
<tt class="descname">convert_xunits</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.convert_xunits" title="Permalink to this definition">¶</a></dt>
<dd><p>For artists in an axes, if the xaxis has units support,
convert <em>x</em> using xaxis unit type</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.convert_yunits">
<tt class="descname">convert_yunits</tt><big>(</big><em>y</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.convert_yunits" title="Permalink to this definition">¶</a></dt>
<dd><p>For artists in an axes, if the yaxis has units support,
convert <em>y</em> using yaxis unit type</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.draw">
<tt class="descname">draw</tt><big>(</big><em>renderer</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Derived classes drawing method</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.findobj">
<tt class="descname">findobj</tt><big>(</big><em>match=None</em>, <em>include_self=True</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.findobj" title="Permalink to this definition">¶</a></dt>
<dd><p>Find artist objects.</p>
<p>Recursively find all <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> instances
contained in self.</p>
<p><em>match</em> can be</p>
<blockquote>
<div><ul class="simple">
<li>None: return all objects contained in artist.</li>
<li>function with signature <tt class="docutils literal"><span class="pre">boolean</span> <span class="pre">=</span> <span class="pre">match(artist)</span></tt>
used to filter matches</li>
<li>class instance: e.g., Line2D. Only return artists of class type.</li>
</ul>
</div></blockquote>
<p>If <em>include_self</em> is True (default), include self in the list to be
checked for a match.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_agg_filter">
<tt class="descname">get_agg_filter</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_agg_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>return filter function to be used for agg filter</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_alpha">
<tt class="descname">get_alpha</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the alpha value used for blending - not supported on all
backends</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_animated">
<tt class="descname">get_animated</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_animated" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the artist’s animated state</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_axes">
<tt class="descname">get_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">Axes</span></tt></a> instance the artist
resides in, or <em>None</em></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_children">
<tt class="descname">get_children</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the child <tt class="xref py py-class docutils literal"><span class="pre">Artist`s</span> <span class="pre">this</span>
<span class="pre">:class:`Artist</span></tt> contains.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_clip_box">
<tt class="descname">get_clip_box</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_clip_box" title="Permalink to this definition">¶</a></dt>
<dd><p>Return artist clipbox</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_clip_on">
<tt class="descname">get_clip_on</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_clip_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether artist uses clipping</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_clip_path">
<tt class="descname">get_clip_path</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Return artist clip path</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_contains">
<tt class="descname">get_contains</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the _contains test used by the artist, or <em>None</em> for default.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_figure">
<tt class="descname">get_figure</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">Figure</span></tt></a> instance the
artist belongs to.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_gid">
<tt class="descname">get_gid</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_gid" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the group id</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_label">
<tt class="descname">get_label</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the label used for this artist in the legend.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_path_effects">
<tt class="descname">get_path_effects</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_path_effects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_picker">
<tt class="descname">get_picker</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_picker" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the picker object used by this artist</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_rasterized">
<tt class="descname">get_rasterized</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_rasterized" title="Permalink to this definition">¶</a></dt>
<dd><p>return True if the artist is to be rasterized</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_sketch_params">
<tt class="descname">get_sketch_params</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_sketch_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the sketch parameters for the artist.</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">Returns:</th><td class="field-body"><p class="first"><strong>sketch_params</strong> : tuple or <tt class="xref py py-obj docutils literal"><span class="pre">None</span></tt></p>
<p><strong>A 3-tuple with the following elements:</strong> :</p>
<blockquote>
<div><ul class="simple">
<li><tt class="xref py py-obj docutils literal"><span class="pre">scale</span></tt>: The amplitude of the wiggle perpendicular to the
source line.</li>
<li><tt class="xref py py-obj docutils literal"><span class="pre">length</span></tt>: The length of the wiggle along the line.</li>
<li><tt class="xref py py-obj docutils literal"><span class="pre">randomness</span></tt>: The scale factor by which the length is
shrunken or expanded.</li>
</ul>
</div></blockquote>
<p class="last"><strong>May return `None` if no sketch parameters were set.</strong> :</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_snap">
<tt class="descname">get_snap</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_snap" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the snap setting which may be:</p>
<blockquote>
<div><ul class="simple">
<li>True: snap vertices to the nearest pixel center</li>
<li>False: leave vertices as-is</li>
<li>None: (auto) If the path contains only rectilinear line
segments, round to the nearest pixel center</li>
</ul>
</div></blockquote>
<p>Only supported by the Agg and MacOSX backends.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_transform">
<tt class="descname">get_transform</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a>
instance used by this artist.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_transformed_clip_path_and_affine">
<tt class="descname">get_transformed_clip_path_and_affine</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_transformed_clip_path_and_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the clip path with the non-affine part of its
transformation applied, and the remaining affine part of its
transformation.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_url">
<tt class="descname">get_url</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the url</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_visible">
<tt class="descname">get_visible</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_visible" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the artist’s visiblity</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_window_extent">
<tt class="descname">get_window_extent</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the axes bounding box in display space.
Subclasses should override for inclusion in the bounding box
“tight” calculation. Default is to return an empty bounding
box at 0, 0.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.get_zorder">
<tt class="descname">get_zorder</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.get_zorder" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a>‘s zorder.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.have_units">
<tt class="descname">have_units</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.have_units" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if units are set on the <em>x</em> or <em>y</em> axes</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.hitlist">
<tt class="descname">hitlist</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.hitlist" title="Permalink to this definition">¶</a></dt>
<dd><p>List the children of the artist which contain the mouse event <em>event</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.is_figure_set">
<tt class="descname">is_figure_set</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.is_figure_set" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the artist is assigned to a
<a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">Figure</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.is_transform_set">
<tt class="descname">is_transform_set</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.is_transform_set" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <em>True</em> if <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> has a transform explicitly
set.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.pchanged">
<tt class="descname">pchanged</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.pchanged" title="Permalink to this definition">¶</a></dt>
<dd><p>Fire an event when property changed, calling all of the
registered callbacks.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.pick">
<tt class="descname">pick</tt><big>(</big><em>mouseevent</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.pick" title="Permalink to this definition">¶</a></dt>
<dd><p>call signature:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">pick</span><span class="p">(</span><span class="n">mouseevent</span><span class="p">)</span>
</pre></div>
</div>
<p>each child artist will fire a pick event if <em>mouseevent</em> is over
the artist and the artist has picker set</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.pickable">
<tt class="descname">pickable</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.pickable" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> is pickable.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.properties">
<tt class="descname">properties</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.properties" title="Permalink to this definition">¶</a></dt>
<dd><p>return a dictionary mapping property name -> value for all Artist props</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.remove">
<tt class="descname">remove</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the artist from the figure if possible. The effect
will not be visible until the figure is redrawn, e.g., with
<tt class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.draw_idle()</span></tt>. Call
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.relim" title="matplotlib.axes.Axes.relim"><tt class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.relim()</span></tt></a> to update the axes limits
if desired.</p>
<p>Note: <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.relim" title="matplotlib.axes.Axes.relim"><tt class="xref py py-meth docutils literal"><span class="pre">relim()</span></tt></a> will not see
collections even if the collection was added to axes with
<em>autolim</em> = True.</p>
<p>Note: there is no support for removing the artist’s legend entry.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.remove_callback">
<tt class="descname">remove_callback</tt><big>(</big><em>oid</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.remove_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a callback based on its <em>id</em>.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="#matplotlib.artist.Artist.add_callback" title="matplotlib.artist.Artist.add_callback"><tt class="xref py py-meth docutils literal"><span class="pre">add_callback()</span></tt></a></dt>
<dd>For adding callbacks</dd>
</dl>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set">
<tt class="descname">set</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set" title="Permalink to this definition">¶</a></dt>
<dd><p>A tkstyle set command, pass <em>kwargs</em> to set properties</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_agg_filter">
<tt class="descname">set_agg_filter</tt><big>(</big><em>filter_func</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_agg_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>set agg_filter fuction.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_alpha">
<tt class="descname">set_alpha</tt><big>(</big><em>alpha</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the alpha value used for blending - not supported on
all backends.</p>
<p>ACCEPTS: float (0.0 transparent through 1.0 opaque)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_animated">
<tt class="descname">set_animated</tt><big>(</big><em>b</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_animated" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s animation state.</p>
<p>ACCEPTS: [True | False]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_axes">
<tt class="descname">set_axes</tt><big>(</big><em>axes</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">Axes</span></tt></a> instance in which the
artist resides, if any.</p>
<p>ACCEPTS: an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">Axes</span></tt></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_clip_box">
<tt class="descname">set_clip_box</tt><big>(</big><em>clipbox</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_clip_box" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s clip <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><tt class="xref py py-class docutils literal"><span class="pre">Bbox</span></tt></a>.</p>
<p>ACCEPTS: a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Bbox</span></tt></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_clip_on">
<tt class="descname">set_clip_on</tt><big>(</big><em>b</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_clip_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Set whether artist uses clipping.</p>
<p>ACCEPTS: [True | False]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_clip_path">
<tt class="descname">set_clip_path</tt><big>(</big><em>path</em>, <em>transform=None</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s clip path, which may be:</p>
<blockquote>
<div><ul>
<li><p class="first">a <a class="reference internal" href="#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><tt class="xref py py-class docutils literal"><span class="pre">Patch</span></tt></a> (or subclass) instance</p>
</li>
<li><dl class="first docutils">
<dt>a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> instance, in which case</dt>
<dd><p class="first last">an optional <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a>
instance may be provided, which will be applied to the
path before using it for clipping.</p>
</dd>
</dl>
</li>
<li><p class="first"><em>None</em>, to remove the clipping path</p>
</li>
</ul>
</div></blockquote>
<p>For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to <em>None</em>.</p>
<p>ACCEPTS: [ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a>,
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a>) |
<a class="reference internal" href="#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><tt class="xref py py-class docutils literal"><span class="pre">Patch</span></tt></a> | None ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_contains">
<tt class="descname">set_contains</tt><big>(</big><em>picker</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Replace the contains test used by this artist. The new picker
should be a callable function which determines whether the
artist is hit by the mouse event:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">hit</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="n">picker</span><span class="p">(</span><span class="n">artist</span><span class="p">,</span> <span class="n">mouseevent</span><span class="p">)</span>
</pre></div>
</div>
<p>If the mouse event is over the artist, return <em>hit</em> = <em>True</em>
and <em>props</em> is a dictionary of properties you want returned
with the contains test.</p>
<p>ACCEPTS: a callable function</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_figure">
<tt class="descname">set_figure</tt><big>(</big><em>fig</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">Figure</span></tt></a> instance the artist
belongs to.</p>
<p>ACCEPTS: a <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></tt></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_gid">
<tt class="descname">set_gid</tt><big>(</big><em>gid</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_gid" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the (group) id for the artist</p>
<p>ACCEPTS: an id string</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_label">
<tt class="descname">set_label</tt><big>(</big><em>s</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the label to <em>s</em> for auto legend.</p>
<p>ACCEPTS: string or anything printable with ‘%s’ conversion.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_lod">
<tt class="descname">set_lod</tt><big>(</big><em>on</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_lod" title="Permalink to this definition">¶</a></dt>
<dd><p>Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly</p>
<p>ACCEPTS: [True | False]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_path_effects">
<tt class="descname">set_path_effects</tt><big>(</big><em>path_effects</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_path_effects" title="Permalink to this definition">¶</a></dt>
<dd><p>set path_effects, which should be a list of instances of
matplotlib.patheffect._Base class or its derivatives.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_picker">
<tt class="descname">set_picker</tt><big>(</big><em>picker</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_picker" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the epsilon for picking used by this artist</p>
<p><em>picker</em> can be one of the following:</p>
<blockquote>
<div><ul>
<li><p class="first"><em>None</em>: picking is disabled for this artist (default)</p>
</li>
<li><p class="first">A boolean: if <em>True</em> then picking will be enabled and the
artist will fire a pick event if the mouse event is over
the artist</p>
</li>
<li><p class="first">A float: if picker is a number it is interpreted as an
epsilon tolerance in points and the artist will fire
off an event if it’s data is within epsilon of the mouse
event. For some artists like lines and patch collections,
the artist may provide additional data to the pick event
that is generated, e.g., the indices of the data within
epsilon of the pick event</p>
</li>
<li><p class="first">A function: if picker is callable, it is a user supplied
function which determines whether the artist is hit by the
mouse event:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">hit</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="n">picker</span><span class="p">(</span><span class="n">artist</span><span class="p">,</span> <span class="n">mouseevent</span><span class="p">)</span>
</pre></div>
</div>
<p>to determine the hit test. if the mouse event is over the
artist, return <em>hit=True</em> and props is a dictionary of
properties you want added to the PickEvent attributes.</p>
</li>
</ul>
</div></blockquote>
<p>ACCEPTS: [None|float|boolean|callable]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_rasterized">
<tt class="descname">set_rasterized</tt><big>(</big><em>rasterized</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_rasterized" title="Permalink to this definition">¶</a></dt>
<dd><p>Force rasterized (bitmap) drawing in vector backend output.</p>
<p>Defaults to None, which implies the backend’s default behavior</p>
<p>ACCEPTS: [True | False | None]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_sketch_params">
<tt class="descname">set_sketch_params</tt><big>(</big><em>scale=None</em>, <em>length=None</em>, <em>randomness=None</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_sketch_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the the sketch parameters.</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"><p class="first"><strong>scale</strong> : float, optional</p>
<blockquote>
<div><p>The amplitude of the wiggle perpendicular to the source
line, in pixels. If scale is <tt class="xref py py-obj docutils literal"><span class="pre">None</span></tt>, or not provided, no
sketch filter will be provided.</p>
</div></blockquote>
<p><strong>length</strong> : float, optional</p>
<blockquote>
<div><p>The length of the wiggle along the line, in pixels
(default 128.0)</p>
</div></blockquote>
<p><strong>randomness</strong> : float, optional</p>
<blockquote class="last">
<div><p>The scale factor by which the length is shrunken or
expanded (default 16.0)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_snap">
<tt class="descname">set_snap</tt><big>(</big><em>snap</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_snap" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the snap setting which may be:</p>
<blockquote>
<div><ul class="simple">
<li>True: snap vertices to the nearest pixel center</li>
<li>False: leave vertices as-is</li>
<li>None: (auto) If the path contains only rectilinear line
segments, round to the nearest pixel center</li>
</ul>
</div></blockquote>
<p>Only supported by the Agg and MacOSX backends.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_transform">
<tt class="descname">set_transform</tt><big>(</big><em>t</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> instance
used by this artist.</p>
<p>ACCEPTS: <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_url">
<tt class="descname">set_url</tt><big>(</big><em>url</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the url for the artist</p>
<p>ACCEPTS: a url string</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_visible">
<tt class="descname">set_visible</tt><big>(</big><em>b</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_visible" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s visiblity.</p>
<p>ACCEPTS: [True | False]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.set_zorder">
<tt class="descname">set_zorder</tt><big>(</big><em>level</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.set_zorder" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the zorder for the artist. Artists with lower zorder
values are drawn first.</p>
<p>ACCEPTS: any number</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.update">
<tt class="descname">update</tt><big>(</big><em>props</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the properties of this <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> from the
dictionary <em>prop</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.Artist.update_from">
<tt class="descname">update_from</tt><big>(</big><em>other</em><big>)</big><a class="headerlink" href="#matplotlib.artist.Artist.update_from" title="Permalink to this definition">¶</a></dt>
<dd><p>Copy properties from <em>other</em> to <em>self</em>.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.artist.Artist.zorder">
<tt class="descname">zorder</tt><em class="property"> = 0</em><a class="headerlink" href="#matplotlib.artist.Artist.zorder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.artist.ArtistInspector">
<em class="property">class </em><tt class="descclassname">matplotlib.artist.</tt><tt class="descname">ArtistInspector</tt><big>(</big><em>o</em><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector" title="Permalink to this definition">¶</a></dt>
<dd><p>A helper class to inspect an <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a>
and return information about it’s settable properties and their
current values.</p>
<p>Initialize the artist inspector with an
<a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> or sequence of <tt class="xref py py-class docutils literal"><span class="pre">Artists</span></tt>.
If a sequence is used, we assume it is a homogeneous sequence (all
<tt class="xref py py-class docutils literal"><span class="pre">Artists</span></tt> are of the same type) and it is your responsibility
to make sure this is so.</p>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.aliased_name">
<tt class="descname">aliased_name</tt><big>(</big><em>s</em><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.aliased_name" title="Permalink to this definition">¶</a></dt>
<dd><p>return ‘PROPNAME or alias’ if <em>s</em> has an alias, else return
PROPNAME.</p>
<p>e.g., for the line markerfacecolor property, which has an
alias, return ‘markerfacecolor or mfc’ and for the transform
property, which does not, return ‘transform’</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.aliased_name_rest">
<tt class="descname">aliased_name_rest</tt><big>(</big><em>s</em>, <em>target</em><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.aliased_name_rest" title="Permalink to this definition">¶</a></dt>
<dd><p>return ‘PROPNAME or alias’ if <em>s</em> has an alias, else return
PROPNAME formatted for ReST</p>
<p>e.g., for the line markerfacecolor property, which has an
alias, return ‘markerfacecolor or mfc’ and for the transform
property, which does not, return ‘transform’</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.findobj">
<tt class="descname">findobj</tt><big>(</big><em>match=None</em><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.findobj" title="Permalink to this definition">¶</a></dt>
<dd><p>Recursively find all <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.artist.Artist</span></tt></a>
instances contained in <em>self</em>.</p>
<p>If <em>match</em> is not None, it can be</p>
<blockquote>
<div><ul class="simple">
<li>function with signature <tt class="docutils literal"><span class="pre">boolean</span> <span class="pre">=</span> <span class="pre">match(artist)</span></tt></li>
<li>class instance: e.g., <a class="reference internal" href="#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><tt class="xref py py-class docutils literal"><span class="pre">Line2D</span></tt></a></li>
</ul>
</div></blockquote>
<p>used to filter matches.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.get_aliases">
<tt class="descname">get_aliases</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.get_aliases" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a dict mapping <em>fullname</em> -> <em>alias</em> for each <em>alias</em> in
the <a class="reference internal" href="#matplotlib.artist.ArtistInspector" title="matplotlib.artist.ArtistInspector"><tt class="xref py py-class docutils literal"><span class="pre">ArtistInspector</span></tt></a>.</p>
<p>e.g., for lines:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span><span class="s">'markerfacecolor'</span><span class="p">:</span> <span class="s">'mfc'</span><span class="p">,</span>
<span class="s">'linewidth'</span> <span class="p">:</span> <span class="s">'lw'</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.get_setters">
<tt class="descname">get_setters</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.get_setters" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the attribute strings with setters for object. e.g., for a line,
return <tt class="docutils literal"><span class="pre">['markerfacecolor',</span> <span class="pre">'linewidth',</span> <span class="pre">....]</span></tt>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.get_valid_values">
<tt class="descname">get_valid_values</tt><big>(</big><em>attr</em><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.get_valid_values" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the legal arguments for the setter associated with <em>attr</em>.</p>
<p>This is done by querying the docstring of the function <em>set_attr</em>
for a line that begins with ACCEPTS:</p>
<p>e.g., for a line linestyle, return
“[ <tt class="docutils literal"><span class="pre">'-'</span></tt> | <tt class="docutils literal"><span class="pre">'--'</span></tt> | <tt class="docutils literal"><span class="pre">'-.'</span></tt> | <tt class="docutils literal"><span class="pre">':'</span></tt> | <tt class="docutils literal"><span class="pre">'steps'</span></tt> | <tt class="docutils literal"><span class="pre">'None'</span></tt> ]”</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.is_alias">
<tt class="descname">is_alias</tt><big>(</big><em>o</em><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.is_alias" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if method object <em>o</em> is an alias for another
function.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.pprint_getters">
<tt class="descname">pprint_getters</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.pprint_getters" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the getters and actual values as list of strings.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.pprint_setters">
<tt class="descname">pprint_setters</tt><big>(</big><em>prop=None</em>, <em>leadingspace=2</em><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.pprint_setters" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>prop</em> is <em>None</em>, return a list of strings of all settable properies
and their valid values.</p>
<p>If <em>prop</em> is not <em>None</em>, it is a valid property name and that
property will be returned as a string of property : valid
values.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.pprint_setters_rest">
<tt class="descname">pprint_setters_rest</tt><big>(</big><em>prop=None</em>, <em>leadingspace=2</em><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.pprint_setters_rest" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>prop</em> is <em>None</em>, return a list of strings of all settable properies
and their valid values. Format the output for ReST</p>
<p>If <em>prop</em> is not <em>None</em>, it is a valid property name and that
property will be returned as a string of property : valid
values.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.artist.ArtistInspector.properties">
<tt class="descname">properties</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.artist.ArtistInspector.properties" title="Permalink to this definition">¶</a></dt>
<dd><p>return a dictionary mapping property name -> value</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.artist.allow_rasterization">
<tt class="descclassname">matplotlib.artist.</tt><tt class="descname">allow_rasterization</tt><big>(</big><em>draw</em><big>)</big><a class="headerlink" href="#matplotlib.artist.allow_rasterization" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator for Artist.draw method. Provides routines
that run before and after the draw call. The before and after functions
are useful for changing artist-dependant renderer attributes or making
other setup function calls, such as starting and flushing a mixed-mode
renderer.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.artist.get">
<tt class="descclassname">matplotlib.artist.</tt><tt class="descname">get</tt><big>(</big><em>obj</em>, <em>property=None</em><big>)</big><a class="headerlink" href="#matplotlib.artist.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the value of object’s property. <em>property</em> is an optional string
for the property you want to return</p>
<p>Example usage:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">getp</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="c"># get all the object properties</span>
<span class="n">getp</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">'linestyle'</span><span class="p">)</span> <span class="c"># get the linestyle property</span>
</pre></div>
</div>
<p><em>obj</em> is a <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> instance, e.g.,
<tt class="xref py py-class docutils literal"><span class="pre">Line2D</span></tt> or an instance of a
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">Axes</span></tt></a> or <a class="reference internal" href="#matplotlib.text.Text" title="matplotlib.text.Text"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.text.Text</span></tt></a>.
If the <em>property</em> is ‘somename’, this function returns</p>
<blockquote>
<div>obj.get_somename()</div></blockquote>
<p><a class="reference internal" href="#matplotlib.artist.getp" title="matplotlib.artist.getp"><tt class="xref py py-func docutils literal"><span class="pre">getp()</span></tt></a> can be used to query all the gettable properties with
<tt class="docutils literal"><span class="pre">getp(obj)</span></tt>. Many properties have aliases for shorter typing, e.g.
‘lw’ is an alias for ‘linewidth’. In the output, aliases and full
property names will be listed as:</p>
<blockquote>
<div>property or alias = value</div></blockquote>
<p>e.g.:</p>
<blockquote>
<div>linewidth or lw = 2</div></blockquote>
</dd></dl>
<dl class="function">
<dt id="matplotlib.artist.getp">
<tt class="descclassname">matplotlib.artist.</tt><tt class="descname">getp</tt><big>(</big><em>obj</em>, <em>property=None</em><big>)</big><a class="headerlink" href="#matplotlib.artist.getp" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the value of object’s property. <em>property</em> is an optional string
for the property you want to return</p>
<p>Example usage:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">getp</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="c"># get all the object properties</span>
<span class="n">getp</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">'linestyle'</span><span class="p">)</span> <span class="c"># get the linestyle property</span>
</pre></div>
</div>
<p><em>obj</em> is a <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> instance, e.g.,
<tt class="xref py py-class docutils literal"><span class="pre">Line2D</span></tt> or an instance of a
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">Axes</span></tt></a> or <a class="reference internal" href="#matplotlib.text.Text" title="matplotlib.text.Text"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.text.Text</span></tt></a>.
If the <em>property</em> is ‘somename’, this function returns</p>
<blockquote>
<div>obj.get_somename()</div></blockquote>
<p><a class="reference internal" href="#matplotlib.artist.getp" title="matplotlib.artist.getp"><tt class="xref py py-func docutils literal"><span class="pre">getp()</span></tt></a> can be used to query all the gettable properties with
<tt class="docutils literal"><span class="pre">getp(obj)</span></tt>. Many properties have aliases for shorter typing, e.g.
‘lw’ is an alias for ‘linewidth’. In the output, aliases and full
property names will be listed as:</p>
<blockquote>
<div>property or alias = value</div></blockquote>
<p>e.g.:</p>
<blockquote>
<div>linewidth or lw = 2</div></blockquote>
</dd></dl>
<dl class="function">
<dt id="matplotlib.artist.kwdoc">
<tt class="descclassname">matplotlib.artist.</tt><tt class="descname">kwdoc</tt><big>(</big><em>a</em><big>)</big><a class="headerlink" href="#matplotlib.artist.kwdoc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.artist.setp">
<tt class="descclassname">matplotlib.artist.</tt><tt class="descname">setp</tt><big>(</big><em>obj</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.artist.setp" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a property on an artist object.</p>
<p>matplotlib supports the use of <a class="reference internal" href="#matplotlib.artist.setp" title="matplotlib.artist.setp"><tt class="xref py py-func docutils literal"><span class="pre">setp()</span></tt></a> (“set property”) and
<a class="reference internal" href="#matplotlib.artist.getp" title="matplotlib.artist.getp"><tt class="xref py py-func docutils literal"><span class="pre">getp()</span></tt></a> to set and get object properties, as well as to do
introspection on the object. For example, to set the linestyle of a
line to be dashed, you can do:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">line</span><span class="p">,</span> <span class="o">=</span> <span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">])</span>
<span class="gp">>>> </span><span class="n">setp</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="n">linestyle</span><span class="o">=</span><span class="s">'--'</span><span class="p">)</span>
</pre></div>
</div>
<p>If you want to know the valid types of arguments, you can provide the
name of the property you want to set without a value:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">setp</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="s">'linestyle'</span><span class="p">)</span>
<span class="go"> linestyle: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' ]</span>
</pre></div>
</div>
<p>If you want to see all the properties that can be set, and their
possible values, you can do:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">setp</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="go"> ... long output listing omitted</span>
</pre></div>
</div>
<p><a class="reference internal" href="#matplotlib.artist.setp" title="matplotlib.artist.setp"><tt class="xref py py-func docutils literal"><span class="pre">setp()</span></tt></a> operates on a single instance or a list of instances.
If you are in query mode introspecting the possible values, only
the first instance in the sequence is used. When actually setting
values, all the instances will be set. e.g., suppose you have a
list of two lines, the following will make both lines thicker and
red:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">x</span> <span class="o">=</span> <span class="n">arange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mf">1.0</span><span class="p">,</span><span class="mf">0.01</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">y1</span> <span class="o">=</span> <span class="n">sin</span><span class="p">(</span><span class="mi">2</span><span class="o">*</span><span class="n">pi</span><span class="o">*</span><span class="n">x</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">y2</span> <span class="o">=</span> <span class="n">sin</span><span class="p">(</span><span class="mi">4</span><span class="o">*</span><span class="n">pi</span><span class="o">*</span><span class="n">x</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">lines</span> <span class="o">=</span> <span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y1</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y2</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">setp</span><span class="p">(</span><span class="n">lines</span><span class="p">,</span> <span class="n">linewidth</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s">'r'</span><span class="p">)</span>
</pre></div>
</div>
<p><a class="reference internal" href="#matplotlib.artist.setp" title="matplotlib.artist.setp"><tt class="xref py py-func docutils literal"><span class="pre">setp()</span></tt></a> works with the MATLAB style string/value pairs or
with python kwargs. For example, the following are equivalent:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">setp</span><span class="p">(</span><span class="n">lines</span><span class="p">,</span> <span class="s">'linewidth'</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="s">'color'</span><span class="p">,</span> <span class="s">'r'</span><span class="p">)</span> <span class="c"># MATLAB style</span>
<span class="gp">>>> </span><span class="n">setp</span><span class="p">(</span><span class="n">lines</span><span class="p">,</span> <span class="n">linewidth</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s">'r'</span><span class="p">)</span> <span class="c"># python style</span>
</pre></div>
</div>
</dd></dl>