matplotlib.patches.ConnectionPatch#

classmatplotlib.patches.ConnectionPatch(xyA,xyB,coordsA,coordsB=None,*,axesA=None,axesB=None,arrowstyle='-',connectionstyle='arc3',patchA=None,patchB=None,shrinkA=0.0,shrinkB=0.0,mutation_scale=10.0,mutation_aspect=None,clip_on=False,**kwargs)[source]#

Bases:FancyArrowPatch

A patch that connects two points (possibly in different Axes).

Connect pointxyA incoordsA with pointxyB incoordsB.

Valid keys are

Key	Description
arrowstyle	the arrow style
connectionstyle	the connection style
relpos	default is (0.5, 0.5)
patchA	default is bounding box of the text
patchB	default is None
shrinkA	default is 2 points
shrinkB	default is 2 points
mutation_scale	default is text size (in points)
mutation_aspect	default is 1.
?	any key formatplotlib.patches.PathPatch

coordsA andcoordsB are strings that indicate thecoordinates ofxyA andxyB.

Property	Description
'figure points'	points from the lower left corner of the figure
'figure pixels'	pixels from the lower left corner of the figure
'figure fraction'	0, 0 is lower left of figure and 1, 1 is upperright
'subfigure points'	points from the lower left corner of the subfigure
'subfigure pixels'	pixels from the lower left corner of the subfigure
'subfigure fraction'	fraction of the subfigure, 0, 0 is lower left.
'axes points'	points from lower left corner of the Axes
'axes pixels'	pixels from lower left corner of the Axes
'axes fraction'	0, 0 is lower left of Axes and 1, 1 is upper right
'data'	use the coordinate system of the object beingannotated (default)
'offset points'	offset (in points) from thexy value
'polar'	you can specifytheta,r for the annotation,even in cartesian plots. Note that if you areusing a polar Axes, you do not need to specifypolar for the coordinate system since that is thenative "data" coordinate system.

Alternatively they can be set to any validTransform.

Note that 'subfigure pixels' and 'figure pixels' are the samefor the parent figure, so users who want code that is usable ina subfigure can use 'subfigure pixels'.

Note

UsingConnectionPatch across twoAxes instancesis not directly compatible withconstrained layout. Add the artistdirectly to theFigure instead of adding it to a specific Axes,or exclude it from the layout usingcon.set_in_layout(False).

fig,ax=plt.subplots(1,2,constrained_layout=True)con=ConnectionPatch(...,axesA=ax[0],axesB=ax[1])fig.add_artist(con)

draw(renderer)[source]#

Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (Artist.get_visiblereturns False).

Parameters:

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_annotation_clip()[source]#

Return the clipping behavior.

Seeset_annotation_clip for the meaning of the return value.

set(*,agg_filter=<UNSET>,alpha=<UNSET>,animated=<UNSET>,annotation_clip=<UNSET>,antialiased=<UNSET>,arrowstyle=<UNSET>,capstyle=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,color=<UNSET>,connectionstyle=<UNSET>,edgecolor=<UNSET>,facecolor=<UNSET>,fill=<UNSET>,gid=<UNSET>,hatch=<UNSET>,hatch_linewidth=<UNSET>,hatchcolor=<UNSET>,in_layout=<UNSET>,joinstyle=<UNSET>,label=<UNSET>,linestyle=<UNSET>,linewidth=<UNSET>,mouseover=<UNSET>,mutation_aspect=<UNSET>,mutation_scale=<UNSET>,patchA=<UNSET>,patchB=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,positions=<UNSET>,rasterized=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,transform=<UNSET>,url=<UNSET>,visible=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

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 and two offsets from the bottom left corner of the image
alpha	float or None
animated	bool
annotation_clip	bool or None
antialiased oraa	bool or None
arrowstyle	[ '-' | '<-' | '->' | '<->' | '<|-' | '-|>' | '<|-|>' | ']-' | '-[' | ']-[' | '|-|' | ']->' | '<-[' | 'simple' | 'fancy' | 'wedge' ]
capstyle	CapStyle or {'butt', 'projecting', 'round'}
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
color	color
connectionstyle	[ 'arc3' | 'angle3' | 'angle' | 'arc' | 'bar' ]
edgecolor orec	color or None
facecolor orfc	color or None
figure	Figure orSubFigure
fill	bool
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
hatch_linewidth	unknown
hatchcolor	color or 'edge' or None
in_layout	bool
joinstyle	JoinStyle or {'miter', 'round', 'bevel'}
label	object
linestyle orls	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth orlw	float or None
mouseover	bool
mutation_aspect	float
mutation_scale	float
patchA	patches.Patch
patchB	patches.Patch
path_effects	list ofAbstractPathEffect
picker	None or bool or float or callable
positions	unknown
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
transform	Transform
url	str
visible	bool
zorder	float

set_annotation_clip(b)[source]#

Set the annotation's clipping behavior.

Parameters:

bbool or None

• True: The annotation will be clipped whenself.xy isoutside the Axes.

• False: The annotation will always be drawn.

• None: The annotation will be clipped whenself.xy isoutside the Axes andself.xycoords=="data".

Examples usingmatplotlib.patches.ConnectionPatch#

Multiple Axes animation

Multiple Axes animation

Bar of pie

Bar of pie

Constrained layout guide

Constrained layout guide

Annotations

Annotations