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)[source]

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.

locstr

Location of this ellipse. 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.1

Padding around the ellipse, in fraction of the font size.

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

Keyword arguments forwarded to AnchoredOffsetbox.

Attributes:
ellipsematplotlib.patches.Ellipse

Ellipse patch drawn.

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

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.

locstr

Location of this ellipse. 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.1

Padding around the ellipse, in fraction of the font size.

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

Keyword arguments forwarded to AnchoredOffsetbox.

Attributes:
ellipsematplotlib.patches.Ellipse

Ellipse patch drawn.

__module__ = 'mpl_toolkits.axes_grid1.anchored_artists'

Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse