mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse

class mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse(transform, width, height, angle, loc, pad=0.1, borderpad=0.1, prop=None, frameon=True, **kwargs)

Bases: matplotlib.offsetbox.AnchoredOffsetbox

Draw an anchored ellipse of a given size.

Parameters:

transformmatplotlib.transforms.Transform

The transformation object for the coordinate system in use, i.e., matplotlib.axes.Axes.transData.

width, heightfloat

Width and height of the ellipse, given in coordinates of transform.

anglefloat

Rotation of the ellipse, in degrees, anti-clockwise.

locint

Location of this size bar. Valid location codes are:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4,
'right'        : 5,
'center left'  : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center'       : 10

padfloat, optional

Padding around the ellipse, in fraction of the font size. Defaults to 0.1.

borderpadfloat, default: 0.1

Border padding, in fraction of the font size.

frameonbool, default: True

If True, draw a box around the ellipse.

propmatplotlib.font_manager.FontProperties, optional

Font property used as a reference for paddings.

**kwargs

Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

Attributes:

ellipsematplotlib.patches.Ellipse

Ellipse patch drawn.

__init__(self, transform, width, height, angle, loc, pad=0.1, borderpad=0.1, prop=None, frameon=True, **kwargs)

Draw an anchored ellipse of a given size.

Parameters:

transformmatplotlib.transforms.Transform

The transformation object for the coordinate system in use, i.e., matplotlib.axes.Axes.transData.

width, heightfloat

Width and height of the ellipse, given in coordinates of transform.

anglefloat

Rotation of the ellipse, in degrees, anti-clockwise.

locint

Location of this size bar. Valid location codes are:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4,
'right'        : 5,
'center left'  : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center'       : 10

padfloat, optional

Padding around the ellipse, in fraction of the font size. Defaults to 0.1.

borderpadfloat, default: 0.1

Border padding, in fraction of the font size.

frameonbool, default: True

If True, draw a box around the ellipse.

propmatplotlib.font_manager.FontProperties, optional

Font property used as a reference for paddings.

**kwargs

Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

Attributes:

ellipsematplotlib.patches.Ellipse

Ellipse patch drawn.

__module__ = 'mpl_toolkits.axes_grid1.anchored_artists'

Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse

Simple Anchored Artists