matplotlib.patches.FancyBboxPatch

class matplotlib.patches.FancyBboxPatch(xy, width, height, boxstyle='round', bbox_transmuter=None, mutation_scale=1.0, mutation_aspect=None, **kwargs) [source]

Bases: matplotlib.patches.Patch

Прямоугольник с заливкой, в левом нижнем углу которого находятся координаты xy = (x, y) и заданными шириной и высотой.

FancyBboxPatch аналогичен Rectangle, но он рисует декоративную рамку вокруг прямоугольника. Преобразование прямоугольника в декоративную рамку делегируется классам стилей, определенным в BoxStyle.

Параметры:

xyfloat, float Левый нижний угол прямоугольника. widthfloat Ширина прямоугольника. heightfloat Высота прямоугольника. boxstylestr or matplotlib.patches.BoxStyle Стиль декоративной рамки. Может быть экземпляром BoxStyle или строкой, содержащей имя стиля и, необязательно, разделенные запятыми атрибуты (например, "Round, pad=0.2"). Эта строка передается в BoxStyle для построения объекта BoxStyle. Полная документация приведена там. Доступны следующие стили рамок: Класс Имя Атрибуты Circle circle pad=0.3 DArrow darrow pad=0.3 LArrow larrow pad=0.3 RArrow rarrow pad=0.3 Round round pad=0.3, rounding_size=None Round4 round4 pad=0.3, rounding_size=None Roundtooth roundtooth pad=0.3, tooth_size=None Sawtooth sawtooth pad=0.3, tooth_size=None Square square pad=0.3 mutation_scalefloat, default: 1 Коэффициент масштабирования, применяемый к атрибутам стиля рамки (например, pad или rounding_size). mutation_aspectfloat, optional Высота прямоугольника будет сжата на это значение перед изменением, а измененный прямоугольник будет растянут в обратной пропорции. Например, это позволяет задавать разный горизонтальный и вертикальный отступ.

Другие параметры:

**kwargsPatch properties Свойство Описание agg_filter функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3) alpha float или None animated bool antialiased или aa неизвестно capstyle {'butt', 'round', 'projecting'} clip_box Bbox clip_on bool clip_path Patch или (Path, Transform) или None color цвет contains неизвестно edgecolor или ec цвет или None или 'auto' facecolor или fc цвет или None figure Figure fill bool gid строка hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layout bool joinstyle {'miter', 'round', 'bevel'} label объект linestyle или ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidth или lw float или None path_effects AbstractPathEffect picker None или bool или вызываемый объект rasterized bool или None sketch_params (scale: float, length: float, randomness: float) snap bool или None transform Transform url строка visible bool zorder float

__init__(self, xy, width, height, boxstyle='round', bbox_transmuter=None, mutation_scale=1.0, mutation_aspect=None, **kwargs) [source]

Параметры:

xyfloat, float Левый нижний угол прямоугольника. widthfloat Ширина прямоугольника. heightfloat Высота прямоугольника. boxstylestr or matplotlib.patches.BoxStyle Стиль рамки. Может быть экземпляром BoxStyle или строкой, содержащей имя стиля и, необязательно, запятыми разделенными атрибутами (например, "Round, pad=0.2"). Эта строка передаётся в BoxStyle для создания объекта BoxStyle. Полная документация приведена там. Доступны следующие стили рамок: Класс Название Атрибуты Circle circle pad=0.3 DArrow darrow pad=0.3 LArrow larrow pad=0.3 RArrow rarrow pad=0.3 Round round pad=0.3, rounding_size=None Round4 round4 pad=0.3, rounding_size=None Roundtooth roundtooth pad=0.3, tooth_size=None Sawtooth sawtooth pad=0.3, tooth_size=None Square square pad=0.3 mutation_scalefloat, default: 1 Коэффициент масштабирования, применяемый к атрибутам стиля рамки (например, pad или rounding_size). mutation_aspectfloat, optional Высота прямоугольника будет сжата на это значение до изменения, а изменённый прямоугольник будет растянут в обратной пропорции. Это позволяет, например, установить разные горизонтальные и вертикальные отступы.

Другие параметры:

**kwargsPatch properties Свойство Описание agg_filter функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3) alpha float или None animated bool antialiased или aa неизвестно capstyle {'butt', 'round', 'projecting'} clip_box Bbox clip_on bool clip_path Patch или (Path, Transform) или None color цвет contains неизвестно edgecolor или ec цвет или None или 'auto' facecolor или fc цвет или None figure Figure fill bool gid строка hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layout bool joinstyle {'miter', 'round', 'bevel'} label объект linestyle или ls {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения), ...} linewidth или lw float или None path_effects AbstractPathEffect picker None или bool или вызываемый объект rasterized bool или None sketch_params (масштаб: float, длина: float, случайность: float) snap bool или None transform Transform url строка visible bool zorder float

__module__ = 'matplotlib.patches'

__str__(self) [source]

Возвращает str(self).

get_bbox(self) [source]

Возвращает Bbox.

get_boxstyle(self) [source]

Возвращает объект boxstyle.

get_height(self) [source]

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

get_mutation_aspect(self) [source]

Возвращает коэффициент масштабирования мутации bbox.

get_mutation_scale(self) [source]

Возвращает масштаб мутации.

get_path(self) [source]

Возвращает изменённый путь прямоугольника.

get_width(self) [source]

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

get_x(self) [source]

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

get_y(self) [source]

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

set_bounds(self, *args) [source]

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

Подписи вызова:

set_bounds(left, bottom, width, height)
set_bounds((left, bottom, width, height))

Параметры:	left, bottomfloat Координаты левого нижнего угла прямоугольника. width, heightfloat Ширина/высота прямоугольника.

set_boxstyle(self, boxstyle=None, **kwargs) [source]

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

Большинство стилей рамки могут быть дополнительно настроены с помощью атрибутов. Атрибуты из предыдущего стиля рамки не используются повторно.

Без аргумента (или с boxstyle=None) возвращаются доступные стили рамки в читаемом для человека виде.

Параметры:

boxstylestr Имя стиля рамки. После запятой необязательно можно указать список атрибутов через запятую. Атрибуты могут быть переданы отдельно в качестве ключевых аргументов. Доступные стили рамки: Класс Имя Атрибуты Circle circle pad=0.3 DArrow darrow pad=0.3 LArrow larrow pad=0.3 RArrow rarrow pad=0.3 Round round pad=0.3, rounding_size=None Round4 round4 pad=0.3, rounding_size=None Roundtooth roundtooth pad=0.3, tooth_size=None Sawtooth sawtooth pad=0.3, tooth_size=None Square square pad=0.3 **kwargs Дополнительные атрибуты для стиля рамки. См. таблицу выше для поддерживаемых параметров.

Примеры

set_boxstyle("round,pad=0.2")
set_boxstyle("round", pad=0.2)

set_height(self, h) [source]

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

Параметры:	hfloat

set_mutation_aspect(self, aspect) [source]

Устанавливает коэффициент масштабирования мутации bbox.

Параметры:	aspectfloat

set_mutation_scale(self, scale) [source]

Устанавливает масштаб мутации.

Параметры:	scalefloat

set_width(self, w) [source]

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

Параметры:	wfloat

set_x(self, x) [source]

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

Параметры:	xfloat

set_y(self, y) [source]

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

Параметры:	yfloat

Примеры использования matplotlib.patches.FancyBboxPatch

Ссылка на элементы Matplotlib

Рисование декоративных рамок

Текст с стрелкой