1.. _artist-api:
2
3===================
4 ``artist`` Module
5===================
6
7.. inheritance-diagram:: matplotlib.axes._axes.Axes matplotlib.axes._base._AxesBase matplotlib.axis.Axis matplotlib.axis.Tick matplotlib.axis.XAxis matplotlib.axis.XTick matplotlib.axis.YAxis matplotlib.axis.YTick matplotlib.collections.AsteriskPolygonCollection matplotlib.collections.BrokenBarHCollection matplotlib.collections.CircleCollection matplotlib.collections.Collection matplotlib.collections.EllipseCollection matplotlib.collections.EventCollection matplotlib.collections.LineCollection matplotlib.collections.PatchCollection matplotlib.collections.PathCollection matplotlib.collections.PolyCollection matplotlib.collections.QuadMesh matplotlib.collections.RegularPolyCollection matplotlib.collections.StarPolygonCollection matplotlib.collections.TriMesh matplotlib.collections._CollectionWithSizes matplotlib.contour.ClabelText matplotlib.figure.Figure matplotlib.image.AxesImage matplotlib.image.BboxImage matplotlib.image.FigureImage matplotlib.image.NonUniformImage matplotlib.image.PcolorImage matplotlib.image._ImageBase matplotlib.legend.Legend matplotlib.lines.Line2D matplotlib.offsetbox.AnchoredOffsetbox matplotlib.offsetbox.AnchoredText matplotlib.offsetbox.AnnotationBbox matplotlib.offsetbox.AuxTransformBox matplotlib.offsetbox.DrawingArea matplotlib.offsetbox.HPacker matplotlib.offsetbox.OffsetBox matplotlib.offsetbox.OffsetImage matplotlib.offsetbox.PackerBase matplotlib.offsetbox.PaddedBox matplotlib.offsetbox.TextArea matplotlib.offsetbox.VPacker matplotlib.patches.Arc matplotlib.patches.Arrow matplotlib.patches.Circle matplotlib.patches.CirclePolygon matplotlib.patches.ConnectionPatch matplotlib.patches.Ellipse matplotlib.patches.FancyArrow matplotlib.patches.FancyArrowPatch matplotlib.patches.FancyBboxPatch matplotlib.patches.Patch matplotlib.patches.PathPatch matplotlib.patches.Polygon matplotlib.patches.Rectangle matplotlib.patches.RegularPolygon matplotlib.patches.Shadow matplotlib.patches.Wedge matplotlib.patches.YAArrow matplotlib.projections.geo.AitoffAxes matplotlib.projections.geo.GeoAxes matplotlib.projections.geo.HammerAxes matplotlib.projections.geo.LambertAxes matplotlib.projections.geo.MollweideAxes matplotlib.projections.polar.PolarAxes matplotlib.quiver.Barbs matplotlib.quiver.Quiver matplotlib.quiver.QuiverKey matplotlib.spines.Spine matplotlib.table.Cell matplotlib.table.CustomCell matplotlib.table.Table matplotlib.text.Annotation matplotlib.text.Text matplotlib.text.TextWithDash
8   :parts: 1
9   :private-bases:
10
11
12
13.. automodule:: matplotlib.artist
14   :no-members:
15   :no-undoc-members:
16
17
18``Artist`` class
19================
20
21.. autoclass:: Artist
22   :no-members:
23   :no-undoc-members:
24
25Interactive
26-----------
27
28.. autosummary::
29   :toctree: _as_gen
30   :nosignatures:
31
32   Artist.add_callback
33   Artist.format_cursor_data
34   Artist.get_contains
35   Artist.get_cursor_data
36   Artist.get_picker
37   Artist.mouseover
38   Artist.pchanged
39   Artist.pick
40   Artist.pickable
41   Artist.remove_callback
42   Artist.set_contains
43   Artist.set_picker
44   Artist.contains
45
46Margins and Autoscaling
47-----------------------
48
49.. autosummary::
50   :toctree: _as_gen
51   :nosignatures:
52
53   Artist.sticky_edges
54
55Clipping
56--------
57
58.. autosummary::
59   :toctree: _as_gen
60   :nosignatures:
61
62   Artist.get_clip_box
63   Artist.get_clip_on
64   Artist.get_clip_path
65   Artist.set_clip_box
66   Artist.set_clip_on
67   Artist.set_clip_path
68
69Bulk Properties
70---------------
71
72.. autosummary::
73   :toctree: _as_gen
74   :nosignatures:
75
76   Artist.update
77   Artist.update_from
78   Artist.properties
79   Artist.set
80
81Drawing
82-------
83
84.. autosummary::
85   :toctree: _as_gen
86   :nosignatures:
87
88   Artist.draw
89   Artist.get_animated
90   Artist.set_animated
91
92   Artist.get_agg_filter
93
94   Artist.get_alpha
95   Artist.get_snap
96   Artist.get_visible
97   Artist.get_zorder
98   Artist.set_agg_filter
99   Artist.set_alpha
100
101   Artist.set_sketch_params
102   Artist.set_snap
103   Artist.get_rasterized
104   Artist.get_sketch_params
105   Artist.set_path_effects
106   Artist.set_rasterized
107   Artist.zorder
108   Artist.set_visible
109   Artist.set_zorder
110   Artist.get_window_extent
111   Artist.get_path_effects
112   Artist.get_transformed_clip_path_and_affine
113
114Figure and Axes
115---------------
116
117.. autosummary::
118   :toctree: _as_gen
119   :nosignatures:
120
121   Artist.remove
122
123   Artist.axes
124
125   Artist.set_figure
126   Artist.get_figure
127
128Children
129--------
130
131.. autosummary::
132   :toctree: _as_gen
133   :nosignatures:
134
135   Artist.get_children
136   Artist.findobj
137
138Transform
139---------
140
141.. autosummary::
142   :toctree: _as_gen
143   :nosignatures:
144
145   Artist.set_transform
146   Artist.get_transform
147   Artist.is_transform_set
148
149Units
150-----
151
152.. autosummary::
153   :toctree: _as_gen
154   :nosignatures:
155
156   Artist.convert_xunits
157   Artist.convert_yunits
158   Artist.have_units
159
160Metadata
161--------
162
163.. autosummary::
164   :toctree: _as_gen
165   :nosignatures:
166
167   Artist.get_gid
168   Artist.get_label
169   Artist.set_gid
170   Artist.set_label
171   Artist.get_url
172   Artist.set_url
173   Artist.aname
174
175Stale
176-----
177
178.. autosummary::
179   :toctree: _as_gen
180   :nosignatures:
181
182   Artist.stale
183
184Functions
185=========
186
187.. autosummary::
188   :toctree: _as_gen
189   :nosignatures:
190
191   allow_rasterization
192   get
193   getp
194   setp
195   kwdoc
196   ArtistInspector
197