mpl_toolkits.axes_grid1.anchored_artists.AnchoredAuxTransformBox

class mpl_toolkits.axes_grid1.anchored_artists.AnchoredAuxTransformBox(transform, loc, pad=0.4, borderpad=0.5, prop=None, frameon=True, **kwargs) [source]

Bases: matplotlib.offsetbox.AnchoredOffsetbox

An anchored container with transformed coordinates.

Artists added to the drawing_area are scaled according to the coordinates of the transformation used. The dimensions of this artist will scale to contain the artists added.

Parameters:

transformmatplotlib.transforms.Transform The transformation object for the coordinate system in use, i.e., matplotlib.axes.Axes.transData. locint Location of this artist. 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, 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 Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

Examples

To display an ellipse in the upper left, with a width of 0.1 and height of 0.4 in data coordinates:

>>> box = AnchoredAuxTransformBox(ax.transData, loc='upper left')
>>> el = Ellipse((0, 0), width=0.1, height=0.4, angle=30)
>>> box.drawing_area.add_artist(el)
>>> ax.add_artist(box)

Attributes:	drawing_areamatplotlib.offsetbox.AuxTransformBox A container for artists to display.

__init__(self, transform, loc, pad=0.4, borderpad=0.5, prop=None, frameon=True, **kwargs) [source]

An anchored container with transformed coordinates.

Artists added to the drawing_area are scaled according to the coordinates of the transformation used. The dimensions of this artist will scale to contain the artists added.

Parameters:

transformmatplotlib.transforms.Transform The transformation object for the coordinate system in use, i.e., matplotlib.axes.Axes.transData. locint Location of this artist. 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, 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 Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

Examples

To display an ellipse in the upper left, with a width of 0.1 and height of 0.4 in data coordinates:

>>> box = AnchoredAuxTransformBox(ax.transData, loc='upper left')
>>> el = Ellipse((0, 0), width=0.1, height=0.4, angle=30)
>>> box.drawing_area.add_artist(el)
>>> ax.add_artist(box)

Attributes:	drawing_areamatplotlib.offsetbox.AuxTransformBox A container for artists to display.

__module__ = 'mpl_toolkits.axes_grid1.anchored_artists'

Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredAuxTransformBox