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)[исходный код]

Базовые классы: 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, 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)[исходный код]: При необходимости обновляет положение потомков и выводит объект с помощью указанного renderer.

get_bbox(renderer)[исходный код]: Возвращает прямоугольник offsetbox, игнорируя смещения родителя.

get_bbox_to_anchor()[исходный код]: Возвращает прямоугольник, к которому привязан ящик.

get_child()[исходный код]: Возвращает потомка.

get_children()[исходный код]: Возвращает список потомков.

get_offset(bbox, renderer)[исходный код]

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

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

Параметры:

bboxBbox
rendererподкласс RendererBase

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>)[исходный код]

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив (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)[исходный код]

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

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

set_child(child)[исходный код]: Устанавливает дочерний элемент для привязки.

update_frame(bbox, fontsize=None)[исходный код]

zorder=5

classmatplotlib.offsetbox.AnchoredText(s, loc, *, pad=0.4, borderpad=0.5, prop=None, **kwargs)[исходный код]

Базовые классы: AnchoredOffsetbox

AnchoredOffsetbox с текстом.

Параметры:

sstr: Текст.
locstr: Код расположения. См. AnchoredOffsetbox.
padfloat, по умолчанию: 0.4: Отступ вокруг текста как доля размера шрифта.
borderpadfloat, по умолчанию: 0.5: Расстояние между рамкой offsetbox и bbox_to_anchor.
propdict, необязательно: Словарь ключевых параметров, передаваемых экземпляру Text, содержащемуся внутри AnchoredText.
**kwargs: Все остальные параметры передаются в AnchoredOffsetbox.

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

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

Свойство	Описание
`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)[исходный код]

Базовые классы: 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).

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

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

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

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

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

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

**kwargs

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

свойствоanncoords

contains(mouseevent)[исходный код]

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

Параметры:

mouseeventMouseEvent

Возвращает:

containsbool: Является ли любое значение в пределах радиуса.
detailsdict: Словарь с подробностями события, специфичных для объекта, например, какие точки попадают в радиус выделения. Подробности см. в соответствующих классах объектов.

draw(renderer)[исходный код]

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

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

Параметры:

rendererподкласс RendererBase.

Примечания

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

get_children()[исходный код]: Возвращает список дочерних элементов Artist этого Artist.

get_fontsize()[исходный код]: Возвращает размер шрифта в пунктах.

get_tightbbox(renderer=None)[исходный код]

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

Параметры:

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

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

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

get_window_extent(renderer=None)[исходный код]

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

Ширина и высота ограничивающей рамки неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотной" ограничивающей рамки. По умолчанию возвращается пустая ограничивающая рамка в координатах 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>)[исходный код]

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

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

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

set_figure(fig)[исходный код]

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

Параметры:

figFigure

set_fontsize(s=None)[исходный код]

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

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

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

propertyxyann

zorder=3

classmatplotlib.offsetbox.AuxTransformBox(aux_transform)[исходный код]

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

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

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

add_artist(a)[исходный код]: Добавление Artist в контейнерную рамку.

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

get_bbox(renderer)[исходный код]: Возвращает ограничивающую рамку offsetbox, игнорируя смещения родительских элементов.

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

get_transform()[исходный код]: Возвращает 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>)[исходный код]

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей запятой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	скаляр или None
`animated`	bool
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Фигура или (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)[исходный код]

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

Параметры:

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

set_transform(t)[исходный код]: set_transform игнорируется.

classmatplotlib.offsetbox.DraggableAnnotation(annotation, use_blit=False)[исходный код]

Базовые классы: DraggableBase

save_offset()[исходный код]

update_offset(dx, dy)[исходный код]

классmatplotlib.offsetbox.DraggableBase(ref_artist, use_blit=False)[исходный код]

Базовый класс для перемещаемого объекта (легенды, 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 пересчитывает их положение в координатах осей и устанавливает соответствующий атрибут.

свойствоcanvas

свойствоcids

disconnect()[исходный код]: Отключить обратные вызовы.

finalize_offset()[исходный код]

on_motion(evt)[исходный код]

on_pick(evt)[исходный код]

on_release(event)[исходный код]

save_offset()[исходный код]

update_offset(dx, dy)[исходный код]

классmatplotlib.offsetbox.DraggableOffsetBox(ref_artist, offsetbox, use_blit=False)[исходный код]

Базовые классы: DraggableBase

get_loc_in_canvas()[исходный код]

save_offset()[исходный код]

update_offset(dx, dy)[исходный код]

классmatplotlib.offsetbox.DrawingArea(width, height, xdescent=0.0, ydescent=0.0, clip=False)[исходный код]

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

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

Параметры:

width, heightfloat: Ширина и высота контейнерного прямоугольника.
xdescent, ydescentfloat: Спуск прямоугольника в направлении x и y.
clipbool: Определяет, нужно ли обрезать дочерние элементы по границам прямоугольника.

add_artist(a)[исходный код]: Добавить объект Artist в контейнерный прямоугольник.

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

draw(renderer)[исходный код]: При необходимости обновить положение дочерних элементов и нарисовать их с помощью заданного renderer.

get_bbox(renderer)[исходный код]: Возвращает прямоугольник (bbox) offsetbox, игнорируя смещения родительского элемента.

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

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

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

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

Свойство	Описание
`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`	неизвестно
`url`	str
`visible`	bool
`width`	float
`zorder`	float

set_offset(xy)[исходный код]

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

Параметры:

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

set_transform(t)[исходный код]: Вызов set_transform игнорируется.

классmatplotlib.offsetbox.HPacker(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[исходный код]

Базовые классы: 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 задаются в пунктах и будут масштабироваться с разрешением dpi средства отрисовки, тогда как width и height задаются в пикселях.

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

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

Свойство	Описание
`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`	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

классmatplotlib.offsetbox.OffsetBox(*args, **kwargs)[исходный код]

Базы: Artist

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

Элементы-потомки должны отображаться по относительному положению к родительскому элементу.

Будучи элементом, все параметры передаются Artist.

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

contains(mouseevent)[исходный код]

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

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

Параметры:

mouseeventMouseEvent

Возвращает:

containsbool: Вхождение ли каких-либо значений в радиус.
detailsdict: Словарь с деталями контекста события (например, какие точки попадают в радиус выбора). См. подклассы отдельных элементов для деталей.

См. также

Artist.contains

draw(renderer)[исходный код]: Обновляет положение потомков при необходимости и отрисовывает их на заданном renderer.

get_bbox(renderer)[исходный код]: Возвращает область, игнорируя смещения родителя.

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

get_extent(renderer)[исходный код]: [Устарело] Возвращает кортеж width, height, xdescent, ydescent области.

Примечания

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

get_extent_offsets(renderer)[исходный код]

[Устарело] Обновляет смещение потомков и возвращает область.

Параметры:

rendererRendererBase подкласс

Возвращает:

ширина
высота
xdescent
ydescent
список пар (xoffset, yoffset)

Примечания

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

get_offset(bbox, renderer)[исходный код]

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

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

Параметры:

bboxBbox
rendererRendererBase подкласс

get_visible_children()[исходный код]: Возвращает список видимых дочерних Artist.

get_window_extent(renderer=None)[исходный код]

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

Ширина и высота ограничивающей области неотрицательны.

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

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

END_OF_DOCUMENT_MARKER ```

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

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

Свойство	Описание
`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)[исходный код]

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

Параметры:

figFigure

set_height(height)[исходный код]

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

Параметры:

heightfloat

set_offset(xy)[исходный код]

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

Параметры:

xy(float, float) или вызываемый объект

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

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

set_width(width)[исходный код]

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

Параметры:

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)[исходный код]

Базы: OffsetBox

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

get_bbox(renderer)[исходный код]: Возвращает рамку области блока смещения, игнорируя смещения родительского элемента.

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

get_data()[исходный код]

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

get_zoom()[исходный код]

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>)[исходный код]

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

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

Свойство	Описание
`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
`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)[исходный код]

set_zoom(zoom)[исходный код]

классmatplotlib.offsetbox.PackerBase(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[источник]

Базовые классы: 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 задаются в пунктах и будут масштабироваться с разрешением dpi средствами отображения, в то время как width и height — в пикселях.

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

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

Свойство	Описание
`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`	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

классmatplotlib.offsetbox.PaddedBox(child, pad=0.0, *, draw_frame=False, patch_attrs=None)[источник]

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

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

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

Параметры:

childArtist: Вложенный Artist.
padfloat, по умолчанию: 0.0: Отступ в пунктах. Он будет масштабироваться с разрешением рендерера. В отличие от этого, width и height задаются в пикселях и, таким образом, не масштабируются.
draw_framebool: Отображать ли вложенный FancyBboxPatch.
patch_attrsdict или None: Дополнительные параметры, передаваемые вложенному FancyBboxPatch.

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

draw_frame(renderer)[источник]

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

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

Свойство	Описание
`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`	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

update_frame(bbox, fontsize=None)[источник]

классmatplotlib.offsetbox.TextArea(s, *, textprops=None, multilinebaseline=False)[источник]

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

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

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

Параметры:

sstr: Текст для отображения.
textpropsdict, по умолчанию: {}: Словарь ключевых параметров, которые будут переданы экземпляру Text внутри TextArea.
multilinebaselinebool, по умолчанию: False: Устанавливает, будет ли основание многострочного текста скорректировано таким образом, чтобы оно (приблизительно) выравнивалось по центру с однострочным текстом.

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

get_bbox(renderer)[источник]: Возвращает ограничивающий прямоугольник offsetbox, игнорируя смещения родителя.

get_multilinebaseline()[источник]: Возвращает значение multilinebaseline.

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

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

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>)[исходный код]

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

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

Свойство	Описание
`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
`multilinebaseline`	неизвестно
`offset`	(float, float)
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`text`	неизвестно
`transform`	неизвестно
`url`	str
`visible`	bool
`width`	float
`zorder`	float

set_multilinebaseline(t)[исходный код]

Установка multilinebaseline.

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

set_offset(xy)[исходный код]

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

Параметры:

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

set_text(s)[исходный код]: Установка текста этой области в виде строки.

set_transform(t)[исходный код]: set_transform игнорируется.

classmatplotlib.offsetbox.VPacker(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[исходный код]

Базовые классы: 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 задаются в пунктах и будут масштабироваться с разрешением dpi средства отрисовки, в то время как width и height задаются в пикселях.

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

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

Свойство	Описание
`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`	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

matplotlib.offsetbox.bbox_artist(*args, **kwargs)[исходный код]: [Устарело]

Примечания

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