Classe « Axes »

Méthode matplotlib.axes.Axes.indicate_inset

Signature de la méthode indicate_inset

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

Description

indicate_inset.__doc__

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`).

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

Parameters
----------
bounds : [x0, y0, width, height]
    Lower-left corner of rectangle to be marked, and its width
    and height.

inset_ax : `.Axes`
    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.

transform : `.Transform`
    Transform for the rectangle coordinates. Defaults to
    `ax.transAxes`, i.e. the units of *rect* are in Axes-relative
    coordinates.

facecolor : color, default: 'none'
    Facecolor of the rectangle.

edgecolor : color, default: '0.5'
    Color of the rectangle and color of the connecting lines.

alpha : float, default: 0.5
    Transparency of the rectangle and connector lines.

zorder : float, 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:

    Properties:
    agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
    alpha: scalar or None
    animated: bool
    antialiased or aa: unknown
    capstyle: `.CapStyle` or {'butt', 'projecting', 'round'}
    clip_box: `.Bbox`
    clip_on: bool
    clip_path: Patch or (Path, Transform) or None
    color: color
    contains: unknown
    edgecolor or ec: color or None or 'auto'
    facecolor or fc: color or None
    figure: `.Figure`
    fill: bool
    gid: str
    hatch: {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
    in_layout: bool
    joinstyle: `.JoinStyle` or {'miter', 'round', 'bevel'}
    label: object
    linestyle or ls: {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
    linewidth or lw: float or None
    path_effects: `.AbstractPathEffect`
    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
    zorder: float

Returns
-------
rectangle_patch : `.patches.Rectangle`
     The indicator frame.

connector_lines : 4-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.