matplotlib.patches.Rectangle

class matplotlib.patches.Rectangle(xy, width, height, angle=0.0, **kwargs)

Draw a rectangle with lower left at xy = (x, y) with specified width, height and rotation angle.

Parameters:

xy: length-2 tuple

The bottom and left rectangle coordinates

width:

Rectangle width

height:

Rectangle height

angle: float, optional

rotation in degrees anti-clockwise about xy (default is 0.0)

fill: bool, optional

Whether to fill the rectangle (default is True)

Notes

Valid kwargs 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 aa	bool or None
capstyle	['butt' | 'round' | 'projecting']
clip_box	a Bbox instance
clip_on	bool
clip_path	[(Path, Transform) | Patch | None]
color	matplotlib color spec
contains	a callable function
edgecolor or ec	mpl color spec, None, 'none', or 'auto'
facecolor or fc	mpl color spec, or None for default, or 'none' for no color
figure	a Figure instance
fill	bool
gid	an id string
hatch	['/' | '\' | '|' | '-' | '+' | 'x' | 'o' | 'O' | '.' | '*']
joinstyle	['miter' | 'round' | 'bevel']
label	object
linestyle or ls	['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) | '-' | '--' | '-.' | ':' | 'None' | ' ' | '']
linewidth or lw	float or None for default
path_effects	AbstractPathEffect
picker	[None | bool | float | callable]
rasterized	bool or None
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
transform	Transform
url	a url string
visible	bool
zorder	float

get_bbox()

get_height()

Return the height of the rectangle

get_patch_transform()

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.

get_path()

Return the vertices of the rectangle

get_width()

Return the width of the rectangle

get_x()

Return the left coord of the rectangle

get_xy()

Return the left and bottom coords of the rectangle

get_y()

Return the bottom coord of the rectangle

set_bounds(*args)

Set the bounds of the rectangle: l,b,w,h

ACCEPTS: (left, bottom, width, height)

set_height(h)

Set the height of the rectangle

set_width(w)

Set the width of the rectangle

set_x(x)

Set the left coord of the rectangle

set_xy(xy)

Set the left and bottom coords of the rectangle

ACCEPTS: 2-item sequence

set_y(y)

Set the bottom coord of the rectangle

xy

Return the left and bottom coords of the rectangle

Examples using matplotlib.patches.Rectangle

Text Layout

Creating boxes from error bars using PatchCollection

Reference for matplotlib artists

Viewlims

Pick Event Demo

Anchored Artists

Artist tests

Menu

Legend guide

Transformations Tutorial

Specifying Colors

Text properties and layout