You are reading documentation for the unreleased version of Matplotlib. Try searching for the released version of this page instead?
Applications are open for the 2018 John Hunter Matplotlib Summer Fellowship. Apply now!
Version 2.2.2.post1744+g9382a0569
matplotlib
Fork me on GitHub

Table Of Contents

matplotlib.patches.Rectangle

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

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 unknown
capstyle {'butt', 'round', 'projecting'}
clip_box Bbox
clip_on bool
clip_path [(Path, Transform) | Patch | None]
color color
contains callable
edgecolor or ec color or None or 'auto'
facecolor or fc color 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 lw float or None for default
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_bbox()[source]
get_height()[source]

Return the height of the rectangle.

get_patch_transform()[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.

get_path()[source]

Return the vertices of the rectangle.

get_width()[source]

Return the width of the rectangle.

get_x()[source]

Return the left coord of the rectangle.

get_xy()[source]

Return the left and bottom coords of the rectangle.

get_y()[source]

Return the bottom coord of the rectangle.

set_bounds(*args)[source]

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

ACCEPTS: (left, bottom, width, height)

set_height(h)[source]

Set the height of the rectangle.

set_width(w)[source]

Set the width of the rectangle.

set_x(x)[source]

Set the left coord of the rectangle.

set_xy(xy)[source]

Set the left and bottom coords of the rectangle.

Parameters:
xy : 2-item sequence
set_y(y)[source]

Set the bottom coord of the rectangle.

xy

Return the left and bottom coords of the rectangle.