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 or BoxStyle

Стиль фанси рамки. Это может быть экземпляр BoxStyle или строка со стилем и необязательными разделенными запятыми атрибутами (например, "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, default: 1

Коэффициент масштабирования, применяемый к атрибутам стиля рамки (например, pad или rounding_size).

mutation_aspectfloat, default: 1

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

Other Parameters:

**kwargsPatch свойства

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

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, Transform) или 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 или float или вызываемый объект
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	pad=0.3
Круг	circle	pad=0.3
Эллипс	ellipse	pad=0.3
Стрелка влево	larrow	pad=0.3
Стрелка вправо	rarrow	pad=0.3
Двусторонняя стрелка	darrow	pad=0.3
Округлый	round	pad=0.3, rounding_size=None
Округлый4	round4	pad=0.3, rounding_size=None
Пилообразный	sawtooth	pad=0.3, tooth_size=None
Округлый пилообразный	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

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

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

Комментирование текстовой стрелки

Комментирование текстовой стрелки