matplotlib.patches.Ellipse #

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

Bases:Patch

A scale-free ellipse.

Parameters:

xy(float, float): xy coordinates of ellipse centre.
widthfloat: Total length (diameter) of horizontal axis.
heightfloat: Total length (diameter) of vertical axis.
anglefloat, default: 0: 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 and two offsets from the bottom left corner of the image
alpha
unknown
animated
bool
antialiased oraa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clip_box
BboxBase or None
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor orec
color or None
facecolor orfc
color or None
figure
Figure orSubFigure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
hatch_linewidth
unknown
in_layout
bool
joinstyle
JoinStyle or {'miter', 'round', 'bevel'}
label
object
linestyle orls
{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth orlw
float or None
mouseover
bool
path_effects
list ofAbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
zorder
float

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 and two offsets from the bottom left corner of the image
`alpha`	unknown
`animated`	bool
`antialiased` or`aa`	bool or None
`capstyle`	`CapStyle` or {'butt', 'projecting', 'round'}
`clip_box`	`BboxBase` or None
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`color`	color
`edgecolor` or`ec`	color or None
`facecolor` or`fc`	color or None
`figure`	`Figure` or`SubFigure`
`fill`	bool
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	unknown
`in_layout`	bool
`joinstyle`	`JoinStyle` or {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or`ls`	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
`linewidth` or`lw`	float or None
`mouseover`	bool
`path_effects`	list of`AbstractPathEffect`
`picker`	None or bool or float or callable
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`transform`	`Transform`
`url`	str
`visible`	bool
`zorder`	float

propertyangle#: Return the angle of the ellipse.

propertycenter#: Return the center of the ellipse.

get_angle()[source]#: Return the angle of the ellipse.

get_center()[source]#: Return the center of the ellipse.

get_co_vertices()[source]#

Return the co-vertices coordinates of the ellipse.

The definition can be foundhere

Added in version 3.8.

get_corners()[source]#

Return the corners of the ellipse bounding box.

The bounding box orientation is moving anti-clockwise from thelower left corner defined before rotation.

get_height()[source]#: Return the height of the ellipse.

get_patch_transform()[source]#

Return theTransform instance mapping patch coordinatesto data coordinates.

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

get_path()[source]#: Return the path of the ellipse.

get_vertices()[source]#

Return the vertices coordinates of the ellipse.

The definition can be foundhere

Added in version 3.8.

get_width()[source]#: Return the width of the ellipse.

propertyheight#: Return the height of the ellipse.

set(*,agg_filter=<UNSET>,alpha=<UNSET>,angle=<UNSET>,animated=<UNSET>,antialiased=<UNSET>,capstyle=<UNSET>,center=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,color=<UNSET>,edgecolor=<UNSET>,facecolor=<UNSET>,fill=<UNSET>,gid=<UNSET>,hatch=<UNSET>,hatch_linewidth=<UNSET>,height=<UNSET>,in_layout=<UNSET>,joinstyle=<UNSET>,label=<UNSET>,linestyle=<UNSET>,linewidth=<UNSET>,mouseover=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,rasterized=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,transform=<UNSET>,url=<UNSET>,visible=<UNSET>,width=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties 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 and two offsets from the bottom left corner of the image
alpha
float or None
angle
float
animated
bool
antialiased oraa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
center
(float, float)
clip_box
BboxBase or None
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor orec
color or None
facecolor orfc
color or None
figure
Figure orSubFigure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
hatch_linewidth
unknown
height
float
in_layout
bool
joinstyle
JoinStyle or {'miter', 'round', 'bevel'}
label
object
linestyle orls
{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth orlw
float or None
mouseover
bool
path_effects
list ofAbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
width
float
zorder
float

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 and two offsets from the bottom left corner of the image
`alpha`	float or None
`angle`	float
`animated`	bool
`antialiased` or`aa`	bool or None
`capstyle`	`CapStyle` or {'butt', 'projecting', 'round'}
`center`	(float, float)
`clip_box`	`BboxBase` or None
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`color`	color
`edgecolor` or`ec`	color or None
`facecolor` or`fc`	color or None
`figure`	`Figure` or`SubFigure`
`fill`	bool
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	unknown
`height`	float
`in_layout`	bool
`joinstyle`	`JoinStyle` or {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or`ls`	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
`linewidth` or`lw`	float or None
`mouseover`	bool
`path_effects`	list of`AbstractPathEffect`
`picker`	None or bool or float or callable
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`transform`	`Transform`
`url`	str
`visible`	bool
`width`	float
`zorder`	float