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

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

__init__(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`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`animated`	логическое значение
`antialiased` или aa	неизвестно
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`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`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или ls	{'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения), ...}
`linewidth` или lw	число с плавающей точкой или None
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`rasterized`	логическое значение
`sketch_params`	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
`snap`	логическое значение или None
`transform`	`Transform`
`url`	строка
`visible`	логическое значение
`zorder`	число с плавающей точкой

__module__ = 'matplotlib.patches'

contains(mouseevent, radius=None)[source]

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

Возвращает:	(bool, пустой словарь)

contains_point(point, radius=None)[source]

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

Параметры:

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

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

Возвращает:

bool

Примечания

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

>>> 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(points, radius=None)[source]

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

Параметры:

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

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

Возвращает:

массив bool длиной N

Примечания

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

draw(renderer)[source]

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

Это не оказывает никакого влияния, если элемент не виден (Artist.get_visible возвращает False).

Параметры:	rendererподкласс `RendererBase`.

Примечания

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

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

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

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

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

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

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

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

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

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

get_fc(): Псевдоним для get_facecolor.

get_fill()[source]: Возвращает, заполнена ли область.

get_hatch()[source]: Возвращает узор штриховки.

get_joinstyle()[source]: Возвращает стиль соединения.

get_linestyle()[source]: Возвращает стиль линии.

get_linewidth()[source]: Возвращает ширину линии в пунктах.

get_ls(): Псевдоним для get_linestyle.

get_lw(): Псевдоним для get_linewidth.

get_patch_transform()[source]

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

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

get_path()[source]: Возвращает путь данной фигуры.

get_transform()[source]: Возвращает Transform, применяемое к Patch.

get_verts()[source]

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

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

get_window_extent(renderer=None)[source]

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

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

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

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

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

set_alpha(alpha)[source]

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

Параметры:	alphaвещественное число или None alpha должно быть в диапазоне от 0 до 1 включительно.

set_antialiased(aa)[source]

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

Параметры:	bbool или None

set_capstyle(s)[source]

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

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

set_color(c)[source]

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

Параметры:	cцвет

См. также

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

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

set_edgecolor(color)[source]

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

Параметры:	colorцвет или None или 'auto'

set_facecolor(color)[source]

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

Параметры:	colorцвет или None

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

set_fill(b)[source]

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

Параметры:	bbool

END_OF_DOCUMENT_MARKER

set_hatch(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(s)[source]

Установите JoinStyle.

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

set_linestyle(ls)[source]

Установите стиль линии объекта.

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