matplotlib.patches.FancyBboxPatch#
- class matplotlib.patches.FancyBboxPatch(xy, width, height, boxstyle='round', *, mutation_scale=1, mutation_aspect=1, **kwargs)[source]#
Bases:
Patch
A fancy box around a rectangle with lower left at xy = (x, y) with specified width and height.
FancyBboxPatch
is similar toRectangle
, but it draws a fancy box around the rectangle. The transformation of the rectangle box to the fancy box is delegated to the style classes defined inBoxStyle
.- Parameters:
- xyfloat, float
The lower left corner of the box.
- widthfloat
The width of the box.
- heightfloat
The height of the box.
- boxstylestr or
matplotlib.patches.BoxStyle
The style of the fancy box. This can either be a
BoxStyle
instance or a string of the style name and optionally comma separated attributes (e.g. "Round, pad=0.2"). This string is passed toBoxStyle
to construct aBoxStyle
object. See there for a full documentation.The following box styles are available:
Class
Name
Attrs
Square
square
pad=0.3
Circle
circle
pad=0.3
Ellipse
ellipse
pad=0.3
LArrow
larrow
pad=0.3
RArrow
rarrow
pad=0.3
DArrow
darrow
pad=0.3
Round
round
pad=0.3, rounding_size=None
Round4
round4
pad=0.3, rounding_size=None
Sawtooth
sawtooth
pad=0.3, tooth_size=None
Roundtooth
roundtooth
pad=0.3, tooth_size=None
- mutation_scalefloat, default: 1
Scaling factor applied to the attributes of the box style (e.g. pad or rounding_size).
- mutation_aspectfloat, default: 1
The height of the rectangle will be squeezed by this value before the mutation and the mutated box will be stretched by the inverse of it. For example, this allows different horizontal and vertical padding.
- Other Parameters:
- **kwargs
Patch
properties Property
Description
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
unknown
bool
antialiased
or aabool or None
CapStyle
or {'butt', 'projecting', 'round'}bool
Patch or (Path, Transform) or None
color
edgecolor
or eccolor or None
facecolor
or fccolor or None
bool
str
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyle
or {'miter', 'round', 'bevel'}object
linestyle
or ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth
or lwfloat or None
bool
None or bool or float or callable
bool
(scale: float, length: float, randomness: float)
bool or None
str
bool
float
- **kwargs
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, bounds=<UNSET>, boxstyle=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, height=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, mutation_aspect=<UNSET>, mutation_scale=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)[source]#
Set multiple properties at once.
Supported properties are
Property
Description
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
scalar or None
bool
antialiased
or aabool or None
unknown
[ 'square' | 'circle' | 'ellipse' | 'larrow' | 'rarrow' | 'darrow' | 'round' | 'round4' | 'sawtooth' | 'roundtooth' ]
CapStyle
or {'butt', 'projecting', 'round'}bool
Patch or (Path, Transform) or None
color
edgecolor
or eccolor or None
facecolor
or fccolor or None
bool
str
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
float
bool
JoinStyle
or {'miter', 'round', 'bevel'}object
linestyle
or ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth
or lwfloat or None
bool
float
float
None or bool or float or callable
bool
(scale: float, length: float, randomness: float)
bool or None
str
bool
float
float
float
float
- set_bounds(*args)[source]#
Set the bounds of the rectangle.
Call signatures:
set_bounds(left, bottom, width, height) set_bounds((left, bottom, width, height))
- Parameters:
- left, bottomfloat
The coordinates of the bottom left corner of the rectangle.
- width, heightfloat
The width/height of the rectangle.
- set_boxstyle(boxstyle=None, **kwargs)[source]#
Set the box style, possibly with further attributes.
Attributes from the previous box style are not reused.
Without argument (or with
boxstyle=None
), the available box styles are returned as a human-readable string.- Parameters:
- boxstylestr or
matplotlib.patches.BoxStyle
The style of the box: either a
BoxStyle
instance, or a string, which is the style name and optionally comma separated attributes (e.g. "Round,pad=0.2"). Such a string is used to construct aBoxStyle
object, as documented in that class.The following box styles are available:
Class
Name
Attrs
Square
square
pad=0.3
Circle
circle
pad=0.3
Ellipse
ellipse
pad=0.3
LArrow
larrow
pad=0.3
RArrow
rarrow
pad=0.3
DArrow
darrow
pad=0.3
Round
round
pad=0.3, rounding_size=None
Round4
round4
pad=0.3, rounding_size=None
Sawtooth
sawtooth
pad=0.3, tooth_size=None
Roundtooth
roundtooth
pad=0.3, tooth_size=None
- **kwargs
Additional attributes for the box style. See the table above for supported parameters.
- boxstylestr or
Examples
set_boxstyle("Round,pad=0.2") set_boxstyle("round", pad=0.2)
Examples using matplotlib.patches.FancyBboxPatch
#
Reference for Matplotlib artists