matplotlib.patches.PathPatch #

classmatplotlib.patches.PathPatch(path,**kwargs)[source]#

Bases:Patch

A general polycurve path patch.

path is aPath object.

Valid keyword arguments 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
unknown
animated
bool
antialiased oraa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clip_box
BboxBase or None
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor orec
color or None
edgegapcolor
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
{'-', '--', '-.', ':', '', ...} or (offset, on-off-seq)
linewidth orlw
float or None
mouseover
bool
path_effects
list ofAbstractPathEffect
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

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`	unknown
`animated`	bool
`antialiased` or`aa`	bool or None
`capstyle`	`CapStyle` or {'butt', 'projecting', 'round'}
`clip_box`	`BboxBase` or None
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`color`	color
`edgecolor` or`ec`	color or None
`edgegapcolor`	color or None
`facecolor` or`fc`	color or None
`figure`	`Figure` or`SubFigure`
`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` or`ls`	{'-', '--', '-.', ':', '', ...} or (offset, on-off-seq)
`linewidth` or`lw`	float or None
`mouseover`	bool
`path_effects`	list of`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

get_path()[source]#: Return the path of this patch.

set(*,agg_filter=<UNSET>,alpha=<UNSET>,animated=<UNSET>,antialiased=<UNSET>,capstyle=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,color=<UNSET>,edgecolor=<UNSET>,edgegapcolor=<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>,path=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,rasterized=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,transform=<UNSET>,url=<UNSET>,visible=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

a.set(a=A,b=B,c=C)

is equivalent to

a.set_a(A)a.set_b(B)a.set_c(C)

In addition to the full property names, aliases are also supported, e.g.set(lw=2) is equivalent toset(linewidth=2), but it is an errorto pass both simultaneously.

The order of the individual setter calls matches the order of parametersinset(). However, most properties do not depend on each other sothat order is rarely relevant.

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
antialiased oraa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clip_box
BboxBase or None
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor orec
color or None
edgegapcolor
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
{'-', '--', '-.', ':', '', ...} or (offset, on-off-seq)
linewidth orlw
float or None
mouseover
bool
path
unknown
path_effects
list ofAbstractPathEffect
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

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
`antialiased` or`aa`	bool or None
`capstyle`	`CapStyle` or {'butt', 'projecting', 'round'}
`clip_box`	`BboxBase` or None
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`color`	color
`edgecolor` or`ec`	color or None
`edgegapcolor`	color or None
`facecolor` or`fc`	color or None
`figure`	`Figure` or`SubFigure`
`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` or`ls`	{'-', '--', '-.', ':', '', ...} or (offset, on-off-seq)
`linewidth` or`lw`	float or None
`mouseover`	bool
`path`	unknown
`path_effects`	list of`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