matplotlib.patches.FancyBboxPatch
- classmatplotlib.patches.FancyBboxPatch(xy, width, height, boxstyle='round', bbox_transmuter=<deprecated parameter>, *, mutation_scale=1, mutation_aspect=1, **kwargs)[source]
-
Bases:
PatchФантазийная рамка вокруг прямоугольника с нижним левым углом в xy = (x, y) заданной шириной и высотой.
FancyBboxPatchпохожа наRectangle, но она рисует декоративную рамку вокруг прямоугольника. Преобразование прямоугольной рамки в декоративную рамку делегируется классам стилей, определённым вBoxStyle.
- Параметры:
-
- xyfloat, float
-
Координаты левого нижнего угла прямоугольника.
- widthfloat
-
Ширина прямоугольника.
- heightfloat
-
Высота прямоугольника.
-
boxstylestr или
matplotlib.patches.BoxStyle -
Стиль рамки. Может быть экземпляром
BoxStyleили строкой, содержащей имя стиля и, необязательно, разделенные запятыми атрибуты (например, "Round, pad=0.2"). Эта строка передается вBoxStyleдля создания объектаBoxStyle. Полная документация находится там.Доступные стили рамок:
Класс
Имя
Атрибуты
Square
squarepad=0.3
Circle
circlepad=0.3
LArrow
larrowpad=0.3
RArrow
rarrowpad=0.3
DArrow
darrowpad=0.3
Round
roundpad=0.3, rounding_size=None
Round4
round4pad=0.3, rounding_size=None
Sawtooth
sawtoothpad=0.3, tooth_size=None
Roundtooth
roundtoothpad=0.3, tooth_size=None
- mutation_scalefloat, по умолчанию: 1
-
Коэффициент масштабирования, применяемый к атрибутам стиля рамки (например, pad или rounding_size).
- mutation_aspectfloat, по умолчанию: 1
-
Высота прямоугольника будет уменьшена на этот коэффициент до изменения, а изменённый прямоугольник будет увеличен в обратной пропорции. Например, это позволяет задавать разное горизонтальное и вертикальное отступы.
- Другие параметры:
-
-
**kwargs
Patchсвойства -
Свойство
Описание
функция фильтра, которая принимает массив (m, n, 3) с плавающей запятой и значение dpi, и возвращает массив (m, n, 3) и два смещения от левого нижнего угла изображения
неизвестно
bool
antialiasedили aabool или None
CapStyleили {'butt', 'projecting', 'round'}bool
Объект Patch или (Path, Transform) или None
цвет
edgecolorили ecцвет или None
facecolorили fcцвет или None
bool
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidthили lwfloat или None
bool
None или bool или float или вызываемый объект
bool
(scale: float, length: float, randomness: float)
bool или None
строка
bool
float
-
**kwargs
- 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]
-
Установить сразу несколько свойств.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив и два смещения от нижнего левого угла изображения
скаляр или None
bool
antialiasedили aabool или None
неизвестно
[ 'square' | 'circle' | 'larrow' | 'rarrow' | 'darrow' | 'round' | 'round4' | 'sawtooth' | 'roundtooth' ]
CapStyleили {'butt', 'projecting', 'round'}bool
Patch или (Path, Transform) или None
цвет
edgecolorили ecцвет или None
facecolorили fcцвет или None
bool
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
число с плавающей точкой
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили ls{'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения), ...}
linewidthили lwчисло с плавающей точкой или None
bool
число с плавающей точкой
число с плавающей точкой
None или bool или число с плавающей точкой или вызываемая функция
bool
(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
bool или None
строка
bool
число с плавающей точкой
число с плавающей точкой
число с плавающей точкой
число с плавающей точкой
- 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, как документировано в этом классе.Доступны следующие стили рамок:
Класс
Имя
Атрибуты
Square
squarepad=0.3
Circle
circlepad=0.3
LArrow
larrowpad=0.3
RArrow
rarrowpad=0.3
DArrow
darrowpad=0.3
Round
roundpad=0.3, rounding_size=None
Round4
round4pad=0.3, rounding_size=None
Sawtooth
sawtoothpad=0.3, tooth_size=None
Roundtooth
roundtoothpad=0.3, tooth_size=None
- **kwargs
-
Дополнительные атрибуты для стиля рамки. Смотрите таблицу выше для поддерживаемых параметров.
-
boxstylestr или
Примеры
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
© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.6.0/api/_as_gen/matplotlib.patches.FancyBboxPatch.html