matplotlib / 3.4.3 / _as_gen / mpl_toolkits.axes_grid1.anchored_artists.anchoredellipse.html /

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:
transform matplotlib.transforms.Transform

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

width, height float

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

angle 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 float, optional

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

borderpad float, default: 0.1

Border padding, in fraction of the font size.

frameon bool, default: True

If True, draw a box around the ellipse.

prop matplotlib.font_manager.FontProperties, optional

Font property used as a reference for paddings.

**kwargs

Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

Attributes:
ellipse matplotlib.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:
transform matplotlib.transforms.Transform

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

width, height float

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

angle 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 float, optional

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

borderpad float, default: 0.1

Border padding, in fraction of the font size.

frameon bool, default: True

If True, draw a box around the ellipse.

prop matplotlib.font_manager.FontProperties, optional

Font property used as a reference for paddings.

**kwargs

Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

Attributes:
ellipse matplotlib.patches.Ellipse

Ellipse patch drawn.

__module__ = 'mpl_toolkits.axes_grid1.anchored_artists'

Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse

© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/_as_gen/mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse.html