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 — это двумерный объект с цветом заливки и цветом обводки.

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

Поддерживаются следующие свойства в виде аргументов ключевого слова:

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

contains(mouseevent, radius=None)[source]

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

Возвращает:

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

contains_point(point, radius=None)[source]

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

Параметры:

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

Возвращает:

булево значение

Примечания

Правильное использование этого метода зависит от преобразования объекта 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=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

Примечания

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

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

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]

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

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

Подклассы должны переопределять для включения в вычисление прямоугольника ограничивающей рамки «плотно». По умолчанию возвращается пустой прямоугольник в координатах 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`	`Bbox`
`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`	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
`linewidth`	float или None
`mouseover`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`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' для FancyArrowPatch и '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'`, `' '`, или `''`	линия не рисуется