matplotlib.artist.ArtistList#

class matplotlib.artist.ArtistList(parent, prop_name, valid_types=None, invalid_types=None)[source]#

Bases: Sequence

A sublist of Axes or Figure children based on their type.

The Axes' type-specific children sublists were made immutable in Matplotlib 3.7. In the future these artist lists may be replaced by tuples. Use as if this is a tuple already.

Parameters:

parentAxes or FigureBase

The Axes or (Sub)Figure from which this sublist will pull the children Artists.

prop_namestr

The property name used to access this sublist from the parent.

valid_typeslist of type, optional

A list of types that determine which children will be returned by this sublist. If specified, then the Artists in the sublist must be instances of any of these types. If unspecified, then any type of Artist is valid (unless limited by invalid_types.)

invalid_typestuple, optional

A list of types that determine which children will not be returned by this sublist. If specified, then Artists in the sublist will never be an instance of these types. Otherwise, no types will be excluded.