You are reading an old version of the documentation (v2.2.0). For the latest version see https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.Polygon.html
Version 2.2.0
matplotlib
Fork me on GitHub

Table Of Contents

This Page

matplotlib.patches.Polygon

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

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 kwargs 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 bool or None
capstyle [‘butt’ | ‘round’ | ‘projecting’]
clip_box a Bbox instance
clip_on bool
clip_path [(Path, Transform) | Patch | None]
color matplotlib color spec
contains a callable function
edgecolor or ec mpl color spec, None, ‘none’, or ‘auto’
facecolor or fc mpl color spec, or None for default, or ‘none’ for no color
figure a Figure instance
fill bool
gid an id string
hatch [‘/’ | ‘' | ‘|’ | ‘-‘ | ‘+’ | ‘x’ | ‘o’ | ‘O’ | ‘.’ | ‘*’]
joinstyle [‘miter’ | ‘round’ | ‘bevel’]
label object
linestyle or ls [‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (offset, on-off-dash-seq) | '-' | '--' | '-.' | ':' | 'None' | ' ' | '']
linewidth or lw float or None for default
path_effects AbstractPathEffect
picker [None | bool | float | callable]
rasterized bool or None
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url a url string
visible bool
zorder float

See also

Patch
For additional kwargs
get_closed()

Returns if the polygon is closed

Returns:

closed : bool

If the path is closed

get_path()

Get the path of the polygon

Returns:

path : Path

The Path object for the polygon

get_xy()

Get the vertices of the path

Returns:

vertices : numpy array

The coordinates of the vertices as a Nx2 ndarray.

set_closed(closed)

Set if the polygon is closed

Parameters:

closed : bool

True if the polygon is closed

set_xy(xy)

Set the vertices of the polygon

Parameters:

xy : numpy array or iterable of pairs

The coordinates of the vertices as a Nx2 ndarray or iterable of pairs.

xy

Set/get the vertices of the polygon. This property is provided for backward compatibility with matplotlib 0.91.x only. New code should use get_xy() and set_xy() instead.