matplotlib.collections

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

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

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

Bases: RegularPolyCollection

Отображает набор правильных звездочек с numsides вершинами.

Параметры:

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

Примеры

См. Демонстрацию выделения лассо для полного примера:

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

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

add_callback(func)[source]

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

Параметры:

funccallable

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

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

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

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

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, 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.

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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` или 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_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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бэкендах.

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

Параметры:

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]

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

Параметры:

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 может быть скалярным значением или последовательностью; если это последовательность, фигуры будут циклически принимать значения из последовательности.

Параметры:

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 или callable

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

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. Если это массив с масками, любые замаскированные элементы будут установлены в 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.BrokenBarHCollection(xranges, yrange, **kwargs)[source]

Bases: PolyCollection

[Устаревшее] Коллекция горизонтальных столбиков, охватывающих yrange с последовательностью xranges.

Примечания

Устарело начиная с версии 3.7.

Параметры:

xrangesсписок (float, float): Последовательность пар (позиция левого края, ширина) для каждого столбика.
yrange(float, float): Общая (нижний край, высота) для всех столбиков.
**kwargs: Передаются в Collection.

add_callback(func)[source]

Параметры:

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

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

def func(artist: Artist) -> Any

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

Возвращает:

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

См. также

remove_callback

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

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

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

changed()[source]: Вызовите эту функцию при изменении отображаемого объекта, чтобы уведомить все слушатели обратного вызова о сигнале «изменено».

colorbar: Последняя связанная с этим отображаемым объектом скалярная цветовая шкала. Может быть 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]

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

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

См. также

set_picker, pickable, 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 подкласс, необязательно: 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]

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

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

Подклассы должны переопределять для включения в вычисление «плотного» bounding box. По умолчанию возвращается пустая область отображения в координатах 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.

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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`	массив-подобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список RGBA кортежей
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`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`	число с плавающей точкой

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) — это по умолчанию обрезка художника, добавленного к оси.

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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg backends.

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

Параметры:

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]

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

Параметры:

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

set_label(s)[source]

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

Параметры:

sобъект: 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 или список чисел с плавающей точкой

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список массивов-подобных объектов: Последовательность многоугольников [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 использует это аргумент как 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(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

classmethodspan_where(x, ymin, ymax, where, **kwargs)[source]

[Устарело] Возвращает BrokenBarHCollection, который рисует горизонтальные полосы по областям в x, где where равно True. Полосы простираются на оси y от ymin до ymax

kwargs передаются в коллекцию.

Примечания

Устарело начиная с версии 3.7: Используйте fill_between вместо этого.

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 будет возвращён на основе нормализации и цветовой карты, установленных для данного объекта ScalarMappable.

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

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

update(props)[source]

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

Параметры:

propsсловарь

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

update_scalarmappable()[source]

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

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

zorder=0

классmatplotlib.collections.CircleCollection(sizes, **kwargs)[source]

Bases: _CollectionWithSizes

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

Параметры:

sizesfloat или array-like: Площадь каждого круга в пунктах^2.
**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_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 может преобразовать данные в строковое представление.

Параметры:

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]: Возвращает смещения для коллекции.

END_OF_DOCUMENT_MARKER

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, 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.

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

propertynorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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` или 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_funccallable: Функция фильтра, которая принимает массив с плавающей точкой (m, n, глубина) и значение dpi и возвращает массив (m, n, глубина) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[source]

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

Параметры:

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

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 или 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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg бэкендах.

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

Параметры:

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 может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности.

Параметры:

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

set_pickradius(pickradius)[source]

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

Параметры:

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_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.

Существует один особый случай для обработки изображений, которые уже являются RGB или RGBA, например, загруженных из файла изображения. Если x является ndarray с 3 измерениями, и последнее измерение равно 3 или 4, то оно будет рассматриваться как массив RGB или RGBA, и никакой обработки не будет производиться. Массив может быть uint8, или это могут быть числа с плавающей точкой в диапазоне от 0 до 1; в противном случае будет поднята ошибка ValueError. Если это массив с маской, любые замаскированные элементы будут установлены в 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 в 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 коллекции была установлена (через вызов 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)

Вектор для перемещения каждого элемента после отрисовки (по умолчанию — без перемещения). Перемещение выполняется в координатах экрана (пиксели) (т.е. после применения преобразования 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

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

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

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

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]: Вызовите эту функцию всякий раз, когда изменяется отображаемый объект, чтобы уведомить все слушатели обратного вызова callbackSM о сигнале '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).

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.

Примечание

Этот метод предназначен для переопределения подклассами artist. Пользователям 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]

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

Returns:

{'butt', 'projecting', 'round'} or 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]

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

Note

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

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

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

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

Parameters:

eventMouseEvent

Примечания

Для повышения эффективности, если 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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бекендах.

Параметры:

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(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 использует это аргумент как 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-порядок художника. Художники с меньшими значениями 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 измерениями, и последнее измерение равно 3 или 4, то он будет обработан как массив RGB или RGBA, и никакого сопоставления не будет выполнено. Массив может быть uint8, или он может быть числами с плавающей точкой со значениями в диапазоне от 0 до 1; в противном случае будет поднято исключение ValueError. Если это массив с масками, все замаскированные элементы будут установлены в 0 alpha. Если последнее измерение равно 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 в 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]

Параметры:

funccallable

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

def func(artist: Artist) -> Any

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

Возвращает:

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может использоваться для удаления обратного вызова с помощью 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).

Параметры:

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.

Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны гарантировать, что 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.

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]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

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

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, но включает любое обрезание.

Параметры:

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.

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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`	функция фильтра, которая принимает массив 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
`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 на объекте. Этот подход используется для ускорения анимаций с помощью 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.

Примечания

По техническим причинам (поддержка 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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бекендах.

Параметры:

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 может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить через последовательность.

Параметры:

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: Выбор отключен для этого элемента (по умолчанию).
bool: Если True, то выбор будет включен, и элемент сгенерирует событие выбора, если событие мыши находится над ним.
float: Если 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 использует это аргумент как 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: Показывает, является ли объект 'неактуальным' и нуждается ли он в перерисовке для соответствия внутреннему состоянию объекта.

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 измерениями, а последнее измерение — 3 или 4, он будет обрабатываться как массив RGB или RGBA и никакое отображение не будет выполняться. Массив может быть ndarray, или он может быть числами с плавающей точкой со значениями в диапазоне от 0 до 1; в противном случае будет поднято исключение ValueError. Если это массив с пропускаемыми значениями, любые пропущенные элементы будут установлены в 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 в себя.

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{'горизонтально', 'вертикально'}, по умолчанию: 'горизонтально'

Последовательность событий отображается в этом направлении. Маркерные линии отдельных событий находятся вдоль перпендикулярного направления.

lineoffsetfloat, по умолчанию: 0

Смещение центра маркеров от начала координат в направлении, перпендикулярном orientation.

linelengthfloat, по умолчанию: 1

Полная высота маркера (т.е. маркер простирается от lineoffset - linelength/2 до lineoffset + linelength/2).

linewidthfloat или список float, по умолчанию: rcParams["lines.linewidth"] (по умолчанию: 1.5)

Толщина линий событий в пунктах.

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

Цвет линий событий.

linestyleстрока или кортеж или список кортежей, по умолчанию: 'сплошная'

Допустимые строки: ['сплошная', 'пунктирная', 'штрихпунктирная', 'точечная', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид:

(offset, onoffseq),

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

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

Использовать ли антиалиасинг для рисования линий.

**kwargs

Передаются в LineCollection.

Примеры

(Source code, 2x.png, png)

add_callback(func)[source]

Параметры:

funccallable

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

def func(artist: Artist) -> Any

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

Возвращает:

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

См. также

remove_callback

add_positions(position)[source]: Добавить одно или несколько событий в указанных позициях.

append_positions(position)[source]: Добавить одно или несколько событий в указанных позициях.

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

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

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

changed()[source]: Вызвать этот метод всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей callbackSM о сигнале «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.

Единственный текущий случай использования — отображение значения 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]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

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

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

END_OF_DOCUMENT_MARKER

get_segments()[source]

Возвращает:

список: Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.

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_horizontal()[source]: True, если eventcollection горизонтальная, False — если вертикальная.

is_transform_set()[source]

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

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

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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]

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

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

END_OF_DOCUMENT_MARKER

Свойство	Описание
`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` или str или None
`color`	цвет или список цветов
`colors`	цвет или список цветов
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gapcolor`	цвет или список цветов или None
`gid`	str
`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` или str или None
`offset_transform` или transOffset	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`orientation`	{'horizontal', 'vertical'}
`path_effects`	список `AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или float или вызываемый объект
`pickradius`	число с плавающей точкой
`positions`	неизвестно
`rasterized`	bool
`segments`	неизвестно
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или 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]

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

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

См. также 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), также принимается кортеж (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]

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

Параметры:

gidстрока

set_hatch(hatch)[source]

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

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

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

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

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

Параметры:

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

set_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 или str или None

Примечания

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

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)

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список строк или None

Примечания

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

set_verts(segments)[source]

set_visible(b)[source]

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

Параметры:

bbool

set_zorder(level)[source]

Установить zorder для элемента. Элементы с меньшими значениями zorder рисуются первыми.

Параметры:

levelfloat

propertystale: Является ли элемент 'stale' и требует ли перерисовки для соответствия выходных данных внутреннему состоянию элемента.

свойство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)

switch_orientation()[source]: Переключить ориентацию линии событий с вертикальной на горизонтальную или наоборот.

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. Если это массив с пропусками, любые пропущенные элементы будут установлены в 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.

Параметры:

propsсловарь

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

update_scalarmappable()[source]

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

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

zorder=0

классmatplotlib.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список array-like

Последовательность (line0, line1, line2) линий, где каждая линия представляет собой список точек:

lineN = [(x0, y0), (x1, y1), ... (xm, ym)]

или эквивалентный массив NumPy Mx2 с двумя столбцами. Каждая линия может иметь различное количество сегментов.

linewidthsfloat или список float, по умолчанию: rcParams["lines.linewidth"] (по умолчанию: 1.5)

Ширина каждой линии в пунктах.

colorsцвет или список цветов, по умолчанию: rcParams["lines.color"] (по умолчанию: 'C0')

Последовательность кортежей RGBA (например, произвольные цветовые строки и т. д. не допускаются).

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

Использовать ли сглаживание для каждой линии.

zorderfloat, по умолчанию: 2

zorder линий после отрисовки.

facecolorsцвет или список цветов, по умолчанию: 'none'

При установке facecolors каждая линия интерпретируется как граница области, неявно замыкая путь от последней точки до первой. Заключенная область заполняется facecolor. Чтобы вручную указать, что должно считаться "внутренностью" каждой линии, пожалуйста, используйте PathCollection, где "внутренность" может быть указана соответствующим использованием CLOSEPOLY.

**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]: Вызывайте это всякий раз, когда изменяется отображаемый объект, чтобы уведомить всех прослушивателей callbackSM о сигнале «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]

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

Возвращаемое значение:

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

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 может преобразовать данные в строковое представление.

Параметры:

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]

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

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

См. также

set_picker, pickable, 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, но включает любые обрезки.

Параметры:

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 находится над элементом и у элемента установлен выборщик.

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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`	Функция фильтра, которая принимает массив (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` или str или 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` или 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
`segments`	неизвестно
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`verts`	неизвестно
`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_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]

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

Параметры:

gidстрока

set_hatch(hatch)[source]

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

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

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

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

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

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

Параметры:

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

set_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 для этой нормализации, установка нормализации 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(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 пиксель.

Привязка в настоящее время поддерживается только 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 в настоящее время реализованы только для backends SVG. Они игнорируются всеми другими backends.

set_verts(segments)[source]

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 или 4, то оно будет рассматриваться как массив RGB или RGBA, и никакое отображение не будет выполняться. Массив может быть uint8, или это могут быть числа с плавающей точкой в диапазоне от 0 до 1; в противном случае будет возбуждено исключение ValueError. Если это массив с пропусками, любые пропущенные элементы будут установлены в 0 alpha. Если последнее измерение равно 3, аргумент alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующий alpha. ValueError будет возбуждён, если третье измерение не равно 3 или 4.

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

update(props)[source]

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

Parameters:

propsdict

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

update_scalarmappable()[source]

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

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

zorder=0

classmatplotlib.collections.PatchCollection(patches, *, match_original=False, **kwargs)[source]

Основы: Collection

Общий набор фигур.

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

Параметры:

patchesсписок Patch

Последовательность объектов Patch. Этот список может содержать разнородные типы фигур.

match_originalbool, по умолчанию: False

Если True, используются цвета и ширины линий исходных фигур. Если False, новые цвета могут быть назначены, используя стандартные аргументы коллекции, такие как facecolor, edgecolor, linewidths, norm или cmap.

**kwargs

Все остальные параметры передаются в Collection.

Если любые из edgecolors, facecolors, linewidths, antialiaseds равны None, они по умолчанию принимают значения из настроек rcParams фигуры, в последовательной форме.

Примечания

Использование функциональности ScalarMappable необязательно. Если матрица ScalarMappable _A была установлена (через вызов set_array), во время отрисовки будет вызвана функция для установки цветов заливки.

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

свойство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.

Единственным текущим случаем использования является отображение значения 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.

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]

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

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

См. также

set_picker, pickable, 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. См. Ссылки для примера.

END_OF_DOCUMENT_MARKER

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.

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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]

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

Если 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 или строка или 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

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

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

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

Параметры:

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 может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности

Параметры:

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

Примечания

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

set_offset_transform(offset_transform)[source]

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

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

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

Параметры:

offsets(N, 2) или (2,) array-like

set_path_effects(path_effects)[source]

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

Параметры:

path_effectsсписок AbstractPathEffect

set_paths(patches)[source]

set_picker(picker)[source]

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

Параметры:

pickerNone или bool или float или callable

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

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, необязательно

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

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

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

include_selfbool

Include self in the list to be checked for a match.

Returns:

list of 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.

Единственный текущий сценарий использования — отображение значения 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]

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

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

См. также

set_picker, pickable, 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.

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" (по умолчанию), массив или 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список str: Строковые описания элементов легенды.

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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`	число с плавающей точкой

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) также принимается кортеж (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]

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

Параметры:

gidstr

set_hatch(hatch)[source]

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

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

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

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

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

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

Параметры:

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

set_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,) array-like

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)

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

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

update(props)[source]

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

Parameters:

propsdict

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

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 задают масштабирование площадей). Масштабирование применяется перед преобразованием главного художника.
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

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 экземпляры, содержащиеся в художнике.

Параметры:

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]: Возвращает список дочерних элементов-артистов этого элемента-артиста.

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]

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

Примечание

Данные курсора могут использоваться элементами-артистами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращает 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]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

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

get_sizes()[source]

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

Возвращает:

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

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.

END_OF_DOCUMENT_MARKER

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.

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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` или 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`	число с плавающей точкой

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 или список 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 или строка или 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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бекендах.

Параметры:

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(verts, closed=True)[source]

Устанавливает вершины многоугольников.

Параметры:

vertsсписок массив-подобных объектов: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как 2D массив-подобный объект формы (M, 2).
closedbool, по умолчанию: True: Закрывать ли многоугольник, добавив соединение CLOSEPOLY в конце.

set_picker(picker)[source]

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

Параметры:

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

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

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

set_pickradius(pickradius)[source]

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

Параметры:

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры:

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 backend. Они игнорируются всеми другими backends.

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-порядок для объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры:

levelfloat

classmethodspan_where(x, ymin, ymax, where, **kwargs)[source]

[Устарело] Возвращает BrokenBarHCollection, который рисует горизонтальные полосы в областях в x, где where — True. Полосы на y-оси от ymin до ymax

kwargs передаются в collection.

Примечания

Устарело начиная с версии 3.7: Используйте fill_between вместо этого.

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

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

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

update(props)[source]

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

Параметры:

propsdict

update_from(other)[source]: Копирует свойства из других в себя.

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 задают масштабирование областей). Масштабирование применяется до преобразования главного художника.
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

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

changed()[source]: Вызовите эту функцию, когда карта отображения изменяется, чтобы уведомить всех слушателей обратного вызова '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).

Параметры:

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах художника.

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]

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

Возвращает:

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

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]

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

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

См. также

set_picker, pickable, 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 подкласс, необязательно: 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]

Получает область элемента на экране.

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

Подклассы должны переопределять для включения в вычисление "плотной" области. По умолчанию возвращается пустая область в координатах 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]

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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` или str или 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 или число с плавающей точкой или вызываемая функция
`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`	число с плавающей точкой

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массив-подобный объект

Данные сетки. Поддерживаемые формы массива:

(M, N) или (M*N,): сетка со скалярными данными. Значения отображаются в цвета с помощью нормализации и цветовой карты. См. параметры norm, cmap, vmin, vmax.
(M, N, 3): изображение с RGB-значениями (числа с плавающей точкой от 0 до 1 или целые числа от 0 до 255).
(M, N, 4): изображение с RGBA-значениями (числа с плавающей точкой от 0 до 1 или целые числа от 0 до 255), включая прозрачность.

Если значения заданы в виде двумерной сетки, форма должна соответствовать форме сетки координат. Если значения заданы в виде одномерного массива, они преобразуются в двумерный массив. M и N определяются из сетки координат, где форма сетки координат — (M, N) для 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 или 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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бекендах.

Параметры:

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 — кортеж чётной длины значений отступа и включения чернил в пунктах.

Параметры:

lsstr или кортеж/список: Допустимые значения для отдельных стилей линии включают {'-', '--', '-.', ':', '', (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список массив-подобных: Последовательность многоугольников [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список строк или 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

classmethodspan_where(x, ymin, ymax, where, **kwargs)[source]

[Устарело] Возвращает BrokenBarHCollection, который рисует горизонтальные полосы по областям в x, где where имеет значение True. Полосы изменяются по оси y от ymin до ymax

kwargs передаются в коллекцию.

Примечания

Устарело начиная с версии 3.7: Используйте fill_between вместо этого.

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 будет возвращён на основе нормы и цветовой карты, установленных для данного объекта ScalarMappable.

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

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

update(props)[source]

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

Параметры:

propsdict

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

update_scalarmappable()[source]

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

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

zorder=0

классmatplotlib.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{'плоский', 'гоуро'}, по умолчанию: 'плоский'

Примечания

В отличие от других Collection, значение по умолчанию pickradius для QuadMesh равно 0, т.е. contains проверяет, находится ли тестовая точка внутри любого из четырёхугольников сетки.

Параметры:

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

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

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

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

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

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

linestylesстрока или кортеж или список таковых, по умолчанию: 'сплошная'

Допустимые строки: ['сплошная', 'штриховая', 'штрихпунктирная', 'пунктирная', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид:

(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 для всех значений по умолчанию и примеров.

add_callback(func)[source]

Параметры:

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

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

def func(artist: Artist) -> Any

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

Возвращает:

целое число: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью 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 подкласс.

Примечания

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

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.

Параметры:

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]

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

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

См. также

set_picker, pickable, 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]: Возвращает порядок элемента по z.

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

is_transform_set()[source]

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

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

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

propertynorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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>, 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: Функция фильтра, которая принимает массив float (m, n, глубина) и значение dpi, и возвращает массив (m, n, глубина) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[source]

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

Параметры:

alphaarray-like или скаляр или 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]

Установить значения данных.

Параметры:

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) для 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 или 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строка

set_hatch(hatch)[source]

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

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

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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бекендах.

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

Параметры:

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

set_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()[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список 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 — это массив ndarray с 3 измерениями, а последнее измерение — 3 или 4, то он будет обрабатываться как массив RGB или RGBA, и никакого отображения не будет выполнено. Массив может быть uint8, или он может быть числами с плавающей точкой в диапазоне 0-1; в противном случае будет возбуждено исключение ValueError. Если это массив с пропусками, то любые пропущенные элементы будут установлены в 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 в 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]

Parameters:

funccallable

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

def func(artist: Artist) -> Any

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

Returns:

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

См. также

remove_callback

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

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

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

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

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]

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

Возвращает:

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

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.

Единственный текущий случай использования — отображение значения 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]

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

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

См. также

set_picker, pickable, 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.

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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`	функция фильтра, которая принимает массив чисел с плавающей точкой (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	строка или кортеж или список thereof
`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
`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 или список 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 или строка или 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

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

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

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

Параметры:

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 или кортеж или список кортежей: Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. См. Line2D.set_linestyle для полного описания.

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

set_linewidth(lw)[source]

Параметры:

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 — число, оно интерпретируется как допустимая погрешность в точках, и объект будет генерировать событие, если его данные находятся в пределах погрешности от события нажатия мыши. Для некоторых объектов, таких как линии и коллекции участков, объект может предоставить дополнительные данные событию выбора, например, индексы данных, находящиеся в пределах погрешности от события выбора.
Вызываемый объект: Если 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 пиксель.

Привязка в настоящее время поддерживается только бэкендами 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 или 4, то оно будет обработано как массив RGB или RGBA, и никакая карта не будет применена. Массив может быть uint8, или содержать числа с плавающей точкой в диапазоне от 0 до 1; в противном случае будет вызвано исключение ValueError. Если это массив с масками, любые замаскированные элементы будут установлены в 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.StarPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[source]

Bases: RegularPolyCollection

Отображает коллекцию правильных звезд с numsides точками.

Параметры:

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]

Параметры:

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: Последняя связанная с этим 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).

Параметры:

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]

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

Примечание

Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращает 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_numsides()[source]

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

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

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, 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.

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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`	число с плавающей точкой

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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бекендах.

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

Параметры:

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 или кортеж или список кортежей: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (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(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 пиксель.

Привязка в настоящее время поддерживается только 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 в настоящее время реализованы только в backend SVG. Они игнорируются всеми другими backends.

set_visible(b)[source]

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

Параметры:

bbool

set_zorder(level)[source]

Установить zorder для объекта. Объекты с меньшими значениями 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.

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

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

update(props)[source]

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

Параметры:

propsdict

update_from(other)[source]: Копирует свойства из других в себя.

update_scalarmappable()[source]

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

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

zorder=0

classmatplotlib.collections.TriMesh(triangulation, **kwargs)[source]

Основы: 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)

Вектор для смещения каждого фрагмента после рендеринга (по умолчанию смещение отсутствует). Смещение выполняется в экранных (пиксельных) координатах (т. е. после применения преобразования 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.

add_callback(func)[source]

Параметры:

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

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

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 содержит событие.

staticconvert_mesh_to_paths(tri)[source]

Преобразование заданной сетки в последовательность объектов Path.

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

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

draw(renderer)[source]

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

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

Parameters:

rendererRendererBase подкласс.

Примечания

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

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

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

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

Parameters:

match

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

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

include_selfbool

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

Returns:

список Artist

format_cursor_data(data)[source]

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

Примечание

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

См. также

get_cursor_data

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

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

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

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

get_antialiased()[source]

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

Returns:

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

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

get_array()[source]

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

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

get_capstyle()[source]

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

Returns:

{'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_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]

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

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

См. также

set_picker, pickable, 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 подкласс, необязательно: 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]

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

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

Подклассы должны переопределять для включения в вычисление области «плотно». По умолчанию возвращается пустая область в 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.

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, 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>, 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`	массивоподобный объект или 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 или число с плавающей точкой или вызываемая функция
`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.

Параметры:

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 или строка или 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строка

set_hatch(hatch)[source]

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

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

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

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

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бэкендах.

Параметры:

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

set_in_layout(in_layout)[source]

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

Параметры:

in_layoutбулево

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

Примечания

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

set_offset_transform(offset_transform)[source]

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

Параметры:

offset_transformTransform

set_offsets(offsets)[source]

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

Параметры:

offsets(N, 2) или (2,) array-like

set_path_effects(path_effects)[source]

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

Параметры:

path_effectsсписок AbstractPathEffect

set_paths()[source]

set_picker(picker)[source]

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

Параметры:

pickerNone или bool или float или callable

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

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]

Установить 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. Если это массив с пропусками, любые пропущенные элементы будут установлены в 0 альфа. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, значение параметра alpha игнорируется; оно не заменяет существующее значение альфа. Если третье измерение отличается от 3 или 4, будет возбуждено исключение ValueError.

В любом случае, если 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