Section Navigation

matplotlib.patches.Polygon#

class matplotlib.patches.Polygon(xy, *, closed=True, **kwargs)[source]#

Bases: Patch

A general polygon patch.

Parameters:

xy(N, 2) array

closedbool, default: True

Whether the polygon is closed (i.e., has identical start and end points).

**kwargs

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
`blend_mode`	blend mode
`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
`fill_rule`	{'nonzero', 'evenodd'}
`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`	linestyle
`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_closed()[source]#: Return whether the polygon is closed.

get_path()[source]#: Get the Path of the polygon.

get_xy()[source]#

Get the vertices of the path.

Returns:

(N, 2) array: The coordinates of the vertices.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, blend_mode=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, closed=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, edgegapcolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, fill_rule=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, hatchcolor=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xy=<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 to set(linewidth=2), but it is an error to pass both simultaneously.

The order of the individual setter calls matches the order of parameters in set(). However, most properties do not depend on each other so that 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 or aa

bool or None

blend_mode

blend mode

capstyle

CapStyle or {'butt', 'projecting', 'round'}

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

closed

bool

color

color

edgecolor or ec

color or None

edgegapcolor

color or None

facecolor or fc

color or None

figure

Figure or SubFigure

fill

bool

fill_rule

{'nonzero', 'evenodd'}

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

linestyle

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

xy

(N, 2) array-like

zorder

float

set_closed(closed)[source]#

Set whether the polygon is closed.

Parameters:

closedbool: True if the polygon is closed

set_xy(xy)[source]#

Set the vertices of the polygon.

Parameters:

xy(N, 2) array-like: The coordinates of the vertices.

Notes

Unlike Path, we do not ignore the last input vertex. If the polygon is meant to be closed, and the last point of the polygon is not equal to the first, we assume that the user has not explicitly passed a CLOSEPOLY vertex, and add it ourselves.