You are reading an old version of the documentation (v3.1.0). For the latest version see
Version 3.1.0
Fork me on GitHub

Table of Contents


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.

transform : matplotlib.transforms.Transform

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

width, height : int or float

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

angle : int or float

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

loc : int

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
pad : int or float, optional

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

borderpad : int or float, optional

Border padding, in fraction of the font size. Defaults to 0.1.

frameon : bool, optional

If True, draw a box around the ellipse. Defaults to True.

prop : matplotlib.font_manager.FontProperties, optional

Font property used as a reference for paddings.


Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

ellipse : matplotlib.patches.Ellipse

Ellipse patch drawn.

Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse