mpl_toolkits.axes_grid1.anchored_artists.AnchoredDrawingArea

class mpl_toolkits.axes_grid1.anchored_artists.AnchoredDrawingArea(width, height, xdescent, ydescent, loc, pad=0.4, borderpad=0.5, prop=None, frameon=True, **kwargs)[source]

Bases: matplotlib.offsetbox.AnchoredOffsetbox

An anchored container with a fixed size and fillable DrawingArea.

Artists added to the drawing_area will have their coordinates interpreted as pixels. Any transformations set on the artists will be overridden.

Parameters:
width, heightfloat

width and height of the container, in pixels.

xdescent, ydescentfloat

descent of the container in the x- and y- direction, in pixels.

locstr

Location of this artist. Valid locations are 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.

padfloat, default: 0.4

Padding around the child objects, in fraction of the font size.

borderpadfloat, default: 0.5

Border padding, in fraction of the font size.

propmatplotlib.font_manager.FontProperties, optional

Font property used as a reference for paddings.

frameonbool, default: True

If True, draw a box around this artists.

**kwargs

Keyword arguments forwarded to AnchoredOffsetbox.

Examples

To display blue and red circles of different sizes in the upper right of an axes ax:

>>> ada = AnchoredDrawingArea(20, 20, 0, 0,
...                           loc='upper right', frameon=False)
>>> ada.drawing_area.add_artist(Circle((10, 10), 10, fc="b"))
>>> ada.drawing_area.add_artist(Circle((30, 10), 5, fc="r"))
>>> ax.add_artist(ada)
Attributes:
drawing_areamatplotlib.offsetbox.DrawingArea

A container for artists to display.

__init__(width, height, xdescent, ydescent, loc, pad=0.4, borderpad=0.5, prop=None, frameon=True, **kwargs)[source]

An anchored container with a fixed size and fillable DrawingArea.

Artists added to the drawing_area will have their coordinates interpreted as pixels. Any transformations set on the artists will be overridden.

Parameters:
width, heightfloat

width and height of the container, in pixels.

xdescent, ydescentfloat

descent of the container in the x- and y- direction, in pixels.

locstr

Location of this artist. Valid locations are 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.

padfloat, default: 0.4

Padding around the child objects, in fraction of the font size.

borderpadfloat, default: 0.5

Border padding, in fraction of the font size.

propmatplotlib.font_manager.FontProperties, optional

Font property used as a reference for paddings.

frameonbool, default: True

If True, draw a box around this artists.

**kwargs

Keyword arguments forwarded to AnchoredOffsetbox.

Examples

To display blue and red circles of different sizes in the upper right of an axes ax:

>>> ada = AnchoredDrawingArea(20, 20, 0, 0,
...                           loc='upper right', frameon=False)
>>> ada.drawing_area.add_artist(Circle((10, 10), 10, fc="b"))
>>> ada.drawing_area.add_artist(Circle((30, 10), 5, fc="r"))
>>> ax.add_artist(ada)
Attributes:
drawing_areamatplotlib.offsetbox.DrawingArea

A container for artists to display.

__module__ = 'mpl_toolkits.axes_grid1.anchored_artists'

Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredDrawingArea