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

A patch is a 2D artist with a face color and an edge color.

If any of edgecolor, facecolor, linewidth, or antialiased are None, they default to their rc params setting.

The following kwarg properties are supported

Property	Description
`agg_filter`	a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
`alpha`	float or None
`animated`	bool
`antialiased` or aa	unknown
`capstyle`	{'butt', 'round', 'projecting'}
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`color`	color
`contains`	unknown
`edgecolor` or ec	цвет или None или 'auto'
`facecolor` or fc	цвет или None
`figure`	`Figure`
`fill`	bool
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	{'miter', 'round', 'bevel'}
`label`	объект
`linestyle` or ls	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
`linewidth` or lw	float или None
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или вызываемый объект
`rasterized`	bool или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`visible`	bool
`zorder`	float

END_OF_DOCUMENT_MARKER

__init__(self, edgecolor=None, facecolor=None, color=None, linewidth=None, linestyle=None, antialiased=None, hatch=None, fill=True, capstyle=None, joinstyle=None, **kwargs) [source]

Следующие свойства kwarg поддерживаются

Свойство	Описание
`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`	Patch или (Path, Transform) или 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	{'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения), ...}
`linewidth` или lw	число с плавающей точкой или None
`path_effects`	`AbstractPathEffect`
`picker`	None или логическое значение или вызываемая функция
`rasterized`	логическое значение или None
`sketch_params`	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
`snap`	логическое значение или None
`transform`	`Transform`
`url`	строка
`visible`	логическое значение
`zorder`	число с плавающей точкой

__module__ = 'matplotlib.patches'

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

Проверить, произошла ли событие мыши внутри области.

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

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

Возвращает, находится ли заданная точка внутри области.

Параметры:

Параметры:	`point(float, float)` Точка (x, y) для проверки в координатах назначения `self.get_transform()`. Это координаты отображения для областей, которые добавлены в рисунок или ось. `radiusfloat, optional` Добавить дополнительный отступ к области в координатах назначения `self.get_transform()`. См. `Path.contains_point` для получения дополнительной информации.
Возвращает:	логическое значение

point(float, float): Точка (x, y) для проверки в координатах назначения self.get_transform(). Это координаты отображения для областей, которые добавлены в рисунок или ось.
radiusfloat, optional: Добавить дополнительный отступ к области в координатах назначения self.get_transform(). См. Path.contains_point для получения дополнительной информации.

Возвращает:

логическое значение

Примечания

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

>>> center = 0, 0
>>> c = Circle(center, radius=1)
>>> c.contains_point(center)
True

Конвенция проверки по отношению к преобразованной области основана на том, что этот метод в основном используется для проверки, находятся ли координаты отображения (например, от событий мыши) внутри области. Если вы хотите выполнить вышеупомянутую проверку в координатах данных, вы должны сначала правильно преобразовать их:

>>> center = 0, 0
>>> c = Circle(center, radius=1)
>>> plt.gca().add_patch(c)
>>> transformed_center = c.get_transform().transform(center)
>>> c.contains_point(transformed_center)
True

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

Определяет, находятся ли заданные точки внутри области.

Параметры:

Параметры:	`points(N, 2) array` Проверяемые точки в координатах назначения `self.get_transform()`. Это координаты отображения для областей, добавленных в рисунок или ось. Столбцы содержат значения x и y. `radiusfloat, optional` Дополнительный отступ области в координатах назначения `self.get_transform()`. См. `Path.contains_point` для получения дополнительных сведений.
Возвращаемое значение:	массив bool длины N

points(N, 2) array: Проверяемые точки в координатах назначения self.get_transform(). Это координаты отображения для областей, добавленных в рисунок или ось. Столбцы содержат значения x и y.
radiusfloat, optional: Дополнительный отступ области в координатах назначения self.get_transform(). См. Path.contains_point для получения дополнительных сведений.

Возвращаемое значение:

массив bool длины N

Примечания

Правильное использование этого метода зависит от преобразования области. См. примечания к Patch.contains_point.

draw(self, renderer) [source]

Отрисовка объекта (и его дочерних элементов) с помощью заданного рендерера.

Это не оказывает влияния, если объект не отображается (Artist.get_visible возвращает False).

Параметры:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределяется в подклассах Artist.

property fill: Возвращает, заполнена ли область.

get_aa(self): Псевдоним для get_antialiased.

get_antialiased(self) [source]: Возвращает, используется ли антиалиасинг для отрисовки.

get_capstyle(self) [source]: Возвращает стиль окончания.

get_data_transform(self) [source]: Возвращает Transform, отображающий координаты данных в физические координаты.

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self) [source]: Возвращает цвет границы.

get_extents(self) [source]: Возвращает прямоугольник области с осями, выровненными по осям, в виде Bbox.

get_facecolor(self) [source]: Возвращает цвет заливки.

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]

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

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

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

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

set_aa(self, aa): Псевдоним для set_antialiased.

set_alpha(self, alpha) [source]

Установить значение альфа для смешивания - не поддерживается во всех бэкендах.

Параметры:	`alphafloat or None`

set_antialiased(self, aa) [source]

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

Параметры:	`bbool or None`

set_capstyle(self, s) [source]

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

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

set_color(self, c) [source]

Установить цвет края и заливки.

Параметры:	`ccolor`

См. также

Patch.set_facecolor, Patch.set_edgecolor: Для установки цвета края или заливки отдельно.

set_ec(self, color): Псевдоним для set_edgecolor.

set_edgecolor(self, color) [source]

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

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

set_facecolor(self, color) [source]

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

Параметры:	`colorcolor or None`

set_fc(self, color): Псевдоним для set_facecolor.

set_fill(self, b) [source]

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

Параметры:	`bbool`

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'`	пунктирная линия