Spec-Zone.ru › Matplotlib 3.2

matplotlib.patches.FancyBboxPatch

class matplotlib.patches.FancyBboxPatch(xy, width, height, boxstyle='round', bbox_transmuter=None, mutation_scale=1.0, mutation_aspect=None, **kwargs) [source]

Bases: matplotlib.patches.Patch

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

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

Параметры:
xyfloat, float

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

widthfloat

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

heightfloat

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

boxstylestr or matplotlib.patches.BoxStyle

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

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

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

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

mutation_aspectfloat, optional

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

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

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

get_boxstyle(self) [source]

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

get_height(self) [source]

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

get_mutation_aspect(self) [source]

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

get_mutation_scale(self) [source]

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

get_path(self) [source]

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

get_width(self) [source]

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

get_x(self) [source]

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

get_y(self) [source]

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

set_bounds(self, *args) [source]

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

Подписи вызова:

set_bounds(left, bottom, width, height)
set_bounds((left, bottom, width, height))
Параметры:
left, bottomfloat

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

width, heightfloat

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

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

Устанавливает стиль box.

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

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

Параметры:
boxstylestr

Имя стиля box. Дополнительно, может следовать запятая и список атрибутов, разделённых запятыми. Атрибуты также могут быть переданы по отдельности как ключевые аргументы.

Доступны следующие стили box:

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

Дополнительные атрибуты для стиля box. См. таблицу выше для поддерживаемых параметров.

Примеры

set_boxstyle("round,pad=0.2")
set_boxstyle("round", pad=0.2)
set_height(self, h) [source]

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

Параметры:
hfloat
set_mutation_aspect(self, aspect) [source]

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

Параметры:
aspectfloat
set_mutation_scale(self, scale) [source]

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

Параметры:
scalefloat
set_width(self, w) [source]

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

Параметры:
wfloat
set_x(self, x) [source]

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

Параметры:
xfloat
set_y(self, y) [source]

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

Параметры:
yfloat

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

Reference for Matplotlib artists

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

Drawing fancy boxes

Рисование декоративных прямоугольников

Annotate Text Arrow

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

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.2.2/api/_as_gen/matplotlib.patches.FancyBboxPatch.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API