W3cubDocs

/Matplotlib 2.0

mpl_toolkits.axes_grid1.anchored_artists

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

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:

transform : matplotlib.transforms.Transform

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

loc : int

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

pad : int or float, optional

Padding around the child objects, in fraction of the font size. Defaults to 0.4.

borderpad : int or float, optional

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

prop : matplotlib.font_manager.FontProperties, optional

Font property used as a reference for paddings.

frameon : bool, optional

If True, draw a box around this artists. Defaults to True.

**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=2)
>>> el = Ellipse((0,0), width=0.1, height=0.4, angle=30)
>>> box.drawing_area.add_artist(el)
>>> ax.add_artist(box)

Attributes

drawing_area (matplotlib.offsetbox.AuxTransformBox) A container for artists to display.
class mpl_toolkits.axes_grid1.anchored_artists.AnchoredDrawingArea(width, height, xdescent, ydescent, loc, pad=0.4, borderpad=0.5, prop=None, frameon=True, **kwargs)

Bases: matplotlib.offsetbox.AnchoredOffsetbox

An anchored container with a fixed size and fillable DrawingArea.

Artists added to the drawing_area will have their coordinates interpreted as pixels. Any transformations set on the artists will be overridden.

Parameters:

width, height : int or float

width and height of the container, in pixels.

xdescent, ydescent : int or float

descent of the container in the x- and y- direction, in pixels.

loc : int

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

pad : int or float, optional

Padding around the child objects, in fraction of the font size. Defaults to 0.4.

borderpad : int or float, optional

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

prop : matplotlib.font_manager.FontProperties, optional

Font property used as a reference for paddings.

frameon : bool, optional

If True, draw a box around this artists. Defaults to True.

**kwargs :

Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

Examples

To display blue and red circles of different sizes in the upper right of an axes ax:

>>> ada = AnchoredDrawingArea(20, 20, 0, 0, loc=1, frameon=False)
>>> ada.drawing_area.add_artist(Circle((10, 10), 10, fc="b"))
>>> ada.drawing_area.add_artist(Circle((30, 10), 5, fc="r"))
>>> ax.add_artist(ada)

Attributes

drawing_area (matplotlib.offsetbox.DrawingArea) A container for artists to display.
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:

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.

**kwargs :

Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

Attributes

ellipse (matplotlib.patches.Ellipse) Ellipse patch drawn.
class mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar(transform, size, label, loc, pad=0.1, borderpad=0.1, sep=2, frameon=True, size_vertical=0, color='black', label_top=False, fontproperties=None, **kwargs)

Bases: matplotlib.offsetbox.AnchoredOffsetbox

Draw a horizontal scale bar with a center-aligned label underneath.

Parameters:

transform : matplotlib.transforms.Transform

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

size : int or float

Horizontal length of the size bar, given in coordinates of transform.

label : str

Label to display.

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 label and size bar, 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.

sep : int or float, optional

Seperation between the label and the size bar, in points. Defaults to 2.

frameon : bool, optional

If True, draw a box around the horizontal bar and label. Defaults to True.

size_vertical : int or float, optional

Vertical length of the size bar, given in coordinates of transform. Defaults to 0.

color : str, optional

Color for the size bar and label. Defaults to black.

label_top : bool, optional

If True, the label will be over the size bar. Defaults to False.

fontproperties : matplotlib.font_manager.FontProperties, optional

Font properties for the label text.

**kwargs :

Keyworded arguments to pass to matplotlib.offsetbox.AnchoredOffsetbox.

Notes

If prop is passed as a keyworded argument, but fontproperties is not, then prop is be assumed to be the intended fontproperties. Using both prop and fontproperties is not supported.

Examples

>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> from mpl_toolkits.axes_grid1.anchored_artists import AnchoredSizeBar
>>> fig, ax = plt.subplots()
>>> ax.imshow(np.random.random((10,10)))
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 data units', 4)
>>> ax.add_artist(bar)
>>> fig.show()

Using all the optional parameters

>>> import matplotlib.font_manager as fm
>>> fontprops = fm.FontProperties(size=14, family='monospace')
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 units', 4, pad=0.5, sep=5, borderpad=0.5, frameon=False, size_vertical=0.5, color='white', fontproperties=fontprops)

Attributes

size_bar (matplotlib.offsetbox.AuxTransformBox) Container for the size bar.
txt_label (matplotlib.offsetbox.TextArea) Container for the label of the size bar.

© 2012–2017 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
http://matplotlib.org/2.0.2/mpl_toolkits/axes_grid/api/anchored_artists_api.html