mpl_toolkits.axes_grid1.inset_locator.BboxConnector

class mpl_toolkits.axes_grid1.inset_locator.BboxConnector(bbox1, bbox2, loc1, loc2=None, **kwargs) [source]

Bases: matplotlib.patches.Patch

Connect two bboxes with a straight line.

Parameters:

bbox1, bbox2 : matplotlib.transforms.Bbox Bounding boxes to connect. loc1 : {1, 2, 3, 4} Corner of bbox1 to draw the line. Valid values are: 'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4 loc2 : {1, 2, 3, 4}, optional Corner of bbox2 to draw the line. If None, defaults to loc1. Valid values are: 'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4 **kwargs Patch properties for the line drawn. 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

static connect_bbox(bbox1, bbox2, loc1, loc2=None) [source]

Helper function to obtain a Path from one bbox to another.

Parameters:	bbox1, bbox2 : matplotlib.transforms.Bbox Bounding boxes to connect. loc1 : {1, 2, 3, 4} Corner of bbox1 to use. Valid values are: 'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4 loc2 : {1, 2, 3, 4}, optional Corner of bbox2 to use. If None, defaults to loc1. Valid values are: 'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4
Returns:	path : matplotlib.path.Path A line segment from the loc1 corner of bbox1 to the loc2 corner of bbox2.

static get_bbox_edge_pos(bbox, loc) [source]

Helper function to obtain the location of a corner of a bbox

Parameters:	bbox : matplotlib.transforms.Bbox loc : {1, 2, 3, 4} Corner of bbox. Valid values are: 'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4
Returns:	x, y : float Coordinates of the corner specified by loc.

get_path(self) [source]

Return the path of this patch

Examples using mpl_toolkits.axes_grid1.inset_locator.BboxConnector