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`	callable
`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`	object
`linestyle` or ls	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
`linewidth` or lw	float или None
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или callable
`rasterized`	bool или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`visible`	bool
`zorder`	float

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

Test whether the mouse event occurred in the patch.

Returns:	(bool, empty dict)

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

Return whether the given point is inside the patch.

Parameters:	`point(float, float)` The point (x, y) to check, in target coordinates of `self.get_transform()`. These are display coordinates for patches that are added to a figure or axes. `radiusfloat, optional` Add an additional margin on the patch in target coordinates of `self.get_transform()`. See `Path.contains_point` for further details.
Returns:	bool

Notes

The proper use of this method depends on the transform of the patch. Isolated patches do not have a transform. In this case, the patch creation coordinates and the point coordinates match. The following example checks that the center of a circle is within the circle

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

The convention of checking against the transformed patch stems from the fact that this method is predominantly used to check if display coordinates (e.g. from mouse events) are within the patch. If you want to do the above check with data coordinates, you have to properly transform them first:

>>> 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]: Отрисовать на заданном renderer.

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]: Возвращает прямоугольник области Patch в виде 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	описание
`'-'` or `'solid'`	сплошная линия
`'--'` or `'dashed'`	штриховая линия
`'-.'` or `'dashdot'`	штрихпунктирная линия
`':'` or `'dotted'`	пунктирная линия