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	unknown
capstyle	{'butt', 'round', 'projecting'}
clip_box	Bbox
clip_on	bool
clip_path	[(Path, Transform) | Patch | None]
color	цвет
contains	вызываемая функция
edgecolor	цвет или None или 'auto'
facecolor	цвет или None
figure	Figure
fill	bool
gid	строка
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	bool
joinstyle	{'miter', 'round', 'bevel'}
label	объект
linestyle	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth	число с плавающей точкой или None по умолчанию
path_effects	AbstractPathEffect
picker	None или bool или число с плавающей точкой или вызываемая функция
rasterized	bool или None
sketch_params	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
snap	bool или None
transform	Transform
url	строка
visible	bool
zorder	число с плавающей точкой

contains(mouseevent, radius=None) [source]

Test whether the mouse event occurred in the patch.

Returns T/F, {}

contains_point(point, radius=None) [source]

Returns True if the given point is inside the path (transformed with its transform attribute).

radius allows the path to be made slightly larger or smaller.

contains_points(points, radius=None) [source]

Returns a bool array which is True if the (closed) path contains the corresponding point. (transformed with its transform attribute).

points must be Nx2 array. radius allows the path to be made slightly larger or smaller.

draw(renderer) [source]

Draw the Patch to the given renderer.

fill

return whether fill is set

get_aa(*args, **kwargs)

alias for get_antialiased

get_antialiased() [source]

Returns True if the Patch is to be drawn with antialiasing.

get_capstyle() [source]

Return the current capstyle

get_data_transform() [source]

Return the Transform instance which maps data coordinates to physical coordinates.

get_ec(*args, **kwargs)

псевдоним для get_edgecolor

get_edgecolor() [source]

Возвращает цвет границы Patch.

get_extents() [source]

Возвращает объект Bbox, определяющий прямоугольные области Patch.

get_facecolor() [source]

Возвращает цвет заливки Patch.

get_fc(*args, **kwargs)

псевдоним для get_facecolor

get_fill() [source]

возвращает, установлена ли заливка

get_hatch() [source]

Возвращает текущий шаблон штриховки.

get_joinstyle() [source]

Возвращает текущий стиль соединения.

get_linestyle() [source]

Возвращает стиль линии.

get_linewidth() [source]

Возвращает ширину линии в пунктах.

get_ls(*args, **kwargs)

псевдоним для get_linestyle

get_lw(*args, **kwargs)

псевдоним для 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(*args, **kwargs)

псевдоним для set_antialiased

set_alpha(alpha) [source]

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

Параметры:	alpha : float or None

set_antialiased(aa) [source]

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

Параметры:	b : bool or None

set_capstyle(s) [source]

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

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

set_color(c) [source]

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

См. также

set_facecolor(), set_edgecolor()

Для установки цвета границы или заливки по отдельности.

Параметры:	c : color

set_ec(*args, **kwargs)

псевдоним для set_edgecolor

set_edgecolor(color) [source]

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

Параметры:	color : color or None or 'auto'

set_facecolor(color) [source]

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

Параметры:	color : color or None

set_fc(*args, **kwargs)

псевдоним для set_facecolor

set_fill(b) [source]

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

Параметры:	b : bool

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]

Установить стиль соединения фигур.

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

set_linestyle(ls) [source]

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

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

В качестве альтернативы можно указать кортеж штрихов следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий длины включённых и выключенных отрезков в пунктах.

Параметры:	ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...} Стиль линии.

set_linewidth(w) [source]

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

ПРИНИМАЕТ: float или None для значения по умолчанию

set_ls(*args, **kwargs)

псевдоним для set_linestyle

set_lw(*args, **kwargs)

псевдоним для set_linewidth

update_from(other) [source]

Обновляет свойства этой Patch по свойствам other.

validCap = ('butt', 'round', 'projecting')

validJoin = ('miter', 'round', 'bevel')

zorder = 1

Примеры использования matplotlib.patches.Patch

Создание пользовательских легенд по частям

Руководство по легендам