matplotlib.patches.Patch

class matplotlib.patches.Patch(edgecolor=None, facecolor=None, color=None, linewidth=None, linestyle=None, antialiased=None, hatch=None, fill=True, capstyle=None, joinstyle=None, **kwargs) [source]

Bases: matplotlib.artist.Artist

Объект Patch — это 2D-объект с цветом заливки и цветом обводки.

Если любой из параметров edgecolor, facecolor, linewidth или antialiased равен None, они принимают значения по умолчанию из rc параметров.

Поддерживаются следующие параметры-свойства:

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

contains(self, mouseevent, radius=None) [source]

Проверка, произошёл ли щелчок мыши внутри объекта Patch.

Возвращает:	(булево значение, пустой словарь)

contains_point(self, point, radius=None) [source]

Возвращает True если заданная точка находится внутри пути (преобразована с помощью его атрибута transform).

radius позволяет сделать путь немного больше или меньше.

contains_points(self, points, radius=None) [source]

Возвращает массив bool, который True если (закрытый) путь содержит соответствующую точку. (преобразована с помощью его атрибута transform).

points должен быть массивом Nx2. radius позволяет сделать путь немного больше или меньше.

draw(self, renderer) [source]

Отрисовать Patch в заданном renderer.

fill

возвращает, установлена ли заливка

get_aa(self)

Псевдоним для get_antialiased.

get_antialiased(self) [source]

Возвращает True, если Patch должна быть нарисована с сглаживанием.

get_capstyle(self) [source]

Возвращает текущую стилизацию концов.

get_data_transform(self) [source]

Возвращает экземпляр Transform, который отображает координаты данных в физические координаты.

get_ec(self)

Псевдоним для get_edgecolor.

get_edgecolor(self) [source]

Возвращает цвет обводки Patch.

get_extents(self) [source]

Возвращает объект Bbox, определяющий прямоугольные границы Patch.

get_facecolor(self) [source]

Возвращает цвет заливки Patch.

get_fc(self)

Псевдоним для get_facecolor.

get_fill(self) [source]

возвращает, установлена ли заливка

get_hatch(self) [source]

Возвращает текущий узор штриховки.

get_joinstyle(self) [source]

Возвращает текущий стиль соединения.

get_linestyle(self) [source]

Возвращает стиль линии.

get_linewidth(self) [source]

Возвращает ширину линии в пунктах.

get_ls(self)

Псевдоним для get_linestyle.

get_lw(self)

Псевдоним для get_linewidth.

get_patch_transform(self) [source]

Возвращает экземпляр Transform, который преобразует координаты фигуры в координаты данных.

Например, можно определить фигуру окружности, представляющую радиус 5, предоставив координаты единичной окружности и преобразование, которое масштабирует координаты (координаты фигуры) на 5.

get_path(self) [source]

Возвращает путь этой фигуры.

get_transform(self) [source]

Возвращает Transform, применённый к Patch.

get_verts(self) [source]

Возвращает копию вершин, используемых в этой фигуре.

Если фигура содержит кривые Безье, кривые будут интерполированы линейными сегментами. Чтобы получить доступ к кривым как кривым, используйте get_path().

get_window_extent(self, renderer=None) [source]

Получение прямоугольника области осей в пространстве отображения.

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

Подклассы должны переопределять для включения в вычисление прямоугольника "tight". По умолчанию возвращается пустой прямоугольник в точке 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновляются, если область отображения объекта-художника изменилась. Область может измениться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но будут сохранены неправильно.

set_aa(self, aa)

Псевдоним для set_antialiased.

set_alpha(self, alpha) [source]

Устанавливает прозрачность заливки фигуры.

Параметры:	alpha : float or None

set_antialiased(self, aa) [source]

Устанавливает, использовать ли антиалиасинг.

Параметры:	b : bool or None

set_capstyle(self, s) [source]

Устанавливает стиль окончания линии.

Параметры:	s : {'butt', 'round', 'projecting'}

set_color(self, c) [source]

Устанавливает и цвет обводки и цвет заливки.

Параметры:	c : color

См. также

Patch.set_facecolor, Patch.set_edgecolor

Для установки цвета обводки или заливки индивидуально.

set_ec(self, color)

Псевдоним для set_edgecolor.

set_edgecolor(self, color) [source]

Устанавливает цвет обводки фигуры.

Параметры:	color : color or None or 'auto'

set_facecolor(self, color) [source]

Установите цвет заливки фигуры.

Параметры:	color : color or None

set_fc(self, color)

Псевдоним для set_facecolor.

set_fill(self, b) [source]

Установить, закрашивать ли фигуру.

Параметры:	b : bool

set_hatch(self, hatch) [source]

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут комбинироваться, в этом случае выполняются все указанные типы штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого типа.

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

Параметры:	hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_joinstyle(self, s) [source]

Установить стиль соединения.

Параметры:	s : {'miter', 'round', 'bevel'}

set_linestyle(self, ls) [source]

Установить стиль линии фигуры.

linestyle	описание
'-' или 'solid'	сплошная линия
'--' или 'dashed'	штриховая линия
'-.' или 'dashdot'	штрихпунктирная линия
':' или 'dotted'	пунктирная линия

В качестве альтернативы можно указать кортеж штрихов в следующем формате:

(offset, onoffseq),

где onoffseq - кортеж чётной длины, задающий длительность включения и выключения чернил в пунктах.

Параметры:	ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...} Стиль линии.

set_linewidth(self, w) [source]

Установить ширину линии фигуры в пунктах.

Параметры:	w : float or None

set_ls(self, ls)

Псевдоним для set_linestyle.

set_lw(self, w)

Псевдоним для set_linewidth.

update_from(self, other) [source]

Обновляет данный Patch из свойств other.

validCap = ('butt', 'round', 'projecting')

validJoin = ('miter', 'round', 'bevel')

zorder = 1

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

Создание пользовательских легенд

Руководство по легендам