matplotlib.patches.Polygon — Matplotlib 3.10.1 documentation (original) (raw)
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
Return whether the polygon is closed.
Get the Path of the polygon.
Get the vertices of the path.
Returns:
(N, 2) array
The coordinates of the vertices.
set(*, agg_filter=, alpha=, animated=, antialiased=, capstyle=, clip_box=, clip_on=, clip_path=, closed=, color=, edgecolor=, facecolor=, fill=, gid=, hatch=, hatch_linewidth=, in_layout=, joinstyle=, label=, linestyle=, linewidth=, mouseover=, path_effects=, picker=, rasterized=, sketch_params=, snap=, transform=, url=, visible=, xy=, zorder=)[source]#
Set multiple properties at once.
Supported properties are
Set whether the polygon is closed.
Parameters:
closedbool
True if the polygon is closed
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 aCLOSEPOLY vertex, and add it ourselves.
property xy#
The vertices of the path as a (N, 2) array.