matplotlib.container#

classmatplotlib.container.BarContainer(*args,**kwargs)[source]#

Bases:Container

Container for the artists of bar plots (e.g. created byAxes.bar).

The container can be treated as a tuple of thepatches themselves.Additionally, you can access these and further parameters by theattributes.

Attributes:
patcheslist ofRectangle

The artists of the bars.

errorbarNone orErrorbarContainer

A container for the error bar artists if error bars are present.None otherwise.

datavaluesNone or array-like

The underlying data values corresponding to the bars.

orientation{'vertical', 'horizontal'}, default: None

If 'vertical', the bars are assumed to be vertical.If 'horizontal', the bars are assumed to be horizontal.

classmatplotlib.container.Container(*args,**kwargs)[source]#

Bases:tuple

Base class for containers.

Containers are classes that collect semantically related Artists such asthe bars of a bar plot.

add_callback(func)[source]#

Add a callback function that will be called whenever one of theArtist's properties changes.

Parameters:
funccallable

The callback function. It must have the signature:

deffunc(artist:Artist)->Any

whereartist is the callingArtist. Return values may existbut are ignored.

Returns:
int

The observer id associated with the callback. This id can beused for removing the callback withremove_callback later.

get_children()[source]#
get_label()[source]#

Return the label used for this artist in the legend.

pchanged()[source]#

Call all of the registered callbacks.

This function is triggered internally when a property is changed.

remove()[source]#
remove_callback(oid)[source]#

Remove a callback based on its observer id.

See also

add_callback
set_label(s)[source]#

Set a label that will be displayed in the legend.

Parameters:
sobject

s will be converted to a string by callingstr.

classmatplotlib.container.ErrorbarContainer(*args,**kwargs)[source]#

Bases:Container

Container for the artists of error bars (e.g. created byAxes.errorbar).

The container can be treated as thelines tuple itself.Additionally, you can access these and further parameters by theattributes.

Attributes:
linestuple

Tuple of(data_line,caplines,barlinecols).

  • data_line : ALine2D instance of x, y plot markersand/or line.

  • caplines : A tuple ofLine2D instances of the errorbar caps.

  • barlinecols : A tuple ofLineCollection with thehorizontal and vertical error ranges.

has_xerr, has_yerrbool

True if the errorbar has x/y errors.

classmatplotlib.container.StemContainer(*args,**kwargs)[source]#

Bases:Container

Container for the artists created in aAxes.stem() plot.

The container can be treated like a namedtuple(markerline,stemlines,baseline).

Attributes:
markerlineLine2D

The artist of the markers at the stem heads.

stemlinesLineCollection

The artists of the vertical lines for all stems.

baselineLine2D

The artist of the horizontal baseline.

Parameters:
markerline_stemlines_baselinetuple

Tuple of(markerline,stemlines,baseline).markerline contains theLine2D of the markers,stemlines is aLineCollection of the main lines,baseline is theLine2D of the baseline.