On this page
matplotlib.patches.Polygon
class matplotlib.patches.Polygon(xy, closed=True, **kwargs)[source]-
Bases:
matplotlib.patches.PatchA 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 kwargs are:
Property Description agg_filtera filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alphafloat or None animatedbool antialiasedunknown capstyle{'butt', 'round', 'projecting'} clip_boxBboxclip_onbool clip_path[( Path,Transform) |Patch| None]colorcolor containscallable edgecolorcolor or None or 'auto' facecolorcolor or None figureFigurefillbool gidstr hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layoutbool joinstyle{'miter', 'round', 'bevel'} labelobject linestyle{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthfloat or None for default path_effectsAbstractPathEffectpickerNone or bool or float or callable rasterizedbool or None sketch_params(scale: float, length: float, randomness: float) snapbool or None transformTransformurlstr visiblebool zorderfloat See also
Patch- For additional kwargs
get_closed()[source]-
Returns if the polygon is closed
Returns: -
closed : bool -
If the path is closed
-
get_path()[source]-
Get the path of the polygon
Returns: -
path : Path -
The
Pathobject for the polygon
-
get_xy()[source]-
Get the vertices of the path.
Returns: -
vertices : (N, 2) numpy array -
The coordinates of the vertices.
-
set_closed(closed)[source]-
Set if the polygon is closed
Parameters: -
closed : bool -
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.
-
xy-
The vertices of the path as (N, 2) numpy array.
Examples using matplotlib.patches.Polygon
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.0.0/api/_as_gen/matplotlib.patches.Polygon.html