matplotlib.patches.Rectangle — Matplotlib 3.10.1 documentation (original) (raw)
class matplotlib.patches.Rectangle(xy, width, height, *, angle=0.0, rotation_point='xy', **kwargs)[source]#
Bases: Patch
A rectangle defined via an anchor point xy and its width and height.
The rectangle extends from xy[0] to xy[0] + width in x-direction and from xy[1] to xy[1] + height in y-direction.
: +------------------+ : | | : height | : | | : (xy)---- width -----+
One may picture xy as the bottom left corner, but which corner xy is actually depends on the direction of the axis and the sign of _width_and height; e.g. xy would be the bottom right corner if the x-axis was inverted or if width was negative.
Parameters:
xy(float, float)
The anchor point.
widthfloat
Rectangle width.
heightfloat
Rectangle height.
anglefloat, default: 0
Rotation in degrees anti-clockwise about the rotation point.
rotation_point{'xy', 'center', (number, number)}, default: 'xy'
If 'xy', rotate around the anchor point. If 'center' rotate around the center. If 2-tuple of number, rotate around this coordinate.
Other Parameters:
**kwargsPatch properties
Get the rotation angle in degrees.
Return the Bbox.
Return the centre of the rectangle.
Return the corners of the rectangle, moving anti-clockwise from (x0, y0).
Return the height of the rectangle.
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.
Return the vertices of the rectangle.
Return the width of the rectangle.
Return the left coordinate of the rectangle.
Return the left and bottom coords of the rectangle as a tuple.
Return the bottom coordinate of the rectangle.
property rotation_point#
The rotation point of the patch.
set(*, agg_filter=, alpha=, angle=, animated=, antialiased=, bounds=, capstyle=, clip_box=, clip_on=, clip_path=, color=, edgecolor=, facecolor=, fill=, gid=, hatch=, hatch_linewidth=, height=, in_layout=, joinstyle=, label=, linestyle=, linewidth=, mouseover=, path_effects=, picker=, rasterized=, sketch_params=, snap=, transform=, url=, visible=, width=, x=, xy=, y=, zorder=)[source]#
Set multiple properties at once.
Supported properties are
Set the rotation angle in degrees.
The rotation is performed anti-clockwise around xy.
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 the height of the rectangle.
Set the width of the rectangle.
Set the left coordinate of the rectangle.
Set the left and bottom coordinates of the rectangle.
Parameters:
xy(float, float)
Set the bottom coordinate of the rectangle.
property xy#
Return the left and bottom coords of the rectangle as a tuple.