matplotlib.axes.Axes.indicate_inset#

Axes.indicate_inset(bounds=None,inset_ax=None,*,transform=None,facecolor='none',edgecolor='0.5',alpha=0.5,zorder=None,**kwargs)[source]#

Add an inset indicator to the Axes. This is a rectangle on the plotat the position indicated bybounds that optionally has lines thatconnect the rectangle to an inset Axes (Axes.inset_axes).

Parameters:

bounds[x0, y0, width, height], optional

Lower-left corner of rectangle to be marked, and its widthand height. If not set, the bounds will be calculated from thedata limits ofinset_ax, which must be supplied.

inset_axAxes, optional

An optional inset Axes to draw connecting lines to. Two lines aredrawn connecting the indicator box to the inset Axes on cornerschosen so as to not overlap with the indicator box.

transformTransform

Transform for the rectangle coordinates. Defaults toax.transData, i.e. the units ofrect are in the Axes' datacoordinates.

facecolorcolor, default: 'none'

Facecolor of the rectangle.

edgecolorcolor, default: '0.5'

Color of the rectangle and color of the connecting lines.

alphafloat or None, default: 0.5

Transparency of the rectangle and connector lines. If notNone, this overrides any alpha value included in thefacecolor andedgecolor parameters.

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 theRectangle patch:

Property	Description
agg_filter	a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
alpha	float or None
angle	unknown
animated	bool
antialiased oraa	bool or None
bounds	(left, bottom, width, height)
capstyle	CapStyle or {'butt', 'projecting', 'round'}
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
color	color
edgecolor orec	color or None
facecolor orfc	color or None
figure	Figure orSubFigure
fill	bool
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
hatch_linewidth	unknown
hatchcolor	color or 'edge' or None
height	unknown
in_layout	bool
joinstyle	JoinStyle or {'miter', 'round', 'bevel'}
label	object
linestyle orls	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth orlw	float or None
mouseover	bool
path_effects	list ofAbstractPathEffect
picker	None or bool or float or callable
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
transform	Transform
url	str
visible	bool
width	unknown
x	unknown
xy	(float, float)
y	unknown
zorder	float

Returns:

inset_indicatorinset.InsetIndicator

An artist which contains

inset_indicator.rectangleRectangle

The indicator frame.

inset_indicator.connectors4-tuple ofpatches.ConnectionPatch

The four connector lines connecting to (lower_left, upper_left,lower_right upper_right) corners ofinset_ax. Two lines areset with visibility toFalse, but the user can set thevisibility to True if the automatic choice is not deemed correct.

Changed in version 3.10:Previously the rectangle and connectors tuple were returned.

Warning

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