matplotlib.axes.Axes.indicate_inset

Axes.indicate_inset(self, bounds, inset_ax=None, *, transform=None, facecolor='none', edgecolor='0.5', alpha=0.5, zorder=4.99, **kwargs)

Add an inset indicator to the axes. This is a rectangle on the plot at the position indicated by bounds that optionally has lines that connect the rectangle to an inset axes (Axes.inset_axes).

Parameters:

bounds[x0, y0, width, height]

Lower-left corner of rectangle to be marked, and its width and height.

inset_axAxes

An optional inset axes to draw connecting lines to. Two lines are drawn connecting the indicator box to the inset axes on corners chosen so as to not overlap with the indicator box.

transformTransform

Transform for the rectangle coordinates. Defaults to ax.transAxes, i.e. the units of rect are in axes-relative coordinates.

facecolorcolor, default: 'none'

Facecolor of the rectangle.

edgecolorcolor, default: '0.5'

Color of the rectangle and color of the connecting lines.

alphafloat, default: 0.5

Transparency of the rectangle and connector lines.

zorderfloat, default: 4.99

Drawing order of the rectangle and connector lines. The default, 4.99, is just below the default level of inset axes.

**kwargs

Other keyword arguments are passed on to the Rectangle patch:

%(Rectangle)s

Returns:

rectangle_patchpatches.Rectangle

The indicator frame.

connector_lines4-tuple of patches.ConnectionPatch

The four connector lines connecting to (lower_left, upper_left, lower_right upper_right) corners of inset_ax. Two lines are set with visibility to False, but the user can set the visibility to True if the automatic choice is not deemed correct.

Warning

This method is experimental as of 3.0, and the API may change.

Examples using matplotlib.axes.Axes.indicate_inset