offsetbox

matplotlib.offsetbox

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

[VH]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)

Основывается на matplotlib.offsetbox.OffsetBox

Ящик со смещением, размещённый в соответствии с расположением легенды loc. AnchoredOffsetbox имеет один дочерний элемент. При необходимости нескольких дочерних элементов используйте другие классы 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 = {'upper right': 1, 'upper left': 2, 'lower left': 3, 'lower right': 4, 'right': 5, 'center left': 6, 'center right': 7, 'lower center': 8, 'upper center': 9, 'center': 10}

draw(renderer)

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

get_bbox_to_anchor()

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

get_child()

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

get_children()

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

get_extent(renderer)

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

get_window_extent(renderer)

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

set_bbox_to_anchor(bbox, transform=None)

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

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

set_child(child)

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

update_frame(bbox, fontsize=None)

zorder = 5

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

Основывается на matplotlib.offsetbox.AnchoredOffsetbox

AnchoredOffsetbox с текстом.

Параметры:	s : строка Текст. loc : строка Код расположения. pad : число с плавающей точкой, необязательно Отступ между текстом и рамкой в долях размера шрифта. borderpad : число с плавающей точкой, необязательно Отступ между рамкой и осями (или bbox_to_anchor). prop : matplotlib.font_manager.FontProperties Свойства шрифта.

Примечания

Также разрешены другие ключевые параметры 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)

Основывается на matplotlib.artist.Artist, matplotlib.text._AnnotationBase

Класс, похожий на Annotation, но с offsetbox вместо текста.

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

горизонтальное выравнивание ящика со смещением относительно boxcoords. Левый нижний угол — (0.0), правый верхний — (1.1).

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

anncoords

contains(event)

draw(renderer)

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

get_children()

get_fontsize(s=None)

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

set_figure(fig)

set_fontsize(s=None)

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

update_positions(renderer)

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

xyann

zorder = 3

class matplotlib.offsetbox.AuxTransformBox(aux_transform)

Основывается на matplotlib.offsetbox.OffsetBox

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

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

add_artist(a)

Добавить любой Artist в контейнерный ящик

draw(renderer)

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

get_extent(renderer)

get_offset()

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

get_transform()

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

get_window_extent(renderer)

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

set_offset(xy)

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

Принимает: кортеж координат x, y в единицах отображения.

set_transform(t)

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

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

Основывается на matplotlib.offsetbox.DraggableBase

save_offset()

update_offset(dx, dy)

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

Базы: object

Вспомогательный код для перетаскиваемого элемента (легенды, offsetbox). Производный класс должен переопределить следующие два метода.

def saveoffset(self):

pass

def update_offset(self, dx, dy):

pass

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

update_offset вызывается во время перетаскивания. dx и dy — это пиксельный

смещение от точки, с которой началось перетаскивание мыши.

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

def artist_picker(self, artist, evt):

return self.ref_artist.contains(evt)

def finalize_offset(self):

pass

artist_picker — это метод выбора, который будет

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

artist_picker(artist, evt)

disconnect()

отключить обратные вызовы

finalize_offset()

on_motion(evt)

on_motion_blit(evt)

on_pick(evt)

on_release(event)

save_offset()

update_offset(dx, dy)

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

Базы: matplotlib.offsetbox.DraggableBase

get_loc_in_canvas()

save_offset()

update_offset(dx, dy)

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

Базы: matplotlib.offsetbox.OffsetBox

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

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

add_artist(a)

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

clip_children

Если дочерние элементы DrawingArea должны быть обрезаны ограничивающим прямоугольником DrawingArea.

draw(renderer)

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

get_extent(renderer)

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

get_offset()

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

get_transform()

Возвращает Transform, применённый к дочерним элементам

get_window_extent(renderer)

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

set_offset(xy)

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

Принимает: кортеж координат x, y в единицах отображения.

set_transform(t)

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

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

Базы: matplotlib.offsetbox.PackerBase

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

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

Примечания

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

get_extent_offsets(renderer)

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

class matplotlib.offsetbox.OffsetBox(*args, **kwargs)

Базы: matplotlib.artist.Artist

OffsetBox — это простой контейнерный элемент. Дочерние элементы предназначены для отрисовки в относительном положении к родителю.

axes

Объект Axes, в котором находится элемент, или None.

contains(mouseevent)

draw(renderer)

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

get_children()

Возвращает список элементов, которые он содержит.

get_extent(renderer)

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

get_extent_offsets(renderer)

get_offset(width, height, xdescent, ydescent, renderer)

Получить смещение.

Принимает размеры блока.

get_visible_children()

Возвращает список видимых элементов, которые он содержит.

get_window_extent(renderer)

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

set_figure(fig)

Установить фигуру.

Принимает объект класса:Figure.

set_height(height)

Установить высоту.

Принимает число с плавающей точкой.

set_offset(xy)

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

Принимает x, y, кортеж или вызываемый объект.

set_width(width)

Установить ширину.

Принимает число с плавающей точкой.

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)

Базы: matplotlib.offsetbox.OffsetBox

draw(renderer)

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

get_children()

get_data()

get_extent(renderer)

get_offset()

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

get_window_extent(renderer)

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

get_zoom()

set_data(arr)

set_zoom(zoom)

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

Bases: matplotlib.offsetbox.OffsetBox

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

Примечания

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

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

Bases: matplotlib.offsetbox.OffsetBox

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

Примечание

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

draw(renderer)

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

draw_frame(renderer)

get_extent_offsets(renderer)

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

update_frame(bbox, fontsize=None)

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

Bases: matplotlib.offsetbox.OffsetBox

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

Параметры:	s : str строка для отображения. textprops : FontProperties, необязательно multilinebaseline : bool, необязательно Если True, выравнивание по основанию многострочного текста корректируется так, чтобы оно (приблизительно) совпадало с выравниванием по основанию однострочного текста. minimumdescent : bool, необязательно Если True, у поля есть минимальный спуск “p”.

draw(renderer)

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

get_extent(renderer)

get_minimumdescent()

Возвращает минимальный спуск.

get_multilinebaseline()

Возвращает многострочное выравнивание по основанию.

get_offset()

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

get_text()

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

get_window_extent(renderer)

Возвращает область в пространстве отображения.

set_minimumdescent(t)

Устанавливает минимальный спуск.

Если True, область однострочного текста корректируется так, чтобы у неё был минимальный спуск “p”.

set_multilinebaseline(t)

Устанавливает многострочное выравнивание по основанию.

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

set_offset(xy)

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

Принимает: кортеж координат x, y в единицах отображения.

set_text(s)

Устанавливает текст этого поля как строку.

set_transform(t)

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

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

Bases: matplotlib.offsetbox.PackerBase

VPacker компонует дочерние элементы вертикально. Автоматически корректирует относительное положение элементов во время отрисовки.

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

Примечания

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

get_extent_offsets(renderer)

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

matplotlib.offsetbox.bbox_artist(*args, **kwargs)