matplotlib.patches.RegularPolygon

class matplotlib.patches.RegularPolygon(xy, numVertices, radius=5, orientation=0, **kwargs) [source]

Bases: matplotlib.patches.Patch

A regular polygon patch.

Parameters:
xy(float, float)

The center position.

numVerticesint

The number of vertices.

radiusfloat

The distance from the center to each of the vertices.

orientationfloat

The polygon rotation angle (in radians).

**kwargs

Patch properties:

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 unknown
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
__init__(self, xy, numVertices, radius=5, orientation=0, **kwargs) [source]
Parameters:
xy(float, float)

The center position.

numVerticesint

The number of vertices.

radiusfloat

The distance from the center to each of the vertices.

orientationfloat

The polygon rotation angle (in radians).

**kwargs

Patch properties:

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 unknown
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
__module__ = 'matplotlib.patches'
__str__(self) [source]

Return str(self).

get_patch_transform(self) [source]

Return the Transform instance mapping patch coordinates to data coordinates.

For example, one may define a patch of a circle which represents a radius of 5 by providing coordinates for a unit circle, and a transform which scales the coordinates (the patch coordinate) by 5.

get_path(self) [source]

Return the path of this patch.

property numvertices
property orientation
property radius
property xy

Examples using matplotlib.patches.RegularPolygon

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.3.3/api/_as_gen/matplotlib.patches.RegularPolygon.html