offsetbox

matplotlib.offsetbox

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

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

DrawingArea может содержать любого художника в качестве дочернего элемента. 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 для их объединения. По умолчанию offset box привязан к родительским осям. Вы можете явно указать 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: прямоугольник для привязки. Используйте self.axes.bbox, если None.

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(renderer) [source]: рисование художника

get_bbox_to_anchor() [source]: возвращает прямоугольник, к которому будет привязана легенда

get_child() [source]: возвращает дочерний элемент

get_children() [source]: возвращает список дочерних элементов

get_extent(renderer) [source]: возвращает область художника. Возвращается область дочернего элемента вместе с отступом

get_window_extent(renderer) [source]: получение прямоугольника в пространстве отображения.

set_bbox_to_anchor(bbox, transform=None) [source]

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

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

set_child(child) [source]: установка дочернего элемента, который будет привязан

update_frame(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 с Text.

Параметры:	`s : string` Текст. `loc : str` Код расположения. `pad : float, optional` Отступ между текстом и рамкой как доля от размера шрифта. `borderpad : float, optional` Отступ между рамкой и осями (или 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) [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 box относительно boxcoords. Нижний левый угол — (0.0), верхний правый — (1.1).

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

anncoords

contains(event) [source]

Проверка, содержит ли художник событие мыши.

Возвращает булевое значение и словарь данных, специфичных для художника, о выделении, такие как точки, содержащиеся в радиусе выбора. См. индивидуальных художников для получения подробной информации.

draw(renderer) [source]: Рисует объект Annotation в заданном рендере.

get_children() [source]: Возвращает список дочерних элементов, которые содержит Artist`s this :class:`Artist.

get_fontsize(s=None) [source]: возвращает размер шрифта в пунктах

set_figure(fig) [source]

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

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

set_fontsize(s=None) [source]: установка размера шрифта в пунктах

update_positions(renderer) [source]: Обновление пиксельных позиций аннотированной точки и текста.

xyann

zorder = 3

END_OF_DOCUMENT_MARKER

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

Базы: matplotlib.offsetbox.OffsetBox

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

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

add_artist(a) [source]: Добавить любой Artist в контейнерный объект

draw(renderer) [source]: Отобразить дочерние элементы

get_extent(renderer) [source]: Возвращает ширину, высоту, xdescent, ydescent объекта

get_offset() [source]: Возвращает смещение контейнера.

get_transform() [source]: Возвращает Transform, применяемый к дочерним элементам

get_window_extent(renderer) [source]: Возвращает область ограничивающей рамки в пространстве отображения.

set_offset(xy) [source]

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

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

set_transform(t) [source]: set_transform игнорируется.

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

Базы: matplotlib.offsetbox.DraggableBase

save_offset() [source]

update_offset(dx, dy) [source]

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

Базы: object

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

def save_offset(self):: pass
def update_offset(self, dx, dy):: pass

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

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

disconnect() [source]: Отключить обратные вызовы

finalize_offset() [source]

on_motion(evt) [source]

on_motion_blit(evt) [source]

on_pick(evt) [source]

on_release(event) [source]

save_offset() [source]

update_offset(dx, dy) [source]

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

Базы: matplotlib.offsetbox.DraggableBase

get_loc_in_canvas() [source]

save_offset() [source]

update_offset(dx, dy) [source]

END_OF_DOCUMENT_MARKER

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

Базы: matplotlib.offsetbox.OffsetBox

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

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

add_artist(a) [source]: Добавить любой Artist в контейнер

clip_children: Если дочерние элементы DrawingArea должны быть обрезаны границами DrawingArea.

draw(renderer) [source]: Отрисовать дочерние элементы

get_extent(renderer) [source]: Вернуть ширину, высоту, спуск по x и y контейнера

get_offset() [source]: вернуть смещение контейнера.

get_transform() [source]: Вернуть Transform применяемое к дочерним элементам

get_window_extent(renderer) [source]: Получить область отрисовки в пространстве отображения.

set_offset(xy) [source]

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

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

set_transform(t) [source]: set_transform игнорируется.

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

Базы: 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(renderer) [source]: Обновить смещение дочерних элементов и вернуть размеры контейнера

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

Базы: matplotlib.artist.Artist

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

axes: Экземпляр Axes в котором находится элемент, или None.

contains(mouseevent) [source]

Проверить, содержит ли элемент событие мыши.

Возвращает истинное значение и словарь с данными, специфичными для элемента, такими как выделенные точки. Смотрите подробности для отдельных элементов.

draw(renderer) [source]: Обновить положение дочерних элементов при необходимости и нарисовать их в заданном renderer.

get_children() [source]: Вернуть список элементов, которые он содержит.

get_extent(renderer) [source]: Вернуть ширину, высоту, спуск по x и y контейнера

get_extent_offsets(renderer) [source]

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

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

принимает размеры контейнера

get_visible_children() [source]: Вернуть список видимых элементов, которые он содержит.

get_window_extent(renderer) [source]: Получить область отрисовки в пространстве отображения.

set_figure(fig) [source]

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

принимает экземпляр класса Figure

set_height(height) [source]

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

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

set_offset(xy) [source]

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

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

set_width(width) [source]

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

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

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]

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

draw(renderer) [source]: Отрисовка дочерних элементов.

get_children() [source]: Возвращает список содержащихся в нём элементов-графических объектов.

get_data() [source]

get_extent(renderer) [source]: Возвращает ширину, высоту, отступы по горизонтали и вертикали области.

get_offset() [source]: Возвращает смещение контейнера.

get_window_extent(renderer) [source]: Возвращает область в пространстве отображения.

get_zoom() [source]

set_data(arr) [source]

set_zoom(zoom) [source]

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

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

Параметры:

Параметры:	`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` Режим упаковки.

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: Режим упаковки.

Примечания

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(renderer) [source]: Обновляет расположение дочерних элементов при необходимости и рисует их для данного рендерера.

draw_frame(renderer) [source]

get_extent_offsets(renderer) [source]: Обновляет смещение дочерних элементов и возвращает размеры области.

update_frame(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 : FontProperties, optional` `multilinebaseline : bool, optional` Если `True`, выравнивание по основанию многострочного текста корректируется для приблизительного центрирования с однострочным текстом. `minimumdescent : bool, optional` Если `True`, в коробке устанавливается минимальное нисходящее смещение "p".

s : str: строка, подлежащая отображению.
textprops : FontProperties, optional
multilinebaseline : bool, optional: Если True, выравнивание по основанию многострочного текста корректируется для приблизительного центрирования с однострочным текстом.
minimumdescent : bool, optional: Если True, в коробке устанавливается минимальное нисходящее смещение "p".

draw(renderer) [source]: Отобразить дочерние элементы

get_extent(renderer) [source]: Возвращает ширину, высоту, смещение по x и смещение по y прямоугольника.

get_minimumdescent() [source]: Получить минимальное нисходящее смещение.

get_multilinebaseline() [source]: Получить значение выравнивания по основанию для многострочного текста.

get_offset() [source]: Возвращает смещение контейнера.

get_text() [source]: Возвращает строковое представление текста этого элемента.

get_window_extent(renderer) [source]: Получить область прямоугольника в пространстве отображения.

set_minimumdescent(t) [source]

Установить минимальное нисходящее смещение.

Если True, размер однострочного текста корректируется для обеспечения минимального нисходящего смещения "p".

set_multilinebaseline(t) [source]

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

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

set_offset(xy) [source]

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

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

set_text(s) [source]: Установить текст данного элемента в виде строки.

set_transform(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(renderer) [source]: Обновить смещения дочерних элементов и вернуть области прямоугольника.

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