Spec-Zone.ru › Matplotlib 3.6

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

square

pad=0.3

Circle

circle

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

bool

antialiased или aa

bool или None

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

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или ls

{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

linewidth или lw

float или None

mouseover

bool

path_effects

AbstractPathEffect

picker

None или bool или float или вызываемый объект

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool или None

transform

Transform

url

строка

visible

bool

zorder

float

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]
END_OF_DOCUMENT_MARKER

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство

Описание

agg_filter

функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив и два смещения от нижнего левого угла изображения

alpha

скаляр или None

animated

bool

antialiased или aa

bool или None

bounds

неизвестно

boxstyle

[ 'square' | 'circle' | '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

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

height

число с плавающей точкой

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или ls

{'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения), ...}

linewidth или lw

число с плавающей точкой или None

mouseover

bool

mutation_aspect

число с плавающей точкой

mutation_scale

число с плавающей точкой

path_effects

AbstractPathEffect

picker

None или bool или число с плавающей точкой или вызываемая функция

rasterized

bool

sketch_params

(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)

snap

bool или None

transform

Transform

url

строка

visible

bool

width

число с плавающей точкой

x

число с плавающей точкой

y

число с плавающей точкой

zorder

число с плавающей точкой

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

square

pad=0.3

Circle

circle

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

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

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

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

Подпись текста стрелкой

Подпись текста стрелкой

© 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

Spec-Zone.ru

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