matplotlib.patches.FancyBboxPatch

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

Bases: matplotlib.patches.Patch

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

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

Параметры

xyfloat, float

Левый нижний угол прямоугольника.

widthfloat

Ширина прямоугольника.

heightfloat

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

boxstylestr или matplotlib.patches.BoxStyle

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

Доступны следующие стили прямоугольников:

Класс	Имя	Атрибуты
Square	square	pad=0.3
Circle	circle	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

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

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

**kwargsPatch свойства

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

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 или matplotlib.patches.BoxStyle

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

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

Класс	Имя	Атрибуты
Square	square	pad=0.3
Circle	circle	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