matplotlib.patches.BoxStyle
-
class
matplotlib.patches.
BoxStyle
( stylename, **kw ) [source] -
Bases:
matplotlib.patches._Style
BoxStyle
is a container class which defines several boxstyle classes, which are used forFancyBboxPatch
.A style object can be created as:
BoxStyle.Round(pad=0.2)
or:
BoxStyle("Round", pad=0.2)
or:
BoxStyle("Round, pad=0.2")
The following boxstyle classes are defined.
Class Name Attrs Circle circle
pad=0.3 DArrow darrow
pad=0.3 LArrow larrow
pad=0.3 RArrow rarrow
pad=0.3 Round round
pad=0.3, rounding_size=None Round4 round4
pad=0.3, rounding_size=None Roundtooth roundtooth
pad=0.3, tooth_size=None Sawtooth sawtooth
pad=0.3, tooth_size=None Square square
pad=0.3 An instance of any boxstyle class is an callable object, whose call signature is:
__call__(self, x0, y0, width, height, mutation_size)
and returns a
Path
instance. x0, y0, width and height specify the location and size of the box to be drawn. mutation_scale determines the overall size of the mutation (by which I mean the transformation of the rectangle to the fancy box).Return the instance of the subclass with the given style name.
-
class
Circle
( pad=0.3 ) [source] -
Bases:
matplotlib.patches.BoxStyle._Base
A circular box.
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
-
__call__
( x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter> ) [source] -
Given the location and size of the box, return the path of the box around it.
Parameters: - x0, y0, width, height float
-
Location and size of the box.
- mutation_size float
-
A reference scale for the mutation.
Returns:
-
__init__
( pad=0.3 ) [source] -
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
-
__module__
= 'matplotlib.patches'
-
class
DArrow
( pad=0.3 ) [source] -
Bases:
matplotlib.patches.BoxStyle._Base
A box in the shape of a two-way arrow.
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
-
__call__
( x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter> ) [source] -
Given the location and size of the box, return the path of the box around it.
Parameters: - x0, y0, width, height float
-
Location and size of the box.
- mutation_size float
-
A reference scale for the mutation.
Returns:
-
__init__
( pad=0.3 ) [source] -
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
-
__module__
= 'matplotlib.patches'
-
class
LArrow
( pad=0.3 ) [source] -
Bases:
matplotlib.patches.BoxStyle._Base
A box in the shape of a left-pointing arrow.
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
-
__call__
( x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter> ) [source] -
Given the location and size of the box, return the path of the box around it.
Parameters: - x0, y0, width, height float
-
Location and size of the box.
- mutation_size float
-
A reference scale for the mutation.
Returns:
-
__init__
( pad=0.3 ) [source] -
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
-
__module__
= 'matplotlib.patches'
-
class
RArrow
( pad=0.3 ) [source] -
Bases:
matplotlib.patches.BoxStyle.LArrow
A box in the shape of a right-pointing arrow.
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
-
__call__
( x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter> ) [source] -
Given the location and size of the box, return the path of the box around it.
Parameters: - x0, y0, width, height float
-
Location and size of the box.
- mutation_size float
-
A reference scale for the mutation.
Returns:
-
__module__
= 'matplotlib.patches'
-
class
Round
( pad=0.3, rounding_size=None ) [source] -
Bases:
matplotlib.patches.BoxStyle._Base
A box with round corners.
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
- rounding_size float, default: pad
-
Radius of the corners.
-
__call__
( x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter> ) [source] -
Given the location and size of the box, return the path of the box around it.
Parameters: - x0, y0, width, height float
-
Location and size of the box.
- mutation_size float
-
A reference scale for the mutation.
Returns:
-
__init__
( pad=0.3, rounding_size=None ) [source] -
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
- rounding_size float, default: pad
-
Radius of the corners.
-
__module__
= 'matplotlib.patches'
-
class
Round4
( pad=0.3, rounding_size=None ) [source] -
Bases:
matplotlib.patches.BoxStyle._Base
A box with rounded edges.
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
- rounding_size float, default: pad/2
-
Rounding of edges.
-
__call__
( x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter> ) [source] -
Given the location and size of the box, return the path of the box around it.
Parameters: - x0, y0, width, height float
-
Location and size of the box.
- mutation_size float
-
A reference scale for the mutation.
Returns:
-
__init__
( pad=0.3, rounding_size=None ) [source] -
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
- rounding_size float, default: pad/2
-
Rounding of edges.
-
__module__
= 'matplotlib.patches'
-
class
Roundtooth
( pad=0.3, tooth_size=None ) [source] -
Bases:
matplotlib.patches.BoxStyle.Sawtooth
A box with a rounded sawtooth outline.
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
- tooth_size float, default: pad/2
-
Size of the sawtooth.
-
__call__
( x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter> ) [source] -
Given the location and size of the box, return the path of the box around it.
Parameters: - x0, y0, width, height float
-
Location and size of the box.
- mutation_size float
-
A reference scale for the mutation.
Returns:
-
__module__
= 'matplotlib.patches'
-
class
Sawtooth
( pad=0.3, tooth_size=None ) [source] -
Bases:
matplotlib.patches.BoxStyle._Base
A box with a sawtooth outline.
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
- tooth_size float, default: pad/2
-
Size of the sawtooth.
-
__call__
( x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter> ) [source] -
Given the location and size of the box, return the path of the box around it.
Parameters: - x0, y0, width, height float
-
Location and size of the box.
- mutation_size float
-
A reference scale for the mutation.
Returns:
-
__init__
( pad=0.3, tooth_size=None ) [source] -
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
- tooth_size float, default: pad/2
-
Size of the sawtooth.
-
__module__
= 'matplotlib.patches'
-
class
Square
( pad=0.3 ) [source] -
Bases:
matplotlib.patches.BoxStyle._Base
A square box.
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
-
__call__
( x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter> ) [source] -
Given the location and size of the box, return the path of the box around it.
Parameters: - x0, y0, width, height float
-
Location and size of the box.
- mutation_size float
-
A reference scale for the mutation.
Returns:
-
__init__
( pad=0.3 ) [source] -
Parameters: - pad float, default: 0.3
-
The amount of padding around the original box.
-
__module__
= 'matplotlib.patches'
-
__module__
= 'matplotlib.patches'
-
class
Examples using matplotlib.patches.BoxStyle
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/_as_gen/matplotlib.patches.BoxStyle.html