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:

bboxmatplotlib.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 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

__init__(self, bbox, **kwargs) [source]

Patch showing the shape bounded by a Bbox.

Parameters:

bboxmatplotlib.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 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

__module__ = 'mpl_toolkits.axes_grid1.inset_locator'

get_path(self) [source]

Return the path of this patch.

Examples using mpl_toolkits.axes_grid1.inset_locator.BboxPatch