matplotlib.patches.Rectangle¶
-
class
matplotlib.patches.
Rectangle
(xy, width, height, angle=0.0, **kwargs)[source]¶ Bases:
matplotlib.patches.Patch
A rectangle with lower left at xy = (x, y) with specified width, height and rotation angle.
Parameters: - xy(float, float)
The bottom and left rectangle coordinates
- widthfloat
Rectangle width
- heightfloat
Rectangle height
- anglefloat, optional
rotation in degrees anti-clockwise about xy (default is 0.0)
- fillbool, optional
Whether to fill the rectangle (default is
True
)
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 aaunknown capstyle
{'butt', 'round', 'projecting'} clip_box
Bbox
clip_on
bool clip_path
Patch or (Path, Transform) or None color
color contains
callable edgecolor
or eccolor or None or 'auto' facecolor
or fccolor 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 lwfloat 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 -
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.
-
set_bounds
(self, \*args)[source]¶ Set the bounds of the rectangle as left, bottom, width, height.
The values may be passed as separate parameters or as a tuple:
set_bounds(left, bottom, width, height) set_bounds((left, bottom, width, height))
-
set_xy
(self, xy)[source]¶ Set the left and bottom coordinates of the rectangle.
Parameters: - xy(float, float)
-
property
xy
¶ Return the left and bottom coords of the rectangle as a tuple.