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: matplotlib.offsetbox.OffsetBox

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

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

Parameters

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={'центр': 10, 'центр слева': 6, 'центр справа': 7, 'низ центр': 8, 'низ слева': 3, 'низ справа': 4, 'справа': 5, 'верх центр': 9, 'верх слева': 2, 'верх справа': 1}

draw(renderer)[source]

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

get_bbox_to_anchor()[source]

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

get_child()[source]

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

get_children()[source]

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

get_extent(renderer)[source]

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

Это размеры дочернего элемента плюс отступы.

get_window_extent(renderer)[source]

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

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

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

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

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>, 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	логическое значение
bbox_to_anchor	неизвестно
child	неизвестно
clip_box	Bbox
clip_on	логическое значение
clip_path	Объект Patch или (Path, Transform) или None
figure	Figure
gid	строка
height	вещественное число
in_layout	логическое значение
label	объект
offset	(число с плавающей точкой, число с плавающей точкой) или вызываемый объект
path_effects	AbstractPathEffect
picker	None или логическое значение или число с плавающей точкой или вызываемый объект
rasterized	логическое значение
sketch_params	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
snap	логическое значение или None
transform	Transform
url	строка
visible	логическое значение
width	вещественное число
zorder	вещественное число

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: matplotlib.offsetbox.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>, 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	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
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: matplotlib.artist.Artist, matplotlib.text._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 или вызываемый объект или (float, float), по умолчанию: 'data'

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

boxcoordsстрока или Artist или Transform или вызываемый объект или (float, float), по умолчанию: значение xycoords

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

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

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

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

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

box_alignment(float, float)

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

**kwargs

Другие параметры аналогичны Annotation.

свойствоanncoords

contains(mouseevent)[source]

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

Параметры

mouseeventmatplotlib.backend_bases.MouseEvent

Возвращает

containsbool

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

detailsdict

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

draw(renderer)[source]

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

Это не повлияет, если элемент не видимый (Artist.get_visible возвращает False).

Параметры

rendererRendererBase подкласс.

Примечания

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

get_children()[source]

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

get_fontsize()[source]

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

get_tightbbox(renderer)[source]

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

Параметры

rendererRendererBase подкласс

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

Возвращает

Bbox

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

get_window_extent(renderer)[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>, 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, и возвращает массив (m, n, 3)
alpha	скаляр или None
animated	bool
annotation_clip	bool или None
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	неизвестно
fontsize	неизвестно
gid	строка
in_layout	bool
label	объект
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
rasterized	bool
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
transform	Transform
url	строка
visible	bool
zorder	float

set_figure(fig)[source]

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

Parameters

figFigure

set_fontsize(s=None)[source]

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

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

update_positions(renderer)[source]

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

propertyxyann

zorder=3

classmatplotlib.offsetbox.AuxTransformBox(aux_transform)[source]

Bases: matplotlib.offsetbox.OffsetBox

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

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

add_artist(a)[source]

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

draw(renderer)[source]

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

get_extent(renderer)[source]

Возвращает кортеж width, height, xdescent, ydescent рамки.

get_offset()[source]

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

get_transform()[source]

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

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

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

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

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

set_offset(xy)[source]

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

Параметры

xy(float, float)

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

set_transform(t)[source]

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

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

Базовой класс: matplotlib.offsetbox.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 пересчитывает их положение в координатах осей и устанавливает соответствующее свойство.

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: matplotlib.offsetbox.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: matplotlib.offsetbox.OffsetBox

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

Параметры

width, heightfloat

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

xdescent, ydescentfloat

Смещение области в направлениях x и y.

clipbool

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

add_artist(a)[source]

Добавляет элемент Artist в контейнерную область.

propertyclip_children

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

draw(renderer)[source]

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

get_extent(renderer)[source]

Возвращает ширину, высоту, xdescent, ydescent области.

get_offset()[source]

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

get_transform()[source]

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

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

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

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

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
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=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)[source]

Bases: matplotlib.offsetbox.PackerBase

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

Параметры

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

Поля границы в пунктах.

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

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

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 — в пикселях.

get_extent_offsets(renderer)[source]

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

Параметры

rendererподкласс RendererBase

Возвращает

width

height

xdescent

ydescent

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

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

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

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

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3)
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
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

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

Bases: matplotlib.artist.Artist

The OffsetBox is a simple container artist.

The child artists are meant to be drawn at a relative position to its parent.

Being an artist itself, all parameters are passed on to Artist.

propertyaxes

The Axes instance the artist resides in, or None.

contains(mouseevent)[source]

Delegate the mouse event contains-check to the children.

As a container, the OffsetBox does not respond itself to mouseevents.

Parameters

mouseeventmatplotlib.backend_bases.MouseEvent

Returns

containsbool

Whether any values are within the radius.

detailsdict

An artist-specific dictionary of details of the event context, such as which points are contained in the pick radius. See the individual Artist subclasses for details.

См. также

Artist.contains

draw(renderer)[source]

Update the location of children if necessary and draw them to the given renderer.

get_children()[source]

Return a list of the child Artists.

get_extent(renderer)[source]

Return a tuple width, height, xdescent, ydescent of the box.

get_extent_offsets(renderer)[source]

Update offset of the children and return the extent of the box.

Parameters

rendererRendererBase subclass

Returns

width

height

xdescent

ydescent

list of (xoffset, yoffset) pairs

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

Return the offset as a tuple (x, y).

The extent parameters have to be provided to handle the case where the offset is dynamically determined by a callable (see set_offset).

Parameters

width, height, xdescent, ydescent

Extent parameters.

rendererRendererBase subclass

get_visible_children()[source]

Return a list of the visible child Artists.

get_window_extent(renderer)[source]

Get the artist's bounding box in display space.

The bounding box' width and height are nonnegative.

Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.

Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.

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

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

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

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi и возвращает массив (m, n, 3)
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Объект Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
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)[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]

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

Parameters

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]

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

draw(renderer)[source]

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

get_children()[source]

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

get_data()[source]

get_extent(renderer)[source]

Возвращает кортеж width, height, xdescent, ydescent прямоугольника.

get_offset()[source]

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

get_window_extent(renderer)[source]

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

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

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

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

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>, 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	bool
clip_box	Bbox
clip_on	bool
clip_path	Объект Patch или (Path, Transform) или None
data	неизвестно
figure	Figure
gid	строка
height	число с плавающей точкой
in_layout	bool
label	объект
offset	(число с плавающей точкой, число с плавающей точкой) или вызываемый объект
path_effects	AbstractPathEffect
picker	None или bool или число с плавающей точкой или вызываемый объект
rasterized	bool
sketch_params	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
snap	bool или None
transform	Transform
url	строка
visible	bool
width	число с плавающей точкой
zoom	неизвестно
zorder	число с плавающей точкой

set_data(arr)[source]

set_zoom(zoom)[source]

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

Bases: matplotlib.offsetbox.OffsetBox

Параметры

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

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

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

Расстояние между элементами в пунктах.

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

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

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

Свойство	Описание
agg_filter	функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает массив (m, n, 3)
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	object
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.PaddedBox(child, pad=None, draw_frame=False, patch_attrs=None)[source]

Bases: matplotlib.offsetbox.OffsetBox

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

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

Параметры

childArtist

Содержимое Artist.

padfloat

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

draw_framebool

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

patch_attrsdict or None

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

draw(renderer)[source]

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

draw_frame(renderer)[source]

get_extent_offsets(renderer)[source]

Обновить смещения дочерних элементов и вернуть размеры области.

Параметры

rendererRendererBase подкласс

Возвращает

width

height

xdescent

ydescent

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

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

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

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

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

update_frame(bbox, fontsize=None)[source]

classmatplotlib.offsetbox.TextArea(s, textprops=None, multilinebaseline=False, minimumdescent=<deprecated parameter>)[source]

Bases: matplotlib.offsetbox.OffsetBox

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

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

Параметры

sstr

Текст для отображения.

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

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

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

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

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

Если True, у ящика есть минимальный спуск "p". Сейчас это всегда True.

draw(renderer)[source]

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

get_extent(renderer)[source]

Возвращает кортеж width, height, xdescent, ydescent ящика.

get_minimumdescent()[source]

[Устарело] Получение minimumdescent.

Примечания

Устарело начиная с версии 3.4.

get_multilinebaseline()[source]

Получение multilinebaseline.

get_offset()[source]

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

get_text()[source]

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

get_window_extent(renderer)[source]

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

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

Подклассы должны переопределять для включения в расчет прямоугольника "tight". По умолчанию возвращается пустой прямоугольник в (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>, minimumdescent=<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	функция фильтра, которая принимает массив (m, n, 3) значений с плавающей точкой и значение dpi, и возвращает массив (m, n, 3)
alpha	скаляр или None
animated	bool
clip_box	Bbox
clip_on	bool
clip_path	Объект Patch или (Path, Transform) или None
figure	Figure
gid	str
height	float
in_layout	bool
label	объект
minimumdescent	неизвестно
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_minimumdescent(t)[source]

[Устаревшее] Установка minimumdescent.

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

Примечания

Устарело начиная с версии 3.4.

set_multilinebaseline(t)[source]

Установка multilinebaseline.

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

set_offset(xy)[source]

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

Параметры

xy(float, float)

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

set_text(s)[source]

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

set_transform(t)[source]

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

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

Базы: matplotlib.offsetbox.PackerBase

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

Параметры

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

Поля границы в пунктах.

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

Расстояние между элементами в пунктах.

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 в пикселях.

get_extent_offsets(renderer)[source]

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

Параметры

rendererRendererBase подкласс

Возвращает

ширина

высота

xdescent

ydescent

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

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

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

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

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

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