Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
data_interval
unknown
figure
Figure
gid
str
in_layout
bool
inverted
unknown
label
object
label_coords
unknown
label_position
{'top', 'bottom'}
label_text
str
major_formatter
Formatter, str, or function
major_locator
Locator
minor_formatter
Formatter, str, or function
minor_locator
Locator
pane_color
unknown
pane_pos
unknown
path_effects
AbstractPathEffect
picker
None or bool or float or callable
pickradius
float
rasterized
bool
remove_overlapping_locs
unknown
rotate_label
unknown
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
tick_params
unknown
ticklabels
sequence of str or of Texts
ticks
list of floats
ticks_position
{'top', 'bottom', 'both', 'default', 'none'}
transform
Transform
units
units tag
url
str
view_interval
unknown
visible
bool
zorder
float


Whether to rotate the axis label: True, False or None. If set to None the label will be rotated if longer than 4 chars.


Transform the points by the projection matrix


Transform the points by the projection matrix and return the clipping result returns txs, tys, tzs, tis


Produce a matrix that scales homogeneous coords in the specified ranges to [0, 1], or [0, pb_aspect[i]] if the plotbox aspect ratio is specified.


Container classes for Artists.
The base of all container artists defined in this module.
Anchor and align an arbitrary Artist or a text relative to the parent axes or a specific anchor point.
A container with fixed width and height. Children have a fixed position inside the container and may be clipped.
Containers for layouting their children vertically or horizontally.
A container to add a padding around an Artist.
Contains a single Text instance.
Bases: matplotlib.offsetbox.OffsetBox
An offset box placed according to location loc.
AnchoredOffsetbox has a single child. When multiple children are needed, use an extra OffsetBox to enclose them. By default, the offset box is anchored against its parent axes. You may explicitly specify the bbox_to_anchor.
The box location. Valid locations are 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.
Padding around the child as fraction of the fontsize.
Padding between the offsetbox frame and the bbox_to_anchor.
The box that will be anchored.
This is only used as a reference for paddings. If not given, rcParams["legend.fontsize"] (default: 'medium') is used.
Whether to draw a frame around the box.
Box that is used to position the legend in conjunction with loc.
The transform for the bounding box (bbox_to_anchor).
All other parameters are passed on to OffsetBox.
See Legend for a detailed description of the anchoring mechanism.
Update the location of children if necessary and draw them to the given renderer.
Return the bbox that the box is anchored to.
Return the child.
Return the list of children.
Return the extent of the box as (width, height, x, y).
This is the extent of the child plus the padding.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
bbox_to_anchor
unknown
child
unknown
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float
Set the bbox that the box is anchored to.
bbox can be a Bbox instance, a list of [left, bottom, width, height], or a list of [left, bottom] where the width and height will be assumed to be zero. The bbox will be transformed to display coordinate by the given transform.
Set the child to be anchored.
Bases: matplotlib.offsetbox.AnchoredOffsetbox
AnchoredOffsetbox with Text.
Text.
Location code. See AnchoredOffsetbox.
Padding around the text as fraction of the fontsize.
Spacing between the offsetbox frame and the bbox_to_anchor.
Dictionary of keyword parameters to be passed to the Text instance contained inside AnchoredText.
All other parameters are passed to AnchoredOffsetbox.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
bbox_to_anchor
unknown
child
unknown
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float
Bases: matplotlib.artist.Artist, matplotlib.text._AnnotationBase
Container for an OffsetBox referring to a specific position xy.
Optionally an arrow pointing from the offsetbox to xy can be drawn.
This is like Annotation, but with OffsetBox instead of Text.
The point (x, y) to annotate. The coordinate system is determined by xycoords.
The position (x, y) to place the text at. The coordinate system is determined by boxcoords.
The coordinate system that xy is given in. See the parameter xycoords in Annotation for a detailed description.
The coordinate system that xybox is given in. See the parameter textcoords in Annotation for a detailed description.
Whether to draw a frame around the box.
Padding around the offsetbox.
A tuple of two floats for a vertical and horizontal alignment of the offset box w.r.t. the boxcoords. The lower-left corner is (0, 0) and upper-right corner is (1, 1).
Other parameters are identical to Annotation.
Test whether the artist contains the mouse event.
Whether any values are within the radius.
An artist-specific dictionary of details of the event context, such as which points are contained in the pick radius. See the individual Artist subclasses for details.
Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (Artist.get_visible returns False).
This method is overridden in the Artist subclasses.
Return a list of the child Artists of this Artist.
Return the fontsize in points.
Like Artist.get_window_extent, but includes any clipping.
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())
The enclosing bounding box (in figure pixel coordinates).
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
annotation_clip
bool or None
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
unknown
fontsize
unknown
gid
str
in_layout
bool
label
object
path_effects
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
Set the Figure instance the artist belongs to.
Set the fontsize in points.
If s is not given, reset to rcParams["legend.fontsize"] (default: 'medium').
Update the pixel positions of the annotated point and the text.
Bases: matplotlib.offsetbox.OffsetBox
Offset Box with the aux_transform. Its children will be transformed with the aux_transform first then will be offsetted. The absolute coordinate of the aux_transform is meaning as it will be automatically adjust so that the left-lower corner of the bounding box of children will be set to (0, 0) before the offset transform.
It is similar to drawing area, except that the extent of the box is not predetermined but calculated from the window extent of its children. Furthermore, the extent of the children will be calculated in the transformed coordinate.
Add an Artist to the container box.
Update the location of children if necessary and draw them to the given renderer.
Return a tuple width, height, xdescent, ydescent of the box.
Return offset of the container.
Return the Transform applied to the children
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float)
path_effects
AbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
unknown
url
str
visible
bool
width
float
zorder
float
Set the offset of the container.
The (x, y) coordinates of the offset in display units.
set_transform is ignored.
Bases: matplotlib.offsetbox.DraggableBase
Bases: object
Helper base class for a draggable artist (legend, offsetbox).
Derived classes must override the following methods:
Optionally, you may override the following method:
In the current implementation of DraggableLegend and DraggableAnnotation, update_offset places the artists in display coordinates, and finalize_offset recalculates their position in axes coordinate and set a relevant attribute.
Disconnect the callbacks.
Bases: matplotlib.offsetbox.DraggableBase
Bases: matplotlib.offsetbox.OffsetBox
The DrawingArea can contain any Artist as a child. The DrawingArea has a fixed width and height. The position of children relative to the parent is fixed. The children can be clipped at the boundaries of the parent.
Width and height of the container box.
Descent of the box in x- and y-direction.
Whether to clip the children to the box.
Add an Artist to the container box.
If the children of this DrawingArea should be clipped by DrawingArea bounding box.
Update the location of children if necessary and draw them to the given renderer.
Return width, height, xdescent, ydescent of box.
Return offset of the container.
Return the Transform applied to the children.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float)
path_effects
AbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
unknown
url
str
visible
bool
width
float
zorder
float
Set the offset of the container.
The (x, y) coordinates of the offset in display units.
set_transform is ignored.
Bases: matplotlib.offsetbox.PackerBase
HPacker packs its children horizontally, automatically adjusting their relative positions at draw time.
The boundary padding in points.
The spacing between items in points.
Width and height of the container box in pixels, calculated if None.
Alignment of boxes.
The packing mode.
The artists to pack.
pad and sep are in points and will be scaled with the renderer dpi, while width and height are in pixels.
Update offset of the children and return the extent of the box.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float
Bases: matplotlib.artist.Artist
The OffsetBox is a simple container artist.
The child artists are meant to be drawn at a relative position to its parent.
Being an artist itself, all parameters are passed on to Artist.
The Axes instance the artist resides in, or None.
Delegate the mouse event contains-check to the children.
As a container, the OffsetBox does not respond itself to mouseevents.
Whether any values are within the radius.
An artist-specific dictionary of details of the event context, such as which points are contained in the pick radius. See the individual Artist subclasses for details.
See also
Update the location of children if necessary and draw them to the given renderer.
Return a list of the child Artists.
Return a tuple width, height, xdescent, ydescent of the box.
Update offset of the children and return the extent of the box.
Return the offset as a tuple (x, y).
The extent parameters have to be provided to handle the case where the offset is dynamically determined by a callable (see set_offset).
Extent parameters.
Return a list of the visible child Artists.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float
Set the Figure for the OffsetBox and all its children.
Set the height of the box.
Set the offset.
The (x, y) coordinates of the offset in display units. These can either be given explicitly as a tuple (x, y), or by providing a function that converts the extent into the offset. This function must have the signature:
Set the width of the box.
Bases: matplotlib.offsetbox.OffsetBox
Update the location of children if necessary and draw them to the given renderer.
Return a list of the child Artists.
Return a tuple width, height, xdescent, ydescent of the box.
Return offset of the container.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
data
unknown
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zoom
unknown
zorder
float
Bases: matplotlib.offsetbox.OffsetBox
The boundary padding in points.
The spacing between items in points.
Width and height of the container box in pixels, calculated if None.
Alignment of boxes.
The packing mode.
The artists to pack.
pad and sep are in points and will be scaled with the renderer dpi, while width and height are in pixels.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float
Bases: matplotlib.offsetbox.OffsetBox
A container to add a padding around an Artist.
The PaddedBox contains a FancyBboxPatch that is used to visualize it when rendering.
The contained Artist.
The padding in points. This will be scaled with the renderer dpi. In contrast width and height are in pixels and thus not scaled.
Whether to draw the contained FancyBboxPatch.
Additional parameters passed to the contained FancyBboxPatch.
Update the location of children if necessary and draw them to the given renderer.
Update offset of the children and return the extent of the box.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float
Bases: matplotlib.offsetbox.OffsetBox
The TextArea is a container artist for a single Text instance.
The text is placed at (0, 0) with baseline+left alignment, by default. The width and height of the TextArea instance is the width and height of its child text.
The text to be displayed.
Dictionary of keyword parameters to be passed to the Text instance in the TextArea.
Whether the baseline for multiline text is adjusted so that it is (approximately) center-aligned with single-line text.
If True, the box has a minimum descent of "p". This is now effectively always True.
Update the location of children if necessary and draw them to the given renderer.
Return a tuple width, height, xdescent, ydescent of the box.
[Deprecated] Get minimumdescent.
Deprecated since version 3.4.
Get multilinebaseline.
Return offset of the container.
Return the string representation of this area's text.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
minimumdescent
unknown
multilinebaseline
unknown
offset
(float, float)
path_effects
AbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
text
unknown
transform
unknown
url
str
visible
bool
width
float
zorder
float
[Deprecated] Set minimumdescent.
If True, extent of the single line text is adjusted so that its descent is at least the one of the glyph "p".
Deprecated since version 3.4.
Set multilinebaseline.
If True, the baseline for multiline text is adjusted so that it is (approximately) center-aligned with single-line text. This is used e.g. by the legend implementation so that single-line labels are baseline-aligned, but multiline labels are "center"-aligned with them.
Set the offset of the container.
The (x, y) coordinates of the offset in display units.
Set the text of this area as a string.
set_transform is ignored.
Bases: matplotlib.offsetbox.PackerBase
VPacker packs its children vertically, automatically adjusting their relative positions at draw time.
The boundary padding in points.
The spacing between items in points.
Width and height of the container box in pixels, calculated if None.
Alignment of boxes.
The packing mode.
The artists to pack.
pad and sep are in points and will be scaled with the renderer dpi, while width and height are in pixels.
Update offset of the children and return the extent of the box.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float


Bases: matplotlib.offsetbox.OffsetBox
An offset box placed according to location loc.
AnchoredOffsetbox has a single child. When multiple children are needed, use an extra OffsetBox to enclose them. By default, the offset box is anchored against its parent axes. You may explicitly specify the bbox_to_anchor.
The box location. Valid locations are 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.
Padding around the child as fraction of the fontsize.
Padding between the offsetbox frame and the bbox_to_anchor.
The box that will be anchored.
This is only used as a reference for paddings. If not given, rcParams["legend.fontsize"] (default: 'medium') is used.
Whether to draw a frame around the box.
Box that is used to position the legend in conjunction with loc.
The transform for the bounding box (bbox_to_anchor).
All other parameters are passed on to OffsetBox.
See Legend for a detailed description of the anchoring mechanism.
Update the location of children if necessary and draw them to the given renderer.
Return the bbox that the box is anchored to.
Return the child.
Return the list of children.
Return the extent of the box as (width, height, x, y).
This is the extent of the child plus the padding.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
bbox_to_anchor
unknown
child
unknown
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float
Set the bbox that the box is anchored to.
bbox can be a Bbox instance, a list of [left, bottom, width, height], or a list of [left, bottom] where the width and height will be assumed to be zero. The bbox will be transformed to display coordinate by the given transform.
Set the child to be anchored.


Update the location of children if necessary and draw them to the given renderer.


Return the bbox that the box is anchored to.


Return the extent of the box as (width, height, x, y).
This is the extent of the child plus the padding.


Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.


Set multiple properties at once.
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
alpha
scalar or None
animated
bool
bbox_to_anchor
unknown
child
unknown
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float


Set the bbox that the box is anchored to.
bbox can be a Bbox instance, a list of [left, bottom, width, height], or a list of [left, bottom] where the width and height will be assumed to be zero. The bbox will be transformed to display coordinate by the given transform.


Bases: matplotlib.offsetbox.AnchoredOffsetbox
AnchoredOffsetbox with Text.
Text.
Location code. See AnchoredOffsetbox.
Padding around the text as fraction of the fontsize.
Spacing between the offsetbox frame and the bbox_to_anchor.
Dictionary of keyword parameters to be passed to the Text instance contained inside AnchoredText.
All other parameters are passed to AnchoredOffsetbox.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
bbox_to_anchor
unknown
child
unknown
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float


Bases: matplotlib.artist.Artist, matplotlib.text._AnnotationBase
Container for an OffsetBox referring to a specific position xy.
Optionally an arrow pointing from the offsetbox to xy can be drawn.
This is like Annotation, but with OffsetBox instead of Text.
The point (x, y) to annotate. The coordinate system is determined by xycoords.
The position (x, y) to place the text at. The coordinate system is determined by boxcoords.
The coordinate system that xy is given in. See the parameter xycoords in Annotation for a detailed description.
The coordinate system that xybox is given in. See the parameter textcoords in Annotation for a detailed description.
Whether to draw a frame around the box.
Padding around the offsetbox.
A tuple of two floats for a vertical and horizontal alignment of the offset box w.r.t. the boxcoords. The lower-left corner is (0, 0) and upper-right corner is (1, 1).
Other parameters are identical to Annotation.
Test whether the artist contains the mouse event.
Whether any values are within the radius.
An artist-specific dictionary of details of the event context, such as which points are contained in the pick radius. See the individual Artist subclasses for details.
Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (Artist.get_visible returns False).
This method is overridden in the Artist subclasses.
Return a list of the child Artists of this Artist.
Return the fontsize in points.
Like Artist.get_window_extent, but includes any clipping.
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())
The enclosing bounding box (in figure pixel coordinates).
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
annotation_clip
bool or None
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
unknown
fontsize
unknown
gid
str
in_layout
bool
label
object
path_effects
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
Set the Figure instance the artist belongs to.
Set the fontsize in points.
If s is not given, reset to rcParams["legend.fontsize"] (default: 'medium').
Update the pixel positions of the annotated point and the text.


Test whether the artist contains the mouse event.
Whether any values are within the radius.
An artist-specific dictionary of details of the event context, such as which points are contained in the pick radius. See the individual Artist subclasses for details.


Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (Artist.get_visible returns False).
This method is overridden in the Artist subclasses.


Return a list of the child Artists of this Artist.


Like Artist.get_window_extent, but includes any clipping.
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())
The enclosing bounding box (in figure pixel coordinates).


Set multiple properties at once.
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
alpha
scalar or None
animated
bool
annotation_clip
bool or None
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
unknown
fontsize
unknown
gid
str
in_layout
bool
label
object
path_effects
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


Set the Figure instance the artist belongs to.


Set the fontsize in points.
If s is not given, reset to rcParams["legend.fontsize"] (default: 'medium').


Update the pixel positions of the annotated point and the text.


Bases: matplotlib.offsetbox.OffsetBox
Offset Box with the aux_transform. Its children will be transformed with the aux_transform first then will be offsetted. The absolute coordinate of the aux_transform is meaning as it will be automatically adjust so that the left-lower corner of the bounding box of children will be set to (0, 0) before the offset transform.
It is similar to drawing area, except that the extent of the box is not predetermined but calculated from the window extent of its children. Furthermore, the extent of the children will be calculated in the transformed coordinate.
Add an Artist to the container box.
Update the location of children if necessary and draw them to the given renderer.
Return a tuple width, height, xdescent, ydescent of the box.
Return offset of the container.
Return the Transform applied to the children
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float)
path_effects
AbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
unknown
url
str
visible
bool
width
float
zorder
float
Set the offset of the container.
The (x, y) coordinates of the offset in display units.
set_transform is ignored.


Update the location of children if necessary and draw them to the given renderer.


Return a tuple width, height, xdescent, ydescent of the box.


Return the Transform applied to the children


Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.


Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float)
path_effects
AbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
unknown
url
str
visible
bool
width
float
zorder
float


Set the offset of the container.
The (x, y) coordinates of the offset in display units.


Bases: object
Helper base class for a draggable artist (legend, offsetbox).
Derived classes must override the following methods:
Optionally, you may override the following method:
In the current implementation of DraggableLegend and DraggableAnnotation, update_offset places the artists in display coordinates, and finalize_offset recalculates their position in axes coordinate and set a relevant attribute.
Disconnect the callbacks.


Bases: matplotlib.offsetbox.OffsetBox
The DrawingArea can contain any Artist as a child. The DrawingArea has a fixed width and height. The position of children relative to the parent is fixed. The children can be clipped at the boundaries of the parent.
Width and height of the container box.
Descent of the box in x- and y-direction.
Whether to clip the children to the box.
Add an Artist to the container box.
If the children of this DrawingArea should be clipped by DrawingArea bounding box.
Update the location of children if necessary and draw them to the given renderer.
Return width, height, xdescent, ydescent of box.
Return offset of the container.
Return the Transform applied to the children.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float)
path_effects
AbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
unknown
url
str
visible
bool
width
float
zorder
float
Set the offset of the container.
The (x, y) coordinates of the offset in display units.
set_transform is ignored.


Return width, height, xdescent, ydescent of box.


Return the Transform applied to the children.


Bases: matplotlib.offsetbox.PackerBase
HPacker packs its children horizontally, automatically adjusting their relative positions at draw time.
The boundary padding in points.
The spacing between items in points.
Width and height of the container box in pixels, calculated if None.
Alignment of boxes.
The packing mode.
The artists to pack.
pad and sep are in points and will be scaled with the renderer dpi, while width and height are in pixels.
Update offset of the children and return the extent of the box.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float


Update offset of the children and return the extent of the box.


Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float


Bases: matplotlib.artist.Artist
The OffsetBox is a simple container artist.
The child artists are meant to be drawn at a relative position to its parent.
Being an artist itself, all parameters are passed on to Artist.
The Axes instance the artist resides in, or None.
Delegate the mouse event contains-check to the children.
As a container, the OffsetBox does not respond itself to mouseevents.
Whether any values are within the radius.
An artist-specific dictionary of details of the event context, such as which points are contained in the pick radius. See the individual Artist subclasses for details.
See also
Update the location of children if necessary and draw them to the given renderer.
Return a list of the child Artists.
Return a tuple width, height, xdescent, ydescent of the box.
Update offset of the children and return the extent of the box.
Return the offset as a tuple (x, y).
The extent parameters have to be provided to handle the case where the offset is dynamically determined by a callable (see set_offset).
Extent parameters.
Return a list of the visible child Artists.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float
Set the Figure for the OffsetBox and all its children.
Set the height of the box.
Set the offset.
The (x, y) coordinates of the offset in display units. These can either be given explicitly as a tuple (x, y), or by providing a function that converts the extent into the offset. This function must have the signature:
Set the width of the box.


Delegate the mouse event contains-check to the children.
As a container, the OffsetBox does not respond itself to mouseevents.
Whether any values are within the radius.
An artist-specific dictionary of details of the event context, such as which points are contained in the pick radius. See the individual Artist subclasses for details.
See also


Return the offset as a tuple (x, y).
The extent parameters have to be provided to handle the case where the offset is dynamically determined by a callable (see set_offset).
Extent parameters.


Return a list of the visible child Artists.


Set the Figure for the OffsetBox and all its children.


Set the offset.
The (x, y) coordinates of the offset in display units. These can either be given explicitly as a tuple (x, y), or by providing a function that converts the extent into the offset. This function must have the signature:


Bases: matplotlib.offsetbox.OffsetBox
Update the location of children if necessary and draw them to the given renderer.
Return a list of the child Artists.
Return a tuple width, height, xdescent, ydescent of the box.
Return offset of the container.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
data
unknown
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zoom
unknown
zorder
float


Update the location of children if necessary and draw them to the given renderer.


Return a tuple width, height, xdescent, ydescent of the box.


Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.


Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
data
unknown
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zoom
unknown
zorder
float


Bases: matplotlib.offsetbox.OffsetBox
The boundary padding in points.
The spacing between items in points.
Width and height of the container box in pixels, calculated if None.
Alignment of boxes.
The packing mode.
The artists to pack.
pad and sep are in points and will be scaled with the renderer dpi, while width and height are in pixels.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float


Bases: matplotlib.offsetbox.OffsetBox
A container to add a padding around an Artist.
The PaddedBox contains a FancyBboxPatch that is used to visualize it when rendering.
The contained Artist.
The padding in points. This will be scaled with the renderer dpi. In contrast width and height are in pixels and thus not scaled.
Whether to draw the contained FancyBboxPatch.
Additional parameters passed to the contained FancyBboxPatch.
Update the location of children if necessary and draw them to the given renderer.
Update offset of the children and return the extent of the box.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float


Bases: matplotlib.offsetbox.OffsetBox
The TextArea is a container artist for a single Text instance.
The text is placed at (0, 0) with baseline+left alignment, by default. The width and height of the TextArea instance is the width and height of its child text.
The text to be displayed.
Dictionary of keyword parameters to be passed to the Text instance in the TextArea.
Whether the baseline for multiline text is adjusted so that it is (approximately) center-aligned with single-line text.
If True, the box has a minimum descent of "p". This is now effectively always True.
Update the location of children if necessary and draw them to the given renderer.
Return a tuple width, height, xdescent, ydescent of the box.
[Deprecated] Get minimumdescent.
Deprecated since version 3.4.
Get multilinebaseline.
Return offset of the container.
Return the string representation of this area's text.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
minimumdescent
unknown
multilinebaseline
unknown
offset
(float, float)
path_effects
AbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
text
unknown
transform
unknown
url
str
visible
bool
width
float
zorder
float
[Deprecated] Set minimumdescent.
If True, extent of the single line text is adjusted so that its descent is at least the one of the glyph "p".
Deprecated since version 3.4.
Set multilinebaseline.
If True, the baseline for multiline text is adjusted so that it is (approximately) center-aligned with single-line text. This is used e.g. by the legend implementation so that single-line labels are baseline-aligned, but multiline labels are "center"-aligned with them.
Set the offset of the container.
The (x, y) coordinates of the offset in display units.
Set the text of this area as a string.
set_transform is ignored.


[Deprecated] Get minimumdescent.
Deprecated since version 3.4.


Return the string representation of this area's text.


Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
minimumdescent
unknown
multilinebaseline
unknown
offset
(float, float)
path_effects
AbstractPathEffect
picker
None or bool or float or callable
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
text
unknown
transform
unknown
url
str
visible
bool
width
float
zorder
float


[Deprecated] Set minimumdescent.
If True, extent of the single line text is adjusted so that its descent is at least the one of the glyph "p".
Deprecated since version 3.4.


Set multilinebaseline.
If True, the baseline for multiline text is adjusted so that it is (approximately) center-aligned with single-line text. This is used e.g. by the legend implementation so that single-line labels are baseline-aligned, but multiline labels are "center"-aligned with them.


Set the offset of the container.
The (x, y) coordinates of the offset in display units.


Bases: matplotlib.offsetbox.PackerBase
VPacker packs its children vertically, automatically adjusting their relative positions at draw time.
The boundary padding in points.
The spacing between items in points.
Width and height of the container box in pixels, calculated if None.
Alignment of boxes.
The packing mode.
The artists to pack.
pad and sep are in points and will be scaled with the renderer dpi, while width and height are in pixels.
Update offset of the children and return the extent of the box.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float


Update offset of the children and return the extent of the box.


Set multiple properties at once.
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
alpha
scalar or None
animated
bool
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
figure
Figure
gid
str
height
float
in_layout
bool
label
object
offset
(float, float) or callable
path_effects
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
float
zorder
float


Patches are Artists with a face color and an edge color.
Annulus(xy, r, width[, angle])
An elliptical annulus.
Arc(xy, width, height[, angle, theta1, theta2])
An elliptical arc, i.e. a segment of an ellipse.
Arrow(x, y, dx, dy[, width])
An arrow patch.
ArrowStyle(stylename, **kw)
ArrowStyle is a container class which defines several arrowstyle classes, which is used to create an arrow path along a given path.
BoxStyle(stylename, **kw)
BoxStyle is a container class which defines several boxstyle classes, which are used for FancyBboxPatch.
Circle(xy[, radius])
A circle patch.
CirclePolygon(xy[, radius, resolution])
A polygon-approximation of a circle patch.
ConnectionPatch(xyA, xyB, coordsA[, ...])
A patch that connects two points (possibly in different axes).
ConnectionStyle(stylename, **kw)
ConnectionStyle is a container class which defines several connectionstyle classes, which is used to create a path between two points.
Ellipse(xy, width, height[, angle])
A scale-free ellipse.
FancyArrow(x, y, dx, dy[, width, ...])
Like Arrow, but lets you set head width and head height independently.
FancyArrowPatch([posA, posB, path, ...])
A fancy arrow patch.
FancyBboxPatch(xy, width, height[, ...])
A fancy box around a rectangle with lower left at xy = (x, y) with specified width and height.
Patch([edgecolor, facecolor, color, ...])
A patch is a 2D artist with a face color and an edge color.
PathPatch(path, **kwargs)
A general polycurve path patch.
StepPatch(values, edges, *[, orientation, ...])
A path patch describing a stepwise constant function.
Polygon(xy[, closed])
A general polygon patch.
Rectangle(xy, width, height[, angle])
A rectangle defined via an anchor point xy and its width and height.
RegularPolygon(xy, numVertices[, radius, ...])
A regular polygon patch.
Shadow(patch, ox, oy, **kwargs)
Create a shadow of the given patch.
Wedge(center, r, theta1, theta2[, width])
Wedge shaped patch.
bbox_artist(artist, renderer[, props, fill])
A debug function to draw a rectangle around the bounding box returned by an artist's Artist.get_window_extent to test whether the artist is returning the correct bbox.
draw_bbox(bbox, renderer[, color, trans])
A debug function to draw a rectangle around the bounding box returned by an artist's Artist.get_window_extent to test whether the artist is returning the correct bbox.


Bases: matplotlib.patches.Patch
An elliptical annulus.
xy coordinates of annulus centre.
The radius, or semi-axes:
Width (thickness) of the annular ring. The width is measured inward from the outer ellipse so that for the inner ellipse the semi-axes are given by r - width. width must be less than or equal to the semi-minor axis.
Rotation angle in degrees (anti-clockwise from the positive x-axis). Ignored for circular annuli (i.e., if r is a scalar).
Keyword arguments control the Patch 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
alpha
unknown
animated
bool
antialiased or aa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor or ec
color or None
facecolor or fc
color or None
figure
Figure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'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
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
zorder
float
Return the angle of the annulus.
Return the center of the annulus.
Return the angle of the annulus.
Return the center of the annulus.
Return the path of this patch.
Return the semi-major and semi-minor radii of the annulus.
Return the width (thickness) of the annulus ring.
Return the semi-major and semi-minor radii of the annulus.
Set multiple properties at once.
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
alpha
scalar or None
angle
float
animated
bool
antialiased or aa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
center
(float, float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor or ec
color or None
facecolor or fc
color or None
figure
Figure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'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
radii
float or (float, float)
rasterized
bool
semimajor
float
semiminor
float
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
width
float
zorder
float
Set the tilt angle of the annulus.
Set the center of the annulus.
Set the semi-major (a) and semi-minor radii (b) of the annulus.
The radius, or semi-axes:
Set the semi-major axis a of the annulus.
Set the semi-minor axis b of the annulus.
Set the width (thickness) of the annulus ring.
The width is measured inwards from the outer ellipse.
Return the width (thickness) of the annulus ring.


Return the semi-major and semi-minor radii of the annulus.


Return the width (thickness) of the annulus ring.


Set multiple properties at once.
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
alpha
scalar or None
angle
float
animated
bool
antialiased or aa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
center
(float, float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor or ec
color or None
facecolor or fc
color or None
figure
Figure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'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
radii
float or (float, float)
rasterized
bool
semimajor
float
semiminor
float
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
width
float
zorder
float


Set the semi-major (a) and semi-minor radii (b) of the annulus.
The radius, or semi-axes:


Set the semi-major axis a of the annulus.


Set the semi-minor axis b of the annulus.


Set the width (thickness) of the annulus ring.
The width is measured inwards from the outer ellipse.


Bases: matplotlib.patches.Ellipse
An elliptical arc, i.e. a segment of an ellipse.
Due to internal optimizations, there are certain restrictions on using Arc:
The center of the ellipse.
The length of the horizontal axis.
The length of the vertical axis.
Rotation of the ellipse in degrees (counterclockwise).
Starting and ending angles of the arc in degrees. These values are relative to angle, e.g. if angle = 45 and theta1 = 90 the absolute starting angle is 135. Default theta1 = 0, theta2 = 360, i.e. a complete ellipse. The arc is drawn in the counterclockwise direction. Angles greater than or equal to 360, or smaller than 0, are represented by an equivalent angle in the range [0, 360), by taking the input value mod 360.
Most Patch properties are supported as keyword arguments, with the exception of fill and facecolor because filling is not supported.
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
unknown
animated
bool
antialiased or aa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor or ec
color or None
facecolor or fc
color or None
figure
Figure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'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
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
zorder
float
Draw the arc to the given renderer.
Ellipses are normally drawn using an approximation that uses eight cubic Bezier splines. The error of this approximation is 1.89818e-6, according to this unverified source:
Lancaster, Don. Approximating a Circle or an Ellipse Using Four Bezier Cubic Splines.
https://www.tinaja.com/glib/ellipse4.pdf
There is a use case where very large ellipses must be drawn with very high accuracy, and it is too expensive to render the entire ellipse with enough segments (either splines or line segments). Therefore, in the case where either radius of the ellipse is large enough that the error of the spline approximation will be visible (greater than one pixel offset from the ideal), a different technique is used.
In that case, only the visible parts of the ellipse are drawn, with each visible arc using a fixed number of spline segments (8). The algorithm proceeds as follows:
The points where the ellipse intersects the axes bounding box are located. (This is done be performing an inverse transformation on the axes bbox such that it is relative to the unit circle -- this makes the intersection calculation much easier than doing rotated ellipse intersection directly).
This uses the "line intersecting a circle" algorithm from:
Vince, John. Geometry for Computer Graphics: Formulae, Examples & Proofs. London: Springer-Verlag, 2005.
Set multiple properties at once.
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
alpha
scalar or None
angle
float
animated
bool
antialiased or aa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
center
(float, float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor or ec
color or None
facecolor or fc
color or None
figure
Figure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
height
float
in_layout
bool
joinstyle
JoinStyle or {'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
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
width
float
zorder
float
Scale invariant angle label
Ellipse With Units


Draw the arc to the given renderer.
Ellipses are normally drawn using an approximation that uses eight cubic Bezier splines. The error of this approximation is 1.89818e-6, according to this unverified source:
Lancaster, Don. Approximating a Circle or an Ellipse Using Four Bezier Cubic Splines.
https://www.tinaja.com/glib/ellipse4.pdf
There is a use case where very large ellipses must be drawn with very high accuracy, and it is too expensive to render the entire ellipse with enough segments (either splines or line segments). Therefore, in the case where either radius of the ellipse is large enough that the error of the spline approximation will be visible (greater than one pixel offset from the ideal), a different technique is used.
In that case, only the visible parts of the ellipse are drawn, with each visible arc using a fixed number of spline segments (8). The algorithm proceeds as follows:
The points where the ellipse intersects the axes bounding box are located. (This is done be performing an inverse transformation on the axes bbox such that it is relative to the unit circle -- this makes the intersection calculation much easier than doing rotated ellipse intersection directly).
This uses the "line intersecting a circle" algorithm from:
Vince, John. Geometry for Computer Graphics: Formulae, Examples & Proofs. London: Springer-Verlag, 2005.


Set multiple properties at once.
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
alpha
scalar or None
angle
float
animated
bool
antialiased or aa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
center
(float, float)
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor or ec
color or None
facecolor or fc
color or None
figure
Figure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
height
float
in_layout
bool
joinstyle
JoinStyle or {'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
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
width
float
zorder
float


Bases: matplotlib.patches.Patch
An arrow patch.
Draws an arrow from (x, y) to (x + dx, y + dy). The width of the arrow is scaled by width.
x coordinate of the arrow tail.
y coordinate of the arrow tail.
Arrow length in the x direction.
Arrow length in the y direction.
Scale factor for the width of the arrow. With a default value of 1, the tail width is 0.2 and head width is 0.6.
Keyword arguments control the Patch 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
alpha
unknown
animated
bool
antialiased or aa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor or ec
color or None
facecolor or fc
color or None
figure
Figure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'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
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
zorder
float
See also
Patch that allows independent control of the head and tail properties.
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.
Return the path of this patch.
Set multiple properties at once.
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
alpha
scalar or None
animated
bool
antialiased or aa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor or ec
color or None
facecolor or fc
color or None
figure
Figure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'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
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
zorder
float
Arrow guide
Reference for Matplotlib artists


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.


Set multiple properties at once.
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
alpha
scalar or None
animated
bool
antialiased or aa
bool or None
capstyle
CapStyle or {'butt', 'projecting', 'round'}
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
color
color
edgecolor or ec
color or None
facecolor or fc
color or None
figure
Figure
fill
bool
gid
str
hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout
bool
joinstyle
JoinStyle or {'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
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
transform
Transform
url
str
visible
bool
zorder
float


Bases: matplotlib.patches._Style
ArrowStyle is a container class which defines several arrowstyle classes, which is used to create an arrow path along a given path. These are mainly used with FancyArrowPatch.
A arrowstyle object can be either created as:
or:
or:
The following classes are defined
Class
Name
Attrs
Curve
-
None
CurveA
<-
head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveB
->
head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveAB
<->
head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveFilledA
<|-
head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveFilledB
-|>
head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveFilledAB
<|-|>
head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
BracketA
]-
widthA=1.0, lengthA=0.2, angleA=0
BracketB
-[
widthB=1.0, lengthB=0.2, angleB=0
BracketAB
]-[
widthA=1.0, lengthA=0.2, angleA=0, widthB=1.0, lengthB=0.2, angleB=0
BarAB
|-|
widthA=1.0, angleA=0, widthB=1.0, angleB=0
BracketCurve
]->
widthA=1.0, lengthA=0.2, angleA=None
CurveBracket
<-[
widthB=1.0, lengthB=0.2, angleB=None
Simple
simple
head_length=0.5, head_width=0.5, tail_width=0.2
Fancy
fancy
head_length=0.4, head_width=0.4, tail_width=0.4
Wedge
wedge
tail_width=0.3, shrink_factor=0.5
An instance of any arrow style class is a callable object, whose call signature is:
and it returns a tuple of a Path instance and a boolean value. path is a Path instance along which the arrow will be drawn. mutation_size and aspect_ratio have the same meaning as in BoxStyle. linewidth is a line width to be stroked. This is meant to be used to correct the location of the head so that it does not overshoot the destination point, but not all classes support it.
Return the instance of the subclass with the given style name.
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with vertical bars | at both ends.
Width of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with an outward square bracket at its start.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with outward square brackets at both ends.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with an outward square bracket at its end.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with an outward square bracket at its start and a head at the end.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Bases: matplotlib.patches.ArrowStyle._Curve
A simple curve without any arrow head.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with a head at its begin point.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with heads both at the begin and the end point.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with a head at its end point.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with an outward square bracket at its end and a head at the start.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with filled triangle head at the begin.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with filled triangle heads at both ends.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket
Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with filled triangle head at the end.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket
Bases: matplotlib.patches.ArrowStyle._Base
A fancy arrow. Only works with a quadratic Bezier curve.
Length of the arrow head.
Width of the arrow head.
Width of the arrow tail.
The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.
Bases: matplotlib.patches.ArrowStyle._Base
A simple arrow. Only works with a quadratic Bezier curve.
Length of the arrow head.
Width of the arrow head.
Width of the arrow tail.
The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.
Bases: matplotlib.patches.ArrowStyle._Base
Wedge(?) shape. Only works with a quadratic Bezier curve. The begin point has a width of the tail_width and the end point has a width of 0. At the middle, the width is shrink_factor*tail_width.
Width of the tail.
Fraction of the arrow width at the middle point.
The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with vertical bars | at both ends.
Width of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with an outward square bracket at its start.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with outward square brackets at both ends.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with an outward square bracket at its end.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with an outward square bracket at its start and a head at the end.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.


Bases: matplotlib.patches.ArrowStyle._Curve
A simple curve without any arrow head.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with a head at its begin point.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with heads both at the begin and the end point.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with a head at its end point.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with an outward square bracket at its end and a head at the start.
Width of the bracket.
Length of the bracket.
Orientation of the bracket, as a counterclockwise angle. 0 degrees means perpendicular to the line.


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with filled triangle head at the begin.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with filled triangle heads at both ends.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket


Bases: matplotlib.patches.ArrowStyle._Curve
An arrow with filled triangle head at the end.
Length of the arrow head, relative to mutation_scale.
Width of the arrow head, relative to mutation_scale.
Width of the bracket at the beginning of the arrow
Width of the bracket at the end of the arrow
Length of the bracket at the beginning of the arrow
Length of the bracket at the end of the arrow
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
Orientation of the bracket at the beginning, as a counterclockwise angle. 0 degrees means perpendicular to the line.
The mutation_size for the beginning bracket
The mutation_size for the end bracket


Bases: matplotlib.patches.ArrowStyle._Base
A fancy arrow. Only works with a quadratic Bezier curve.
Length of the arrow head.
Width of the arrow head.
Width of the arrow tail.
The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.


The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.


Bases: matplotlib.patches.ArrowStyle._Base
A simple arrow. Only works with a quadratic Bezier curve.
Length of the arrow head.
Width of the arrow head.
Width of the arrow tail.
The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.


Bases: matplotlib.patches.ArrowStyle._Base
Wedge(?) shape. Only works with a quadratic Bezier curve. The begin point has a width of the tail_width and the end point has a width of 0. At the middle, the width is shrink_factor*tail_width.
Width of the tail.
Fraction of the arrow width at the middle point.
The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.


A debug function to draw a rectangle around the bounding box returned by an artist's Artist.get_window_extent to test whether the artist is returning the correct bbox.
props is a dict of rectangle props with the additional property 'pad' that sets the padding around the bbox in points.