matplotlib.patches.FancyBboxPatch

classmatplotlib.patches.FancyBboxPatch(xy, width, height, boxstyle='round', *, mutation_scale=1, mutation_aspect=1, **kwargs)[source]

Bases: Patch

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

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

Parameters:

xy(float, float)

Координаты левого нижнего угла рамки.

widthfloat

Ширина рамки.

heightfloat

Высота рамки.

boxstylestr или BoxStyle

Стиль закругленной рамки. Может быть экземпляром BoxStyle или строкой вида "ИмяСтиля, атрибут1=значение1, атрибут2=значение2" (например, "Round, pad=0.2"). Строка передаётся в BoxStyle для создания объекта BoxStyle. Полная документация находится там.

Доступны следующие стили рамки:

Класс	Имя	Атрибуты
Square	square	pad=0.3
Circle	circle	pad=0.3
Ellipse	ellipse	pad=0.3
LArrow	larrow	pad=0.3
RArrow	rarrow	pad=0.3
DArrow	darrow	pad=0.3
Round	round	pad=0.3, rounding_size=None
Round4	round4	pad=0.3, rounding_size=None
Sawtooth	sawtooth	pad=0.3, tooth_size=None
Roundtooth	roundtooth	pad=0.3, tooth_size=None

mutation_scalefloat, по умолчанию: 1

Множитель, применяемый к атрибутам стиля рамки (например, pad или rounding_size).

mutation_aspectfloat, по умолчанию: 1

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

Other Parameters:

**kwargsPatch свойства

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

get_bbox()[source]

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

get_boxstyle()[source]

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

get_height()[source]

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

get_mutation_aspect()[source]

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

get_mutation_scale()[source]

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

get_path()[source]

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

get_width()[source]

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

get_x()[source]

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

get_y()[source]

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, bounds=<UNSET>, boxstyle=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, height=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, mutation_aspect=<UNSET>, mutation_scale=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)[source]

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

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

Свойство	Описание
agg_filter	функция фильтра, принимающая массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращающая массив чисел с плавающей точкой (m, n, 3) и два смещения от левого нижнего угла изображения
alpha	скаляр или None
animated	bool
antialiased или aa	bool или None
bounds	неизвестно
boxstyle	[ 'square' | 'circle' | 'ellipse' | 'larrow' | 'rarrow' | 'darrow' | 'round' | 'round4' | 'sawtooth' | 'roundtooth' ]
capstyle	CapStyle или {'butt', 'projecting', 'round'}
clip_box	BboxBase или None
clip_on	bool
clip_path	Объект Patch или (объект Path, преобразование) или None
color	цвет
edgecolor или ec	цвет или None
facecolor или fc	цвет или None
figure	Figure
fill	bool
gid	строка
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
height	вещественное число
in_layout	bool
joinstyle	JoinStyle или {'miter', 'round', 'bevel'}
label	объект
linestyle или ls	{'-', '--', '-.', ':', '', (смещение, последовательность вкл/выкл), ...}
linewidth или lw	вещественное число или None
mouseover	bool
mutation_aspect	вещественное число
mutation_scale	вещественное число
path_effects	список AbstractPathEffect
picker	None или bool или вещественное число или вызываемая функция
rasterized	bool
sketch_params	(масштаб: вещественное число, длина: вещественное число, случайность: вещественное число)
snap	bool или None
transform	Transform
url	строка
visible	bool
width	вещественное число
x	вещественное число
y	вещественное число
zorder	вещественное число

set_bounds(*args)[source]

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

Возможные сигнатуры вызова:

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

Параметры:

left, bottomfloat

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

width, heightfloat

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

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

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

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

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

Параметры:

boxstylestr или BoxStyle

Стиль рамки: либо экземпляр BoxStyle, либо строка, содержащая имя стиля и необязательные разделенные запятыми атрибуты (например, "Round,pad=0.2"). Такая строка используется для построения объекта BoxStyle, как описано в этом классе.

Доступные стили рамок:

Класс	Имя	Атрибуты
Square	square	pad=0.3
Circle	circle	pad=0.3
Ellipse	ellipse	pad=0.3
LArrow	larrow	pad=0.3
RArrow	rarrow	pad=0.3
DArrow	darrow	pad=0.3
Round	round	pad=0.3, rounding_size=None
Round4	round4	pad=0.3, rounding_size=None
Sawtooth	sawtooth	pad=0.3, tooth_size=None
Roundtooth	roundtooth	pad=0.3, tooth_size=None

**kwargs

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

Примеры

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

set_height(h)[source]

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

Параметры:

hfloat

set_mutation_aspect(aspect)[source]

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

Параметры:

aspectfloat

set_mutation_scale(scale)[source]

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

Параметры:

scalefloat

set_width(w)[source]

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

Параметры:

wfloat

set_x(x)[source]

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

Параметры:

xfloat

set_y(y)[source]

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

Параметры:

yfloat

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

Справочник по элементам Matplotlib

Справочник по элементам Matplotlib

Рисование фигурных рамок

Рисование фигурных рамок

Аннотация текста со стрелкой

Аннотация текста со стрелкой