matplotlib.offsetbox

Container classes for Artists.

OffsetBox

The base of all container artists defined in this module.

AnchoredOffsetbox, AnchoredText

Anchor and align an arbitrary Artist or a text relative to the parent axes or a specific anchor point.

DrawingArea

A container with fixed width and height. Children have a fixed position inside the container and may be clipped.

HPacker, VPacker

Containers for layouting their children vertically or horizontally.

PaddedBox

A container to add a padding around an Artist.

TextArea

Contains a single Text instance.

classmatplotlib.offsetbox.AnchoredOffsetbox(loc, pad=0.4, borderpad=0.5, child=None, prop=None, frameon=True, bbox_to_anchor=None, bbox_transform=None, **kwargs)[source]

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.

Parameters

locstr

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.

padfloat, default: 0.4

Padding around the child as fraction of the fontsize.

borderpadfloat, default: 0.5

Padding between the offsetbox frame and the bbox_to_anchor.

childOffsetBox

The box that will be anchored.

propFontProperties

This is only used as a reference for paddings. If not given, rcParams["legend.fontsize"] (default: 'medium') is used.

frameonbool

Whether to draw a frame around the box.

bbox_to_anchorBboxBase, 2-tuple, or 4-tuple of floats

Box that is used to position the legend in conjunction with loc.

bbox_transformNone or matplotlib.transforms.Transform

The transform for the bounding box (bbox_to_anchor).

**kwargs

All other parameters are passed on to OffsetBox.

Notes

See Legend for a detailed description of the anchoring mechanism.

codes={'center': 10, 'center left': 6, 'center right': 7, 'lower center': 8, 'lower left': 3, 'lower right': 4, 'right': 5, 'upper center': 9, 'upper left': 2, 'upper right': 1}

draw(renderer)[source]

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

get_bbox_to_anchor()[source]

Return the bbox that the box is anchored to.

get_child()[source]

Return the child.

get_children()[source]

Return the list of children.

get_extent(renderer)[source]

Return the extent of the box as (width, height, x, y).

This is the extent of the child plus the padding.

get_window_extent(renderer)[source]

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(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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_bbox_to_anchor(bbox, transform=None)[source]

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_child(child)[source]

Set the child to be anchored.

update_frame(bbox, fontsize=None)[source]

zorder=5

classmatplotlib.offsetbox.AnchoredText(s, loc, pad=0.4, borderpad=0.5, prop=None, **kwargs)[source]

Bases: matplotlib.offsetbox.AnchoredOffsetbox

AnchoredOffsetbox with Text.

Parameters

sstr

Text.

locstr

Location code. See AnchoredOffsetbox.

padfloat, default: 0.4

Padding around the text as fraction of the fontsize.

borderpadfloat, default: 0.5

Spacing between the offsetbox frame and the bbox_to_anchor.

propdict, optional

Dictionary of keyword parameters to be passed to the Text instance contained inside AnchoredText.

**kwargs

All other parameters are passed to AnchoredOffsetbox.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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

classmatplotlib.offsetbox.AnnotationBbox(offsetbox, xy, xybox=None, xycoords='data', boxcoords=None, frameon=True, pad=0.4, annotation_clip=None, box_alignment=(0.5, 0.5), bboxprops=None, arrowprops=None, fontsize=None, **kwargs)[source]

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.

Parameters

offsetboxOffsetBox

xy(float, float)

The point (x, y) to annotate. The coordinate system is determined by xycoords.

xybox(float, float), default: xy

The position (x, y) to place the text at. The coordinate system is determined by boxcoords.

xycoordsstr or Artist or Transform or callable or (float, float), default: 'data'

The coordinate system that xy is given in. See the parameter xycoords in Annotation for a detailed description.

boxcoordsstr or Artist or Transform or callable or (float, float), default: value of xycoords

The coordinate system that xybox is given in. See the parameter textcoords in Annotation for a detailed description.

frameonbool, default: True

Whether to draw a frame around the box.

padfloat, default: 0.4

Padding around the offsetbox.

box_alignment(float, float)

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).

**kwargs

Other parameters are identical to Annotation.

propertyanncoords

contains(mouseevent)[source]

Test whether the artist contains the mouse event.

Parameters

mouseeventmatplotlib.backend_bases.MouseEvent

Returns

containsbool

Whether any values are within the radius.

detailsdict

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(renderer)[source]

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).

Parameters

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_children()[source]

Return a list of the child Artists of this Artist.

get_fontsize()[source]

Return the fontsize in points.

get_tightbbox(renderer)[source]

Like Artist.get_window_extent, but includes any clipping.

Parameters

rendererRendererBase subclass

renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())

Returns

Bbox

The enclosing bounding box (in figure pixel coordinates).

get_window_extent(renderer)[source]

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(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, annotation_clip=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, fontsize=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

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_figure(fig)[source]

Set the Figure instance the artist belongs to.

Parameters

figFigure

set_fontsize(s=None)[source]

Set the fontsize in points.

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

update_positions(renderer)[source]

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

propertyxyann

zorder=3

classmatplotlib.offsetbox.AuxTransformBox(aux_transform)[source]

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_artist(a)[source]

Add an Artist to the container box.

draw(renderer)[source]

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

get_extent(renderer)[source]

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

get_offset()[source]

Return offset of the container.

get_transform()[source]

Return the Transform applied to the children

get_window_extent(renderer)[source]

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(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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_offset(xy)[source]

Set the offset of the container.

Parameters

xy(float, float)

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

set_transform(t)[source]

set_transform is ignored.

classmatplotlib.offsetbox.DraggableAnnotation(annotation, use_blit=False)[source]

Bases: matplotlib.offsetbox.DraggableBase

save_offset()[source]

update_offset(dx, dy)[source]

classmatplotlib.offsetbox.DraggableBase(ref_artist, use_blit=False)[source]

Bases: object

Helper base class for a draggable artist (legend, offsetbox).

Derived classes must override the following methods:

def save_offset(self):
    '''
    Called when the object is picked for dragging; should save the
    reference position of the artist.
    '''

def update_offset(self, dx, dy):
    '''
    Called during the dragging; (*dx*, *dy*) is the pixel offset from
    the point where the mouse drag started.
    '''

Optionally, you may override the following method:

def finalize_offset(self):
    '''Called when the mouse is released.'''

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()[source]

Disconnect the callbacks.

finalize_offset()[source]

on_motion(evt)[source]

on_pick(evt)[source]

on_release(event)[source]

save_offset()[source]

update_offset(dx, dy)[source]

classmatplotlib.offsetbox.DraggableOffsetBox(ref_artist, offsetbox, use_blit=False)[source]

Bases: matplotlib.offsetbox.DraggableBase

get_loc_in_canvas()[source]

save_offset()[source]

update_offset(dx, dy)[source]

classmatplotlib.offsetbox.DrawingArea(width, height, xdescent=0.0, ydescent=0.0, clip=False)[source]

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.

Parameters

width, heightfloat

Width and height of the container box.

xdescent, ydescentfloat

Descent of the box in x- and y-direction.

clipbool

Whether to clip the children to the box.

add_artist(a)[source]

Add an Artist to the container box.

propertyclip_children

If the children of this DrawingArea should be clipped by DrawingArea bounding box.

draw(renderer)[source]

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

get_extent(renderer)[source]

Return width, height, xdescent, ydescent of box.

get_offset()[source]

Return offset of the container.

get_transform()[source]

Return the Transform applied to the children.

get_window_extent(renderer)[source]

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(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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_offset(xy)[source]

Set the offset of the container.

Parameters

xy(float, float)

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

set_transform(t)[source]

set_transform is ignored.

classmatplotlib.offsetbox.HPacker(pad=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)[source]

Bases: matplotlib.offsetbox.PackerBase

HPacker packs its children horizontally, automatically adjusting their relative positions at draw time.

Parameters

padfloat, optional

The boundary padding in points.

sepfloat, optional

The spacing between items in points.

width, heightfloat, optional

Width and height of the container box in pixels, calculated if None.

align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, default: 'baseline'

Alignment of boxes.

mode{'fixed', 'expand', 'equal'}, default: 'fixed'

The packing mode.

• 'fixed' packs the given Artists tight with sep spacing.
• 'expand' uses the maximal available space to distribute the artists with equal spacing in between.
• 'equal': Each artist an equal fraction of the available space and is left-aligned (or top-aligned) therein.

childrenlist of Artist

The artists to pack.

Notes

pad and sep are in points and will be scaled with the renderer dpi, while width and height are in pixels.

get_extent_offsets(renderer)[source]

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

Parameters

rendererRendererBase subclass

Returns

width

height

xdescent

ydescent

list of (xoffset, yoffset) pairs

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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

classmatplotlib.offsetbox.OffsetBox(*args, **kwargs)[source]

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.

propertyaxes

The Axes instance the artist resides in, or None.

contains(mouseevent)[source]

Delegate the mouse event contains-check to the children.

As a container, the OffsetBox does not respond itself to mouseevents.

Parameters

mouseeventmatplotlib.backend_bases.MouseEvent

Returns

containsbool

Whether any values are within the radius.

detailsdict

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

Artist.contains

draw(renderer)[source]

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

get_children()[source]

Return a list of the child Artists.

get_extent(renderer)[source]

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

get_extent_offsets(renderer)[source]

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

Parameters

rendererRendererBase subclass

Returns

width

height

xdescent

ydescent

list of (xoffset, yoffset) pairs

get_offset(width, height, xdescent, ydescent, renderer)[source]

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).

Parameters

width, height, xdescent, ydescent

Extent parameters.

rendererRendererBase subclass

get_visible_children()[source]

Return a list of the visible child Artists.

get_window_extent(renderer)[source]

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(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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_figure(fig)[source]

Set the Figure for the OffsetBox and all its children.

Parameters

figFigure

set_height(height)[source]

Set the height of the box.

Parameters

heightfloat

set_offset(xy)[source]

Set the offset.

Parameters

xy(float, float) or callable

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:

def offset(width, height, xdescent, ydescent, renderer) -> (float, float)

set_width(width)[source]

Set the width of the box.

Parameters

widthfloat

classmatplotlib.offsetbox.OffsetImage(arr, zoom=1, cmap=None, norm=None, interpolation=None, origin=None, filternorm=True, filterrad=4.0, resample=False, dpi_cor=True, **kwargs)[source]

Bases: matplotlib.offsetbox.OffsetBox

draw(renderer)[source]

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

get_children()[source]

Return a list of the child Artists.

get_data()[source]

get_extent(renderer)[source]

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

get_offset()[source]

Return offset of the container.

get_window_extent(renderer)[source]

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.

get_zoom()[source]

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, data=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zoom=<UNSET>, zorder=<UNSET>)[source]

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

set_data(arr)[source]

set_zoom(zoom)[source]

classmatplotlib.offsetbox.PackerBase(pad=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)[source]

Bases: matplotlib.offsetbox.OffsetBox

Parameters

padfloat, optional

The boundary padding in points.

sepfloat, optional

The spacing between items in points.

width, heightfloat, optional

Width and height of the container box in pixels, calculated if None.

align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, default: 'baseline'

Alignment of boxes.

mode{'fixed', 'expand', 'equal'}, default: 'fixed'

The packing mode.

• 'fixed' packs the given Artists tight with sep spacing.
• 'expand' uses the maximal available space to distribute the artists with equal spacing in between.
• 'equal': Each artist an equal fraction of the available space and is left-aligned (or top-aligned) therein.

childrenlist of Artist

The artists to pack.

Notes

pad and sep are in points and will be scaled with the renderer dpi, while width and height are in pixels.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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

classmatplotlib.offsetbox.PaddedBox(child, pad=None, draw_frame=False, patch_attrs=None)[source]

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.

Parameters

childArtist

The contained Artist.

padfloat

The padding in points. This will be scaled with the renderer dpi. In contrast width and height are in pixels and thus not scaled.

draw_framebool

Whether to draw the contained FancyBboxPatch.

patch_attrsdict or None

Additional parameters passed to the contained FancyBboxPatch.

draw(renderer)[source]

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

draw_frame(renderer)[source]

get_extent_offsets(renderer)[source]

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

Parameters

rendererRendererBase subclass

Returns

width

height

xdescent

ydescent

list of (xoffset, yoffset) pairs

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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_frame(bbox, fontsize=None)[source]

classmatplotlib.offsetbox.TextArea(s, textprops=None, multilinebaseline=False, minimumdescent=<deprecated parameter>)[source]

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.

Parameters

sstr

The text to be displayed.

textpropsdict, default: {}

Dictionary of keyword parameters to be passed to the Text instance in the TextArea.

multilinebaselinebool, default: False

Whether the baseline for multiline text is adjusted so that it is (approximately) center-aligned with single-line text.

minimumdescentbool, default: True

If True, the box has a minimum descent of "p". This is now effectively always True.

draw(renderer)[source]

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

get_extent(renderer)[source]

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

get_minimumdescent()[source]

[Deprecated] Get minimumdescent.

Notes

Deprecated since version 3.4.

get_multilinebaseline()[source]

Get multilinebaseline.

get_offset()[source]

Return offset of the container.

get_text()[source]

Return the string representation of this area's text.

get_window_extent(renderer)[source]

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(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, minimumdescent=<UNSET>, multilinebaseline=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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

set_minimumdescent(t)[source]

[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".

Notes

Deprecated since version 3.4.

set_multilinebaseline(t)[source]

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_offset(xy)[source]

Set the offset of the container.

Parameters

xy(float, float)

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

set_text(s)[source]

Set the text of this area as a string.

set_transform(t)[source]

set_transform is ignored.

classmatplotlib.offsetbox.VPacker(pad=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)[source]

Bases: matplotlib.offsetbox.PackerBase

VPacker packs its children vertically, automatically adjusting their relative positions at draw time.

Parameters

padfloat, optional

The boundary padding in points.

sepfloat, optional

The spacing between items in points.

width, heightfloat, optional

Width and height of the container box in pixels, calculated if None.

align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, default: 'baseline'

Alignment of boxes.

mode{'fixed', 'expand', 'equal'}, default: 'fixed'

The packing mode.

• 'fixed' packs the given Artists tight with sep spacing.
• 'expand' uses the maximal available space to distribute the artists with equal spacing in between.
• 'equal': Each artist an equal fraction of the available space and is left-aligned (or top-aligned) therein.

childrenlist of Artist

The artists to pack.

Notes

pad and sep are in points and will be scaled with the renderer dpi, while width and height are in pixels.

get_extent_offsets(renderer)[source]

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

Parameters

rendererRendererBase subclass

Returns

width

height

xdescent

ydescent

list of (xoffset, yoffset) pairs

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

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

matplotlib.offsetbox.bbox_artist(*args, **kwargs)[source]