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

Bases: OffsetBox

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

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

Параметры:

locstr: Положение ящика. Допустимые позиции: «верхний левый», «верхний центр», «верхний правый», «центр слева», «центр», «центр справа», «нижний левый», «нижний центр», «нижний правый». Для обратной совместимости также принимаются числовые значения. Подробности см. в параметре loc у Legend.
padfloat, по умолчанию: 0.4: Отступ вокруг дочернего элемента как доля размера шрифта.
borderpadfloat, по умолчанию: 0.5: Отступ между рамкой offsetbox и bbox_to_anchor.
childOffsetBox: Ящик, который будет привязан.
propFontProperties: Используется только в качестве ссылки для отступов. Если не указано, используется rcParams["legend.fontsize"] (по умолчанию: 'medium').
frameonbool: Отображать ли рамку вокруг ящика.
bbox_to_anchorBboxBase, пара или четвёрка чисел с плавающей точкой: Прямоугольник, используемый для позиционирования легенды вместе с loc.
bbox_transformNone или matplotlib.transforms.Transform: Преобразование для ограничивающей рамки (bbox_to_anchor).
**kwargs: Все остальные параметры передаются в OffsetBox.

Примечания

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

codes={'center': 10, 'center left': 6, 'center right': 7, 'lower center': 8, 'lower left': 3, 'lower right': 4, 'right': 5, 'upper center': 9, 'upper left': 2, 'upper right': 1}

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

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

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

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

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

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

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

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

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

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

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

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

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

bbox может быть объектом Bbox, списком [left, bottom, width, height] или списком [left, bottom], где ширина и высота предполагаются равными нулю. Прямоугольник будет преобразован в координаты отображения с помощью заданного преобразования.

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

classmatplotlib.offsetbox.AnnotationBbox(offsetbox, xy, xybox=None, *, xycoords='data', boxcoords=None, frameon=True, pad=0.4, annotation_clip=None, box_alignment=(0.5, 0.5), bboxprops=None, arrowprops=None, fontsize=None, **kwargs)[исходный код]

Основания: Artist, _AnnotationBase

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

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

Это похоже на Annotation, но с OffsetBox вместо Text.

Параметры:

offsetboxOffsetBox
xy(float, float): Точка (x, y) для аннотации. Система координат определяется параметром xycoords.
xybox(float, float), по умолчанию: xy: Положение (x, y) для размещения текста. Система координат определяется параметром boxcoords.
xycoordsстрока или Artist или Transform или вызываемая функция или (float, float), по умолчанию: 'data': Система координат, в которой задано xy. Подробное описание см. в параметре xycoords у Annotation.
boxcoordsстрока или Artist или Transform или вызываемая функция или (float, float), по умолчанию: значение xycoords: Система координат, в которой задано xybox. Подробное описание см. в параметре textcoords у Annotation.
frameonbool, по умолчанию: True: По умолчанию текст окружён белым FancyBboxPatch (доступен как атрибут patch у AnnotationBbox). Если frameon установлено в False, этот патч становится невидимым.
padfloat, по умолчанию: 0.4: Отступ вокруг offsetbox.
box_alignment(float, float): Кортеж из двух чисел для вертикального и горизонтального выравнивания offsetbox относительно boxcoords. Нижний левый угол — (0, 0), верхний правый — (1, 1).
**kwargs: Другие параметры идентичны Annotation.

свойствоanncoords

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

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

Параметры:

mouseeventmatplotlib.backend_bases.MouseEvent

Возвращает:

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

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

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

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

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

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

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

Параметры:

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

Возвращает:

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

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

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

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

Параметры:

figFigure

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

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

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

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

свойствоxyann

zorder=3

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

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

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

Аналогичен области рисования, за исключением того, что границы контейнера не задаются заранее, а вычисляются из области видимости (window extent) его дочерних элементов. Кроме того, границы дочерних элементов вычисляются в преобразованных координатах.

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

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

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

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

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

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

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

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

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

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[исходный код]

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

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

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

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

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

Параметры:

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

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

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

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

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

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

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

Базовые классы: 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()[исходный код]: Отключить обработчики событий.

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

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

Параметры:

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

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

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

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

get_extent(renderer)[исходный код]: Возвращает ширину, высоту, xdescent, ydescent поля.

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры:

rendererRendererBase подкласс

Возвращает:

width
height
xdescent
ydescent
список пар (xoffset, yoffset)

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

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

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

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

Базы: Artist

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

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

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

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

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

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

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

Параметры:

mouseeventmatplotlib.backend_bases.MouseEvent

Возвращает:

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

См. также

Artist.contains

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

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

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

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

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

Параметры:

rendererRendererBase подкласс

Возвращает:

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

get_offset(width, height, xdescent, ydescent, renderer)[исходный код]

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

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

Параметры:

width, height, xdescent, ydescent: Параметры размеров.
rendererRendererBase подкласс

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры:

padвещественное число, необязательно

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

sepвещественное число, необязательно

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

width, heightвещественное число, необязательно

Ширина и высота контейнерного поля в пикселях, вычисляются, если 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 — в пикселях.

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

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

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

classmatplotlib.offsetbox.PaddedBox(child, pad=None, *, draw_frame=False, patch_attrs=None)[исходный код]

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

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

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

Параметры:

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

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

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

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

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

Параметры:

rendererподкласс RendererBase

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

width
height
xdescent
ydescent
список пар (xoffset, yoffset)

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

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

Свойство	Описание
`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`	строка
`height`	вещественное число
`in_layout`	bool
`label`	объект
`mouseover`	bool
`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)[исходный код]

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

Bases: OffsetBox

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

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

Параметры:

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

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

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

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

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

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

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

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

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

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

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, 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`	булево значение
`clip_box`	`Bbox`
`clip_on`	булево значение
`clip_path`	Объект Patch или (Path, Transform) или None
`figure`	`Figure`
`gid`	строка
`height`	число с плавающей точкой
`in_layout`	булево значение
`label`	объект
`mouseover`	булево значение
`multilinebaseline`	неизвестно
`offset`	(число с плавающей точкой, число с плавающей точкой)
`path_effects`	`AbstractPathEffect`
`picker`	None или булево значение или число с плавающей точкой или вызываемая функция
`rasterized`	булево значение
`sketch_params`	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
`snap`	булево значение или None
`text`	неизвестно
`transform`	неизвестно
`url`	строка
`visible`	булево значение
`width`	число с плавающей точкой
`zorder`	число с плавающей точкой

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

Установить значение multilinebaseline.

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

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

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

Параметры:

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

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

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

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

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

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

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

Параметры:

rendererподкласс RendererBase

Возвращает:

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

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

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

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

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