matplotlib.collections

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

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

classmatplotlib.collections.AsteriskPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[исходный код]

Базовые классы: RegularPolyCollection

Рисует коллекцию правильных звёзд с numsides вершинами.

Параметры:

numsidesint: Количество сторон многоугольника.
rotationfloat: Угол поворота многоугольника в радианах.
sizestuple of float: Площадь описанной вокруг многоугольника окружности в точках^2.
**kwargs: Передаются в Collection.

Примеры

Полный пример см. в разделе Демонстрация лассо:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    offset_transform=ax.transData,
    )

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая будет вызываться при изменении любого из свойств Artist.

Параметры:

funccallable

Функция обратного вызова. Она должна иметь следующую сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения могут быть, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позже этот идентификатор можно использовать для удаления функции обратного вызова с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив.

autoscale_None()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив; изменяются только пределы со значением None.

propertyaxes: Экземпляр Axes, в котором находится объект-художник, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None.

propertycolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x, используя тип единиц оси x.

Если объект-художник не входит в Axes или ось x не имеет единиц измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразует y, используя тип единиц оси y.

Если объект-художник не входит в Axes или ось y не имеет единиц измерения, возвращается само значение y.

draw(renderer)[исходный код]

Рисует объект Artist (и его дочерние объекты) с помощью указанного средства визуализации.

Ничего не делает, если объект-художник невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: Figure (или SubFigure), к которой относится объект-художник. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Находит объекты-художники.

Рекурсивно находит все экземпляры Artist, содержащиеся в объекте-художнике.

Параметры:

match

Критерий фильтрации совпадений. Возможные значения:

None: возвращает все объекты, содержащиеся в объекте-художнике.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только те объекты-художники, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат войдут только объекты-художники этого класса или его подклассов (проверка isinstance).

include_selfbool

Включает self в список объектов, проверяемых на совпадение.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах Artist. Как пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы таких чисел в строку, разделённую запятыми и заключённую в квадратные скобки. Если с объектом-художником связана цветовая шкала, скалярные значения форматируются с помощью форматировщика этой цветовой шкалы.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Возвращает функцию фильтрации для фильтра agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания. Поддерживается не всеми серверными частями.

get_animated()[исходный код]: Возвращает признак того, что объект-художник анимирован.

get_antialiased()[исходный код]

Возвращает состояние сглаживания при отрисовке.

Возвращает:

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

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Возвращает массив значений, преобразуемых в цвета.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[исходный код]

Возвращает стиль окончания линий для коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Возвращает список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Возвращает значения (min, max), которые сопоставляются с пределами цветовой карты.

get_clip_box()[исходный код]: Возвращает область отсечения.

get_clip_on()[исходный код]: Возвращает признак использования отсечения объектом-художником.

get_clip_path()[исходный код]: Возвращает путь отсечения.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

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

Примечание

Объекты Artist могут использовать данные курсора, чтобы предоставить дополнительную контекстную информацию для заданного события. Реализация по умолчанию просто возвращает None.

Подклассы могут переопределить метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что метод format_cursor_data сможет преобразовать данные в строковое представление.

Единственный используемый в настоящее время сценарий — отображение z-значения объекта AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, к которому относится объект-художник.

Параметры:

rootbool, по умолчанию False: Если False, возвращает Figure (или SubFigure), к которой относится этот объект-художник. Если True, возвращает корневую Figure во вложенном дереве SubFigure.

get_fill()[исходный код]: Возвращает признак того, что область залита цветом.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает ширину линий штриховки.

get_in_layout()[исходный код]

Возвращает логический флаг, True если объект включён в расчёты компоновки.

Например, руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого объекта в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли у этого объекта пользовательские контекстные сведения при наведении на него курсора мыши.

get_numsides()[исходный код]

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого объекта.

get_offsets()[исходный код]: Возвращает смещения элементов коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора объекта.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растрировать объект.

get_rotation()[исходный код]

get_sizes()[исходный код]

Возвращает размеры («площади») элементов коллекции.

Возвращает:

array: «Площадь» каждого элемента.

get_sketch_params()[исходный код]

Возвращает параметры эскиза объекта.

Возвращает:

tuple или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент, на который длина уменьшается или увеличивается.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Как Artist.get_window_extent, но с учётом обрезки.

Параметры:

rendererподкласс RendererBase, необязательный: объект отрисовки, который будет использоваться для рисования рисунков (т. е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающий прямоугольник (в пиксельных координатах рисунка). Возвращает None, если в результате обрезки пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой к нему неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Для элементов без URL в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает видимость объекта.

get_window_extent(renderer=None)[исходный код]

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

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

Для включения объекта в расчёт ограничивающего прямоугольника «tight» подклассам следует переопределить этот метод. По умолчанию возвращается пустой ограничивающий прямоугольник в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает порядок отрисовки объекта (zorder).

have_units()[исходный код]: Возвращает, заданы ли единицы измерения хотя бы для одной оси.

is_transform_set()[исходный код]

Возвращает, задано ли для Artist преобразование явно.

Значение равно True после вызова set_transform.

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

свойствоnorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренним образом при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний объект Artist вызовет событие выбора, если mouseevent произошло над ним и для него задано свойство picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами объекта.

remove()[исходный код]

Удаляет объект из рисунка, если это возможно.

Изменение станет видимым после перерисовки рисунка, например с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи объекта из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Задать несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив вещественных чисел формы (m, n, 3) и значение dpi, а возвращает массив формы (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	массивоподобный объект, вещественное число или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` or `ec` or `edgecolors`	цвет или список цветов или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список цветов
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `dashes` or `linestyles` or `ls`	str, кортеж или список таких значений
`linewidth` or `linewidths` or `lw`	вещественное число или список вещественных чисел
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` or `transOffset`	`Transform`
`offsets`	массивоподобный объект формы (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None, bool, float или callable
`pickradius`	float
`rasterized`	bool
`sizes`	`numpy.ndarray` или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[исходный код]

Задать фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, которая принимает массив вещественных чисел формы (m, n, depth) и значение dpi, а возвращает массив формы (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задать значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Задать, предназначен ли объект Artist для использования в анимации.

Если значение True, объект Artist исключается из обычного рисования фигуры. Для него необходимо явно вызвать Figure.draw_artist / Axes.draw_artist. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Ускорение отрисовки с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задать состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задать массив значений из массивоподобного объекта A.

Параметры:

Aarray-like or None

Значения, сопоставляемые цветам.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

csCapStyle or {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать кортежем (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[исходный код]

Задать область отсечения Bbox для объекта Artist.

Параметры:

clipboxBboxBase или None: Обычно создаётся на основе TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) — это область отсечения по умолчанию для объекта Artist, добавленного в Axes.

set_clip_on(b)[исходный код]

Задать, использует ли объект Artist отсечение.

Если значение False, объекты Artist будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать обрезающий контур объекта-художника.

Параметры:

pathPatch or Path or TransformedPath or None: Обрезающий контур. Если задан объект Path, необходимо также указать transform. Если задано значение None, ранее установленный обрезающий контур удаляется.
transformTransform, необязательный: Используется только в том случае, если path — это Path. В этом случае заданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — это Rectangle, этот метод задаёт обрезающую область в виде соответствующего прямоугольника, а обрезающий контур устанавливает в None.

По техническим причинам (для поддержки set) кортеж (path, transform) также можно передать как один позиционный параметр.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных яркости.

Параметры:

cmapColormap or str or None

set_color(c)[исходный код]

Задать цвет контура и заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

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

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвета контура коллекции.

Параметры:

cцвет или список значений цвет или 'face': Цвета контура коллекции. Если передана последовательность, цвета элементов будут циклически выбираться из неё. Если задано значение 'face', цвет будет соответствовать цвету заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвета заливки коллекции. Значение c может быть цветом (все элементы будут одного цвета) или последовательностью цветов; если передана последовательность, цвета элементов будут циклически выбираться из неё.

Если c равно 'none', заливка элемента не выполняется.

Параметры:

cцвет или список значений цвет

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, к которому относится объект-художник.

Параметры:

figFigure или SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) для объекта-художника.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать: в этом случае применяются все указанные узоры штриховки. Повторение одной и той же буквы увеличивает плотность соответствующего узора.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно задать только для всей коллекции, но не отдельно для каждого её элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать толщину линий штриховки.

set_in_layout(in_layout)[исходный код]

Задать, следует ли включать объект-художник в расчёты компоновки, например, в руководстве по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать стиль соединения JoinStyle для всей коллекции.

Параметры:

jsJoinStyle or {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Задать подпись, которая будет отображаться в легенде.

Параметры:

sobject: Значение s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стили линий для коллекции.

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

Также можно передать кортеж, задающий штриховой узор, в следующем формате:

(offset, onoffseq),

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

Параметры:

lsstr or tuple or list thereof: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать толщину линий коллекции. Значение lw может быть скаляром или последовательностью; если передана последовательность, значения будут циклически применяться к элементам.

Параметры:

lwfloat or list of floats

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого объекта-художника дополнительные сведения при наведении на него курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize or str or None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения объекта-художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения элементов коллекции.

Параметры:

offsets(N, 2) or (2,) array-like

set_path_effects(path_effects)[исходный код]

Задать эффекты контура.

Параметры:

path_effectslist of AbstractPathEffect

set_paths(paths)[исходный код]

set_picker(picker)[исходный код]

Задать поведение выбора объекта-художника.

Параметры:

pickerNone or bool or float or callable

Допустимы следующие значения:

None: выбор объекта отключён (по умолчанию).
Логическое значение: если задано True, выбор включается, и при наведении курсора мыши на объект-художник генерируется событие выбора.
Число с плавающей точкой: если picker — число, оно интерпретируется как допустимое отклонение в пунктах; событие генерируется, если данные объекта находятся от курсора мыши на расстоянии не более этого значения. Для некоторых объектов, например линий и коллекций фигур, в событие выбора могут включаться дополнительные данные, например индексы данных, находящихся в пределах допустимого отклонения от места выбора.
Функция: если picker является вызываемым объектом, это заданная пользователем функция, которая определяет, попал ли курсор мыши на объект-художник:
```
hit, props = picker(artist, mouseevent)
```
для проверки попадания. Если курсор мыши находится над объектом-художником, верните hit=True, а props должен быть словарём свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый при проверке принадлежности.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно включить растровую (битовую) отрисовку для векторного вывода.

Растровая отрисовка поддерживается не всеми объектами. Если попытаться включить её для объекта, который её не поддерживает, команда не подействует и будет выдано предупреждение.

Эта настройка игнорируется при выводе в пиксельном формате.

См. также Растеризация для векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Задать размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер, задаваемый для каждого элемента коллекции. Значение представляет собой «площадь» элемента.
dpifloat, default: 72: Разрешение холста в dpi.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эскиза.

Параметры:

scalefloat, optional

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если значение scale равно None или не задано, фильтр эскиза применяться не будет.

lengthfloat, optional

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, optional

Масштабный коэффициент, на который уменьшается или увеличивается длина (по умолчанию 16.0)

Бэкенд PGF использует этот аргумент как начальное значение генератора случайных чисел, а не так, как описано выше. При использовании одного и того же начального значения получается одна и та же случайная форма.

set_snap(snap)[исходный код]

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

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

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Допустимые значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять позиции вершин.
None: (авто) если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование объекта.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL для объекта.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_visible(b)[исходный код]

Задать видимость объекта.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать zorder объекта. Объекты с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли объект «устаревшим» и нуждается ли он в повторной отрисовке, чтобы вывод соответствовал внутреннему состоянию объекта.

propertysticky_edges

x и y списки фиксированных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ добавляться не будет — пределы области просмотра «прилипнут» к границе. Типичный пример использования — гистограммы, для которых обычно не ожидается отступа у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может пересечь их. Например, если верхний предел данных равен 1.0, верхний предел области просмотра, вычисленный простым добавлением отступа, равен 1.2, но фиксированная граница расположена на 1.1, фактический верхний предел области просмотра будет равен 1.1.

Этому атрибуту нельзя присвоить значение; однако при необходимости списки x и y можно изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Вернуть нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скалярных значений, и будет возвращён соответствующий массив ndarray значений RGBA на основе нормы и цветовой карты, заданных для этого Colorizer.

Существует особый случай обработки изображений, уже представленных в формате RGB или RGBA, например, считанных из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение равно 3 или 4, он будет обработан как массив RGB или RGBA, без преобразования. Массив может быть типа uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвана ошибка ValueError. Значения NaN и замаскированные элементы получат альфа-канал со значением 0. Если последнее измерение равно 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если последнее измерение равно 4, аргумент alpha игнорируется и не заменяет существующее значение альфа-канала. Если третье измерение не равно 3 или 4, будет вызвана ошибка ValueError.

В обоих случаях, если bytes равно False (по умолчанию), массив RGBA будет содержать числа с плавающей точкой в диапазоне 0–1; если оно равно True, возвращаемый массив RGBA будет иметь тип uint8 и значения в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого объекта из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из other в текущий объект.

update_scalarmappable()[исходный код]

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

Назначить цвета границам и заливкам на основе массива и/или цветов, заданных напрямую, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.CircleCollection(sizes, **kwargs)[исходный код]

Базовые классы: _CollectionWithSizes

Коллекция окружностей, нарисованных с помощью сплайнов.

Параметры:

sizesfloat or array-like: Площадь каждой окружности в points^2.
**kwargs: Передаются в Collection.

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая будет вызываться при изменении любого из свойств Artist.

Параметры:

funccallable

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Возвращаемые значения могут быть, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Этот идентификатор можно использовать позднее для удаления функции с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив, изменяя только пределы со значением None

propertyaxes: Экземпляр Axes, в котором находится художник, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x, используя тип единиц оси x.

Если художник не входит в состав Axes или ось x не использует единицы измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразует y, используя тип единиц оси y.

Если художник не входит в состав Axes или ось y не использует единицы измерения, возвращается само значение y.

draw(renderer)[исходный код]

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

Не оказывает влияния, если художник невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: (Под)фигура, на которой расположен художник. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Находит объекты-художники.

Рекурсивно находит все экземпляры Artist, содержащиеся в художнике.

Параметры:

match

Критерий фильтрации совпадений. Это может быть

None: возвращает все объекты, содержащиеся в художнике.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат попадут только художники, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат попадут только художники этого класса или его подклассов (проверка isinstance).

include_selfbool

Включает self в список объектов, проверяемых на совпадение.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах Artist. Как конечный пользователь Matplotlib вы, скорее всего, не будете вызывать этот метод самостоятельно.

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

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Возвращает функцию фильтрации для фильтра agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Возвращает признак анимации художника.

get_antialiased()[исходный код]

Возвращает состояние сглаживания при отрисовке.

Возвращает:

массив значений bool

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Возвращает массив значений, сопоставляемых с цветами.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[исходный код]

Возвращает стиль окончания линий коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Возвращает список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Возвращает значения (min, max), сопоставленные с пределами цветовой карты.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает признак использования обрезки для художника.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

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

Примечание

Художники могут использовать данные курсора для предоставления дополнительной контекстной информации о заданном событии. Реализация по умолчанию просто возвращает None.

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

Единственный текущий вариант использования — отображение z-значения объекта AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит художник.

Параметры:

rootbool, по умолчанию False: Если False, возвращает (под)фигуру, на которой расположен этот художник. Если True, возвращает корневую Figure для вложенной структуры SubFigure.

get_fill()[исходный код]: Возвращает признак заливки грани цветом.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий шаблон штриховки.

get_hatch_linewidth()[исходный код]: Возвращает толщину линий штриховки.

get_in_layout()[исходный код]

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

Например, руководство по constrained layout, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого художника в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли у этого художника дополнительные сведения о контексте при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого художника.

get_offsets()[исходный код]: Возвращает смещения элементов коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора художника.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растрировать художника.

get_sizes()[исходный код]

Возвращает размеры («площади») элементов коллекции.

Возвращает:

массив: «Площадь» каждого элемента.

get_sketch_params()[исходный код]

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

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент, на который уменьшается или увеличивается длина.

Возвращает None, если параметры наброска не заданы.

get_snap()[исходный код]

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

Подробнее см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Как Artist.get_window_extent, но с учётом любого обрезания.

Параметры:

rendererподкласс RendererBase, необязательный: рендерер, который будет использоваться для отрисовки рисунков (т. е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающий прямоугольник (в пиксельных координатах рисунка). Возвращает None, если в результате обрезания пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим художником.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой к нему неаффинной частью преобразования, а также оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Для элементов без URL в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает признак видимости.

get_window_extent(renderer=None)[исходный код]

Возвращает ограничивающий прямоугольник художника в пространстве отображения.

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

Для включения в расчёт «точных» границ подклассам следует переопределить этот метод. По умолчанию возвращается пустой ограничивающий прямоугольник в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает порядок отрисовки художника (zorder).

have_units()[исходный код]: Возвращает, заданы ли единицы измерения на какой-либо оси.

is_transform_set()[исходный код]

Возвращает, задано ли для Artist явное преобразование.

Значение становится True после вызова set_transform.

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

свойствоnorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция запускается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний художник вызовет событие выбора, если mouseevent произошло над ним и для художника задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами художника.

remove()[исходный код]

Удаляет художника с рисунка, если это возможно.

Изменение станет видимым только после повторной отрисовки рисунка, например с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи художника из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

Установить несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив чисел с плавающей точкой размером (m, n, 3) и значение dpi и возвращающая массив размером (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	массивоподобный объект, число с плавающей точкой или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` or `ec` or `edgecolors`	цвет или список цветов или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список цветов
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` or `dashes` or `linestyles` or `ls`	str, кортеж или список таких значений
`linewidth` or `linewidths` or `lw`	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` or `transOffset`	`Transform`
`offsets`	массивоподобный объект размером (N, 2) или (2,)
`path_effects`	список `AbstractPathEffect`
`paths`	неизвестно
`picker`	None, bool, число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	`numpy.ndarray` или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список str или None
`visible`	bool
`zorder`	число с плавающей точкой

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

set_agg_filter(filter_func)[исходный код]

Задать фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, принимающая массив чисел с плавающей точкой размером (m, n, depth) и значение dpi и возвращающая массив размером (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задать значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Задать, предназначен ли художник для использования в анимации.

Если значение True, художник исключается из обычного рисования фигуры. Необходимо явно вызвать для художника Figure.draw_artist / Axes.draw_artist. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Более быстрая отрисовка с помощью blitting.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задать состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задать массив значений из массивоподобного объекта A.

Параметры:

Aarray-like or None

Значения, которые преобразуются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

csCapStyle or {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать одним позиционным аргументом в виде кортежа (vmin, vmax).

set_clip_box(clipbox)[исходный код]

Задать ограничивающую Bbox художника.

Параметры:

clipboxBboxBase or None: Обычно создаётся из объекта TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) является стандартной областью отсечения для художника, добавленного в Axes.

set_clip_on(b)[исходный код]

Задать, использует ли художник отсечение.

Если значение False, художники будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать контур отсечения объекта Artist.

Параметры:

pathPatch или Path или TransformedPath или None: Контур отсечения. Если задан объект Path, необходимо также указать transform. Если задано значение None, ранее установленный контур отсечения удаляется.
transformTransform, необязательно: Используется только в том случае, если path — это объект Path; тогда заданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — это объект Rectangle, этот метод задаёт ограничивающую рамку отсечения в виде соответствующего прямоугольника, а для контура отсечения устанавливает значение None.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных о яркости.

Параметры:

cmapColormap или str или None

set_color(c)[исходный код]

Задать цвет границы и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

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

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет границы коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет границы коллекции. Если задана последовательность, цвета элементов чередуются в соответствии с ней. Если задано значение 'face', цвет границы совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет заливки коллекции. c может быть цветом (все элементы будут одного цвета) или последовательностью цветов; если задана последовательность, цвета элементов будут чередоваться в соответствии с ней.

Если для c задано значение 'none', элемент не будет залит.

Параметры:

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, которому принадлежит объект Artist.

Параметры:

figFigure или SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) объекта Artist.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать: в этом случае применяются все указанные варианты штриховки. Повторение одной и той же буквы увеличивает плотность штриховки соответствующего узора.

В отличие от других свойств, таких как толщина линий и цвета, штриховку можно задать только для всей коллекции целиком, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать толщину линий штриховки.

set_in_layout(in_layout)[исходный код]

Задать, следует ли включать объект Artist в расчёты компоновки, например, в руководстве по компоновке с ограничениями, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль линий коллекции.

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

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

(offset, onoffseq),

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

Параметры:

lsstr или tuple или список таких значений: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать толщину линий коллекции. lw может быть скалярным значением или последовательностью; если задана последовательность, толщины линий элементов будут чередоваться в соответствии с ней.

Параметры:

lwfloat или список значений float

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого объекта Artist пользовательскую контекстную информацию при перемещении курсора мыши над ним.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения объекта Artist.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsetsмассивоподобный объект формы (N, 2) или (2,)

set_path_effects(path_effects)[исходный код]

Задать эффекты контура.

Параметры:

path_effectsсписок объектов AbstractPathEffect

set_paths(paths)[исходный код]

set_picker(picker)[исходный код]

Определить поведение объекта Artist при выборе.

Параметры:

pickerNone или bool или float или вызываемый объект

Возможны следующие значения:

None: выбор для этого объекта Artist отключён (по умолчанию).
Логическое значение: если задано True, выбор будет включён, и объект Artist вызовет событие выбора, если событие мыши произошло над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допустимое отклонение в точках, и объект Artist вызовет событие, если его данные находятся в пределах этого отклонения от события мыши. Для некоторых объектов Artist, например линий и коллекций фигур, в сгенерированное событие выбора могут добавляться дополнительные данные, например индексы данных, находящихся в пределах допустимого отклонения от места выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, определяющая, попал ли указатель мыши на объект Artist:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если событие мыши произошло над объектом Artist, функция должна вернуть hit=True, а props должен быть словарём свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый для проверки принадлежности.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно использовать растровую (битовую) отрисовку при выводе векторной графики.

Растровая отрисовка поддерживается не всеми художниками. Если попытаться включить её для художника, который её не поддерживает, команда не даст эффекта и будет выдано предупреждение.

Этот параметр игнорируется при выводе в формате на основе пикселей.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Задать размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray or None: Размер, задаваемый каждому элементу коллекции. Значение представляет собой «площадь» элемента.
dpifloat, default: 72: Разрешение холста в точках на дюйм.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эскиза.

Параметры:

scalefloat, optional

Амплитуда колебаний перпендикулярно исходной линии, в пикселях. Если значение scale равно None или не задано, фильтр эскиза применяться не будет.

lengthfloat, optional

Длина колебаний вдоль линии, в пикселях (по умолчанию 128.0)

randomnessfloat, optional

Коэффициент масштабирования, на который уменьшается или увеличивается длина (по умолчанию 16.0)

Бэкенд PGF использует этот аргумент как начальное значение генератора случайных чисел, а не в описанном выше смысле. При использовании одного и того же начального значения получается одна и та же случайная форма.

set_snap(snap)[исходный код]

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

Привязка выравнивает положения по пиксельной сетке, что повышает чёткость изображений. Например, если чёрная линия шириной 1 пиксель проходит между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть серое значение в обоих соседних пикселях. При привязке линия смещается к ближайшему целочисленному значению пикселя, поэтому на изображении действительно будет чёрная линия шириной 1 пиксель.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Возможные значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять положения вершин.
None: (автоматически) если путь содержит только прямолинейные отрезки, округлить координаты до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование художника.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL художника.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL-адреса реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_visible(b)[исходный код]

Задать видимость художника.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать порядок отрисовки художника. Художники с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, устарел ли художник и требуется ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию художника.

propertysticky_edges

x и y списки фиксированных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — пределы отображения «прилипают» к границе. Типичный пример — гистограммы, для которых обычно ожидается отсутствие отступа у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может их пересечь. Например, если верхний предел данных равен 1.0, верхний предел отображения, вычисленный простым применением отступа, равен 1.2, но фиксированная граница находится на уровне 1.1, фактический верхний предел отображения будет равен 1.1.

Этому атрибуту нельзя присваивать значение; однако списки x и y можно изменять на месте по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив RGBA, соответствующий x.

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

Предусмотрен особый случай для обработки изображений, уже представленных в формате RGB или RGBA, например прочитанных из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение имеет длину 3 или 4, оно будет рассматриваться как массив RGB или RGBA, и преобразование выполняться не будет. Массив может иметь тип uint8 или содержать вещественные значения в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Все значения NaN и маскированные элементы получат альфа-значение 0. Если длина последнего измерения равна 3, параметр alpha (по умолчанию 1) будет использован для задания прозрачности. Если длина последнего измерения равна 4, параметр alpha игнорируется и не заменяет уже заданное альфа-значение. Если третье измерение имеет длину, отличную от 3 или 4, будет вызвано исключение ValueError.

В обоих случаях, если bytes равно False (по умолчанию), значения в массиве RGBA будут вещественными числами в диапазоне 0–1; если оно равно True, возвращаемый массив RGBA будет иметь тип uint8 и значения в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется; предполагается, что они находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого художника из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета по массиву скалярного отображения, если он задан.

Назначить цвета краям и заливке на основе массива и/или цветов, заданных напрямую, в соответствующих случаях.

zorder=0

classmatplotlib.collections.Collection(*, edgecolors=None, facecolors=None, linewidths=None, linestyles='solid', capstyle=None, joinstyle=None, antialiaseds=None, offsets=None, offset_transform=None, norm=None, cmap=None, colorizer=None, pickradius=5.0, hatch=None, urls=None, zorder=1, **kwargs)[исходный код]

Базовые классы: ColorizingArtist

Базовый класс для коллекций. Для использования его необходимо наследовать.

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

Большинство свойств коллекции можно настраивать отдельно для каждого элемента. Поэтому у коллекций есть «множественные» версии многих свойств объекта Patch (например, Collection.get_paths вместо Patch.get_path). Исключение составляют свойства zorder, hatch, pickradius, capstyle и joinstyle, которые можно задать только глобально для всей коллекции.

За исключением перечисленных выше свойств, все свойства можно задавать как одиночными значениями (применяемыми ко всем элементам), так и последовательностями значений. Свойство i-го элемента коллекции:

prop[i % len(prop)]

Каждую коллекцию при необходимости можно использовать как отдельный объект ScalarMappable, передав параметры norm и cmap её конструктору. Если матрица _A объекта ScalarMappable коллекции задана (вызовом Collection.set_array), то при отрисовке этот внутренний скалярный объект будет использован для задания facecolors и edgecolors, а значения, переданные вручную, будут проигнорированы.

Параметры:

edgecolorsцвет или список цветов, по умолчанию: rcParams["patch.edgecolor"] (значение по умолчанию: 'black')

Цвет контура каждого фрагмента, составляющего коллекцию. Специальное значение 'face' можно передать, чтобы цвет контура совпадал с цветом заливки.

facecolorsцвет или список цветов, по умолчанию: rcParams["patch.facecolor"] (значение по умолчанию: 'C0')

Цвет заливки каждого фрагмента, составляющего коллекцию.

linewidthsчисло с плавающей точкой или список чисел с плавающей точкой, по умолчанию: rcParams["patch.linewidth"] (значение по умолчанию: 1.0)

Толщина линий каждого фрагмента, составляющего коллекцию.

linestylesстрока, кортеж или список таких значений, по умолчанию: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь следующий формат:

(offset, onoffseq),

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

capstyleподобный CapStyle, по умолчанию: 'butt'

Стиль окончаний линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.

joinstyleподобный JoinStyle, по умолчанию: 'round'

Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.

antialiasedsлогическое значение или список логических значений, по умолчанию: rcParams["patch.antialiased"] (значение по умолчанию: True)

Следует ли рисовать каждый фрагмент коллекции с сглаживанием.

offsets(число с плавающей точкой, число с плавающей точкой) или список таких значений, по умолчанию: (0, 0)

Вектор, на который смещается каждый фрагмент после отрисовки (по умолчанию смещения нет). Смещение выполняется в экранных координатах (пикселях), то есть после применения преобразования Artist.

offset_transformTransform, по умолчанию: IdentityTransform

Единичное преобразование, применяемое к каждому вектору offsets перед его использованием.

cmap, norm

Параметры нормализации данных и сопоставления с цветами. Подробное описание см. в документации ScalarMappable.

hatchстрока, необязательный параметр

Штриховка для залитых путей, если она используется. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Значение каждого типа штриховки описано в разделе Справочник по стилям штриховки.

pickradiusчисло с плавающей точкой, по умолчанию: 5.0

Если pickradius <= 0, то Collection.contains вернёт True, если проверяемая точка находится внутри одного из многоугольников, образованных контрольными точками Path в коллекции. Если же значение больше 0, вместо этого проверяется, находится ли точка внутри штриха шириной 2*pickradius, проходящего вдоль любого из путей коллекции.

urlsсписок строк, по умолчанию: None

URL-ссылка для каждого фрагмента, по которой можно перейти после отрисовки. В настоящее время работает только с бэкендом SVG. Примеры см. в разделе Гиперссылки.

zorderчисло с плавающей точкой, по умолчанию: 1

Порядок отрисовки, общий для всех Patches в коллекции. Значения по умолчанию и примеры см. в разделе Демонстрация Zorder.

**kwargs

Оставшиеся именованные аргументы используются для задания свойств как Collection.set_{key}(val) для каждой пары ключ-значение в kwargs.

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая вызывается при изменении любого свойства Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Её сигнатура должна иметь следующий вид:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Функция может возвращать значения, но они игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позднее этот идентификатор можно использовать для удаления функции с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm с использованием текущего массива

autoscale_None()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm с использованием текущего массива, изменяя только пределы, равные None

propertyaxes: Экземпляр Axes, в котором находится Artist, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[исходный код]

Проверяет, произошло ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x с использованием типа единиц оси x.

Если Artist не входит в Axes или ось x не имеет единиц измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразует y с использованием типа единиц оси y.

Если Artist не входит в Axes или ось y не имеет единиц измерения, возвращается само значение y.

draw(renderer)[исходный код]

Рисует Artist (и его дочерние объекты) с помощью заданного визуализатора.

Ничего не делает, если Artist невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: Объект Figure или SubFigure, к которому относится Artist. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Находит объекты Artist.

Рекурсивно находит все экземпляры Artist, содержащиеся в Artist.

Параметры:

match

Критерий фильтрации результатов. Это может быть

None: возвращает все объекты, содержащиеся в Artist.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только те объекты Artist, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат войдут только объекты Artist этого класса или его подклассов (проверка isinstance).

include_selfлогическое значение

Включает self в список объектов, проверяемых на соответствие.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах Artist. Как конечный пользователь Matplotlib вы, скорее всего, не будете вызывать его самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы таких чисел в строку, разделённую запятыми и заключённую в квадратные скобки. Если же с Artist связана цветовая шкала, скалярные значения форматируются с помощью её форматировщика.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Возвращает функцию фильтрации для фильтра agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Возвращает признак анимации Artist.

get_antialiased()[исходный код]

Возвращает состояние сглаживания при отрисовке.

Возвращает:

массив логических значений

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Возвращает массив значений, сопоставляемых с цветами.

Базовый класс ScalarMappable не предполагает какую-либо размерность или форму массива.

get_capstyle()[исходный код]

Возвращает стиль окончаний линий для коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Возвращает список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Возвращает значения (min, max), сопоставляемые с пределами цветовой карты.

get_clip_box()[исходный код]: Возвращает область отсечения.

get_clip_on()[исходный код]: Возвращает признак использования отсечения для Artist.

get_clip_path()[исходный код]: Возвращает путь отсечения.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

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

Примечание

Artist могут использовать данные курсора для предоставления дополнительной контекстной информации о заданном событии. Реализация по умолчанию просто возвращает None.

Подклассы могут переопределить метод и возвращать произвольные данные. Однако при этом необходимо обеспечить возможность преобразования этих данных в строковое представление методом format_cursor_data.

В настоящее время этот метод используется только для отображения z-значения объекта AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит объект artist.

Параметры:

rootbool, по умолчанию False: Если False, возвращает (Sub)Figure, на которой находится этот объект artist. Если True, возвращает корневую Figure для вложенного дерева SubFigures.

get_fill()[исходный код]: Возвращает, закрашена ли внутренняя область.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает толщину линий штриховки.

get_in_layout()[исходный код]

Возвращает логический флаг, True если объект artist включён в расчёты компоновки.

Например, руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого объекта artist в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли для этого объекта artist пользовательские контекстные сведения при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого объекта artist.

get_offsets()[исходный код]: Возвращает смещения элементов коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение объекта artist при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растрировать объект artist.

get_sketch_params()[исходный код]

Возвращает параметры эскиза для объекта artist.

Возвращает:

tuple или None

Кортеж из 3 элементов:

scale: амплитуда колебаний перпендикулярно исходной линии.
length: длина колебаний вдоль линии.
randomness: коэффициент масштабирования, на который уменьшается или увеличивается длина.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Подобно Artist.get_window_extent, но учитывает отсечение.

Параметры:

rendererподкласс RendererBase, необязательный: рендерер, который будет использоваться для отрисовки фигур (то есть fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающий прямоугольник (в пиксельных координатах фигуры). Возвращает None, если после отсечения пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом artist.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает контур отсечения с применённой неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL — по одному для каждого элемента коллекции.

Для элементов без URL в списке указано None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает признак видимости.

get_window_extent(renderer=None)[исходный код]

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

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

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

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

get_zorder()[исходный код]: Возвращает zorder объекта artist.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения на какой-либо оси.

is_transform_set()[исходный код]

Возвращает, было ли для Artist явно задано преобразование.

Значение равно True после вызова set_transform.

propertymouseover: Возвращает, запрашиваются ли для этого объекта artist пользовательские контекстные сведения при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний объект artist вызывает событие выбора, если указатель mouseevent находится над ним и для объекта artist задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами объекта artist.

remove()[исходный код]

Удаляет художник с рисунка, если это возможно.

Изменение станет видимым только после перерисовки рисунка, например, с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи художника из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Задает несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой формы (m, n, 3) и значение dpi, а возвращает массив формы (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	массивоподобный объект, число с плавающей точкой или None
`animated`	bool
`antialiased`	bool или список значений bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor`	цвет или список значений цвет или 'face'
`facecolor`	цвет или список значений цвет
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle`	str, кортеж или список таких значений
`linewidth`	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform`	`Transform`
`offsets`	массивоподобный объект формы (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None, bool, число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`visible`	bool
`zorder`	число с плавающей точкой

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

set_agg_filter(filter_func)[исходный код]

Задает фильтр agg.

Параметры:

filter_funcвызываемый объект: Функция фильтра, которая принимает массив чисел с плавающей точкой формы (m, n, depth) и значение dpi, а возвращает массив формы (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaмассивоподобный объект, число с плавающей точкой или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и nan не поддерживаются.

set_animated(b)[исходный код]

Задает, предназначен ли художник для использования в анимации.

Если значение True, художник исключается из обычной отрисовки рисунка. Необходимо явно вызвать для художника Figure.draw_artist / Axes.draw_artist. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Ускорение отрисовки с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задает состояние сглаживания при отрисовке.

Параметры:

aabool или список значений bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задает массив значений из массивоподобного объекта A.

Параметры:

Aмассивоподобный объект или None

Значения, сопоставляемые цветам.

Базовый класс ScalarMappable не предполагает каких-либо ограничений на размерность и форму массива значений A.

set_capstyle(cs)[исходный код]

Задает CapStyle для коллекции (для всех ее элементов).

Параметры:

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

set_clim(vmin=None, vmax=None)[исходный код]

Задает пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxчисло с плавающей точкой

Пределы.

Для скалярных данных пределы также можно передать в виде кортежа (vmin, vmax) одним позиционным аргументом.

set_clip_box(clipbox)[исходный код]

Задает область отсечения художника Bbox.

Параметры:

clipboxBboxBase или None: Обычно создается на основе объекта TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) используется по умолчанию для отсечения художника, добавленного в Axes.

set_clip_on(b)[исходный код]

Задает, использует ли художник отсечение.

Если значение False, художники будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задает путь отсечения художника.

Параметры:

pathPatch или Path или TransformedPath или None: Путь отсечения. Если задан объект Path, необходимо также указать transform. Если задано значение None, ранее установленный путь отсечения удаляется.
transformTransform, необязательный параметр: Используется только в том случае, если path — объект Path; в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является объектом Rectangle, этот метод задает область отсечения, соответствующую прямоугольнику, и устанавливает путь отсечения в None.

По техническим причинам (для поддержки set) кортеж (path, transform) также принимается в качестве одного позиционного параметра.

set_cmap(cmap)[источник]

Задать цветовую карту для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[источник]

Задать цвет края и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для задания цвета края или заливки по отдельности.

set_dashes(ls)[источник]: Псевдоним для set_linestyle.

set_ec(c)[источник]: Псевдоним для set_edgecolor.

set_edgecolor(c)[источник]

Задать цвет(а) края коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет(а) края коллекции. Если задана последовательность, элементы коллекции перебирают её циклически. Если задано 'face', цвет совпадает с цветом заливки.

set_edgecolors(c)[источник]: Псевдоним для set_edgecolor.

set_facecolor(c)[источник]

Задать цвет(а) заливки коллекции. c может быть цветом (все элементы имеют один цвет) или последовательностью цветов; если задана последовательность, элементы будут перебирать её циклически.

Если c равно 'none', заливка элемента отсутствует.

Параметры:

cцвет или список цветов

set_facecolors(c)[источник]: Псевдоним для set_facecolor.

set_fc(c)[источник]: Псевдоним для set_facecolor.

set_figure(fig)[источник]

Задать экземпляр Figure или SubFigure, которому принадлежит художник.

Параметры:

figFigure или SubFigure

set_gid(gid)[источник]

Задать (групповой) идентификатор художника.

Параметры:

gidstr

set_hatch(hatch)[источник]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать — в этом случае будут применены все указанные узоры штриховки. Повторение одной и той же буквы увеличивает плотность соответствующего узора.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно задать только для всей коллекции, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[источник]: Задать толщину линии штриховки.

set_in_layout(in_layout)[источник]

Задать, следует ли включать художника в расчёты компоновки, например, в руководстве по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[источник]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[источник]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[источник]

Задать стиль(и) линий для коллекции.

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

Также можно задать кортеж параметров штриховки следующего вида:

(offset, onoffseq),

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

Параметры:

lsstr или tuple или список таких значений: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[источник]: Псевдоним для set_linestyle.

set_linewidth(lw)[источник]

Задать толщину линии (линий) коллекции. lw может быть скалярным значением или последовательностью; если задана последовательность, элементы будут перебирать её циклически

Параметры:

lwfloat или список значений float

set_linewidths(lw)[источник]: Псевдоним для set_linewidth.

set_ls(ls)[источник]: Псевдоним для set_linestyle.

set_lw(lw)[источник]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[источник]

Задать, следует ли запрашивать у этого художника дополнительную контекстную информацию при наведении на него курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[источник]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[источник]

Задать преобразование смещения художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[источник]

Задать смещения для коллекции.

Параметры:

offsetsмассивоподобный объект формы (N, 2) или (2,)

set_path_effects(path_effects)[источник]

Задать эффекты пути.

Параметры:

path_effectsсписок объектов AbstractPathEffect

set_paths(paths)[источник]

set_picker(picker)[источник]

Определить поведение выбора художника.

Параметры:

pickerNone или bool, float или callable

Может принимать одно из следующих значений:

None: выбор этого художника отключён (по умолчанию).
Логическое значение: если задано True, выбор будет включён, и художник сгенерирует событие выбора, если курсор мыши находится над ним.
Число с плавающей запятой: если picker — число, оно интерпретируется как допустимое отклонение в пунктах, и художник сгенерирует событие, если его данные находятся в пределах этого отклонения от события мыши. Для некоторых художников, например линий и коллекций контуров, в сгенерированное событие выбора могут быть добавлены дополнительные данные, например индексы данных, находящихся в пределах допустимого отклонения от точки выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, определяющая, попал ли курсор мыши на художника:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если событие мыши произошло над художником, верните hit=True, а props должен быть словарём свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[источник]

Задать радиус выбора для проверки вхождения.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[источник]

Принудительно включить растровую (битовую) отрисовку для векторного вывода.

Этот параметр игнорируется для вывода на основе пикселей.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[источник]

Задать параметры наброска.

Параметры:

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None или не задан, фильтр наброска применяться не будет.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент, определяющий степень уменьшения или увеличения длины (по умолчанию 16.0)

set_snap(snap)[исходный код]

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

Привязка выравнивает позиции по пиксельной сетке, что позволяет получать более чёткие изображения. Например, если чёрная линия шириной 1px задана в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть серое значение в обоих соседних пикселях. При привязке линия перемещается к ближайшему целочисленному значению пикселя, поэтому результирующее изображение действительно будет содержать чёрную линию шириной 1px.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (автоматически) Если путь содержит только прямолинейные сегменты, округлить до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование объекта Artist.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL для объекта Artist.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL-адреса реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_visible(b)[исходный код]

Задать видимость объекта Artist.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать zorder объекта Artist. Объекты Artist с меньшими значениями zorder рисуются первыми.

Параметры:

levelfloat

propertystale: Является ли объект Artist «устаревшим» и нуждается ли он в повторной отрисовке, чтобы выходные данные соответствовали внутреннему состоянию объекта Artist.

propertysticky_edges

x и y списки фиксированных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — пределы области просмотра «прилипают» к границе. Типичный пример — гистограммы, для которых обычно не ожидается отступа у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может их пересечь. Например, если верхний предел данных равен 1.0, верхний предел области просмотра, вычисленный простым добавлением отступа, равен 1.2, но на отметке 1.1 находится фиксированная граница, фактический верхний предел области просмотра будет равен 1.1.

Этому атрибуту нельзя присвоить значение, однако списки x и y можно изменять на месте по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скаляров, и будет возвращён соответствующий массив ndarray значений RGBA, основанный на норме и цветовой карте, заданных для этого Colorizer.

Предусмотрен особый случай для обработки изображений, уже представленных в формате RGB или RGBA, например считанных из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение равно 3 или 4, он будет рассматриваться как массив RGB или RGBA, и преобразование выполняться не будет. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвана ошибка ValueError. Значения NaN и замаскированные элементы получат альфа-канал 0. Если последнее измерение равно 3, для заполнения прозрачности будет использован аргумент alpha (по умолчанию равный 1). Если последнее измерение равно 4, аргумент alpha игнорируется и не заменяет существующее значение альфа-канала. Если третье измерение отлично от 3 или 4, будет вызвана ошибка ValueError.

Если norm равно False, нормализация входных данных не выполняется; предполагается, что их значения находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого объекта Artist из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из другого объекта в текущий.

update_scalarmappable()[исходный код]

Обновить цвета по массиву скалярного отображения, если он задан.

Назначить цвета границам и заливке на основе массива и/или непосредственно заданных цветов, если это применимо.

zorder=0

classmatplotlib.collections.EllipseCollection(widths, heights, angles, *, units='points', **kwargs)[исходный код]

Базовые классы: Collection

Коллекция эллипсов, нарисованных с помощью сплайнов.

Параметры:

widthsмассивоподобный объект: Длины первых осей (например, длины больших осей).
heightsмассивоподобный объект: Длины вторых осей.
anglesмассивоподобный объект: Углы первых осей в градусах против часовой стрелки от оси x.
units{'points', 'inches', 'dots', 'width', 'height', 'x', 'y', 'xy'}: Единицы измерения, в которых заданы большие и малые оси; 'width' и 'height' относятся к размерам осей координат, а 'x' и 'y' — к единицам данных смещений. 'xy' отличается от всех остальных тем, что отображаемый угол меняется в зависимости от соотношения сторон и совпадает с заданным углом только при соотношении сторон, равном единице. Поэтому он ведёт себя так же, как Ellipse с axes.transData в качестве преобразования.
**kwargs: Передаются в Collection.

add_callback(func)[исходный код]

Добавить функцию обратного вызова, которая будет вызываться при каждом изменении свойств Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующую сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Возвращаемые значения могут присутствовать, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позднее этот идентификатор можно использовать для удаления функции обратного вызова с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра norm с использованием текущего массива

autoscale_None()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра norm с использованием текущего массива, изменяя только пределы, равные None

свойствоaxes: Экземпляр Axes, в котором находится объект artist, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

свойствоcmap

свойствоcolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

свойствоcolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразовать x с использованием типа единиц оси x.

Если объект artist не содержится в Axes или ось x не имеет единиц измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразовать y с использованием типа единиц оси y.

Если объект artist не содержится в Axes или ось y не имеет единиц измерения, возвращается само значение y.

draw(renderer)[исходный код]

Нарисовать Artist (и его дочерние объекты) с помощью указанного средства визуализации.

Ничего не происходит, если объект artist невидим (Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

свойствоfigure: Объект (Sub)Figure, на котором находится artist. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Найти объекты artist.

Рекурсивно найти все экземпляры Artist, содержащиеся в объекте artist.

Параметры:

match

Критерий фильтрации совпадений. Это может быть

None: вернуть все объекты, содержащиеся в artist.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только объекты artist, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат войдут только объекты artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список объектов, проверяемых на соответствие.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Вернуть строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах artist. Как конечный пользователь Matplotlib вы, скорее всего, не будете вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы целых чисел и чисел с плавающей точкой в строку, разделённую запятыми и заключённую в квадратные скобки, если только с объектом artist не связана цветовая шкала; в этом случае скалярные значения форматируются с помощью форматтера цветовой шкалы.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Вернуть функцию фильтрации для фильтра agg.

get_alpha()[исходный код]: Вернуть значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_angles()[исходный код]: Получить углы первых осей в градусах против часовой стрелки от оси x.

get_animated()[исходный код]: Вернуть сведения о том, является ли объект artist анимированным.

get_antialiased()[исходный код]

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

Возвращает:

массив логических значений

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Вернуть массив значений, которые сопоставляются цветам.

Базовый класс ScalarMappable не накладывает никаких ограничений на размерность и форму массива.

get_capstyle()[исходный код]

Вернуть стиль окончания линий для коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Вернуть список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Вернуть значения (минимум, максимум), сопоставленные с пределами цветовой карты.

get_clip_box()[исходный код]: Вернуть область отсечения.

get_clip_on()[исходный код]: Вернуть сведения о том, использует ли объект artist отсечение.

get_clip_path()[исходный код]: Вернуть путь отсечения.

get_cmap()[исходный код]: Вернуть экземпляр Colormap.

get_cursor_data(event)[исходный код]

Вернуть данные курсора для заданного события.

Примечание

Объекты Artist могут использовать данные курсора для предоставления дополнительной контекстной информации о заданном событии. Реализация по умолчанию просто возвращает None.

Подклассы могут переопределить этот метод и возвращать произвольные данные. Однако при этом необходимо обеспечить, чтобы format_cursor_data мог преобразовать эти данные в строковое представление.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Вернуть экземпляр Figure или SubFigure, к которому относится объект artist.

Параметры:

rootbool, по умолчанию False: Если False, вернуть объект (Sub)Figure, на котором находится этот объект artist. Если True, вернуть корневой Figure для вложенного дерева SubFigure.

get_fill()[исходный код]: Вернуть сведения о том, задан ли цвет заливки.

get_gid()[исходный код]: Вернуть идентификатор группы.

get_hatch()[исходный код]: Вернуть текущий шаблон штриховки.

get_hatch_linewidth()[исходный код]: Возвращает ширину линии штриховки.

get_heights()[исходный код]: Задаёт длины вторых осей (например, малых осей).

get_in_layout()[исходный код]

Возвращает логический флаг, True, указывающий, включён ли объект Artist в расчёты компоновки.

Например, руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого объекта Artist в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Синоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Синоним для get_linewidth.

get_ls()[исходный код]: Синоним для get_linestyle.

get_lw()[исходный код]: Синоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли у этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого объекта Artist.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение объекта Artist при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, должна ли растеризоваться отрисовка объекта Artist.

get_sketch_params()[исходный код]

Возвращает параметры наброска для объекта Artist.

Возвращает:

кортеж или None

Кортеж из 3 элементов со следующими значениями:

scale: амплитуда колебаний перпендикулярно исходной линии.
length: длина колебаний вдоль линии.
randomness: коэффициент, на который уменьшается или увеличивается длина.

Возвращает None, если параметры наброска не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Аналогично Artist.get_window_extent, но с учётом обрезки.

Параметры:

rendererподкласс RendererBase, необязательный: средство отрисовки, которое будет использоваться для построения рисунков (т. е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Охватывающая ограничивающая рамка (в пиксельных координатах рисунка). Возвращает None, если в результате обрезки пересечения нет.

get_transOffset()[исходный код]: Синоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом Artist.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает контур обрезки с применённой неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Для элементов без URL в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает видимость.

get_widths()[исходный код]: Возвращает длины первых осей (например, большой оси).

get_window_extent(renderer=None)[исходный код]

Возвращает ограничивающую рамку объекта Artist в координатах области отображения.

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

Для включения в расчёт ограничивающей рамки «tight» подклассам следует переопределить этот метод. По умолчанию возвращается пустая ограничивающая рамка с координатами 0, 0.

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

get_zorder()[исходный код]: Возвращает порядок отрисовки объекта Artist.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения для какой-либо оси.

is_transform_set()[исходный код]

Возвращает, задано ли для объекта Artist явное преобразование.

Результат равен True после вызова set_transform.

propertymouseover: Возвращает, запрашиваются ли у этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний объект Artist вызовет событие выбора, если указатель mouseevent находится над ним и для объекта задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами объекта Artist.

remove()[исходный код]

Удаляет объект Artist с рисунка, если это возможно.

Изменение будет заметно только после повторной отрисовки рисунка, например с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи объекта Artist из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, angles=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, heights=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, widths=<UNSET>, zorder=<UNSET>)[исходный код]

Задать несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив float размера (m, n, 3) и значение dpi и возвращающая массив размера (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	массивоподобный объект, число с плавающей точкой или None
`angles`	неизвестно
`animated`	bool
`antialiased` или `aa` или `antialiaseds`	bool или список значений bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` или `ec` или `edgecolors`	цвет или список значений цвета или 'face'
`facecolor` или `facecolors` или `fc`	цвет или список значений цвета
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`heights`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` или `dashes` или `linestyles` или `ls`	str, кортеж или список таких значений
`linewidth` или `linewidths` или `lw`	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` или `transOffset`	`Transform`
`offsets`	массивоподобный объект размера (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None, bool, float или callable
`pickradius`	float
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`visible`	bool
`widths`	неизвестно
`zorder`	float

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

set_agg_filter(filter_func)[исходный код]

Задать фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, принимающая массив float размера (m, n, depth) и значение dpi и возвращающая массив размера (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задать значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_angles(angles)[исходный код]: Задать углы первых осей в градусах против часовой стрелки от оси x.

set_animated(b)[исходный код]

Задать, предназначен ли объект Artist для использования в анимации.

Если значение равно True, объект Artist исключается из обычной отрисовки фигуры. Для него необходимо явно вызвать Figure.draw_artist / Axes.draw_artist. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Ускорение отрисовки с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задать состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задать массив значений из массивоподобного объекта A.

Параметры:

Aarray-like or None

Значения, преобразуемые в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

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

set_clim(vmin=None, vmax=None)[исходный код]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать одним позиционным аргументом в виде кортежа (vmin, vmax).

set_clip_box(clipbox)[исходный код]

Задать область отсечения Artist Bbox.

Параметры:

clipboxBboxBase или None: Обычно создаётся на основе TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) — область отсечения по умолчанию для Artist, добавленного в Axes.

set_clip_on(b)[исходный код]

Задать, использует ли Artist отсечение.

Если значение равно False, объекты Artist будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать путь отсечения художника.

Параметры:

pathPatch or Path or TransformedPath or None: Путь отсечения. Если задан Path, необходимо также указать transform. Если задано значение None, ранее установленный путь отсечения удаляется.
transformTransform, необязательно: Используется только если path — это Path; в этом случае указанный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — это Rectangle, этот метод задаёт прямоугольную область отсечения и устанавливает путь отсечения в None.

По техническим причинам (для поддержки set) кортеж (path, transform) также принимается как единичный позиционный параметр.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных яркости.

Параметры:

cmapColormap or str or None

set_color(c)[исходный код]

Задать одновременно цвет края и цвет заливки.

Параметры:

cцвет or list of RGBA tuples

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для задания цвета края или заливки по отдельности.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвета края коллекции.

Параметры:

cцвет or list of цвет or 'face': Цвета края коллекции. Если задана последовательность, элементы коллекции перебирают её циклически. Если указано 'face', цвет совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвета заливки коллекции. c может быть цветом (все элементы коллекции будут одного цвета) или последовательностью цветов; если задана последовательность, элементы коллекции будут перебирать её циклически.

Если c равно 'none', заливка элемента не выполняется.

Параметры:

cцвет or list of цвет

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, которому принадлежит художник.

Параметры:

figFigure or SubFigure

set_gid(gid)[исходный код]

Задать (групповой) идентификатор художника.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

В отличие от других свойств, таких как ширина линии и цвета, узор штриховки можно задать только для всей коллекции целиком, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать ширину линии штриховки.

set_heights(heights)[исходный код]: Задать длины вторых осей (например, малых осей).

set_in_layout(in_layout)[исходный код]

Задать, должен ли художник учитываться при вычислении компоновки, например, в руководстве по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

jsJoinStyle or {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стили линии для коллекции.

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

Также можно указать кортеж параметров штриховки следующего вида:

(offset, onoffseq),

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

Параметры:

lsstr or tuple or list thereof: Допустимые значения для отдельных стилей линии: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать ширину линии для коллекции. lw может быть скалярным значением или последовательностью; если задана последовательность, элементы коллекции будут перебирать её циклически.

Параметры:

lwfloat or list of floats

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, будет ли выполняться запрос к этому художнику для получения пользовательской контекстной информации при перемещении над ним курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize or str or None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsets(N, 2) or (2,) array-like

set_path_effects(path_effects)[исходный код]

Задать эффекты пути.

Параметры:

path_effectslist of AbstractPathEffect

set_paths(paths)[исходный код]

set_picker(picker)[исходный код]

Определить поведение выбора художника.

Параметры:

pickerNone or bool or float or callable

Возможны следующие значения:

None: выбор для этого художника отключён (значение по умолчанию).
Логическое значение: если задано True, выбор будет включён, и художник вызовет событие выбора, если событие мыши произойдёт над ним.
Число с плавающей точкой: если picker — это число, оно трактуется как допуск epsilon в пунктах; художник вызовет событие, если его данные находятся от события мыши на расстоянии не более epsilon. Для некоторых художников, например линий и коллекций фигур, в сгенерированное событие выбора могут передаваться дополнительные данные, например индексы данных, находящихся в пределах epsilon от события выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, которая определяет, затронут ли художник событием мыши:
```
hit, props = picker(artist, mouseevent)
```
для выполнения проверки попадания. Если событие мыши произошло над художником, верните hit=True; props — это словарь свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый при проверках принадлежности.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно включить растровую (битовую) отрисовку для вывода векторной графики.

Растровая отрисовка поддерживается не всеми объектами Artist. Если попытаться включить её для объекта, который её не поддерживает, команда не даст эффекта и будет выдано предупреждение.

Этот параметр игнорируется при выводе на основе пикселей.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эскиза.

Параметры:

scalefloat, optional

Амплитуда колебаний перпендикулярно исходной линии, в пикселях. Если scale равен None или не задан, фильтр эскиза применяться не будет.

lengthfloat, optional

Длина колебаний вдоль линии, в пикселях (по умолчанию 128.0)

randomnessfloat, optional

Коэффициент, на который умножается длина для её уменьшения или увеличения (по умолчанию 16.0)

set_snap(snap)[исходный код]

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

Привязка выравнивает положения по пиксельной сетке, что позволяет получать более чёткие изображения. Например, если чёрная линия шириной 1px задана в положении между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке — серое значение в обоих соседних пикселях. При привязке линия перемещается к ближайшему целочисленному значению пикселя, поэтому результирующее изображение действительно будет содержать чёрную линию шириной 1px.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Допустимые значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять положения вершин.
None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить координаты до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование объекта Artist.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL для объекта Artist.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL поддерживаются только бэкендом SVG. Все остальные бэкенды их игнорируют.

set_visible(b)[исходный код]

Задать видимость объекта Artist.

Параметры:

bbool

set_widths(widths)[исходный код]: Задать длины первых осей (например, большой оси).

set_zorder(level)[исходный код]

Задать zorder для объекта Artist. Объекты Artist с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли объект Artist «устаревшим» и требует ли он повторной отрисовки для соответствия вывода внутреннему состоянию объекта Artist.

propertysticky_edges

Списки закреплённых краёв x и y для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, поле не добавляется — пределы области просмотра «прилипают» к краю. Типичный пример — гистограммы, у которых обычно не ожидается поле у нижнего края (0).

Кроме того, расширение поля «упирается» в закреплённые края и не может пересечь их. Например, если верхний предел данных равен 1.0, верхний предел области просмотра, вычисленный простым добавлением поля, равен 1.2, но закреплённый край находится на 1.1, фактический верхний предел области просмотра будет равен 1.1.

Этому атрибуту нельзя присвоить значение; однако списки x и y при необходимости можно изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив RGBA, соответствующий x.

В обычном случае x представляет собой одномерную или двумерную последовательность скалярных значений; на основе нормализации и цветовой карты, заданных для этого Colorizer, будет возвращён соответствующий массив ndarray значений RGBA.

Есть один особый случай — обработка изображений, уже представленных в формате RGB или RGBA, например, считанных из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение имеет размер 3 или 4, оно будет интерпретировано как массив RGB или RGBA, и преобразование выполняться не будет. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Значения NaN и замаскированные элементы получат альфа-значение 0. Если размер последнего измерения равен 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если размер последнего измерения равен 4, аргумент alpha игнорируется: он не заменяет существующее альфа-значение. Если третье измерение имеет размер, отличный от 3 или 4, будет вызвано исключение ValueError.

update(props)[исходный код]

Обновить свойства этого объекта Artist значениями из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета на основе массива ScalarMappable, если он задан.

Назначить цвета краям и заливкам на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.EventCollection(positions, orientation='horizontal', *, lineoffset=0, linelength=1, linewidth=None, color=None, linestyle='solid', antialiased=None, **kwargs)[исходный код]

Базовые классы: LineCollection

Коллекция расположений вдоль одной оси, в которых произошло «событие».

События задаются одномерным массивом. У них нет амплитуды, и они отображаются в виде параллельных линий.

Параметры:

positionsмассивоподобный объект размерности 1

Каждое значение обозначает событие.

orientation{'horizontal', 'vertical'}, по умолчанию: 'horizontal'

Последовательность событий строится вдоль этого направления. Маркерные линии отдельных событий направлены ортогонально ему.

lineoffsetчисло с плавающей точкой, по умолчанию: 0

Смещение центра маркеров относительно начала координат в направлении, ортогональном orientation.

linelengthчисло с плавающей точкой, по умолчанию: 1

Полная высота маркера (т. е. маркер простирается от lineoffset - linelength/2 до lineoffset + linelength/2).

linewidthчисло с плавающей точкой или список таких значений, по умолчанию: rcParams["lines.linewidth"] (по умолчанию: 1.5)

Ширина линий событий в пунктах.

colorцвет или список цветов, по умолчанию: rcParams["lines.color"] (по умолчанию: 'C0')

Цвет линий событий.

linestyleстрока, кортеж или список таких значений, по умолчанию: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь следующий вид:

(offset, onoffseq),

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

antialiasedлогическое значение или список таких значений, по умолчанию: rcParams["lines.antialiased"] (по умолчанию: True)

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

**kwargs

Передаются в LineCollection.

Примеры

(Source code, 2x.png, png)

add_callback(func)[исходный код]

Добавить функцию обратного вызова, которая будет вызываться при каждом изменении свойств Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения могут быть, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позже этот идентификатор можно использовать для удаления функции с помощью remove_callback.

См. также

remove_callback

add_positions(position)[исходный код]: Добавить одно или несколько событий в указанных позициях.

append_positions(position)[исходный код]: Добавить одно или несколько событий в указанных позициях.

autoscale()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра нормализации, используя текущий массив.

autoscale_None()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра нормализации, используя текущий массив; изменять только пределы со значением None.

свойствоaxes: Экземпляр Axes, в котором находится объект-художник, или None.

changed()[исходный код]: Вызывать при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

свойствоcmap

свойствоcolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None.

свойствоcolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразовать x с использованием типа единиц оси x.

Если объект-художник не принадлежит объекту Axes или ось x не имеет единиц измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразовать y с использованием типа единиц оси y.

Если объект-художник не принадлежит объекту Axes или ось y не имеет единиц измерения, возвращается само значение y.

draw(renderer)[исходный код]

Нарисовать объект-художник (и его дочерние объекты) с помощью указанного средства визуализации.

Ничего не происходит, если объект-художник невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

extend_positions(position)[исходный код]: Добавить одно или несколько событий в указанных позициях.

свойствоfigure: Объект (Sub)Figure, к которому относится объект-художник. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Найти объекты-художники.

Рекурсивно найти все экземпляры Artist, содержащиеся в объекте-художнике.

Параметры:

match

Критерий фильтрации совпадений. Возможны следующие значения:

None: вернуть все объекты, содержащиеся в объекте-художнике.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат попадут только те объекты-художники, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат попадут только объекты-художники этого класса или его подклассов (проверка isinstance).

include_selfлогическое значение

Включить self в список объектов, проверяемых на совпадение.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Вернуть строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах объектов-художников. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы таких чисел в строку со значениями через запятую в квадратных скобках. Если с объектом-художником связана цветовая шкала, скалярные значения форматируются с помощью её форматтера.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Вернуть функцию фильтрации, используемую для фильтра agg.

get_alpha()[исходный код]: Вернуть значение альфа-канала, используемое для смешивания; поддерживается не всеми серверными модулями.

get_animated()[исходный код]: Вернуть сведения о том, является ли объект-художник анимированным.

get_antialiased()[исходный код]

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

Возвращает:

массив логических значений

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Вернуть массив значений, сопоставленных с цветами.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[исходный код]

Вернуть стиль окончания линий коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Вернуть список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Вернуть значения (минимум, максимум), сопоставленные с пределами цветовой карты.

get_clip_box()[исходный код]: Вернуть область отсечения.

get_clip_on()[исходный код]: Вернуть сведения о том, используется ли для объекта-художника отсечение.

get_clip_path()[исходный код]: Вернуть путь отсечения.

get_cmap()[исходный код]: Вернуть экземпляр Colormap.

get_color()[исходный код]: Вернуть цвет линий, обозначающих каждое событие.

get_colors()[исходный код]

get_cursor_data(event)[исходный код]

Вернуть данные курсора для заданного события.

Примечание

Объекты-художники могут использовать данные курсора, чтобы предоставлять дополнительную контекстную информацию для заданного события. Реализация по умолчанию просто возвращает None.

Подклассы могут переопределять этот метод и возвращать произвольные данные. При этом необходимо обеспечить возможность преобразования данных в строковое представление методом format_cursor_data.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит художник.

Параметры:

rootbool, по умолчанию False: Если False, возвращает (под)фигуру, на которой находится этот художник. Если True, возвращает корневую Figure для вложенного дерева SubFigure.

get_fill()[исходный код]: Возвращает, закрашена ли внутренняя область.

get_gapcolor()[исходный код]

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает толщину линий штриховки.

get_in_layout()[исходный код]

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

Например, руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого художника в легенде.

get_linelength()[исходный код]: Возвращает длину линий, используемых для отметки каждого события.

get_lineoffset()[исходный код]: Возвращает смещение линий, используемых для отметки каждого события.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]: Возвращает толщину линий, используемых для отметки каждого события.

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли у этого художника дополнительные сведения при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого художника.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_orientation()[исходный код]: Возвращает ориентацию линии событий ('horizontal' или 'vertical').

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение художника при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_positions()[исходный код]: Возвращает массив, содержащий значения позиций с плавающей точкой.

get_rasterized()[исходный код]: Возвращает, следует ли растеризовать художника.

get_segments()[исходный код]

Возвращает:

list: Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()[исходный код]

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

Возвращает:

tuple или None

Кортеж из 3 элементов:

scale: амплитуда колебания перпендикулярно исходной линии.
length: длина колебания вдоль линии.
randomness: коэффициент, определяющий, во сколько раз длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Подобно Artist.get_window_extent, но учитывает обрезку.

Параметры:

rendererподкласс RendererBase, необязательный: визуализатор, который будет использоваться для отрисовки фигур (т. е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающая рамка (в пиксельных координатах фигуры). Возвращает None, если в результате обрезки пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим художником.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой неаффинной частью преобразования, а также оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL-адресов — по одному для каждого элемента коллекции.

Для элементов без URL в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer=None)[исходный код]

Возвращает ограничивающую рамку художника в координатах отображения.

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

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

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

get_zorder()[исходный код]: Возвращает zorder художника.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения хотя бы для одной оси.

is_horizontal()[исходный код]: True, если коллекция событий горизонтальная, и False, если вертикальная.

is_transform_set()[исходный код]

Возвращает, задано ли для Artist преобразование явно.

Значение равно True после вызова set_transform.

propertymouseover: Возвращает, запрашиваются ли у этого художника дополнительные сведения при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция запускается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний художник вызовет событие выбора, если курсор mouseevent находится над художником и для него задан picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[источник]

Возвращает, можно ли выбрать объект Artist.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[источник]: Возвращает словарь со всеми свойствами объекта Artist.

remove()[источник]

Удаляет объект Artist из фигуры, если это возможно.

Изменение станет видимым после перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы осей.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена на оси с параметром autolim = True.

Примечание: удаление записи объекта Artist из легенды не поддерживается.

remove_callback(oid)[источник]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, colors=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gapcolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linelength=<UNSET>, lineoffset=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, orientation=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, positions=<UNSET>, rasterized=<UNSET>, segments=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[источник]

Задаёт несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтрации, принимающая массив чисел с плавающей точкой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от левого нижнего угла изображения
`alpha`	array-like или float, или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	array-like или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform), или None
`cmap`	`Colormap` или str, или None
`color`	цвет или список значений цвет
`colors`	цвет или список значений цвет
`edgecolor` or `ec` or `edgecolors`	цвет или список значений цвет, или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список значений цвет
`figure`	`Figure` или `SubFigure`
`gapcolor`	цвет или список значений цвет, или None
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linelength`	неизвестно
`lineoffset`	неизвестно
`linestyle` or `dashes` or `linestyles` or `ls`	str, tuple или список таких значений
`linewidth` or `linewidths` or `lw`	float или список значений float
`mouseover`	bool
`norm`	`Normalize` или str, или None
`offset_transform` or `transOffset`	`Transform`
`offsets`	array-like формы (N, 2) или (2,)
`orientation`	{'horizontal', 'vertical'}
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None, bool, float или callable
`pickradius`	float
`positions`	неизвестно
`rasterized`	bool
`segments`	неизвестно
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`verts`	неизвестно
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[источник]

Задаёт фильтр agg.

Параметры:

filter_funccallable: Функция фильтрации, принимающая массив чисел с плавающей точкой формы (m, n, depth) и значение dpi и возвращающая массив формы (m, n, depth) и два смещения от левого нижнего угла изображения

set_alpha(alpha)[источник]

Задаёт значение альфа-канала, используемое при смешивании; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[источник]

Задаёт, предназначен ли объект Artist для использования в анимации.

Если значение True, объект Artist исключается из обычной отрисовки фигуры. Необходимо явно вызвать для объекта Artist Figure.draw_artist / Axes.draw_artist. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Ускорение отрисовки с помощью blitting.

Параметры:

bbool

set_antialiased(aa)[источник]

Задаёт состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[источник]: Псевдоним для set_antialiased.

set_array(A)[источник]

Задаёт массив значений из объекта array-like A.

Параметры:

Aarray-like or None

Значения, которые преобразуются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

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

set_clim(vmin=None, vmax=None)[исходный код]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать в виде кортежа (vmin, vmax) одним позиционным аргументом.

set_clip_box(clipbox)[исходный код]

Задать область отсечения художника: Bbox.

Параметры:

clipboxBboxBase или None: Обычно создаётся из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) является областью отсечения по умолчанию для художника, добавленного в Axes.

set_clip_on(b)[исходный код]

Задать, использует ли художник отсечение.

Если значение False, художники будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать путь отсечения художника.

Параметры:

pathPatch или Path или TransformedPath или None: Путь отсечения. Если передан объект Path, необходимо также указать transform. Если значение равно None, ранее заданный путь отсечения удаляется.
transformTransform, необязательно: Используется только в том случае, если path — это Path; в этом случае переданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является объектом Rectangle, этот метод задаст область отсечения, соответствующую этому прямоугольнику, и установит путь отсечения в None.

По техническим причинам (для поддержки set) также принимается кортеж (path, transform) в качестве одного позиционного параметра.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных о яркости.

Параметры:

cmapColormap или str или None

set_color(c)[исходный код]

Задать цвет(а) границ LineCollection.

Параметры:

cцвет или список значений цвет: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если задана последовательность, линии будут циклически использовать её элементы.

set_colors(c)[исходный код]

Задать цвет(а) границ LineCollection.

Параметры:

cцвет или список значений цвет: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если задана последовательность, линии будут циклически использовать её элементы.

set_dashes(ls)[исходный код]: Синоним для set_linestyle.

set_ec(c)[исходный код]: Синоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет(а) границ коллекции.

Параметры:

cцвет или список значений цвет или 'face': Цвет(а) границ коллекции. Если задана последовательность, элементы коллекции будут циклически использовать её элементы. Если указано 'face', цвет границ будет совпадать с цветом заливки.

set_edgecolors(c)[исходный код]: Синоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет(а) заливки коллекции. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если задана последовательность, элементы будут циклически использовать её элементы.

Если c равно 'none', элемент не будет залит.

Параметры:

cцвет или список значений цвет

set_facecolors(c)[исходный код]: Синоним для set_facecolor.

set_fc(c)[исходный код]: Синоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, к которому принадлежит художник.

Параметры:

figFigure или SubFigure

set_gapcolor(gapcolor)[исходный код]

Задать цвет для заполнения промежутков в пунктирной линии.

Примечание

Полосатые линии создаются путём рисования двух чередующихся пунктирных линий. Они могут накладываться друг на друга, что при использовании прозрачности может приводить к артефактам.

Эта функциональность является экспериментальной и может измениться.

Параметры:

gapcolorцвет или список значений цвет или None: Цвет для заполнения промежутков. Если значение равно None, промежутки не заполняются.

set_gid(gid)[исходный код]

Задать идентификатор (группы) для художника.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать шаблон штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать — в этом случае применяются все указанные варианты штриховки. Повторение одной и той же буквы увеличивает плотность штриховки соответствующего шаблона.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно задавать только для коллекции в целом, а не отдельно для каждого её элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать ширину линии штриховки.

set_in_layout(in_layout)[исходный код]

Задать, следует ли включать художника в расчёты компоновки, например, в руководстве по constrained layout, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linelength(linelength)[исходный код]: Задать длину линий, используемых для обозначения каждого события.

set_lineoffset(lineoffset)[исходный код]: Задать смещение линий, используемых для обозначения каждого события.

set_linestyle(ls)[исходный код]

Задать стиль(и) линии для коллекции.

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

Также можно передать кортеж параметров штриховки следующего вида:

(offset, onoffseq),

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

Параметры:

lsstr или tuple или list thereof: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Синоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать ширину линии (линий) для коллекции. lw может быть скаляром или последовательностью; если задана последовательность, элементы коллекции будут циклически использовать её элементы.

Параметры:

lwfloat or list of floats

set_linewidths(lw)[исходный код]: Синоним для set_linewidth.

set_ls(ls)[исходный код]: Синоним для set_linestyle.

set_lw(lw)[исходный код]: Синоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения коллекции.

Параметры:

offsets(N, 2) или (2,) массивоподобный объект

set_orientation(orientation)[исходный код]

Задать ориентацию линии событий.

Параметры:

orientation{'horizontal', 'vertical'}

set_path_effects(path_effects)[исходный код]

Задать эффекты пути.

Параметры:

path_effectsсписок из AbstractPathEffect

set_paths(segments)[исходный код]

set_picker(picker)[исходный код]

Определить поведение художника при выборе.

Параметры:

pickerNone или bool или float или callable

Это может быть одно из следующих значений:

None: Выбор для этого художника отключён (по умолчанию).
Логическое значение: Если задано True, выбор будет включён, и художник сгенерирует событие выбора, если событие мыши произошло над художником.
Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск epsilon в пунктах, и художник сгенерирует событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых художников, например линий и коллекций контуров, художник может предоставить дополнительные данные для сгенерированного события выбора, например индексы данных, находящихся в пределах epsilon от события выбора.
Функция: Если picker является вызываемым объектом, это предоставленная пользователем функция, которая определяет, попал ли курсор мыши в область художника:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если событие мыши произошло над художником, верните hit=True, а props должен быть словарём свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый для проверок принадлежности.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_positions(positions)[исходный код]: Задать положения событий.

set_rasterized(rasterized)[исходный код]

Принудительно использовать растровую (битовую) отрисовку для вывода векторной графики.

Этот параметр игнорируется при выводе в пиксельном формате.

См. также Растрирование векторной графики.

Параметры:

rasterizedbool

set_segments(segments)[исходный код]

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры наброска.

Параметры:

scalefloat, необязательный

Амплитуда колебаний перпендикулярно исходной линии, в пикселях. Если значение scale равно None или не указано, фильтр наброска применяться не будет.

lengthfloat, необязательный

Длина колебания вдоль линии, в пикселях (по умолчанию 128.0)

randomnessfloat, необязательный

Коэффициент, задающий уменьшение или увеличение длины (по умолчанию 16.0)

set_snap(snap)[исходный код]

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

Привязка выравнивает положения по пиксельной сетке, что позволяет получать более чёткие изображения. Например, если чёрная линия шириной 1 пиксель задана в положении между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть оба соседних пикселя будут серыми. При привязке линия перемещается к ближайшему целочисленному значению пикселя, и в результирующем изображении действительно будет чёрная линия шириной 1 пиксель.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool или None

Возможные значения:

True: привязать вершины к ближайшим центрам пикселей.
False: не изменять положения вершин.
None: (автоматически) если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование художника.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL художника.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlsсписок из str или None

Примечания

В настоящее время URL реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_verts(segments)[исходный код]

set_visible(b)[исходный код]

Задать видимость художника.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать порядок отрисовки художника. Художники с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли художник «устаревшим» и требует ли он повторной отрисовки, чтобы вывод соответствовал внутреннему состоянию художника.

propertysticky_edges

x и y списки фиксированных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — предел отображения «прилипает» к границе. Типичный пример — гистограммы, для которых обычно не нужен отступ у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может пересечь их. Например, если верхний предел данных равен 1.0, верхний предел отображения, вычисленный простым добавлением отступа, равен 1.2, но фиксированная граница находится на 1.1, то фактический верхний предел отображения будет равен 1.1.

Этому атрибуту нельзя присвоить значение; однако списки x и y можно при необходимости изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

switch_orientation()[исходный код]: Переключить ориентацию линии событий с вертикальной на горизонтальную или наоборот.

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Вернуть нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скалярных значений, и будет возвращён соответствующий массив значений RGBA в виде ndarray на основе нормализации и цветовой карты, заданных для этого Colorizer.

Есть один особый случай обработки изображений, которые уже представлены в формате RGB или RGBA, например прочитаны из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение равно 3 или 4, он будет считаться массивом RGB или RGBA, и преобразование выполняться не будет. Массив может иметь тип uint8 либо содержать значения с плавающей точкой в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Все значения NaN и маскированные элементы будут иметь альфа-значение 0. Если последнее измерение равно 3, аргумент alpha (по умолчанию равный 1) будет использован для задания прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется и не заменяет уже имеющееся альфа-значение. Если третье измерение не равно 3 или 4, будет вызвано исключение ValueError.

В обоих случаях, если bytes равно False (по умолчанию), массив RGBA будет содержать значения с плавающей точкой в диапазоне 0–1; если оно равно True, возвращаемый массив RGBA будет иметь тип uint8 и значения в диапазоне от 0 до 255.

update(props)[исходный код]

Обновить свойства этого художника из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета на основе массива скалярного отображаемого объекта, если он есть.

zorder=0

classmatplotlib.collections.FillBetweenPolyCollection(t_direction, t, f1, f2, *, where=None, interpolate=False, step=None, **kwargs)[исходный код]

Базовые классы: PolyCollection

PolyCollection, заполняющий область между двумя кривыми по x или y.

Параметры:

t_direction{{'x', 'y'}}

Ось, вдоль которой расположена переменная.

'x': кривые — (t, f1) и (t, f2).
'y': кривые — (f1, t) и (f2, t).

tarray-like

Координаты t_direction узлов, задающих кривые.

f1array-like or float

Другие координаты узлов, задающих первую кривую.

f2array-like or float

Другие координаты узлов, задающих вторую кривую.

wherearray-like of bool, optional

Задаёт where, чтобы исключить некоторые области по {dir} из заливки. Заливаемые области определяются координатами t[where]. Точнее, заливка выполняется между t[i] и t[i+1], если where[i] and where[i+1]. Обратите внимание, что согласно этому определению, отдельное значение True между двумя значениями False в where не приведёт к заливке. Обе стороны от позиции True останутся незалитыми из-за соседних значений False.

interpolatebool, default: False

Этот параметр имеет значение только в том случае, если используется where и две кривые пересекаются.

Семантически where часто используется для условия f1 > f2 или подобного. По умолчанию узлы многоугольника, задающего заполняемую область, располагаются только в позициях массива t. Такой многоугольник не может описать указанную семантику вблизи точки пересечения. Участки t, содержащие точку пересечения, просто обрезаются.

Если установить interpolate в значение True, будет вычислена фактическая точка пересечения, а заполняемая область будет продлена до этой точки.

step{{'pre', 'post', 'mid'}}, optional

Задаёт step, если заливка должна быть ступенчатой функцией, то есть постоянной между значениями t. Значение определяет положение ступени:

'pre': Значение f продолжается постоянным влево от каждой позиции t, то есть интервал (t[i-1], t[i]] имеет значение f[i].
'post': Значение y продолжается постоянным вправо от каждой позиции x, то есть интервал [t[i], t[i+1]) имеет значение f[i].
'mid': Ступени располагаются посередине между позициями t.

**kwargs

Передаются в PolyCollection.

См. также

Axes.fill_between, Axes.fill_betweenx

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая будет вызываться при изменении любого из свойств объекта Artist.

Параметры:

funccallable

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения допустимы, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позже этот идентификатор можно использовать для удаления функции с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив, изменяя только пределы со значением None

propertyaxes: Экземпляр Axes, в котором находится объект artist, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x в соответствии с типом единиц оси x.

Если объект artist не входит в Axes или для оси x не заданы единицы измерения, возвращается сам x.

convert_yunits(y)[исходный код]

Преобразует y в соответствии с типом единиц оси y.

Если объект artist не входит в Axes или для оси y не заданы единицы измерения, возвращается сам y.

draw(renderer)[исходный код]

Рисует объект Artist (и его дочерние объекты) с помощью указанного рендерера.

Ничего не делает, если объект artist невидим (Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: (Под)фигура, на которой находится объект artist. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Находит объекты artist.

Рекурсивно находит все экземпляры Artist, содержащиеся в объекте artist.

Параметры:

match

Критерий фильтрации для совпадений. Это может быть

None: возвращает все объекты, содержащиеся в объекте artist.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только объекты artist, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат войдут только объекты artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включает self в список объектов, проверяемых на соответствие.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах Artist. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы целых чисел и чисел с плавающей точкой в строку, разделённую запятыми и заключённую в квадратные скобки. Если с объектом связана цветовая шкала, скалярные значения форматируются с помощью форматтера цветовой шкалы.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Возвращает функцию фильтрации для фильтра agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Возвращает, является ли объект artist анимированным.

get_antialiased()[исходный код]

Возвращает состояние сглаживания при отрисовке.

Возвращает:

массив логических значений

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Возвращает массив значений, сопоставленных с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

Возвращает стиль окончания линий для коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Возвращает список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Возвращает значения (min, max), сопоставленные с пределами цветовой карты.

get_clip_box()[исходный код]: Возвращает область отсечения.

get_clip_on()[исходный код]: Возвращает, использует ли объект artist отсечение.

get_clip_path()[исходный код]: Возвращает контур отсечения.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

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

Примечание

Подклассы могут переопределить этот метод и возвращать произвольные данные. Однако при этом необходимо обеспечить, чтобы format_cursor_data мог преобразовать данные в строковое представление.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]: Вычисляет пределы данных и возвращает их в виде объекта Bbox.

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит художник.

Параметры:

rootbool, по умолчанию False: Если False, возвращает (Sub)Figure, на котором расположен этот художник. Если True, возвращает корневой Figure для вложенного дерева SubFigures.

get_fill()[исходный код]: Возвращает, залита ли лицевая сторона цветом.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает толщину линий штриховки.

get_in_layout()[исходный код]

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

Например, руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого художника в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашивается ли для этого художника дополнительная контекстная информация при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого художника.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

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

Допустимые значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растеризовать художника.

get_sizes()[исходный код]

Возвращает размеры («площади») элементов коллекции.

Возвращает:

array: «Площадь» каждого элемента.

get_sketch_params()[исходный код]

Возвращает параметры эскиза для художника.

Возвращает:

tuple или None

Кортеж из трёх элементов:

scale: амплитуда колебаний перпендикулярно исходной линии.
length: длина колебаний вдоль линии.
randomness: коэффициент, на который умножается длина для её уменьшения или увеличения.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Подобно Artist.get_window_extent, но учитывает обрезку.

Параметры:

rendererподкласс RendererBase, необязательный: средство визуализации, которое будет использоваться для отрисовки фигур (например, fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающий прямоугольник (в координатах пикселей фигуры). Возвращает None, если в результате обрезки пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим художником.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Для элементов без URL в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer=None)[исходный код]

Возвращает ограничивающую рамку художника в пространстве отображения.

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

Подклассы должны переопределять этот метод, чтобы включать объект в расчёт ограничивающей рамки «tight». По умолчанию возвращается пустая ограничивающая рамка в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает zorder художника.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения хотя бы для одной оси.

is_transform_set()[исходный код]

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

Это значение равно True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли для этого художника дополнительная контекстная информация при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция запускается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний художник генерирует событие выбора, если mouseevent произошло над ним и для художника задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

Возвращает, можно ли выбрать художника.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами художника.

remove()[исходный код]

Удаляет художника из фигуры, если это возможно.

Результат станет виден после перерисовки фигуры, например с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи художника из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору его наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, data=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

Одновременная установка нескольких свойств.

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

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив с плавающей точкой размером (m, n, 3) и значение dpi и возвращающая массив размером (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	массивоподобное значение, число с плавающей точкой или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	массивоподобное значение или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap`, str или None
`color`	цвет или список кортежей RGBA
`data`	массивоподобное значение
`edgecolor` or `ec` or `edgecolors`	цвет или список значений цвет или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список значений цвет
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `dashes` or `linestyles` or `ls`	str, кортеж или список таких значений
`linewidth` or `linewidths` or `lw`	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize`, str или None
`offset_transform` or `transOffset`	`Transform`
`offsets`	массивоподобное значение размером (N, 2) или (2,)
`path_effects`	список значений `AbstractPathEffect`
`paths`	список массивоподобных значений
`picker`	None, bool, число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	`numpy.ndarray` или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`verts`	список массивоподобных значений
`verts_and_codes`	неизвестно
`visible`	bool
`zorder`	число с плавающей точкой

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

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funcвызываемый объект: Функция фильтра, принимающая массив с плавающей точкой размером (m, n, depth) и значение dpi и возвращающая массив размером (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[source]

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

Параметры:

alphaмассивоподобное значение, число с плавающей точкой или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли объект Artist для использования в анимации.

Если значение True, объект Artist исключается из обычной отрисовки рисунка. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для этого объекта Artist. Такой подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Ускорение отрисовки с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[source]

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

Параметры:

aabool или список значений bool

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

set_array(A)[source]

Установить массив значений из массивоподобного объекта A.

Параметры:

Aмассивоподобное значение или None

Значения, сопоставляемые цветам.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[source]

Установить CapStyle для коллекции (для всех ее элементов).

Параметры:

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

set_clim(vmin=None, vmax=None)[source]

Установить пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxчисло с плавающей точкой

Пределы.

Для скалярных данных пределы также можно передать в виде кортежа (vmin, vmax) одним позиционным аргументом.

set_clip_box(clipbox)[source]

Установить область отсечения Bbox объекта Artist.

Параметры:

clipboxBboxBase или None: Обычно создается на основе TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) — область отсечения по умолчанию для объекта Artist, добавленного в Axes.

set_clip_on(b)[source]

Установить, использует ли объект Artist отсечение.

Если значение False, объекты Artist будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать контур отсечения художника.

Параметры:

pathPatch или Path или TransformedPath или None: Контур отсечения. Если передан объект Path, необходимо также указать transform. Если задано значение None, ранее установленный контур отсечения удаляется.
transformTransform, необязательно: Используется только если path является объектом Path; в этом случае переданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является объектом Rectangle, этот метод задаёт область отсечения соответствующим прямоугольником, а контур отсечения устанавливает в None.

По техническим причинам (поддержка set) также допускается передавать кортеж (path, transform) как один позиционный параметр.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[исходный код]

Задать цвет границы и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

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

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_data(t, f1, f2, *, where=None)[исходный код]

Задать новые значения для двух ограничивающих кривых.

Параметры:

tarray-like: Координаты self.t_direction узлов, определяющих кривые.
f1array-like или float: Другие координаты узлов, определяющих первую кривую.
f2array-like или float: Другие координаты узлов, определяющих вторую кривую.
wherearray-like из bool, необязательно: С помощью where задаются области {dir}, которые не следует заливать. Заливаемые области определяются координатами t[where]. Точнее, область между t[i] и t[i+1] заливается, если where[i] and where[i+1]. Обратите внимание, что согласно этому определению отдельное значение True между двумя значениями False в where не приведёт к заливке. Обе стороны позиции True останутся незалитыми из-за соседних значений False.

См. также

PolyCollection.set_verts, Line2D.set_data

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет(а) границы коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет(а) границы коллекции. Если задана последовательность, цвета элементов чередуются в соответствии с ней. Если задано 'face', цвет совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет(а) заливки коллекции. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если задана последовательность, цвета элементов будут чередоваться в соответствии с ней.

Если c равно 'none', заливка элемента не выполняется.

Параметры:

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, к которому относится художник.

Параметры:

figFigure или SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) художника.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать: в этом случае будут применены все указанные виды штриховки. Повторение одной и той же буквы увеличивает плотность соответствующего узора.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно задать только для всей коллекции, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать ширину линии штриховки.

set_in_layout(in_layout)[исходный код]

Задать, следует ли учитывать художника при вычислении компоновки, например, в руководстве по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль(и) линии для коллекции.

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

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

(offset, onoffseq),

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

Параметры:

lsstr или tuple или список таких значений: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать ширину линии (линий) для коллекции. lw может быть скалярным значением или последовательностью; если задана последовательность, ширина линий элементов будет чередоваться в соответствии с ней.

Параметры:

lwfloat или список значений float

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого художника пользовательскую контекстную информацию при наведении на него курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

Если для этой нормализации используются цветовые шкалы с данным объектом, задавание нормализации объекта приведёт к сбросу нормализации, локатора и форматировщиков цветовой шкалы до значений по умолчанию.

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsetsarray-like формы (N, 2) или (2,)

set_path_effects(path_effects)[исходный код]

Задать эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(verts, closed=True)[исходный код]

Задать вершины многоугольников.

Параметры:

vertsсписок объектов, подобных массивам: Последовательность многоугольников [verts0, verts1, ...], где каждый элемент verts_i задаёт вершины многоугольника i в виде двумерного объекта, подобного массиву, формы (M, 2).
closedbool, по умолчанию: True: Нужно ли замкнуть многоугольник, добавив в конце соединение CLOSEPOLY.

set_picker(picker)[исходный код]

Определить поведение художника при выборе.

Параметры:

pickerNone, bool, float или вызываемый объект

Может принимать одно из следующих значений:

None: выбор для этого художника отключён (по умолчанию).
Логическое значение: если задано True, выбор будет включён, и художник сгенерирует событие выбора, если событие мыши произошло над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск epsilon в пунктах, и художник сгенерирует событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых художников, например линий и наборов участков, в сгенерированное событие выбора могут быть добавлены дополнительные данные, например индексы данных, находящихся в пределах epsilon от места выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, которая определяет, попал ли художник под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если событие мыши произошло над художником, верните hit=True, а props — словарь свойств, которые следует добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый для проверки принадлежности.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно использовать растровую (битовую) отрисовку для вывода векторной графики.

Этот параметр игнорируется для вывода на основе пикселей.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Задать размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер, задаваемый для каждого элемента коллекции. Это значение соответствует «площади» элемента.
dpifloat, по умолчанию: 72: Разрешение холста в dpi.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эскиза.

Параметры:

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None или не задан, фильтр эскиза применяться не будет.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, на который длина уменьшается или увеличивается (по умолчанию 16.0)

Бэкенд PGF использует этот аргумент как начальное значение генератора случайных чисел, а не так, как описано выше. При одинаковом начальном значении получается одна и та же случайная форма.

set_snap(snap)[исходный код]

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

Привязка выравнивает позиции по сетке пикселей, что делает изображения более чёткими. Например, если чёрная линия шириной 1px задана в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в сетке пикселей, то есть серое значение в обоих соседних пикселях. При привязке линия перемещается к ближайшему целочисленному значению пикселя, поэтому на изображении действительно будет чёрная линия шириной 1px.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool или None

Возможные значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять положения вершин.
None: (автоматически) если путь содержит только прямолинейные отрезки, округлить координаты до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование художника.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL для художника.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlsсписок строк или None

Примечания

В настоящее время URL-адреса реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_verts(verts, closed=True)[исходный код]

Задать вершины многоугольников.

Параметры:

vertsсписок объектов, подобных массивам: Последовательность многоугольников [verts0, verts1, ...], где каждый элемент verts_i задаёт вершины многоугольника i в виде двумерного объекта, подобного массиву, формы (M, 2).
closedbool, по умолчанию: True: Нужно ли замкнуть многоугольник, добавив в конце соединение CLOSEPOLY.

set_verts_and_codes(verts, codes)[исходный код]: Инициализировать вершины с кодами пути.

set_visible(b)[исходный код]

Задать видимость художника.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать zorder художника. Художники с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли художник «устаревшим» и требует ли он повторной отрисовки, чтобы выходные данные соответствовали внутреннему состоянию художника.

propertysticky_edges

x и y списки закреплённых границ для автомасштабирования.

При автомасштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — предел просмотра «прилипает» к границе. Типичный пример — гистограммы, для которых обычно ожидается отсутствие отступа у нижней границы (0).

Кроме того, расширение отступа «упирается» в закреплённые границы и не может пересечь их. Например, если верхний предел данных равен 1.0, верхний предел просмотра, вычисленный простым добавлением отступа, равен 1.2, но закреплённая граница находится на отметке 1.1, фактический верхний предел просмотра будет равен 1.1.

Этому атрибуту нельзя присвоить значение; однако списки x и y при необходимости можно изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Вернуть нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скалярных значений, и будет возвращён соответствующий ndarray значений RGBA на основе нормализации и цветовой карты, заданных для этого Colorizer.

Есть один особый случай — обработка изображений, которые уже представлены в формате RGB или RGBA, например прочитаны из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение равно 3 или 4, он будет обработан как массив RGB или RGBA, без выполнения преобразования. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвана ошибка ValueError. Все значения NaN и замаскированные элементы получат альфа-значение 0. Если последнее измерение равно 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если последнее измерение равно 4, аргумент alpha игнорируется и не заменяет существующее альфа-значение. Если третье измерение не равно 3 или 4, будет вызвана ошибка ValueError.

Если norm равно False, нормализация входных данных не выполняется, предполагается, что их значения находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого художника из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из другого объекта в текущий.

update_scalarmappable()[исходный код]

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

Назначить цвета границам и заливкам на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.LineCollection(segments, *, zorder=2, **kwargs)[исходный код]

Базовые классы: Collection

Представляет последовательность Line2Ds, которые следует нарисовать вместе.

Этот класс расширяет Collection, представляя последовательность Line2Ds вместо последовательности Patchs. Как и в Collection, каждое свойство LineCollection может быть как отдельным значением, так и списком значений. Этот список циклически используется для каждого элемента LineCollection, поэтому свойство i-го элемента коллекции равно:

prop[i % len(prop)]

Свойства каждого элемента LineCollection по умолчанию принимают значения из rcParams["lines.*"] вместо rcParams["patch.*"], а свойство colors добавлено вместо edgecolors.

Параметры:

segmentsсписок массивовоподобных объектов формы (N, 2)

Последовательность [line0, line1, ...], где каждая линия — массивоподобный объект формы (N, 2), содержащий точки:

line0 = [(x0, y0), (x1, y1), ...]

Каждая линия может содержать разное количество точек.

linewidthsчисло с плавающей точкой или список чисел с плавающей точкой, по умолчанию: rcParams["lines.linewidth"] (значение по умолчанию: 1.5)

Ширина каждой линии в пунктах.

colorsцвет или список цветов, по умолчанию: rcParams["lines.color"] (значение по умолчанию: 'C0')

Последовательность кортежей RGBA (например, произвольные строки с цветами и т. п. не допускаются).

antialiasedsлогическое значение или список логических значений, по умолчанию: rcParams["lines.antialiased"] (значение по умолчанию: True)

Использовать ли сглаживание для каждой линии.

zorderчисло с плавающей точкой, по умолчанию: 2

Порядок отрисовки линий.

facecolorsцвет или список цветов, по умолчанию: 'none'

При задании facecolors каждая линия интерпретируется как граница области: путь неявно замыкается от последней точки к первой. Внутренняя область заполняется цветом facecolor. Чтобы вручную задать, что считать «внутренней областью» каждой линии, используйте вместо этого PathCollection, где «внутреннюю область» можно определить с помощью соответствующего использования CLOSEPOLY.

**kwargs

Передаются в Collection.

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая будет вызываться при изменении одного из свойств Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующую сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения могут быть, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позже этот идентификатор можно использовать для удаления функции с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра нормализации, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра нормализации, используя текущий массив; изменяются только пределы, равные None

propertyaxes: Экземпляр Axes, в котором находится объект Artist, либо None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x в соответствии с типом единиц оси x.

Если объект Artist не принадлежит Axes или у оси x не заданы единицы измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразует y в соответствии с типом единиц оси y.

Если объект Artist не принадлежит Axes или у оси y не заданы единицы измерения, возвращается само значение y.

draw(renderer)[исходный код]

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

Ничего не делает, если объект Artist невидим (Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: Figure или SubFigure, к которому относится объект Artist. Для более гибкого управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Находит объекты Artist.

Рекурсивно находит все экземпляры Artist, содержащиеся в объекте Artist.

Параметры:

match

Критерий фильтрации результатов. Это может быть:

None: возвращает все объекты, содержащиеся в объекте Artist.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат попадут только объекты Artist, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат попадут только объекты Artist этого класса или его подклассов (проверка isinstance).

include_selfлогическое значение

Включать ли self в список объектов, проверяемых на соответствие.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы таких чисел в строку со значениями, разделёнными запятыми и заключёнными в квадратные скобки; если же с объектом Artist связана цветовая шкала, скалярные значения форматируются с помощью её форматтера.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Возвращает функцию фильтрации, используемую для фильтра agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Возвращает информацию о том, является ли объект Artist анимированным.

get_antialiased()[исходный код]

Возвращает состояние сглаживания при отрисовке.

Возвращает:

массив логических значений

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Возвращает массив значений, преобразуемых в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

Возвращает стиль окончания линий коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Возвращает список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Возвращает значения (min, max), отображаемые на пределы цветовой карты.

get_clip_box()[исходный код]: Возвращает область отсечения.

get_clip_on()[исходный код]: Возвращает информацию о том, используется ли для объекта Artist отсечение.

get_clip_path()[исходный код]: Возвращает путь отсечения.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_color()[исходный код]

get_colors()[исходный код]

get_cursor_data(event)[исходный код]

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

Примечание

Подклассы могут переопределить этот метод и возвращать произвольные данные. Однако в этом случае они должны обеспечить возможность преобразования данных в строковое представление с помощью format_cursor_data.

Единственный текущий сценарий использования — отображение z-значения объекта AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит объект Artist.

Параметры:

rootbool, по умолчанию False: Если False, возвращает (Sub)Figure, в которой находится этот объект Artist. Если True, возвращает корневую Figure для вложенной структуры SubFigures.

get_fill()[исходный код]: Возвращает, залита ли лицевая сторона цветом.

get_gapcolor()[исходный код]

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает ширину линий штриховки.

get_in_layout()[исходный код]

Возвращает логический флаг, True если объект Artist учитывается при расчёте компоновки.

Например, руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого объекта Artist в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли у этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого объекта Artist.

get_offsets()[исходный код]: Возвращает смещения элементов коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение объекта Artist при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растеризовать объект Artist.

get_segments()[исходный код]

Возвращает:

список: Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()[исходный код]

Возвращает параметры эскиза для объекта Artist.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент, на который уменьшается или увеличивается длина.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Аналогично Artist.get_window_extent, но учитывает обрезку.

Параметры:

rendererподкласс RendererBase, необязательный: средство визуализации, используемое для отрисовки фигур (т. е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающую рамку (в пиксельных координатах фигуры). Возвращает None, если в результате обрезки пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом Artist.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой к нему неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL — по одному для каждого элемента коллекции.

Для элементов без URL в списке указано None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer=None)[исходный код]

Возвращает ограничивающую рамку объекта Artist в пространстве отображения.

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

Для включения в расчёт «tight» ограничивающей рамки подклассам следует переопределить этот метод. По умолчанию возвращается пустая ограничивающая рамка в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает zorder объекта Artist.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения на какой-либо оси.

is_transform_set()[исходный код]

Возвращает, задано ли для объекта Artist явное преобразование.

Значение становится True после вызова set_transform.

propertymouseover: Возвращает, запрашиваются ли у этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция запускается внутри системы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора объекта.

Каждый дочерний объект Artist создаёт событие выбора, если mouseevent произошло над этим объектом и для него задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

Возвращает, можно ли выбрать этот объект Artist.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами объекта Artist.

remove()[исходный код]

Удаляет объект Artist из фигуры, если это возможно.

Изменение станет видимым только после перерисовки фигуры, например с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи объекта Artist из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, colors=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gapcolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, segments=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Задать несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив с плавающей запятой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	неизвестно
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool or list of bools
`array`	array-like or None
`capstyle`	`CapStyle` or {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` or None
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`cmap`	`Colormap` or str or None
`color`	цвет or list of цвет
`colors`	цвет or list of цвет
`edgecolor` or `ec` or `edgecolors`	цвет or list of цвет or 'face'
`facecolor` or `facecolors` or `fc`	цвет or list of цвет
`figure`	`Figure` or `SubFigure`
`gapcolor`	цвет or list of цвет or None
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` or {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `dashes` or `linestyles` or `ls`	str or tuple or list thereof
`linewidth` or `linewidths` or `lw`	float or list of floats
`mouseover`	bool
`norm`	`Normalize` or str or None
`offset_transform` or `transOffset`	`Transform`
`offsets`	(N, 2) or (2,) array-like
`path_effects`	list of `AbstractPathEffect`
`paths`	неизвестно
`picker`	None or bool or float or callable
`pickradius`	float
`rasterized`	bool
`segments`	неизвестно
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`transform`	`Transform`
`url`	str
`urls`	list of str or None
`verts`	неизвестно
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[исходный код]

Задать фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, принимающая массив с плавающей запятой формы (m, n, depth) и значение dpi и возвращающая массив формы (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задать значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Задать, предназначен ли объект Artist для использования в анимации.

Если значение True, объект Artist исключается из обычной отрисовки фигуры. Для этого необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для этого объекта. Такой подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Ускорение отрисовки с помощью blitting.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задать состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задать массив значений из объекта, подобного массиву, A.

Параметры:

Aarray-like or None

Значения, преобразуемые в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

csCapStyle or {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать одним позиционным аргументом в виде кортежа (vmin, vmax).

set_clip_box(clipbox)[исходный код]

Задать область отсечения Bbox объекта Artist.

Параметры:

clipboxBboxBase or None: Обычно создаётся на основе TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) является областью отсечения по умолчанию для объекта Artist, добавленного в Axes.

set_clip_on(b)[исходный код]

Задать, используется ли для объекта Artist отсечение.

Если значение False, объекты Artist будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать путь обрезки объекта.

Параметры:

pathPatch or Path or TransformedPath or None: Путь обрезки. Если задан объект Path, необходимо также указать transform. Если задано значение None, ранее заданный путь обрезки удаляется.
transformTransform, optional: Используется только если path — это Path; в этом случае заданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — это Rectangle, этот метод задаёт в качестве области обрезки соответствующий прямоугольник, а путь обрезки задаёт равным None.

По техническим причинам (для поддержки set) в качестве одного позиционного параметра также принимается кортеж (path, transform).

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных о яркости.

Параметры:

cmapColormap or str or None

set_color(c)[исходный код]

Задать цвет(а) границ LineCollection.

Параметры:

cцвет or list of цвет: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если задана последовательность, цвета линий будут циклически выбираться из неё.

set_colors(c)[исходный код]

Задать цвет(а) границ LineCollection.

Параметры:

cцвет or list of цвет: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если задана последовательность, цвета линий будут циклически выбираться из неё.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет(а) границ коллекции.

Параметры:

cцвет or list of цвет or 'face': Цвет(а) границ коллекции. Если задана последовательность, цвета элементов будут циклически выбираться из неё. Если задано значение 'face', цвет совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет(а) заливки коллекции. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если задана последовательность, цвета элементов будут циклически выбираться из неё.

Если c имеет значение 'none', заливка элемента не выполняется.

Параметры:

cцвет or list of цвет

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, которому принадлежит объект.

Параметры:

figFigure or SubFigure

set_gapcolor(gapcolor)[исходный код]

Задать цвет для заполнения промежутков в пунктирной линии.

Примечание

Эта функциональность является экспериментальной и может измениться.

Параметры:

gapcolorцвет or list of цвет or None: Цвет для заполнения промежутков. Если задано значение None, промежутки остаются незаполненными.

set_gid(gid)[исходный код]

Задать идентификатор (группы) объекта.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать толщину линий штриховки.

set_in_layout(in_layout)[исходный код]

Задать, следует ли включать объект в расчёты компоновки, например, в руководстве по constrained layout, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать стиль соединения JoinStyle для коллекции (для всех её элементов).

Параметры:

jsJoinStyle or {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль(и) линий коллекции.

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

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

(offset, onoffseq),

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

Параметры:

lsstr or tuple or list thereof: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать толщину линии (линий) коллекции. lw может быть скалярным значением или последовательностью; если задана последовательность, значения будут циклически выбираться для элементов коллекции.

Параметры:

lwfloat or list of floats

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого объекта пользовательскую контекстную информацию при наведении на него курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize or str or None

Примечания

Если имеются цветовые шкалы, использующие объект mappable для этой нормализации, задание нормализации для объекта mappable сбросит нормализацию, локатор и форматтеры цветовой шкалы на значения по умолчанию.

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения объекта.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsets(N, 2) or (2,) array-like

set_path_effects(path_effects)[исходный код]

Задать эффекты пути.

Параметры:

path_effectslist of AbstractPathEffect

set_paths(segments)[исходный код]

set_picker(picker)[исходный код]

Задать поведение графического объекта при выборе.

Параметры:

pickerNone, bool, float или вызываемый объект

Значение может быть одним из следующих:

None: выбор этого графического объекта отключён (по умолчанию).
Булево значение: если задано True, выбор будет включён, и графический объект сгенерирует событие выбора, если событие мыши произошло над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск epsilon в пунктах, и графический объект сгенерирует событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых графических объектов, например линий и наборов фигур, в сгенерированное событие выбора могут быть добавлены дополнительные данные, например индексы данных, находящихся в пределах epsilon от места выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, определяющая, попал ли указатель мыши на графический объект:
```
hit, props = picker(artist, mouseevent)
```
для выполнения проверки попадания. Если событие мыши произошло над графическим объектом, верните hit=True, а props — это словарь свойств, которые нужно добавить в атрибуты PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый при проверках принадлежности.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно использовать растровую (битовую) отрисовку при выводе в векторном формате.

Растровая отрисовка поддерживается не всеми графическими объектами. Если попытаться включить её для объекта, который её не поддерживает, команда не даст эффекта и будет выдано предупреждение.

Для вывода на основе пикселей эта настройка игнорируется.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_segments(segments)[исходный код]

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эскиза.

Параметры:

scalefloat, необязательный

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None или не указан, фильтр эскиза применяться не будет.

lengthfloat, необязательный

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательный

Коэффициент, на который умножается длина для её уменьшения или увеличения (по умолчанию 16.0)

Бэкенд PGF использует этот аргумент в качестве начального значения генератора случайных чисел, а не так, как описано выше. При использовании одного и того же начального значения получается одинаковая случайная форма.

set_snap(snap)[исходный код]

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

Привязка выравнивает координаты по пиксельной сетке, что позволяет получать более чёткие изображения. Например, если чёрная линия шириной 1px задана между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии на пиксельной сетке, то есть серое значение в обоих соседних пикселях. При включённой привязке линия перемещается к ближайшему целому значению пикселя, поэтому на итоговом изображении действительно будет чёрная линия шириной 1px.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool или None

Возможные значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять положения вершин.
None: (автоматически) если путь содержит только прямолинейные сегменты, округлить координаты до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование графического объекта.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL для графического объекта.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str или None

Примечания

В настоящее время URL реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_verts(segments)[исходный код]

set_visible(b)[исходный код]

Задать видимость графического объекта.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать порядок отрисовки графического объекта. Объекты с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли графический объект «устаревшим» и нуждается ли он в повторной отрисовке, чтобы вывод соответствовал внутреннему состоянию объекта.

propertysticky_edges

x и y — списки липких границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ добавляться не будет — пределы отображения «прилипнут» к границе. Типичный пример — гистограммы, для которых обычно не требуется отступ у нижней границы (0).

Кроме того, расширение отступа «упирается» в липкие границы и не может выйти за них. Например, если верхний предел данных равен 1.0, верхний предел отображения, вычисленный простым добавлением отступа, равен 1.2, а липкая граница находится на 1.1, фактический верхний предел отображения будет равен 1.1.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скалярных значений, и будет возвращён соответствующий массив значений RGBA ndarray, рассчитанный на основе нормализации и цветовой карты, заданных для этого Colorizer.

Предусмотрен специальный случай для обработки изображений, которые уже представлены в формате RGB или RGBA, например считаны из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение равно 3 или 4, он будет обрабатываться как массив RGB или RGBA, без выполнения преобразования. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвана ошибка ValueError. Все NaN и замаскированные элементы получат значение альфа-канала 0. Если размер последнего измерения равен 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если размер последнего измерения равен 4, аргумент alpha игнорируется и не заменяет уже существующее значение альфа-канала. Если размер третьего измерения не равен 3 или 4, будет вызвана ошибка ValueError.

В обоих случаях, если bytes равен False (по умолчанию), массив RGBA будет содержать числа с плавающей точкой в диапазоне 0–1; если он равен True, возвращаемый массив RGBA будет иметь тип uint8 и значения в диапазоне от 0 до 255.

Если norm равен False, нормализация входных данных не выполняется; предполагается, что они находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого графического объекта из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из other в текущий объект.

update_scalarmappable()[исходный код]

Обновить цвета из массива отображаемых скалярных значений, если он есть.

Назначить цвета границам и заливкам на основе массива и/или непосредственно заданных цветов, если это применимо.

zorder=0

classmatplotlib.collections.PatchCollection(patches, *, match_original=False, **kwargs)[исходный код]

Базовые классы: Collection

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

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

Параметры:

patchesсписок Patch

Последовательность объектов Patch. Этот список может включать разнообразные патчи разных типов.

match_originalbool, по умолчанию: False

Если True, используются цвета и толщины линий исходных патчей. Если False, новые цвета можно назначить, задав стандартные аргументы коллекции: facecolor, edgecolor, linewidths, norm или cmap.

**kwargs

Все остальные параметры передаются в Collection.

Если значение любого из параметров edgecolors, facecolors, linewidths, antialiaseds равно None, по умолчанию используется соответствующая настройка патчей из rcParams в виде последовательности.

Примечания

Использование функциональности ScalarMappable необязательно. Если матрица ScalarMappable _A была задана (вызовом set_array), во время отрисовки будет вызван объект scalar mappable для задания цветов заливки.

add_callback(func)[источник]

Добавить функцию обратного вызова, которая будет вызываться при изменении любого из свойств объекта Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующую сигнатуру:

def func(artist: Artist) -> Any

где artist — объект Artist, вызвавший функцию. Возвращаемые значения могут быть, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позже этот идентификатор можно использовать для удаления функции обратного вызова с помощью remove_callback.

См. также

remove_callback

autoscale()[источник]: Автоматически масштабировать скалярные пределы экземпляра norm с использованием текущего массива

autoscale_None()[источник]: Автоматически масштабировать скалярные пределы экземпляра norm с использованием текущего массива, изменяя только пределы со значением None

propertyaxes: Экземпляр Axes, в котором находится объект Artist, или None.

changed()[источник]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[источник]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[источник]

Преобразовать x с использованием типа единиц оси x.

Если объект Artist не содержится в Axes или у оси x не заданы единицы измерения, возвращается само значение x.

convert_yunits(y)[источник]

Преобразовать y с использованием типа единиц оси y.

Если объект Artist не содержится в Axes или у оси y не заданы единицы измерения, возвращается само значение y.

draw(renderer)[источник]

Нарисовать Artist (и его дочерние объекты) с помощью заданного средства отрисовки.

Ничего не делает, если объект Artist невидим (Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: Figure (или SubFigure), к которой относится объект Artist. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[источник]

Найти объекты Artist.

Рекурсивно найти все экземпляры Artist, содержащиеся в объекте Artist.

Параметры:

match

Критерий фильтрации совпадений. Это может быть

None: вернуть все объекты, содержащиеся в Artist.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только объекты Artist, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат войдут только объекты Artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список объектов, проверяемых на совпадение.

Возвращает:

список объектов Artist

format_cursor_data(data)[источник]

Вернуть строковое представление data.

Примечание

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой, а также массивы целых чисел и чисел с плавающей точкой в строку со значениями, разделёнными запятыми и заключёнными в квадратные скобки; если же с объектом Artist связана цветовая шкала, скалярные значения форматируются с помощью её форматировщика.

См. также

get_cursor_data

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

get_agg_filter()[источник]: Вернуть функцию фильтрации для фильтра agg.

get_alpha()[источник]: Вернуть значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[источник]: Вернуть признак анимированности объекта Artist.

get_antialiased()[источник]

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

Возвращает:

массив логических значений

get_antialiaseds()[источник]: Псевдоним для get_antialiased.

get_array()[источник]

Вернуть массив значений, которые преобразуются в цвета.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[источник]

Вернуть стиль окончания линий коллекции (для всех её элементов).

Возвращает:

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

get_children()[источник]: Вернуть список дочерних объектов Artist данного объекта Artist.

get_clim()[источник]: Вернуть значения (минимум, максимум), сопоставленные с пределами цветовой карты.

get_clip_box()[источник]: Вернуть область отсечения.

get_clip_on()[источник]: Вернуть признак использования отсечения объектом Artist.

get_clip_path()[источник]: Вернуть путь отсечения.

get_cmap()[источник]: Вернуть экземпляр Colormap.

get_cursor_data(event)[источник]

Вернуть данные курсора для заданного события.

Примечание

Единственный используемый сейчас сценарий — отображение z-значения объекта AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[источник]: Псевдоним для get_linestyle.

get_datalim(transData)[источник]

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

get_edgecolor()[источник]

get_edgecolors()[источник]: Псевдоним для get_edgecolor.

get_facecolor()[источник]

get_facecolors()[источник]: Псевдоним для get_facecolor.

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

get_figure(root=False)[источник]

Вернуть экземпляр Figure или SubFigure, к которому относится объект Artist.

Параметры:

rootbool, по умолчанию=False: Если False, вернуть Figure (или SubFigure), к которой относится этот объект Artist. Если True, вернуть корневую Figure для вложенного дерева SubFigure.

get_fill()[источник]: Вернуть признак того, что заливка окрашена.

get_gid()[источник]: Вернуть идентификатор группы.

get_hatch()[источник]: Вернуть текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает толщину линий штриховки.

get_in_layout()[исходный код]

Возвращает логический флаг True, указывающий, включён ли объект Artist в расчёты компоновки.

Например, Руководство по constrained layout, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого объекта Artist в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли у этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого объекта Artist.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение объекта Artist при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растрировать объект Artist.

get_sketch_params()[исходный код]

Возвращает параметры наброска для объекта Artist.

Возвращает:

tuple или None

Кортеж из трёх элементов со следующими значениями:

scale: Амплитуда отклонения от исходной линии по перпендикуляру.
length: Длина отклонения вдоль линии.
randomness: Коэффициент, на который умножается длина при уменьшении или увеличении.

Возвращает None, если параметры наброска не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Аналогично Artist.get_window_extent, но с учётом обрезки.

Параметры:

rendererподкласс RendererBase, необязательный: рендерер, который будет использоваться для отрисовки фигур (то есть fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающую рамку (в координатах пикселей фигуры). Возвращает None, если в результате обрезки пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом Artist.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает контур обрезки с применённой неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Для элементов без URL в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает признак видимости.

get_window_extent(renderer=None)[исходный код]

Возвращает ограничивающую рамку объекта Artist в пространстве отображения.

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

Для включения в расчёт ограничивающей рамки «tight» подклассам следует переопределить этот метод. По умолчанию возвращается пустая ограничивающая рамка в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает zorder объекта Artist.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения хотя бы для одной оси.

is_transform_set()[исходный код]

Возвращает, задано ли для объекта Artist преобразование явно.

Значение становится True после вызова set_transform.

propertymouseover: Возвращает, запрашиваются ли у этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний объект Artist генерирует событие выбора, если mouseevent происходит над ним и для него задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами объекта Artist.

remove()[исходный код]

Удаляет объект Artist из фигуры, если это возможно.

Изменение станет видимым только после повторной отрисовки фигуры, например с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи объекта Artist из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Задать несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтрации, которая принимает массив чисел с плавающей запятой размером (m, n, 3) и значение dpi, а возвращает массив размером (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	подобный массиву объект, число с плавающей запятой или None
`animated`	bool
`antialiased` или `aa` или `antialiaseds`	bool или список значений bool
`array`	подобный массиву объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` или `ec` или `edgecolors`	цвет или список значений цвета или 'face'
`facecolor` или `facecolors` или `fc`	цвет или список значений цвета
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` или `dashes` или `linestyles` или `ls`	str, кортеж или список таких значений
`linewidth` или `linewidths` или `lw`	число с плавающей запятой или список чисел с плавающей запятой
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` или `transOffset`	`Transform`
`offsets`	подобный массиву объект размером (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None, bool, число с плавающей запятой или вызываемый объект
`pickradius`	число с плавающей запятой
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`visible`	bool
`zorder`	число с плавающей запятой

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

set_agg_filter(filter_func)[исходный код]

Задать фильтр agg.

Параметры:

filter_funcвызываемый объект: Функция фильтрации, которая принимает массив чисел с плавающей запятой размером (m, n, depth) и значение dpi, а возвращает массив размером (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задать значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaподобный массиву объект, число с плавающей запятой или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[исходный код]

Задать, предназначен ли графический объект для использования в анимации.

Если значение True, графический объект исключается из обычной отрисовки фигуры. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для этого графического объекта. Такой подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Ускорение отрисовки с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задать режим сглаживания при отрисовке.

Параметры:

aabool или список значений bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задать массив значений, используя объект A, подобный массиву.

Параметры:

Aподобный массиву объект или None

Значения, преобразуемые в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

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

set_clim(vmin=None, vmax=None)[исходный код]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxчисло с плавающей запятой

Пределы.

Для скалярных данных пределы также можно передать в виде кортежа (vmin, vmax) одним позиционным аргументом.

set_clip_box(clipbox)[исходный код]

Задать область отсечения Bbox графического объекта.

Параметры:

clipboxBboxBase или None: Обычно создаётся из объекта TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) — область отсечения по умолчанию для графического объекта, добавленного в Axes.

set_clip_on(b)[исходный код]

Задать, использует ли графический объект отсечение.

Если значение False, графические объекты будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать путь отсечения графического объекта.

Параметры:

pathPatch или Path или TransformedPath или None: Путь отсечения. Если задан объект Path, необходимо также указать transform. Если задано значение None, ранее установленный путь отсечения удаляется.
transformTransform, необязательно: Используется только в том случае, если path является объектом Path. В этом случае заданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является объектом Rectangle, этот метод задаст область отсечения, соответствующую данному прямоугольнику, и установит путь отсечения в None.

По техническим причинам (для поддержки set) кортеж (path, transform) также принимается в качестве единственного позиционного параметра.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных о яркости.

Параметры:

cmapColormap or str or None

set_color(c)[исходный код]

Задать цвет границы и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

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

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет границы коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет границы коллекции. Если задана последовательность, цвета для объектов будут циклически выбираться из неё. Если задано 'face', цвет будет совпадать с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет заливки коллекции. c может быть цветом (все объекты будут иметь одинаковый цвет) или последовательностью цветов; если задана последовательность, цвета объектов будут циклически выбираться из неё.

Если c равно 'none', заливка объекта не выполняется.

Параметры:

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, к которому относится объект-художник.

Параметры:

figFigure or SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) для объекта-художника.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать; в этом случае будут применены все указанные узоры штриховки. Повторение одной и той же буквы увеличивает плотность штриховки соответствующего узора.

В отличие от других свойств, таких как ширина линий и цвета, штриховку можно задать только для всей коллекции, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать ширину линии штриховки.

set_in_layout(in_layout)[исходный код]

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать стиль соединения JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль линий для коллекции.

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

Также можно указать кортеж параметров штриховки следующего вида:

(offset, onoffseq),

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

Параметры:

lsstr или tuple или list thereof: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать ширину линий для коллекции. lw может быть скалярным значением или последовательностью; если задана последовательность, значения для объектов будут циклически выбираться из неё.

Параметры:

lwfloat или список значений float

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого объекта-художника пользовательскую контекстную информацию при перемещении над ним курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize or str or None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения объекта-художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsetsмассивоподобный объект формы (N, 2) или (2,)

set_path_effects(path_effects)[исходный код]

Задать эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(patches)[исходный код]

set_picker(picker)[исходный код]

Задать поведение объекта-художника при выборе.

Параметры:

pickerNone или bool или float или callable

Может принимать одно из следующих значений:

None: выбор для этого объекта-художника отключён (по умолчанию).
Логическое значение: если задано True, выбор будет включён, и объект-художник сгенерирует событие выбора, если событие мыши произойдёт над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск epsilon в пунктах; объект-художник сгенерирует событие, если его данные находятся от события мыши на расстоянии не более epsilon. Для некоторых объектов-художников, например линий и коллекций патчей, в созданное событие выбора могут быть добавлены дополнительные данные, например индексы данных, находящихся в пределах epsilon от места выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, которая определяет, попал ли курсор мыши на объект-художник:
```
hit, props = picker(artist, mouseevent)
```
для выполнения проверки попадания. Если событие мыши произошло над объектом-художником, верните hit=True; props — это словарь свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый для проверки принадлежности.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно использовать растровую (битовую) отрисовку для векторной графики.

Растровая отрисовка поддерживается не всеми объектами-художниками. Если включить её для объекта, который её не поддерживает, команда не даст эффекта и будет выдано предупреждение.

Этот параметр игнорируется при выводе, основанном на пикселях.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Задать параметры эскиза.

Параметры:

scalefloat, необязательно

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент, на который длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(snap)[source]

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

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

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool или None

Возможные значения:

True: привязывать вершины к ближайшим центрам пикселей.
False: не изменять позиции вершин.
None: (автоматически) если путь содержит только прямолинейные сегменты, округлять координаты до ближайшего центра пикселя.

set_transOffset(offset_transform)[source]: Псевдоним для set_offset_transform.

set_transform(t)[source]

Задать преобразование объекта.

Параметры:

tTransform

set_url(url)[source]

Задать URL объекта.

Параметры:

urlstr

set_urls(urls)[source]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_visible(b)[source]

Задать видимость объекта.

Параметры:

bbool

set_zorder(level)[source]

Задать порядок отрисовки объекта. Объекты с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли объект «устаревшим» и требует ли он повторной отрисовки, чтобы результат соответствовал внутреннему состоянию объекта.

propertysticky_edges

Списки фиксированных границ x и y для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — предел области просмотра «прилипает» к границе. Типичный пример — гистограммы, для которых обычно не ожидается отступ у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может выйти за них. Например, если верхний предел данных равен 1.0, верхний предел области просмотра, рассчитанный простым применением отступа, равен 1.2, но фиксированная граница находится на отметке 1.1, фактический верхний предел области просмотра будет равен 1.1.

Этому атрибуту нельзя присвоить значение; однако списки x и y можно при необходимости изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[source]

Возвращает нормализованный массив RGBA, соответствующий x.

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

Есть один особый случай — обработка изображений, которые уже представлены в формате RGB или RGBA, например, если они были прочитаны из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение равно 3 или 4, оно будет рассматриваться как массив RGB или RGBA, и преобразование выполняться не будет. Массив может иметь тип uint8 или содержать числа с плавающей запятой в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Значения NaN и замаскированные элементы получат альфа-канал со значением 0. Если последнее измерение равно 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если последнее измерение равно 4, аргумент alpha игнорируется и не заменяет существующее значение альфа-канала. Если третье измерение не равно 3 или 4, будет вызвано исключение ValueError.

В обоих случаях, если bytes равно False (по умолчанию), массив RGBA будет состоять из чисел с плавающей запятой в диапазоне 0–1; если оно равно True, возвращаемый массив RGBA будет иметь тип uint8, а значения будут лежать в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется и предполагается, что они находятся в диапазоне (0–1).

update(props)[source]

Обновить свойства этого объекта из словаря props.

Параметры:

propsdict

update_from(other)[source]: Скопировать свойства из other в self.

update_scalarmappable()[source]

Обновить цвета на основе массива скалярного отображения, если он задан.

zorder=0

classmatplotlib.collections.PathCollection(paths, sizes=None, **kwargs)[исходный код]

Базовые классы: _CollectionWithSizes

Коллекция объектов Path, создаваемых, например, функцией scatter.

Параметры:

pathsсписок объектов path.Path: Объекты paths, из которых состоит Collection.
sizesподобный массиву объект: Коэффициент масштабирования для каждого рисуемого объекта Path. При отображении одна квадратная единица в пространстве данных Path масштабируется до sizes**2 пунктов.
**kwargs: Передаются в Collection.

add_callback(func)[исходный код]

Добавить функцию обратного вызова, которая будет вызываться при изменении любого из свойств объекта Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующую сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения могут присутствовать, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позже этот идентификатор можно использовать для удаления функции обратного вызова с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра norm на основе текущего массива

autoscale_None()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра norm на основе текущего массива, изменяя только пределы со значением None

propertyaxes: Экземпляр Axes, к которому относится художник, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале «changed».

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразовать x с использованием типа единиц оси xaxis.

Если художник не принадлежит Axes или если у xaxis не заданы единицы измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразовать y с использованием типа единиц оси yaxis.

Если художник не принадлежит Axes или если у yaxis не заданы единицы измерения, возвращается само значение y.

draw(renderer)[исходный код]

Нарисовать Artist (и его дочерние объекты) с помощью указанного средства отрисовки.

Ничего не происходит, если художник невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: Figure или SubFigure, на которой находится художник. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Найти объекты-художники.

Рекурсивно найти все экземпляры Artist, содержащиеся в художнике.

Параметры:

match

Критерий фильтрации результатов. Это может быть

None: вернуть все объекты, содержащиеся в художнике.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только те художники, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат войдут только художники этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список объектов, проверяемых на соответствие критерию.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Вернуть строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах художников. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой, а также массивы целых чисел и чисел с плавающей точкой в строку, разделённую запятыми и заключённую в квадратные скобки. Если с художником связана цветовая шкала, скалярные значения форматируются с помощью её форматировщика.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Вернуть функцию фильтрации, используемую для фильтра agg.

get_alpha()[исходный код]: Вернуть значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Вернуть признак того, что художник анимирован.

get_antialiased()[исходный код]

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

Возвращает:

массив логических значений

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Вернуть массив значений, сопоставляемых с цветами.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[исходный код]

Вернуть стиль окончания линий для коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Вернуть список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Вернуть значения (min, max), сопоставленные с пределами цветовой карты.

get_clip_box()[исходный код]: Вернуть область отсечения.

get_clip_on()[исходный код]: Вернуть признак использования отсечения художником.

get_clip_path()[исходный код]: Вернуть контур отсечения.

get_cmap()[исходный код]: Вернуть экземпляр Colormap.

get_cursor_data(event)[исходный код]

Вернуть данные курсора для заданного события.

Примечание

Подклассы могут переопределить этот метод и возвращать произвольные данные. Однако при этом они должны обеспечить, чтобы format_cursor_data мог преобразовать данные в строковое представление.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Вернуть экземпляр Figure или SubFigure, которому принадлежит художник.

Параметры:

rootbool, по умолчанию False: Если False, вернуть Figure или SubFigure, на которой находится этот художник. Если True, вернуть корневую Figure для вложенного дерева SubFigure.

get_fill()[исходный код]: Вернуть признак того, что лицевая сторона залита цветом.

get_gid()[исходный код]: Вернуть идентификатор группы.

get_hatch()[исходный код]: Вернуть текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Вернуть ширину линий штриховки.

get_in_layout()[исходный код]

Возвращает логическое значение True, указывающее, включён ли объект Artist в расчёты компоновки.

Например, руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого объекта Artist в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли у этого объекта Artist дополнительные сведения о контексте при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого объекта Artist.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение объекта Artist при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, будет ли объект Artist растрирован.

get_sizes()[исходный код]

Возвращает размеры («площади») элементов коллекции.

Возвращает:

массив: «Площадь» каждого элемента.

get_sketch_params()[исходный код]

Возвращает параметры эскиза для объекта Artist.

Возвращает:

кортеж или None

Кортеж из 3 элементов со следующими значениями:

scale: амплитуда колебаний перпендикулярно исходной линии.
length: длина колебаний вдоль линии.
randomness: коэффициент, на который умножается длина, чтобы уменьшить или увеличить её.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Аналогично Artist.get_window_extent, но учитывает обрезку.

Параметры:

rendererподкласс RendererBase, необязательный: рендерер, который будет использоваться для отрисовки фигур (то есть fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающая рамка (в пиксельных координатах фигуры). Возвращает None, если в результате обрезки пересечения нет.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом Artist.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает контур обрезки с применённой неаффинной частью его преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Для элементов без URL-адреса в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает значение видимости.

get_window_extent(renderer=None)[исходный код]

Возвращает ограничивающую рамку объекта Artist в координатах области отображения.

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

Для включения в расчёт ограничивающей рамки «tight» подклассам следует переопределить этот метод. По умолчанию возвращается пустая ограничивающая рамка с началом в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает порядок отрисовки zorder объекта Artist.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения хотя бы для одной оси.

is_transform_set()[исходный код]

Возвращает, задано ли для объекта Artist явное преобразование.

Значение становится True после вызова set_transform.

legend_elements(prop='colors', num='auto', fmt=None, func=<function PathCollection.<lambda>>, **kwargs)[исходный код]

Создаёт дескрипторы и метки легенды для PathCollection.

Каждый дескриптор легенды — это Line2D, представляющий нарисованный Path, а каждая метка — строка, обозначающая Path.

Это полезно для создания легенды для графика scatter; например:

scatter = plt.scatter([1, 2, 3],  [4, 5, 6],  c=[7, 2, 3], num=None)
plt.legend(*scatter.legend_elements())

создаёт три элемента легенды — по одному для каждого цвета, а числовые значения, переданные в c, используются в качестве меток.

См. также пример Автоматическое создание легенды.

Параметры:

prop{"colors", "sizes"}, по умолчанию: "colors": Если задано значение "colors", дескрипторы легенды будут отображать разные цвета коллекции. Если задано значение "sizes", легенда будет отображать разные размеры. Чтобы задать оба параметра, используйте kwargs для непосредственного изменения свойств Line2D.
numint, None, "auto" (по умолчанию), массивоподобный объект или Locator: Целевое число создаваемых элементов. Если задано None, используются все уникальные элементы отображаемого массива. Если задано целое число, в нормализованном диапазоне выбирается num элементов. Если задано "auto", функция пытается определить, какой вариант лучше подходит для данных. Фактическое число созданных элементов может немного отличаться от num, поскольку для поиска подходящих позиций используется Locator. Если задан список или массив, в легенду включаются именно эти элементы. Наконец, можно передать Locator.
fmtstr, Formatter или None (по умолчанию): Формат или форматтер, используемый для меток. Если задана строка, она должна быть допустимым аргументом для StrMethodFormatter. Если задано None (по умолчанию), используется ScalarFormatter.
funcфункция, по умолчанию: lambda x: x: Функция для вычисления меток. Часто аргумент размера (или цвета) функции scatter предварительно обрабатывается пользователем с помощью функции s = f(x), чтобы маркеры были видны; например, size = np.log10(x). Если здесь указать обратную функцию, предварительная обработка будет отменена, и метки легенды будут содержать правильные значения; например, func = lambda x: 10**x.
**kwargs: Допустимые именованные аргументы: color и size. Например, если используется prop="sizes", может быть полезно задать цвет маркеров; аналогично, при использовании prop="colors" можно задать размер маркеров. Все остальные параметры передаются экземпляру Line2D. Это может быть полезно, например, чтобы задать для дескрипторов легенды другие значения markeredgecolor или alpha.

Возвращает:

handlesсписок объектов Line2D: Визуальное представление каждого элемента легенды.
labelsсписок строк: Строковые метки элементов легенды.

propertymouseover: Возвращает, запрашиваются ли у этого объекта Artist дополнительные сведения о контексте при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные функции обратного вызова.

Эта функция запускается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний объект Artist генерирует событие выбора, если mouseevent произошло над ним и для объекта задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами объекта Artist.

remove()[исходный код]

Удаляет художник с рисунка, если это возможно.

Результат станет видимым только после перерисовки рисунка, например с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи художника из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

Задает несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив чисел с плавающей точкой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения относительно нижнего левого угла изображения
`alpha`	array-like или float или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	array-like или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` or `ec` or `edgecolors`	цвет или список цветов или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список цветов
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `dashes` or `linestyles` or `ls`	str или tuple или список таких значений
`linewidth` or `linewidths` or `lw`	float или список значений float
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` or `transOffset`	`Transform`
`offsets`	array-like формы (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или float или callable
`pickradius`	float
`rasterized`	bool
`sizes`	`numpy.ndarray` или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[исходный код]

Задает фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, принимающая массив чисел с плавающей точкой формы (m, n, depth) и значение dpi и возвращающая массив формы (m, n, depth) и два смещения относительно нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Задает, предназначен ли художник для использования в анимации.

Если значение True, художник исключается из обычной отрисовки рисунка. Для него необходимо явно вызвать Figure.draw_artist / Axes.draw_artist. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Ускорение отрисовки с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задает состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задает массив значений из объекта array-like A.

Параметры:

Aarray-like or None

Значения, сопоставляемые цветам.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Задает CapStyle для коллекции (для всех ее элементов).

Параметры:

csCapStyle or {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Задает пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать одним позиционным аргументом в виде кортежа (vmin, vmax).

set_clip_box(clipbox)[исходный код]

Задает Bbox для отсечения художника.

Параметры:

clipboxBboxBase or None: Обычно создается на основе TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) используется для отсечения по умолчанию у художника, добавленного в Axes.

set_clip_on(b)[исходный код]

Задает, использует ли художник отсечение.

При значении False художники будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать путь обрезки художника.

Параметры:

pathPatch or Path or TransformedPath or None: Путь обрезки. Если задан Path, необходимо также указать transform. Если задано значение None, ранее установленный путь обрезки удаляется.
transformTransform, необязательно: Используется только если path является Path. В этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод задаст ограничивающий прямоугольник, соответствующий этому прямоугольнику, и установит путь обрезки в None.

По техническим причинам (для поддержки set) также допускается кортеж (path, transform) в качестве единственного позиционного параметра.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных яркости.

Параметры:

cmapColormap or str or None

set_color(c)[исходный код]

Задать цвет края и цвет заливки.

Параметры:

cцвет or list of RGBA tuples

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для задания цвета края или заливки по отдельности.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет(а) края коллекции.

Параметры:

cцвет or list of цвет or 'face': Цвет(а) краёв коллекции. Если задана последовательность, патчи по очереди используют её элементы. Если задано 'face', используется цвет заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет(а) заливки коллекции. c может быть цветом (все патчи будут одного цвета) или последовательностью цветов; если это последовательность, патчи будут по очереди использовать её элементы.

Если c равно 'none', патч не будет залит.

Параметры:

cцвет or list of цвет

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, которому принадлежит художник.

Параметры:

figFigure or SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) художника.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать штриховку

hatch может принимать одно из значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать: в таком случае будут применены все указанные виды штриховки. Повторение одной и той же буквы увеличивает плотность соответствующей штриховки.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать толщину линий штриховки.

set_in_layout(in_layout)[исходный код]

Задать, должен ли художник учитываться при вычислении компоновки, например в руководстве по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

jsJoinStyle or {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль линий коллекции.

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

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

(offset, onoffseq),

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

Параметры:

lsstr or tuple or list thereof: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать толщину линий коллекции. lw может быть скаляром или последовательностью; если это последовательность, патчи будут по очереди использовать её элементы.

Параметры:

lwfloat or list of floats

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого художника контекстную информацию при наведении на него курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize or str or None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsets(N, 2) or (2,) array-like

set_path_effects(path_effects)[исходный код]

Задать эффекты пути.

Параметры:

path_effectslist of AbstractPathEffect

set_paths(paths)[исходный код]

set_picker(picker)[исходный код]

Определить поведение художника при выборе щелчком.

Параметры:

pickerNone or bool or float or callable

Может принимать одно из следующих значений:

None: выбор этого художника щелчком отключён (по умолчанию).
Логическое значение: если задано True, выбор щелчком будет включён, и художник вызовет событие выбора, если событие мыши произошло над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск epsilon в пунктах; художник вызовет событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых художников, например линий и коллекций патчей, в созданное событие выбора могут добавляться дополнительные данные, например индексы данных, находящихся в пределах epsilon от точки выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, которая определяет, попал ли указатель мыши в художника:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если событие мыши произошло над художником, верните hit=True; props — это словарь свойств, которые следует добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Установить радиус захвата, используемый для проверки попадания.

Параметры:

pickradiusfloat: Радиус захвата в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно включить растровую (битовую) отрисовку для вывода векторной графики.

Растровая отрисовка поддерживается не всеми объектами Artist. Если попытаться включить её для объекта Artist, который её не поддерживает, команда не даст эффекта и будет выдано предупреждение.

Этот параметр игнорируется при выводе на основе пикселей.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

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

Параметры:

sizesnumpy.ndarray or None: Размер, задаваемый для каждого элемента коллекции. Значение соответствует «площади» элемента.
dpifloat, default: 72: Разрешение холста в точках на дюйм.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установить параметры эскиза.

Параметры:

scalefloat, optional

Амплитуда отклонения от исходной линии по перпендикуляру, в пикселях. Если scale равен None или не указан, фильтр эскиза применяться не будет.

lengthfloat, optional

Длина отклонения вдоль линии, в пикселях (по умолчанию 128.0)

randomnessfloat, optional

Коэффициент, на который умножается длина, чтобы уменьшить или увеличить её (по умолчанию 16.0)

Бэкенд PGF использует этот аргумент как начальное значение генератора случайных чисел, а не в описанном выше смысле. При одинаковом начальном значении получается одинаковая случайная форма.

set_snap(snap)[исходный код]

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

Привязка выравнивает положения по пиксельной сетке, что позволяет получать более чёткие изображения. Например, если чёрная линия шириной 1 пиксель задана в положении между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть серое значение в обоих соседних пикселях. При включённой привязке линия перемещается к ближайшему целочисленному значению пикселя, поэтому на изображении действительно будет чёрная линия шириной 1 пиксель.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Допустимые значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять положения вершин.
None: (автоматически) если путь содержит только прямолинейные отрезки, округлить координаты до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Установить преобразование объекта Artist.

Параметры:

tTransform

set_url(url)[исходный код]

Установить URL для объекта Artist.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL реализованы только в бэкенде SVG. В остальных бэкендах они игнорируются.

set_visible(b)[исходный код]

Установить видимость объекта Artist.

Параметры:

bbool

set_zorder(level)[исходный код]

Установить порядок отрисовки объекта Artist. Объекты Artist с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли объект Artist «устаревшим» и требуется ли его повторная отрисовка, чтобы вывод соответствовал внутреннему состоянию объекта Artist.

propertysticky_edges

x и y списки фиксированных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ добавляться не будет — пределы отображения «прилипнут» к границе. Типичный пример — гистограммы, для которых обычно не нужен отступ у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может выйти за них. Например, если верхний предел данных равен 1.0, верхний предел отображения, вычисленный простым применением отступа, равен 1.2, а фиксированная граница находится на уровне 1.1, то фактический верхний предел отображения будет равен 1.1.

Этому атрибуту нельзя присваивать значения; однако списки x и y можно при необходимости изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Вернуть нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скалярных значений. На основе нормализации и цветовой карты, заданных для этого объекта Colorizer, возвращается соответствующий массив ndarray значений RGBA.

Предусмотрен особый случай для обработки изображений, уже представленных в формате RGB или RGBA, например считанных из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение имеет размер 3 или 4, массив будет рассматриваться как массив RGB или RGBA, и преобразование выполняться не будет. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвана ошибка ValueError. Все значения NaN и замаскированные элементы получат альфа-канал 0. Если размер последнего измерения равен 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если размер последнего измерения равен 4, аргумент alpha игнорируется и не заменяет уже имеющееся значение альфа-канала. Если размер третьего измерения отличается от 3 или 4, будет вызвана ошибка ValueError.

Если norm равно False, нормализация входных данных не выполняется; предполагается, что они находятся в диапазоне 0–1.

update(props)[исходный код]

Обновить свойства этого объекта Artist значениями из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из other в self.

update_scalarmappable()[исходный код]

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

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

zorder=0

classmatplotlib.collections.PolyCollection(verts, sizes=None, *, closed=True, **kwargs)[исходный код]

Базовые классы: _CollectionWithSizes

Параметры:

vertsсписок объектов, подобных массивам: Последовательность полигонов [verts0, verts1, ...], где каждый элемент verts_i задаёт вершины полигона i как двумерный объект, подобный массиву, формы (M, 2).
sizesобъект, подобный массиву, по умолчанию: None: Квадраты коэффициентов масштабирования полигонов. Координаты каждого полигона verts_i умножаются на квадратный корень соответствующего элемента в sizes (то есть sizes задаёт масштабирование площадей). Масштабирование применяется до основного преобразования Artist.
closedbool, по умолчанию: True: Следует ли замкнуть полигон, добавив в конце соединение CLOSEPOLY.
**kwargs: Передаются в Collection.

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая вызывается при изменении любого из свойств Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующую сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения могут быть, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позднее этот идентификатор можно использовать для удаления функции обратного вызова с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив и изменяя только пределы со значением None

свойствоaxes: Экземпляр Axes, в котором находится объект Artist, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале «changed».

свойствоcmap

свойствоcolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

свойствоcolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x в соответствии с типом единиц измерения оси x.

Если объект Artist не принадлежит объекту Axes или ось x не использует единицы измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразует y в соответствии с типом единиц измерения оси y.

Если объект Artist не принадлежит объекту Axes или ось y не использует единицы измерения, возвращается само значение y.

draw(renderer)[исходный код]

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

Ничего не делает, если объект Artist невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

свойствоfigure: (Под)фигура, на которой находится объект Artist. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Находит объекты Artist.

Рекурсивно находит все экземпляры Artist, содержащиеся в объекте Artist.

Параметры:

match

Критерий фильтрации результатов. Это может быть:

None: возвращает все объекты, содержащиеся в объекте Artist.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только объекты Artist, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат войдут только объекты Artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включает сам объект self в список для проверки соответствия.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Предполагается, что этот метод переопределяется в подклассах Artist. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой, а также массивы целых чисел и чисел с плавающей точкой в строку со значениями, разделёнными запятыми и заключёнными в квадратные скобки. Если с объектом Artist связана цветовая шкала, скалярные значения форматируются с помощью её форматировщика.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Возвращает функцию фильтрации, используемую для фильтра agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Возвращает сведения о том, является ли объект Artist анимированным.

get_antialiased()[исходный код]

Возвращает состояние сглаживания при отрисовке.

Возвращает:

массив значений bool

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Возвращает массив значений, сопоставленных с цветами.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[исходный код]

Возвращает стиль окончания для коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Возвращает список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Возвращает значения (min, max), сопоставленные с пределами цветовой карты.

get_clip_box()[исходный код]: Возвращает область отсечения.

get_clip_on()[исходный код]: Возвращает сведения о том, используется ли для объекта Artist отсечение.

get_clip_path()[исходный код]: Возвращает путь отсечения.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

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

Примечание

Подклассы могут переопределить этот метод и возвращать произвольные данные. Однако при этом они должны обеспечить, чтобы метод format_cursor_data мог преобразовать эти данные в строковое представление.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит объект Artist.

Параметры:

rootbool, по умолчанию=False: Если False, возвращает (под)фигуру, на которой находится этот объект Artist. Если True, возвращает корневую Figure для вложенного дерева SubFigure.

get_fill()[исходный код]: Возвращает сведения о том, окрашена ли внутренняя область.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает толщину линий штриховки.

get_in_layout()[исходный код]

Возвращает логический флаг, True, указывающий, включён ли объект Artist в расчёты компоновки.

Например, см. Руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

{'miter', 'round', 'bevel'} or None

get_label()[исходный код]: Возвращает метку, используемую для этого художника в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли для этого художника дополнительные контекстные сведения при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого художника.

get_offsets()[исходный код]: Возвращает смещения коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение художника при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растрировать художника.

get_sizes()[исходный код]

Возвращает размеры («площади») элементов коллекции.

Возвращает:

array: «Площадь» каждого элемента.

get_sketch_params()[исходный код]

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

Возвращает:

tuple or None

Кортеж из 3 элементов со следующими значениями:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент, на который длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Как Artist.get_window_extent, но с учётом обрезки.

Параметры:

rendererподкласс RendererBase, необязательный: модуль визуализации, который будет использоваться для рисования фигур (то есть fig.canvas.get_renderer())

Возвращает:

Bbox or None: Ограничивающая рамка (в пиксельных координатах фигуры). Возвращает None, если в результате обрезки пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим художником.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает контур обрезки с применённой неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Для элементов без URL в списке указано None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer=None)[исходный код]

Получает ограничивающую рамку художника в пространстве отображения.

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

Для включения в расчёт «плотной» ограничивающей рамки подклассы должны переопределять этот метод. По умолчанию возвращается пустая ограничивающая рамка в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает порядок наложения художника (zorder).

have_units()[исходный код]: Возвращает, заданы ли единицы измерения хотя бы для одной оси.

is_transform_set()[исходный код]

Возвращает, было ли для Artist явно задано преобразование.

Это значение True после вызова set_transform.

propertymouseover: Возвращает, запрашиваются ли для этого художника дополнительные контекстные сведения при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

Возвращает, можно ли выбрать художника.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами художника.

remove()[исходный код]

Удаляет художника из фигуры, если это возможно.

Примечание: relim не обнаружит коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи художника из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору его наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Задать несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив чисел с плавающей запятой размера (m, n, 3) и значение dpi и возвращающая массив размера (m, n, 3) и два смещения относительно нижнего левого угла изображения
`alpha`	array-like или float или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	array-like или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` or `ec` or `edgecolors`	цвет или список значений цвет или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список значений цвет
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `dashes` or `linestyles` or `ls`	str или tuple, либо список таких значений
`linewidth` or `linewidths` or `lw`	float или список значений float
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` or `transOffset`	`Transform`
`offsets`	array-like размера (N, 2) или (2,)
`path_effects`	список `AbstractPathEffect`
`paths`	список объектов array-like
`picker`	None или bool или float или callable
`pickradius`	float
`rasterized`	bool
`sizes`	`numpy.ndarray` или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`verts`	список объектов array-like
`verts_and_codes`	неизвестно
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[исходный код]

Задать фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, принимающая массив чисел с плавающей запятой размера (m, n, depth) и значение dpi и возвращающая массив размера (m, n, depth) и два смещения относительно нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задать значение alpha, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Указать, предназначен ли Artist для использования в анимации.

Если значение True, Artist исключается из обычной отрисовки фигуры. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для Artist. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Более быстрая отрисовка с помощью blitting.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задать состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задать массив значений из объекта array-like A.

Параметры:

Aarray-like or None

Значения, сопоставляемые цветам.

Базовый класс ScalarMappable не накладывает никаких ограничений на размерность и форму массива значений A.

set_capstyle(cs)[исходный код]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

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

set_clim(vmin=None, vmax=None)[исходный код]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать в виде кортежа (vmin, vmax) одним позиционным аргументом.

set_clip_box(clipbox)[исходный код]

Задать область отсечения Artist — Bbox.

Параметры:

clipboxBboxBase или None: Обычно создаётся на основе TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) — это область отсечения по умолчанию для Artist, добавленного в Axes.

set_clip_on(b)[исходный код]

Указать, использует ли Artist отсечение.

Если значение False, Artist будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать путь обрезки для художника.

Параметры:

pathPatch или Path или TransformedPath или None: Путь обрезки. Если задан объект Path, необходимо также указать transform. Если задано значение None, ранее заданный путь обрезки удаляется.
transformTransform, необязательно: Используется только если path — это Path; в этом случае указанный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — это Rectangle, этот метод задаёт область обрезки в виде соответствующего прямоугольника, а путь обрезки задаёт равным None.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных о яркости.

Параметры:

cmapColormap или str или None

set_color(c)[исходный код]

Задать одновременно цвет края и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для задания цвета края или заливки по отдельности.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет или цвета края коллекции.

Параметры:

cцвет или список значений цвет или 'face': Цвет или цвета края коллекции. Если задана последовательность, заливки поочерёдно используют её элементы. Если задано значение 'face', цвет совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет или цвета заливки коллекции. c может быть цветом (все многоугольники будут одного цвета) или последовательностью цветов; если задана последовательность, многоугольники будут поочерёдно использовать её элементы.

Если c равно 'none', многоугольник не будет залит.

Параметры:

cцвет или список значений цвет

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, к которому принадлежит художник.

Параметры:

figFigure или SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) для художника.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать: в этом случае применяются все указанные узоры штриховки. Повторение одной и той же буквы увеличивает плотность штриховки соответствующего узора.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно задать только для всей коллекции, а не отдельно для каждого её элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать ширину линии штриховки.

set_in_layout(in_layout)[исходный код]

Задать, следует ли включать художника в расчёты компоновки, например, при использовании руководства по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[исходный код]

Задать подпись, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль или стили линии для коллекции.

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

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

(offset, onoffseq),

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

Параметры:

lsstr или tuple или список таких значений: Допустимые значения для отдельных стилей линии: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать ширину или ширины линии для коллекции. lw может быть скалярным значением или последовательностью; если задана последовательность, многоугольники будут поочерёдно использовать её элементы.

Параметры:

lwfloat или список значений float

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого художника дополнительные сведения при наведении на него курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsetsмассивоподобный объект формы (N, 2) или (2,)

set_path_effects(path_effects)[исходный код]

Задать эффекты пути.

Параметры:

path_effectsсписок объектов AbstractPathEffect

set_paths(verts, closed=True)[исходный код]

Задать вершины многоугольников.

Параметры:

vertsсписок массивоподобных объектов: Последовательность многоугольников [verts0, verts1, ...], где каждый элемент verts_i задаёт вершины многоугольника i в виде двумерного массивоподобного объекта формы (M, 2).
closedbool, по умолчанию: True: Следует ли замкнуть многоугольник, добавив в конце соединение CLOSEPOLY.

set_picker(picker)[исходный код]

Определяет поведение выбора объекта.

Параметры:

pickerNone или bool или float или callable

Возможны следующие значения:

None: выбор этого объекта отключён (по умолчанию).
Булево значение: если задано True, выбор будет включён, и объект сгенерирует событие выбора, если событие мыши произошло над объектом.
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск epsilon в пунктах, и объект сгенерирует событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых объектов, например линий и коллекций патчей, объект может добавить в сгенерированное событие выбора дополнительные данные, например индексы данных, находящихся в пределах epsilon от события выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, которая определяет, затронут ли объект событием мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если событие мыши произошло над объектом, верните hit=True, а props — словарь свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задаёт радиус выбора, используемый для проверки вхождения.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно включает растровую (битовую) отрисовку для вывода векторной графики.

Растровая отрисовка поддерживается не всеми объектами. Если попытаться включить её для объекта, который её не поддерживает, команда не даст эффекта и будет выдано предупреждение.

Этот параметр игнорируется для вывода на основе пикселей.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Задаёт размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер, задаваемый для каждого элемента коллекции. Значение представляет собой «площадь» элемента.
dpifloat, по умолчанию: 72: Разрешение холста в dpi.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задаёт параметры эскиза.

Параметры:

scalefloat, необязательный

lengthfloat, необязательный

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательный

Коэффициент масштабирования, определяющий, насколько длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(snap)[исходный код]

Задаёт поведение привязки к пикселям.

Привязка выравнивает положения по сетке пикселей, благодаря чему изображения становятся чётче. Например, если чёрная линия шириной 1px задана между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в сетке пикселей, то есть серое значение в обоих соседних пикселях. При привязке линия перемещается к ближайшему целочисленному значению пикселя, поэтому в результирующем изображении действительно будет чёрная линия шириной 1px.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool или None

Возможные значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять положения вершин.
None: (автоматически) если путь содержит только прямолинейные сегменты, округлить до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задаёт преобразование объекта.

Параметры:

tTransform

set_url(url)[исходный код]

Задаёт URL для объекта.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL-адреса реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_verts(verts, closed=True)[исходный код]

Задаёт вершины многоугольников.

Параметры:

vertslist of array-like: Последовательность многоугольников [verts0, verts1, ...], где каждый элемент verts_i задаёт вершины многоугольника i в виде двумерного объекта, подобного массиву, формы (M, 2).
closedbool, по умолчанию: True: Следует ли замкнуть многоугольник, добавив в конце соединение CLOSEPOLY.

set_verts_and_codes(verts, codes)[исходный код]: Инициализирует вершины кодами пути.

set_visible(b)[исходный код]

Задаёт видимость объекта.

Параметры:

bbool

set_zorder(level)[исходный код]

Задаёт zorder объекта. Объекты с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли объект «устаревшим» и нужно ли перерисовать его, чтобы вывод соответствовал внутреннему состоянию объекта.

propertysticky_edges

x и y списки фиксированных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — предел отображения «прилипает» к границе. Типичный пример — гистограммы, для которых обычно не требуется отступ у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может их пересечь. Например, если верхний предел данных равен 1.0, верхний предел отображения, вычисленный простым добавлением отступа, равен 1.2, но фиксированная граница находится на 1.1, фактический верхний предел отображения будет равен 1.1.

Этому атрибуту нельзя присвоить значение; однако списки x и y можно при необходимости изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив RGBA, соответствующий x.

Существует один особый случай обработки изображений, уже представленных в формате RGB или RGBA, например прочитанных из файла изображения. Если x — это ndarray с тремя измерениями, а размер последнего измерения равен 3 или 4, он будет обработан как массив RGB или RGBA без преобразования. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвана ошибка ValueError. Все значения NaN и маскированные элементы получат альфа-значение 0. Если размер последнего измерения равен 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если размер последнего измерения равен 4, аргумент alpha игнорируется: он не заменяет уже имеющееся альфа-значение. Если третье измерение не равно 3 или 4, будет вызвана ошибка ValueError.

В обоих случаях, если bytes равно False (по умолчанию), массив RGBA будет содержать числа с плавающей точкой в диапазоне 0–1; если задано True, возвращаемый массив RGBA будет иметь тип uint8 и значения в диапазоне от 0 до 255.

Если norm равно False, входные данные не нормализуются и считаются находящимися в диапазоне (0–1).

update(props)[исходный код]

Обновляет свойства этого объекта значениями из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Копирует свойства из other в self.

update_scalarmappable()[исходный код]

Обновляет цвета по массиву скалярного отображения, если он задан.

Назначает цвета границам и заливке на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.PolyQuadMesh(coordinates, **kwargs)[исходный код]

Bases: _MeshData, PolyCollection

Класс для отрисовки четырёхугольной сетки в виде отдельных многоугольников.

Четырёхугольная сетка — это сетка из M на N смежных четырёхугольников, задаваемых сеткой вершин размером (M+1, N+1). Четырёхугольник (m, n) задаётся вершинами

   (m+1, n) ----------- (m+1, n+1)
      /                   /
     /                 /
    /               /
(m, n) -------- (m, n+1)

Сетка не обязана быть регулярной, а многоугольники не обязаны быть выпуклыми.

Параметры:

coordinates(M+1, N+1, 2) array-like: Вершины. coordinates[m, n] задаёт координаты (x, y) вершины (m, n).

Примечания

В отличие от QuadMesh, этот класс отрисовывает каждую ячейку как отдельный многоугольник. Это значительно медленнее, но обеспечивает большую гибкость, когда требуется добавить к ячейкам дополнительные свойства, например штриховку.

Ещё одно отличие от QuadMesh состоит в том, что если какие-либо вершины или данные ячейки замаскированы, этот многоугольник не будет отрисован и не попадёт в возвращаемый список путей.

Параметры:

vertslist of array-like: Последовательность многоугольников [verts0, verts1, ...], где каждый элемент verts_i задаёт вершины многоугольника i в виде двумерного объекта array-like формы (M, 2).
sizesarray-like, default: None: Квадраты коэффициентов масштабирования многоугольников. Координаты каждого многоугольника verts_i умножаются на квадратный корень из соответствующего элемента sizes (то есть sizes задаёт масштабирование площадей). Масштабирование применяется до основного преобразования Artist.
closedbool, default: True: Следует ли замкнуть многоугольник, добавив в конце соединение CLOSEPOLY.
**kwargs: Передаются в Collection.

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая вызывается при изменении любого свойства объекта Artist.

Параметры:

funccallable

Функция обратного вызова. Её сигнатура должна иметь вид:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения могут быть, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позднее этот идентификатор можно использовать для удаления функции с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив и изменяя только пределы, равные None

propertyaxes: Экземпляр Axes, в котором находится объект artist, либо None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x в соответствии с типом единиц измерения оси x.

Если объект artist не содержится в Axes или у оси x не заданы единицы измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразует y в соответствии с типом единиц измерения оси y.

Если объект artist не содержится в Axes или у оси y не заданы единицы измерения, возвращается само значение y.

draw(renderer)[исходный код]

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

Ничего не делает, если объект artist невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: Фигура (или подфигура), на которой находится объект artist. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Находит объекты artist.

Рекурсивно находит все экземпляры Artist, содержащиеся в объекте artist.

Параметры:

match

Критерий фильтрации результатов. Это может быть

None: вернуть все объекты, содержащиеся в объекте artist.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только те объекты artist, для которых функция возвращает True.
Экземпляр класса: например, Line2D. В результат войдут только объекты artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включать ли self в список объектов, проверяемых на соответствие критерию.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах artist. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы из целых чисел и чисел с плавающей точкой в строку со значениями, разделёнными запятыми и заключёнными в квадратные скобки. Если с объектом artist связана цветовая шкала, скалярные значения форматируются с помощью её форматера.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Возвращает функцию фильтрации, используемую для фильтра agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания; поддерживается не всеми backend.

get_animated()[исходный код]: Возвращает, является ли объект artist анимированным.

get_antialiased()[исходный код]

Возвращает состояние сглаживания при отрисовке.

Возвращает:

массив логических значений

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Возвращает массив значений, отображаемых цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

Возвращает стиль концов для коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Возвращает список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Возвращает значения (min, max), отображаемые в пределы цветовой карты.

get_clip_box()[исходный код]: Возвращает область отсечения.

get_clip_on()[исходный код]: Возвращает, использует ли объект artist отсечение.

get_clip_path()[исходный код]: Возвращает путь отсечения.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_coordinates()[исходный код]

Возвращает вершины сетки в виде массива формы (M+1, N+1, 2).

M и N — число четырёхугольников в строках и столбцах сетки, которым соответствуют (M+1, N+1) вершин. Последняя размерность задаёт компоненты (x, y).

get_cursor_data(event)[исходный код]

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

Примечание

Объекты Artist могут использовать данные курсора, чтобы предоставлять дополнительную контекстную информацию для заданного события. Реализация по умолчанию просто возвращает None.

Подклассы могут переопределить метод и возвращать произвольные данные. Однако при этом необходимо обеспечить, чтобы format_cursor_data мог преобразовать данные в строковое представление.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит объект artist.

Параметры:

rootbool, default=False: Если False, возвращает фигуру (или подфигуру), на которой находится этот объект artist. Если True, возвращает корневую фигуру для вложенной иерархии подфигур.

get_fill()[исходный код]: Возвращает, залита ли грань цветом.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает толщину линий штриховки.

get_in_layout()[исходный код]

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

Например, руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого художника в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашивается ли у этого художника пользовательская контекстная информация при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого художника.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение художника при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растрировать художника.

get_sizes()[исходный код]

Возвращает размеры («площади») элементов коллекции.

Возвращает:

массив: «Площадь» каждого элемента.

get_sketch_params()[исходный код]

Возвращает параметры эскиза для художника.

Возвращает:

кортеж или None

Кортеж из трёх элементов со следующими значениями:

scale: амплитуда отклонения перпендикулярно исходной линии.
length: длина отклонения вдоль линии.
randomness: коэффициент, на который уменьшается или увеличивается длина.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Аналогично Artist.get_window_extent, но учитывает любое отсечение.

Параметры:

rendererподкласс RendererBase, необязательный: визуализатор, который будет использоваться для отрисовки рисунков (то есть fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающая рамка (в пиксельных координатах рисунка). Возвращает None, если в результате отсечения пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим художником.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь отсечения с применённой неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Для элементов без URL-адреса в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает значение видимости.

get_window_extent(renderer=None)[исходный код]

Возвращает ограничивающую рамку художника в пространстве отображения.

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

Для включения в расчёт ограничивающей рамки «tight» подклассы должны переопределять этот метод. По умолчанию возвращается пустая ограничивающая рамка в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает порядок отрисовки zorder художника.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения для какой-либо оси.

is_transform_set()[исходный код]

Возвращает, задано ли для Artist явное преобразование.

Значение равно True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли у этого художника пользовательская контекстная информация при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция запускается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами художника.

remove()[исходный код]

Удаляет художника с рисунка, если это возможно.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи художника из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору его наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Задать несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтрации, принимающая массив чисел с плавающей точкой размером (m, n, 3) и значение dpi и возвращающая массив размером (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	массивоподобный объект, число с плавающей точкой или None
`animated`	bool
`antialiased` или `aa` или `antialiaseds`	bool или список значений bool
`array`	неизвестно
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` или `ec` или `edgecolors`	цвет или список значений цвета или 'face'
`facecolor` или `facecolors` или `fc`	цвет или список значений цвета
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или `dashes` или `linestyles` или `ls`	str или кортеж или список таких значений
`linewidth` или `linewidths` или `lw`	число с плавающей точкой или список таких чисел
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` или `transOffset`	`Transform`
`offsets`	массивоподобный объект формы (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	список массивоподобных объектов
`picker`	None, bool, число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	`numpy.ndarray` или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список str или None
`verts`	список массивоподобных объектов
`verts_and_codes`	неизвестно
`visible`	bool
`zorder`	число с плавающей точкой

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

set_agg_filter(filter_func)[исходный код]

Задать фильтр agg.

Параметры:

filter_funcвызываемый объект: Функция фильтрации, принимающая массив чисел с плавающей точкой размером (m, n, depth) и значение dpi и возвращающая массив размером (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задать значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaмассивоподобный объект, число с плавающей точкой или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Задать, предназначен ли объект Artist для использования в анимации.

Если значение True, объект Artist исключается из обычной отрисовки фигуры. Для этого необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для объекта Artist. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Ускорение отрисовки с помощью blitting.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задать режим сглаживания при отрисовке.

Параметры:

aabool или список значений bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задать значения данных.

Параметры:

Aмассивоподобный объект

Данные сетки. Поддерживаются массивы следующих форм:

(M, N) или (M*N): сетка со скалярными данными. Значения преобразуются в цвета с помощью нормализации и цветовой карты. См. параметры norm, cmap, vmin, vmax.
(M, N, 3): изображение со значениями RGB (числа с плавающей точкой от 0 до 1 или целые числа от 0 до 255).
(M, N, 4): изображение со значениями RGBA (числа с плавающей точкой от 0 до 1 или целые числа от 0 до 255), то есть с прозрачностью.

Если значения заданы в виде двумерной сетки, ее форма должна совпадать с формой сетки координат. Если значения одномерные, они преобразуются в двумерную форму. M и N определяются по сетке координат: ее форма равна (M, N) для затенения 'gouraud' и (M+1, N+1) для затенения 'flat'.

set_capstyle(cs)[исходный код]

Задать CapStyle для коллекции (для всех ее элементов).

Параметры:

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

set_clim(vmin=None, vmax=None)[исходный код]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxчисло с плавающей точкой

Пределы.

Для скалярных данных пределы также можно передать одним позиционным аргументом в виде кортежа (vmin, vmax).

set_clip_box(clipbox)[исходный код]

Задать область отсечения Bbox объекта Artist.

Параметры:

clipboxBboxBase или None: Обычно создается на основе TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) — это область отсечения по умолчанию для объекта Artist, добавленного в Axes.

set_clip_on(b)[исходный код]

Задать, используется ли для объекта Artist отсечение.

Если значение False, объекты Artist будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать путь отсечения художника.

Параметры:

pathPatch или Path или TransformedPath или None: Путь отсечения. Если задан объект Path, необходимо также указать transform. Если задано значение None, ранее установленный путь отсечения удаляется.
transformTransform, необязательный: Используется только если path — это Path; в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является объектом Rectangle, этот метод задаст ограничивающую рамку отсечения в соответствии с этим прямоугольником, а путь отсечения задаст как None.

По техническим причинам (для поддержки set) в качестве одного позиционного параметра также допускается кортеж (path, transform).

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных о яркости.

Параметры:

cmapColormap или str или None

set_color(c)[исходный код]

Задать одновременно цвет контура и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

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

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет контура или цвета контуров коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет контура или цвета контуров коллекции. Если задана последовательность, контуры будут перебирать её элементы по циклу. Если задано значение 'face', цвет будет совпадать с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет заливки или цвета заливки коллекции. c может быть цветом (все элементы будут одного цвета) или последовательностью цветов; если задана последовательность, цвета будут циклически применяться к элементам.

Если c равно 'none', заливка элемента не выполняется.

Параметры:

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, которому принадлежит художник.

Параметры:

figFigure или SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) художника.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать толщину линии штриховки.

set_in_layout(in_layout)[исходный код]

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать стиль соединения JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[исходный код]

Задать подпись, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль линии или стили линий для коллекции.

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

Кроме того, можно задать кортеж штриховки следующего вида:

(offset, onoffseq),

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

Параметры:

lsstr или tuple или список таких значений: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать толщину линии или толщины линий для коллекции. lw может быть скаляром или последовательностью; если задана последовательность, значения будут циклически применяться к элементам.

Параметры:

lwfloat или список значений float

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsetsмассивоподобный объект формы (N, 2) или (2,)

set_path_effects(path_effects)[исходный код]

Задать эффекты пути.

Параметры:

path_effectsсписок объектов AbstractPathEffect

set_paths(verts, closed=True)[исходный код]

Задать вершины многоугольников.

Параметры:

vertsсписок массивоподобных объектов: Последовательность многоугольников [verts0, verts1, ...], где каждый элемент verts_i задаёт вершины многоугольника i в виде двумерного массивоподобного объекта формы (M, 2).
closedbool, по умолчанию: True: Следует ли замкнуть многоугольник, добавив в конце соединение CLOSEPOLY.

set_picker(picker)[исходный код]

Определить поведение художника при выборе щелчком.

Параметры:

pickerNone, bool, float или вызываемый объект

Значение может быть одним из следующих:

None: выбор этого художника отключён (по умолчанию).
Логическое значение: если задано True, выбор будет включён, и художник сгенерирует событие выбора, если указатель мыши находится над ним.
Вещественное число: если picker — число, оно интерпретируется как допуск epsilon в пунктах; художник сгенерирует событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых художников, например линий и коллекций элементов заливки, в сгенерированное событие выбора могут быть добавлены дополнительные данные, например индексы данных, расположенных в пределах epsilon от места выбора.
Функция: если picker является вызываемым объектом, он представляет собой предоставленную пользователем функцию, которая определяет, попал ли указатель мыши на художника:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если указатель мыши находится над художником, верните hit=True, а props должен быть словарём свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый при проверке принадлежности.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно использовать растровую отрисовку для вывода векторной графики.

Растровая отрисовка поддерживается не всеми объектами Artist. Если попытаться включить её для объекта, который её не поддерживает, команда не окажет никакого эффекта и будет выдано предупреждение.

Этот параметр игнорируется при выводе на основе пикселей.

См. также Растрирование векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Задать размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray or None: Размер, который следует задать для каждого элемента коллекции. Значение соответствует «площади» элемента.
dpifloat, default: 72: Разрешение холста в точках на дюйм.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эффекта наброска.

Параметры:

scalefloat, optional

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None или не указан, фильтр эффекта наброска применяться не будет.

lengthfloat, optional

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, optional

Коэффициент масштабирования, определяющий, во сколько раз длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(snap)[исходный код]

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

Привязка выравнивает координаты по пиксельной сетке, что повышает чёткость изображений. Например, если чёрная линия шириной 1 пиксель задана между двумя пикселями, итоговое изображение будет содержать интерполированное значение этой линии на пиксельной сетке — серое значение в обоих соседних пикселях. При привязке линия перемещается к ближайшему целочисленному значению пикселя, поэтому на итоговом изображении получается настоящая чёрная линия шириной 1 пиксель.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Возможные значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять положения вершин.
None: (автоматически) если путь содержит только прямолинейные отрезки, округлить координаты до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование объекта Artist.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL для объекта Artist.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL поддерживаются только бэкендом SVG. Все остальные бэкенды их игнорируют.

set_verts(verts, closed=True)[исходный код]

Задать вершины многоугольников.

Параметры:

vertslist of array-like: Последовательность многоугольников [verts0, verts1, ...], где каждый элемент verts_i задаёт вершины многоугольника i в виде двумерного массива-подобного объекта формы (M, 2).
closedbool, default: True: Следует ли замкнуть многоугольник, добавив в конце соединение CLOSEPOLY.

set_verts_and_codes(verts, codes)[исходный код]: Инициализировать вершины с кодами пути.

set_visible(b)[исходный код]

Задать видимость объекта Artist.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать порядок отрисовки объекта Artist. Объекты с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли объект Artist «устаревшим» и требуется ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию объекта.

propertysticky_edges

x и y списки закреплённых границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — предел отображения «прилипает» к границе. Типичный пример — гистограммы, у которых обычно не ожидается отступа у нижней границы (0).

Кроме того, расширение отступа «упирается» в закреплённые границы и не может выйти за них. Например, если верхний предел данных равен 1.0, верхний предел отображения, вычисленный простым добавлением отступа, равен 1.2, но закреплённая граница находится на отметке 1.1, фактический верхний предел отображения будет равен 1.1.

Этому атрибуту нельзя присвоить значение, однако списки x и y можно при необходимости изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скалярных значений, и возвращается соответствующий массив значений RGBA ndarray, сформированный на основе нормализации и цветовой карты, заданных для этого Colorizer.

Предусмотрен особый случай для обработки изображений, уже представленных в формате RGB или RGBA, например прочитанных из файла изображения. Если x — это трёхмерный ndarray, а размер последнего измерения равен 3 или 4, он будет обработан как массив RGB или RGBA без выполнения преобразования. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Все значения NaN и маскированные элементы получат альфа-значение 0. Если размер последнего измерения равен 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если размер последнего измерения равен 4, аргумент alpha игнорируется и не заменяет уже имеющееся альфа-значение. Если размер третьего измерения не равен 3 или 4, будет вызвано исключение ValueError.

update(props)[исходный код]

Обновить свойства этого объекта Artist значениями из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета на основе массива, отображаемого скалярной величиной, если он есть.

Назначить цвета границам и граням на основе массива и/или цветов, заданных напрямую, если это применимо.

zorder=0

classmatplotlib.collections.QuadMesh(coordinates, *, antialiased=True, shading='flat', **kwargs)[исходный код]

Базовые классы: _MeshData, Collection

Класс для эффективного рисования четырёхугольной сетки.

Четырёхугольная сетка — это сетка из M на N смежных четырёхугольников, определяемых сеткой вершин размером (M+1, N+1). Четырёхугольник (m, n) определяется вершинами

   (m+1, n) ----------- (m+1, n+1)
      /                   /
     /                 /
    /               /
(m, n) -------- (m, n+1)

Сетка не обязательно должна быть регулярной, а многоугольники не обязательно должны быть выпуклыми.

Параметры:

coordinates(M+1, N+1, 2) array-like: Вершины. coordinates[m, n] задаёт координаты (x, y) вершины (m, n).
antialiasedbool, default: True
shading{'flat', 'gouraud'}, default: 'flat'

Примечания

В отличие от других объектов Collection, значение pickradius по умолчанию для QuadMesh равно 0, то есть contains проверяет, находится ли тестовая точка внутри какого-либо четырёхугольника сетки.

Параметры:

edgecolorsцвет или список цветов, по умолчанию: rcParams["patch.edgecolor"] (значение по умолчанию: 'black')

Цвет границы для каждого элемента коллекции. Специальное значение 'face' можно передать, чтобы цвет границы совпадал с цветом заливки.

facecolorsцвет или список цветов, по умолчанию: rcParams["patch.facecolor"] (значение по умолчанию: 'C0')

Цвет заливки для каждого элемента коллекции.

linewidthsfloat или список значений float, по умолчанию: rcParams["patch.linewidth"] (значение по умолчанию: 1.0)

Толщина линии для каждого элемента коллекции.

linestylesstr, tuple или список таких значений, по умолчанию: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь следующий вид:

(offset, onoffseq),

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

capstyleподобный CapStyle, по умолчанию: 'butt'

Стиль завершения линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.

joinstyleподобный JoinStyle, по умолчанию: 'round'

Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.

antialiasedsbool или список значений bool, по умолчанию: rcParams["patch.antialiased"] (значение по умолчанию: True)

Следует ли рисовать каждый элемент коллекции с включённым сглаживанием.

offsets(float, float) или список таких значений, по умолчанию: (0, 0)

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

offset_transformTransform, по умолчанию: IdentityTransform

Единое преобразование, применяемое к каждому вектору offsets перед его использованием.

cmap, norm

Параметры нормализации данных и сопоставления цветов. Подробное описание см. в документации ScalarMappable.

hatchstr, необязательный

Используемый узор штриховки для залитых путей, если он задан. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Значение каждого типа штриховки см. в разделе Справочник по стилям штриховки.

pickradiusfloat, по умолчанию: 5.0

Если pickradius <= 0, то Collection.contains вернёт True, если тестовая точка находится внутри одного из многоугольников, образованных контрольными точками пути в коллекции. Если же значение больше 0, проверяется, находится ли тестовая точка в штрихе шириной 2*pickradius вдоль любого из путей в коллекции.

urlsсписок str, по умолчанию: None

URL-ссылка для каждого элемента после его отрисовки. В настоящее время работает только с бэкендом SVG. Примеры см. в разделе Гиперссылки.

zorderfloat, по умолчанию: 1

Порядок отрисовки, общий для всех объектов Patch в коллекции. Значения по умолчанию и примеры см. в разделе Пример zorder.

**kwargs

Оставшиеся именованные аргументы будут использоваться для задания свойств через Collection.set_{key}(val) для каждой пары ключ-значение в kwargs.

add_callback(func)[исходный код]

Добавить функцию обратного вызова, которая будет вызываться при изменении любого из свойств Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Её сигнатура должна быть следующей:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения допустимы, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позднее этот идентификатор можно использовать для удаления функции с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра norm, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра norm, используя текущий массив и изменяя только пределы со значением None

свойствоaxes: Экземпляр Axes, в котором находится объект artist, или None.

changed()[исходный код]: Вызывать при каждом изменении объекта mappable, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

свойствоcmap

свойствоcolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

свойствоcolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразовать x согласно типу единиц оси x.

Если объект artist не входит в Axes или для оси x не заданы единицы измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразовать y согласно типу единиц оси y.

Если объект artist не входит в Axes или для оси y не заданы единицы измерения, возвращается само значение y.

draw(renderer)[исходный код]

Нарисовать объект Artist и его дочерние объекты с помощью указанного renderer.

Ничего не происходит, если объект artist невидим (Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

свойствоfigure: Figure или SubFigure, к которому относится объект artist. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Найти объекты artist.

Рекурсивно найти все экземпляры Artist, содержащиеся в объекте artist.

Параметры:

match

Критерий фильтрации совпадений. Это может быть:

None: вернуть все объекты, содержащиеся в объекте artist.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только объекты artist, для которых функция возвращает True.
Экземпляр класса, например Line2D. Результат будет содержать только объекты artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включать ли self в список объектов для проверки совпадения.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Вернуть строковое представление data.

Примечание

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы таких чисел в строку со значениями, разделёнными запятыми и заключёнными в квадратные скобки. Если же с объектом artist связана цветовая шкала, скалярные значения форматируются с помощью её форматтера.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Вернуть функцию фильтрации, используемую для agg-фильтра.

get_alpha()[исходный код]: Вернуть значение alpha, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Вернуть информацию о том, является ли объект artist анимированным.

get_antialiased()[исходный код]

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

Возвращает:

массив значений bool

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Вернуть массив значений, сопоставленных с цветами.

Базовый класс ScalarMappable не накладывает ограничений на размерность и форму массива.

get_capstyle()[исходный код]

Вернуть стиль завершения линий для коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Вернуть список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Вернуть значения (min, max), сопоставленные с пределами цветовой карты.

get_clip_box()[исходный код]: Вернуть область отсечения.

get_clip_on()[исходный код]: Вернуть информацию о том, использует ли объект artist отсечение.

get_clip_path()[исходный код]: Вернуть путь отсечения.

get_cmap()[исходный код]: Вернуть экземпляр Colormap.

get_coordinates()[исходный код]

Вернуть вершины сетки в виде массива размером (M+1, N+1, 2).

M и N — количество четырёхугольников в строках и столбцах сетки, соответствующее (M+1, N+1) вершинам. Последняя размерность задаёт компоненты (x, y).

get_cursor_data(event)[исходный код]

Вернуть данные курсора для заданного события.

Примечание

Данные курсора могут использоваться объектами Artist для предоставления дополнительной контекстной информации для заданного события. Реализация по умолчанию просто возвращает None.

Подклассы могут переопределить метод и возвращать произвольные данные. Однако при этом необходимо убедиться, что format_cursor_data может преобразовать данные в строковое представление.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит этот объект Artist.

Параметры:

rootbool, по умолчанию=False: Если False, возвращает (под)фигуру, в которой находится этот объект Artist. Если True, возвращает корневую Figure для вложенного дерева SubFigure.

get_fill()[исходный код]: Возвращает, закрашена ли грань.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает ширину линий штриховки.

get_in_layout()[исходный код]

Возвращает логический флаг, True если объект Artist включён в расчёты компоновки.

Например, руководство по компоновке с ограничениями, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого объекта Artist в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли у этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого объекта Artist.

get_offsets()[исходный код]: Возвращает смещения элементов коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение объекта Artist при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, будет ли объект Artist растрирован.

get_sketch_params()[исходный код]

Возвращает параметры эскиза для объекта Artist.

Возвращает:

tuple или None

Кортеж из 3 элементов:

scale: амплитуда колебания перпендикулярно исходной линии.
length: длина колебания вдоль линии.
randomness: коэффициент, на который умножается длина для её уменьшения или увеличения.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Подобно Artist.get_window_extent, но учитывает обрезку.

Параметры:

rendererподкласс RendererBase, необязательный: объект renderer, который будет использоваться для отрисовки фигур (т. е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающий прямоугольник (в пиксельных координатах фигуры). Возвращает None, если в результате обрезки пересечение отсутствует.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом Artist.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает контур обрезки с применённой неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL — по одному для каждого элемента коллекции.

Для элементов без URL в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает состояние видимости.

get_window_extent(renderer=None)[исходный код]

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

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

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

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

get_zorder()[исходный код]: Возвращает порядок отрисовки zorder объекта Artist.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения хотя бы для одной оси.

is_transform_set()[исходный код]

Возвращает, было ли для Artist явно задано преобразование.

Значение равно True после вызова set_transform.

propertymouseover: Возвращает, запрашиваются ли у этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные функции обратного вызова.

Эта функция вызывается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний объект Artist генерирует событие выбора, если курсор mouseevent находится над ним и для объекта задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами объекта Artist.

remove()[исходный код]

Удаляет объект Artist из фигуры, если это возможно.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи объекта Artist из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Задает несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив чисел с плавающей точкой размерности (m, n, 3) и значение dpi и возвращающая массив размерности (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	array-like or float or None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool or list of bools
`array`	array-like
`capstyle`	`CapStyle` or {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` or None
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`cmap`	`Colormap` or str or None
`color`	цвет или список кортежей RGBA
`edgecolor` or `ec` or `edgecolors`	цвет или список цветов или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список цветов
`figure`	`Figure` or `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` or {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `dashes` or `linestyles` or `ls`	str or tuple or list thereof
`linewidth` or `linewidths` or `lw`	float or list of floats
`mouseover`	bool
`norm`	`Normalize` or str or None
`offset_transform` or `transOffset`	`Transform`
`offsets`	(N, 2) or (2,) array-like
`path_effects`	list of `AbstractPathEffect`
`picker`	None or bool or float or callable
`pickradius`	float
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`transform`	`Transform`
`url`	str
`urls`	list of str or None
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[исходный код]

Задает фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, принимающая массив чисел с плавающей точкой размерности (m, n, depth) и значение dpi и возвращающая массив размерности (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[исходный код]

Задает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Задает, предназначен ли объект Artist для использования в анимации.

Если значение True, объект Artist исключается из обычной отрисовки фигуры. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для объекта Artist. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Ускорение отрисовки с помощью blitting.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задает состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задает значения данных.

Параметры:

Aarray-like

Данные сетки. Поддерживаются следующие формы массива:

(M, N) or (M*N,): сетка со скалярными данными. Значения отображаются в цвета с помощью нормализации и цветовой карты. См. параметры norm, cmap, vmin, vmax.
(M, N, 3): изображение со значениями RGB (числа с плавающей точкой от 0 до 1 или целые числа от 0 до 255).
(M, N, 4): изображение со значениями RGBA (числа с плавающей точкой от 0 до 1 или целые числа от 0 до 255), то есть с прозрачностью.

Если значения переданы в виде двумерной сетки, ее форма должна совпадать с формой сетки координат. Если значения одномерные, они преобразуются в двумерную форму. M и N определяются по сетке координат: ее форма — (M, N) для shading 'gouraud' и (M+1, N+1) для 'flat' shading.

set_capstyle(cs)[исходный код]

Задает стиль окончания CapStyle для коллекции (для всех ее элементов).

Параметры:

csCapStyle or {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Задает пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать одним позиционным аргументом в виде кортежа (vmin, vmax).

set_clip_box(clipbox)[исходный код]

Задает ограничивающую область отсечения объекта Artist — Bbox.

Параметры:

clipboxBboxBase or None: Обычно создается из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) является областью отсечения по умолчанию для объекта Artist, добавленного в Axes.

set_clip_on(b)[исходный код]

Задает, использует ли объект Artist отсечение.

При значении False объекты Artist будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Установить путь отсечения объекта Artist.

Параметры:

pathPatch или Path или TransformedPath или None: Путь отсечения. Если задан Path, необходимо также указать transform. Если задано значение None, ранее установленный путь отсечения удаляется.
transformTransform, необязательно: Используется только если path — это Path; в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path — это Rectangle, этот метод установит прямоугольник отсечения, соответствующий этому прямоугольнику, и задаст путь отсечения None.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных о яркости.

Параметры:

cmapColormap или str или None

set_color(c)[исходный код]

Задать цвет края и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для задания цвета края или заливки по отдельности.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет(а) края коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет(а) края коллекции. Если задана последовательность, элементы коллекции перебирают её циклически. Если задано 'face', цвет совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет(а) заливки коллекции. c может быть цветом (все элементы будут одного цвета) или последовательностью цветов; если задана последовательность, элементы коллекции будут перебирать её циклически.

Если c равно 'none', заливка элемента не выполняется.

Параметры:

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Установить экземпляр Figure или SubFigure, которому принадлежит объект Artist.

Параметры:

figFigure или SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) объекта Artist.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать — в этом случае применяются все указанные виды штриховки. Повторение одной и той же буквы увеличивает плотность соответствующего узора.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно задать только для коллекции в целом, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать толщину линии штриховки.

set_in_layout(in_layout)[исходный код]

Задать, следует ли включать объект Artist в расчёты компоновки, например в руководстве по constrained layout, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль(и) линии для коллекции.

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

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

(offset, onoffseq),

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

Параметры:

lsstr или tuple или список таких значений: Допустимые значения для отдельных стилей линии: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать толщину линии (линий) коллекции. lw может быть скалярным значением или последовательностью; если задана последовательность, элементы коллекции будут перебирать её циклически

Параметры:

lwfloat или список значений float

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого объекта Artist пользовательские контекстные данные при наведении на него курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения объекта Artist.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsetsмассивоподобный объект формы (N, 2) или (2,)

set_path_effects(path_effects)[исходный код]

Задать эффекты пути.

Параметры:

path_effectsсписок объектов AbstractPathEffect

set_paths()[исходный код]

set_picker(picker)[исходный код]

Задать поведение объекта Artist при выборе.

Параметры:

pickerNone, bool, float или вызываемый объект

Может принимать одно из следующих значений:

None: выбор для этого объекта Artist отключён (значение по умолчанию).
Булево значение: если задано True, выбор будет включён, и объект Artist сгенерирует событие выбора, если событие мыши произошло над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск epsilon в пунктах; объект Artist сгенерирует событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых объектов Artist, например линий и коллекций патчей, в событие выбора могут добавляться дополнительные данные, например индексы данных, находящихся в пределах epsilon от места выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, определяющая, попал ли указатель мыши в объект Artist:
```
hit, props = picker(artist, mouseevent)
```
для выполнения проверки попадания. Если событие мыши произошло над объектом Artist, верните hit=True; props — это словарь свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый для проверки попадания.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно включить растровую (битовую) отрисовку для вывода векторной графики.

Этот параметр игнорируется при выводе, основанном на пикселях.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эскиза.

Параметры:

scalefloat, optional

lengthfloat, optional

Длина колебаний вдоль линии, в пикселях (по умолчанию 128.0)

randomnessfloat, optional

Коэффициент, на который умножается длина при уменьшении или увеличении (по умолчанию 16.0)

set_snap(snap)[исходный код]

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

Привязка выравнивает координаты по пиксельной сетке, что позволяет получать более чёткие изображения. Например, если чёрная линия шириной 1px задана между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть серое значение в обоих соседних пикселях. При привязке линия перемещается к ближайшему целочисленному значению пикселя, поэтому на результирующем изображении действительно будет чёрная линия шириной 1px.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Возможные значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять положение вершин.
None: (автоматически) если путь содержит только прямолинейные отрезки, округлить координаты до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование графического объекта.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL для графического объекта.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL поддерживаются только бэкендом SVG. Все остальные бэкенды их игнорируют.

set_visible(b)[исходный код]

Задать видимость графического объекта.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать zorder графического объекта. Объекты с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли графический объект «устаревшим» и нужно ли перерисовать его, чтобы вывод соответствовал внутреннему состоянию объекта.

propertysticky_edges

x и y списки фиксированных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — предел отображения «прилипает» к границе. Типичный пример — гистограммы, для которых обычно не ожидается отступ у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может их пересечь. Например, если верхний предел данных равен 1.0, верхний предел отображения, рассчитанный простым добавлением отступа, равен 1.2, а фиксированная граница находится на 1.1, фактический верхний предел отображения будет равен 1.1.

Этому атрибуту нельзя присвоить значение; однако списки x и y можно при необходимости изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив RGBA, соответствующий x.

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

Есть один особый случай — обработка изображений, которые уже представлены в формате RGB или RGBA, например, если они были прочитаны из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение имеет размер 3 или 4, массив будет рассматриваться как массив RGB или RGBA, и преобразование выполняться не будет. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызван ValueError. Все значения NaN и замаскированные элементы получат альфа-канал со значением 0. Если размер последнего измерения равен 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если размер последнего измерения равен 4, аргумент alpha игнорируется и не заменяет уже заданное значение альфа-канала. Если размер третьего измерения не равен 3 или 4, будет вызван ValueError.

update(props)[исходный код]

Обновить свойства этого графического объекта из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из другого объекта в этот.

update_scalarmappable()[исходный код]

Обновить цвета на основе массива отображаемых скалярных значений, если он задан.

zorder=0

classmatplotlib.collections.RegularPolyCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[исходный код]

Базовые классы: _CollectionWithSizes

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

Параметры:

numsidesint: Количество сторон многоугольника.
rotationfloat: Угол поворота многоугольника в радианах.
sizestuple of float: Площадь описанной вокруг многоугольника окружности в points^2.
**kwargs: Передаются в Collection.

Примеры

Полный пример см. в разделе Демонстрация Lasso:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    offset_transform=ax.transData,
    )

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая вызывается при изменении любого свойства Artist.

Параметры:

funccallable

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Возвращаемые значения могут присутствовать, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позже этот идентификатор можно использовать для удаления функции обратного вызова с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm, используя текущий массив и изменяя только пределы со значением None

propertyaxes: Экземпляр Axes, в котором находится объект Artist, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x с использованием типа единиц оси x.

Если объект Artist не входит в Axes или ось x не использует единицы измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразует y с использованием типа единиц оси y.

Если объект Artist не входит в Axes или ось y не использует единицы измерения, возвращается само значение y.

draw(renderer)[исходный код]

Рисует Artist (и его дочерние объекты) с помощью указанного рендерера.

Ничего не делает, если объект Artist невидим (Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: (Под)фигура, на которой расположен объект Artist. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Находит объекты Artist.

Рекурсивно находит все экземпляры Artist, содержащиеся в объекте Artist.

Параметры:

match

Критерий фильтрации результатов. Это может быть:

None: возвращает все объекты, содержащиеся в объекте Artist.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только те объекты Artist, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат войдут только объекты Artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включать ли self в список объектов для проверки на соответствие.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы таких чисел в строку, разделённую запятыми и заключённую в квадратные скобки, если только с объектом Artist не связана цветовая шкала; в этом случае скалярные значения форматируются с помощью форматтера цветовой шкалы.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Возвращает функцию фильтрации для использования в agg-фильтре.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Возвращает признак анимации объекта Artist.

get_antialiased()[исходный код]

Возвращает состояние сглаживания при отрисовке.

Возвращает:

массив значений bool

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Возвращает массив значений, сопоставленных с цветами.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[исходный код]

Возвращает стиль окончания линий для коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Возвращает список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Возвращает значения (минимум, максимум), сопоставленные с пределами цветовой карты.

get_clip_box()[исходный код]: Возвращает область отсечения.

get_clip_on()[исходный код]: Возвращает признак использования отсечения для объекта Artist.

get_clip_path()[исходный код]: Возвращает путь отсечения.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

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

Примечание

Подклассы могут переопределить этот метод и возвращать произвольные данные. При этом они должны обеспечить возможность преобразования данных в строковое представление методом format_cursor_data.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит объект Artist.

Параметры:

rootbool, default=False: Если False, возвращает (под)фигуру, на которой расположен этот объект Artist. Если True, возвращает корневую Figure для вложенного дерева SubFigure.

get_fill()[исходный код]: Возвращает признак заливки цветом внутренней области.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает толщину линии штриховки.

get_in_layout()[исходный код]

Возвращает логический флаг, True, указывающий, включён ли объект Artist в вычисления компоновки.

Например, руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого объекта Artist в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли для этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

get_numsides()[исходный код]

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого объекта Artist.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение объекта Artist при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, должна ли растеризоваться графика объекта Artist.

get_rotation()[исходный код]

get_sizes()[исходный код]

Возвращает размеры («площади») элементов коллекции.

Возвращает:

массив: «Площадь» каждого элемента.

get_sketch_params()[исходный код]

Возвращает параметры эскиза для объекта Artist.

Возвращает:

кортеж или None

Кортеж из трёх элементов:

scale: амплитуда колебаний перпендикулярно исходной линии.
length: длина колебаний вдоль линии.
randomness: коэффициент, на который умножается длина при уменьшении или увеличении.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[исходный код]

Аналогично Artist.get_window_extent, но также учитывает обрезку.

Параметры:

rendererподкласс RendererBase, необязательный: рендерер, который будет использоваться для отрисовки рисунков (то есть fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающая рамка (в координатах пикселей рисунка). Возвращает None, если в результате обрезки не осталось области пересечения.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом Artist.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает контур обрезки с применённой неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL — по одному для каждого элемента коллекции.

Для элементов без URL в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer=None)[исходный код]

Возвращает ограничивающую рамку объекта Artist в координатах области отображения.

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

Для включения в расчёт плотной ограничивающей рамки подклассам следует переопределить этот метод. По умолчанию возвращается пустая ограничивающая рамка в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает порядок наложения объекта Artist.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения хотя бы для одной оси.

is_transform_set()[исходный код]

Возвращает, задано ли для объекта Artist преобразование явно.

Это значение равно True после вызова set_transform.

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

свойствоnorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний объект Artist вызовет событие выбора, если курсор mouseevent находится над этим объектом и для него задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь со всеми свойствами объекта Artist.

remove()[исходный код]

Удаляет объект Artist из рисунка, если это возможно.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена на Axes с параметром autolim = True.

Примечание: удаление записи объекта Artist из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору его наблюдателя.

См. также

add_callback

Задать несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтрации, принимающая массив чисел с плавающей точкой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от левого нижнего угла изображения
`alpha`	array-like, float или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	array-like или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` or `ec` or `edgecolors`	цвет или список цветов или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список цветов
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `dashes` or `linestyles` or `ls`	str или tuple или список таких значений
`linewidth` or `linewidths` or `lw`	float или список значений float
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` or `transOffset`	`Transform`
`offsets`	array-like формы (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None, bool, float или callable
`pickradius`	float
`rasterized`	bool
`sizes`	`numpy.ndarray` или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список str или None
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[исходный код]

Задать фильтр agg.

Параметры:

filter_funccallable: Функция фильтрации, принимающая массив чисел с плавающей точкой формы (m, n, depth) и значение dpi и возвращающая массив формы (m, n, depth) и два смещения от левого нижнего угла изображения

set_alpha(alpha)[исходный код]

Задать значение альфа-канала, используемое для смешивания; поддерживается не всеми backend.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Задать, предназначен ли объект Artist для использования в анимации.

Если значение True, объект Artist исключается из обычной отрисовки фигуры. Для объекта Artist необходимо явно вызвать Figure.draw_artist / Axes.draw_artist. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Более быстрая отрисовка с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[исходный код]

Задать состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Задать массив значений на основе объекта array-like A.

Параметры:

Aarray-like or None

Значения, которым сопоставляются цвета.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

csCapStyle or {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать одним позиционным аргументом в виде кортежа (vmin, vmax).

set_clip_box(clipbox)[исходный код]

Задать область отсечения Bbox объекта Artist.

Параметры:

clipboxBboxBase or None: Обычно создаётся на основе TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) — это область отсечения по умолчанию для объекта Artist, добавленного в Axes.

set_clip_on(b)[исходный код]

Задать, будет ли объект Artist использовать отсечение.

Если значение False, объекты Artist будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[исходный код]

Задать обрезающий контур художника.

Параметры:

pathPatch или Path или TransformedPath или None: Обрезающий контур. Если задан объект Path, необходимо также указать transform. Если задано значение None, ранее заданный обрезающий контур удаляется.
transformTransform, необязательный: Используется только если path — это Path; в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — это Rectangle, этот метод задаст область отсечения в виде соответствующего прямоугольника, а обрезающий контур — как None.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[исходный код]

Задать цвет границы и заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

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

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет границы коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет границы коллекции. Если задана последовательность, контуры перебирают её по кругу. Если задано 'face', цвет совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет заливки коллекции. c может быть цветом (все контуры будут одного цвета) или последовательностью цветов; если задана последовательность, контуры будут перебирать её по кругу.

Если c равно 'none', заливки не будет.

Параметры:

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, которому принадлежит художник.

Параметры:

figFigure или SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) художника.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из следующих значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать, тогда будут применены все указанные виды штриховки. Повторение одной и той же буквы увеличивает плотность соответствующего узора.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать толщину линий штриховки.

set_in_layout(in_layout)[исходный код]

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль линии для коллекции.

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

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

(offset, onoffseq),

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

Параметры:

lsstr или tuple или список таких значений: Допустимые значения для отдельных стилей линии: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Задать толщину линий коллекции. lw может быть скаляром или последовательностью; если задана последовательность, контуры будут перебирать её по кругу.

Параметры:

lwfloat или список значений float

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого художника пользовательские контекстные сведения при наведении на него курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массивоподобный объект

set_path_effects(path_effects)[исходный код]

Задать эффекты контура.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(paths)[исходный код]

set_picker(picker)[исходный код]

Задать поведение художника при выборе.

Параметры:

pickerNone или bool или float или вызываемый объект

Допустимы следующие значения:

None: выбор этого художника отключён (по умолчанию).
Логическое значение: если задано True, выбор будет включён, и художник вызовет событие выбора, если событие мыши произошло над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск epsilon в пунктах, и художник вызовет событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых художников, например линий и коллекций контуров, в сгенерированное событие выбора могут добавляться дополнительные данные, например индексы данных, находящихся в пределах epsilon от места выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, которая определяет, затронут ли художник событием мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если событие мыши произошло над художником, верните hit=True; props — это словарь свойств, которые следует добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый при проверке попадания.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно использовать растровую отрисовку (битовую карту) для вывода векторной графики.

Эта настройка игнорируется при выводе в пиксельном формате.

См. также Растеризация векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Задать размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер, задаваемый для каждого элемента коллекции. Это значение представляет собой «площадь» элемента.
dpifloat, по умолчанию: 72: Разрешение холста в точках на дюйм.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эскиза.

Параметры:

scalefloat, необязательный

lengthfloat, необязательный

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательный

Коэффициент, на который умножается длина для её уменьшения или увеличения (по умолчанию 16.0)

set_snap(snap)[исходный код]

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

Привязка выравнивает положения по пиксельной сетке, что позволяет получить более чёткое изображение. Например, если чёрная линия шириной 1 пиксель задана между двумя пикселями, на изображении появится интерполированное значение этой линии в пиксельной сетке — серое значение в обоих соседних пикселях. При привязке линия перемещается к ближайшему целому значению пикселя, поэтому на изображении будет чёрная линия шириной ровно 1 пиксель.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool или None

Допустимые значения:

True: привязывать вершины к ближайшему центру пикселя.
False: не изменять положения вершин.
None: (автоматически) если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование объекта Artist.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL для объекта Artist.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str или None

Примечания

В настоящее время URL реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_visible(b)[исходный код]

Задать видимость объекта Artist.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать zorder объекта Artist. Объекты Artist с меньшими значениями zorder рисуются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли объект Artist «устаревшим» и нуждается ли он в повторной отрисовке, чтобы вывод соответствовал его внутреннему состоянию.

propertysticky_edges

x и y списки фиксированных границ для автомасштабирования.

При автомасштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — предел отображения «прилипает» к границе. Типичный пример — гистограммы, для которых обычно не требуется отступ у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может выйти за них. Например, если верхний предел данных равен 1.0, верхний предел отображения, вычисленный простым добавлением отступа, равен 1.2, но фиксированная граница находится на 1.1, фактический верхний предел отображения будет равен 1.1.

Этому атрибуту нельзя присвоить значение; однако при необходимости списки x и y можно изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив RGBA, соответствующий x.

Особый случай предусмотрен для обработки изображений, которые уже представлены в формате RGB или RGBA, например, если они были прочитаны из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение равно 3 или 4, он будет обработан как массив RGB или RGBA без преобразования. Массив может иметь тип uint8 или содержать числа с плавающей запятой в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Все значения NaN и маскированные элементы получат альфа-значение 0. Если последнее измерение равно 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если последнее измерение равно 4, аргумент alpha игнорируется и не заменяет уже заданное альфа-значение. Если третье измерение не равно 3 или 4, будет вызвано исключение ValueError.

В обоих случаях, если bytes равно False (по умолчанию), массив RGBA будет содержать числа с плавающей запятой в диапазоне 0–1; если оно равно True, возвращаемый массив RGBA будет иметь тип uint8 и значения в диапазоне от 0 до 255.

Если norm равен False, нормализация входных данных не выполняется и предполагается, что они находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого объекта Artist из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства объекта other в текущий объект.

update_scalarmappable()[исходный код]

Обновить цвета на основе массива ScalarMappable, если он задан.

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

zorder=0

classmatplotlib.collections.StarPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[исходный код]

Базовые классы: RegularPolyCollection

Рисует набор правильных звёзд с numsides вершинами.

Параметры:

numsidesint: Количество сторон многоугольника.
rotationfloat: Угол поворота многоугольника в радианах.
sizesкортеж чисел с плавающей точкой: Площадь описанной вокруг многоугольника окружности в точках^2.
**kwargs: Передаются в Collection.

Примеры

Полный пример см. в разделе Демонстрация лассо:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    offset_transform=ax.transData,
    )

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая будет вызываться при изменении любого из свойств объекта Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Её сигнатура должна иметь вид:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения могут быть, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позже этот идентификатор можно использовать для удаления функции с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm по текущему массиву

autoscale_None()[исходный код]: Автоматически масштабирует скалярные пределы экземпляра norm по текущему массиву, изменяя только пределы, равные None

propertyaxes: Экземпляр Axes, в котором находится объект Artist, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x с учётом типа единиц измерения оси x.

Если объект Artist не входит в Axes или у оси x не заданы единицы измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразует y с учётом типа единиц измерения оси y.

Если объект Artist не входит в Axes или у оси y не заданы единицы измерения, возвращается само значение y.

draw(renderer)[исходный код]

Рисует объект Artist (и его дочерние элементы) с помощью заданного средства визуализации.

Ничего не делает, если объект Artist невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: (Под)фигура, к которой относится объект Artist. Для более гибкого управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Находит объекты Artist.

Рекурсивно находит все экземпляры Artist, содержащиеся в объекте Artist.

Параметры:

match

Критерий фильтрации результатов. Может быть:

None: возвращает все объекты, содержащиеся в объекте Artist.
Функцией с сигнатурой def match(artist: Artist) -> bool. В результат войдут только те объекты Artist, для которых функция возвращает True.
Экземпляром класса, например Line2D. В результат войдут только объекты Artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включать ли self в список объектов, проверяемых на соответствие.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах Artist. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать его самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы таких чисел в строку со значениями, разделёнными запятыми и заключёнными в квадратные скобки; если с объектом Artist связана цветовая шкала, скалярные значения форматируются с помощью её форматтера.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Возвращает функцию фильтрации, используемую для фильтра agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Возвращает, включена ли анимация объекта Artist.

get_antialiased()[исходный код]

Возвращает состояние сглаживания при отрисовке.

Возвращает:

массив логических значений

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Возвращает массив значений, сопоставляемых цветам.

Базовый класс ScalarMappable не предполагает какую-либо размерность или форму массива.

get_capstyle()[исходный код]

Возвращает стиль окончания линий коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Возвращает список дочерних объектов Artist данного объекта Artist.

get_clim()[исходный код]: Возвращает значения (минимум, максимум), сопоставленные пределам цветовой карты.

get_clip_box()[исходный код]: Возвращает область отсечения.

get_clip_on()[исходный код]: Возвращает, использует ли объект Artist отсечение.

get_clip_path()[исходный код]: Возвращает путь отсечения.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

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

Примечание

Подклассы могут переопределить метод и возвращать произвольные данные. Однако в этом случае необходимо обеспечить возможность преобразования этих данных в строковое представление с помощью метода format_cursor_data.

Единственный известный на данный момент вариант использования — отображение z-значения объекта AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, к которому относится объект Artist.

Параметры:

rootbool, по умолчанию=False: Если False, возвращает (под)фигуру, к которой относится этот объект Artist. Если True, возвращает корневую Figure во вложенной структуре SubFigure.

get_fill()[исходный код]: Возвращает, закрашена ли внутренняя область.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий штриховой узор.

get_hatch_linewidth()[исходный код]: Возвращает толщину линий штрихового узора.

get_in_layout()[источник]

Возвращает логический флаг, True, указывающий, включён ли художник в вычисления компоновки.

Например, Руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[источник]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[источник]: Возвращает подпись, используемую для этого художника в легенде.

get_linestyle()[источник]

get_linestyles()[источник]: Псевдоним для get_linestyle.

get_linewidth()[источник]

get_linewidths()[источник]: Псевдоним для get_linewidth.

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

get_lw()[источник]: Псевдоним для get_linewidth.

get_mouseover()[источник]: Возвращает, запрашиваются ли для этого художника дополнительные контекстные сведения при наведении на него курсора мыши.

get_numsides()[источник]

get_offset_transform()[источник]: Возвращает экземпляр Transform, используемый для смещения этого художника.

get_offsets()[источник]: Возвращает смещения элементов коллекции.

get_path_effects()[источник]

get_paths()[источник]

get_picker()[источник]

Возвращает поведение художника при выборе.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[источник]

get_rasterized()[источник]: Возвращает, следует ли растрировать художника.

get_rotation()[источник]

get_sizes()[источник]

Возвращает размеры («площади») элементов коллекции.

Возвращает:

массив: «Площадь» каждого элемента.

get_sketch_params()[источник]

Возвращает параметры эскиза для художника.

Возвращает:

кортеж или None

Кортеж из трёх элементов со следующими значениями:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент, определяющий, во сколько раз длина уменьшается или увеличивается.

Возвращает None, если параметры эскиза не заданы.

get_snap()[источник]

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

Подробности см. в set_snap.

get_tightbbox(renderer=None)[источник]

Как Artist.get_window_extent, но с учётом обрезки.

Параметры:

rendererподкласс RendererBase, необязательный: средство визуализации, которое будет использоваться для отрисовки фигур (то есть fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающий прямоугольник (в пиксельных координатах фигуры). Возвращает None, если в результате обрезки пересечение отсутствует.

get_transOffset()[источник]: Псевдоним для get_offset_transform.

get_transform()[источник]: Возвращает экземпляр Transform, используемый этим художником.

get_transformed_clip_path_and_affine()[источник]: Возвращает путь обрезки с применённой нефинальной частью его преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[источник]

get_url()[источник]: Возвращает URL.

get_urls()[источник]

Возвращает список URL, по одному для каждого элемента коллекции.

Для элементов без URL в списке указано значение None. Пример см. в разделе Гиперссылки.

get_visible()[источник]: Возвращает признак видимости.

get_window_extent(renderer=None)[источник]

Возвращает ограничивающую рамку художника в пространстве отображения.

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

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

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

get_zorder()[источник]: Возвращает порядок отрисовки художника.

have_units()[источник]: Возвращает, заданы ли единицы измерения для какой-либо оси.

is_transform_set()[источник]

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

Значение равно True после вызова set_transform.

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

свойствоnorm

pchanged()[источник]

Вызывает все зарегистрированные обратные вызовы.

Эта функция запускается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[источник]

Обрабатывает событие выбора.

Каждый дочерний художник вызовет событие выбора, если mouseevent происходит над художником и для него задано свойство picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[источник]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[источник]: Возвращает словарь со всеми свойствами художника.

remove()[источник]

Удаляет художника из фигуры, если это возможно.

Результат не будет виден, пока фигура не будет перерисована, например с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить пределы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи художника из легенды не поддерживается.

remove_callback(oid)[источник]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

Задать несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтрации, принимающая массив float формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	array-like или float, или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	array-like или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform), или None
`cmap`	`Colormap` или str, или None
`color`	цвет или список кортежей RGBA
`edgecolor` or `ec` or `edgecolors`	цвет или список значений цвета, или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список значений цвета
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `dashes` or `linestyles` or `ls`	str, кортеж или список таких значений
`linewidth` or `linewidths` or `lw`	float или список значений float
`mouseover`	bool
`norm`	`Normalize` или str, или None
`offset_transform` or `transOffset`	`Transform`
`offsets`	array-like формы (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None, bool, float или вызываемый объект
`pickradius`	float
`rasterized`	bool
`sizes`	`numpy.ndarray` или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[источник]

Задать фильтр agg.

Параметры:

filter_funccallable: Функция фильтрации, принимающая массив float формы (m, n, depth) и значение dpi и возвращающая массив формы (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[источник]

Задать значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[источник]

Задать, предназначен ли объект Artist для использования в анимации.

Если значение равно True, объект Artist исключается из обычной отрисовки фигуры. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для объекта Artist. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Ускорение отрисовки с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[источник]

Задать состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

set_antialiaseds(aa)[источник]: Псевдоним для set_antialiased.

set_array(A)[источник]

Задать массив значений из объекта array-like A.

Параметры:

Aarray-like or None

Значения, преобразуемые в цвета.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива значений A.

set_capstyle(cs)[источник]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

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

set_clim(vmin=None, vmax=None)[источник]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать одним позиционным аргументом в виде кортежа (vmin, vmax).

set_clip_box(clipbox)[источник]

Задать область отсечения Bbox объекта Artist.

Параметры:

clipboxBboxBase или None: Обычно создаётся из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) является областью отсечения по умолчанию для объекта Artist, добавленного в Axes.

set_clip_on(b)[источник]

Задать, использует ли объект Artist отсечение.

Параметры:

bbool

set_clip_path(path, transform=None)[источник]

Задать контур обрезки объекта-художника.

Параметры:

pathPatch или Path или TransformedPath или None: Контур обрезки. Если задан объект Path, необходимо также задать transform. Если задано None, ранее установленный контур обрезки удаляется.
transformTransform, необязательно: Используется, только если path — это Path; в этом случае заданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — это Rectangle, этот метод задаст область обрезки в виде соответствующего прямоугольника, а контур обрезки задаст равным None.

set_cmap(cmap)[источник]

Задать цветовую карту для данных о яркости.

Параметры:

cmapColormap или str или None

set_color(c)[источник]

Задать цвет края и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для задания цвета края или заливки по отдельности.

set_dashes(ls)[источник]: Псевдоним для set_linestyle.

set_ec(c)[источник]: Псевдоним для set_edgecolor.

set_edgecolor(c)[источник]

Задать цвет(а) края коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет(а) края коллекции. Если задана последовательность, цвета участков циклически выбираются из неё. Если задано 'face', используется цвет заливки.

set_edgecolors(c)[источник]: Псевдоним для set_edgecolor.

set_facecolor(c)[источник]

Задать цвет(а) заливки коллекции. c может быть цветом (все участки будут одного цвета) или последовательностью цветов; если задана последовательность, цвета участков будут циклически выбираться из неё.

Если c равно 'none', участок не будет залит.

Параметры:

cцвет или список цветов

set_facecolors(c)[источник]: Псевдоним для set_facecolor.

set_fc(c)[источник]: Псевдоним для set_facecolor.

set_figure(fig)[источник]

Задать экземпляр Figure или SubFigure, которому принадлежит объект-художник.

Параметры:

figFigure или SubFigure

set_gid(gid)[источник]

Задать идентификатор (группы) объекта-художника.

Параметры:

gidstr

set_hatch(hatch)[источник]

Задать узор штриховки

hatch может принимать одно из значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать — в этом случае применяются все указанные узоры штриховки. Повторение одной и той же буквы увеличивает плотность штриховки соответствующего узора.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно задать только для коллекции целиком, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[источник]: Задать ширину линии штриховки.

set_in_layout(in_layout)[источник]

Задать, следует ли учитывать объект-художник при расчётах компоновки, например в руководстве по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[источник]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[источник]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[источник]

Задать стиль(и) линий для коллекции.

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

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

(offset, onoffseq),

где onoffseq — кортеж чётной длины с чередованием длины штрихов и пробелов в точках.

Параметры:

lsstr или tuple или список таких значений: Допустимые значения для отдельных стилей линий: {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[источник]: Псевдоним для set_linestyle.

set_linewidth(lw)[источник]

Задать ширину(ы) линий коллекции. lw может быть числом или последовательностью; если задана последовательность, ширины линий участков будут циклически выбираться из неё

Параметры:

lwfloat или список float

set_linewidths(lw)[источник]: Псевдоним для set_linewidth.

set_ls(ls)[источник]: Псевдоним для set_linestyle.

set_lw(lw)[источник]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[источник]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[источник]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

set_offset_transform(offset_transform)[источник]

Задать преобразование смещения объекта-художника.

Параметры:

offset_transformTransform

set_offsets(offsets)[источник]

Задать смещения элементов коллекции.

Параметры:

offsetsобъект, подобный массиву формы (N, 2) или (2,)

set_path_effects(path_effects)[источник]

Задать эффекты контура.

Параметры:

path_effectsсписок объектов AbstractPathEffect

set_paths(paths)[источник]

set_picker(picker)[источник]

Определить поведение объекта-художника при выборе щелчком.

Параметры:

pickerNone или bool или float или вызываемый объект

Допустимы следующие значения:

None: выбор этого объекта-художника отключён (по умолчанию).
Логическое значение: если задано True, выбор будет включён, и объект-художник вызовет событие выбора, если указатель мыши находится над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допустимая погрешность в точках; объект-художник вызовет событие, если его данные находятся от события мыши на расстоянии не более этой погрешности. Для некоторых объектов-художников, например линий и коллекций участков, в созданное событие выбора могут передаваться дополнительные данные, например индексы данных, находящихся в пределах погрешности от точки выбора.
Функция: если picker является вызываемым объектом, это функция, предоставленная пользователем и определяющая, попал ли указатель мыши на объект-художник:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если указатель мыши находится над объектом-художником, верните hit=True; props — это словарь свойств, которые необходимо добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

Задать радиус выбора, используемый для проверки вхождения.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно включить растровую (битовую) отрисовку для вывода векторной графики.

Растровая отрисовка поддерживается не всеми объектами Artist. Если попытаться включить её для объекта Artist, который её не поддерживает, команда не подействует и будет выдано предупреждение.

Этот параметр игнорируется при выводе в пиксельный формат.

См. также раздел Растрирование векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Задать размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер, задаваемый для каждого элемента коллекции. Значение соответствует «площади» элемента.
dpifloat, по умолчанию: 72: Разрешение холста в dpi.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эскиза.

Параметры:

scalefloat, необязательный

lengthfloat, необязательный

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательный

Коэффициент, на который умножается длина, чтобы уменьшить или увеличить её (по умолчанию 16.0)

set_snap(snap)[исходный код]

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

Привязка выравнивает позиции по пиксельной сетке, благодаря чему изображения становятся чётче. Например, если чёрная линия шириной 1px задана в позиции между двумя пикселями, в результате изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть оба соседних пикселя будут серыми. При привязке линия перемещается к ближайшему целому значению пикселя, поэтому в итоговом изображении будет чёрная линия шириной ровно 1px.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool или None

Возможные значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять положения вершин.
None: (автоматически) если путь содержит только прямолинейные отрезки, округлить координаты до ближайшего центра пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование объекта Artist.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL-адрес для объекта Artist.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlsсписок str или None

Примечания

В настоящее время URL-адреса реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_visible(b)[исходный код]

Задать видимость объекта Artist.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать zorder для объекта Artist. Объекты Artist с меньшими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли объект Artist «устаревшим» и нуждается ли он в повторной отрисовке, чтобы вывод соответствовал внутреннему состоянию объекта Artist.

propertysticky_edges

Списки фиксированных границ x и y для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, отступ не добавляется — предел области просмотра «фиксируется» на этой границе. Типичный пример — гистограммы, для которых обычно не ожидается отступа у нижней границы (0).

Кроме того, расширение отступа «упирается» в фиксированные границы и не может пересечь их. Например, если верхний предел данных равен 1.0, верхний предел области просмотра, вычисленный простым применением отступа, равен 1.2, а фиксированная граница находится на отметке 1.1, фактический верхний предел области просмотра будет равен 1.1.

Этому атрибуту нельзя присвоить значение, однако списки x и y можно при необходимости изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Вернуть нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скалярных значений; будет возвращён соответствующий массив ndarray значений RGBA на основе нормы и цветовой карты, заданных для этого Colorizer.

Особый случай — обработка изображений, уже представленных в формате RGB или RGBA, например прочитанных из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение равно 3 или 4, он будет рассматриваться как массив RGB или RGBA, и преобразование выполняться не будет. Массив может иметь тип uint8 либо содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Все значения NaN и замаскированные элементы получат альфа-значение 0. Если последнее измерение равно 3, аргумент alpha (по умолчанию равный 1) будет использован для заполнения значения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется и не заменяет уже имеющееся альфа-значение. Если третье измерение не равно 3 или 4, будет вызвано исключение ValueError.

Если norm равно False, входные данные не нормализуются и предполагается, что они находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого объекта Artist из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Скопировать свойства из другого объекта в текущий.

update_scalarmappable()[исходный код]

Обновить цвета на основе массива скалярного отображения, если он задан.

Назначить цвета рёбрам и граням на основе массива и/или цветов, заданных напрямую, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.TriMesh(triangulation, **kwargs)[исходный код]

Базовые классы: Collection

Класс для эффективного отображения треугольной сетки с использованием затенения Гуро.

Треугольная сетка — это объект Triangulation.

Параметры:

edgecolorsцвет или список цветов, по умолчанию: rcParams["patch.edgecolor"] (значение по умолчанию: 'black')

Цвет края для каждого участка коллекции. Специальное значение 'face' можно передать, чтобы цвет края совпадал с цветом заливки.

facecolorsцвет или список цветов, по умолчанию: rcParams["patch.facecolor"] (значение по умолчанию: 'C0')

Цвет заливки для каждого участка коллекции.

Толщина линии для каждого участка коллекции.

linestylesстрока, кортеж или список таких значений, по умолчанию: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь следующий вид:

(offset, onoffseq),

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

capstyleподобный CapStyle, по умолчанию: 'butt'

Стиль окончания линий для всех контуров коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.

joinstyleподобный JoinStyle, по умолчанию: 'round'

Стиль соединения линий для всех контуров коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.

Следует ли отображать каждый участок коллекции со сглаживанием.

offsets(число с плавающей точкой, число с плавающей точкой) или список таких значений, по умолчанию: (0, 0)

Вектор, на который смещается каждый участок после отрисовки (по умолчанию смещения нет). Смещение выполняется в экранных координатах (пикселях), то есть после применения преобразования Artist.

offset_transformTransform, по умолчанию: IdentityTransform

Единое преобразование, применяемое к каждому вектору offsets перед его использованием.

cmap, norm

Параметры нормализации данных и сопоставления цветов. Подробное описание см. в ScalarMappable.

hatchстрока, необязательный параметр

Штриховка для залитых контуров, если она нужна. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Значение каждого типа штриховки см. в разделе Справочник по стилям штриховки.

pickradiusчисло с плавающей точкой, по умолчанию: 5.0

Если pickradius <= 0, то Collection.contains вернёт True, если тестовая точка находится внутри одного из многоугольников, образованных контрольными точками Path в коллекции. Если же значение больше 0, проверяется, находится ли тестовая точка внутри обводки шириной 2*pickradius вдоль любого из Path в коллекции.

urlsсписок строк, по умолчанию: None

URL для каждого участка, на который можно перейти после отрисовки. В настоящее время работает только в SVG-бэкенде. Примеры см. в разделе Гиперссылки.

zorderчисло с плавающей точкой, по умолчанию: 1

Порядок отрисовки, общий для всех Patch в коллекции. Значения по умолчанию и примеры см. в разделе Демонстрация zorder.

**kwargs

Остальные именованные аргументы используются для задания свойств как Collection.set_{key}(val) для каждой пары ключ—значение в kwargs.

add_callback(func)[исходный код]

Добавить функцию обратного вызова, которая будет вызываться при изменении любого свойства Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения могут быть, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Позже его можно использовать для удаления функции с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра norm, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабировать скалярные пределы экземпляра norm, используя текущий массив и изменяя только пределы со значением None

propertyaxes: Экземпляр Axes, в котором находится artist, или None.

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

propertycmap

propertycolorbar: Последняя цветовая шкала, связанная с этим объектом. Может иметь значение None

propertycolorizer

contains(mouseevent)[исходный код]

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

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

staticconvert_mesh_to_paths(tri)[исходный код]

Преобразовать заданную сетку в последовательность объектов Path.

Эта функция в первую очередь предназначена для разработчиков бэкендов, не поддерживающих сетки напрямую.

convert_xunits(x)[исходный код]

Преобразовать x в соответствии с типом единиц оси x.

Если artist не принадлежит Axes или ось x не имеет единиц измерения, возвращается сам x.

convert_yunits(y)[исходный код]

Преобразовать y в соответствии с типом единиц оси y.

Если artist не принадлежит Axes или ось y не имеет единиц измерения, возвращается сам y.

draw(renderer)[исходный код]

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

Ничего не делает, если artist невидим (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

propertyfigure: Figure или SubFigure, к которой относится artist. Для более точного управления используйте метод get_figure.

findobj(match=None, include_self=True)[исходный код]

Найти объекты artist.

Рекурсивно найти все экземпляры Artist, содержащиеся в artist.

Параметры:

match

Критерий фильтрации результатов. Это может быть:

None: вернуть все объекты, содержащиеся в artist.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат войдут только те artist, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат войдут только artist этого класса или его подклассов (проверка isinstance).

include_selfлогическое значение

Включить self в список объектов для проверки на соответствие.

Возвращает:

список объектов Artist

format_cursor_data(data)[исходный код]

Вернуть строковое представление data.

Примечание

Предполагается, что этот метод переопределяется в подклассах artist. Как конечный пользователь Matplotlib вы, скорее всего, не будете вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы таких чисел в строку, разделённую запятыми и заключённую в квадратные скобки. Если с artist связана цветовая шкала, скалярные значения форматируются с помощью её форматировщика.

См. также

get_cursor_data

get_aa()[исходный код]: Псевдоним для get_antialiased.

get_agg_filter()[исходный код]: Вернуть функцию фильтрации для фильтра agg.

get_alpha()[исходный код]: Вернуть значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.

get_animated()[исходный код]: Вернуть признак анимированности artist.

get_antialiased()[исходный код]

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

Возвращает:

массив логических значений

get_antialiaseds()[исходный код]: Псевдоним для get_antialiased.

get_array()[исходный код]

Вернуть массив значений, сопоставляемых с цветами.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[исходный код]

Вернуть стиль окончания линий коллекции (для всех её элементов).

Возвращает:

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

get_children()[исходный код]: Вернуть список дочерних объектов Artist этого объекта Artist.

get_clim()[исходный код]: Вернуть значения (минимум, максимум), сопоставляемые с пределами цветовой карты.

get_clip_box()[исходный код]: Вернуть ограничивающий прямоугольник обрезки.

get_clip_on()[исходный код]: Вернуть признак использования обрезки для artist.

get_clip_path()[исходный код]: Вернуть контур обрезки.

get_cmap()[исходный код]: Вернуть экземпляр Colormap.

get_cursor_data(event)[исходный код]

Вернуть данные курсора для заданного события.

Примечание

Artist могут использовать данные курсора, чтобы предоставлять дополнительную контекстную информацию для заданного события. Реализация по умолчанию просто возвращает None.

Подклассы могут переопределить метод и возвращать произвольные данные. Однако при этом необходимо убедиться, что format_cursor_data может преобразовать эти данные в строковое представление.

В настоящее время этот метод используется только для отображения z-значения AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure(root=False)[исходный код]

Возвращает экземпляр Figure или SubFigure, которому принадлежит этот объект Artist.

Параметры:

rootbool, по умолчанию False: Если False, возвращает Figure или SubFigure, на котором находится этот объект Artist. Если True, возвращает корневой Figure для вложенного дерева SubFigure.

get_fill()[исходный код]: Возвращает, закрашена ли грань.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_hatch_linewidth()[исходный код]: Возвращает ширину линий штриховки.

get_in_layout()[исходный код]

Возвращает логический флаг: True, если объект Artist включён в расчёты компоновки.

Например, руководство по constrained layout, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

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

get_label()[исходный код]: Возвращает метку, используемую для этого объекта Artist в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_mouseover()[исходный код]: Возвращает, запрашиваются ли для этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого объекта Artist.

get_offsets()[исходный код]: Возвращает смещения элементов коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора объекта Artist.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растрировать объект Artist.

get_sketch_params()[исходный код]

Возвращает параметры эскиза для объекта Artist.

Возвращает:

tuple или None

Кортеж из трёх элементов:

scale: амплитуда колебаний перпендикулярно исходной линии.
length: длина колебаний вдоль линии.
randomness: коэффициент, на который умножается длина при уменьшении или увеличении.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

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

Подробнее см. в описании set_snap.

get_tightbbox(renderer=None)[исходный код]

Подобно Artist.get_window_extent, но учитывает обрезку.

Параметры:

rendererподкласс RendererBase, необязательный: рендерер, который будет использоваться для рисования фигур (то есть fig.canvas.get_renderer())

Возвращает:

Bbox или None: Ограничивающий прямоугольник (в пиксельных координатах фигуры). Возвращает None, если после обрезки пересечений нет.

get_transOffset()[исходный код]: Псевдоним для get_offset_transform.

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом Artist.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой к нему неаффинной частью преобразования и оставшуюся аффинную часть преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Для элементов без URL список содержит None. Пример см. в разделе Гиперссылки.

get_visible()[исходный код]: Возвращает признак видимости.

get_window_extent(renderer=None)[исходный код]

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

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

Для включения в расчёт «плотной» ограничивающей рамки подклассы должны переопределить этот метод. По умолчанию возвращается пустая ограничивающая рамка в точке 0, 0.

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

get_zorder()[исходный код]: Возвращает порядок отрисовки объекта Artist.

have_units()[исходный код]: Возвращает, заданы ли единицы измерения хотя бы для одной оси.

is_transform_set()[исходный код]

Возвращает, задано ли для объекта Artist преобразование явно.

Значение становится True после вызова set_transform.

propertymouseover: Возвращает, запрашиваются ли для этого объекта Artist пользовательские контекстные сведения при наведении на него курсора мыши.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция запускается внутри программы при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора объекта.

Каждый дочерний объект Artist вызывает событие выбора, если mouseevent происходит над этим объектом и для него задан параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[исходный код]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[исходный код]: Возвращает словарь всех свойств объекта Artist.

remove()[исходный код]

Удаляет объект Artist из фигуры, если это возможно.

Изменение станет видимым только после перерисовки фигуры, например с помощью FigureCanvasBase.draw_idle. При необходимости вызовите relim, чтобы обновить границы Axes.

Примечание: relim не учитывает коллекции, даже если коллекция была добавлена в Axes с параметром autolim = True.

Примечание: удаление записи объекта Artist из легенды не поддерживается.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

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

Установить несколько свойств одновременно.

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

Свойство	Описание
`agg_filter`	функция фильтрации, принимающая массив чисел с плавающей точкой размера (m, n, 3) и значение dpi и возвращающая массив размера (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	array-like или float или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	array-like или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` or `ec` or `edgecolors`	цвет или список цветов или 'face'
`facecolor` or `facecolors` or `fc`	цвет или список цветов
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` or `dashes` or `linestyles` or `ls`	str или tuple или список таких значений
`linewidth` or `linewidths` or `lw`	float или список значений float
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` or `transOffset`	`Transform`
`offsets`	array-like размера (N, 2) или (2,)
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или callable
`pickradius`	float
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список str или None
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funccallable: Функция фильтрации, принимающая массив чисел с плавающей точкой размера (m, n, depth) и значение dpi и возвращающая массив размера (m, n, depth) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[source]

Установить значение alpha, используемое для смешивания; поддерживается не всеми бэкендами.

Параметры:

alphaarray-like or float or None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[source]

Задать, предназначен ли объект-художник для использования в анимации.

Если значение True, объект-художник исключается из обычной отрисовки рисунка. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для объекта-художника. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Ускорение отрисовки с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[source]

Задать состояние сглаживания при отрисовке.

Параметры:

aabool or list of bools

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

set_array(A)[source]

Задать массив значений из объекта array-like A.

Параметры:

Aarray-like or None

Значения, сопоставляемые цветам.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[source]

Задать CapStyle для коллекции (для всех её элементов).

Параметры:

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

set_clim(vmin=None, vmax=None)[source]

Задать пределы нормализации для масштабирования изображения.

Параметры:

vmin, vmaxfloat

Пределы.

Для скалярных данных пределы также можно передать в виде кортежа (vmin, vmax) одним позиционным аргументом.

set_clip_box(clipbox)[source]

Задать область отсечения Bbox объекта-художника.

Параметры:

clipboxBboxBase или None: Обычно создаётся из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) — область отсечения по умолчанию для объекта-художника, добавленного в Axes.

set_clip_on(b)[source]

Задать, используется ли для объекта-художника отсечение.

Если значение False, объекты-художники будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[source]

Задать путь отсечения объекта-художника.

Параметры:

pathPatch или Path или TransformedPath или None: Путь отсечения. Если передан объект Path, необходимо также указать transform. Если задано значение None, ранее установленный путь отсечения удаляется.
transformTransform, optional: Используется только в том случае, если path — это Path; в этом случае переданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — это Rectangle, этот метод установит область отсечения в соответствующий прямоугольник, а путь отсечения — в None.

set_cmap(cmap)[исходный код]

Задать цветовую карту для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[исходный код]

Задать цвет границы и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

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

set_dashes(ls)[исходный код]: Синоним set_linestyle.

set_ec(c)[исходный код]: Синоним set_edgecolor.

set_edgecolor(c)[исходный код]

Задать цвет границы (или цвета границ) коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет границы (или цвета границ) коллекции. Если задана последовательность, цвета для контуров выбираются из неё циклически. Если задано 'face', цвет границы совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Синоним set_edgecolor.

set_facecolor(c)[исходный код]

Задать цвет заливки (или цвета заливки) коллекции. c может быть одним цветом (все контуры имеют одинаковый цвет) или последовательностью цветов; если задана последовательность, цвета для контуров выбираются из неё циклически.

Если c равно 'none', контур не будет залит.

Параметры:

cцвет или список цветов

set_facecolors(c)[исходный код]: Синоним set_facecolor.

set_fc(c)[исходный код]: Синоним set_facecolor.

set_figure(fig)[исходный код]

Задать экземпляр Figure или SubFigure, которому принадлежит объект Artist.

Параметры:

figFigure или SubFigure

set_gid(gid)[исходный код]

Задать идентификатор (группы) объекта Artist.

Параметры:

gidstr

set_hatch(hatch)[исходный код]

Задать узор штриховки

hatch может принимать одно из значений:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать: в этом случае будут применены все заданные узоры штриховки. Повторение одной и той же буквы увеличивает плотность штриховки соответствующего узора.

В отличие от других свойств, таких как толщина линий и цвета, узор штриховки можно задать только для всей коллекции целиком, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_hatch_linewidth(lw)[исходный код]: Задать толщину линий штриховки.

set_in_layout(in_layout)[исходный код]

Задать, следует ли учитывать объект Artist при расчётах компоновки, например, в руководстве по constrained layout, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[исходный код]

Задать JoinStyle для коллекции (для всех её элементов).

Параметры:

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

set_label(s)[исходный код]

Задать метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку вызовом str.

set_linestyle(ls)[исходный код]

Задать стиль линии (или стили линий) для коллекции.

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

Кроме того, можно передать кортеж параметров штриховки следующего вида:

(offset, onoffseq),

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

Параметры:

lsstr или tuple или список таких значений: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Синоним set_linestyle.

set_linewidth(lw)[исходный код]

Задать толщину линии (или толщины линий) для коллекции. lw может быть скалярным значением или последовательностью; если задана последовательность, значения для контуров выбираются из неё циклически

Параметры:

lwfloat или список значений float

set_linewidths(lw)[исходный код]: Синоним set_linewidth.

set_ls(ls)[исходный код]: Синоним set_linestyle.

set_lw(lw)[исходный код]: Синоним set_linewidth.

set_mouseover(mouseover)[исходный код]

Задать, следует ли запрашивать у этого объекта дополнительные контекстные сведения при наведении на него курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[исходный код]

Задать экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[исходный код]

Задать преобразование смещения объекта Artist.

Параметры:

offset_transformTransform

set_offsets(offsets)[исходный код]

Задать смещения для коллекции.

Параметры:

offsetsмассивоподобный объект формы (N, 2) или (2,)

set_path_effects(path_effects)[исходный код]

Задать эффекты контура.

Параметры:

path_effectsсписок объектов AbstractPathEffect

set_paths()[исходный код]

set_picker(picker)[исходный код]

Задать поведение объекта Artist при выборе.

Параметры:

pickerNone, bool, float или вызываемый объект

Может принимать одно из следующих значений:

None: выбор для этого объекта Artist отключён (по умолчанию).
Логическое значение: если задано True, выбор будет включён, и объект Artist сгенерирует событие выбора, если указатель мыши окажется над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск epsilon в пунктах, и объект Artist сгенерирует событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых объектов Artist, например линий и коллекций контуров, в событие выбора могут быть добавлены дополнительные данные, например индексы данных, находящихся в пределах epsilon от точки выбора.
Функция: если picker является вызываемым объектом, это предоставленная пользователем функция, определяющая, попал ли указатель мыши на объект Artist:
```
hit, props = picker(artist, mouseevent)
```
для проверки попадания. Если указатель мыши находится над объектом Artist, верните hit=True, а props задайте как словарь свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[исходный код]

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

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно включить растровую (битовую) отрисовку для вывода векторной графики.

Этот параметр игнорируется при выводе на основе пикселей.

См. также Растрирование векторной графики.

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Задать параметры эскизного эффекта.

Параметры:

scalefloat, необязательный

Амплитуда отклонения от исходной линии по перпендикуляру, в пикселях. Если scale равен None или не задан, фильтр эскизного эффекта не будет применён.

lengthfloat, необязательный

Длина отклонения вдоль линии, в пикселях (по умолчанию 128.0)

randomnessfloat, необязательный

Коэффициент, на который умножается длина (по умолчанию 16.0)

Бэкенд PGF использует этот аргумент как начальное значение генератора случайных чисел, а не так, как описано выше. При одинаковом начальном значении получается одинаковая случайная форма.

set_snap(snap)[исходный код]

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

Привязка выравнивает позиции по пиксельной сетке, что позволяет получать более чёткие изображения. Например, если чёрная линия шириной 1 пиксель задана между двумя пикселями, в результирующем изображении значение этой линии будет интерполировано по пиксельной сетке, поэтому на обеих соседних позициях пикселей получится серый цвет. При привязке линия перемещается к ближайшему целочисленному значению пикселя, поэтому в результирующем изображении будет чёрная линия шириной ровно 1 пиксель.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool или None

Возможные значения:

True: Привязать вершины к центру ближайшего пикселя.
False: Не изменять положения вершин.
None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до центра ближайшего пикселя.

set_transOffset(offset_transform)[исходный код]: Псевдоним для set_offset_transform.

set_transform(t)[исходный код]

Задать преобразование объекта.

Параметры:

tTransform

set_url(url)[исходный код]

Задать URL объекта.

Параметры:

urlstr

set_urls(urls)[исходный код]

Параметры:

urlslist of str or None

Примечания

В настоящее время URL-адреса реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_visible(b)[исходный код]

Задать видимость объекта.

Параметры:

bbool

set_zorder(level)[исходный код]

Задать zorder объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры:

levelfloat

propertystale: Указывает, является ли объект «устаревшим» и требуется ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию объекта.

propertysticky_edges

x и y списки фиксированных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, поле не добавляется — предел отображения «прилипает» к границе. Типичный пример — гистограммы, где обычно не ожидается поля у нижней границы (0) гистограммы.

Кроме того, при расширении поля происходит «упор» в фиксированные границы, и выйти за них нельзя. Например, если верхний предел данных равен 1.0, верхний предел отображения, вычисленный простым добавлением поля, равен 1.2, но фиксированная граница находится на уровне 1.1, фактический верхний предел отображения будет равен 1.1.

Этому атрибуту нельзя присвоить значение; однако при необходимости списки x и y можно изменять на месте.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Вернуть нормализованный массив RGBA, соответствующий x.

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

Предусмотрен особый случай для обработки изображений, уже представленных в формате RGB или RGBA, например, загруженных из файла изображения. Если x — это ndarray с тремя измерениями, а последнее измерение имеет размер 3 или 4, он будет интерпретирован как массив RGB или RGBA, и преобразование выполняться не будет. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Значения NaN и маскированные элементы получат альфа-значение 0. Если размер последнего измерения равен 3, для заполнения прозрачности будет использоваться аргумент alpha (по умолчанию равный 1). Если размер последнего измерения равен 4, аргумент alpha игнорируется и не заменяет уже имеющееся альфа-значение. Если размер третьего измерения отличается от 3 или 4, будет вызвано исключение ValueError.

В обоих случаях, если bytes имеет значение False (по умолчанию), массив RGBA будет содержать числа с плавающей точкой в диапазоне 0–1; если значение равно True, возвращённый массив RGBA будет иметь тип uint8 и значения в диапазоне от 0 до 255.

Если norm имеет значение False, входные данные не нормализуются; предполагается, что они находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого объекта из словаря props.

Параметры:

propsdict

update_from(other)[исходный код]: Копировать свойства из другого объекта в текущий.

update_scalarmappable()[исходный код]

Обновить цвета на основе массива скалярного отображения, если он задан.

Назначить цвета рёбрам и граням в соответствии с массивом и/или цветами, заданными напрямую, если применимо.

zorder=0