matplotlib.patches.Patch

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

Основы: Artist

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

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

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

Свойство	Описание
`agg_filter`	Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, а возвращает массив float (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	неизвестно
`animated`	bool
`antialiased` или aa	bool или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clip_box`	`BboxBase` или None
`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	число с плавающей точкой или None
`mouseover`	bool
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемая функция
`rasterized`	bool
`sketch_params`	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`visible`	bool
`zorder`	число с плавающей точкой

contains(mouseevent, radius=None)[source]

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

Возвращает:

(bool, пустой словарь)

contains_point(point, radius=None)[source]

Определяет, лежит ли указанная точка внутри объекта Patch.

Параметры:

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

Возвращает:

bool

Примечания

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

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

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

>>> center = 0, 0
>>> c = Circle(center, radius=3)
>>> plt.gca().add_patch(c)
>>> transformed_interior_point = c.get_data_transform().transform((0, 2))
>>> c.contains_point(transformed_interior_point)
True

contains_points(points, radius=None)[source]

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

Параметры:

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

Возвращает:

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

Примечания

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

draw(renderer)[source]

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

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

Параметры:

rendererподкласс RendererBase.

Примечания

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

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

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

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

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

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

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

get_edgecolor()[source]: Возвращает цвет контура.

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

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

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

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

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

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

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

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

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

get_lw()[source]: Псевдоним для 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]

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

Ширина и высота области рамки неотрицательны.

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

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

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

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

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

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

set_alpha(alpha)[source]

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

Параметры:

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

set_antialiased(aa)[source]

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

Параметры:

aabool или None

set_capstyle(s)[source]

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

По умолчанию стиль окончания «round» для CapStyle и «butt» для всех остальных элементов.

Параметры:

sCapStyle или {'butt', 'projecting', 'round'}

set_color(c)[source]

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

Параметры:

cцвет

См. также

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

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

set_edgecolor(color)[source]

Установить цвет границы элемента.

Параметры:

colorцвет или None

set_facecolor(color)[source]

Установить цвет заливки элемента.

Параметры:

colorцвет или None

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

set_fill(b)[source]

Установить, закрашивать ли элемент.

Параметры:

bbool

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]

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

По умолчанию стиль соединения «round» для FancyArrowPatch и «miter» для всех остальных элементов.

Параметры:

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

set_linestyle(ls)[source]

Установить стиль линии элемента.

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