You are reading an old version of the documentation (v3.1.3). For the latest version see https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.Ellipse.html
Version 3.1.3
matplotlib
Fork me on GitHub

Table of Contents

matplotlib.patches.Ellipse

class matplotlib.patches.Ellipse(xy, width, height, angle=0, **kwargs)[source]

Bases: matplotlib.patches.Patch

A scale-free ellipse.

Parameters:
xy : (float, float)

xy coordinates of ellipse centre.

width : float

Total length (diameter) of horizontal axis.

height : float

Total length (diameter) of vertical axis.

angle : scalar, optional

Rotation in degrees anti-clockwise.

Notes

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 [(Path, Transform) | Patch | 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 float 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
center

Return the center of the ellipse

get_center(self)[source]

Return the center of the ellipse

get_patch_transform(self)[source]

Return the Transform instance which takes 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 the ellipse

set_center(self, xy)[source]

Set the center of the ellipse.

Parameters:
xy : (float, float)