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.

Параметры:

xy(float, float)

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

widthfloat

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

heightfloat

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

boxstyleстрока или 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, по умолчанию: 1

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

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

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

Дополнительные параметры:

**kwargsPatch свойства

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	неизвестно
animated	логическое значение
antialiased или aa	логическое значение или None
capstyle	CapStyle или {'butt', 'projecting', 'round'}
clip_box	Bbox
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	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	{'-', '--', '-.', ':', '', (смещение, последовательность вкл.-выкл), ...}
linewidth или lw	float или None
mouseover	bool
mutation_aspect	float
mutation_scale	float
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемая функция
rasterized	bool
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
transform	Transform
url	str
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 или 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

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

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

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

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