W3cubDocs

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 `width : float` Rectangle width `height : float` 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
`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(self) [source]

get_height(self) [source]: Return the height of the rectangle.

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.