matplotlib.patches.Rectangle#

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

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 and two offsets from the bottom left corner of the image
`alpha`	unknown
`animated`	bool
`antialiased` or `aa`	bool or None
`capstyle`	`CapStyle` or {'butt', 'projecting', 'round'}
`clip_box`	`BboxBase` or None
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`color`	color
`edgecolor` or `ec`	color or None
`edgegapcolor`	color or None
`facecolor` or `fc`	color or None
`figure`	`Figure` or `SubFigure`
`fill`	bool
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	unknown
`hatchcolor`	color or 'edge' or None
`in_layout`	bool
`joinstyle`	`JoinStyle` or {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `ls`	{'-', '--', '-.', ':', '', ...} or (offset, on-off-seq)
`linewidth` or `lw`	float or None
`mouseover`	bool
`path_effects`	list of `AbstractPathEffect`
`picker`	None or bool or float or callable
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`transform`	`Transform`
`url`	str
`visible`	bool
`zorder`	float

See also

FancyBboxPatch: A rectangle with a fancy box style, e.g. rounded corners.

get_angle()[source]#: Get the rotation angle in degrees.

get_bbox()[source]#: Return the Bbox.

get_center()[source]#: Return the centre of the rectangle.

get_corners()[source]#: Return the corners of the rectangle, moving anti-clockwise from (x0, y0).

get_height()[source]#: 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.

get_path()[source]#: Return the vertices of the rectangle.

get_width()[source]#: Return the width of the rectangle.

get_x()[source]#: Return the left coordinate of the rectangle.

get_xy()[source]#: Return the left and bottom coords of the rectangle as a tuple.

get_y()[source]#: Return the bottom coordinate of the rectangle.

property rotation_point#: The rotation point of the patch.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, angle=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, bounds=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, edgegapcolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, hatchcolor=<UNSET>, height=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, x=<UNSET>, xy=<UNSET>, y=<UNSET>, zorder=<UNSET>)[source]#

Set multiple properties at once.

a.set(a=A, b=B, c=C)

is equivalent to

a.set_a(A)
a.set_b(B)
a.set_c(C)

In addition to the full property names, aliases are also supported, e.g. set(lw=2) is equivalent to set(linewidth=2), but it is an error to pass both simultaneously.

The order of the individual setter calls matches the order of parameters in set(). However, most properties do not depend on each other so that order is rarely relevant.

Supported properties 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 and two offsets from the bottom left corner of the image

alpha

float or None

angle

unknown

animated

bool

antialiased or aa

bool or None

bounds

(left, bottom, width, height)

capstyle

CapStyle or {'butt', 'projecting', 'round'}

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

color

color

edgecolor or ec

color or None

edgegapcolor

color or None

facecolor or fc

color or None

figure

Figure or SubFigure

fill

bool

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

hatch_linewidth

unknown

hatchcolor

color or 'edge' or None

height

unknown

in_layout

bool

joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

label

object

linestyle or ls

{'-', '--', '-.', ':', '', ...} or (offset, on-off-seq)

linewidth or lw

float or None

mouseover

bool

path_effects

list of AbstractPathEffect

picker

None or bool or float or callable

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

transform

Transform

url

str

visible

bool

width

unknown

x

unknown

xy

(float, float)

y

unknown

zorder

float

set_angle(angle)[source]#

Set the rotation angle in degrees.

The rotation is performed anti-clockwise around xy.

set_bounds(*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_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 coordinate of the rectangle.

set_xy(xy)[source]#

Set the left and bottom coordinates of the rectangle.

Parameters:

xy(float, float)

set_y(y)[source]#: Set the bottom coordinate of the rectangle.

property xy#: Return the left and bottom coords of the rectangle as a tuple.

Examples using `matplotlib.patches.Rectangle`#

Placing images, preserving relative sizes

Create boxes from error bars using PatchCollection

Reference for Matplotlib artists

Hatch style reference

Hatchcolor Demo

Style sheets reference

Inset locator demo

Pick event demo

Viewlims

Identify whether artists intersect

Transformations Tutorial

Legend guide

Specifying colors

Text properties and layout

matplotlib.patches.Rectangle#

Examples using matplotlib.patches.Rectangle#

Examples using `matplotlib.patches.Rectangle`#