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.

Параметры:

locстрока

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

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

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

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

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

childOffsetBox

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

propFontProperties

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

frameonbool

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

bbox_to_anchorBboxBase, кортеж из 2 или 4 чисел

Прямоугольник, используемый для позиционирования контейнера в сочетании с 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).

Параметры extent нужны для обработки случаев, когда смещение определяется вызываемой функцией (см. 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, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
bbox_to_anchor	неизвестно
child	неизвестно
clip_box	BboxBase или None
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_bbox_to_anchor(bbox, transform=None)[source]

Установить область, к которой привязывается рамка.

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

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	Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
bbox_to_anchor	неизвестно
child	неизвестно
clip_box	BboxBase или None
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одиночная или двумерная кортеж строк или Artist или Transform или вызываемая функция, по умолчанию: 'data'

Система координат, в которой заданы координаты xy. См. параметр xycoords в Annotation для подробного описания.

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

Система координат, в которой заданы координаты xybox. См. параметр textcoords в Annotation для подробного описания.

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

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

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

Нужно ли обрезать (т.е. не рисовать) аннотацию, когда точка аннотации xy находится за пределами области Axes.

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

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

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

box_alignment(float, float)

Кортеж из двух чисел для вертикального и горизонтального выравнивания offsetbox относительно boxcoords. Левый нижний угол — (0, 0), правый верхний — (1, 1).

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

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

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

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

fontsize: число с плавающей точкой или строка, необязательно

Преобразуется в точки и передаётся как 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 или None

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

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

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

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

Parameters:

width, heightfloat

Ширина и высота контейнерного прямоугольника.

xdescent, ydescentfloat

Спуск прямоугольника в направлении x и y.

clipbool

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

add_artist(a)[source]

Добавить элемент Artist в контейнерный прямоугольник.

propertyclip_children

Если дочерние элементы этой области рисования должны быть обрезаны границами области рисования.

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	BboxBase или None
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]

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

Параметры:

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]

Основания: 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) массив с плавающей точкой и значение dpi и возвращает (m, n, 3) массив и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	BboxBase или None
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	строка
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]

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

get_children()[source]

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

get_offset(bbox, renderer)[source]

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

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

Параметры:

bboxBbox

rendererRendererBase подкласс

get_visible_children()[source]

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

get_window_extent(renderer=None)[source]

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

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

Подклассы должны переопределять для включения в вычисление "плотной" области отображения. По умолчанию возвращает пустую область отображения в координатах 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	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения с левого нижнего угла изображения
alpha	скаляр или None
animated	bool
clip_box	BboxBase или None
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 и всех его дочерних элементов.

Parameters:

figFigure

set_height(height)[source]

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

Parameters:

heightfloat

set_offset(xy)[source]

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

Parameters:

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]

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

get_bbox(renderer)[source]

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

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]

Основы: OffsetBox

Параметры:

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) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	BboxBase или None
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	строка
visible	bool
width	float
zorder	float

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

Основы: OffsetBox

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

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

Параметры:

childArtist

Вложенный Artist.

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

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

draw_framebool

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

patch_attrsdict или None

Дополнительные параметры, передаваемые вложенному FancyBboxPatch.

draw(renderer)[source]

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

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	BboxBase или None
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

update_frame(bbox, fontsize=None)[source]

classmatplotlib.offsetbox.TextArea(s, *, textprops=None, multilinebaseline=False)[source]

Bases: OffsetBox

The TextArea is a container artist for a single Text instance.

The text is placed at (0, 0) with baseline+left alignment, by default. The width and height of the TextArea instance is the width and height of its child text.

Parameters:

sstr

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

textpropsdict, default: {}

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

multilinebaselinebool, default: False

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

draw(renderer)[source]

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

get_bbox(renderer)[source]

Возвращает область (bbox) 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, и возвращает массив float (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
clip_box	BboxBase или None
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]

Установить многострочный базовый уровень.

Если 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]

Bases: 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	BboxBase или None
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