mpl_toolkits.axes_grid1.inset_locator.BboxConnectorPatch
-
class mpl_toolkits.axes_grid1.inset_locator.BboxConnectorPatch(bbox1, bbox2, loc1a, loc2a, loc1b, loc2b, **kwargs)
[source] -
Bases:
mpl_toolkits.axes_grid1.inset_locator.BboxConnector
Connect two bboxes with a quadrilateral.
The quadrilateral is specified by two lines that start and end at corners of the bboxes. The four sides of the quadrilateral are defined by the two lines given, the line between the two corners specified in bbox1 and the line between the two corners specified in bbox2.
Parameters: -
bbox1, bbox2matplotlib.transforms.Bbox
-
Bounding boxes to connect.
-
loc1a, loc2a{1, 2, 3, 4}
-
Corners of bbox1 and bbox2 to draw the first line. Valid values are:
'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4
-
loc1b, loc2b{1, 2, 3, 4}
-
Corners of bbox1 and bbox2 to draw the second line. Valid values are:
'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4
- **kwargs
-
Patch properties for the line drawn:
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 aaunknown capstyle
{'butt', 'round', 'projecting'} clip_box
Bbox
clip_on
bool clip_path
Patch or (Path, Transform) or None color
color contains
unknown edgecolor
or eccolor or None or 'auto' facecolor
or fccolor 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 lwfloat or None path_effects
AbstractPathEffect
picker
None or bool 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
-
__init__(self, bbox1, bbox2, loc1a, loc2a, loc1b, loc2b, **kwargs)
[source] -
Connect two bboxes with a quadrilateral.
The quadrilateral is specified by two lines that start and end at corners of the bboxes. The four sides of the quadrilateral are defined by the two lines given, the line between the two corners specified in bbox1 and the line between the two corners specified in bbox2.
Parameters: -
bbox1, bbox2matplotlib.transforms.Bbox
-
Bounding boxes to connect.
-
loc1a, loc2a{1, 2, 3, 4}
-
Corners of bbox1 and bbox2 to draw the first line. Valid values are:
'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4
-
loc1b, loc2b{1, 2, 3, 4}
-
Corners of bbox1 and bbox2 to draw the second line. Valid values are:
'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4
- **kwargs
-
Patch properties for the line drawn:
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 aaunknown capstyle
{'butt', 'round', 'projecting'} clip_box
Bbox
clip_on
bool clip_path
Patch or (Path, Transform) or None color
color contains
unknown edgecolor
or eccolor or None or 'auto' facecolor
or fccolor 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 lwfloat or None path_effects
AbstractPathEffect
picker
None or bool 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
-
-
__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.BboxConnectorPatch
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.3.3/api/_as_gen/mpl_toolkits.axes_grid1.inset_locator.BboxConnectorPatch.html