matplotlib.offsetbox

OffsetBox — это простой контейнерный элемент. Дочерние элементы должны отображаться в относительном положении к родительскому элементу. [VH]Packer, DrawingArea и TextArea являются производными от OffsetBox.

Packer автоматически настраивает относительные позиции своих дочерних элементов, которые должны быть экземплярами OffsetBox. Это используется для выравнивания похожих элементов, например, в легенде.

DrawingArea может содержать любой элемент Artist в качестве дочернего элемента. DrawingArea имеет фиксированную ширину и высоту. Позиция дочерних элементов относительно родительского элемента фиксирована. TextArea содержит один элемент Text. Ширина и высота TextArea — это ширина и высота его дочернего текста.

class 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]

Базовое класс: matplotlib.offsetbox.OffsetBox

Элемент OffsetBox, размещаемый в соответствии с расположением loc легенды. AnchoredOffsetbox имеет один дочерний элемент. Если необходимо несколько дочерних элементов, используйте другой класс OffsetBox для их объединения. По умолчанию элемент OffsetBox привязывается к оси родительского элемента. Вы можете явно указать bbox_to_anchor.

loc — строка или целое число, определяющее расположение легенды. Допустимые коды расположения:

'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,

pad : pad around the child for drawing a frame. given in

доля от размера шрифта.

borderpad: отступ между рамкой OffsetBox и bbox_to_anchor,

child: экземпляр OffsetBox, который будет привязан.

prop: свойства шрифта. Это используется только как ссылка для отступов.

frameon: рисовать рамку, если True.

bbox_to_anchor: область для привязки. Если None, используется self.axes.bbox.

bbox_transform: с помощью какой трансформации будет преобразована bbox_to_anchor.

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

отрисовать элемент

get_bbox_to_anchor(self) [source]

возвращает область, к которой будет привязана легенда

get_child(self) [source]

возвращает дочерний элемент

get_children(self) [source]

возвращает список дочерних элементов

get_extent(self, renderer) [source]

возвращает область элемента. Возвращается область дочернего элемента с добавленным отступом

get_window_extent(self, renderer) [source]

получить область в пространстве отображения.

set_bbox_to_anchor(self, bbox, transform=None) [source]

устанавливает область, к которой будет привязан дочерний элемент.

bbox может быть экземпляром Bbox, списком [левый, нижний, ширина, высота] или списком [левый, нижний], где ширина и высота предполагаются равными нулю. Область будет преобразована в координаты отображения с помощью заданной трансформации.

set_child(self, child) [source]

устанавливает дочерний элемент для привязки

update_frame(self, bbox, fontsize=None) [source]

zorder = 5

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

Базовое класс: matplotlib.offsetbox.AnchoredOffsetbox

AnchoredOffsetbox с текстом.

Параметры:	s : string Текст. loc : str Код расположения. pad : float, optional Отступ между текстом и рамкой как доля от размера шрифта. borderpad : float, optional Отступ между рамкой и осью (или bbox_to_anchor). prop : dictionary, optional, default: None Словарь ключевых параметров, которые будут переданы экземпляру Text внутри AnchoredText.

Примечания

Также разрешены другие ключевые параметры AnchoredOffsetbox.

class 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]

Основы: matplotlib.artist.Artist, matplotlib.text._AnnotationBase

Класс, похожий на аннотацию, но с использованием offsetbox вместо Text.

offsetbox : Экземпляр OffsetBox

xycoords : same as Annotation but can be a tuple of two

строки, интерпретируемые как координаты x и y.

boxcoords : similar to textcoords as Annotation but can be a

кортеж из двух строк, интерпретируемых как координаты x и y.

box_alignment : a tuple of two floats for a vertical and

горизонтальное выравнивание offset-бокcа по отношению к boxcoords. Левый нижний угол — (0.0), правый верхний — (1.1).

другие параметры идентичны параметрам класса Annotation.

anncoords

contains(self, event) [source]

Проверка, содержит ли объект-артист событие мыши.

Параметры:	mouseevent : matplotlib.backend_bases.MouseEvent
Возвращаемые значения:	contains : bool Принадлежность каких-либо значений радиусу. details : dict Словарь, специфичный для объекта-артиста, содержащий подробности контекста события, такие как точки, попадающие в радиус выбора. Подробности см. в соответствующих подклассах Artist.

См. также

set_contains, get_contains

draw(self, renderer) [source]

Отрисовка объекта Annotation в заданном renderer.

get_children(self) [source]

Возвращает список дочерних элементов Artist этого объекта Artist.

get_fontsize(self, s=None) [source]

Возвращает размер шрифта в пунктах.

set_figure(self, fig) [source]

Устанавливает экземпляр Figure, к которому принадлежит объект-артист.

Параметры:	fig : Figure

set_fontsize(self, s=None) [source]

Устанавливает размер шрифта в пунктах.

update_positions(self, renderer) [source]

Обновляет пиксельные позиции аннотированной точки и текста.

xyann

zorder = 3

class matplotlib.offsetbox.AuxTransformBox(aux_transform) [source]

Основы: matplotlib.offsetbox.OffsetBox

Offset-бокс с aux_transform. Его дочерние элементы сначала преобразуются с помощью aux_transform, а затем смещаются. Абсолютные координаты aux_transform учитываются, так как они автоматически корректируются, чтобы левый нижний угол ограничивающей рамки дочерних элементов был установлен в (0,0) перед преобразованием смещения.

Он похож на область рисования, за исключением того, что размеры области не предопределены, а вычисляются из размеров окна ее дочерних элементов. Кроме того, размеры дочерних элементов вычисляются в преобразованных координатах.

add_artist(self, a) [source]

Добавить любой объект Artist в контейнерный бокс.

draw(self, renderer) [source]

Отрисовать дочерние элементы.

get_extent(self, renderer) [source]

Возвращает ширину, высоту, xdescent и ydescent объекта.

get_offset(self) [source]

возвращает смещение контейнера.

get_transform(self) Transform применяемого к дочерним элементам.

get_window_extent(self, renderer) [source]

Получить ограничивающую рамку в пространстве отображения.

set_offset(self, xy) [source]

Устанавливает смещение контейнера.

Параметры:	xy : (float, float) Координаты смещения (x, y) в единицах отображения.

set_transform(self, t) [source]

set_transform игнорируется.

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

Основы: matplotlib.offsetbox.DraggableBase

save_offset(self) [source]

update_offset(self, dx, dy) [source]

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

Bases: object

Базовый класс для перетаскиваемого объекта (легенды, offsetbox).

Производные классы должны переопределить следующие методы:

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

Дополнительно, вы можете переопределить следующие методы:

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

В текущей реализации DraggableLegend и DraggableAnnotation, update_offset помещает объекты в координаты отображения, а finalize_offset пересчитывает их положение в координатах осей и устанавливает соответствующее атрибут.

artist_picker(self, artist, evt) [source]

disconnect(self) [source]

Отключить обработчики событий.

finalize_offset(self) [source]

on_motion(self, evt) [source]

on_motion_blit(self, evt) [source]

on_pick(self, evt) [source]

on_release(self, event) [source]

save_offset(self) [source]

update_offset(self, dx, dy) [source]

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

Bases: matplotlib.offsetbox.DraggableBase

get_loc_in_canvas(self) [source]

save_offset(self) [source]

update_offset(self, dx, dy) [source]

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

Bases: matplotlib.offsetbox.OffsetBox

DrawingArea может содержать любой объект Artist в качестве дочернего элемента. DrawingArea имеет фиксированную ширину и высоту. Положение дочерних элементов относительно родительского элемента фиксировано. Дочерние элементы могут быть обрезаны по границам родительского элемента.

width, height : ширина и высота контейнера. xdescent, ydescent : спуск контейнера по x и y. clip : обрезать ли дочерние элементы

add_artist(self, a) [source]

Добавить любой объект Artist в контейнер.

clip_children

Если дочерние элементы DrawingArea должны быть обрезаны рамкой DrawingArea.

draw(self, renderer) [source]

Отрисовать дочерние элементы.

get_extent(self, renderer) [source]

Возвращает ширину, высоту, xdescent, ydescent контейнера.

get_offset(self) [source]

Возвращает смещение контейнера.

get_transform(self) [source]

Возвращает преобразование, применяемое к дочерним элементам.

get_window_extent(self, renderer) [source]

Получить рамку ограничивающего прямоугольника в пространстве отображения.

set_offset(self, xy) [source]

Установить смещение контейнера.

Параметры:	xy : (float, float) Координаты смещения (x,y) в единицах отображения.

set_transform(self, t) [source]

set_transform игнорируется.

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

Bases: matplotlib.offsetbox.PackerBase

HPacker размещает дочерние элементы в ряд. Автоматически корректирует положение дочерних элементов при отрисовке.

Параметры:	pad : float, optional Отступ границы. sep : float, optional Интервал между элементами. width : float, optional height : float, optional Ширина и высота контейнера, вычисляются, если None. align : str Выравнивание элементов. mode : str Режим размещения.

Примечания

pad и sep должны быть заданы в пунктах и масштабируются с разрешением рендеринга, в то время как width и height должны быть в пикселях.

get_extent_offsets(self, renderer) [source]

Обновить смещение дочерних элементов и вернуть размеры контейнера.

class matplotlib.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.

axes

The Axes instance the artist resides in, or None.

contains(self, mouseevent) [source]

Test whether the artist contains the mouse event.

Parameters:	mouseevent : matplotlib.backend_bases.MouseEvent
Returns:	contains : bool Whether any values are within the radius. details : dict 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

set_contains, get_contains

draw(self, renderer) [source]

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

get_children(self) [source]

Return a list of artists it contains.

get_extent(self, renderer) [source]

Return with, height, xdescent, ydescent of box

get_extent_offsets(self, renderer) [source]

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

Get the offset

accepts extent of the box

get_visible_children(self) [source]

Return a list of visible artists it contains.

get_window_extent(self, renderer) [source]

get the bounding box in display space.

set_figure(self, fig) [source]

Set the figure

accepts a class:Figure instance

set_height(self, height) [source]

Set the height

accepts float

set_offset(self, xy) [source]

Set the offset.

Parameters:	xy : (float, float) or callable The (x,y) coordinates of the offset in display units. A callable must have the signature: def offset(width, height, xdescent, ydescent, renderer) -> (float, float)

set_width(self, width) [source]

Set the width

accepts float

class 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]

Bases: matplotlib.offsetbox.OffsetBox

draw(self, renderer) [source]

Draw the children

get_children(self) [source]

Return a list of artists it contains.

get_data(self) [source]

get_extent(self, renderer) [source]

Return with, height, xdescent, ydescent of box

get_offset(self) [source]

return offset of the container.

get_window_extent(self, renderer) [source]

get the bounding box in display space.

get_zoom(self) [source]

set_data(self, arr) [source]

set_zoom(self, zoom) [source]

class matplotlib.offsetbox.PackerBase(pad=None, sep=None, width=None, height=None, align=None, mode=None, children=None) [source]

Bases: matplotlib.offsetbox.OffsetBox

Parameters:	pad : float, optional Поля отступа. sep : float, optional Интервал между элементами. width : float, optional height : float, optional Ширина и высота контейнерного блока, вычисляются, если None. align : str, optional Выравнивание блоков. Может быть одним из top, bottom, left, right, center и baseline mode : str, optional Режим упаковки.

Notes

pad и sep должны быть заданы в пунктах и будут масштабироваться с разрешением рендерера, в то время как width и height должны быть в пикселях.

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

Основы: matplotlib.offsetbox.OffsetBox

pad : отступ границы

Примечание

pad необходимо указывать в пунктах и будет масштабироваться с разрешением рендерера, в то время как width и height должны быть в пикселях.

draw(self, renderer) [source]

Обновить положение дочерних элементов при необходимости и нарисовать их на заданном рендерере.

draw_frame(self, renderer) [source]

get_extent_offsets(self, renderer) [source]

обновить смещения дочерних элементов и вернуть размеры области

update_frame(self, bbox, fontsize=None) [source]

class matplotlib.offsetbox.TextArea(s, textprops=None, multilinebaseline=None, minimumdescent=True) [source]

Основы: matplotlib.offsetbox.OffsetBox

TextArea содержит один объект Text. Текст размещается в (0,0) с выравниванием по основанию и левому краю. Ширина и высота TextArea — это ширина и высота содержащегося в нём текста.

Параметры:

s : str строка для отображения. textprops : dictionary, optional, default: None Словарь ключевых параметров, которые будут переданы объекту Text, содержащемуся внутри TextArea. multilinebaseline : bool, optional Если True, основание многострочного текста корректируется таким образом, чтобы оно (приблизительно) центрировалось с однострочным текстом. minimumdescent : bool, optional Если True, в поле есть минимальный спуск «p».

draw(self, renderer) [source]

Отрисовать дочерние элементы

get_extent(self, renderer) [source]

Возвратить ширину, высоту, xdescent, ydescent области

get_minimumdescent(self) [source]

получить minimumdescent.

get_multilinebaseline(self) [source]

получить multilinebaseline.

get_offset(self) [source]

возвратить смещение контейнера.

get_text(self) [source]

Возвращает строковое представление текста этой области.

get_window_extent(self, renderer) [source]

получить область отображения в пространстве.

set_minimumdescent(self, t) [source]

Установить minimumdescent.

Если True, размеры области однострочного текста корректируются таким образом, чтобы она имела минимальный спуск «p».

set_multilinebaseline(self, t) [source]

Установить multilinebaseline.

Если True, основание многострочного текста корректируется таким образом, чтобы оно (приблизительно) центрировалось с однострочным текстом.

set_offset(self, xy) [source]

Установить смещение контейнера.

Параметры:	xy : (float, float) Координаты смещения (x, y) в единицах отображения.

set_text(self, s) [source]

Установить текст этой области в виде строки.

set_transform(self, t) [source]

set_transform игнорируется.

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

Основы: matplotlib.offsetbox.PackerBase

VPacker располагает свои дочерние элементы вертикально. Он автоматически корректирует относительные позиции дочерних элементов во время отрисовки.

Параметры:	pad : float, optional Отступ границы. sep : float, optional Интервал между элементами. width : float, optional height : float, optional Ширина и высота контейнерной области, вычисляются, если None. align : str, optional Выравнивание областей. mode : str, optional Режим упаковки.

Примечания

pad и sep необходимо указывать в пунктах и будут масштабироваться с разрешением рендерера, в то время как width и height должны быть в пикселях.

get_extent_offsets(self, renderer) [source]

обновить смещения дочерних элементов и вернуть размеры области

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