Version 3.0.2
matplotlib

matplotlib.artist

Inheritance diagram of 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

Artist class

class matplotlib.artist.Artist[source]

Abstract base class for someone who renders into a FigureCanvas.

Interactive

Artist.add_callback Adds a callback function that will be called whenever one of the Artist's properties changes.
Artist.remove_callback Remove a callback based on its id.
Artist.pchanged Fire an event when property changed, calling all of the registered callbacks.
Artist.get_cursor_data Get the cursor data for a given event.
Artist.format_cursor_data Return cursor data string formatted.
Artist.mouseover
Artist.contains Test whether the artist contains the mouse event.
Artist.set_contains Replace the contains test used by this artist.
Artist.get_contains Return the _contains test used by the artist, or None for default.
Artist.pick Process pick event
Artist.pickable Return True if Artist is pickable.
Artist.set_picker Set the epsilon for picking used by this artist
Artist.get_picker Return the picker object used by this artist.

Clipping

Artist.set_clip_on Set whether artist uses clipping.
Artist.get_clip_on Return whether artist uses clipping
Artist.set_clip_box Set the artist's clip Bbox.
Artist.get_clip_box Return artist clipbox
Artist.set_clip_path Set the artist's clip path, which may be:
Artist.get_clip_path Return artist clip path

Bulk Properties

Artist.update Update this artist's properties from the dictionary prop.
Artist.update_from Copy properties from other to self.
Artist.properties return a dictionary mapping property name -> value for all Artist props
Artist.set A property batch setter.

Drawing

Artist.draw Derived classes drawing method
Artist.set_animated Set the artist's animation state.
Artist.get_animated Return the artist's animated state
Artist.set_alpha Set the alpha value used for blending - not supported on all backends.
Artist.get_alpha Return the alpha value used for blending - not supported on all backends
Artist.set_snap Sets the snap setting which may be:
Artist.get_snap Returns the snap setting which may be:
Artist.set_visible Set the artist's visibility.
Artist.get_visible Return the artist's visiblity
Artist.zorder
Artist.set_zorder Set the zorder for the artist.
Artist.get_zorder Return the artist's zorder.
Artist.set_agg_filter Set the agg filter.
Artist.set_sketch_params Sets the sketch parameters.
Artist.get_sketch_params Returns the sketch parameters for the artist.
Artist.set_rasterized Force rasterized (bitmap) drawing in vector backend output.
Artist.get_rasterized Return whether the artist is to be rasterized.
Artist.set_path_effects Set the path effects.
Artist.get_path_effects
Artist.get_agg_filter Return filter function to be used for agg filter.
Artist.get_window_extent Get the axes bounding box in display space.
Artist.get_transformed_clip_path_and_affine Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.

Figure and Axes

Artist.remove Remove the artist from the figure if possible.
Artist.axes The Axes instance the artist resides in, or None.
Artist.set_figure Set the Figure instance the artist belongs to.
Artist.get_figure Return the Figure instance the artist belongs to.

Children

Artist.get_children Return a list of the child Artist`s this :class:`Artist contains.
Artist.findobj Find artist objects.

Transform

Artist.set_transform Set the artist transform.
Artist.get_transform Return the Transform instance used by this artist.
Artist.is_transform_set Returns True if Artist has a transform explicitly set.

Units

Artist.convert_xunits For artists in an axes, if the xaxis has units support, convert x using xaxis unit type
Artist.convert_yunits For artists in an axes, if the yaxis has units support, convert y using yaxis unit type
Artist.have_units Return True if units are set on the x or y axes

Metadata

Artist.set_gid Sets the (group) id for the artist.
Artist.get_gid Returns the group id.
Artist.set_label Set the label to s for auto legend.
Artist.get_label Get the label used for this artist in the legend.
Artist.set_url Sets the url for the artist.
Artist.get_url Returns the url.

Miscellaneous

Artist.sticky_edges x and y sticky edge lists.
Artist.set_in_layout Set if artist is to be included in layout calculations, E.g.
Artist.get_in_layout Return boolean flag, True if artist is included in layout calculations.
Artist.stale If the artist is 'stale' and needs to be re-drawn for the output to match the internal state of the artist.

Functions

allow_rasterization Decorator for Artist.draw method.
get Return the value of object's property.
getp Return the value of object's property.
setp Set a property on an artist object.
kwdoc Inspect an Artist class and return information about its settable properties and their current values.
ArtistInspector A helper class to inspect an Artist and return information about its settable properties and their current values.