Axes.indicate_inset_zoom

Axes.indicate_inset_zoom(**kwargs)[source]

Add indicators denoting the zoom range of the inset axes. This will replace previously drawn zoom indicators.

Parameters
  • lw, linewidth, linewidths (unit-spec, default: rc['patch.linewidth'] = 0.6) – The edge width of the patch(es). If float, units are points. If string, interpreted by units.

  • ls, linestyle, linestyles (str, default: '-') – The edge style of the patch(es).

  • ec, edgecolor, edgecolors (color-spec, default: 'none') – The edge color of the patch(es).

  • fc, facecolor, facecolors, fillcolor, fillcolors (color-spec, optional) – The face color of the patch(es). The property cycle is used by default.

  • a, alpha, alphas (float, optional) – The opacity of the patch(es). Inferred from facecolor and edgecolor by default.

  • zorder (float, default: 3.5) – The zorder of the indicators. Should be greater than the zorder of elements in the parent axes.

Other Parameters

**kwargs – Passed to Patch.

Note

This command must be called from the inset axes rather than the parent axes. It is called automatically when zoom=True is passed to inset_axes and whenever the axes are drawn (so the line positions always track the axis limits even if they are later changed).