matplotlib.patches.Annulus¶
- class matplotlib.patches.Annulus(xy, r, width, angle=0.0, **kwargs)[source]¶
Bases:
matplotlib.patches.Patch
An elliptical annulus.
- Parameters
- xy(float, float)
xy coordinates of annulus centre.
- rfloat or (float, float)
The radius, or semi-axes:
If float: radius of the outer circle.
If two floats: semi-major and -minor axes of outer ellipse.
- widthfloat
Width (thickness) of the annular ring. The width is measured inward from the outer ellipse so that for the inner ellipse the semi-axes are given by
r - width
. width must be less than or equal to the semi-minor axis.- anglefloat, default: 0
Rotation angle in degrees (anti-clockwise from the positive x-axis). Ignored for circular annuli (i.e., if r is a scalar).
- **kwargs
Keyword arguments control the
Patch
properties:Property
Description
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
unknown
bool
antialiased
or aabool or None
CapStyle
or {'butt', 'projecting', 'round'}bool
Patch or (Path, Transform) or None
color
edgecolor
or eccolor or None
facecolor
or fccolor or None
bool
str
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyle
or {'miter', 'round', 'bevel'}object
linestyle
or ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth
or lwfloat or None
None or bool or float or callable
bool
(scale: float, length: float, randomness: float)
bool or None
str
bool
float
- property angle¶
Return the angle of the annulus.
- property center¶
Return the center of the annulus.
- property radii¶
Return the semi-major and semi-minor radii of the annulus.
- 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>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, radii=<UNSET>, rasterized=<UNSET>, semimajor=<UNSET>, semiminor=<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
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
scalar or None
float
bool
antialiased
or aabool or None
CapStyle
or {'butt', 'projecting', 'round'}(float, float)
bool
Patch or (Path, Transform) or None
color
edgecolor
or eccolor or None
facecolor
or fccolor or None
bool
str
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyle
or {'miter', 'round', 'bevel'}object
linestyle
or ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth
or lwfloat or None
None or bool or float or callable
float or (float, float)
bool
float
float
(scale: float, length: float, randomness: float)
bool or None
str
bool
float
float
- set_radii(r)[source]¶
Set the semi-major (a) and semi-minor radii (b) of the annulus.
- Parameters
- rfloat or (float, float)
The radius, or semi-axes:
If float: radius of the outer circle.
If two floats: semi-major and -minor axes of outer ellipse.
- set_width(width)[source]¶
Set the width (thickness) of the annulus ring.
The width is measured inwards from the outer ellipse.
- Parameters
- widthfloat
- property width¶
Return the width (thickness) of the annulus ring.