matplotlib.patches.Ellipse#

class matplotlib.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 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

edgegapcolor

color or None

facecolor or fc

color or None

figure

Figure or SubFigure

fill

bool

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

hatch_linewidth

unknown

hatchcolor

color or 'edge' or None

in_layout

bool

joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

label

object

linestyle or ls

{'-', '--', '-.', ':', '', ...} or (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

property angle#: Return the angle of the ellipse.

property center#: 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 found here

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 the lower left corner defined before rotation.

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

get_patch_transform()[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()[source]#: Return the path of the ellipse.

get_vertices()[source]#

Return the vertices coordinates of the ellipse.

The definition can be found here

Added in version 3.8.

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

property height#: 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>, edgegapcolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, hatchcolor=<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.

a.set(a=A, b=B, c=C)

is equivalent to

a.set_a(A)
a.set_b(B)
a.set_c(C)

In addition to the full property names, aliases are also supported, e.g. set(lw=2) is equivalent to set(linewidth=2), but it is an error to pass both simultaneously.

The order of the individual setter calls matches the order of parameters in set(). However, most properties do not depend on each other so that order is rarely relevant.

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 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

edgegapcolor

color or None

facecolor or fc

color or None

figure

Figure or SubFigure

fill

bool

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

hatch_linewidth

unknown

hatchcolor

color or 'edge' or None

height

float

in_layout

bool

joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

label

object

linestyle or ls

{'-', '--', '-.', ':', '', ...} or (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

set_angle(angle)[source]#

Set the angle of the ellipse.

Parameters:

anglefloat

set_center(xy)[source]#

Set the center of the ellipse.

Parameters:

xy(float, float)

set_height(height)[source]#

Set the height of the ellipse.

Parameters:

heightfloat

set_width(width)[source]#

Set the width of the ellipse.

Parameters:

widthfloat

property width#: Return the width of the ellipse.

Examples using `matplotlib.patches.Ellipse`#

Clipping images with patches

Axes box aspect

Plot a confidence ellipse of a two-dimensional dataset

Scale invariant angle label

Annotate plots

Artists as annotations

Reference for Matplotlib artists

Dolphins

Ellipse with orientation arrow demo

Ellipse Demo

Hatch demo

Circles, Wedges and Polygons

ggplot style sheet

Grayscale style sheet

Petroff style sheets

Style sheets reference

Draw flat objects in 3D plot

Radar chart (aka spider or star chart)

Ellipse with units

Transformations Tutorial

Legend guide

Annotations

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
`edgegapcolor`	color or None
`facecolor` or `fc`	color or None
`figure`	`Figure` or `SubFigure`
`fill`	bool
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	unknown
`hatchcolor`	color or 'edge' or None
`in_layout`	bool
`joinstyle`	`JoinStyle` or {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `ls`	{'-', '--', '-.', ':', '', ...} or (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

matplotlib.patches.Ellipse#

Examples using matplotlib.patches.Ellipse#

Examples using `matplotlib.patches.Ellipse`#