matplotlib.container
¶
-
class
matplotlib.container.
BarContainer
(patches, errorbar=None, **kwargs)[source]¶ Bases:
matplotlib.container.Container
Container for the artists of bar plots (e.g. created by
Axes.bar
).The container can be treated as a tuple of the patches themselves. Additionally, you can access these and further parameters by the attributes.
Attributes
patches (list of Rectangle
) The artists of the bars.errorbar (None or ErrorbarContainer
) A container for the error bar artists if error bars are present. None otherwise.
-
class
matplotlib.container.
Container
(kl, label=None)[source]¶ Bases:
tuple
Base class for containers.
Containers are classes that collect semantically related Artists such as the bars of a bar plot.
-
add_callback
(func)¶ Add a callback function that will be called whenever one of the
Artist
's properties changes.Parameters: func : callable
The callback function. It must have the signature:
def func(artist: Artist) -> Any
where artist is the calling
Artist
. Return values may exist but are ignored.Returns: oid : int
The observer id associated with the callback. This id can be used for removing the callback with
remove_callback
later.See also
-
get_label
()¶ Return the label used for this artist in the legend.
-
pchanged
()¶ Call all of the registered callbacks.
This function is triggered internally when a property is changed.
See also
-
remove_callback
(oid)¶ Remove a callback based on its observer id.
See also
-
set_label
(s)¶ Set a label that will be displayed in the legend.
Parameters: s : object
s will be converted to a string by calling
str
.
-
-
class
matplotlib.container.
ErrorbarContainer
(lines, has_xerr=False, has_yerr=False, **kwargs)[source]¶ Bases:
matplotlib.container.Container
Container for the artists of error bars (e.g. created by
Axes.errorbar
).The container can be treated as the lines tuple itself. Additionally, you can access these and further parameters by the attributes.
Attributes
lines (tuple) Tuple of (data_line, caplines, barlinecols)
. - data_line :Line2D
instance of x, y plot markers and/or line. - caplines : tuple ofLine2D
instances of the error bar caps. - barlinecols : list ofLineCollection
with the horizontal and vertical error ranges.has_xerr, has_yerr (bool) True
if the errorbar has x/y errors.
-
class
matplotlib.container.
StemContainer
(markerline_stemlines_baseline, **kwargs)[source]¶ Bases:
matplotlib.container.Container
Container for the artists created in a
Axes.stem()
plot.The container can be treated like a namedtuple
(markerline, stemlines, baseline)
.Attributes
markerline ( Line2D
) The artist of the markers at the stem heads.stemlines (list of Line2D
) The artists of the vertical lines for all stems.baseline ( Line2D
) The artist of the horizontal baseline.Parameters: markerline_stemlines_baseline : tuple
Tuple of
(markerline, stemlines, baseline)
.markerline
contains theLineCollection
of the markers,stemlines
is aLineCollection
of the main lines,baseline
is theLine2D
of the baseline.