matplotlib.offsetbox
¶The OffsetBox is a simple container artist. The child artist are meant to be drawn at a relative position to its parent. The [VH]Packer, DrawingArea and TextArea are derived from the OffsetBox.
The [VH]Packer automatically adjust the relative positions of their children, which should be instances of the OffsetBox. This is used to align similar artists together, e.g., in legend.
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 TextArea is contains a single Text instance. The width and height of the TextArea instance is the width and height of the its child text.
matplotlib.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 the legend location loc. AnchoredOffsetbox has a single child. When multiple children is needed, use other OffsetBox class to enclose them. By default, the offset box is anchored against its parent axes. You may explicitly specify the bbox_to_anchor.
loc is a string or an integer specifying the legend location. The valid location codes are:
'upper right' : 1,
'upper left' : 2,
'lower left' : 3,
'lower right' : 4,
'right' : 5, (same as 'center right', for back-compatibility)
'center left' : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center' : 10,
borderpad : pad between offsetbox frame and the bbox_to_anchor,
child : OffsetBox instance that will be anchored.
prop : font property. This is only used as a reference for paddings.
frameon : draw a frame box if True.
bbox_to_anchor : bbox to anchor. Use self.axes.bbox if None.
bbox_transform : with which the bbox_to_anchor will be transformed.
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}¶get_extent
(self, renderer)[source]¶return the extent of the artist. The extent of the child added with the pad is returned
set_bbox_to_anchor
(self, bbox, transform=None)[source]¶set the bbox that the child will be anchored.
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.
zorder
= 5¶matplotlib.offsetbox.
AnchoredText
(s, loc, pad=0.4, borderpad=0.5, prop=None, **kwargs)[source]¶Bases: matplotlib.offsetbox.AnchoredOffsetbox
AnchoredOffsetbox with Text.
Parameters: |
|
---|
Notes
Other keyword parameters of AnchoredOffsetbox
are also
allowed.
matplotlib.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
Annotation-like class, but with offsetbox instead of Text.
offsetbox : OffsetBox instance
other parameters are identical to that of Annotation.
anncoords
¶contains
(self, event)[source]¶Test whether the artist contains the mouse event.
Parameters: |
|
---|---|
Returns: |
|
See also
set_contains
, get_contains
set_figure
(self, fig)[source]¶Set the Figure
instance the artist belongs to.
Parameters: |
|
---|
update_positions
(self, renderer)[source]¶Update the pixel positions of the annotated point and the text.
xyann
¶zorder
= 3¶matplotlib.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 offseted. 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.
matplotlib.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 methods:
def artist_picker(self, artist, evt):
'''The picker method that will be used.'''
return self.ref_artist.contains(evt)
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.
matplotlib.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.
width, height : width and height of the container box. xdescent, ydescent : descent of the box in x- and y-direction. clip : Whether to clip the children
clip_children
¶If the children of this DrawingArea should be clipped by DrawingArea bounding box.
matplotlib.offsetbox.
HPacker
(pad=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)[source]¶Bases: matplotlib.offsetbox.PackerBase
The HPacker has its children packed horizontally. It automatically adjusts the relative positions of children at draw time.
Parameters: |
|
---|
Notes
pad and sep need to given in points and will be scale with the renderer dpi, while width and height need to be in pixels.
get_extent_offsets
(self, renderer)[source]¶Update offset of the children and return the extent of the box.
Parameters: |
|
---|---|
Returns: |
|
matplotlib.offsetbox.
OffsetBox
(*args, **kwargs)[source]¶Bases: matplotlib.artist.Artist
The OffsetBox is a simple container artist. The child artist are meant to be drawn at a relative position to its parent.
contains
(self, mouseevent)[source]¶Delegate the mouse event contains-check to the children.
As a container, the OffsetBox
does not respond itself to
mouseevents.
Parameters: |
|
---|---|
Returns: |
|
See also
draw
(self, renderer)[source]¶Update the location of children if necessary and draw them to the given renderer.
get_extent_offsets
(self, renderer)[source]¶Update offset of the children and return the extent of the box.
Parameters: |
|
---|---|
Returns: |
|
get_offset
(self, 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: |
|
---|
set_figure
(self, fig)[source]¶Set the Figure
for the OffsetBox
and all its children.
Parameters: |
|
---|
set_offset
(self, xy)[source]¶Set the offset.
Parameters: |
|
---|
matplotlib.offsetbox.
OffsetImage
(arr, zoom=1, cmap=None, norm=None, interpolation=None, origin=None, filternorm=1, filterrad=4.0, resample=False, dpi_cor=True, **kwargs)[source]¶matplotlib.offsetbox.
PackerBase
(pad=None, sep=None, width=None, height=None, align=None, mode=None, children=None)[source]¶Bases: matplotlib.offsetbox.OffsetBox
Parameters: |
|
---|
Notes
pad and sep need to given in points and will be scale with the renderer dpi, while width and height need to be in pixels.
matplotlib.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: |
|
---|
draw
(self, renderer)[source]¶Update the location of children if necessary and draw them to the given renderer.
get_extent_offsets
(self, renderer)[source]¶Update offset of the children and return the extent of the box.
Parameters: |
|
---|---|
Returns: |
|
matplotlib.offsetbox.
TextArea
(s, textprops=None, multilinebaseline=None, minimumdescent=True)[source]¶Bases: matplotlib.offsetbox.OffsetBox
The TextArea is contains a single Text instance. The text is placed at (0,0) with baseline+left alignment. The width and height of the TextArea instance is the width and height of the its child text.
Parameters: |
|
---|
set_minimumdescent
(self, t)[source]¶Set minimumdescent .
If True, extent of the single line text is adjusted so that it has minimum descent of "p"
set_multilinebaseline
(self, t)[source]¶Set multilinebaseline .
If True, baseline for multiline text is adjusted so that it is (approximately) center-aligned with single-line text.
matplotlib.offsetbox.
VPacker
(pad=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)[source]¶Bases: matplotlib.offsetbox.PackerBase
The VPacker has its children packed vertically. It automatically adjust the relative positions of children in the drawing time.
Parameters: |
|
---|
Notes
pad and sep need to given in points and will be scale with the renderer dpi, while width and height need to be in pixels.
get_extent_offsets
(self, renderer)[source]¶Update offset of the children and return the extent of the box.
Parameters: |
|
---|---|
Returns: |
|