matplotlib.offsetbox

Классы-контейнеры для Artist.

OffsetBox

Базовый класс всех контейнерных элементов отрисовки, определённых в этом модуле.

AnchoredOffsetbox, AnchoredText

Привязка и выравнивание произвольного Artist или текста относительно родительских осей или конкретной точки привязки.

DrawingArea

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

HPacker, VPacker

Контейнеры для выстраивания своих дочерних элементов по вертикали или горизонтали.

PaddedBox

Контейнер для добавления отступа вокруг Artist.

TextArea

Содержит один элемент Text.

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: OffsetBox

Блок смещения, размещённый в соответствии с местоположением loc.

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

Параметры:

locstr

Местоположение блока. Допустимые местоположения: 'верхний левый', 'верхний центр', 'верхний правый', 'центр слева', 'центр', 'центр справа', 'нижний левый', 'нижний центр', 'нижний правый'. Для обратной совместимости также принимаются числовые значения. Подробнее см. параметр loc в Legend.

padfloat, по умолчанию: 0.4

Отступ вокруг дочернего элемента, как доля размера шрифта.

borderpadfloat, по умолчанию: 0.5

Отступ между рамкой offsetbox и bbox_to_anchor.

childOffsetBox

Блок, который будет привязан.

propFontProperties

Используется только как ссылка для отступов. Если не указано, используется значение по умолчанию rcParams["legend.fontsize"] (по умолчанию 'medium').

frameonbool

Отображать ли рамку вокруг блока.

bbox_to_anchorBboxBase, пара или четвёрка чисел с плавающей точкой

Прямоугольник, используемый для позиционирования легенды вместе с loc.

bbox_transformNone или matplotlib.transforms.Transform

Преобразование для ограничивающей рамки (bbox_to_anchor).

**kwargs

Все остальные параметры передаются в OffsetBox.

Примечания

См. Legend для подробного описания механизма привязки.

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]

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

get_bbox(renderer)[source]

Возвращает ограничивающую рамку offsetbox, игнорируя смещения родителя.

get_bbox_to_anchor()[source]

Возвращает ограничивающую рамку, к которой привязан блок.

get_child()[source]

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

get_children()[source]

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

get_offset(bbox, renderer)[source]

Возвращает смещение как кортеж (x, y).

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

Параметры:

bboxBbox

rendererRendererBase подкласс

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>, mouseover=<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]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
agg_filter	Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
bbox_to_anchor	неизвестно
child	неизвестно
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
mouseover	bool
offset	(float, float) или вызываемая функция
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемая функция
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
transform	Transform
url	str
visible	bool
width	float
zorder	float

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

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

Bases: AnchoredOffsetbox

AnchoredOffsetbox с текстом.

Параметры:

sstr

Текст.

locstr

Код расположения. См. AnchoredOffsetbox.

padfloat, по умолчанию: 0.4

Отступ вокруг текста как доля размера шрифта.

borderpadfloat, по умолчанию: 0.5

Интервал между рамкой offsetbox и bbox_to_anchor.

propdict, необязательно

Словарь ключевых параметров, передаваемых экземпляру Text, содержащемуся внутри AnchoredText.

**kwargs

Все остальные параметры передаются в 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>, mouseover=<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]

Установка нескольких свойств сразу.

Поддерживаемые свойства

Свойство	Описание
agg_filter	функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив и два смещения от нижнего левого угла изображения
alpha	число или None
animated	bool
bbox_to_anchor	неизвестно
child	неизвестно
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
mouseover	bool
offset	(float, float) или вызываемая функция
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемая функция
rasterized	bool
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или 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: Artist, _AnnotationBase

Контейнер для OffsetBox, относящегося к определённому положению xy.

Можно дополнительно нарисовать стрелку, направленную от offsetbox к xy.

Это аналогично Annotation, но с OffsetBox вместо Text.

Параметры:

offsetboxOffsetBox

xy(float, float)

Точка (x, y) для аннотации. Система координат определяется параметром xycoords.

xybox(float, float), по умолчанию: xy

Положение (x, y) для размещения аннотации. Система координат определяется параметром boxcoords.

xycoordsодиночный или двухэлементный кортеж из str или Artist или Transform или вызываемая функция, по умолчанию: 'data'

Система координат для xy. Подробное описание см. в параметре xycoords в Annotation.

boxcoordsодиночный или двухэлементный кортеж из str или Artist или Transform или вызываемая функция, по умолчанию: значение xycoords

Система координат для xybox. Подробное описание см. в параметре textcoords в Annotation.

frameonbool, по умолчанию: True

По умолчанию, текст окружён белым FancyBboxPatch (доступный как атрибут patch у AnnotationBbox). Если frameon установлено в False, этот патч скрывается.

annotation_clip: bool или None, по умолчанию: None

Определяет, будет ли обрезаться аннотация, если точка аннотации xy находится вне области осей.

• Если True, аннотация будет обрезана, если xy вне осей.
• Если False, аннотация всегда будет нарисована.
• Если None, аннотация будет обрезана, если xy вне осей и xycoords равно 'data'.

padfloat, по умолчанию: 0.4

Отступ вокруг offsetbox.

box_alignment(float, float)

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

bboxpropsсловарь, необязательно

Словарь свойств для настройки прямоугольной рамки аннотации, например, boxstyle и alpha. См. FancyBboxPatch для подробностей.

arrowprops: dict, необязательно

Свойства стрелки, см. Annotation для описания.

fontsize: float или str, необязательно

Преобразуется в точки и передаётся как mutation_scale в FancyBboxPatch для масштабирования атрибутов стиля рамки (например, pad или rounding_size). Название выбрано аналогично Text, где fontsize также определяет масштаб мутаций. Если не указано, используется rcParams["legend.fontsize"] (по умолчанию 'medium'). См. Text.set_fontsize для допустимых значений.

**kwargs

Другие свойства AnnotationBbox. См. AnnotationBbox.set для списка.

свойствоanncoords

contains(mouseevent)[source]

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

Параметры:

mouseeventMouseEvent

Возвращаемые значения:

containsbool

Принадлежит ли какое-либо значение области.

detailsdict

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

draw(renderer)[source]

Отрисовка элемента (и его дочерних элементов) с помощью заданного рендерера.

Не имеет эффекта, если элемент не отображается (Artist.get_visible возвращает False).

Параметры:

rendererRendererBase подкласс.

Примечания

Этот метод переопределён в подклассах элементов.

get_children()[source]

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

get_fontsize()[source]

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

get_tightbbox(renderer=None)[source]

Как Artist.get_window_extent, но включает любую обрезку.

Параметры:

rendererRendererBase подкласс

рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает:

Bbox

Охватывающая область (в пикселях координат фигуры).

get_window_extent(renderer=None)[source]

Получить область отображения объекта-артиста.

Ширина и высота области отображения неотрицательны.

Подклассы должны переопределять, чтобы включить в вычисление "плотной" области отображения. По умолчанию возвращается пустая область отображения в координатах 0, 0.

Будьте внимательны, используя эту функцию, результаты не будут обновляться, если область отображения артиста изменится. Область отображения может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

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>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
agg_filter	функция фильтра, которая принимает (m, n, 3) массив float и значение dpi, и возвращает (m, n, 3) массив и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
annotation_clip	bool или None
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	неизвестно
fontsize	неизвестно
gid	строка
in_layout	bool
label	объект
mouseover	bool
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
rasterized	bool
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
transform	Transform
url	строка
visible	bool
zorder	float

set_figure(fig)[source]

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

Параметры:

figFigure

set_fontsize(s=None)[source]

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

Если s не указан, сбросьте до rcParams["legend.fontsize"] (по умолчанию: 'medium').

update_positions(renderer)[source]

Обновить пиксельные координаты помеченного пункта, текста и стрелки.

propertyxyann

zorder=3

classmatplotlib.offsetbox.AuxTransformBox(aux_transform)[source]

Наследуется от OffsetBox

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

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

add_artist(a)[source]

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

draw(renderer)[source]

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

get_bbox(renderer)[source]

Возвращает рамку offsetbox, игнорируя смещения родительских элементов.

get_offset()[source]

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

get_transform()[source]

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

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>, mouseover=<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]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
mouseover	bool
offset	(float, float)
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
rasterized	bool
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
transform	неизвестно
url	str
visible	bool
width	float
zorder	float

set_offset(xy)[source]

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

Parameters:

xy(float, float)

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

set_transform(t)[source]

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

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

Bases: DraggableBase

save_offset()[source]

update_offset(dx, dy)[source]

classmatplotlib.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 finalize_offset(self):
    '''Called when the mouse is released.'''

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

propertycanvas

propertycids

disconnect()[source]

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

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: 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: OffsetBox

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

Параметры:

width, heightfloat

Ширина и высота контейнерного блока.

xdescent, ydescentfloat

Спуск блока в направлении x и y.

clipbool

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

add_artist(a)[source]

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

свойствоclip_children

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

draw(renderer)[source]

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

get_bbox(renderer)[source]

Возвращает область отрисовки offsetbox, игнорируя смещения родительских элементов.

get_offset()[source]

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

get_transform()[source]

Возвращает Transform, применяемое к потомкам.

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>, mouseover=<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]

Установка нескольких свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
mouseover	bool
offset	(float, float)
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
transform	неизвестно
url	str
visible	bool
width	float
zorder	float

set_offset(xy)[source]

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

Параметры:

xy(float, float)

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

set_transform(t)[source]

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

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

Bases: PackerBase

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

Параметры:

padfloat, по умолчанию: 0.0

Поля отступов в пунктах.

sepfloat, по умолчанию: 0.0

Интервал между элементами в пунктах.

width, heightfloat, необязательно

Ширина и высота контейнерной области в пикселях, вычисляются, если None.

align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, по умолчанию: 'baseline'

Выравнивание областей.

mode{'fixed', 'expand', 'equal'}, по умолчанию: 'fixed'

Режим компоновки.

• 'fixed' размещает предоставленные Artist плотно с интервалом sep.
• 'expand' использует максимальное доступное пространство для распределения элементов с равным интервалом между ними.
• 'equal': Каждый элемент занимает равную долю доступного пространства и выравнивается по левому краю (или верхнему краю) в пределах этой доли.

childrenсписок Artist

Элементы для компоновки.

Примечания

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

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>, mouseover=<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]

Установка нескольких свойств сразу.

Поддерживаются следующие свойства

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив (m, n, 3) float и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	строка
height	float
in_layout	bool
label	объект
mouseover	bool
offset	(float, float) или вызываемая функция
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемая функция
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
transform	Transform
url	строка
visible	bool
width	float
zorder	float

классmatplotlib.offsetbox.OffsetBox(*args, **kwargs)[source]

Базы: Artist

OffsetBox — простой контейнерный элемент.

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

Как и любой элемент, все параметры передаются элементу Artist.

свойствоaxes

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

contains(mouseevent)[source]

Делегирование проверки содержит ли мышь дочерним элементам.

Как контейнер, OffsetBox сам не реагирует на события мыши.

Параметры:

mouseeventMouseEvent

Возвращает:

containsbool

Находится ли какой-либо элемент в радиусе.

detailsdict

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

См. также

Artist.contains

draw(renderer)[source]

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

get_bbox(renderer)[source]

Возвращение области (bbox) offsetbox, игнорируя смещения родителя.

get_children()[source]

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

get_extent(renderer)[source]

[Устарело] Возвращение кортежа width, height, xdescent, ydescent области.

Примечания

Устарело начиная с версии 3.7: Используйте get_bbox вместо этого.

get_extent_offsets(renderer)[source]

[Устарело] Обновление смещения дочерних элементов и возврат области (extent) прямоугольника.

Параметры:

rendererRendererBase подкласс

Возвращает:

ширина

высота

xdescent

ydescent

список пар (xoffset, yoffset)

Примечания

Устарело начиная с версии 3.7: Используйте get_bbox и child.get_offset вместо этого.

get_offset(bbox, renderer)[source]

Возвращение смещения как кортежа (x, y).

Параметры extent необходимы для обработки случаев, когда смещение динамически определяется вызываемым методом (см. set_offset).

Параметры:

bboxBbox

rendererRendererBase подкласс

get_visible_children()[source]

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

get_window_extent(renderer=None)[source]

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

Ширина и высота области неотрицательны.

Подклассы должны переопределять для включения в вычисления "плотного" bounding box. По умолчанию возвращает пустую область в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если область окна элемента изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.

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>, mouseover=<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]

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

Поддерживаемые свойства:

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив (m, n, 3) чисел с плавающей точкой и значение dpi и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
mouseover	bool
offset	(float, float) или вызываемая функция
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемая функция
rasterized	bool
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
transform	Transform
url	str
visible	bool
width	float
zorder	float

set_figure(fig)[source]

Устанавливает Figure для OffsetBox и всех его дочерних элементов.

Параметры:

figFigure

set_height(height)[source]

Устанавливает высоту рамки.

Параметры:

heightfloat

set_offset(xy)[source]

Устанавливает смещение.

Параметры:

xy(float, float) или вызываемая функция

Координаты смещения (x, y) в единицах отображения. Эти значения могут быть заданы явно как кортеж (x, y) или путем предоставления функции, которая преобразует область в смещение. Эта функция должна иметь следующий синтаксис:

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

set_width(width)[source]

Установите ширину рамки.

Параметры:

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]

Базовый класс: OffsetBox

draw(renderer)[source]

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

get_bbox(renderer)[source]

Возвращает рамку элемента offsetbox, игнорируя смещения родителя.

get_children()[source]

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

get_data()[source]

get_offset()[source]

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

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>, mouseover=<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]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив (m, n, 3) float и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Объект Patch или (Path, Transform) или None
data	неизвестно
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
mouseover	bool
offset	(float, float) или вызываемая функция
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемая функция
rasterized	bool
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
transform	Transform
url	str
visible	bool
width	float
zoom	неизвестно
zorder	float

set_data(arr)[source]

set_zoom(zoom)[source]

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

Bases: OffsetBox

Parameters:

padfloat, default: 0.0

Отступ границы в пунктах.

sepfloat, default: 0.0

Интервал между элементами в пунктах.

width, heightfloat, optional

Ширина и высота контейнерной области в пикселях, вычисляются, если None.

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

Выравнивание элементов.

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

Режим укладки.

• 'fixed' укладывает заданные Artist плотно с интервалом sep.
• 'expand' использует максимальное доступное пространство для распределения элементов с равным интервалом между ними.
• 'equal': Каждый элемент занимает равную долю доступного пространства и выравнивается по левому краю (или верхнему краю) внутри.

childrenlist of Artist

Элементы для укладки.

Примечания

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

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>, mouseover=<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]

Установка нескольких свойств сразу.

Поддерживаемые свойства

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	object
mouseover	bool
offset	(float, float) или вызываемый объект
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
transform	Transform
url	str
visible	bool
width	float
zorder	float

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

Bases: OffsetBox

Контейнер для добавления отступа вокруг Artist.

The PaddedBox содержит FancyBboxPatch, используемый для визуализации при отрисовке.

Параметры:

childArtist

Вложенный Artist.

padfloat, default: 0.0

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

draw_framebool

Отрисовывать ли содержащуюся FancyBboxPatch.

patch_attrsdict or None

Дополнительные параметры, передаваемые содержащейся FancyBboxPatch.

draw(renderer)[source]

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

draw_frame(renderer)[source]

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>, mouseover=<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]

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

Поддерживаемые свойства

Свойство	Описание
agg_filter	Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3) и два смещения от нижнего левого угла изображения.
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
mouseover	bool
offset	(float, float) или callable
path_effects	AbstractPathEffect
picker	None или bool или float или callable
rasterized	bool
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или 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)[source]

Bases: OffsetBox

TextArea — это контейнерный элемент для одного объекта Text.

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

Параметры:

sstr

Текст, который будет отображаться.

textpropsdict, по умолчанию: {}

Словарь ключевых параметров, которые будут переданы объекту Text внутри TextArea.

multilinebaselinebool, по умолчанию: False

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

draw(renderer)[source]

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

get_bbox(renderer)[source]

Возвращает bounding box объекта offsetbox, игнорируя смещения родительских элементов.

get_multilinebaseline()[source]

Возвращает значение multilinebaseline.

get_offset()[source]

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

get_text()[source]

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

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>, mouseover=<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]

Установка нескольких свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения с нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
mouseover	bool
multilinebaseline	неизвестно
offset	(float, float)
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
rasterized	bool
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
text	неизвестно
transform	неизвестно
url	str
visible	bool
width	float
zorder	float

set_multilinebaseline(t)[source]

Установка multilinebaseline.

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

set_offset(xy)[source]

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

Параметры:

xy(float, float)

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

set_text(s)[source]

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

set_transform(t)[source]

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

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

Основы: PackerBase

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

Параметры:

padfloat, по умолчанию: 0.0

Отступ границы в пунктах.

sepfloat, по умолчанию: 0.0

Интервал между элементами в пунктах.

width, heightfloat, необязательно

Ширина и высота контейнерного блока в пикселях, вычисляются, если None.

align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, по умолчанию: 'baseline'

Выравнивание блоков.

mode{'fixed', 'expand', 'equal'}, по умолчанию: 'fixed'

Режим упаковки.

• 'fixed' плотно упаковывает заданные Artist с интервалом sep.
• 'expand' использует максимальную доступную площадь для распределения элементов с равным интервалом между ними.
• 'equal': Каждый элемент занимает равную часть доступного пространства и выравнивается по левому краю (или верхнему краю) в этом пространстве.

childrenсписок Artist

Элементы для упаковки.

Примечания

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

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>, mouseover=<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]

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

Поддерживаемые свойства:

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
mouseover	bool
offset	(float, float) или вызываемая функция
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемая функция
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
transform	Transform
url	str
visible	bool
width	float
zorder	float

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

[Устарело]

Примечания

Устарело начиная с версии 3.7: Используйте вместо этого patches.bbox_artist.