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

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

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

Параметры:

locstr

Положение блока. Допустимые значения: 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center', 'lower right'. Для обратной совместимости также допускаются числовые значения. Подробности см. в описании параметра loc класса Legend.

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

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

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

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

childOffsetBox

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

propFontProperties

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

frameonbool

Рисовать ли рамку вокруг блока.

bbox_to_anchorBboxBase, пара или четверка значений float

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

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

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

Возвращает bbox, относительно которого закреплён блок.

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

Задаёт bbox, относительно которого закреплён блок.

bbox может быть экземпляром Bbox, списком [left, bottom, width, height] или списком [left, bottom], в котором ширина и высота считаются равными нулю. Переданное преобразование преобразует 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, default: 0.4

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

borderpadfloat, default: 0.5

Расстояние между рамкой offsetbox и bbox_to_anchor.

propdict, optional

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

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

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

Свойство	Описание
agg_filter	функция фильтрации, принимающая массив чисел с плавающей точкой размера (m, n, 3) и значение dpi и возвращающая массив размера (m, n, 3) и два смещения от левого нижнего угла изображения
alpha	float или 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	object
mouseover	bool
offset	(float, float) или callable
path_effects	список AbstractPathEffect
picker	None или bool или float или callable
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.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.

При необходимости можно нарисовать стрелку, указывающую от блока со смещением на xy.

Подобно Annotation, но вместо Text используется OffsetBox.

Параметры:

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

Отступ вокруг блока со смещением.

box_alignment(float, float)

Кортеж из двух чисел с плавающей точкой, задающих вертикальное и горизонтальное выравнивание блока со смещением относительно boxcoords. Нижний левый угол соответствует (0, 0), а верхний правый — (1, 1).

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

Словарь свойств для рамки аннотации, например 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.

propertyanncoords

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

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

Параметры:

mouseeventMouseEvent

Возвращает:

containsbool

Указывает, находятся ли какие-либо значения внутри радиуса.

detailsdict

Словарь с подробностями контекста события, специфичными для объекта Artist, например с указанием точек, попавших в радиус выбора. Подробности см. в описании отдельных подклассов Artist.

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

Рисует объект Artist (и его дочерние объекты) с помощью указанного средства визуализации.

Ничего не делает, если объект Artist невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

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

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

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

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

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

Аналогичен Artist.get_window_extent, но учитывает обрезку.

Параметры:

rendererподкласс RendererBase, необязательно

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

Возвращает:

Bbox или None

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

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

Возвращает ограничивающую рамку объекта Artist в пространстве отображения.

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

Для включения в расчёт тесной ограничивающей рамки подклассам следует переопределить этот метод. По умолчанию возвращается пустая ограничивающая рамка в точке 0, 0.

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

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	float или 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	object
mouseover	bool
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
zorder	float

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

Задаёт экземпляр Figure или SubFigure, к которому относится объект Artist.

Параметры:

figFigure или SubFigure

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

Задаёт размер шрифта в пунктах.

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

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

Обновляет положения в пикселях для аннотируемой точки, текста и стрелки.

propertyxyann

zorder=3

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

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

OffsetBox со вспомогательным преобразованием.

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

AuxTransformBox похож на DrawingArea, но размеры рамки не заданы заранее, а вычисляются по размерам области отображения дочерних элементов; размеры дочерних элементов вычисляются в преобразованных координатах.

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

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

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

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

propertycanvas

propertycids

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

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

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

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

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

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

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

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

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

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

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

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

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

classmatplotlib.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 в контейнер.

propertyclip_children

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

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

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

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

Возвращает bbox 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	float или 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 или callable
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.HPacker(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[исходный код]

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

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

+-------------------------------+
| Child 1    Child 2    Child 3 |
+-------------------------------+

Параметры:

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' использует максимально доступное пространство, равномерно распределяя объекты Artist с одинаковыми промежутками между ними.
• 'equal': каждому объекту Artist отводится одинаковая доля доступного пространства; в ней он выравнивается по левому краю (или по верхнему краю).

childrenсписок Artist

Объекты Artist для компоновки.

Примечания

pad и sep задаются в пунктах и масштабируются с учётом dpi средства отрисовки, тогда как 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>)[исходный код]

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

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

Свойство	Описание
agg_filter	функция фильтра, принимающая массив чисел с плавающей запятой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от левого нижнего угла изображения
alpha	float или 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) или callable
path_effects	список объектов AbstractPathEffect
picker	None, bool, float или callable
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.OffsetBox(*args, **kwargs)[источник]

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

Простой контейнерный объект-художник.

Предполагается, что дочерние объекты-художники будут отрисовываться относительно родительского объекта.

Поскольку этот объект сам является объектом-художником, все параметры передаются в Artist.

propertyaxes

Экземпляр Axes, в котором находится объект-художник, или None.

contains(mouseevent)[источник]

Передать дочерним объектам проверку попадания события мыши.

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

Параметры:

mouseeventMouseEvent

Возвращает:

containsbool

Находятся ли какие-либо значения в пределах радиуса.

detailsdict

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

См. также

Artist.contains

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

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

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

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

get_children()[источник]

Вернуть список дочерних объектов Artist.

get_offset(bbox, renderer)[источник]

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

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

Параметры:

bboxBbox

rendererподкласс RendererBase

get_visible_children()[источник]

Вернуть список видимых дочерних объектов Artist.

get_window_extent(renderer=None)[источник]

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

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

Для включения в вычисление ограничивающей рамки «tight» подклассам следует переопределить этот метод. По умолчанию возвращается пустая ограничивающая рамка в точке 0, 0.

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

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	функция фильтрации, принимающая массив float размерности (m, n, 3) и значение dpi и возвращающая массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	float или 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

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

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

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

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

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	функция фильтрации, принимающая массив чисел с плавающей запятой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от левого нижнего угла изображения
alpha	float или 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	object
mouseover	bool
offset	(float, float) или callable
path_effects	список AbstractPathEffect
picker	None, bool, float или callable
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
transform	Transform
url	str
visible	bool
width	float
zoom	неизвестно
zorder	float

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

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

classmatplotlib.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 задаются в пикселях.

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	float или 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) или callable
path_effects	список AbstractPathEffect
picker	None, bool, float или callable
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)[исходный код]

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

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

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

+----------------------------+
|                            |
|                            |
|                            |
| <--pad--> Artist           |
|             ^              |
|            pad             |
|             v              |
+----------------------------+

Атрибуты:

padfloat

Отступ в пунктах.

patchFancyBboxPatch

Если draw_frame имеет значение True, этот FancyBboxPatch становится видимым и образует границу вокруг контейнера.

Параметры:

childArtist

Содержащийся объект Artist.

padfloat, default: 0.0

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

draw_framebool

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

patch_attrsdict or None

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

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

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

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

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	float или 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) или callable
path_effects	список объектов AbstractPathEffect
picker	None, bool, float или callable
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)[исходный код]

classmatplotlib.offsetbox.TextArea(s, *, textprops=None, multilinebaseline=False)[исходный код]

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

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

По умолчанию текст размещается в точке (0, 0) с выравниванием по базовой линии и левому краю. Ширина и высота экземпляра TextArea равны ширине и высоте его дочернего текстового объекта.

Параметры:

sstr

Отображаемый текст.

textpropsdict, default: {}

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

multilinebaselinebool, default: False

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

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

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

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

Возвращает bbox 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	float или 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
multilinebaseline	unknown
offset	(float, float)
path_effects	список объектов AbstractPathEffect
picker	None, bool, float или callable
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
text	unknown
transform	unknown
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 размещает дочерние элементы вертикально, автоматически корректируя их взаимное положение во время отрисовки.

+---------+
| Child 1 |
| Child 2 |
| Child 3 |
+---------+

Параметры:

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

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

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

Свойство	Описание
agg_filter	функция фильтра, принимающая массив float размером (m, n, 3) и значение dpi и возвращающая массив размером (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	float или 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