matplotlib.collections

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

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

classmatplotlib.collections.AsteriskPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[source]

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

Рисует набор правильных звёзд с numsides лучами.

Параметры:

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

Примеры

См. Lasso Demo для полного примера:

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)[source]

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

Параметры:

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

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

def func(artist: Artist) -> Any

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

Возвращает:

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

См. также

remove_callback

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

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

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

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

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

contains(mouseevent)[source]

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

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

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

findobj(match=None, include_self=True)[source]

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

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

Параметры:

match

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

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

include_selfbool

Включить self в список для проверки на соответствие.

Возвращает:

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

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

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

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

get_animated()[source]: Возвращает, анимируется ли объект.

get_antialiased()[source]

Получает состояние сглаживания для рендеринга.

Возвращает:

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

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

get_array()[source]

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

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

get_capstyle()[source]

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

Возвращает:

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

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

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

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

get_clip_on()[source]: Возвращает, использует ли объект обрезку.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

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

Примечание

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

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

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

Параметры:

eventMouseEvent

См. также

format_cursor_data

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

get_datalim(transData)[source]

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

get_edgecolor()[source]

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

get_facecolor()[source]

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

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

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[source]: Возвращает значение, указывающее, закрашен ли элемент.

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

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

get_in_layout()[source]

Возвращает булево значение, True если элемент включён в расчёт макета.

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

get_joinstyle()[source]

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

Возвращает:

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

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

get_linestyle()[source]

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

get_linewidth()[source]

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

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

END_OF_DOCUMENT_MARKER

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

get_mouseover()[source]: Возвращает, запрашивается ли у этого элемента информация о контексте при перемещении курсора мыши над ним.

get_numsides()[source]

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

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

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

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

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, следует ли растрировать элемент.

get_rotation()[source]

get_sizes()[source]

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

Возвращает:

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

get_sketch_params()[source]

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

Возвращает:

кортеж или None

Кортеж из 3 элементов с указанными параметрами:

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

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

get_snap()[source]

Возвращает значение параметра привязки.

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

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры:

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

Возвращает:

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

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

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

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

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

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

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

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

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

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

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

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

get_zorder()[source]: Возвращает z-порядок объекта.

have_units()[source]: Возвращает, установлены ли единицы на любой оси.

is_transform_set()[source]

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

Это True после вызова set_transform.

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

propertynorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, является ли объект выбираемым.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

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

remove()[source]

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

Эффект будет виден только после перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это необходимо.

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

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

remove_callback(oid)[source]

Удалить обработчик на основе его идентификатора наблюдателя.

См. также

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>, 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>)[source]

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

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

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

zorder

float

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

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

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

set_alpha(alpha)[source]

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

Параметры:

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

set_animated(b)[source]

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

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

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

Параметры:

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, 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, необязательно: Используется только если path является объектом Path. В этом случае заданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

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

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

set_cmap(cmap)[source]

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

Параметры:

cmapColormap или str или None

set_color(c)[source]

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

Параметры:

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

См. также

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

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

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

set_edgecolor(c)[source]

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

Параметры:

cцвет или список цветов или 'face': Цвет(ы) границы коллекции. Если последовательность, фигуры циклически перебирают ее. Если 'face', соответствуют цвету заливки.

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

set_facecolor(c)[source]

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

Если c равно 'none', фигура не будет закрашена.

Параметры:

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

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

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

set_figure(fig)[source]

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

Параметры:

figFigure

set_gid(gid)[source]

Установите идентификатор (группы) для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установите узор штриховки.

hatch может быть одним из:

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

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

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

Параметры:

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

set_in_layout(in_layout)[source]

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

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установите стиль соединения JoinStyle для набора (для всех его элементов).

Параметры:

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

set_label(s)[source]

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

Параметры:

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

set_linestyle(ls)[source]

Установите стиль(и) линии для набора.

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

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

(offset, onoffseq),

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

Параметры:

lsстрока или кортеж или список кортежей: Допустимые значения индивидуальных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность вкл/выкл)}. Смотрите Line2D.set_linestyle для полного описания.

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

set_linewidth(lw)[source]

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

Параметры:

lwчисловое или список чисел

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

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

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

set_mouseover(mouseover)[source]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

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

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[source]

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

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

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

Параметры:

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

set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(paths)[source]

set_picker(picker)[source]

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

Параметры:

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

Это может быть одно из следующих:

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

set_pickradius(pickradius)[source]

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

Параметры:

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

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

Параметры:

sizesnumpy.ndarray или None: Размер для установки для каждого элемента коллекции. Значение - это 'площадь' элемента.
dpifloat, по умолчанию: 72: Точек на дюйм холста.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:

scalefloat, необязательно

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

lengthfloat, необязательно

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

randomnessfloat, необязательно

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

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

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]

Параметры:

urlsсписок str или None

Примечания

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

set_visible(b)[source]

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

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок элемента. Элементы с более низкими значениями 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 — это одномерная или двумерная последовательность скаляров, и соответствующий ndarray массив значений RGBA будет возвращен на основе нормы и цветовой карты, установленных для этого ScalarMappable.

Есть один специальный случай для обработки изображений, которые уже находятся в формате RGB или RGBA, например, прочитанных из файла изображения. Если x — это ndarray с 3 измерениями, и последнее измерение равно 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]

Обновить цвета из массива scalar mappable, если он есть.

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

zorder=0

classmatplotlib.collections.CircleCollection(sizes, **kwargs)[source]

Bases: _CollectionWithSizes

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

Параметры:

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

add_callback(func)[source]

Параметры:

funcвызываемая функция

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

def func(artist: Artist) -> Any

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

Возвращает:

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

См. также

remove_callback

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

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

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

changed()[source]: Вызывайте эту функцию всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей обратных вызовов о сигнале 'changed'.

colorbar: Последняя связанная с этим ScalarMappable цветовая шкала. Может быть None.

contains(mouseevent)[source]

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

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

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

findobj(match=None, include_self=True)[source]

Поиск элементов объекта.

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

Параметры:

match

Критерий фильтрации соответствий. Может быть

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

include_selfbool

Включить self в список для проверки соответствия.

Возвращает:

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

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

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

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

get_animated()[source]: Возвращает значение, указывающее, является ли объект анимированным.

get_antialiased()[source]

Получает состояние антиалиасинга для отрисовки.

Возвращает:

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

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

get_array()[source]

Возвращает массив значений, которые отображаются в цвета.

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

get_capstyle()[source]

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

Возвращает:

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

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

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

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

get_clip_on()[source]: Возвращает, использует ли объект обрезку.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

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

Примечание

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

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

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

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

Параметры:

eventMouseEvent

См. также

format_cursor_data

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

get_datalim(transData)[source]

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

get_edgecolor()[source]

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

get_facecolor()[source]

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

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

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

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

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

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

get_in_layout()[source]

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

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

get_joinstyle()[source]

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

Возвращает:

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

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

get_linestyle()[source]

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

get_linewidth()[source]

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

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

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

get_mouseover()[source]: Возвращает, запрашивается ли у этого элемента информация о контексте при наведении курсора мыши.

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

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

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

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

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, должен ли элемент быть растрированным.

get_sizes()[source]

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

Возвращает:

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

get_sketch_params()[source]

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

Возвращает:

кортеж или None

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

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

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

get_snap()[source]

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

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

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры:

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

Возвращает:

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

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

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

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

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

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

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

Получить область отображения объекта-графического элемента.

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

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

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

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

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

is_transform_set()[source]

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

Это True после вызова set_transform.

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний объект-графический элемент сгенерирует событие выбора, если mouseevent над ним, и у объекта-графического элемента установлено свойство picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

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

remove()[source]

Удаляет объект-графический элемент из фигуры, если это возможно.

Эффект будет виден только после перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если необходимо.

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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

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

Свойство	Описание
`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 или (Путь, Преобразование) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список таковых
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или 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`	строка
`urls`	список строк или None
`visible`	bool

zorder

число с плавающей точкой

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

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

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

set_alpha(alpha)[source]

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

Параметры:

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

set_animated(b)[source]

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

Если True, художник исключается из обычного рисования фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_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.

Параметры:

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, необязательно: Используется только если path является объектом Path. В этом случае заданный объект Path преобразуется в TransformedPath с использованием transform.

Примечания

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

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

set_cmap(cmap)[source]

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

Параметры:

cmapColormap или str или None

set_color(c)[source]

Установить цвет обводки и заливки.

Параметры:

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

См. также

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

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

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

set_edgecolor(c)[source]

Установить цвет(а) обводки коллекции.

Параметры:

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

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

set_facecolor(c)[source]

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

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

Параметры:

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

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

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

set_figure(fig)[source]

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

Параметры:

figFigure

set_gid(gid)[source]

Установите идентификатор группы (gid) для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установите шаблон штриховки.

hatch может быть одним из:

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

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

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

Параметры:

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

set_in_layout(in_layout)[source]

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

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Устанавливает JoinStyle для набора (для всех его элементов).

Параметры:

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

set_label(s)[source]

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

Параметры:

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

set_linestyle(ls)[source]

Устанавливает стиль линии (стили) для набора.

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

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

(offset, onoffseq),

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

Параметры:

lsстрока или кортеж или список таких же: Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См. Line2D.set_linestyle для полного описания.

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

set_linewidth(lw)[source]

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

Параметры:

lwчисловое или список чисел

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

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

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

set_mouseover(mouseover)[source]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

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

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[source]

Установите трансформирование смещения объекта.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

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

Параметры:

offsets(N, 2) или (2,) массив

set_path_effects(path_effects)[source]

Установите эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(paths)[source]

set_picker(picker)[source]

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

Параметры:

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

Это может быть одно из следующих:

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

set_pickradius(pickradius)[source]

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

Параметры:

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

set_rasterized(rasterized)[source]

Принудительное растровое (битовое) отображение для векторной графики.

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

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

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

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

Установите размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер, который нужно установить для каждого элемента коллекции. Значение — 'площадь' элемента.
dpifloat, по умолчанию: 72: Точек на дюйм холста.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры размытия.

Параметры:

scalefloat, необязательно

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

lengthfloat, необязательно

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

randomnessfloat, необязательно

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

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

set_snap(snap)[source]

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

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

Привязка в настоящее время поддерживается только backends 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]

Параметры:

urlsсписок str или None

Примечания

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

set_visible(b)[source]

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

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок объекта. Объекты с меньшими значениями 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 является одномерной или двумерной последовательностью скаляров, и соответствующий ndarray массив значений RGBA будет возвращён на основе нормализации и цветовой карты, установленной для этого ScalarMappable.

Существует один особый случай для обработки изображений, которые уже являются RGB или RGBA, например, которые были прочитаны из файла изображения. Если x является ndarray с 3 измерениями, и последнее измерение равно 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)[source]

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

Parameters:

propsdict

update_from(other)[source]: Копирует свойства из other в self.

update_scalarmappable()[source]

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

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

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, pickradius=5.0, hatch=None, urls=None, zorder=1, **kwargs)[source]

Базы: Artist, ScalarMappable

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

Коллекция представляет собой последовательность 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 в её конструктор. Если для коллекции задана матрица ScalarMappable _A (через вызов 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 — кортеж чётной длины длительностей включения и выключения чернил в пунктах. Примеры см. в Стилях линий.

capstyleCapStyle-подобное, по умолчанию: rcParams["patch.capstyle"]

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

joinstyleJoinStyle-подобное, по умолчанию: rcParams["patch.joinstyle"]

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

antialiasedsbool или список bool, по умолчанию: rcParams["patch.antialiased"] (по умолчанию: True)

Определяет, должен ли каждый элемент коллекции отрисовываться с антиалиасингом.

offsets(float, float) или список таковых, по умолчанию: (0, 0)

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

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

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

cmap, norm

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

hatchстрока, необязательно

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

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

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

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

URL для каждого элемента коллекции для привязки к нему при отрисовке. В настоящее время работает только для бэкэнда SVG. См. Гиперссылки для примеров.

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

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

**kwargs

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

add_callback(func)[source]

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

Параметры:

funcфункция

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

def func(artist: Artist) -> Any

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

Возвращает:

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

См. также

remove_callback

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

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

END_OF_DOCUMENT_MARKER

propertyaxes: The Axes instance the artist resides in, or None.

changed()[source]: Вызовите эту функцию всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей обратного вызова о сигнале 'changed'.

colorbar: Последняя связанная с этим ScalarMappable цветовая шкала. Может быть None.

contains(mouseevent)[source]

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

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

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

draw(renderer)[source]

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

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

Parameters:

rendererRendererBase подкласс.

Примечания

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

findobj(match=None, include_self=True)[source]

Поиск объектов художников.

Рекурсивно находит все Artist объекты, содержащиеся в художнике.

Parameters:

match

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

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

include_selfbool

Включать self в список, который будет проверяться на соответствие.

Returns:

список Artist

format_cursor_data(data)[source]

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

Примечание

Этот метод предназначен для переопределения подклассами художников. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

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

См. также

get_cursor_data

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

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

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

get_animated()[source]: Возвращает, анимируется ли объект-художник.

get_antialiased()[source]

Получить состояние антиалиасинга для рендеринга.

Returns:

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

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

get_array()[source]

Возвращает массив значений, которые отображаются в цвета.

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

get_capstyle()[source]

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

Возвращает:

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

get_children()[source]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[source]: Возвращает значения (min, max), которые отображаются на шкале цветовой карты.

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

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

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

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

Примечание

Этот метод предназначен для переопределения подклассами элементов. Пользователю Matplotlib, скорее всего, не нужно вызывать этот метод.

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

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

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

Параметры:

eventMouseEvent

См. также

format_cursor_data

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

get_datalim(transData)[source]

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

get_edgecolor()[source]

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

get_facecolor()[source]

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

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

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

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

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

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

get_in_layout()[source]

Возвращает логическое значение, True если элемент включён в расчёты макета.

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

get_joinstyle()[source]

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

Возвращает:

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

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

get_linestyle()[source]

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

get_linewidth()[source]

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

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

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

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

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

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

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

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

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, необходимо ли растрировать элемент.

get_sketch_params()[source]

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

Возвращает:

кортеж или None

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

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

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

get_snap()[source]

Возвращает значение настройки snap.

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

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры:

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

Возвращает:

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

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

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

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

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

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

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

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

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

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

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

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

get_zorder()[source]: Возвращает z-порядок элемента.

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

is_transform_set()[source]

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

Это True после вызова set_transform.

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

propertynorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, является ли элемент графического объекта выбираемым.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь всех свойств графического объекта.

remove()[source]

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

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

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

remove_callback(oid)[source]

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

См. также

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>, 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>)[source]

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

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

Свойство	Описание
`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` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor`	цвет или список цветов или 'face'
`facecolor`	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle`	строка или кортеж или список
`linewidth`	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или 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`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

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

set_agg_filter(filter_func)[source]

Устанавливает фильтр agg.

Параметры:

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

set_alpha(alpha)[source]

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

Параметры:

alphaмассив-подобный объект или скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

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

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

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

Параметры:

bbool

set_antialiased(aa)[source]

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

Параметры:

aabool или список булевых значений

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, 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, необязательно: Используется только если path является Path. В этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

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

set_cmap(cmap)[source]

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

Параметры:

cmapColormap или str или None

set_color(c)[source]

Установите цвет обводки и заливки.

Параметры:

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

См. также

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

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

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

set_edgecolor(c)[source]

Установите цвет обводки коллекции.

Параметры:

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

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

set_facecolor(c)[source]

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

Если c равно 'none', область не будет закрашиваться.

Параметры:

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

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

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

set_figure(fig)[source]

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

Параметры:

figFigure

set_gid(gid)[source]

Установите идентификатор (группы) для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установите узор штриховки.

hatch может быть одним из:

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

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

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

Параметры:

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

set_in_layout(in_layout)[source]

Указывает, будет ли элемент участвовать в расчетах макета, например, при использовании руководства по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установите стиль соединения JoinStyle для набора (для всех его элементов).

Параметры:

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

set_label(s)[source]

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

Параметры:

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

set_linestyle(ls)[source]

Установите стиль(и) линии для набора.

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

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

(offset, onoffseq),

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

Параметры:

lsstr или кортеж или список кортежей: Допустимые значения отдельных стилей линии включают {'-', '--', '-.', ':', '', (смещение, последовательность вкл/выкл)}. Подробное описание см. в Line2D.set_linestyle.

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

set_linewidth(lw)[source]

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

Параметры:

lwfloat или список float

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

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

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

set_mouseover(mouseover)[source]

Установить, запрашивается ли у данного объекта пользовательская информация о контексте, когда курсор мыши наведён на него.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

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

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[source]

Установить трансформирование смещения для объекта.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

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

Параметры:

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

set_path_effects(path_effects)[source]

Установить эффекты траекторий.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(paths)[source]

set_picker(picker)[source]

Определение поведения выбора для элемента.

Параметры:

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

Может быть одним из следующих:

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

set_pickradius(pickradius)[source]

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

Параметры:

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:

scalefloat, необязательно

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

lengthfloat, необязательно

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

randomnessfloat, необязательно

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

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

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]

Параметры:

urlsсписок строк или None

Примечания

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

set_visible(b)[source]

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

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок для художника. Художники с меньшими значениями 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 — это 1D или 2D последовательность скаляров, и соответствующий массив RGBA будет возвращён, на основе установленных для этого ScalarMappable нормирования и цветовой карты.

Есть один особый случай для обработки изображений, которые уже имеют формат RGB или RGBA, например, считанных из файла изображения. Если x является массивом NumPy с 3 измерениями и последнее измерение равно 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.

Параметры:

propsсловарь

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

update_scalarmappable()[source]

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

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

zorder=0

classmatplotlib.collections.EllipseCollection(widths, heights, angles, *, units='points', **kwargs)[source]

Основы: Collection

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

Параметры:

widthsarray-like: Длина первых осей (например, длина большой оси).
heightsarray-like: Длина вторых осей.
anglesarray-like: Углы первых осей, градусы против часовой стрелки от оси x.
units{'points', 'inches', 'dots', 'width', 'height', 'x', 'y', 'xy'}: Единицы измерения больших и малых осей; 'width' и 'height' относятся к размерам осей, а 'x' и 'y' относятся к данным единицам смещения. 'xy' отличается от всех остальных тем, что угол, как изображённый, изменяется в зависимости от соотношения сторон, и равен указанному углу только тогда, когда соотношение сторон равно единице. Таким образом, он ведет себя так же, как Ellipse с axes.transData в качестве своего преобразования.
**kwargs: Передаётся в Collection.

add_callback(func)[source]

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

Параметры:

funccallable

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

def func(artist: Artist) -> Any

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

Возвращает:

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

См. также

remove_callback

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

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

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

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

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

contains(mouseevent)[source]

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

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

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

findobj(match=None, include_self=True)[source]

Поиск объектов художника.

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

Параметры:

match

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

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

include_selfbool

Включить self в список для проверки совпадения.

Возвращает:

список Artist

format_cursor_data(data)[source]

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

Примечание

Этот метод предназначен для переопределения подклассами элементов графики. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

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

См. также

get_cursor_data

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

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

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

get_angles()[source]: Получение углов первой оси, в градусах против часовой стрелки от оси x.

get_animated()[source]: Возвращает, анимирован ли элемент графики.

get_antialiased()[source]

Получение состояния антиалиасинга для отрисовки.

Возвращает:

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

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

get_array()[source]

Возвращает массив значений, которые отображаются в цвета.

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

get_capstyle()[source]

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

Возвращает:

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

get_children()[source]: Возвращает список дочерних элементов Artist данного Artist.

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

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

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

get_clip_path()[source]: Возвращает траекторию обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

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

Примечание

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

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

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

Параметры:

eventMouseEvent

См. также

format_cursor_data

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

get_datalim(transData)[source]

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

get_edgecolor()[source]

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

get_facecolor()[source]

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

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

get_figure()[source]: Возвращает экземпляр Figure, к которому относится элемент графики.

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

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

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

get_heights()[source]: Устанавливает длины осей второго порядка (например, малые оси).

get_in_layout()[source]

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

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

get_joinstyle()[source]

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

Возвращает:

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

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

get_linestyle()[source]

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

get_linewidth()[source]

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

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

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

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

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

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

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

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

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, должен ли элемент быть растрирован.

get_sketch_params()[source]

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

Возвращает:

кортеж или None

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

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

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

get_snap()[source]

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

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

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:

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

Возвращает:

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

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

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

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

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

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

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

get_visible()[source]: Возвращает видимость.

get_widths()[source]: Получает длины первой оси (например, большой оси).

get_window_extent(renderer=None)[source]

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

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

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

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

get_zorder()[source]: Возвращает z-порядок объекта.

have_units()[source]: Возвращает, установлены ли единицы на любой оси.

is_transform_set()[source]

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

Это True после вызова set_transform.

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

propertynorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, можно ли выбрать объект.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

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

remove()[source]

Удалить элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это необходимо.

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

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

remove_callback(oid)[source]

Удалить обработчик на основе его идентификатора наблюдателя.

См. также

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>, 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>)[source]

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

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

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

`visible`	bool
`widths`	неизвестно
`zorder`	float

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

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Parameters:

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

set_alpha(alpha)[source]

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

Parameters:

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

set_angles(angles)[source]: Установить углы первой оси, градусы против часовой стрелки от оси x.

set_animated(b)[source]

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

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

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

Parameters:

bbool

set_antialiased(aa)[source]

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

Parameters:

aabool или список bool

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

set_array(A)[source]

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

Parameters:

Aмассив-подобное значение или None

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

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

set_capstyle(cs)[source]

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

Parameters:

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

set_clim(vmin=None, vmax=None)[source]

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

Parameters:

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

Установить область обрезки художника Bbox.

Parameters:

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, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

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

По техническим причинам (поддержка set), также допускается кортеж (path, transform) в качестве единственного позиционного параметра.

set_cmap(cmap)[source]

Установить палитру для данных яркости.

Параметры:

cmapColormap или строка или None

set_color(c)[source]

Установить цвет обводки и заливки.

Параметры:

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

См. также

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

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

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

set_edgecolor(c)[source]

Установить цвет(цвета) обводки коллекции.

Параметры:

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

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

set_facecolor(c)[source]

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

Если c равно 'none', элемент не будет закрашен.

Параметры:

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

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

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

set_figure(fig)[source]

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

Параметры:

figFigure

set_gid(gid)[source]

Установить идентификатор группы (id) для объекта.

Параметры:

gidstr

set_hatch(hatch)[source]

Установить узор штриховки.

hatch может быть одним из:

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

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

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

Параметры:

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

set_heights(heights)[source]: Установить длины вторых осей (например, малых осей).

set_in_layout(in_layout)[source]

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

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установить JoinStyle для набора (для всех его элементов).

Параметры:

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

set_label(s)[source]

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

Параметры:

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

set_linestyle(ls)[source]

Установить стиль линии(й) для набора.

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

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

(offset, onoffseq),

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

Параметры:

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

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

set_linewidth(lw)[source]

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

Параметры:

lwfloat или список чисел с плавающей точкой

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

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

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

set_mouseover(mouseover)[source]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

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

Параметры:

normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[source]

Устанавливает трансформирование смещения для объекта.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

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

Параметры:

offsets(N, 2) или (2,) массив-подобный

set_path_effects(path_effects)[source]

Устанавливает эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(paths)[source]

set_picker(picker)[source]

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

Параметры:

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

Это может быть одно из следующих:

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

set_pickradius(pickradius)[source]

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

Параметры:

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:

scalefloat, необязательно

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

lengthfloat, необязательно

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

randomnessfloat, необязательно

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

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

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]

Параметры:

urlsсписок строк или None

Примечания

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

set_visible(b)[source]

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

Параметры:

bbool

set_widths(widths)[source]: Установить длины первой оси (например, большой оси).

set_zorder(level)[source]

Установить z-порядок элемента. Элементы с меньшими значениями 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 представляет собой одномерную или двумерную последовательность скалярных значений, и соответствующий массив значений RGBA будет возвращён на основе установленных нормализации и цветовой карты для данного ScalarMappable.

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

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

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

update(props)[source]

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

Parameters:

propsdict

update_from(other)[source]: Копирует свойства из other в себя.

update_scalarmappable()[source]

Обновляет цвета из массива скалярной карты, если таковой имеется.

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

zorder=0

classmatplotlib.collections.EventCollection(positions, orientation='horizontal', *, lineoffset=0, linelength=1, linewidth=None, color=None, linestyle='solid', antialiased=None, **kwargs)[source]

Bases: LineCollection

Коллекция положений вдоль одной оси, в которых произошло «событие».

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

Параметры:

positionsОдномерный массив-подобный объект

Каждое значение — событие.

orientation{'горизонтально', 'вертикально'}, по умолчанию: 'горизонтально'

Последовательность событий отображается в этом направлении. Линии маркеров отдельных событий расположены в ортогональном направлении.

lineoffsetвещественное число, по умолчанию: 0

Смещение центра маркеров от начала координат в направлении, ортогональном к orientation.

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

Полная высота маркера (т.е. маркер простирается от lineoffset - linelength/2 до lineoffset + linelength/2).

linewidthвещественное число или список таковых, по умолчанию: rcParams["lines.linewidth"] (по умолчанию: 1.5)

Толщина линий событий в пунктах.

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

Цвет линий событий.

linestyleстрока или кортеж или список таковых, по умолчанию: 'сплошная'

Допустимые строки: ['сплошная', 'пунктирная', 'штрихпунктирная', 'точечная', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид:

(offset, onoffseq),

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

antialiasedбулево значение или список таковых, по умолчанию: rcParams["lines.antialiased"] (по умолчанию: True)

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

**kwargs

Передаются в LineCollection.

Примеры

(Source code, 2x.png, png)

add_callback(func)[source]

Параметры:

funcвызываемая функция

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

def func(artist: Artist) -> Any

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

Возвращаемое значение:

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

См. также

remove_callback

add_positions(position)[source]: Добавляет одно или несколько событий в указанных позициях.

append_positions(position)[source]: Добавляет одно или несколько событий в указанных позициях.

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

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

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

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

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

contains(mouseevent)[source]

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

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

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

extend_positions(position)[source]: Добавить одно или несколько событий в указанных позициях.

findobj(match=None, include_self=True)[source]

Найти объекты элементов.

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

Параметры:

match

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

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

include_selfbool

Включать self в список для проверки совпадения.

Возвращает:

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

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

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

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

get_animated()[source]: Возвращает, анимирован ли элемент.

get_antialiased()[source]

Получение состояния антиалиасинга для рендеринга.

Возвращает:

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

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

get_array()[source]

Возвращает массив значений, которые отображаются в цвета.

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

get_capstyle()[source]

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

Возвращает:

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

get_children()[source]: Возвращает список дочерних элементов Artist этого элемента Artist.

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

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

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

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

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

get_colors()[source]

get_cursor_data(event)[source]

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

Примечание

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

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

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

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

Параметры:

eventMouseEvent

См. также

format_cursor_data

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

get_datalim(transData)[source]

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

get_edgecolor()[source]

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

get_facecolor()[source]

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

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

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[source]: Возвращает, закрашен ли элемент.

get_gapcolor()[source]

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

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

get_in_layout()[source]

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

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

get_joinstyle()[source]

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

Возвращает:

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

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

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

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

get_linestyle()[source]

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

get_linewidth()[source]: Получает ширину линий, используемых для маркировки каждого события.

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

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

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

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

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

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

get_orientation()[source]: Возвращает ориентацию линии события ('горизонтальная' или 'вертикальная').

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_positions()[source]: Возвращает массив, содержащий значения позиций с плавающей точкой.

get_rasterized()[source]: Возвращает, будет ли элемент растрирован.

get_segments()[source]

Возвращает:

список: Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()[source]

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

Возвращает:

кортеж или None

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

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

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

get_snap()[source]

Возвращает значение настройки "snap".

См. set_snap для подробностей.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:

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

Возвращает:

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

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

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

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

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

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

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

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

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

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

get_zorder()[source]: Возвращает порядок элемента z.

have_units()[source]: Возвращает, установлены ли единицы на любой оси.

is_horizontal()[source]: Истина, если eventcollection горизонтальный, ложь, если вертикальный.

is_transform_set()[source]

Возвращает, есть ли у элемента явно установленное преобразование.

Это Истина после вызова set_transform.

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, может ли элемент отображения быть выбранным.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь со всеми свойствами элемента отображения.

remove()[source]

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

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если необходимо.

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

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

remove_callback(oid)[source]

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

См. также

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>, 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>)[source]

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (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` или строка или None
`color`	цвет или список цветов
`colors`	цвет или список цветов
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gapcolor`	цвет или список цветов или None
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linelength`	неизвестно
`lineoffset`	неизвестно
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или None
`offset_transform` или transOffset	`Transform`
`offsets`	(N, 2) или (2,) массивоподобное значение
`orientation`	{'horizontal', 'vertical'}
`path_effects`	список `AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или число с плавающей точкой или вызываемая функция
`pickradius`	число с плавающей точкой

`positions`	неизвестно
`rasterized`	bool
`segments`	неизвестно
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список строк или None
`verts`	неизвестно
`visible`	bool
`zorder`	float

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

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

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

set_alpha(alpha)[source]

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

Параметры:

alphaмассив-подобный объект или скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Не поддерживаются значения с маской и NaN.

set_animated(b)[source]

Установить, предназначен ли элемент для использования в анимации.

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

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

Параметры:

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, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры:

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, необязательно: Используется только если path — Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

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

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

set_cmap(cmap)[source]

Установить палитру для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[source]

Установить цвет(цвета) обводки LineCollection.

Параметры:

cцвет или список цвета: Один цвет (все линии имеют один цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически проходить через последовательность.

set_colors(c)[source]

Установить цвет(цвета) обводки LineCollection.

Параметры:

cцвет или список цвета: Один цвет (все линии имеют один цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически проходить через последовательность.

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

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

set_edgecolor(c)[source]

Установить цвет(цвета) обводки коллекции.

Параметры:

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

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

set_facecolor(c)[source]

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

Если c равно 'none', область не будет заполнена.

Параметры:

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

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

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

set_figure(fig)[source]

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

Параметры:

figFigure

set_gapcolor(gapcolor)[source]

Установите цвет для заполнения пробелов в пунктирной линии.

Примечание

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

Эта функция находится в экспериментальной стадии и может быть изменена.

Параметры:

gapcolorцвет или список цветов или None: Цвет, используемый для заполнения пробелов. Если None, пробелы не заполняются.

set_gid(gid)[source]

Установите (групповой) идентификатор для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установите узор штриховки.

hatch может быть одним из:

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

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

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

Параметры:

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

set_in_layout(in_layout)[source]

Устанавливает, нужно ли учитывать элемент в расчетах макета. Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

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

Параметры:

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

set_label(s)[source]

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

Параметры:

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

set_linelength(linelength)[source]: Установите длину линий, используемых для маркировки каждого события.

set_lineoffset(lineoffset)[source]: Установите смещение линий, используемых для маркировки каждого события.

set_linestyle(ls)[source]

Установить стиль линии(ей) для коллекции.

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

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

(offset, onoffseq),

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

Параметры:

lsстрока, кортеж или список кортежей: Допустимые значения для отдельных стилей линии включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См. Line2D.set_linestyle для полного описания.

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

set_linewidth(lw)[source]

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

Параметры:

lwчисловое значение или список числовых значений

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

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

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

set_mouseover(mouseover)[source]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

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

Параметры:

normNormalize или строка или None

Примечания

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

set_offset_transform(offset_transform)[source]

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

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

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

Параметры:

offsets(N, 2) или (2,) массив

set_orientation(orientation)[source]

Установить ориентацию линии событий.

Параметры:

orientation{'горизонтально', 'вертикально'}

set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(segments)[source]

set_picker(picker)[source]

Определите поведение выбора для элемента.

Параметры:

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

Это может быть одно из следующих значений:

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

set_pickradius(pickradius)[source]

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

Параметры:

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

set_positions(positions)[source]: Установите позиции событий.

set_rasterized(rasterized)[source]

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

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

Это значение игнорируется для растрового вывода.

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

Параметры:

rasterizedbool

set_segments(segments)[source]

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установите параметры наброска.

Параметры:

scalefloat, необязательно

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

lengthfloat, необязательно

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

randomnessfloat, необязательно

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

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

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]

Параметры:

urlsсписок строк или None

Примечания

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

set_verts(segments)[source]

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)

switch_orientation()[source]: Переключает ориентацию линии событий с вертикальной на горизонтальную и наоборот.

to_rgba(x, alpha=None, bytes=False, norm=True)[source]

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

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

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

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

update(props)[source]

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

Параметры:

propsdict

update_from(other)[source]: Копирует свойства из other в себя.

update_scalarmappable()[source]

Обновляет цвета из массива скалярной карты, если таковой имеется.

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

zorder=0

classmatplotlib.collections.LineCollection(segments, *, zorder=2, **kwargs)[source]

Основы: Collection

Представляет последовательность Line2D которые должны быть нарисованы вместе.

Этот класс расширяет Collection для представления последовательности Line2D вместо просто последовательности Patch. Как и в Collection, каждый атрибут LineCollection может быть либо единственным значением, либо списком значений. Этот список используется циклически для каждого элемента LineCollection, поэтому атрибут i-го элемента коллекции равен:

prop[i % len(prop)]

Атрибуты каждого элемента LineCollection по умолчанию принимают свои значения из rcParams["lines.*"] вместо rcParams["patch.*"], а атрибут colors добавлен вместо edgecolors.

Параметры:

segmentsсписок массивов

Последовательность (line0, line1, line2) линий, где каждая линия представляет собой список точек:

lineN = [(x0, y0), (x1, y1), ... (xm, ym)]

или эквивалентный Mx2 массив NumPy с двумя столбцами. Каждая линия может иметь разное количество отрезков.

linewidthsчисло или список чисел, по умолчанию: rcParams["lines.linewidth"] (по умолчанию: 1.5)

Ширина каждой линии в пунктах.

colorsцвет или список цветов, по умолчанию: rcParams["lines.color"] (по умолчанию: 'C0')

Последовательность кортежей RGBA (например, произвольные цветовые строки и т.д., не допускаются).

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

Использовать ли антиалиасинг для каждой линии.

zorderчисло, по умолчанию: 2

zorder линий после отрисовки.

facecolorsцвет или список цветов, по умолчанию: 'none'

При установке facecolors, каждая линия интерпретируется как граница области, неявным образом закрывая путь от последней точки до первой точки. Закрытая область закрашивается facecolor. Для того чтобы вручную указать, что должно считаться "внутренней" частью каждой линии, используйте PathCollection вместо этого, где "внутренняя" часть может быть указана с помощью соответствующего использования CLOSEPOLY.

**kwargs

Передается в Collection.

add_callback(func)[source]

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

Параметры:

funcвызываемая функция

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

def func(artist: Artist) -> Any

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

Возвращает:

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

См. также

remove_callback

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

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

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

changed()[source]: Вызовите эту функцию всякий раз, когда изменяется mappable, чтобы уведомить все слушатели обратного вызова сигнала 'changed'.

colorbar: Последняя связанная с этим ScalarMappable цветковая шкала. Может быть None.

contains(mouseevent)[source]

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

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

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

draw(renderer)[source]

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

Это не имеет эффекта, если элемент не видимый (Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

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

findobj(match=None, include_self=True)[source]

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

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

Параметры:

match

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

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

include_selfbool

Включить self в список для проверки соответствия.

Возвращает:

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

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

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

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

get_animated()[source]: Возвращает, анимирован ли художник.

get_antialiased()[source]

Получение состояния антиалиасинга для отрисовки.

Возвращает:

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

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

get_array()[source]

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

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

get_capstyle()[source]

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

Возвращает:

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

get_children()[source]: Возвращает список дочерних элементов Artist этого Artist.

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

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

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

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_color()[source]

get_colors()[source]

get_cursor_data(event)[source]

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

Примечание

Этот метод предназначен для переопределения подклассами элементов. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

Параметры:

eventMouseEvent

См. также

format_cursor_data

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

get_datalim(transData)[source]

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

get_edgecolor()[source]

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

get_facecolor()[source]

get_facecolors()[source]: Псевдоним для get_facecolor.

get_fc()[source]: Псевдоним для get_facecolor.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[source]: Возвращает значение, указывающее, закрашен ли объект.

get_gapcolor()[source]

get_gid()[source]: Возвращает идентификатор группы.

get_hatch()[source]: Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает логическое значение, True если элемент включён в расчёты макета.

Например, Руководство по макетам с ограниченным размером, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

{'miter', 'round', 'bevel'} или None

get_label()[source]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[source]

get_linestyles()[source]: Псевдоним для get_linestyle.

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

get_mouseover()[source]: Возвращает, запрашивается ли у этого объекта пользовательская информация о контексте, когда курсор мыши находится над ним.

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого объекта.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора объекта.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, нужно ли растрировать объект.

get_segments()[source]

Возвращает:

list: Список отрезков в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()[source]

Возвращает параметры наброска для объекта.

Возвращает:

tuple или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, с которым длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были заданы.

get_snap()[source]

Возвращает значение параметра привязки.

Подробнее см. set_snap.

get_tightbbox(renderer=None)[source]

Как Artist.get_window_extent, но включает любое обрезание.

Parameters:

rendererRendererBase подкласс, необязательно: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Returns:

Bbox или None: Охватывающая область (в пикселях координат фигуры). Возвращает None, если обрезание не приводит к пересечению.

get_transOffset()[source]: Псевдоним для get_offset_transform.

get_transform()[source]: Возвращает объект Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[source]: Возвращает путь обрезки с примененной неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

Получить область элемента в пространстве отображения.

Ширина и высота области неотрицательны.

Подклассы должны переопределять для включения в расчет "плотной" области. По умолчанию возвращает пустую область в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если область элемента изменится. Область может измениться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или используемой холщовой области (как при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохраняться неправильно.

get_zorder()[source]: Возвращает z-порядок элемента.

have_units()[source]: Возвращает, установлены ли единицы на любой оси.

is_transform_set()[source]

Возвращает, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли у этого элемента информация о контексте, когда курсор мыши находится над ним.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обрабатывает событие выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен пикер.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, является ли элемент графическим объектом, пригодным для выбора.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь всех свойств графического элемента.

remove()[source]

Удаляет графический элемент из фигуры, если это возможно.

Эффект будет заметен только после перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.

Примечание: нет поддержки удаления записи элемента легенды графика.

remove_callback(oid)[source]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

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>, 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>)[source]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	неизвестно
`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` или строка или None
`color`	цвет или список цветов
`colors`	цвет или список цветов
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gapcolor`	цвет или список цветов или None
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или штрихи или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	вещественное число или список вещественных чисел
`mouseover`	bool
`norm`	`Normalize` или строка или None
`offset_transform` или transOffset	`Transform`
`offsets`	(N, 2) или (2,) массив
`path_effects`	список `AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или float или вызываемая функция
`pickradius`	float
`rasterized`	bool
`segments`	неизвестно
`sketch_params`	(scale: float, length: float, randomness: float)

`snap`	булево значение или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`verts`	неизвестно
`visible`	булево значение
`zorder`	вещественное число

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funcвызываемый объект: Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения

set_alpha(alpha)[source]

Установить значение альфа, используемое для смешивания - не поддерживается на всех бэкендах.

Параметры:

alphaмассивоподобное значение, скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

См. также matplotlib.animation и Более быстрое отображение с помощью blitting.

Параметры:

bбулево значение

set_antialiased(aa)[source]

Установить состояние антиалиасинга для рендеринга.

Параметры:

aaбулево значение или список булевых значений

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.

Параметры:

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, необязательно: Используется только если path — Path, в этом случае указанный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — Rectangle, этот метод установит область обрезки на соответствующий прямоугольник и установит путь обрезки на None.

set_cmap(cmap)[source]

Установить цветовую карту для данных яркости.

Параметры:

cmapColormap или строка или None

set_color(c)[source]

Установить цвет(а) обводки LineCollection.

Параметры:

cцвет или список цветов: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически принимать цвета из последовательности.

set_colors(c)[source]

Установить цвет(а) обводки LineCollection.

Параметры:

cцвет или список цветов: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически принимать цвета из последовательности.

set_dashes(ls)[source]: Псевдоним для set_linestyle.

set_ec(c)[source]: Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установить цвет(а) обводки коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет(а) обводки коллекции. Если последовательность, элементы циклически принимают значения из неё. Если 'face', соответствуют цвету заливки.

set_edgecolors(c)[source]: Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Установите цвет(ы) заливки коллекции. c может быть цветом (все области имеют одинаковый цвет) или последовательностью цветов; если это последовательность, области будут циклически перебирать последовательность.

Если c равно 'none', область не будет заполнена.

Параметры:

cцвет или список цветов

set_facecolors(c)[source]: Псевдоним для set_facecolor.

set_fc(c)[source]: Псевдоним для set_facecolor.

set_figure(fig)[source]

Установите экземпляр Figure, к которому принадлежит элемент управления.

Параметры:

figFigure

set_gapcolor(gapcolor)[source]

Установите цвет для заполнения пробелов в штриховом стиле линии.

Примечание

Штриховые линии создаются путем рисования двух чередующихся пунктирных линий. Между ними могут быть перекрытия, что может привести к артефактам при использовании прозрачности.

Эта функциональность экспериментальная и может измениться.

Параметры:

gapcolorцвет или список цветов или None: Цвет, которым заполняются пробелы. Если None, пробелы не заполняются.

set_gid(gid)[source]

Установите идентификатор группы для элемента управления.

Параметры:

gidstr

set_hatch(hatch)[source]

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае все указанные штриховки выполняются. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого узора.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всей коллекции, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[source]

Установите, должен ли элемент управления включаться в вычисления макета, например, руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установите JoinStyle для коллекции (для всех ее элементов).

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установить метку, которая будет отображаться в легенде.

Параметры:

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установить стиль линии (линий) для коллекции.

Стиль линии	Описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	штрих-пунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж с даш-значениями следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий длины включения и выключения чернил в пунктах.

Параметры:

lsстрока, кортеж или список кортежей: Допустимые значения для отдельных стилей линии включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. Подробное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[source]: Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Задать толщину линии (линий) для коллекции. lw может быть скаляром или последовательностью; если это последовательность, объекты будут циклически использовать значения из последовательности.

Параметры:

lwчисло или список чисел

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установить, запрашивается ли у этого объекта пользовательская информация о контексте, когда курсор мыши находится над ним.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

Установить экземпляр нормализации.

Параметры:

normNormalize или строка или None

Примечания

Если какие-либо цветовые шкалы используют карту отображения для этой нормализации, установка нормализации для отображаемого объекта сбросит нормализацию, локали и форматирование в цветовой шкале по умолчанию.

set_offset_transform(offset_transform)[source]

Установить преобразование смещения объекта.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

Установить смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(segments)[source]

set_picker(picker)[source]

Определите поведение выбора для объекта.

Параметры:

pickerNone или bool или float или вызываемая функция

Это может быть одно из следующих:

None: Выбор отключён для этого объекта (по умолчанию).
Булево значение: Если True, то выбор будет включён, и объект сгенерирует событие выбора, если курсор находится над ним.
Число с плавающей точкой: Если picker — число, оно интерпретируется как толерантность эпсилон в точках, и объект сгенерирует событие, если его данные находятся в пределах эпсилон от события мыши. Для некоторых объектов, таких как линии и коллекции областей, объект может предоставить дополнительные данные событию выбора, например, индексы данных в пределах эпсилон от события выбора.
Вызываемая функция: Если picker — вызываемая функция, это пользовательская функция, которая определяет, попадает ли объект под действие события мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор находится над объектом, вернуть hit=True и props — словарь свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Установить радиус выбора, используемый для проверок попадания.

Параметры:

pickradiusfloat: Радиус выбора, в точках.

set_rasterized(rasterized)[source]

Принудительно выполнить растровое (битовое) отображение для выходных данных векторной графики.

Растровое отображение не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не будет иметь эффекта, и будет выведено предупреждение.

Это настройка игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры:

rasterizedbool

set_segments(segments)[source]

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:

scalefloat, необязательно

Амплитуда колебания перпендикулярно исходной линии, в пикселях. Если scale None, или не предоставлено, фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебания вдоль линии, в пикселях (по умолчанию 128.0).

randomnessfloat, необязательно

Коэффициент масштабирования, на который длина сжимается или расширяется (по умолчанию 16.0).

Backend PGF использует этот аргумент как seed генератора случайных чисел, а не как описано выше. Использование одного и того же seed приводит к одной и той же случайной форме.

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]

Параметры:

urlsСписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_verts(segments)[source]

set_visible(b)[source]

Установите видимость объекта.

Параметры:

bbool

set_zorder(level)[source]

Установите значение 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)[source]

Возвращает нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий ndarray значений RGBA будет возвращён на основе нормализации и цветовой карты, установленных для этого ScalarMappable.

Существует один специальный случай для обработки изображений, которые уже находятся в RGB или RGBA формате, например, прочитанных из файла изображения. Если x является ndarray с 3 измерениями, и последнее измерение равно 3 или 4, то оно будет обрабатываться как массив RGB или RGBA, и не будет выполняться отображение. Массив может быть uint8, или это могут быть числа с плавающей точкой в диапазоне от 0 до 1; в противном случае будет вызвано исключение ValueError. Любые значения NaN или замаскированные элементы будут установлены в 0 альфа-канал. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет существующий альфа-канал. Будет вызвана ошибка ValueError, если третье измерение отличается от 3 или 4.

В любом случае, если 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.PatchCollection(patches, *, match_original=False, **kwargs)[source]

Основы: Collection

Общее множество объектов-заплаток.

PatchCollection рисует быстрее, чем большое количество эквивалентных отдельных объектов-заплаток. Это также упрощает присвоение цветовой карты неоднородному множеству объектов-заплаток.

Параметры:

patchesсписок Patch

Последовательность объектов-заплаток. Этот список может включать разнородный набор различных типов заплаток.

match_originalbool, по умолчанию: False

Если True, используйте цвета и ширины линий исходных заплаток. Если False, новые цвета могут быть назначены путем предоставления стандартных аргументов коллекции, facecolor, edgecolor, linewidths, norm или cmap.

**kwargs

Все остальные параметры передаются в Collection.

Если какие-либо из edgecolors, facecolors, linewidths, antialiaseds равны None, они по умолчанию принимают значение параметра rcParams patch, в форме последовательности.

Примечания

Использование функциональности ScalarMappable необязательно. Если матрица ScalarMappable была установлена (через вызов set_array), во время отрисовки будет сделан вызов scalar mappable для установки цветов заливки.

add_callback(func)[source]

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующий сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Значения возврата могут существовать, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[source]: Автомасштабирование пределов скаляра в экземпляре norm с использованием текущего массива

autoscale_None()[source]: Автомасштабирование пределов скаляра в экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None

propertyaxes: Экземпляр Axes, в котором находится объект-артист, или None.

changed()[source]: Вызывайте эту функцию всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей обратного вызова 'changed' сигнала.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[source]

Проверяет, произошла ли событие мыши внутри коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[source]

Преобразовать x с использованием типа единиц осей x.

Если объект-артист не входит в Axes или ось x не имеет единиц, возвращается x.

convert_yunits(y)[source]

Преобразовать y с использованием типа единиц осей y.

Если объект-артист не входит в Axes или ось y не имеет единиц, возвращается y.

draw(renderer)[source]

Отрисовать объект-артист (и его дочерние элементы) с использованием заданного отрисовщика.

Это не имеет эффекта, если объект-артист не виден (Artist.get_visible возвращает False).

Параметры:

rendererRendererBase подкласс.

Примечания

Этот метод переопределен в подклассах Artist.

findobj(match=None, include_self=True)[source]

Найти объекты-артисты.

Рекурсивно найти все Artist экземпляры, содержащиеся в артисте.

Параметры:

match

Критерий фильтрации совпадений. Это может быть

None: вернуть все объекты, содержащиеся в артисте.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только объекты-артисты, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только объекты-артисты этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список, который будет проверен на соответствие.

Возвращает:

список Artist

format_cursor_data(data)[source]

Возвращает строковое представление data.

Примечание

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у элемента нет связанной цветовой шкалы. В противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_aa()[source]: Псевдоним для get_antialiased.

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается на всех бэкендах.

get_animated()[source]: Возвращает значение, указывающее, является ли элемент анимированным.

get_antialiased()[source]

Получает состояние антиалиасинга для рендеринга.

Возвращает:

массив булевых значений

get_antialiaseds()[source]: Псевдоним для get_antialiased.

get_array()[source]

Возвращает массив значений, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

Возвращает стиль обрезки для коллекции (для всех её элементов).

Возвращает:

{'butt', 'projecting', 'round'} или None

get_children()[source]: Возвращает список дочерних элементов Artist этого Artist.

get_clim()[source]: Возвращает значения (минимум, максимум), которые отображаются на пределы цветовой карты.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает значение, указывающее, используется ли обрезка элементов.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные курсора для данного события.

Примечание

Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращает None.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[source]: Псевдоним для get_linestyle.

get_datalim(transData)[source]

get_ec()[source]: Псевдоним для get_edgecolor.

get_edgecolor()[source]

get_edgecolors()[source]: Псевдоним для get_edgecolor.

get_facecolor()[source]

get_facecolors()[source]: Псевдоним для get_facecolor.

get_fc()[source]: Псевдоним для get_facecolor.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[source]: Возвращает, закрашивается ли фигура.

get_gid()[source]: Возвращает идентификатор группы.

get_hatch()[source]: Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает логическое значение, True указывает, включён ли элемент в расчёты макета.

Например, Руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

{'miter', 'round', 'bevel'} или None

get_label()[source]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[source]

get_linestyles()[source]: Псевдоним для get_linestyle.

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

get_mouseover()[source]: Возвращает значение, указывающее, запрашивается ли у этого объекта пользовательская информация о контексте при перемещении курсора мыши над ним.

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый этим объектом для смещения.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора для объекта.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает значение, указывающее, нужно ли растрировать объект.

get_sketch_params()[source]

Возвращает параметры наброска для объекта.

Возвращаемое значение:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний, перпендикулярных исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, с помощью которого длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает значение настройки snap.

См. set_snap для подробностей.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры:

rendererRendererBase подкласс, необязательно: объект отрисовки, который будет использован для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращаемое значение:

Bbox или None: Охватывающая область (в пикселях координат изображения). Возвращает None, если обрезка не приводит к пересечению.

get_transOffset()[source]: Псевдоним для get_offset_transform.

get_transform()[source]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[source]: Возвращает обрезной путь с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

Получить область отображения элемента.

Ширина и высота области отображения неотрицательны.

Подклассы должны переопределять для включения в вычисление "тесной" области отображения. По умолчанию возвращается пустая область отображения в координатах 0, 0.

Будьте внимательны при использовании этой функции. Результаты не будут обновляться, если изменится область отображения элемента. Область отображения может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но будут сохранены неправильно.

get_zorder()[source]: Возвращает z-порядок элемента.

have_units()[source]: Возвращает, установлены ли единицы измерения на какой-либо оси.

is_transform_set()[source]

Возвращает, задано ли преобразование для элемента.

Это True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли у этого элемента информация о контексте при перемещении курсора мыши над ним.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, можно ли выбрать элемент.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь всех свойств элемента.

remove()[source]

Удаляет элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim, чтобы обновить пределы осей, если нужно.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к оси с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[source]

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

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>, 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>)[source]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`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` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список из них
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или 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`	строка
`urls`	список строк или None
`visible`	bool

zorder

число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funcвызываемая функция: Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения

set_alpha(alpha)[source]

Установить значение альфа, используемое для смешивания - не поддерживается на всех бэкендах.

Параметры:

alphaмассив-подобный объект или скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

См. также matplotlib.animation и Более быстрое рендеринг с помощью blitting.

Параметры:

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.

Параметры:

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, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит область обрезки соответствующему прямоугольнику и установит путь обрезки в None.

set_cmap(cmap)[source]

Установите палитру цветов для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[source]

Установите и цвет границы, и цвет заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета границы или заливки по отдельности.

set_dashes(ls)[source]: Псевдоним для set_linestyle.

set_ec(c)[source]: Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установите цвет границы коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет границы коллекции. Если последовательность, фигуры циклически проходят по ней. Если 'face', совпадает с цветом заливки.

set_edgecolors(c)[source]: Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Установите цвет заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически проходить по ней.

Если c равно 'none', фигура не будет заполнена.

Параметры:

cцвет или список цветов

set_facecolors(c)[source]: Псевдоним для set_facecolor.

set_fc(c)[source]: Псевдоним для set_facecolor.

set_figure(fig)[source]

Установите экземпляр Figure, к которому принадлежит элемент.

Параметры:

figFigure

set_gid(gid)[source]

Установите идентификатор группы (id) для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установите узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать, в этом случае все указанные штриховки выполняются. Если одна и та же буква повторяется, она увеличивает плотность штриховки этого узора.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для коллекции целиком, а не для каждого элемента по отдельности.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[source]

Установить, должен ли элемент включаться в вычисления макета, например, в руководстве по макету руководство по ограниченным макетам, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установить JoinStyle для коллекции (для всех ее элементов).

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установить метку, которая будет отображаться в легенде.

Параметры:

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установить стиль(и) линии для коллекции.

linestyle	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	точечная линия

В качестве альтернативы можно указать кортеж с последовательностью тире следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий длины отрезков черной и белой краски в пунктах.

Параметры:

lsстрока или кортеж или список таких кортежей: Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[source]: Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установить ширину(ы) линии(й) для коллекции. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности.

Параметры:

lwfloat или список чисел с плавающей точкой

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установить, запрашивается ли у данного объекта пользовательская информация о контексте при наведении курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

Установить экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

Если какие-либо цветовые шкалы используют этот объект отображения для данной нормализации, установка нормализации отображаемого объекта сбросит нормализацию, локатор и форматеры цветовой шкалы до значений по умолчанию.

set_offset_transform(offset_transform)[source]

Установить преобразование смещения объекта.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

Установить смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установить эффекты для путей.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(patches)[source]

set_picker(picker)[source]

Определите поведение выбора объекта.

Параметры:

pickerNone или bool или float или вызываемая функция

Это может быть одно из следующих:

None: Выбор отключен для этого объекта (по умолчанию).
Булево значение: Если True, то выбор будет включён, и объект сгенерирует событие выбора, если курсор мыши находится над ним.
Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск в точках, и объект сгенерирует событие, если его данные находятся в пределах допуска от события мыши. Для некоторых объектов, таких как линии и коллекции фигур, объект может предоставить дополнительные данные событию выбора, например, индексы данных, находящихся в пределах допуска от события выбора.
Функция: Если picker — вызываемая функция, это пользовательская функция, определяющая, попадает ли указатель мыши на объект:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если указатель мыши находится над объектом, возвращает hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Установить радиус выбора, используемый для проверки попадания.

Параметры:

pickradiusfloat: Радиус выбора в точках.

set_rasterized(rasterized)[source]

Принудительно использовать растровое (bitmap) отображение для векторной графики.

Растровое отображение не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.

Это свойство игнорируется для выходных данных на основе пикселей.

См. также Растризация для векторной графики.

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не указана, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0).

randomnessfloat, необязательно

Коэффициент масштабирования, на который уменьшается или увеличивается длина (по умолчанию 16.0).

Backend PGF использует этот аргумент в качестве значения RNG, а не так, как описано выше. Использование одного и того же значения приводит к одному и тому же случайному рисунку.

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]

Параметры:

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установить видимость художника.

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок художника. Художники с меньшими значениями 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 является одномерным или двумерным массивом скаляров, и соответствующий массив значений RGBA будет возвращён, основываясь на норме и цветовой карте, установленных для этой ScalarMappable.

Существует один специальный случай для обработки изображений, которые уже являются RGB или RGBA, таких как, например, прочитанные из файла изображения. Если x является массивом ndarray с 3 измерениями, и последнее измерение составляет 3 или 4, то он будет обрабатываться как массив RGB или RGBA, и никаких преобразований не будет выполнено. Массив может быть uint8, или это могут быть числа с плавающей запятой в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Любые NaN или замаскированные элементы будут установлены в 0 альфа. Если последнее измерение составляет 3, значение по умолчанию alpha (1) будет использоваться для заполнения прозрачности. Если последнее измерение составляет 4, значение alpha игнорируется; оно не заменяет существующий альфа. ValueError будет поднят, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив RGBA будет числами с плавающей запятой в диапазоне 0-1; если оно равно True, возвращаемый массив RGBA будет uint8 в диапазоне от 0 до 255.

update(props)[source]

Обновить свойства этого художника из словаря props.

Параметры:

propsсловарь

update_from(other)[source]: Копировать свойства из other в self.

update_scalarmappable()[source]

Обновить цвета из массива отображения значений, если таковой имеется.

Присвоить цвета к границам и поверхностям, основываясь на массиве и/или цветах, которые были непосредственно заданы, в соответствии с требованиями.

zorder=0

classmatplotlib.collections.PathCollection(paths, sizes=None, **kwargs)[source]

Bases: _CollectionWithSizes

A collection of Paths, as created by e.g. scatter.

Parameters:

pathslist of path.Path: The paths that will make up the Collection.
sizesarray-like: The factor by which to scale each drawn Path. One unit squared in the Path's data space is scaled to be sizes**2 points when rendered.
**kwargs: Forwarded to Collection.

add_callback(func)[source]

Add a callback function that will be called whenever one of the Artist's properties changes.

Parameters:

funccallable

The callback function. It must have the signature:

def func(artist: Artist) -> Any

where artist is the calling Artist. Return values may exist but are ignored.

Returns:

int: The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.

Notes

This method is overridden in the Artist subclasses.

findobj(match=None, include_self=True)[source]

Find artist objects.

Recursively find all Artist instances contained in the artist.

Parameters:

match

A filter criterion for the matches. This can be

None: Return all objects contained in artist.
A function with signature def match(artist: Artist) -> bool. The result will only contain artists for which the function returns True.
A class instance: e.g., Line2D. The result will only contain artists of this class or its subclasses (isinstance check).

include_selfbool

Include self in the list to be checked for a match.

Returns:

list of Artist

END_OF_DOCUMENT_MARKER ```

format_cursor_data(data)[source]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами объектов-артистов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

В стандартной реализации целые и вещественные числа, а также массивы целых и вещественных чисел преобразуются в строку, разделённую запятыми, заключённую в квадратные скобки, если у объекта-артиста нет связанной цветовой шкалы. В противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.

См. также

get_cursor_data

get_aa()[source]: Псевдоним для get_antialiased.

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается всеми бэкендами.

get_animated()[source]: Возвращает, анимирован ли объект-артист.

get_antialiased()[source]

Получает состояние антиалиасинга для отрисовки.

Возвращает:

массив булевых значений

get_antialiaseds()[source]: Псевдоним для get_antialiased.

get_array()[source]

Возвращает массив значений, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

Возвращает стиль обрезки для коллекции (для всех её элементов).

Возвращает:

{'butt', 'projecting', 'round'} или None

get_children()[source]: Возвращает список дочерних объектов-артистов данного объекта-артиста.

get_clim()[source]: Возвращает значения (мин, макс), которые сопоставляются с пределами цветовой карты.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает, используется ли обрезка для объекта-артиста.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные указателя для данного события.

Примечание

Данные указателя могут использоваться объектами-артистами для предоставления дополнительной контекстной информации для данного события. Стандартная реализация возвращает None.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[source]: Псевдоним для get_linestyle.

get_datalim(transData)[source]

get_ec()[source]: Псевдоним для get_edgecolor.

get_edgecolor()[source]

get_edgecolors()[source]: Псевдоним для get_edgecolor.

get_facecolor()[source]

get_facecolors()[source]: Псевдоним для get_facecolor.

get_fc()[source]: Псевдоним для get_facecolor.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[source]: Возвращает значение, указывающее, окрашена ли область.

get_gid()[source]: Возвращает идентификатор группы.

get_hatch()[source]: Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает булево значение, True если элемент включен в вычисления компоновки.

Например, Руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращаемое значение:

{'miter', 'round', 'bevel'} или None

get_label()[source]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[source]

get_linestyles()[source]: Псевдоним для get_linestyle.

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

END_OF_DOCUMENT_MARKER

get_mouseover()[source]: Возвращает, запрашивается ли у этого элемента пользовательская информация о контексте, когда курсор мыши перемещается над ним.

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, должен ли элемент быть растрированным.

get_sizes()[source]

Возвращает размеры (площади) элементов в коллекции.

Возвращает:

массив: Площадь каждого элемента.

get_sketch_params()[source]

Возвращает параметры наброска для элемента.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, с которым уменьшается или увеличивается длина.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает значение параметра привязки.

См. set_snap для подробностей.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:

rendererRendererBase подкласс, необязательно: экземпляр отрисовки, который будет использован для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Охватывающая область (в пикселях координат фигуры). Возвращает None, если обрезка не приводит к пересечению.

get_transOffset()[source]: Псевдоним для get_offset_transform.

get_transform()[source]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[source]: Возвращает обрезку пути с примененной частью преобразования, не связанной с аффином, и оставшейся аффинной частью преобразования.

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL-адреса. См. Ссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

Получает прямоугольник отображения элемента.

Ширина и высота прямоугольника неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотного" прямоугольника. По умолчанию возвращает пустой прямоугольник в координатах (0, 0).

Будьте осторожны при использовании этой функции, результаты не обновятся, если прямоугольник отображения элемента изменится. Область может измениться из-за любых изменений стека преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к неожиданному поведению, где интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder()[source]: Возвращает значение z-порядка элемента.

have_units()[source]: Возвращает, установлены ли единицы измерения на любой оси.

is_transform_set()[source]

Возвращает, задано ли преобразование для элемента.

Это True после вызова set_transform.

legend_elements(prop='colors', num='auto', fmt=None, func=<function PathCollection.<lambda>>, **kwargs)[source]

Создаёт элементы легенды для PathCollection.

Каждый элемент легенды — это Line2D, представляющий нарисованный путь, а каждое имя — это строка, представляющая путь.

Это полезно для получения легенды для 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" (по умолчанию), array-like или 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список строк: Строковые метки элементов легенды.

свойствоmouseover: Возвращает, запрашивается ли у элемента информация о контексте при наведении курсора.

свойствоnorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается в Matplotlib, когда изменяется свойство.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний элемент-объект сгенерирует событие выбора, если mouseevent находится над элементом-объектом и для элемента-объекта установлено свойство picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, является ли элемент-объект выбираемым.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь всех свойств элемента-объекта.

remove()[source]

Удаляет элемент-объект из графика, если это возможно.

Эффект будет виден только после перерисовки графика, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей используйте relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.

Примечание: нет поддержки удаления записи элемента-объекта в легенде.

remove_callback(oid)[source]

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

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>, 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>)[source]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
`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` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или штрихи или linestyles или ls	строка или кортеж или список кортежей
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или 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`	строка
`urls`	список строк или None

`visible`	bool
`zorder`	float

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funcвызываемый объект: Функция фильтра, которая принимает массив float (m, n, глубина) и значение dpi, и возвращает массив (m, n, глубина) и два смещения из левого нижнего угла изображения

set_alpha(alpha)[source]

Установить значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

Параметры:

alphaмассивоподобный объект или скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

См. также 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, 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, художники будут видны за пределами оси, что может привести к неожиданным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[source]

Устанавливает обрезку для элемента.

Параметры:

pathPatch или Path или TransformedPath или None: Путь обрезки. Если задан Path, transform также должен быть указан. Если None, то ранее заданная обрезка будет удалена.
transformTransform, необязательно: Используется только если path — Path, в этом случае данный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path — Rectangle, этот метод установит ограничивающую рамку соответствующего прямоугольника и установит путь обрезки в None.

set_cmap(cmap)[source]

Устанавливает карту цветов для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[source]

Устанавливает цвет обводки и заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета обводки или заливки индивидуально.

set_dashes(ls)[source]: Псевдоним для set_linestyle.

set_ec(c)[source]: Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Устанавливает цвет контура(ов) коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет контура(ов) коллекции. Если последовательность, фигуры циклически используют значения из неё. Если 'face', соответствует цвету заливки.

set_edgecolors(c)[source]: Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Устанавливает цвет заливки(ов) коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры циклически используют значения из неё.

Если c равно 'none', фигура не будет закрашена.

Параметры:

cцвет или список цветов

set_facecolors(c)[source]: Псевдоним для set_facecolor.

set_fc(c)[source]: Псевдоним для set_facecolor.

set_figure(fig)[source]

Установите экземпляр Figure , к которому принадлежит элемент.

Параметры:

figFigure

set_gid(gid)[source]

Установите идентификатор группы (gid) для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установите шаблон штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна буква повторяется, это увеличивает плотность штриховки этого шаблона.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всего набора, а не для каждого элемента по отдельности.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[source]

Установите, будет ли элемент включён в вычисления макета, например, в руководстве по управлению размерами, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установите стиль соединения JoinStyle для всего набора.

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установите метку, которая будет отображаться в легенде.

Параметры:

sобъект: s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)[source]

Установите стиль(и) линии для набора.

linestyle	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж с отступами, имеющий следующий вид:

(offset, onoffseq),

где onoffseq - кортеж чётной длины, содержащий длины включения и выключения чернил в пунктах.

Параметры:

lsстрока или кортеж или список кортежей: Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[source]: Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установите толщину линии(й) для набора. lw может быть скаляром или последовательностью; если это последовательность, элементы будут циклически перебирать последовательность.

Параметры:

lwчисло или список чисел

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установите, запрашивается ли у этого элемента информация о контексте пользовательского интерфейса при перемещении курсора мыши над ним.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

Установите экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

Если какие-либо цветовые шкалы используют mappable для этой нормализации, установка нормализации mappable сбросит нормализацию, локатор и форматеры цветовой шкалы по умолчанию.

set_offset_transform(offset_transform)[source]

Установите преобразование смещения элемента.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

Установите смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установите эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(paths)[source]

set_picker(picker)[source]

Определите поведение выбора элемента.

Параметры:

pickerNone или bool или float или вызываемый объект

Может быть одним из следующих:

None: Выбор отключён для этого элемента (по умолчанию).
Булево значение: Если True, то выбор будет включён, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
Число с плавающей запятой: Если значение picker — число, оно интерпретируется как значение толерантности в пунктах, и элемент сгенерирует событие, если данные находятся в пределах толерантности от события выбора мыши. Для некоторых элементов, таких как линии и коллекции объектов, элемент может предоставить дополнительные данные событию выбора, например, индексы данных, находящихся в пределах толерантности от события выбора
Функция: Если picker — вызываемый объект, это пользовательская функция, определяющая, выбран ли элемент с помощью события мыши:
```
hit, props = picker(artist, mouseevent)
```
чтобы определить тест на выбор. Если курсор мыши находится над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Установите радиус выбора, используемый для тестов на вхождение.

Параметры:

pickradiusfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[source]

Вынужденное растрирование (отображение битовой карты) для вывода векторной графики.

Растрирование не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не будет иметь эффекта, и будет выведено предупреждение.

Это настройка игнорируется для вывода на основе пикселей.

См. также Растрирование для векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

Установите размеры каждого члена коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер для каждого элемента коллекции. Значение — 'площадь' элемента.
dpifloat, по умолчанию: 72: dpi холста.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры размытия.

Параметры:

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр размытия не будет применён.

lengthfloat, необязательно

Длина колебания вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, на который уменьшается или увеличивается длина (по умолчанию 16.0)

Backend PGF использует это значение как seed для генератора случайных чисел, а не как описано выше. Использование одинакового seed приводит к одинаковой форме.

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]

Параметры:

urlsсписок str или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установить видимость художника.

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок для художника. Художники с более низкими значениями zorder отрисовываются первыми.

Параметры:

levelfloat

propertystale: Является ли художник 'stale' (засохший) и нужно ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию художника.

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 — это одномерная или двумерная последовательность скаляров, и соответствующий ndarray массив значений RGBA будет возвращён на основе нормы и цветовой карты, установленной для этого объекта ScalarMappable.

Существует один особый случай для обработки изображений, которые уже находятся в формате RGB или RGBA, например, прочитанных из файла изображения. Если x является ndarray с 3 измерениями, и последнее измерение равно 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)[source]

Обновляет свойства этого объекта из словаря props.

Параметры:

propsdict

update_from(other)[source]: Копирует свойства из other в себя.

update_scalarmappable()[source]

Обновляет цвета из массива отображения скаляров, если таковой имеется.

Присваивает цвета границам и граням на основе массива и/или непосредственно заданных цветов, как необходимо.

zorder=0

classmatplotlib.collections.PolyCollection(verts, sizes=None, *, closed=True, **kwargs)[source]

Bases: _CollectionWithSizes

Параметры:

vertsсписок массивов: Последовательность полигонов [verts0, verts1, ...] где каждый элемент verts_i определяет вершины полигона i как двумерный массив-подобный объект формы (M, 2).
sizesмассив, по умолчанию: None: Квадратные коэффициенты масштабирования для полигонов. Координаты каждого полигона verts_i умножаются на квадратный корень соответствующего элемента в sizes (т.е., sizes определяют масштабирование площадей). Масштабирование применяется перед преобразованием главного объекта Artist.
closedbool, по умолчанию: True: Определяет, следует ли закрыть полигон, добавив соединение CLOSEPOLY в конце.
**kwargs: Передаются в Collection.

add_callback(func)[source]

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одна из свойств Artist.

Параметры:

funcвызываемая функция

Функция обратного вызова. Она должна иметь следующий синтаксис:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[source]: Автоматически масштабирует пределы скалярных значений в экземпляре нормы, используя текущий массив.

autoscale_None()[source]: Автоматически масштабирует пределы скалярных значений в экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None.

свойствоaxes: Экземпляр Axes, в котором находится элемент графического объекта, или None.

changed()[source]: Вызывайте этот метод всякий раз, когда изменяется отображаемый объект, чтобы уведомить всех слушателей обратного вызова 'changed' сигнала.

colorbar: Последняя цветовая шкала, связанная с этим объектом ScalarMappable. Может быть None.

contains(mouseevent)[source]

Проверяет, произошла ли мышь в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[source]

Преобразует x, используя тип единиц измерения оси x.

Если графический объект не содержится в Axes или ось x не имеет единиц, возвращается само x.

convert_yunits(y)[source]

Преобразует y, используя тип единиц измерения оси y.

Если графический объект не содержится в Axes или ось y не имеет единиц, возвращается само y.

draw(renderer)[source]

Отрисовывает графический объект (и его дочерние элементы) с помощью заданного рендерера.

Это не оказывает никакого влияния, если графический объект не видим (Artist.get_visible возвращает False).

Параметры:

rendererRendererBase подкласс.

Примечания

Этот метод переопределен в подклассах графических объектов.

findobj(match=None, include_self=True)[source]

Поиск объектов графических элементов.

Рекурсивно находит все Artist экземпляры, содержащиеся в графическом объекте.

Параметры:

match

Критерий фильтрации соответствий. Может быть

None: Возвращает все объекты, содержащиеся в графическом объекте.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только графические объекты, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только графические объекты этого класса или его подклассов (isinstance проверка).

include_selfbool

Включать self в список, который будет проверяться на соответствие.

Возвращает:

список Artist

format_cursor_data(data)[source]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами элементов. Пользователям Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у элемента нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.

См. также

get_cursor_data

get_aa()[source]: Псевдоним для get_antialiased.

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается на всех бэкендах.

get_animated()[source]: Возвращает, анимирован ли элемент.

get_antialiased()[source]

Возвращает состояние применения сглаживания при отрисовке.

Возвращает:

массив булевых значений

get_antialiaseds()[source]: Псевдоним для get_antialiased.

get_array()[source]

Возвращает массив значений, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

Возвращает стиль обрезки для коллекции (для всех её элементов).

Возвращает:

{'butt', 'projecting', 'round'} или None

get_children()[source]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[source]: Возвращает значения (мин, макс), сопоставляемые с пределами цветовой карты.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает, используется ли элемент обрезки.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные указателя для данного события.

Примечание

Данные указателя могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация просто возвращает None.

Подклассы могут переопределить метод и вернуть произвольные данные. Однако, при этом они должны убедиться, что format_cursor_data может преобразовать данные в строковое представление.

Единственный текущий случай использования - отображение значения z изображения AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[source]: Псевдоним для get_linestyle.

get_datalim(transData)[source]

get_ec()[source]: Псевдоним для get_edgecolor.

get_edgecolor()[source]

get_edgecolors()[source]: Псевдоним для get_edgecolor.

get_facecolor()[source]

get_facecolors()[source]: Псевдоним для get_facecolor.

get_fc()[source]: Псевдоним для get_facecolor.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[source]: Возвращает, закрашен ли заполненный элемент.

get_gid()[source]: Возвращает идентификатор группы.

get_hatch()[source]: Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает логический флаг, True если элемент включён в расчёт макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

{'miter', 'round', 'bevel'} или None

get_label()[source]: Возвращает метку, используемую для данного элемента на легенде.

get_linestyle()[source]

get_linestyles()[source]: Псевдоним для get_linestyle.

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

get_mouseover()[source]: Возвращает значение, указывающее, запрашивается ли у этого объекта дополнительная информация о контексте при наведении курсора мыши.

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого объекта.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора объекта.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает значение, указывающее, нужно ли растрировать объект.

get_sizes()[source]

Возвращает размеры (площади) элементов в коллекции.

Возвращает:

array: Площадь каждого элемента.

get_sketch_params()[source]

Возвращает параметры наброска для объекта.

Возвращает:

tuple или None

Кортеж из 3 элементов:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, по которому длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были заданы.

get_snap()[source]

Возвращает значение параметра snap.

Подробности см. в set_snap.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры:

rendererRendererBase подкласс, необязательно: renderer, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Охватывающая рамка (в пикселях координат изображения). Возвращает None, если обрезание не привело к пересечению.

get_transOffset()[source]: Псевдоним для get_offset_transform.

get_transform()[source]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[source]: Возвращает путь обрезки с применённой к нему не-аффинной частью преобразования, и оставшейся аффинной частью преобразования.

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL-адреса. См. Гиперссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

Получить область отображения объекта.

Ширина и высота области отображения неотрицательны.

Будьте внимательны при использовании этой функции, результаты не будут обновляться, если область отображения объекта изменится. Область отображения может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к непредсказуемому поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder()[source]: Возвращает порядок объекта по z.

have_units()[source]: Возвращает, установлены ли единицы измерения на любой оси.

is_transform_set()[source]

Возвращает, установлен ли преобразование объекта.

Это True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли у этого объекта пользовательская информация о контексте при перемещении курсора мыши над ним.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается неявно при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обрабатывает событие выбора.

Каждый дочерний объект вызовет событие выбора, если mouseevent находится над объектом, и у объекта установлен picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, может ли объект быть выбран.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь всех свойств объекта.

remove()[source]

Удаляет объект из фигуры, если это возможно.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта.

remove_callback(oid)[source]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

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>, 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` или 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` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или штрихи или стили_линий или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или None
`offset_transform` или transOffset	`Transform`
`offsets`	(N, 2) или (2,) массив
`path_effects`	список `AbstractPathEffect`
`paths`	список массивов
`picker`	None или bool или float или функция
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	`numpy.ndarray` или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None

`verts`	список массивоподобных объектов
`verts_and_codes`	неизвестно
`visible`	bool
`zorder`	float

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funcвызываемый объект: Функция фильтра, которая принимает массив с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения

set_alpha(alpha)[source]

Установить значение альфа-канала, используемое для смешивания — не поддерживается во всех бэкендах.

Параметры:

alphaмассивоподобный объект, скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначается ли объект художника для использования в анимации.

Если True, объект художника исключается из обычного рисования фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_artist на объекте художника. Этот подход используется для ускорения анимации с помощью функции blitting.

См. также matplotlib.animation и Более быстрое отрисовка с использованием blitting.

Параметры:

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, 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, необязательно: Используется только если path является объектом Path. В этом случае переданный объект Path преобразуется в объект TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является объектом Rectangle, этот метод установит область обрезки соответствующим прямоугольником и задаст путь обрезки в None.

По техническим причинам (поддержка set), в качестве единственного позиционного параметра также принимается кортеж (path, transform).

set_cmap(cmap)[source]

Установить палитру цветов для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[source]

Установить цвет обводки и заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета обводки или заливки индивидуально.

set_dashes(ls)[source]: Псевдоним для set_linestyle.

set_ec(c)[source]: Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установить цвет обводки коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет обводки коллекции. Если последовательность, фигуры циклически перебирают ее. Если 'face', совпадает с цветом заливки.

set_edgecolors(c)[source]: Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Установить цвет заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически перебирать ее.

Если c равно 'none', фигура не будет заполнена.

Параметры:

cцвет или список цветов

set_facecolors(c)[source]: Псевдоним для set_facecolor.

set_fc(c)[source]: Псевдоним для set_facecolor.

set_figure(fig)[source]

Установить экземпляр Figure, к которому принадлежит элемент.

Параметры:

figFigure

set_gid(gid)[source]

Установить идентификатор группы для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установить шаблон штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки данного шаблона.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[source]

Установить, следует ли включать элемент в вычисления макета, например, при использовании Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установить JoinStyle для набора (для всех его элементов).

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установить метку, которая будет отображаться в легенде.

Параметры:

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установить стиль линии(ей) для набора.

Стиль линии	Описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	пунктирная линия
`':'` или `'dotted'`	точечная линия

В качестве альтернативы можно указать кортеж штрихов с таким форматом:

(offset, onoffseq),

где onoffseq — это кортеж чётной длины с значениями включения и выключения чернил в точках.

Параметры:

lsстрока или кортеж/список: Допустимые значения для отдельных стилей линии включают {'-', '--', '-.', ':', '', (смещение, последовательность вкл/выкл)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[source]: Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установить ширину линии(ей) для набора. lw может быть скаляром или последовательностью; если это последовательность, области будут циклически проходить по последовательности.

Параметры:

lwчисловой или список чисел

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Устанавливает, запрашивается ли у данного элемента информация о контексте при перемещении курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

Устанавливает экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

Если какие-либо полосы цветовой карты используют mappable для этой нормализации, установка нормы mappable сбросит нормализация, локатор и форматировщики полосы цветовой карты до значений по умолчанию.

set_offset_transform(offset_transform)[source]

Устанавливает преобразование смещения элемента.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

Устанавливает смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Устанавливает эффекты траектории.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(verts, closed=True)[source]

Устанавливает вершины многоугольников.

Параметры:

vertsсписок массивов-подобных объектов: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как 2D массив-подобный объект формы (M, 2).
closedbool, по умолчанию: True: Замкнуть ли многоугольник, добавив соединение CLOSEPOLY в конце.

set_picker(picker)[source]

Определяет поведение выбора элемента.

Параметры:

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующего:

None: Выбор отключен для данного элемента (по умолчанию).
Булево значение: Если True, то выбор будет включён и элемент будет генерировать событие выбора, если курсор мыши находится над ним.
Число с плавающей запятой: Если picker — число, оно интерпретируется как допуск в точках, и элемент будет генерировать событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции участков, элемент может предоставлять дополнительные данные для события выбора, например, индексы данных, которые находятся в пределах допуска от события выбора
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли элемент под курсор мыши:
```
hit, props = picker(artist, mouseevent)
```
чтобы определить тест на попадание. Если курсор мыши находится над элементом, верните hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Устанавливает радиус выбора, используемый для тестов на попадание.

Параметры:

pickradiusfloat: Радиус выбора в точках.

set_rasterized(rasterized)[source]

Принудительно включить растровое (битовое) отображение для векторизованного графического вывода.

Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не окажет никакого влияния, и будет выведено предупреждение.

Это значение игнорируется для пиксельного вывода.

См. также Растрирование для векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

Установите размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер для каждого элемента коллекции. Значение представляет собой 'площадь' элемента.
dpifloat, по умолчанию: 72: Разрешение холста (dpi).

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установите параметры наброска.

Параметры:

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не задан, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, по которому длина уменьшается или увеличивается (по умолчанию 16.0)

Пакет PGF использует этот аргумент как seed для генератора случайных чисел, а не как описано выше. Использование одного и того же seed даёт один и тот же случайный вид.

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]

Параметры:

urlsсписок str или None

Примечания

В настоящее время URL-адреса реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_verts(verts, closed=True)[source]

Установить вершины многоугольников.

Параметры:

vertsсписок array-like: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как 2D массив-подобный формы (M, 2).
closedbool, по умолчанию: True: Закрывать ли многоугольник, добавив подключение CLOSEPOLY в конце.

set_verts_and_codes(verts, codes)[source]: Инициализация вершин с кодами пути.

set_visible(b)[source]

Установить видимость объекта.

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок для объекта. Объекты с меньшими значениями z-порядка рисуются первыми.

Параметры:

levelfloat

propertystale: Является ли объект 'просроченным' и требует перерисовки для соответствия внутреннего состояния объекта выводу.

свойствоsticky_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 — это одномерная или двумерная последовательность скаляров, и соответствующий ndarray значений RGBA будет возвращён на основе нормы и цветовой карты, установленных для данного объекта отображения скаляров.

Существует один специальный случай для обработки изображений, которые уже находятся в формате RGB или RGBA, например, которые были прочитаны из файла изображения. Если x является ndarray с 3 измерениями, а последнее измерение — 3 или 4, то оно будет рассматриваться как массив RGB или RGBA, и никакой обработки не будет выполняться. Массив может быть uint8 или содержать числа с плавающей точкой в диапазоне от 0 до 1; в противном случае будет поднято исключение ValueError. Любые значения NaN или замаскированные элементы будут установлены в 0 альфа-канал. Если последнее измерение равно 3, параметр alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет существующий альфа-канал. ValueError будет поднято, если третье измерение не равно 3 или 4.

update(props)[source]

Обновляет свойства этого объекта-художника из словаря props.

Параметры:

propsdict

update_from(other)[source]: Копирует свойства из other в self.

update_scalarmappable()[source]

Обновляет цвета из массива объекта отображения скаляров, если он есть.

Назначает цвета краям и граням на основе массива и/или непосредственно установленных цветов, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.PolyQuadMesh(coordinates, **kwargs)[source]

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) массив-подобный объект: Вершины. coordinates[m, n] указывает (x, y) координаты вершины (m, n).

Примечания

В отличие от QuadMesh, этот класс отобразит каждую ячейку как отдельный многоугольник. Это значительно медленнее, но позволяет больше гибкости при добавлении дополнительных свойств к ячейкам, таких как штриховка.

Другое отличие от QuadMesh заключается в том, что если какие-либо вершины или данные ячейки замаскированы, этот многоугольник не будет нарисован, и он не будет в списке путей, возвращаемых.

Параметры:

vertsсписок массивоподобных объектов: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массив-подобный объект формы (M, 2).
sizesмассив-подобный объект, по умолчанию: None: Квадратичные коэффициенты масштабирования для многоугольников. Координаты каждого многоугольника verts_i умножаются на квадратный корень соответствующего элемента в sizes (т. е. sizes определяют масштабирование площадей). Масштабирование применяется перед преобразованием основного объекта Artist.
closedbool, по умолчанию: True: Указывает, должен ли многоугольник быть замкнутым путём добавления соединения CLOSEPOLY в конце.
**kwargs: Передаются в Collection.

add_callback(func)[source]

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда одно из свойств Artist изменяется.

Параметры:

funccallable

Функция обратного вызова. Она должна иметь следующий синтаксис:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[source]: Автоматически масштабирует пределы скаляра в экземпляре нормы, используя текущий массив.

autoscale_None()[source]: Автоматически масштабирует пределы скаляра в экземпляре нормы, используя текущий массив, изменяя только отсутствующие пределы.

propertyaxes: Экземпляр Axes, в котором находится объект Artist, или None.

changed()[source]: Вызывается всякий раз, когда карта отображается, чтобы уведомить всех слушателей обратного вызова 'changed' сигнала.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[source]

Проверяет, произошла ли мышь в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[source]

Преобразует x, используя тип единиц оси x.

Если объект Artist не содержится в Axes или ось x не имеет единиц, возвращается x сам по себе.

convert_yunits(y)[source]

Преобразует y, используя тип единиц оси y.

Если объект Artist не содержится в Axes или ось y не имеет единиц, возвращается y сам по себе.

draw(renderer)[source]

Отрисовывает объект Artist (и его потомков) с помощью данного render.

Это не имеет никакого эффекта, если объект Artist не видим (Artist.get_visible возвращает False).

Параметры:

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах Artist.

END_OF_DOCUMENT_MARKER

findobj(match=None, include_self=True)[source]

Найти объекты художников.

Рекурсивно найти все экземпляры Artist, содержащиеся в художнике.

Параметры:

match

Критерий фильтрации совпадений. Он может быть

None: вернуть все объекты, содержащиеся в художнике.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только художников этого класса или его подклассов (isinstance проверка).

include_selfbool

Включить self в список для проверки на соответствие.

Возвращает:

список Artist

format_cursor_data(data)[source]

Возвратить строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами художников. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и плавающие числа и массивы целых и плавающих чисел в строку, разделенную запятыми, заключенную в квадратные скобки, если у художника нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_aa()[source]: Псевдоним для get_antialiased.

get_agg_filter()[source]: Возвратить функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвратить значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

get_animated()[source]: Возвратить, анимирован ли художник.

get_antialiased()[source]

Получить состояние антиалиасинга для рендеринга.

Возвращает:

массив булевых значений

get_antialiaseds()[source]: Псевдоним для get_antialiased.

get_array()[source]

Возвратить массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

Возвратить стиль окончания для коллекции (для всех ее элементов).

Возвращает:

{'butt', 'projecting', 'round'} или None

get_children()[source]: Возвратить список дочерних Artist этого Artist.

get_clim()[source]: Возвратить значения (мин, макс), которые отображаются в пределы цветовой карты.

get_clip_box()[source]: Возвратить область обрезки.

get_clip_on()[source]: Возвратить, использует ли художник обрезку.

get_clip_path()[source]: Возвратить путь обрезки.

get_cmap()[source]: Возвратить экземпляр Colormap.

get_coordinates()[source]

Возвращает вершины сетки в виде массива (M+1, N+1, 2).

M, N — количество четырёхугольников в строках/столбцах сетки, соответствующих (M+1, N+1) вершинам. Последнее измерение определяет компоненты (x, y).

get_cursor_data(event)[source]

Возвращает данные курсора для заданного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов графического интерфейса. Скорее всего, пользователь Matplotlib не будет вызывать этот метод самостоятельно.

Данные курсора могут использоваться элементами графического интерфейса для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[source]: Псевдоним для get_linestyle.

get_datalim(transData)[source]

get_ec()[source]: Псевдоним для get_edgecolor.

get_edgecolor()[source]

get_edgecolors()[source]: Псевдоним для get_edgecolor.

get_facecolor()[source]

get_facecolors()[source]: Псевдоним для get_facecolor.

get_fc()[source]: Псевдоним для get_facecolor.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент графического интерфейса.

get_fill()[source]: Возвращает, закрашена ли фигура.

get_gid()[source]: Возвращает идентификатор группы.

get_hatch()[source]: Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает логическое значение, True если элемент графического интерфейса включён в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

{'miter', 'round', 'bevel'} или None

get_label()[source]: Возвращает метку, используемую для этого элемента графического интерфейса в легенде.

get_linestyle()[source]

get_linestyles()[source]: Псевдоним для get_linestyle.

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

get_mouseover()[source]: Возвращает значение, указывающее, запрашивается ли у этого элемента информация о контексте, когда курсор мыши находится над ним.

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает значение, указывающее, следует ли растровый вывод для элемента.

get_sizes()[source]

Возвращает размеры (площади) элементов в коллекции.

Возвращает:

массив: Площадь каждого элемента.

get_sketch_params()[source]

Возвращает параметры наброска для элемента.

Возвращает:

кортеж или None

3-кортеж с элементами:

масштаб: Амплитуда колебаний перпендикулярно исходной линии.
длина: Длина колебания вдоль линии.
случайность: Коэффициент масштабирования, с которым длина сжимается или расширяется.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает настройку приближения.

См. set_snap для подробностей.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает все операции обрезки.

Параметры:

rendererRendererBase подкласс, необязательно: объект отрисовки, который будет использоваться для рисования графиков (т.е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Охватывающая область (в пикселях координат рисунка). Возвращает None, если обрезка не приводит к пересечению.

get_transOffset()[source]: Псевдоним для get_offset_transform.

get_transform()[source]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[source]: Возвращает обрезной путь с применённой не-аффинной частью его преобразования и оставшейся аффинной частью преобразования.

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Гиперссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

Получает область определения объекта в пространстве отображения.

Ширина и высота области определения неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотной" области определения. По умолчанию возвращает пустую область определения в координатах 0, 0.

Будьте внимательны при использовании этой функции, результаты не обновятся, если область определения окна объекта изменится. Область определения может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но будут сохранены неправильно.

get_zorder()[source]: Возвращает порядок z объекта.

have_units()[source]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[source]

Возвращает, имеет ли объект явно заданное преобразование.

Это True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли у этого объекта пользовательская информация контекста, когда указатель мыши перемещается над ним.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний элемент-объект вызовет событие выбора, если mouseevent находится над объектом и у объекта установлен селектор.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, может ли объект быть выбран.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь со всеми свойствами объекта.

remove()[source]

Удалить графический объект из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim, чтобы обновить пределы осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена на оси с autolim = True.

Примечание: удаление записи легенды объекта не поддерживается.

remove_callback(oid)[source]

Удалить обработчик событий на основе его идентификатора наблюдателя.

См. также

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>, 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` или 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` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список кортежей
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или 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`	строка
`urls`	список строк или None
`verts`	список массивов

`verts_and_codes`	неизвестно
`visible`	bool
`zorder`	float

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, которая принимает массив float (m, n, глубина) и значение dpi, и возвращает массив (m, n, глубина) и два смещения от левого нижнего угла изображения

set_alpha(alpha)[source]

Установить значение альфа, используемое для смешивания - не поддерживается на всех бэкендах.

Параметры:

alphaмассив или скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

См. также matplotlib.animation и Более быстрое отображение с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[source]

Установить состояние антиалиасинга для рендеринга.

Параметры:

aabool или список bool

set_antialiaseds(aa)[source]: Псевдоним для set_antialiased.

set_array(A)[source]

Установить значения данных.

Параметры:

Aarray-like

Данные сетки. Поддерживаемые формы массива:

(M, N) или (M*N,): сетка со скалярными данными. Значения отображаются в цвета с помощью нормализации и цветовой карты. См. параметры norm, cmap, vmin, vmax.
(M, N, 3): изображение с значениями RGB (float 0-1 или int 0-255).
(M, N, 4): изображение с значениями RGBA (float 0-1 или int 0-255), т.е. включая прозрачность.

Если значения предоставляются в виде 2D сетки, форма должна соответствовать сетке координат. Если значения 1D, они преобразуются в 2D. M, N следуют из сетки координат, где форма сетки координат (M, N) для 'gouraud' shading и (M+1, N+1) для 'flat' shading.

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, элементы будут видны за пределами области построения, что может привести к непредвиденным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[source]

Установить область обрезки элемента.

Параметры:

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан Path, transform также должен быть задан. Если None, ранее установленная область обрезки удаляется.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит прямоугольник обрезки соответствующему прямоугольнику и установит область обрезки в None.

set_cmap(cmap)[source]

Установить цветовую карту для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[source]

Установить цвет контура и заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для отдельной настройки цвета контура или заливки.

set_dashes(ls)[source]: Псевдоним для set_linestyle.

set_ec(c)[source]: Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установить цвет(ы) контура коллекции.

Параметры:

cцвет или список цвета или 'face': Цвет(ы) контура коллекции. Если последовательность, фигуры циклически проходят по ней. Если 'face', соответствует цвету заливки.

set_edgecolors(c)[source]: Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Установить цвет(ы) заливки коллекции. c может быть цветом (все фигуры имеют один и тот же цвет) или последовательностью цветов; если это последовательность, фигуры циклически проходят по последовательности.

Если c равно 'none', фигура не будет заполнена.

Параметры:

cцвет или список цвета

set_facecolors(c)[source]: Псевдоним для set_facecolor.

set_fc(c)[source]: Псевдоним для set_facecolor.

set_figure(fig)[source]

Установите экземпляр Figure, к которому принадлежит элемент.

Параметры:

figFigure

set_gid(gid)[source]

Установите идентификатор группы (id) для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установите узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае все указанные узоры штриховки выполняются. Если одна и та же буква повторяется, это увеличивает плотность штриховки данного узора.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно задать только для всего набора, а не для каждого элемента по отдельности.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[source]

Установите, следует ли включать элемент в вычисления макета, например, для руководства по ограниченным макетам, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установите JoinStyle для набора (для всех его элементов).

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установите метку, которая будет отображаться в легенде.

Параметры:

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установите стиль(и) линии для набора.

linestyle	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж с делениями в формате:

(offset, onoffseq),

где onoffseq - кортеж чётной длины, содержащий значения отступов и толщины линий в пунктах.

Параметры:

lsстрока или кортеж или список кортежей: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Смотрите Line2D.set_linestyle для полного описания.

set_linestyles(ls)[source]: Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установите ширину линии(й) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, области будут циклически проходить по последовательности.

Параметры:

lwfloat или список float

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установить, запрашивается ли у этого элемента информация о контексте при наведении курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

Установить экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

Если какие-либо цветовые шкалы используют сопоставитель для этой нормализации, установка нормализации сопоставителя сбросит нормализация, локатор и форматеры цветовой шкалы по умолчанию.

set_offset_transform(offset_transform)[source]

Установить трансформирование смещения элемента.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

Установить смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(verts, closed=True)[source]

Установить вершины многоугольников.

Параметры:

vertsсписок array-like: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как 2D массив-подобный объект формы (M, 2).
closedbool, по умолчанию: True: Закрывать ли многоугольник добавлением подключения CLOSEPOLY в конце.

set_picker(picker)[source]

Определить поведение выбора элемента.

Параметры:

pickerNone или bool или float или вызываемый объект

Это может быть одним из следующих:

None: Выбор отключен для этого элемента (по умолчанию).
Булево значение: Если True, выбор будет включен, и элемент будет генерировать событие выбора, если курсор мыши находится над элементом.
Число с плавающей точкой: Если picker является числом, оно интерпретируется как допустимая погрешность в точках, и элемент будет генерировать событие, если его данные находятся в пределах погрешности от события мыши. Для некоторых элементов, таких как линии и коллекции объектов, элемент может предоставить дополнительные данные для события выбора, например, индексы данных в пределах погрешности от события выбора
Функция: Если picker является вызываемым объектом, это пользовательская функция, которая определяет, попадает ли элемент под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Установить радиус выбора, используемый для проверок попадания.

Параметры:

pickradiusfloat: Радиус выбора в точках.

set_rasterized(rasterized)[source]

Принудительно использовать растровый (битовое изображение) вывод для векторной графики.

Растровый вывод не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.

Это значение игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

Установить размеры каждого элемента в коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер для каждого элемента в коллекции. Значение — 'площадь' элемента.
dpifloat, по умолчанию: 72: Точки на дюйм холста.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:

scalefloat, необязательно

Амплитуда колебания перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина колебания вдоль линии в пикселях (по умолчанию 128.0).

randomnessfloat, необязательно

Коэффициент масштабирования, на который длина сжимается или расширяется (по умолчанию 16.0).

Модуль PGF использует этот аргумент как начальное значение генератора случайных чисел, а не так, как описано выше. Использование одного и того же значения семени приводит к одному и тому же случайному рисунку.

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]

Параметры:

urlsсписок str или None

Примечания

URL в настоящее время реализованы только для заднего плана SVG. Они игнорируются всеми другими задними планами.

set_verts(verts, closed=True)[source]

Установить вершины многоугольников.

Параметры:

vertsсписок массивов-подобных объектов: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массив-подобный объект формы (M, 2).
closedbool, по умолчанию: True: Закрыть ли многоугольник, добавив соединение CLOSEPOLY в конце.

set_verts_and_codes(verts, codes)[source]: Инициализировать вершины с кодами путей.

set_visible(b)[source]

Установить видимость объекта.

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок для объекта. Объекты с меньшими значениями z-порядка рисуются первыми.

Параметры:

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)[source]

Возвращает нормализованный массив RGBA, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий ndarray массив значений RGBA будет возвращён на основе нормализации и цветовой карты, установленных для этого ScalarMappable.

Есть один особый случай для обработки изображений, которые уже являются RGB или RGBA, например, таких, которые были прочитаны из файла изображения. Если x является ndarray с 3 измерениями, и последнее измерение равно 3 или 4, то оно будет обработано как массив RGB или RGBA, и никаких преобразований не будет выполнено. Массив может быть uint8, или это могут быть числа с плавающей точкой в диапазоне от 0 до 1; в противном случае будет поднято исключение ValueError. Любые значения NaN или замаскированные элементы будут установлены в 0 альфа-канал. Если последнее измерение равно 3, значение аргумента alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующий альфа-канал. ValueError будет поднято, если третье измерение не равно 3 или 4.

update(props)[source]

Обновить свойства этого объекта-художника из словаря props.

Parameters:

propsdict

update_from(other)[source]: Копирует свойства из other в self.

update_scalarmappable()[source]

Обновить цвета из массива отображаемого скаляра, если таковой имеется.

Присваивает цвета рёбрам и граням на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.QuadMesh(coordinates, *, antialiased=True, shading='flat', **kwargs)[source]

Bases: _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) массив-подобный объект: Вершины. coordinates[m, n] задаёт (x, y) координаты вершины (m, n).
antialiasedbool, по умолчанию: True
shading{'плоский', 'gouraud'}, по умолчанию: 'плоский'

Примечания

В отличие от других Collection, значение pickradius по умолчанию для QuadMesh равно 0, то есть contains проверяет, находится ли тестовая точка внутри любого из четырёхугольников сетки.

Параметры:

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 — кортеж чётной длины с длиной черного и белого отрезков в пунктах. Примеры см. в Стили линий.

capstyleCapStyle-подобный, по умолчанию: rcParams["patch.capstyle"]

Стиль окончания линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.

joinstyleJoinStyle-подобный, по умолчанию: rcParams["patch.joinstyle"]

Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.

antialiasedsbool или список bool, по умолчанию: 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 всякий раз, когда тестовая точка находится внутри одного из многоугольников, образованных контрольными точками пути в коллекции. С другой стороны, если она больше 0, мы вместо этого проверяем, находится ли тестовая точка внутри штриха шириной 2*pickradius по любому из путей в коллекции.

urlsсписок строк, по умолчанию: None

URL для каждого элемента, к которому можно перейти после отрисовки. В настоящее время работает только с бэкэндом SVG. Примеры см. в Ссылки.

zorderчисло с плавающей точкой, по умолчанию: 1

Порядок отрисовки, общий для всех фигур в коллекции. Примеры и значения по умолчанию см. в Демонстрация zorder.

**kwargs

Остальные ключевые аргументы будут использованы для задания свойств, как Collection.set_{key}(val) для каждой пары ключ-значение в kwargs.

add_callback(func)[source]

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает:

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позднее.

См. также

remove_callback

autoscale()[source]: Автомасштабирование пределов скалярного значения на экземпляре norm с помощью текущего массива

autoscale_None()[source]: Автомасштабирование пределов скалярного значения на экземпляре norm с помощью текущего массива, изменяя только пределы, которые равны None

propertyaxes: Экземпляр Axes, в котором находится объект художника, или None.

changed()[source]: Вызовите эту функцию всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей сигнала 'changed' callbackSM.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[source]

Проверить, произошло ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[source]

Преобразовать x с использованием типа единиц измерения оси x.

Если объект графического элемента не содержится в осях или у оси x нет единиц измерения, возвращается само значение x.

convert_yunits(y)[source]

Преобразовать y с использованием типа единиц измерения оси y.

Если объект графического элемента не содержится в осях или у оси y нет единиц измерения, возвращается само значение y.

draw(renderer)[source]

Отобразить графический элемент (и его дочерние элементы) с помощью данного рендерера.

Это не оказывает влияния, если графический элемент не видим (Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

Этот метод переопределён в подклассах графических элементов.

findobj(match=None, include_self=True)[source]

Найти объекты графических элементов.

Рекурсивно найти все экземпляры Artist, содержащиеся в графическом элементе.

Параметры:

match

Критерий фильтрации для совпадений. Может быть:

None: вернуть все объекты, содержащиеся в элементе.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только те графические элементы, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только графические элементы этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список для проверки на соответствие.

Возвращает:

список Artist

format_cursor_data(data)[source]

Возвращает строковое представление данных data.

Примечание

Этот метод предназначен для переопределения подклассами графических элементов. Пользователь Matplotlib, скорее всего, не будет вызывать этот метод самостоятельно.

Базовая реализация преобразует целые и плавающие числа, а также массивы целых и плавающих чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у графического элемента нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_aa()[source]: Псевдоним для get_antialiased.

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа, используемое для смешивания - не поддерживается во всех бэкендах.

get_animated()[source]: Возвращает, анимирован ли графический элемент.

get_antialiased()[source]

Получить состояние антиалиасинга для отрисовки.

Возвращает:

массив булевых значений

get_antialiaseds()[source]: Псевдоним для get_antialiased.

get_array()[source]

Возвращает массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

Возвращает стиль обрезки для коллекции (для всех её элементов).

Возвращает:

{'butt', 'projecting', 'round'} или None

get_children()[source]: Возвращает список дочерних элементов Artist данного элемента Artist.

get_clim()[source]: Возвращает значения (мин, макс), которые отображаются в пределы цветовой карты.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает, использует ли элемент обрезку.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_coordinates()[source]

Возвращает вершины сетки в виде массива (M+1, N+1, 2).

M, N — количество четырёхугольников в строках/столбцах сетки, соответствующие (M+1, N+1) вершинам. Последнее измерение определяет компоненты (x, y).

get_cursor_data(event)[source]

Возвращает данные указателя для данного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов. Скорее всего, пользователь Matplotlib не будет вызывать этот метод самостоятельно.

Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Единственный текущий случай использования — отображение значения z изображения AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[source]: Псевдоним для get_linestyle.

get_datalim(transData)[source]

get_ec()[source]: Псевдоним для get_edgecolor.

get_edgecolor()[source]

get_edgecolors()[source]: Псевдоним для get_edgecolor.

get_facecolor()[source]

get_facecolors()[source]: Псевдоним для get_facecolor.

get_fc()[source]: Псевдоним для get_facecolor.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[source]: Возвращает, закрашивается ли лицо.

get_gid()[source]: Возвращает идентификатор группы.

get_hatch()[source]: Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает булеву метку, True если графический элемент включён в вычисления макета.

Например, руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

{'miter', 'round', 'bevel'} или None

get_label()[source]: Возвращает метку, используемую для данного графического элемента в легенде.

get_linestyle()[source]

get_linestyles()[source]: Псевдоним для get_linestyle.

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

get_mouseover()[source]: Возвращает, запрашивается ли у этого графического элемента пользовательская информация о контексте, когда указатель мыши перемещается по нему.

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый этим смещенным графическим элементом.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора графического элемента.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, должен ли графический элемент быть растрированным.

get_sketch_params()[source]

Возвращает параметры штриховки для графического элемента.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.

Возвращает None, если параметры штриховки не были установлены.

get_snap()[source]

Возвращает значение параметра «привязка».

См. set_snap для подробностей.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:

rendererRendererBase подкласс, необязательно: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращаемое значение:

Bbox или None: Охватывающая область (в пикселях координат фигуры). Возвращает None, если обрезка приводит к отсутствию пересечения.

get_transOffset()[source]: Псевдоним для get_offset_transform.

get_transform()[source]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[source]: Возвращает путь обрезки с применённой не-аффинной частью преобразования и оставшейся аффинной частью преобразования.

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[source]: Возвращает значение видимости.

get_window_extent(renderer=None)[source]

Получает область объекта в пространстве отображения.

Ширина и высота области неотрицательны.

Подклассы должны переопределять для включения в вычисление «плотного» прямоугольника. По умолчанию возвращает пустую область в координатах 0, 0.

Будьте внимательны при использовании этой функции, результаты не обновятся, если область отображения объекта изменится. Область может измениться из-за любых изменений в стеке преобразований, например, при изменении пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся неправильно.

get_zorder()[source]: Возвращает порядок отрисовки объекта.

have_units()[source]: Возвращает, установлены ли единицы измерения на любой оси.

is_transform_set()[source]

Возвращает, задано ли преобразование для объекта.

Это True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли у этого объекта информация о контексте, когда курсор мыши перемещается над ним.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обрабатывает событие выбора.

Каждый дочерний объект вызовет событие выбора, если mouseevent находится над объектом и для объекта установлен параметр picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, является ли элемент графического объекта выбираемым.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь всех свойств графического объекта.

remove()[source]

Удаляет графический объект из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей можно вызвать relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.

Примечание: удаление записи легенды объекта не поддерживается.

remove_callback(oid)[source]

Удаляет обратный вызов на основе идентификатора наблюдателя.

См. также

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>, 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`	Функция фильтра, которая принимает массив float (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` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список кортежей
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или None
`offset_transform` или transOffset	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[source]

Установить значение альфа, используемое для смешивания - не поддерживается во всех бэкендах.

Параметры:

alphaмассив-подобный объект или скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

См. также matplotlib.animation и Ускорение отрисовки с помощью блиттинга.

Параметры:

bbool

set_antialiased(aa)[source]

Установить состояние антиалиасинга для отрисовки.

Параметры:

aabool или список bool

set_antialiaseds(aa)[source]: Псевдоним для set_antialiased.

set_array(A)[source]

Установить значения данных.

Параметры:

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), т.е. включая прозрачность.

Если значения предоставляются в виде 2D-сетки, форма должна соответствовать сетке координат. Если значения являются 1D, они преобразуются в 2D. M, N следуют из сетки координат, где форма сетки координат (M, N) для shading 'gouraud' и (M+1, N+1) для shading 'flat'.

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, необязательно: Используется только если path является Path. В этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит ограничивающую рамку соответствующего прямоугольника и задаст область обрезки в None.

set_cmap(cmap)[source]

Установить цветовую карту для данных яркости.

Параметры:

cmapColormap или строка или None

set_color(c)[source]

Установить цвет границ и заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета границ или заливки индивидуально.

set_dashes(ls)[source]: Псевдоним для set_linestyle.

set_ec(c)[source]: Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установить цвет(а) границ коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет(а) границ коллекции. Если это последовательность, фигуры будут циклически использовать цвета из неё. Если 'face', цвета будут соответствовать цвету заливки.

set_edgecolors(c)[source]: Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Установить цвет(а) заливки коллекции. c может быть цветом (у всех фигур одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать цвета из неё.

Если c равно 'none', фигура не будет закрашена.

Параметры:

cцвет или список цветов

set_facecolors(c)[source]: Псевдоним для set_facecolor.

set_fc(c)[source]: Псевдоним для set_facecolor.

set_figure(fig)[source]

Установите экземпляр Figure, к которому принадлежит элемент.

Параметры:

figFigure

set_gid(gid)[source]

Установите идентификатор (группы) для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать, в этом случае выполняются все указанные штриховки. Если буква повторяется, плотность штриховки этого узора увеличивается.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всего набора, а не для каждого члена по отдельности.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[source]

Установить, следует ли включать элемент в расчёты макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установить стиль соединения JoinStyle для набора (для всех его элементов).

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установить метку, которая будет отображаться в легенде.

Параметры:

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установить стиль линии(ей) для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	штриховая линия

В качестве альтернативы можно указать кортеж с последовательностью точек в следующей форме:

(offset, onoffseq),

где onoffseq — это кортеж чётной длины, содержащий отступы и длины штрихов в пунктах.

Параметры:

lsстрока или кортеж или список кортежей: Допустимые значения для отдельных стилей линии включают {'-', '--', '-.', ':', '', (смещение, последовательность вкл/выкл)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[source]: Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установить ширину линии(й) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, элементы будут циклически отображаться через последовательность.

Параметры:

lwчисловое значение или список числовых значений

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Устанавливает, запрашивается ли у данного элемента пользовательская информация контекста при перемещении курсора мыши.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

Устанавливает экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

Если какие-либо цветовые шкалы используют сопоставитель для этой нормализации, установка нормализации сопоставителя сбросит нормализацию, локатор и форматировщики цветовой шкалы по умолчанию.

set_offset_transform(offset_transform)[source]

Устанавливает трансформацию смещения элемента.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

Устанавливает смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массивоподобный объект

set_path_effects(path_effects)[source]

Устанавливает эффекты траекторий.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths()[source]

set_picker(picker)[source]

Определяет поведение выбора элемента.

Параметры:

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующего:

None: Выбор отключён для данного элемента (по умолчанию).
Булево значение: Если True, то выбор будет включён, и элемент будет генерировать событие выбора, если курсор мыши находится над ним.
Число с плавающей точкой: Если picker является числом, оно интерпретируется как допускаемая погрешность в точках, и элемент будет генерировать событие, если его данные находятся в пределах погрешности от события мыши. Для некоторых элементов, таких как линии и коллекции участков, элемент может предоставить дополнительные данные для события выбора, например, индексы данных в пределах погрешности от события выбора
Вызываемый объект: Если picker является вызываемым объектом, это пользовательская функция, которая определяет, попадает ли элемент под действие события мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True, а props - словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Устанавливает радиус выбора, используемый для проверок принадлежности.

Параметры:

pickradiusfloat: Радиус выбора в точках.

set_rasterized(rasterized)[source]

Принудительное растрирование (отображение растровым изображением) для вывода векторной графики.

Растрирование не поддерживается всеми элементами. Если вы попытаетесь включить это для элемента, который его не поддерживает, команда не повлияет, и будет выведено сообщение об ошибке.

Это настройка игнорируется для вывода на основе пикселей.

См. также Растрирование для векторной графики.

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Устанавливает параметры наброска.

Параметры:

scalefloat, необязательно

Амплитуда колебания перпендикулярно исходной линии в пикселях. Если scale равен None или не указан, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина колебания вдоль линии в пикселях (по умолчанию 128.0).

randomnessfloat, необязательно

Коэффициент масштабирования, по которому длина уменьшается или увеличивается (по умолчанию 16.0).

Backend PGF использует это аргумент в качестве семени генератора случайных чисел, а не как описано выше. Использование одного и того же семени даёт одну и ту же случайную форму.

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]

Параметры:

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установить видимость художника.

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок художника. Художники с меньшими значениями z-порядка рисуются первыми.

Параметры:

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)[source]

Возвращает нормализованный массив RGBA, соответствующий x.

В обычном случае x является 1D или 2D последовательностью скаляров, и соответствующий ndarray значений RGBA будет возвращён на основе установленной нормы и цветовой карты для этого ScalarMappable.

Существует один особый случай для обработки изображений, которые уже являются RGB или RGBA, например, таких, которые были прочитаны из файла изображения. Если x — это ndarray с 3 измерениями, и последнее измерение равно 3 или 4, то оно будет обрабатываться как массив RGB или RGBA, и никакое отображение не будет выполняться. Массив может быть uint8, или он может быть числами с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Любые NaN или замаскированные элементы будут установлены в 0 альфа. Если последнее измерение равно 3, значение аргумента alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующую прозрачность. Будет поднято исключение ValueError, если третье измерение отличается от 3 или 4.

update(props)[source]

Обновить свойства этого художника из словаря props.

Параметры:

propsdict

update_from(other)[source]: Копировать свойства из other в self.

update_scalarmappable()[source]

Обновить цвета из массива отображаемого скалярного значения, если таковой имеется.

Присвоить цвета к границам и граням на основе массива и/или цветов, которые были непосредственно заданы, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.RegularPolyCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[source]

Bases: _CollectionWithSizes

A collection of n-sided regular polygons.

Parameters:

numsidesint: Количество сторон многоугольника.
rotationfloat: Поворот многоугольника в радианах.
sizestuple of float: Площадь окружности, описанной вокруг многоугольника, в точках^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)[source]

Добавляет функцию обратного вызова, которая вызывается всякий раз, когда изменяется одно из свойств Artist.

Parameters:

funccallable

Функция обратного вызова. Она должна иметь следующий вид:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Возвращаемые значения могут существовать, но игнорируются.

Returns:

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback в дальнейшем.

См. также

remove_callback

autoscale()[source]: Автомасштабирует пределы скалярных величин на объекте norm с использованием текущего массива.

autoscale_None()[source]: Автомасштабирует пределы скалярных величин на объекте norm с использованием текущего массива, изменяя только пределы, которые равны None.

propertyaxes: Объект Axes, в котором находится элемент, или None.

changed()[source]: Вызывается при изменении объекта mappable, чтобы уведомить все слушатели сигнала «изменено».

colorbar: Последняя связанная с этим ScalarMappable цветовая шкала. Может быть None.

contains(mouseevent)[source]

Проверяет, произошел ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[source]

Преобразует x с использованием типа единиц оси x.

Если элемент не содержится в Axes или у оси x нет единиц, возвращается само x.

convert_yunits(y)[source]

Преобразует y с использованием типа единиц оси y.

Если элемент не содержится в Axes или у оси y нет единиц, возвращается само y.

draw(renderer)[source]

Отображает элемент (и его дочерние элементы) с помощью заданного рендерера.

Не имеет эффекта, если элемент не виден (Artist.get_visible возвращает False).

Parameters:

rendererRendererBase подкласс.

Примечания

Этот метод переопределен в подклассах Artist.

findobj(match=None, include_self=True)[source]

Находит объекты элементов.

Рекурсивно находит все Artist экземпляры, содержащиеся в элементе.

Parameters:

match

Критерий фильтрации совпадений. Это может быть

None: Возвращает все объекты, содержащиеся в элементе.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (isinstance проверка).

include_selfbool

Включить self в список для проверки соответствия.

Returns:

список Artist

format_cursor_data(data)[source]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах графических объектов. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми и заключённую в квадратные скобки, если у графического элемента нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_aa()[source]: Псевдоним для get_antialiased.

get_agg_filter()[source]: Возвращает функцию фильтра для использования в фильтре agg.

get_alpha()[source]: Возвращает значение альфа-канала для смешивания цветов - не поддерживается на всех бэкендах.

get_animated()[source]: Возвращает, анимирован ли графический элемент.

get_antialiased()[source]

Получить состояние антиалиасинга для рендеринга.

Возвращает:

массив булевых значений

get_antialiaseds()[source]: Псевдоним для get_antialiased.

get_array()[source]

Возвращает массив значений, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

Возвращает стиль окончания отрезков для коллекции (для всех её элементов).

Возвращает:

{'butt', 'projecting', 'round'} или None

get_children()[source]: Возвращает список дочерних элементов Artist этого объекта Artist.

get_clim()[source]: Возвращает значения (мин, макс), которые сопоставляются с пределами цветовой карты.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает, использует ли графический элемент обрезку.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные курсора для данного события.

Примечание

Данные курсора могут использоваться графическими элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.

Подклассы могут переопределить метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что format_cursor_data может преобразовать данные в строковое представление.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[source]: Псевдоним для get_linestyle.

get_datalim(transData)[source]

get_ec()[source]: Псевдоним для get_edgecolor.

get_edgecolor()[source]

get_edgecolors()[source]: Псевдоним для get_edgecolor.

get_facecolor()[source]

get_facecolors()[source]: Псевдоним для get_facecolor.

get_fc()[source]: Псевдоним для get_facecolor.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[source]: Возвращает значение, указывающее, закрашена ли область.

get_gid()[source]: Возвращает идентификатор группы.

get_hatch()[source]: Возвращает текущий шаблон штриховки.

get_in_layout()[source]

Возвращает логическое значение, True указывающее, включён ли элемент в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

{'miter', 'round', 'bevel'} или None

get_label()[source]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[source]

get_linestyles()[source]: Псевдоним для get_linestyle.

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

get_mouseover()[source]: Возвращает, запрашивается ли у этого объекта информация о контексте при перемещении курсора мыши над ним.

get_numsides()[source]

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый этим объектом для смещения.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора объекта.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, должен ли объект быть растрированным.

get_rotation()[source]

get_sizes()[source]

Возвращает размеры ('площади') элементов в коллекции.

Возвращает:

массив: Площадь каждого элемента.

get_sketch_params()[source]

Возвращает параметры наброска для объекта.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, с которым длина сжимается или растягивается.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает установку "привязки".

Подробности см. в set_snap.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:

rendererRendererBase подкласс, необязательно: рендерер, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Охватывающая рамка (в пикселях координат фигуры). Возвращает None, если обрезка приводит к отсутствию пересечения.

get_transOffset()[source]: Псевдоним для get_offset_transform.

get_transform()[source]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[source]: Возвращает обрезной путь с применённой к нему частью преобразования, не связанной с аффином, и оставшейся аффинной частью преобразования.

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

Получает прямоугольник ограничивающей рамки объекта в пространстве отображения.

Ширина и высота ограничивающей рамки неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотного" ограничивающего прямоугольника. По умолчанию возвращается пустой прямоугольник в координатах 0, 0.

Будьте внимательны при использовании этой функции; результаты не обновятся, если прямоугольник ограничивающей рамки объекта изменится. Ограничивающий прямоугольник может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов оси, размера фигуры или используемого холста (как при сохранении изображения). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder()[source]: Возвращает порядок объекта по z.

have_units()[source]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[source]

Возвращает, задано ли преобразование для объекта.

Это True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли у данного объекта информация о контексте при перемещении курсора мыши по нему.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри, когда свойство изменено.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обрабатывает событие выбора.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, можно ли выбрать объект.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь всех свойств объекта.

remove()[source]

Удаляет объект из фигуры, если это возможно.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к оси с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта.

remove_callback(oid)[source]

Удалить обработчик на основе его идентификатора наблюдателя.

См. также

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>, 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>)[source]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (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` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список таковых
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или 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`	строка
`urls`	список строк или None

`visible`	bool
`zorder`	float

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, которая принимает массив float с размерами (m, n, глубина) и значение dpi, и возвращает массив (m, n, глубина) и два смещения от нижнего левого угла изображения.

set_alpha(alpha)[source]

Установить значение альфа для смешивания — не поддерживается во всех бэкендах.

Параметры:

alphaмассив-подобный объект, скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли объект для использования в анимации.

Если True, объект исключается из обычного рисования фигуры. Вам нужно явно вызвать Figure.draw_artist / Axes.draw_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, 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, необязательно: Используется только если path является Path, в этом случае указанный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит прямоугольную область обрезки и установит путь обрезки в None.

set_cmap(cmap)[source]

Установить цветовую карту для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[source]

Установить цвет обводки и заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для самостоятельного задания цвета обводки или заливки.

set_dashes(ls)[source]: Псевдоним для set_linestyle.

set_ec(c)[source]: Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установить цвет обводки коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет обводки коллекции. Если последовательность, фигуры циклически используют её значения. Если 'face', соответствует цвету заливки.

set_edgecolors(c)[source]: Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Если c равно 'none', фигура не будет закрашена.

Параметры:

cцвет или список цветов

set_facecolors(c)[source]: Псевдоним для set_facecolor.

set_fc(c)[source]: Псевдоним для set_facecolor.

set_figure(fig)[source]

Установите экземпляр Figure, к которому относится объект.

Параметры:

figFigure

set_gid(gid)[source]

Установите идентификатор (группы) для объекта.

Параметры:

gidstr

set_hatch(hatch)[source]

Установите шаблон штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняется вся указанная штриховка. Если одна и та же буква повторяется, плотность штриховки этого рисунка увеличивается.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[source]

Установите, должен ли объект включаться в вычисления макета, например, в руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установите JoinStyle для набора (для всех его элементов).

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установите метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)[source]

Установите стиль(и) линии для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрих-пунктирная линия
`':'` или `'dotted'`	штриховая линия

В качестве альтернативы можно указать кортеж с черточками в следующем формате:

(offset, onoffseq),

где onoffseq — кортеж чётной длины с отступами и включениями в точках.

Параметры:

lsстрока или кортеж или список таких кортежей: Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включений-выключений)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[source]: Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установите ширину(ы) линии для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности.

Параметры:

lwвещественное число или список вещественных чисел

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установите, запрашивается ли у этого элемента пользовательская информация о контексте, когда курсор мыши наведён на него.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

Установите экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

Если для этой нормализации используются какие-либо цветовые шкалы, установка нормализации для отображаемого объекта сбросит нормализацию, локатор и форматеры цветовой шкалы по умолчанию.

set_offset_transform(offset_transform)[source]

Установите трансформирование смещения элемента.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

Установите смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(paths)[source]

set_picker(picker)[source]

Определить поведение выбора элемента.

Параметры:

pickerNone или bool или float или вызываемая функция

Может быть одним из следующих:

None: Выбор отключён для данного элемента (по умолчанию).
Булево значение: Если True, то выбор включён, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
Число с плавающей точкой: Если значение picker является числом, оно интерпретируется как допустимая погрешность в точках, и элемент сгенерирует событие, если его данные находятся в пределах погрешности от события мыши. Для некоторых элементов, таких как линии и коллекции объектов, элемент может предоставить дополнительные данные событию выбора, например, индексы данных, находящихся в пределах погрешности от события выбора
Вызываемая функция: Если picker — вызываемая функция, это функция, предоставляемая пользователем, которая определяет, попадает ли элемент под действие события мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения тестирования на попадание. Если курсор мыши находится над элементом, вернуть hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Установите радиус выбора, используемый для проверок включения.

Параметры:

pickradiusfloat: Радиус выбора, в точках.

set_rasterized(rasterized)[source]

Принудительно использовать растрирование (отображение битовой карты) для выходных данных векторной графики.

Растрирование не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не сработает, и будет выведено предупреждение.

Это свойство игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

Установите размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер, который нужно установить для каждого элемента коллекции. Значение — это 'площадь' элемента.
dpifloat, по умолчанию: 72: Разрешение холста.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:

scalefloat, необязательно

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, с которым длина сжимается или расширяется (по умолчанию 16.0)

Бэкенд PGF использует это аргумент как семя генератора случайных чисел, а не как описано выше. Использование одного и того же семени приводит к одинаковой случайной форме.

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]

Параметры:

urlsсписок str или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установить видимость художника.

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок художника. Художники с меньшими значениями z-порядка рисуются первыми.

Параметры:

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 — это одномерная или двумерная последовательность скаляров, и соответствующий массив RGBA будет возвращен на основе нормализации и цветовой карты, установленных для этого объекта ScalarMappable.

Есть один особый случай для обработки изображений, которые уже находятся в формате RGB или RGBA, например, прочитанных из файла изображения. Если x — это массив NumPy с тремя измерениями, а последнее измерение равно 3 или 4, то он будет обрабатываться как массив RGB или RGBA, и никакой обработки отображения не будет выполняться. Массив может быть типа uint8 или числами с плавающей точкой в диапазоне от 0 до 1; в противном случае будет вызвано исключение ValueError. Любые значения NaN или замаскированные элементы будут установлены с альфой 0. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет уже существующую альфу. Будет вызвано исключение ValueError, если третье измерение не равно 3 или 4.

В любом случае, если bytes имеет значение False (по умолчанию), массив RGBA будет числами с плавающей точкой в диапазоне от 0 до 1; если оно имеет значение True, возвращаемый массив RGBA будет типа uint8 в диапазоне от 0 до 255.

Если norm имеет значение False, нормализация входных данных не выполняется, и предполагается, что она находится в диапазоне от 0 до 1.

update(props)[source]

Обновляет свойства этого объекта из словаря props.

Parameters:

propsdict

update_from(other)[source]: Копирует свойства из other в себя.

update_scalarmappable()[source]

Обновляет цвета из массива отображения скаляров, если таковой имеется.

Присваивает цвета границам и граням на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.StarPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[source]

Bases: RegularPolyCollection

Отрисовка коллекции правильных звезд с numsides точками.

Параметры:

numsidesint: Количество сторон многоугольника.
rotationfloat: Поворот многоугольника в радианах.
sizesкортеж float: Площадь окружности, описанной вокруг многоугольника, в точках^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)[source]

Параметры:

funccallable

Функция обратного вызова. Она должна иметь следующий прототип:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращаемое значение:

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[source]: Автоматическое масштабирование пределов скаляра на экземпляре нормы, используя текущий массив

autoscale_None()[source]: Автоматическое масштабирование пределов скаляра на экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None

propertyaxes: Экземпляр Axes, в котором находится художник, или None.

changed()[source]: Вызовите это, когда карта изменяется, чтобы уведомить всех слушателей обратного вызова об изменении сигнала 'changed'.

colorbar: Последняя цветная шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[source]

Проверка, произошёл ли сдвиг мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[source]

Преобразование x с использованием типа единиц оси x.

Если художник не содержится в Axes или ось x не имеет единиц, возвращается x сам по себе.

convert_yunits(y)[source]

Преобразование y с использованием типа единиц оси y.

Если художник не содержится в Axes или ось y не имеет единиц, возвращается y сам по себе.

draw(renderer)[source]

Отрисовка элемента (и его дочерних элементов) с помощью заданного рендерера.

Это не повлияет, если элемент не виден (Artist.get_visible возвращает False).

Параметры:

rendererRendererBase подкласс.

Примечания

Этот метод переопределён в подклассах художника.

findobj(match=None, include_self=True)[source]

Поиск элементов художника.

Рекурсивный поиск всех Artist экземпляров, содержащихся в художнике.

Параметры:

match

Критерий фильтрации результатов. Может быть

None: вернуть все элементы, содержащиеся в художнике.
Функция с прототипом def match(artist: Artist) -> bool. Результат будет содержать только те элементы художника, для которых функция вернула True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы художника этого класса или его подклассов (isinstance проверка).

include_selfbool

Включить self в список, подлежащий проверке на соответствие.

Возвращаемое значение:

Список Artist

format_cursor_data(data)[source]

Возвращает строковое представление данных data.

Примечание

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у элемента нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.

См. также

get_cursor_data

get_aa()[source]: Псевдоним для get_antialiased.

get_agg_filter()[source]: Возвращает функцию фильтра, используемую для фильтра agg.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешения. Не поддерживается на всех бэкэндах.

get_animated()[source]: Возвращает, анимирован ли элемент.

get_antialiased()[source]

Возвращает состояние антиалиасинга для рендеринга.

Возвращает:

массив булевых значений

get_antialiaseds()[source]: Псевдоним для get_antialiased.

get_array()[source]

Возвращает массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

Возвращает стиль окончания для коллекции (для всех её элементов).

Возвращает:

{'butt', 'projecting', 'round'} или None

get_children()[source]: Возвращает список дочерних элементов Artist этого Artist.

get_clim()[source]: Возвращает значения (мин, макс), которые отображаются в пределы цветовой карты.

get_clip_box()[source]: Возвращает ограничивающую рамку.

get_clip_on()[source]: Возвращает, использует ли элемент обрезку.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные курсора для данного события.

Примечание

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика при перемещении курсора.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[source]: Псевдоним для get_linestyle.

get_datalim(transData)[source]

get_ec()[source]: Псевдоним для get_edgecolor.

get_edgecolor()[source]

get_edgecolors()[source]: Псевдоним для get_edgecolor.

get_facecolor()[source]

get_facecolors()[source]: Псевдоним для get_facecolor.

get_fc()[source]: Псевдоним для get_facecolor.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[source]: Возвращает, закрашен ли лицевой элемент.

get_gid()[source]: Возвращает идентификатор группы.

get_hatch()[source]: Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает флаг булевого типа, True указывает, включён ли элемент в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращаемое значение:

{'miter', 'round', 'bevel'} или None

get_label()[source]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[source]

get_linestyles()[source]: Псевдоним для get_linestyle.

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

get_mouseover()[source]: Возвращает, запрашивается ли у этого объекта информация о контексте, когда курсор мыши наводится на него.

get_numsides()[source]

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого объекта.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора объекта.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, должен ли объект быть растрированным.

get_rotation()[source]

get_sizes()[source]

Возвращает размеры (площади) элементов в коллекции.

Возвращает:

массив: Площадь каждого элемента.

get_sketch_params()[source]

Возвращает параметры наброска для объекта.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, по которому длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были заданы.

get_snap()[source]

Возвращает настройку привязки.

Подробности см. в set_snap.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:

rendererRendererBase подкласс, необязательно: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Охватывающая область (в пикселях координат фигуры). Возвращает None, если обрезка приводит к отсутствию пересечения.

get_transOffset()[source]: Псевдоним для get_offset_transform.

get_transform()[source]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[source]: Возвращает обрезной путь со применённой не-аффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Гиперссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

Получает область определения элемента в пространстве отображения.

Ширина и высота области определения неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотной" области определения. По умолчанию возвращается пустая область определения в (0, 0).

Будьте осторожны при использовании этой функции, результаты не обновляются, если область определения элемента изменяется. Область определения может изменяться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или холста (как это делается при сохранении фигуры). Это может привести к непредсказуемому поведению, где интерактивные фигуры будут выглядеть нормально на экране, но будут сохраняться неправильно.

get_zorder()[source]: Возвращает порядок элемента по z.

have_units()[source]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[source]

Возвращает, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли у этого элемента информация о контексте при перемещении курсора мыши над ним.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри, когда свойство изменено.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обрабатывает событие выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и для элемента установлен picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, может ли элемент быть выбранным.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь со всеми свойствами элемента.

remove()[source]

Удаляет элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей при необходимости вызовите relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[source]

Удалить обработчик на основе его идентификатора наблюдателя.

См. также

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>, 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>)[source]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (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` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список кортежей
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или 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`	строка
`urls`	список строк или None

`visible`	bool
`zorder`	float

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funccallable: Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения

set_alpha(alpha)[source]

Установить значение альфы, используемое для смешивания - не поддерживается во всех бэкендах.

Параметры:

alphaмассив-подобный или скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли элемент для использования в анимации.

Если True, элемент исключается из обычного рисования фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_artist на элементе. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Более быстрое отображение с помощью blitting.

Параметры:

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, vmaxfloat

Пределы.

Пределы также можно передать как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(clipbox)[source]

Установить область обрезки элемента.

Параметры:

clipboxBbox или 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, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и задаст путь обрезки в None.

set_cmap(cmap)[source]

Установить цветовую карту для данных яркости.

Параметры:

cmapColormap или строка или None

set_color(c)[source]

Установить цвет границы и заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета границы или заливки по отдельности.

set_dashes(ls)[source]: Псевдоним для set_linestyle.

set_ec(c)[source]: Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установить цвет(ы) границы коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет(ы) границы коллекции. Если последовательность, фигуры циклически просматривают ее. Если 'face', соответствуют цвету заливки.

set_edgecolors(c)[source]: Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Если c равно 'none', фигура не будет закрашена.

Параметры:

cцвет или список цветов

set_facecolors(c)[source]: Псевдоним для set_facecolor.

set_fc(c)[source]: Псевдоним для set_facecolor.

set_figure(fig)[source]

Установить экземпляр Figure, к которому принадлежит элемент.

Параметры:

figFigure

set_gid(gid)[source]

Установить идентификатор (группы) элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установить шаблон штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого шаблона.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всего набора, а не для каждого отдельного члена.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[source]

Установить, будет ли элемент включаться в расчёт макета, например, в руководстве по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установить JoinStyle для набора (для всех его элементов).

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установить метку, которая будет отображаться в легенде.

Параметры:

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установить стиль(и) линии для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы может быть предоставлена кортеж делений в следующем формате:

(offset, onoffseq),

где onoffseq - кортеж чётной длины, содержащий значения включения и выключения чернил в пунктах.

Параметры:

lsстрока или кортеж или список кортежей: Допустимые значения для индивидуальных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения)}. Подробное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[source]: Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установить толщину(ы) линии для набора. lw может быть скалярным значением или последовательностью; если это последовательность, фигуры будут циклически проходить по этой последовательности.

Параметры:

lwчисло или список чисел

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установить, запрашивается ли у данного элемента информация о контексте, когда курсор мыши наводится на него.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

Установить экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

Если какие-либо полосы цвета используют mappable для этой нормализации, то установка нормализации mappable сбросит нормализация, локали и форматеры полосы цвета на значения по умолчанию.

set_offset_transform(offset_transform)[source]

Установить преобразование смещения элемента.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

Установить смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установить эффекты для пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(paths)[source]

set_picker(picker)[source]

Определение поведения выбора для элемента.

Параметры:

pickerNone или bool или float или вызываемый объект

Может быть одним из следующего:

None: Выбор отключен для данного элемента (по умолчанию).
boolean: Если True, то выбор будет включен, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
float: Если picker является числом, оно интерпретируется как толеранс в точках, и элемент сгенерирует событие, если данные находятся в пределах толерантности от события мыши. Для некоторых элементов, таких как линии и коллекции фигур, элемент может предоставить дополнительные данные в событие выбора, например, индексы данных, находящихся в пределах толерантности от события выбора
функция: Если picker является вызываемым объектом, это функция пользователя, определяющая, попадает ли элемент под указание мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над элементом, вернуть hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Установить радиус выбора, используемый для проверок нахождения внутри.

Параметры:

pickradiusfloat: Радиус выбора, в точках.

set_rasterized(rasterized)[source]

Принудительное растрирование (отображение растровыми изображениями) для выходных данных векторной графики.

Это значение игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры:

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

Установить размеры каждого элемента коллекции.

Параметры:

sizesnumpy.ndarray или None: Размер для установки для каждого элемента коллекции. Значение — это 'площадь' элемента.
dpifloat, по умолчанию: 72: dpi холста.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установите параметры эскиза.

Параметры:

scalefloat, необязательно

Амплитуда колебания перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр эскиза не будет применён.

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]

Параметры:

urlsсписок str или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установить видимость объекта.

Параметры:

bbool

set_zorder(level)[source]

Установить порядок z для объекта. Объекты с меньшими значениями zorder выводятся первыми.

Параметры:

levelfloat

propertystale: Является ли объект 'stale' и требуется ли его повторная отрисовка, чтобы вывод соответствовал внутреннему состоянию объекта.

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)[source]

Возвращает массив RGBA, соответствующий x, в нормализованном формате.

В обычном случае, x — это одномерная или двумерная последовательность скаляров, и соответствующий массив RGBA будет возвращен на основе нормализации и цветовой карты, заданных для этого ScalarMappable.

Существует один специальный случай для обработки изображений, которые уже находятся в формате RGB или RGBA, например, прочитанных из файла изображения. Если x является массивом NumPy с тремя измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив RGB или RGBA, и никакое отображение не будет выполнено. Массив может быть uint8, или он может содержать числа с плавающей точкой в диапазоне от 0 до 1; в противном случае будет поднято исключение ValueError. Любые значения NaN или замаскированные элементы будут установлены в 0 для альфа-канала. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использовано для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет существующий альфа-канал. ValueError будет поднято, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив RGBA будет числами с плавающей точкой в диапазоне от 0 до 1; если оно равно True, возвращаемый массив RGBA будет uint8 в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне от 0 до 1.

update(props)[source]

Обновляет свойства этого объекта из словаря props.

Parameters:

propsdict

update_from(other)[source]: Копирует свойства из other в self.

update_scalarmappable()[source]

Обновляет цвета из массива отображения скаляров, если таковой имеется.

Назначает цвета границам и граням на основе массива и/или непосредственно установленных цветов, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.TriMesh(triangulation, **kwargs)[source]

Bases: Collection

Класс для эффективного рисования треугольной сетки с использованием затенения Гуро.

Треугольная сетка — это объект Triangulation.

Параметры:

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 — кортеж чётной длины длин штрихов и пауз в пунктах. Примеры см. в Стилях линий.

capstyleCapStyle-подобное, по умолчанию: rcParams["patch.capstyle"]

Стиль обрезки линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.

joinstyleJoinStyle-подобное, по умолчанию: rcParams["patch.joinstyle"]

Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.

antialiasedsбулево значение или список булевых значений, по умолчанию: rcParams["patch.antialiased"] (по умолчанию: True)

Определяет, следует ли рисовать каждый фрагмент коллекции с сглаживанием.

offsets(число, число) или список таковых, по умолчанию: (0, 0)

Вектор для смещения каждого фрагмента после отрисовки (по умолчанию — без смещения). Смещение выполняется в координатах экрана (пикселей) (т.е. после применения преобразования художника).

offset_transformTransform, по умолчанию: IdentityTransform

Преобразование, которое будет применено к каждому вектору offsets перед его использованием.

cmap, norm

Параметры нормализации данных и сопоставления цветов. Подробное описание см. в ScalarMappable.

hatchстрока, необязательно

Шаблон штриховки для использования в залитых путях, если таковые имеются. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Значение каждого типа штриховки см. в Справочнике по стилям штриховки.

pickradiusчисловое значение, по умолчанию: 5.0

Если pickradius <= 0, то Collection.contains вернёт True всякий раз, когда тестовая точка находится внутри одного из многоугольников, образованных контрольными точками пути в коллекции. С другой стороны, если значение больше 0, то мы вместо этого проверяем, находится ли тестовая точка внутри штриха шириной 2*pickradius вдоль любого из путей в коллекции.

urlsсписок строк, по умолчанию: None

URL для каждого фрагмента, чтобы связать его с элементом после отрисовки. В настоящее время работает только с SVG-бекендом. Примеры см. в Ссылках.

zorderчисловое значение, по умолчанию: 1

Порядок отрисовки, общий для всех фрагментов в коллекции. Примеры и значения по умолчанию см. в Демонстрации Zorder.

**kwargs

Остальные именованные аргументы будут использованы для установки свойств как Collection.set_{key}(val) для каждой пары ключ-значение в kwargs.

add_callback(func)[source]

Добавить функцию обратного вызова, которая будет вызвана всякий раз, когда меняется одно из свойств Artist.

Параметры:

funcвызываемый объект

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает:

целое число: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[source]: Автомасштабирование пределов скалярных значений на экземпляре norm с использованием текущего массива

autoscale_None()[source]: Автомасштабирование пределов скалярных значений на экземпляре norm с использованием текущего массива, изменяя только отсутствующие пределы

свойствоaxes: Экземпляр Axes, в котором находится элемент, или None.

changed()[source]: Вызывается всякий раз, когда изменяется mappable, чтобы уведомить все слушатели обратного вызова 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[source]

Проверка, произошла ли в коллекции событие мыши.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

статическийconvert_mesh_to_paths(tri)[source]

Преобразование данной сетки в последовательность объектов Path.

Эта функция предназначена в первую очередь для разработчиков бэкэндов, которые не поддерживают сетки напрямую.

END_OF_DOCUMENT_MARKER

convert_xunits(x)[source]

Преобразовать x с использованием типа единиц измерения оси x.

Если объект-графический элемент не находится в области Axes или ось x не имеет единиц измерения, возвращается x.

convert_yunits(y)[source]

Преобразовать y с использованием типа единиц измерения оси y.

Если объект-графический элемент не находится в области Axes или ось y не имеет единиц измерения, возвращается y.

draw(renderer)[source]

Отрисовать элемент графика (и его дочерние элементы) с использованием данного рендерера.

Это не оказывает никакого влияния, если элемент графика не видим (Artist.get_visible возвращает False).

Параметры:

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах элементов графика.

findobj(match=None, include_self=True)[source]

Найти объекты элементов графика.

Рекурсивно найти все экземпляры Artist, содержащиеся в элементе графика.

Параметры:

match

Критерий фильтра для совпадений. Это может быть

None: Вернуть все объекты, содержащиеся в элементе графика.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы графика, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы графика этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список, который будет проверяться на соответствие.

Возвращает:

список Artist

format_cursor_data(data)[source]

Вернуть строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами элементов графика. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа и массивы целых и вещественных чисел в строку, разделенную запятыми, заключённую в квадратные скобки, если элемент графика не имеет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью формата цветовой шкалы.

См. также

get_cursor_data

get_aa()[source]: Псевдоним для get_antialiased.

get_agg_filter()[source]: Возвращает функцию фильтра, которая должна использоваться для фильтра agg.

get_alpha()[source]: Возвращает значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

get_animated()[source]: Возвращает, анимирован ли элемент графика.

get_antialiased()[source]

Получить состояние антиалиасинга для рендеринга.

Возвращает:

массив булевых значений

get_antialiaseds()[source]: Псевдоним для get_antialiased.

get_array()[source]

Возвращает массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

Возвращает стиль обрезки для коллекции (для всех её элементов).

Возвращает:

{'butt', 'projecting', 'round'} или None

get_children()[source]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[source]: Возвращает значения (минимум, максимум), которые отображаются в пределы цветовой карты.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает, использует ли объект обрезку.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные курсора для заданного события.

Примечание

Этот метод предназначен для переопределения подклассами объектов-артистов. Пользователю Matplotlib, скорее всего, не нужно вызывать этот метод самостоятельно.

Данные курсора могут использоваться объектами-артистами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_dashes()[source]: Псевдоним для get_linestyle.

get_datalim(transData)[source]

get_ec()[source]: Псевдоним для get_edgecolor.

get_edgecolor()[source]

get_edgecolors()[source]: Псевдоним для get_edgecolor.

get_facecolor()[source]

get_facecolors()[source]: Псевдоним для get_facecolor.

get_fc()[source]: Псевдоним для get_facecolor.

get_figure()[source]: Возвращает экземпляр Figure, к которому относится объект-артист.

get_fill()[source]: Возвращает, закрашен ли объект.

get_gid()[source]: Возвращает идентификатор группы.

get_hatch()[source]: Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает флаг boolean, True если объект-артист включен в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]

Возвращает стиль соединения для коллекции (для всех её элементов).

Возвращает:

{'miter', 'round', 'bevel'} или None

get_label()[source]: Возвращает метку, используемую для этого объекта в легенде.

get_linestyle()[source]

get_linestyles()[source]: Псевдоним для get_linestyle.

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

get_mouseover()[source]: Возвращает, запрашивается ли у этого объекта пользовательская информация о контексте, когда курсор мыши перемещается по нему.

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый этим смещённым объектом.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора объекта.

Возможные значения описаны в Artist.set_picker.

См. также

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, будет ли объект растрирован.

get_sketch_params()[source]

Возвращает параметры наброска для объекта.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, по которому длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает установку привязки.

Подробности см. в set_snap.

get_tightbbox(renderer=None)[source]

Как Artist.get_window_extent, но включает любые обрезки.

Параметры:

rendererRendererBase подкласс, необязательно: рендерер, который будет использован для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает:

Bbox или None: Охватывающая область (в пиксельных координатах фигуры). Возвращает None, если обрезка приводит к отсутствию пересечения.

get_transOffset()[source]: Псевдоним для get_offset_transform.

get_transform()[source]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[source]: Возвращает путь обрезки с примененной не-аффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()[source]

get_url()[source]: Возвращает URL.

get_urls()[source]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None)[source]

Получить область объекта-артиста в пространстве отображения.

Ширина и высота области неотрицательны.

Будьте осторожны при использовании этой функции, результаты не обновятся, если область окна-артиста изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder()[source]: Возвращает порядок z объекта-артиста.

have_units()[source]: Возвращает, установлены ли единицы на любой оси.

is_transform_set()[source]

Возвращает, имеет ли объект-артист явно установленное преобразование.

Это True после вызова set_transform.

propertymouseover: Возвращает, запрашивается ли этот объект-артист для информации о контексте при наведении курсора мыши на него.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обрабатывает событие выбора.

Каждый дочерний объект-артист сгенерирует событие выбора, если mouseevent находится над объектом-артистом, и для объекта-артиста установлен picker.

См. также

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()[source]

Возвращает, является ли элемент графического объекта выбираемым.

См. также

Artist.set_picker, Artist.get_picker, Artist.pick

properties()[source]: Возвращает словарь со всеми свойствами графического объекта.

remove()[source]

Удаляет графический объект из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей вызовите relim, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды графического объекта.

remove_callback(oid)[source]

Удаляет обратный вызов на основе его идентификатора наблюдателя.

См. также

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>, 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`	Массивоподобный объект, скаляр или 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` или строка или None
`color`	цвет или список кортежей RGBA.
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	Цвет или список цветов.
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список таких.
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`mouseover`	bool
`norm`	`Normalize` или строка или None
`offset_transform` или transOffset	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или вызываемая функция
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:

filter_funcвызываемый: Функция фильтра, которая принимает (m, n, глубина) массив чисел с плавающей точкой и значение dpi, и возвращает массив (m, n, глубина) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[source]

Установить значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

Параметры:

alphaмассив-подобный, скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли объект художника для использования в анимации.

Если True, объект художника исключается из обычного рисования фигуры. Вам нужно явно вызвать Figure.draw_artist / Axes.draw_artist на объекте художника. Этот подход используется для ускорения анимаций с помощью технологии blitting.

См. также matplotlib.animation и Ускорение рендеринга с помощью blitting.

Параметры:

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, 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, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит прямоугольную область обрезки и задаст путь обрезки в None.

set_cmap(cmap)[source]

Установить палитру цветов для данных яркости.

Параметры:

cmapColormap или str или None

set_color(c)[source]

Установить цвет обводки и заливки.

Параметры:

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета обводки или заливки индивидуально.

set_dashes(ls)[source]: Псевдоним для set_linestyle.

set_ec(c)[source]: Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установить цвет(а) обводки коллекции.

Параметры:

cцвет или список цветов или 'face': Цвет(а) обводки коллекции. Если последовательность, фигуры будут циклически перебирать её. Если 'face', совпадать с цветом заливки.

set_edgecolors(c)[source]: Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Установить цвет(а) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически перебирать её.

Если c равно 'none', фигура не будет закрашена.

Параметры:

cцвет или список цветов

set_facecolors(c)[source]: Псевдоним для set_facecolor.

set_fc(c)[source]: Псевдоним для set_facecolor.

set_figure(fig)[source]

Установите экземпляр Figure, к которому принадлежит элемент.

Параметры:

figFigure

set_gid(gid)[source]

Установите идентификатор (группы) для элемента.

Параметры:

gidstr

set_hatch(hatch)[source]

Установите шаблон штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут комбинироваться, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого шаблона.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всего набора, а не отдельно для каждого элемента.

Параметры:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[source]

Установить, должен ли элемент включаться в вычисления макета, например, Руководство по ограниченным макетам, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_joinstyle(js)[source]

Установить JoinStyle для набора (для всех его элементов).

Параметры:

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установить метку, которая будет отображаться в легенде.

Параметры:

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установить стиль линии(й) для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	пунктирная линия
`':'` или `'dotted'`	точечная линия

В качестве альтернативы можно указать кортеж с отступами в следующем формате:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий значения включения/выключения чернил в пунктах.

Параметры:

lsстрока или кортеж или список кортежей: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[source]: Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установить ширину линии(й) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности

Параметры:

lwчисло или список чисел

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установите, запрашивается ли от этого элемента информация о контексте при перемещении курсора мыши над ним.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_norm(norm)[source]

Установите экземпляр нормализации.

Параметры:

normNormalize или str или None

Примечания

Если какие-либо цветные шкалы используют карту отображения для этой нормализации, установка нормализации карты отображения сбросит нормализацию, локатор и форматеры на цветную шкалу по умолчанию.

set_offset_transform(offset_transform)[source]

Установить преобразование смещения элемента.

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

Установить смещения для коллекции.

Параметры:

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры:

path_effectsсписок AbstractPathEffect

set_paths()[source]

set_picker(picker)[source]

Определите поведение выбора элемента.

Параметры:

pickerNone или bool или float или вызываемый объект

Это может быть одним из следующих:

None: Выбор отключен для данного элемента (по умолчанию).
Булево значение: Если True, выбор будет включен, и элемент будет генерировать событие выбора, если указатель мыши находится над элементом.
Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск в точках, и элемент будет генерировать событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции блоков, элемент может предоставлять дополнительные данные событию выбора, например, индексы данных, находящихся в пределах допуска от события выбора.
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли элемент под действие события мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если указатель мыши находится над элементом, вернуть hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Установите радиус выбора, используемый для проверок попадания.

Параметры:

pickradiusfloat: Радиус выбора в точках.

set_rasterized(rasterized)[source]

Принудительно использовать растровое (битовое) отображение для вывода векторной графики.

Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить это для элемента, который его не поддерживает, команда не будет иметь эффекта, и будет выведено предупреждение.

Это значение игнорируется для вывода на основе пикселей.

См. также Растризация для векторной графики.

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не указано, фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебания вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Множитель масштаба, по которому длина сжимается или расширяется (по умолчанию 16.0)

Фон PGF использует этот аргумент как семя генератора случайных чисел, а не как описано выше. Использование одного и того же семени приводит к одному и тому же случайному рисунку.

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]

Параметры:

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установить видимость объекта.

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок объекта. Объекты с меньшими значениями 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)[source]

Возвращает массив RGBA, соответствующий x, в нормализованном формате.

В обычном случае x — это одномерная или двумерная последовательность скалярных значений, и соответствующий массив RGBA будет возвращён на основе установленных для этого объекта ScalarMappable норм и цветовой карты.

Есть один специальный случай, для обработки изображений, которые уже являются RGB или RGBA, например, считанных из файла изображения. Если x является массивом NumPy с 3 измерениями, а последнее измерение — 3 или 4, то он будет обрабатываться как массив RGB или RGBA, и никакой обработки не будет выполняться. Массив может быть типа uint8, или это могут быть числа с плавающей запятой со значениями в диапазоне 0-1; в противном случае будет вызвано исключение ValueError. Любые значения NaN или элементы с маской будут установлены в 0 альфа. Если последнее измерение равно 3, аргумент alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующую альфу. ValueError будет вызван, если третье измерение не равно 3 или 4.

В любом случае, если bytes — False (по умолчанию), массив RGBA будет числами с плавающей запятой в диапазоне 0-1; если он равен True, возвращаемый массив RGBA будет типа uint8 в диапазоне от 0 до 255.

Если norm — False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)[source]

Обновить свойства этого объекта из словаря props.

Параметры:

propsdict

update_from(other)[source]: Копирование свойств из другого объекта в текущий.

update_scalarmappable()[source]

Обновить цвета из массива сопоставителя скаляров, если таковой имеется.

Присвоить цвета рёбрам и граням на основе массива и/или цветов, которые были непосредственно установлены, в зависимости от ситуации.

zorder=0