matplotlib.patches.Polygon

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

Bases: matplotlib.patches.Patch

A general polygon patch.

xy is a numpy array with shape Nx2.

If closed is True, the polygon will be closed so the starting and ending points are the same.

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
alpha float or None
animated bool
antialiased or aa unknown
capstyle {'butt', 'round', 'projecting'}
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or 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 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
get_closed(self)[source]

Returns if the polygon is closed

Returns:
closedbool

If the path is closed

get_path(self)[source]

Get the path of the polygon

Returns:
pathPath

The Path object for the polygon.

get_xy(self)[source]

Get the vertices of the path.

Returns:
vertices(N, 2) numpy array

The coordinates of the vertices.

set_closed(self, closed)[source]

Set if the polygon is closed

Parameters:
closedbool

True if the polygon is closed

set_xy(self, xy)[source]

Set the vertices of the polygon.

Parameters:
xy(N, 2) array-like

The coordinates of the vertices.

property xy

The vertices of the path as (N, 2) numpy array.