You are reading an old version of the documentation (v3.1.1). For the latest version see https://matplotlib.org/stable/api/_as_gen/mpl_toolkits.axes_grid1.inset_locator.BboxPatch.html
Version 3.1.2
matplotlib
Fork me on GitHub

Table of Contents

mpl_toolkits.axes_grid1.inset_locator.BboxPatch

class mpl_toolkits.axes_grid1.inset_locator.BboxPatch(bbox, **kwargs)[source]

Bases: matplotlib.patches.Patch

Patch showing the shape bounded by a Bbox.

Parameters:
bbox : matplotlib.transforms.Bbox

Bbox to use for the extents of this patch.

**kwargs

Patch properties. Valid arguments include:

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
alpha float or None
animated bool
antialiased or aa unknown
capstyle {'butt', 'round', 'projecting'}
clip_box Bbox
clip_on bool
clip_path [(Path, Transform) | Patch | None]
color color
contains callable
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 {'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 or None
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
zorder float
get_path(self)[source]

Return the path of this patch

Examples using mpl_toolkits.axes_grid1.inset_locator.BboxPatch