matplotlib.patches.Rectangle
-
class matplotlib.patches.Rectangle(xy, width, height, angle=0.0, **kwargs)[source] -
Bases:
matplotlib.patches.PatchDraw 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_filtera filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alphafloat or None animatedbool antialiasedunknown capstyle{'butt', 'round', 'projecting'} clip_boxBboxclip_onbool clip_path[( Path,Transform) |Patch| None]colorcolor containscallable edgecolorcolor or None or 'auto' facecolorcolor or None figureFigurefillbool gidstr hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layoutbool joinstyle{'miter', 'round', 'bevel'} labelobject linestyle{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthfloat or None for default path_effectsAbstractPathEffectpickerNone or bool or float or callable rasterizedbool or None sketch_params(scale: float, length: float, randomness: float) snapbool or None transformTransformurlstr visiblebool zorderfloat -
get_bbox()[source]
-
get_height()[source] -
Return the height of the rectangle.
-
get_patch_transform()[source] -
Return the
Transforminstance 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.
Examples using matplotlib.patches.Rectangle
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.0.0/api/_as_gen/matplotlib.patches.Rectangle.html