You are reading an old version of the documentation (v3.0.2). For the latest version see https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.indicate_inset_zoom.html
Version 3.0.2
matplotlib
Fork me on GitHub

Table of Contents

matplotlib.axes.Axes.indicate_inset_zoom

Axes.indicate_inset_zoom(inset_ax, **kwargs)[source]

Add an inset indicator rectangle to the axes based on the axis limits for an inset_ax and draw connectors between inset_ax and the rectangle.

Parameters:
inset_ax : Axes

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.

**kwargs

Other kwargs are passed on to Axes.inset_rectangle

Returns:
rectangle_patch: `.Patches.Rectangle`

Rectangle artist.

connector_lines: 4-tuple of `.Patches.ConnectionPatch`

One for each of four connector lines. Two 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_zoom