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]

Базы: matplotlib.artist.Artist

Объект типа patch — это 2D-объект с цветом заливки и цветом контура.

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

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

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

contains(mouseevent, radius=None)[source]

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

Возвращает

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

contains_point(point, radius=None)[source]

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

Параметры

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.
radiusчисло с плавающей точкой, необязательно: Добавляет дополнительный отступ к области в координатах назначения self.get_transform(). См. Path.contains_point для получения более подробной информации.

Возвращает

массив булевых значений длины N

Примечания

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

draw(renderer)[source]

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

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

Параметры

rendererподкласс RendererBase.

Примечания

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

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

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>, 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
`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]

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

Параметры

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]

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

Параметры

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

set_linestyle(ls)[source]

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

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