mpl_toolkits.axes_grid1.inset_locator.AnchoredZoomLocator

class mpl_toolkits.axes_grid1.inset_locator.AnchoredZoomLocator(parent_axes, zoom, loc, borderpad=0.5, bbox_to_anchor=None, bbox_transform=None)

Bases: mpl_toolkits.axes_grid1.inset_locator.AnchoredLocatorBase

Parameters:

locstr

The box location. Supported values:

• 'upper right'
• 'upper left'
• 'lower left'
• 'lower right'
• 'center left'
• 'center right'
• 'lower center'
• 'upper center'
• 'center'

For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.

padfloat, default: 0.4

Padding around the child as fraction of the fontsize.

borderpadfloat, default: 0.5

Padding between the offsetbox frame and the bbox_to_anchor.

childOffsetBox

The box that will be anchored.

propFontProperties

This is only used as a reference for paddings. If not given, rcParams["legend.fontsize"] (default: 'medium') is used.

frameonbool

Whether to draw a frame around the box.

bbox_to_anchorBboxBase, 2-tuple, or 4-tuple of floats

Box that is used to position the legend in conjunction with loc.

bbox_transformNone or matplotlib.transforms.Transform

The transform for the bounding box (bbox_to_anchor).

**kwargs

All other parameters are passed on to OffsetBox.

Notes

See Legend for a detailed description of the anchoring mechanism.

__init__(self, parent_axes, zoom, loc, borderpad=0.5, bbox_to_anchor=None, bbox_transform=None)

Parameters:

locstr

The box location. Supported values:

• 'upper right'
• 'upper left'
• 'lower left'
• 'lower right'
• 'center left'
• 'center right'
• 'lower center'
• 'upper center'
• 'center'

For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.

padfloat, default: 0.4

Padding around the child as fraction of the fontsize.

borderpadfloat, default: 0.5

Padding between the offsetbox frame and the bbox_to_anchor.

childOffsetBox

The box that will be anchored.

propFontProperties

This is only used as a reference for paddings. If not given, rcParams["legend.fontsize"] (default: 'medium') is used.

frameonbool

Whether to draw a frame around the box.

bbox_to_anchorBboxBase, 2-tuple, or 4-tuple of floats

Box that is used to position the legend in conjunction with loc.

bbox_transformNone or matplotlib.transforms.Transform

The transform for the bounding box (bbox_to_anchor).

**kwargs

All other parameters are passed on to OffsetBox.

Notes

See Legend for a detailed description of the anchoring mechanism.

__module__ = 'mpl_toolkits.axes_grid1.inset_locator'

get_extent(self, renderer)

Return the extent of the box as (width, height, x, y).

This is the extent of the child plus the padding.

Examples using mpl_toolkits.axes_grid1.inset_locator.AnchoredZoomLocator