Spec-Zone.ru › Matplotlib 3.1

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, но она рисует декоративную рамку вокруг прямоугольника. Преобразование прямоугольника в декоративную рамку делегируется классу BoxTransmuterBase и его производным классам.

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

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

width : float

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

height : float

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

boxstyle : str 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_scale : float, optional, default: 1

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

mutation_aspect : float, optional

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

Другие параметры:
**kwargs : Patch properties
Свойство Описание
agg_filter функция фильтра, которая принимает (m, n, 3) массив float и значение dpi, и возвращает (m, n, 3) массив
alpha float или None
animated bool
antialiased или aa неизвестно
capstyle {'butt', 'round', 'projecting'}
clip_box Bbox
clip_on bool
clip_path [(Path, Transform) | Patch | 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 число с плавающей точкой или None
path_effects AbstractPathEffect
picker None или bool или число с плавающей точкой или вызываемый объект
rasterized bool или None
sketch_params (масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
snap bool или None
transform Transform
url строка
visible bool
zorder число с плавающей точкой
get_bbox(self) [source]

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

get_boxstyle(self) [source]

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

get_height(self) [source]

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

get_mutation_aspect(self) [source]

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

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, bottom : float

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

width, height : float

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

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

Устанавливает стиль рамки.

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

set_boxstyle("round,pad=0.2")
set_boxstyle("round", pad=0.2)

Старые атрибуты просто игнорируются.

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

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

Класс Имя Атрибуты
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

ПРИНИМАЕТ: [ 'circle' | 'darrow' | 'larrow' | 'rarrow' | 'round' | 'round4' | 'roundtooth' | 'sawtooth' | 'square' ]

set_height(self, h) [source]

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

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

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

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

Устанавливает масштаб изменения.

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

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

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

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

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

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

Параметры:
y : float

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

../../_images/sphx_glr_artist_reference_thumb.png

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

../../_images/sphx_glr_fancybox_demo_thumb.png

Пример Fancybox

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

Spec-Zone.ru

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