matplotlib.patches.FancyBboxPatch
- class
matplotlib.patches.FancyBboxPatch(xy, width, height, boxstyle='round', bbox_transmuter=<deprecated parameter>, mutation_scale=1, mutation_aspect=1, **kwargs)[source] -
Основывается на
matplotlib.patches.PatchФантазийная рамка вокруг прямоугольника с левым нижним углом в xy = (x, y) с заданной шириной и высотой.
FancyBboxPatchпохожа наRectangle, но рисует фантaзийную рамку вокруг прямоугольника. Преобразование прямоугольника в фантaзийную рамку делегируется классам стилей, определённым вBoxStyle.
Параметры: - xyfloat, float
-
Левый нижний угол прямоугольника.
- widthfloat
-
Ширина прямоугольника.
- heightfloat
-
Высота прямоугольника.
-
boxstylestr или
matplotlib.patches.BoxStyle -
Стиль замысловатого прямоугольника. Это может быть экземпляр
BoxStyleили строка со стилем и, необязательно, с запятыми, разделенными атрибутами (например, "Round, pad=0.2"). Эта строка передается вBoxStyleдля построения объектаBoxStyle. Полная документация представлена там.Доступны следующие стили прямоугольников:
Класс Имя Атрибуты Circle circlepad=0.3 DArrow darrowpad=0.3 LArrow larrowpad=0.3 RArrow rarrowpad=0.3 Round roundpad=0.3, rounding_size=None Round4 round4pad=0.3, rounding_size=None Roundtooth roundtoothpad=0.3, tooth_size=None Sawtooth sawtoothpad=0.3, tooth_size=None Square squarepad=0.3 - mutation_scalefloat, по умолчанию: 1
-
Множитель масштаба, применяемый к атрибутам стиля прямоугольника (например, pad или rounding_size).
- mutation_aspectfloat, по умолчанию: 1
-
Высота прямоугольника будет сжата на это значение перед мутацией, а мутированный прямоугольник будет растянут в обратном отношении. Например, это позволяет задавать разный горизонтальный и вертикальный отступ.
Другие параметры: -
**kwargs
Patchсвойства -
Свойство Описание agg_filterфункция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив alphaскаляр или None animatedbool antialiasedили aaнеизвестно capstyleCapStyleили {'butt', 'projecting', 'round'}clip_boxBboxclip_onbool clip_pathPatch или (Path, Transform) или None colorцвет containsнеизвестно edgecolorили ecцвет или None или 'auto' facecolorили fcцвет или None figureFigurefillbool gidстрока hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layoutbool joinstyleJoinStyleили {'miter', 'round', 'bevel'}labelобъект linestyleили ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthили lwчисло с плавающей точкой или None path_effectsAbstractPathEffectpickerNone или bool или число с плавающей точкой или вызываемый объект rasterizedbool sketch_params(scale: float, length: float, randomness: float) snapbool или None transformTransformurlстрока visiblebool zorderчисло с плавающей точкой
-
__init__(xy, width, height, boxstyle='round', bbox_transmuter=<deprecated parameter>, mutation_scale=1, mutation_aspect=1, **kwargs)[source] -
Параметры: - xyfloat, float
-
Левый нижний угол прямоугольника.
- widthfloat
-
Ширина прямоугольника.
- heightfloat
-
Высота прямоугольника.
-
boxstyleстрока или
matplotlib.patches.BoxStyle -
Стиль рамки. Может быть объектом
BoxStyleили строкой вида "Round, pad=0.2", где имя стиля и необязательные атрибуты разделяются запятыми. Эта строка передаётся вBoxStyleдля создания объектаBoxStyle. Полное описание смотрите там.Доступны следующие стили рамок:
Класс Имя Атрибуты Circle circlepad=0.3 DArrow darrowpad=0.3 LArrow larrowpad=0.3 RArrow rarrowpad=0.3 Round roundpad=0.3, rounding_size=None Round4 round4pad=0.3, rounding_size=None Roundtooth roundtoothpad=0.3, tooth_size=None Sawtooth sawtoothpad=0.3, tooth_size=None Square squarepad=0.3 - mutation_scalefloat, по умолчанию: 1
-
Коэффициент масштабирования, применяемый к атрибутам стиля рамки (например, pad или rounding_size).
- mutation_aspectfloat, по умолчанию: 1
-
Высота прямоугольника будет сжата на этот коэффициент перед мутацией, а изменённый прямоугольник будет растянут в обратном соотношении. Например, это позволяет задавать разные отступы по горизонтали и вертикали.
Другие параметры: -
**kwargs
Patchсвойства -
Свойство Описание
-
__module__= 'matplotlib.patches'
-
-
__str__()[source] -
Возвращает str(self).
-
get_bbox()[source] -
Возвращает
Bbox.
-
get_boxstyle()[source] -
Возвращает объект boxstyle.
-
get_height()[source] -
Возвращает высоту прямоугольника.
-
get_mutation_aspect()[source] -
Возвращает коэффициент масштабирования мутации bbox.
-
get_mutation_scale()[source] -
Возвращает масштаб мутации.
-
get_path()[source] -
Возвращает изменённый путь прямоугольника.
-
get_width()[source] -
Возвращает ширину прямоугольника.
-
get_x()[source] -
Возвращает левую координату прямоугольника.
-
get_y()[source] -
Возвращает нижнюю координату прямоугольника.
-
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 -
Стиль fancy рамки. Может быть экземпляром
BoxStyleили строкой со стилем имени и, необязательно, запятыми атрибутами (например, "Round, pad=0.2"). Эта строка передаётся вBoxStyleдля построения объектаBoxStyle. См. подробную документацию там.Доступны следующие стили рамок:
Класс Имя Атрибуты Circle circlepad=0.3 DArrow darrowpad=0.3 LArrow larrowpad=0.3 RArrow rarrowpad=0.3 Round roundpad=0.3, rounding_size=None Round4 round4pad=0.3, rounding_size=None Roundtooth roundtoothpad=0.3, tooth_size=None Sawtooth sawtoothpad=0.3, tooth_size=None Square squarepad=0.3 - **kwargs
-
Дополнительные атрибуты для стиля рамки. См. таблицу выше для поддерживаемых параметров.
Примеры
set_boxstyle("round,pad=0.2") set_boxstyle("round", pad=0.2) -
boxstylestr или
-
set_height(h)[source] -
Устанавливает высоту прямоугольника.
Параметры: - hfloat
-
set_mutation_aspect(aspect)[source] -
Устанавливает коэффициент масштабирования мутации bbox.
Параметры: - 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
END_OF_DOCUMENT_MARKER
```
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/_as_gen/matplotlib.patches.FancyBboxPatch.html