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. `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
`alpha`	scalar or None
`animated`	bool
`antialiased` or aa	unknown
`capstyle`	`CapStyle` or {'butt', 'projecting', 'round'}
`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`	`JoinStyle` or {'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
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`transform`	`Transform`
`url`	str
`visible`	bool
`zorder`	float

__init__(self, xy, width, height, angle=0, **kwargs) [source]

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
`alpha`	scalar or None
`animated`	bool
`antialiased` or aa	unknown
`capstyle`	`CapStyle` or {'butt', 'projecting', 'round'}
`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`	`JoinStyle` or {'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
`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).

property angle: Return the angle of the ellipse.

property center: Return the center of the ellipse.

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

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

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

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.