matplotlib.patches.FancyBboxPatch

classmatplotlib.patches.FancyBboxPatch(xy, width, height, boxstyle='round', *, mutation_scale=1, mutation_aspect=1, **kwargs)[исходный код]

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

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

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

Параметры:

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

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

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

**kwargsсвойства Patch

Свойство	Описание
agg_filter	функция фильтрации, принимающая массив чисел с плавающей точкой размером (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 или SubFigure
fill	bool
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
hatch_linewidth	неизвестно
in_layout	bool
joinstyle	JoinStyle или {'miter', 'round', 'bevel'}
label	object
linestyle или ls	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth или lw	float или None
mouseover	bool
path_effects	список объектов AbstractPathEffect
picker	None или bool или float или callable
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
transform	Transform
url	str
visible	bool
zorder	float

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

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

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

Возвращает объект стиля рамки.

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

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

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

Возвращает соотношение сторон при изменении рамки.

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

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

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

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

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

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

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

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

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

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

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

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

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

Свойство	Описание
agg_filter	функция фильтрации, принимающая массив чисел с плавающей точкой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от левого нижнего угла изображения
alpha	float или 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 или SubFigure
fill	bool
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
hatch_linewidth	неизвестно
height	float
in_layout	bool
joinstyle	JoinStyle или {'miter', 'round', 'bevel'}
label	object
linestyle или ls	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth или lw	float или None
mouseover	bool
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	str
visible	bool
width	float
x	float
y	float
zorder	float

set_bounds(*args)[исходный код]

Задать границы прямоугольника.

Варианты вызова:

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

Параметры:

left, bottomfloat

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

width, heightfloat

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

set_boxstyle(boxstyle=None, **kwargs)[исходный код]

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

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

Если аргумент не указан (или указан 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)[исходный код]

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

Параметры:

hfloat

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

Задать соотношение сторон при преобразовании bbox.

Параметры:

aspectfloat

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

Задать масштаб преобразования.

Параметры:

scalefloat

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

Задать ширину прямоугольника.

Параметры:

wfloat

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

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

Параметры:

xfloat

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

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

Параметры:

yfloat

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

Справочник по художественным объектам Matplotlib

Справочник по художественным объектам Matplotlib

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

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