matplotlib.collections

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

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

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

END_OF_DOCUMENT_MARKER

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

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

Параметры

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

Примеры

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

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

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

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

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

Параметры

funccallable

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

def func(artist: Artist) -> Any

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

Возвращает

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

См. также

remove_callback

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

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

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

свойствоcallbacksSM[исходный код]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

rendererподкласс RendererBase.

Примечания

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

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

Найти объекты элементов управления.

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

Параметры

match

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

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

include_selfbool

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

Возвращает

список Artist

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

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

Примечание

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

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

См. также

get_cursor_data

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

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

get_animated()[исходный код]: Возвращает значение, указывающее, анимирован ли элемент.

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

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

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

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

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

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

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

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

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

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

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

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

Примечание

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

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

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

См. также

set_picker, pickable, pick

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

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

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

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

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

Возвращает

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

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

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

Возвращает

кортеж или None

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

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

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

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

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

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

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

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

Параметры

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

Возвращает

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

свойствоmouseover

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

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойствоnorm

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

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

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

См. также

add_callback
remove_callback

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

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

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

См. также

set_picker, get_picker, pickable

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

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

См. также

set_picker, get_picker, pick

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

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

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

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

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

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

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

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

См. также

add_callback

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

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi и возвращает массив (m, n, 3)
`alpha`	подобный массиву или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	подобный массиву или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) подобный массиву
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

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

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

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

Параметры

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

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

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

Параметры

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

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

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

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

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

Параметры

bbool

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

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

Параметры

aabool или список bool

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

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

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

Параметры

Aмассив-подобный объект или None

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

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

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

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

Параметры

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

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

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

Параметры

vmin, vmaxfloat

Пределы.

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

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

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

Параметры

clipboxBbox

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

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

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

Параметры

bbool

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

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

Параметры

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

Примечания

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

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

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

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

Параметры

cmapColormap или str или None

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

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

Параметры

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

См. также

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

figFigure

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

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

Параметры

gidstr

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

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

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

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

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

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

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

Параметры

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

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

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

Параметры

in_layoutbool

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

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

Параметры

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

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

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

Параметры

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

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

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

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

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

(offset, onoffseq),

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

Параметры

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

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

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

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

Параметры

lwвещественное число или список вещественных чисел

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

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

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

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

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

Параметры

normNormalize или None

Примечания

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

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

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

Параметры

transOffsetTransform

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

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

Параметры

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

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

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

Параметры

path_effectsAbstractPathEffect

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

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

Параметры

rasterizedbool

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

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

Параметры

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

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

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

Параметры

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

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

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

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

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

Множитель масштаба, на который длина уменьшается или увеличивается (по умолчанию 16,0).

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

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

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

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

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

Параметры

snapbool или None

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

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

END_OF_DOCUMENT_MARKER

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

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

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

update(props)[source]

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

Параметры

propsdict

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

update_scalarmappable()[source]

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

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

zorder=0

classmatplotlib.collections.BrokenBarHCollection(xranges, yrange, **kwargs)[source]

Базовые классы: matplotlib.collections.PolyCollection

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

Параметры

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

add_callback(func)[source]

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

Параметры

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

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

def func(artist: Artist) -> Any

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

Возвращает

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

См. также

remove_callback

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

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

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

propertycallbacksSM[source]

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

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

contains(mouseevent)[source]

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

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

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

draw(renderer)[source]

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

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

Параметры

rendererподкласс RendererBase.

Примечания

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

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

Найти элементы художника.

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

Параметры

match

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

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

include_selfbool

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

Возвращает

список Artist

END_OF_DOCUMENT_MARKER

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

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

Примечание

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

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

См. также

get_cursor_data

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

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

get_animated()[исходный код]: Возвращает значение, указывающее, анимирован ли элемент.

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

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

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

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

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

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

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

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

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

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

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

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

Примечание

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

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

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

См. также

set_picker, pickable, pick

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

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

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

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

Возвращает

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

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

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

Возвращает

кортеж или None

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

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

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

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

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

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

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

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

Параметры

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

Возвращает

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

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

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

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

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

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

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

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

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

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

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

Ширина и высота области имеют неотрицательные значения.

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

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

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

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

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

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

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

propertymouseover

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

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

propertynorm

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

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

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

См. также

add_callback
remove_callback

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

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

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

См. также

set_picker, get_picker, pickable

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

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

См. также

set_picker, get_picker, pick

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

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

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

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

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

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

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

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

См. также

add_callback

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

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив 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`	`Bbox`
`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	вещественное число или список вещественных чисел
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массив (N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`paths`	список массивоподобных объектов
`picker`	None или bool или float или вызываемый объект
`pickradius`	вещественное число
`rasterized`	bool
`sizes`	массив NumPy или 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)[исходный код]: Псевдоним для set_antialiased.

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

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

Параметры

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

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

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

Параметры

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

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

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

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

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

Параметры

bbool

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

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

Параметры

aabool или список bool

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

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

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

Параметры

Aмассивоподобный объект или None

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

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

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

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

Параметры

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

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

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

Параметры

vmin, vmaxfloat

Пределы.

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

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

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

Параметры

clipboxBbox

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

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

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

Параметры

bbool

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

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

Параметры

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

Примечания

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

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

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

Параметры

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

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

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

Параметры

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

См. также

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

figFigure

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

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

Параметры

gidstr

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

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

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

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

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

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

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

Параметры

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

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

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

Параметры

in_layoutbool

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

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

Параметры

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

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

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

Параметры

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

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

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

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

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

(offset, onoffseq),

где onoffseq - кортеж чётной длины значений включения и выключения чернил в точках.

Параметры

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

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

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

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

Параметры

lwfloat или список float

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

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

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

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

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

Параметры

normNormalize или None

Примечания

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

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

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

Параметры

transOffsetTransform

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

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

Параметры

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

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

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

Параметры

path_effectsAbstractPathEffect

set_paths(verts, closed=True)[исходный код]

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

Параметры

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

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

Параметры

rasterizedbool

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

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

Параметры

sizesndarray или None: Размер, который необходимо установить для каждого элемента коллекции. Значение — это «площадь» элемента.
dpifloat, по умолчанию: 72: Точки на дюйм (dpi) холста.

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

Параметры

snapbool или None

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

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

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

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

Параметры

tTransform

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

Установить URL для объекта.

Параметры

urlstr

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

Параметры

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

Примечания

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

set_verts(verts, closed=True)[исходный код]

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

Параметры

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

set_verts_and_codes(verts, codes)[исходный код]: Инициализировать вершины с кодами пути.

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

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

Параметры

bbool

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

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

Параметры

levelfloat

classmethodspan_where(x, ymin, ymax, where, **kwargs)[исходный код]

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

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

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

propertysticky_edges

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

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

Кроме того, расширение отступа "упирается" в липкие края и не может их пересекать. Например, если верхний предел данных равен 1,0, верхний предел просмотра, вычисленный с помощью простого применения отступа, равен 1,2, но есть липкий край в 1,1, то фактический верхний предел просмотра будет равен 1,1.

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

Примеры

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

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

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

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

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

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

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

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

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

Параметры

propsdict

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

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

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

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

zorder=0

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

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

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

Параметры

sizesfloat или массив-подобный объект: Площадь каждой окружности в пунктах^2.
**kwargs: Передаются объекту Collection.

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

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

Параметры

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

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

def func(artist: Artist) -> Any

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

Возвращает

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

См. также

remove_callback

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

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

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

propertycallbacksSM[исходный код]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

rendererподкласс RendererBase.

Примечания

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

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

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

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

Параметры

match

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

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

include_selfbool

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

Возвращает

список Artist

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

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

Примечание

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

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

См. также

get_cursor_data

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

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

get_animated()[исходный код]: Возвращает значение, указывающее, анимирован ли элемент.

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

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

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

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

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

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

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

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

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

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

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

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

Примечание

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

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

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

См. также

set_picker, pickable, pick

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

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

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

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

Возвращает

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

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

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

Возвращает

кортеж или None

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

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

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

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

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

См. set_snap для получения подробностей.

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

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

Параметры

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

Возвращает

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

свойствоmouseover

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

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойствоnorm

pchanged()[источник]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[источник]

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

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

См. также

set_picker, get_picker, pickable

pickable()[источник]

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

См. также

set_picker, get_picker, pick

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

remove()[источник]

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

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

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

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

remove_callback(oid)[источник]

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

См. также

add_callback

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

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, а возвращает массив (m, n, 3)
`alpha`	массивоподобный объект, скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

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

set_agg_filter(filter_func)[источник]

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

Параметры

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

set_alpha(alpha)[источник]

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

Параметры

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

set_animated(b)[источник]

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

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

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

Параметры

bbool

set_antialiased(aa)[источник]

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

Параметры

aabool или список bool

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

set_array(A)[источник]

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

Параметры

Aмассивоподобный объект или None

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

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

set_capstyle(cs)[источник]

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

Параметры

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

set_clim(vmin=None, vmax=None)[источник]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[источник]

Установить область обрезки объекта Bbox.

Параметры

clipboxBbox

set_clip_on(b)[источник]

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

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

Параметры

bbool

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

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

Параметры

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

Примечания

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

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

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

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

Параметры

cmapColormap или str или None

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

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

Параметры

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

См. также

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

figFigure

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

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

Параметры

gidstr

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

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

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

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

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

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

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

Параметры

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

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

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

Параметры

in_layoutbool

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

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

Параметры

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

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

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

Параметры

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

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

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

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

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

(offset, onoffseq),

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

Параметры

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

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

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

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

Параметры

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

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

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

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

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

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

Параметры

normNormalize или None

Примечания

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

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

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

Параметры

transOffsetTransform

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

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

Параметры

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

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

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

Параметры

path_effectsAbstractPathEffect

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

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

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

Параметры

pickerNone или bool или float или вызываемая функция

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

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

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

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

Параметры

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

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

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

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

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

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

Параметры

rasterizedbool

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

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

Параметры

sizesndarray или None: Размер для каждого элемента коллекции. Значение — «площадь» элемента.
dpifloat, по умолчанию: 72: DPI холста.

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

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

Параметры

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

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

lengthfloat, необязательно

Длина колебания вдоль линии в пикселях (по умолчанию 128,0).

randomnessfloat, необязательно

Коэффициент масштабирования, на который длина уменьшается или увеличивается (по умолчанию 16,0).

Бэкенд PGF использует это значение как начальное значение генератора случайных чисел, а не так, как описано выше. При одинаковом начальном значении получаются одинаковые случайные формы.

set_snap(snap)[исходный код]

Установить поведение привязки.

Привязка выравнивает позиции по пиксельной сетке, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет сероватым значением в обеих соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение будет действительно содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (автоматически) Если траектория содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(t)[исходный код]

Установить преобразование элемента.

Параметры

tTransform

set_url(url)[исходный код]

Установить URL для объекта.

Параметры

urlstr

set_urls(urls)[исходный код]

Параметры

urlsсписок str или None

Примечания

URL в настоящее время реализованы только в SVG-бэкенде. В остальных бэкендах они игнорируются.

set_visible(b)[исходный код]

Установить видимость объекта.

Параметры

bbool

set_zorder(level)[исходный код]

Установить 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)[исходный код]

Возвращает массив rgba, нормализованный по отношению к x.

В обычном случае x — это 1D- или 2D-последовательность скаляров, и соответствующий массив значений rgba будет возвращён на основе установленных для данного ScalarMappable нормализации и цветовой карты.

Существует один особый случай для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x — это массив с 3 измерениями, и последнее измерение равно 3 или 4, то он будет рассматриваться как массив rgb или rgba, и преобразование не будет выполнено. Массив может быть uint8 или может быть с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с пропусками, маска будет проигнорирована. Если последнее измерение равно 3, значение аргумента alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующее значение alpha. Будет поднято исключение ValueError, если третье измерение отлично от 3 или 4.

В любом случае, если bytes — False (по умолчанию), массив rgba будет иметь значения с плавающей точкой в диапазоне 0-1; если он True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.

Если norm — False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)[исходный код]

Обновить свойства этого объекта из словаря props.

Параметры

propsdict

update_from(other)[исходный код]: Скопировать свойства из other в этот объект.

update_scalarmappable()[исходный код]

Обновить цвета из массива скалярного отображателя, если он есть.

Назначить цвета краям и граням на основе массива и/или цветов, которые были заданы напрямую, соответственно.

zorder=0

classmatplotlib.collections.Collection(edgecolors=None, facecolors=None, linewidths=None, linestyles='solid', capstyle=None, joinstyle=None, antialiaseds=None, offsets=None, transOffset=None, norm=None, cmap=None, pickradius=5.0, hatch=None, urls=None, *, zorder=1, **kwargs)[исходный код]

Основы: matplotlib.artist.Artist, matplotlib.cm.ScalarMappable

Базовый класс для коллекций. Для использования его необходимо наследовать.

Коллекция представляет собой последовательность элементов Patch, которые можно отрисовать вместе эффективнее, чем по отдельности. Например, если один и тот же путь рисуется много раз с разными смещениями, рендерер, как правило, может выполнить вызов draw_marker() намного эффективнее, чем серию повторяющихся вызовов draw_path(), применяя смещения по одному.

Большинство свойств коллекции можно настраивать отдельно для каждого элемента. Поэтому коллекции имеют «множественные» версии многих свойств Patch (например, Collection.get_paths вместо Patch.get_path). Исключениями являются свойства zorder, hatch, pickradius, capstyle и joinstyle, которые можно задать только глобально для всей коллекции.

Помимо этих исключений, все свойства можно задавать как одиночными значениями (применяемыми ко всем элементам), так и последовательностями значений. Свойство i-го элемента коллекции:

prop[i % len(prop)]

Каждую коллекцию можно дополнительно использовать как собственный ScalarMappable, передав параметры norm и cmap конструктору. Если для коллекции задан массив ScalarMappable _A (с помощью вызова Collection.set_array), то при отрисовке это внутреннее скалярное отображение будет использоваться для задания facecolors и edgecolors, а значения, заданные вручную, будут игнорироваться.

Параметры

edgecolorsцвет или список цветов, по умолчанию: rcParams["patch.edgecolor"] (по умолчанию: 'black')

Цвет обводки каждого элемента коллекции. Специальное значение 'face' можно использовать, чтобы цвет обводки совпадал с цветом заливки.

facecolorsцвет или список цветов, по умолчанию: rcParams["patch.facecolor"] (по умолчанию: 'C0')

Цвет заливки каждого элемента коллекции.

linewidthsвещественное число или список вещественных чисел, по умолчанию: rcParams["patch.linewidth"] (по умолчанию: 1.0)

Толщина линии каждого элемента коллекции.

linestylesстрока, кортеж или список таких значений, по умолчанию: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид:

(offset, onoffseq),

где onoffseq — кортеж чётной длины с длительностями включённых и выключенных участков штриха в пунктах. Примеры см. в Стилях линий.

capstyleзначение типа CapStyle, по умолчанию: rcParams["patch.capstyle"]

Стиль окончания линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.

joinstyleзначение типа JoinStyle, по умолчанию: rcParams["patch.joinstyle"]

Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.

antialiasedsлогическое значение или список логических значений, по умолчанию: rcParams["patch.antialiased"] (по умолчанию: True)

Определяет, следует ли отрисовывать каждый элемент с использованием сглаживания.

offsets(вещественное число, вещественное число) или список таких значений, по умолчанию: (0, 0)

Вектор, применяемый для перемещения каждого элемента после отрисовки (по умолчанию перемещение не выполняется). Перемещение выполняется в экранных координатах (пикселях), то есть после применения преобразования Artist.

transOffsetTransform, по умолчанию: IdentityTransform

Единственное преобразование, применяемое к каждому вектору offsets перед его использованием.

normNormalize, необязательно

Передаётся в ScalarMappable. Значение по умолчанию None означает, что при первом вызове отрисовки будут заданы vmin и vmax на основе минимального и максимального значений данных.

cmapColormap, необязательно

Передаётся в ScalarMappable. Значение по умолчанию None приведёт к использованию rcParams["image.cmap"] (по умолчанию: 'viridis')

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)[исходный код]

Добавляет функцию обратного вызова, которая будет вызываться при изменении любого из свойств Artist.

Параметры

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующий вид:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения допускаются, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно позднее использовать для удаления обратного вызова с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует пределы скаляров в экземпляре norm, используя текущий массив.

autoscale_None()[исходный код]: Автоматически масштабирует пределы скаляров в экземпляре norm, используя текущий массив и изменяя только пределы, равные None.

свойствоaxes: Экземпляр Axes, в котором находится элемент, или None.

свойствоcallbacksSM[исходный код]

changed()[исходный код]: Вызывайте эту функцию при каждом изменении mappable, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может иметь значение None.

contains(mouseevent)[исходный код]

Проверяет, произошло ли событие мыши в пределах коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в списке itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x с использованием типа единиц оси x.

Если элемент не принадлежит Axes или ось x не имеет единиц измерения, возвращается само значение x.

convert_yunits(y)[исходный код]

Преобразует y с использованием типа единиц оси y.

Если элемент не принадлежит Axes или ось y не имеет единиц измерения, возвращается само значение y.

draw(renderer)[исходный код]

Отрисовывает элемент (и его дочерние элементы) с помощью заданного рендерера.

Ничего не делает, если элемент невидим (Artist.get_visible возвращает False).

Параметры

rendererподкласс RendererBase.

Примечания

Этот метод переопределяется в подклассах элемента.

findobj(match=None, include_self=True)[исходный код]

Находит объекты-элементы.

Рекурсивно находит все экземпляры Artist, содержащиеся в элементе.

Параметры

match

Критерий фильтрации результатов. Это может быть:

None: вернуть все объекты, содержащиеся в элементе.
Функция с сигнатурой def match(artist: Artist) -> bool. В результат попадут только элементы, для которых функция возвращает True.
Экземпляр класса, например Line2D. В результат попадут только элементы этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список объектов, проверяемых на соответствие.

Возвращает

Список Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения в подклассах элементов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, заключённую в квадратные скобки и разделённую запятыми. Если же элемент связан с цветовой шкалой, скалярные значения форматируются с помощью форматировщика этой шкалы.

См. также

get_cursor_data

get_agg_filter()[исходный код]: Возвращает функцию фильтрации для использования с фильтром agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания. Поддерживается не всеми бэкендами.

get_animated()[исходный код]: Возвращает признак анимации элемента.

get_array()[исходный код]

Возвращает массив значений, преобразуемых в цвета.

Базовый класс ScalarMappable не предполагает какую-либо размерность или форму массива.

get_capstyle()[исходный код]

get_children()[исходный код]: Возвращает список дочерних элементов Artist этого объекта Artist.

get_clim()[исходный код]: Возвращает значения (мин, макс), сопоставленные с пределами цветовой карты.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает, использует ли элемент обрезку.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Единственное текущее применение — отображать значение z AxesImage в строке состояния окна графика при перемещении мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure()[исходный код]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[исходный код]: Возвращает, закрашен ли элемент.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий шаблон штриховки.

get_in_layout()[исходный код]

Возвращает флаг булевого типа, True если элемент включён в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

get_label()[исходный код]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, нужно ли растрировать элемент.

get_sketch_params()[исходный код]

Возвращает параметры наброска для элемента.

Возвращает

кортеж или None

Кортеж из 3 элементов с такими значениями:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Множитель масштабирования, с помощью которого длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были заданы.

get_snap()[исходный код]

Возвращает значение настройки snap.

Подробности см. в set_snap.

get_tightbbox(renderer)[исходный код]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры

rendererподкласс RendererBase: экземпляр рендерера, который будет использоваться для отрисовки графиков (т. е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая рамка (в пикселях координат фигуры).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой не-аффинной частью преобразования и оставшейся аффинной частью преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer)[исходный код]

Получение области объекта в пространстве отображения.

Ширина и высота области неотрицательны.

Будьте осторожны при использовании этой функции. Результаты не обновятся, если область окна объекта изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, где интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся неправильно.

get_zorder()[исходный код]: Возвращает z-порядок объекта.

have_units()[исходный код]: Возвращает, установлены ли единицы измерения на какой-либо оси.

is_transform_set()[исходный код]

Возвращает, задано ли преобразование для объекта.

Это True после вызова set_transform.

propertymouseover

Если это свойство установлено в True, объект будет запрошен для получения пользовательских данных контекста, когда указатель мыши находится над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

propertynorm

pchanged()[исходный код]

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обработка события выбора.

Каждый дочерний объект-объект сгенерирует событие выбора, если mouseevent находится над объектом и у объекта установлен picker.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает, можно ли выбрать объект.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь всех свойств объекта.

remove()[исходный код]

Удалить графический элемент с фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей можно вызвать relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[исходный код]

Удалить обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	подобный массиву, скалярное значение или None
`animated`	bool
`antialiased`	bool или список bool
`array`	подобный массиву или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей rgba
`edgecolor`	цвет или список цветов или 'face'
`facecolor`	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle`	строка или кортеж или список таковых
`linewidth`	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массив-подобный объект
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sketch_params`	(scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[исходный код]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтрации, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi и возвращает массив (m, n, 3).

set_alpha(alpha)[исходный код]

Установить значение альфа для смешивания — не поддерживается всеми бэкендами.

Параметры

alphaмассивоподобный объект, скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли графический объект для использования в анимации.

Если True, графический объект исключается из обычной отрисовки фигуры. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для графического объекта. Этот подход используется для ускорения анимации с помощью отрисовки с копированием буфера.

См. также matplotlib.animation и Ускорение отображения с помощью копирования буфера.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние сглаживания при отрисовке.

Параметры

aabool или список значений bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассивоподобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Установить стиль окончания CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормализации для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также можно передать в виде кортежа (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[исходный код]

Установить область обрезки графического объекта Bbox.

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, используется ли обрезка для графического объекта.

Если False, графические объекты будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установить область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан объект Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена.
transformTransform, необязательно: Используется только если path — Path; в этом случае данный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — Rectangle, этот метод установит прямоугольник обрезки и область обрезки в None.

По техническим причинам (поддержка set) кортеж (path, transform) также принимается в качестве единственного позиционного параметра.

set_cmap(cmap)[исходный код]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

set_color(c)[исходный код]

Установить цвет обводки и заливки.

Параметры

cцвет или список кортежей rgba

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для отдельной настройки цвета обводки или заливки.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Установить цвет обводки коллекции.

Параметры

cцвет, список цветов или 'face': Цвет обводки коллекции. Если задана последовательность, элементы будут циклически использовать её значения. Если задано 'face', цвет будет совпадать с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Установить цвет заливки коллекции. c может быть цветом (тогда все элементы имеют одинаковый цвет) или последовательностью цветов; если задана последовательность, элементы будут циклически использовать её значения.

Если c равно 'none', элемент не будет заполнен.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Установить объект Figure, к которому относится элемент.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор группы элемента.

Параметры

gidстрока

set_hatch(hatch)[исходный код]

Установить узор штриховки

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)[исходный код]

Устанавливает, должен ли элемент быть включён в расчёт макета. Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Устанавливает JoinStyle для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль линии(й) для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж с отступами в следующем формате:

(offset, onoffseq),

где onoffseq — кортеж чётной длины со значениями включения/выключения чернил в пунктах.

Параметры

lsстрока или кортеж или список таковых: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить ширину линии(й) для набора. lw может быть скалярным или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности

Параметры

lwчисло с плавающей точкой или список чисел с плавающей точкой

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если какие-либо цветовые шкалы используют отображаемую информацию для этой нормализации, установка нормы отображаемой информации сбросит норму, локатор и форматеры цветовой шкалы на значения по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить трансформирование смещения элемента.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установите смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массивоподобный объект

set_path_effects(path_effects)[исходный код]

Установите эффекты траектории.

Параметры

path_effectsAbstractPathEffect

set_paths()[исходный код]

set_picker(picker)[исходный код]

Определение поведения выбора для элемента.

Параметры

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующего:

None: Выбор отключен для данного элемента (по умолчанию).
Булево значение: Если True, то выбор будет включен, и элемент будет генерировать событие выбора, если курсор мыши находится над ним.
Число с плавающей точкой: Если picker — число, оно интерпретируется как толерантность к ошибкам в единицах измерения и элемент будет генерировать событие, если его данные находятся в пределах ошибки от события курсора мыши. Для некоторых элементов, таких как линии и коллекции фигуры, элемент может предоставлять дополнительные данные для события выбора, например, индексы данных в пределах ошибки от события выбора
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, определяющая, попадает ли мышь на элемент:
```
hit, props = picker(artist, mouseevent)
```
чтобы определить тест на попадание. Если курсор мыши находится над элементом, верните hit=True и props в качестве словаря свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pr)[исходный код]

Установите радиус выбора, используемый для тестов на вхождение.

Параметры

prfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительное растровое (битовое) отображение для выходных данных векторной графики.

Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить это для элемента, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.

Это настройка игнорируется для выходных данных на основе пикселей.

См. также Растровое отображение для векторной графики.

Параметры

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установите параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не указано, фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Множитель масштаба, с помощью которого длина уменьшается или увеличивается (по умолчанию 16.0)

Бэкенд PGF использует это значение в качестве семени генератора случайных чисел, а не так, как описано выше. Использование одного и того же семени приводит к одинаковой случайной форме.

set_snap(snap)[исходный код]

Установите поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более четким изображениям. Например, если черная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в обеих соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение будет действительно содержать черную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(t)[исходный код]

Установите преобразование элемента.

Параметры

tTransform

set_url(url)[исходный код]

Установите URL для элемента.

Параметры

urlstr

set_urls(urls)[исходный код]

Параметры

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[исходный код]

Установить видимость объекта.

Параметры

bbool

set_zorder(level)[исходный код]

Установить порядок отрисовки (zorder) для объекта. Объекты с меньшими значениями zorder будут отрисованы первыми.

Параметры

levelfloat

propertystale: Является ли объект «неактуальным» и нуждается ли он в перерисовке, чтобы вывод соответствовал внутреннему состоянию объекта.

propertysticky_edges

x и y списки приклеенных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, тогда не будет добавлен отступ — предел отображения «приклеивается» к краю. Типичный пример — гистограммы, где обычно не ожидается отступ на нижнем краю (0) гистограммы.

Кроме того, расширение отступа «натыкается» на приклеенные края и не может их пересекать. Например, если верхний предел данных равен 1,0, а верхний предел отображения, вычисленный с помощью простого добавления отступа, равен 1,2, но есть приклеенный край в 1,1, то фактический верхний предел отображения будет равен 1,1.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x является одномерной или двумерной последовательностью скаляров, и соответствующий массив значений rgba будет возвращен на основе установленной нормы и цветовой карты для этого объекта ScalarMappable.

Есть один специальный случай для обработки изображений, которые уже находятся в формате rgb или rgba, например, прочитанных из файла изображения. Если x является массивом с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакого отображения не будет выполнено. Массив может быть uint8 или плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет предварительно существующую прозрачность. ValueError будет поднят, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать числа с плавающей точкой в диапазоне 0-1; если оно равно True, возвращаемый массив rgba будет содержать uint8 в диапазоне от 0 до 255.

update(props)[исходный код]

Обновить свойства этого объекта из словаря props.

Параметры

propsdict

update_from(other)[исходный код]: Копировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета из массива скалярной отображаемой информации, если таковой имеется.

Назначить цвета границам и граням на основе массива и/или напрямую заданных цветов, если применимо.

zorder=0

classmatplotlib.collections.EllipseCollection(widths, heights, angles, units='points', **kwargs)[исходный код]

Базовые классы: matplotlib.collections.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)[исходный код]

Параметры

funccallable

Функция обратного вызова. Она должна иметь следующий вид:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует пределы скалярных значений на экземпляре нормы, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабирует пределы скалярных значений на экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None

propertyaxes: Экземпляр Axes, в котором находится объект, или None.

propertycallbacksSM[исходный код]

changed()[исходный код]: Вызывайте этот метод всякий раз, когда изменяется отображаемое значение, чтобы оповестить всех слушателей callbackSM о сигнале 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[исходный код]

Проверяет, произошло ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x с использованием типа единиц измерения оси x.

Если объект не находится в Axes или если ось x не имеет единиц измерения, возвращается само x.

convert_yunits(y)[исходный код]

Преобразует y с использованием типа единиц измерения оси y.

Если объект не находится в Axes или если ось y не имеет единиц измерения, возвращается само y.

draw(renderer)[исходный код]

Отрисовывает объект Artist (и его дочерние элементы) с помощью заданного рендерера.

Если объект не видим (Artist.get_visible возвращает False), это не повлияет на отрисовку.

Параметры

rendererПодкласс RendererBase.

Примечания

Этот метод переопределён в подклассах Artist.

findobj(match=None, include_self=True)[исходный код]

Поиск объектов Artist.

Рекурсивно находит все экземпляры Artist, содержащиеся в объекте Artist.

Параметры

match

Критерий фильтрации совпадений. Он может быть

None: возвращает все объекты, содержащиеся в объекте Artist.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только объекты Artist, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только объекты Artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включать self в список, подлежащий проверке на соответствие.

Возвращает

список Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами объектов Artist. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

Реализация по умолчанию преобразует целые числа, числа с плавающей точкой и массивы целых чисел и чисел с плавающей точкой в строку, разделённую запятыми и заключённую в квадратные скобки, если у объекта Artist нет связанной цветовой шкалы; в противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[исходный код]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешения. Не поддерживается во всех бэкендах.

get_animated()[исходный код]: Возвращает значение, указывающее, анимирован ли элемент.

get_array()[исходный код]

Возвращает массив значений, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

get_children()[исходный код]: Возвращает список дочерних элементов Artist данного Artist.

get_clim()[исходный код]: Возвращает значения (минимум, максимум), которые сопоставляются с пределами цветовой карты.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает значение, указывающее, использует ли объект Artist обрезку.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

Возвращает данные курсора для заданного события.

Примечание

Данные курсора могут использоваться объектами Artist для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращает None.

Единственный текущий вариант использования — отображение значения z изображения AxesImage в строке состояния окна графика при перемещении указателя мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure()[исходный код]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[исходный код]: Возвращает значение, указывающее, закрашен ли объект.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий шаблон штриховки.

get_in_layout()[исходный код]

Возвращает булево значение, True если элемент включён в вычисления макета.

Например, Руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

get_label()[исходный код]: Возвращает метку, используемую для данного элемента в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения данного элемента.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, растрируется ли элемент.

get_sketch_params()[исходный код]

Возвращает параметры наброска для элемента.

Возвращает

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний, перпендикулярных исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.

Возвращает None, если параметры наброска не были заданы.

get_snap()[исходный код]

Возвращает значение параметра привязки.

Подробности см. в set_snap.

get_tightbbox(renderer)[исходный код]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры

rendererподкласс RendererBase: рендерер, который будет использоваться для отрисовки графиков (т. е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая область (в пикселях координат фигуры).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с примененной неаффинной частью преобразования и оставшейся аффинной частью преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer)[исходный код]

Получает область элемента в пространстве отображения.

Ширина и высота области неотрицательны.

Подклассы должны переопределять для включения в расчет "плотной" области. По умолчанию возвращается пустая область в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если область окна элемента изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохраняться неправильно.

get_zorder()[исходный код]: Возвращает z-порядок элемента.

have_units()[исходный код]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[исходный код]

Возвращает, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

свойствоmouseover

Если это свойство установлено в True, к элементу будет обращаться для получения пользовательских данных контекста, когда курсор мыши перемещается по нему.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойствоnorm

pchanged()[исходный код]

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обработка события выбора.

Каждый дочерний элемент будет генерировать событие выбора, если mouseevent над элементом, и у элемента установлен picker.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает, может ли элемент быть выбран.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь всех свойств элемента.

remove()[исходный код]

Удаляет элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это необходимо.

Примечание: relim не обнаружит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[исходный код]

Удаление обратного вызова по его идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	Функция фильтра, которая принимает массив (m, n, 3) с плавающей запятой и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массив-подобный объект или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массив-подобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`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)[исходный код]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив чисел с плавающей точкой размером (m, n, 3) и значение dpi, и возвращает массив размером (m, n, 3).

set_alpha(alpha)[исходный код]

Установить значение альфа, используемое для смешивания — не поддерживается всеми бэкэндами.

Параметры

alphaмассив-подобный объект, скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли элемент для использования в анимации.

Если True, элемент исключается из обычного рисования фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_artist на элементе. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Более быстрая отрисовка с помощью блиттинга.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние антиалиасинга для отрисовки.

Параметры

aabool или список bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассив-подобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Установить стиль окончания CapStyle для коллекции (для всех ее элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормирования для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также могут быть переданы в виде кортежа (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[исходный код]

Установить область обрезки элемента Bbox.

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, использует ли элемент обрезку.

Если False, элементы будут видны за пределами области построения, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установите область обрезки для объекта.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если передан Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и задаст путь обрезки в None.

По техническим причинам (поддержка set), также принимается кортеж (path, transform) в качестве единственного позиционного параметра.

set_cmap(cmap)[исходный код]

Установите цветовую карту для данных яркости.

Параметры

cmapColormap или строка или None

set_color(c)[исходный код]

Установите цвет обводки и заливки.

Параметры

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для отдельной настройки цвета обводки или заливки.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Установите цвет(ы) обводки коллекции.

Параметры

cцвет или список цветов или 'face': Цвет(ы) обводки коллекции. Если список, участки циклически используют значения из списка. Если 'face', соответствует цвету заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Установите цвет(ы) заливки коллекции. c может быть цветом (все участки имеют одинаковый цвет) или списком цветов; если это список, участки будут циклически использовать значения из списка.

Если c равно 'none', участок не будет заливаться.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Установите экземпляр Figure, к которому принадлежит объект.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор (группы) для элемента.

Параметры

gidстрока

set_hatch(hatch)[исходный код]

Установить узор штриховки.

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)[исходный код]

Установить, должен ли элемент включаться в вычисления макета, например, Руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutлогическое

set_joinstyle(js)[исходный код]

Установить JoinStyle для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль линии(ей) для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	точечная линия

В качестве альтернативы можно указать кортеж с чернилами в следующем формате:

(offset, onoffseq),

где onoffseq является кортежем чётной длины, содержащим значения включения и выключения чернил в пунктах.

Параметры

lsстрока или кортеж или список кортежей: Допустимые значения для отдельных стилей линии включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить толщину линии(ей) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, области будут циклически проходить по последовательности

Параметры

lwчисло с плавающей точкой или список чисел с плавающей точкой

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если какие-либо цветовые шкалы используют карту для этой нормализации, установка нормализации карты сбросит нормализации, локализации и форматеры цветовой шкалы по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить трансформ смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установить смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[исходный код]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_paths()[исходный код]

set_picker(picker)[исходный код]

Определить поведение выбора элемента для объекта.

Параметры

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующего:

None: Выбор отключен для этого объекта (по умолчанию).
Булево значение: Если True, выбор будет включён, и объект будет генерировать событие выбора, если курсор мыши находится над объектом.
Число с плавающей точкой: Если значение picker — число, оно интерпретируется как допуск в точках, и объект будет генерировать событие выбора, если его данные находятся в пределах допуска от события мыши. Для некоторых объектов, таких как линии и коллекции объектов, объект может предоставить дополнительные данные для события выбора, например, индексы данных, находящиеся в пределах допуска от события выбора
Функция: Если picker — вызываемый объект, это функция, предоставляемая пользователем, которая определяет, попал ли курсор мыши по объекту:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над объектом, возвращается hit=True и props — словарь свойств, которые необходимо добавить к атрибутам события PickEvent.

set_pickradius(pr)[исходный код]

Установить радиус выбора, используемый для проверок принадлежности.

Параметры

prfloat: Радиус выбора в точках.

set_rasterized(rasterized)[исходный код]

Принудительно растрировать (преобразовать в растровый формат) отрисовку для векторной графики.

Растрированная отрисовка не поддерживается всеми объектами. Если вы попытаетесь включить её для объекта, который её не поддерживает, команда не повлияет, и будет выведено сообщение об ошибке.

Это значение игнорируется для выходных данных на основе пикселей.

См. также Растризация для векторной графики.

Параметры

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установить параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не предоставлен, фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, на который уменьшается или увеличивается длина (по умолчанию 16.0)

Фронт-энд PGF использует это значение в качестве семени генератора случайных чисел, а не как описано выше. Использование одного и того же семени приводит к одному и тому же случайному виду.

set_snap(snap)[исходный код]

Установить поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в обеих смежных пиксельных позициях. Напротив, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение будет действительно содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только задними планами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к центрам ближайших пикселей.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселей.

set_transform(t)[исходный код]

Установить трансформ объекта.

Параметры

tTransform

set_url(url)[исходный код]

Установить URL для объекта.

Параметры

urlstr

set_urls(urls)[исходный код]

Параметры

urlsсписок строк или None

Примечания

В настоящее время URL-адреса реализованы только в SVG-бэкенде. Они игнорируются всеми другими бэкендами.

set_visible(b)[исходный код]

Установить видимость элемента.

Параметры

bbool

set_zorder(level)[исходный код]

Установить 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)[исходный код]

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x является одномерным или двумерным последовательностью скаляров, и возвращается соответствующий массив значений rgba, основанный на установленной для этой ScalarMappable нормализации и цветовой карте.

Есть один специальный случай для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x является ndarray с 3 измерениями, и последнее измерение равно 3 или 4, то оно будет обрабатываться как массив rgb или rgba, и никакое отображение не будет выполняться. Массив может быть uint8 или он может быть с плавающей запятой со значениями в диапазоне от 0 до 1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет существующую прозрачность. Будет поднято исключение ValueError, если третье измерение отличается от 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет числами с плавающей запятой в диапазоне от 0 до 1; если оно равно True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.

update(props)[исходный код]

Обновить свойства этого элемента из словаря props.

Параметры

propsсловарь

update_from(other)[исходный код]: Скопировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета с помощью массива отображаемого скаляра, если таковой имеется.

Присвоить цвета к границам и граням на основе массива и/или цветов, которые были непосредственно установлены, соответственно.

zorder=0

classmatplotlib.collections.EventCollection(positions, orientation='horizontal', lineoffset=0, linelength=1, linewidth=None, color=None, linestyle='solid', antialiased=None, **kwargs)[исходный код]

Базы: matplotlib.collections.LineCollection

Коллекция положений вдоль одной оси, в которых произошло «событие».

События задаются одномерным массивом. У них нет амплитуды, и они отображаются как параллельные линии.

Параметры

positionsОдномерный массив-подобный объект

Каждое значение — это событие.

orientation{'horizontal', 'vertical'}, по умолчанию: 'horizontal'

Последовательность событий отображается в этом направлении. Линии маркеров отдельных событий направлены в перпендикулярном направлении.

lineoffsetfloat, по умолчанию: 0

Смещение центра маркеров от начала координат в направлении, перпендикулярном orientation.

linelengthfloat, по умолчанию: 1

Общая высота маркера (т.е. маркер простирается от lineoffset - linelength/2 до lineoffset + linelength/2).

linewidthfloat или список float, по умолчанию: rcParams["lines.linewidth"] (по умолчанию: 1.5)

Толщина линий событий в пунктах.

colorцвет или список цветов, по умолчанию: rcParams["lines.color"] (по умолчанию: 'C0')

Цвет линий событий.

linestyleстрока или кортеж или список кортежей, по умолчанию: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, задающий длину заливки и пропусков в пунктах.

antialiasedbool или список bool, по умолчанию: rcParams["lines.antialiased"] (по умолчанию: True)

Использовать ли сглаживание для рисования линий.

**kwargs

Передаются методу LineCollection.

Примеры

(Исходный код, png, pdf)

add_callback(func)[исходный код]

Параметры

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующий вид:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

add_positions(position)[исходный код]: Добавляет одно или несколько событий в указанных позициях.

append_positions(position)[исходный код]: Добавляет одно или несколько событий в указанных позициях.

autoscale()[исходный код]: Автоматически масштабирует пределы скаляров в экземпляре нормы с помощью текущего массива.

autoscale_None()[исходный код]: Автоматически масштабирует пределы скаляров в экземпляре нормы с помощью текущего массива, изменяя только отсутствующие пределы.

propertyaxes: Экземпляр Axes, в котором находится элемент, или None.

propertycallbacksSM[исходный код]

changed()[исходный код]: Вызовите этот метод всякий раз, когда изменяется отображаемый объект, чтобы оповестить все слушатели обратных вызовов callbacksSM о сигнале «changed».

colorbar: Последняя связанная с этим ScalarMappable цветная шкала. Может быть None.

contains(mouseevent)[исходный код]

Проверяет, произошло ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x с помощью типа единиц измерения оси x.

Если элемент не находится в Axes или у оси x нет единиц измерения, возвращается само x.

convert_yunits(y)[исходный код]

Преобразует y с помощью типа единиц измерения оси y.

Если элемент не находится в Axes или у оси y нет единиц измерения, возвращается само y.

draw(renderer)[исходный код]

Отрисовывает элемент (и его потомков) с помощью данного рендерера.

Это не имеет эффекта, если элемент не отображается (Artist.get_visible возвращает False).

Параметры

rendererRendererBase подкласс.

Примечания

Этот метод переопределён в подклассах элемента.

extend_positions(position)[исходный код]: Добавить одно или несколько событий в указанных позициях.

findobj(match=None, include_self=True)[исходный код]

Найти объекты художников.

Рекурсивно найти все экземпляры Artist, содержащиеся в художнике.

Параметры

match

Критерий фильтрации совпадений. Может быть

None: Вернуть все объекты, содержащиеся в художнике.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только тех художников, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только художников этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список для проверки соответствия.

Возвращает

список Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами художников. Вероятнее всего, пользователь Matplotlib не будет вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа и массивы целых и вещественных чисел в строку, разделенную запятыми, заключённую в квадратные скобки, если у художника нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[исходный код]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешения цветов - не поддерживается на всех бэкендах.

get_animated()[исходный код]: Возвращает, анимирован ли художник.

get_array()[исходный код]

Возвращает массив значений, которые отображаются в цветах.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

get_children()[исходный код]: Возвращает список дочерних художников Artist этого художника Artist.

get_clim()[исходный код]: Возвращает значения (мин, макс), отображаемые в пределах цветовой карты.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает, использует ли художник обрезку.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_color()[исходный код]: Возвращает цвет линий, используемых для маркировки каждого события.

get_colors()[исходный код]

get_cursor_data(event)[исходный код]

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами объектов-артистов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Данные курсора могут использоваться объектами-артистами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.

Подклассы могут переопределять метод и возвращать произвольные данные. Однако, при этом они должны гарантировать, что format_cursor_data может преобразовать данные в строковое представление.

Единственный текущий случай использования — отображение значения z объекта AxesImage в строке состояния окна графика при перемещении указателя мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure()[исходный код]: Возвращает экземпляр Figure, к которому относится данный объект-артист.

get_fill()[исходный код]: Возвращает, закрашен ли объект-артист.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий шаблон штриховки.

get_in_layout()[исходный код]

Возвращает логическое значение, True которое указывает, включён ли данный объект-артист в вычисления макета.

Например, Руководство по макетам с ограничением размеров, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

get_label()[исходный код]: Возвращает метку, используемую для этого объекта-артиста в легенде.

get_linelength()[исходный код]: Возвращает длину линий, используемых для маркировки каждого события.

get_lineoffset()[исходный код]: Возвращает смещение линий, используемых для маркировки каждого события.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]: Получить ширину линий, используемых для маркировки каждого события.

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом-артистом для смещения.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_orientation()[исходный код]: Возвращает ориентацию линии события ('горизонтальная' или 'вертикальная').

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_positions()[исходный код]: Возвращает массив, содержащий значения позиций с плавающей запятой.

get_rasterized()[исходный код]: Возвращает, следует ли растрировать элемент.

get_segments()[исходный код]

Возвращает

список: Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()[исходный код]

Возвращает параметры наброска для элемента.

Возвращает

кортеж или None

Кортеж длиной 3 с последующими элементами:

масштаб: Амплитуда волны перпендикулярно исходной линии.
длина: Длина волны по линии.
случайность: Коэффициент масштабирования, по которому длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были установлены.

get_snap()[исходный код]

Возвращает установку привязки.

Подробности см. в set_snap.

get_tightbbox(renderer)[исходный код]

Подобно Artist.get_window_extent, но включает любые обрезки.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая область (в пикселях координат рисунка).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает обрезку пути с применённой неаффинной частью его преобразования и оставшейся аффинной частью преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer)[исходный код]

Получение рамки элемента в пространстве отображения.

Ширина и высота рамки неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотной" рамки. По умолчанию возвращается пустая рамка в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если рамка окна элемента изменится. Рамка может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера рисунка или используемого холста (как это делается при сохранении рисунка). Это может привести к неожиданному поведению, где интерактивные рисунки будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder()[исходный код]: Возвращает z-порядок элемента.

have_units()[исходный код]: Возвращает, установлены ли единицы на какой-либо оси.

is_horizontal()[исходный код]: True, если коллекция событий горизонтальная, False, если вертикальная.

is_transform_set()[исходный код]

Возвращает, задано ли преобразование для элемента.

Это True после вызова set_transform.

свойствоmouseover

Если это свойство установлено в True, элемент будет запрошен для получения пользовательских данных контекста при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойствоnorm

pchanged()[исходный код]

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается неявно при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обработка события выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом и у элемента установлен селектор.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает, является ли элемент графического объекта доступным для выбора.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь всех свойств графического объекта.

remove()[исходный код]

Удаляет графический объект из фигуры, если это возможно.

Эффект не будет виден до повторной отрисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim, чтобы обновить пределы осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта.

remove_callback(oid)[исходный код]

Удаляет обратный вызов на основе идентификатора наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, colors=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linelength=<UNSET>, lineoffset=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, orientation=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, positions=<UNSET>, rasterized=<UNSET>, segments=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массивоподобный объект, скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список цветов
`colors`	цвет или список цветов
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linelength`	неизвестно
`lineoffset`	неизвестно
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массив (N, 2) или (2,) типа array-like
`orientation`	{'горизонтально', 'вертикально'}
`path_effects`	`AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или число с плавающей точкой или вызываемая функция
`pickradius`	число с плавающей точкой
`positions`	неизвестно
`rasterized`	bool
`segments`	неизвестно
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None

`verts`	неизвестно
`visible`	bool
`zorder`	float

set_aa(aa)[исходный код]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi и возвращает массив (m, n, 3).

set_alpha(alpha)[исходный код]

Установить значение альфа-канала для смешивания — поддерживается не всеми бэкендами.

Параметры

alphaмассив, скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Значения NaN и маскированные значения не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли художник для использования в анимации.

См. также matplotlib.animation и Более быстрая отрисовка с использованием буферизации.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние сглаживания при отрисовке.

Параметры

aabool или список значений bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить массив значений из объекта, подобного массиву, A.

Параметры

Aмассив или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Установить стиль окончания отрезков (CapStyle) для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормализации для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также можно передать в виде кортежа (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(clipbox)[исходный код]

Установить область обрезки художника (Bbox).

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, использует ли художник обрезку.

Если False, художники будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установить область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан Path, необходимо также указать transform. Если задано None, ранее установленная область обрезки удаляется.
transformTransform, необязательно: Используется только если path является Path. В этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит прямоугольную область обрезки и задаст путь обрезки в None.

По техническим причинам (поддержка set) также допускается передавать кортеж (path, transform) в качестве единственного позиционного параметра.

set_cmap(cmap)[исходный код]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

set_color(c)[исходный код]

Установить цвет или цвета обводки LineCollection.

Параметры

cцвет или список цветов: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей rgba; если передана последовательность, линии будут циклически переключаться между цветами из неё.

set_colors(c)[исходный код]

Установить цвет или цвета обводки LineCollection.

Параметры

cцвет или список цветов: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей rgba; если передана последовательность, линии будут циклически переключаться между цветами из неё.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Установить цвет или цвета обводки коллекции.

Параметры

cцвет, список цветов или 'face': Цвет или цвета обводки коллекции. Если передана последовательность, элементы будут циклически переключаться между цветами из неё. Если задано 'face', цвет соответствует цвету заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Установить цвет или цвета заливки коллекции. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если передана последовательность, элементы будут циклически переключаться между цветами из неё. Если c равно 'none', элемент не будет заливаться.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Установить экземпляр Figure, которому принадлежит элемент.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор (группы) для объекта.

Параметры

gidstr

set_hatch(hatch)[исходный код]

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно задать только для всего набора, а не для каждого элемента по отдельности.

Параметры

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[исходный код]

Установить, должен ли объект включаться в расчеты макета, например, Руководство по ограниченным макетам, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Установить JoinStyle для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linelength(linelength)[исходный код]: Установить длину линий, используемых для маркировки каждого события.

set_lineoffset(lineoffset)[исходный код]: Установить смещение линий, используемых для маркировки каждого события.

set_linestyle(ls)[исходный код]

Установить стиль(и) линии для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж с делениями следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины с чередованием длин линий и пробелов в пунктах.

Параметры

lsстрока или кортеж или список кортежей: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить ширину(ы) линии для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить через последовательность

Параметры

lwfloat или список чисел с плавающей точкой

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если какие-либо цветовые шкалы используют отображение для этой нормализации, установка нормализации отображения сбросит нормализацию, локали и форматирование на цветовой шкале по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить трансформирование смещения элемента.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установить смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_orientation(orientation)[исходный код]

Установить ориентацию линии события.

Параметры

orientation{'горизонтально', 'вертикально'}

set_path_effects(path_effects)[исходный код]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_paths(segments)[исходный код]

set_picker(picker)[исходный код]

Определить поведение выбора элемента.

Параметры

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующих:

None: Выбор отключен для этого элемента (по умолчанию).
Булево значение: Если True, выбор будет включен, и элемент будет генерировать событие выбора, если курсор мыши находится над элементом.
Число с плавающей запятой: Если picker — число, оно интерпретируется как допуск в точках, и элемент будет генерировать событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции областей, элемент может предоставлять дополнительные данные для события выбора, например, индексы данных в пределах допуска от события выбора.
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, определяющая, попадает ли элемент под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pr)[исходный код]

Установить радиус выбора, используемый для проверок попадания.

Параметры

prfloat: Радиус выбора в точках.

set_positions(positions)[исходный код]: Установить позиции событий.

set_rasterized(rasterized)[исходный код]

Вынудительное растрирование (отображение растровой графикой) для вывода векторной графики.

Растрирование не поддерживается всеми элементами. Если вы попытаетесь включить это для элемента, который его не поддерживает, команда не окажет никакого эффекта, и будет выведено предупреждение.

Это значение игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры

rasterizedbool

set_segments(segments)[исходный код]

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установить параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не предоставлено, фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебания по линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, с которым длина сжимается или расширяется (по умолчанию 16.0)

Бэкенд PGF использует это значение как начальное значение генератора псевдослучайных чисел, а не так, как описано выше. Использование одного и того же начального значения приводит к одному и тому же случайному изображению.

set_snap(snap)[исходный код]

Установить поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением на двух смежных пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к центру ближайшего пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные сегменты, округлить до ближайшего центра пикселя.

set_transform(t)[исходный код]

Установить преобразование объекта.

Параметры

tTransform

set_url(url)[исходный код]

Установить URL для объекта.

Параметры

urlstr

set_urls(urls)[исходный код]

Параметры

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_verts(segments)[исходный код]

set_visible(b)[исходный код]

Установить видимость объекта.

Параметры

bbool

set_zorder(level)[исходный код]

Установить z-порядок для объекта. Объекты с меньшими значениями z-порядка рисуются первыми.

Параметры

levelfloat

свойство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()[исходный код]: Переключить ориентацию линии события с вертикальной на горизонтальную или наоборот.

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает массив нормализованных значений RGBA, соответствующий x.

В обычном случае x является одномерной или двумерной последовательностью скаляров, и соответствующий массив значений RGBA возвращается на основе нормализации и цветовой карты, установленной для этого ScalarMappable.

Существует один специальный случай для обработки изображений, которые уже находятся в формате RGB или RGBA, например, которые были прочитаны из файла изображения. Если x является массивом с 3 измерениями, и последнее измерение составляет 3 или 4, то он будет обрабатываться как массив RGB или RGBA, и никакое отображение не будет выполнено. Массив может быть uint8 или массивом чисел с плавающей точкой со значениями в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение составляет 3, аргумент alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение составляет 4, аргумент alpha игнорируется; он не заменяет существующую прозрачность. Исключение ValueError будет вызвано, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив RGBA будет содержать числа с плавающей точкой в диапазоне 0–1; если оно равно True, возвращаемый массив RGBA будет иметь тип uint8 и значения в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого объекта с помощью словаря props.

Параметры

propsdict

update_from(other)[исходный код]: Копировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета из массива скалярного отображения, если таковой имеется.

Присвоить цвета краям и граням на основе массива и/или цветов, которые были непосредственно установлены, в зависимости от ситуации.

zorder=0

классmatplotlib.collections.LineCollection(segments, *args, zorder=2, **kwargs)[исходный код]

Базовые классы: matplotlib.collections.Collection

Представляет последовательность Line2D, которые должны быть нарисованы вместе.

Этот класс расширяет Collection, чтобы представлять последовательность Line2D вместо просто последовательности Patch. Как и в Collection, каждый атрибут LineCollection может быть либо одним значением, либо списком значений. Этот список циклически используется для каждого элемента LineCollection, поэтому атрибут i-го элемента коллекции:

prop[i % len(prop)]

Атрибуты каждого элемента LineCollection по умолчанию принимают значения из rcParams["lines.*"] вместо rcParams["patch.*"], и атрибут colors добавлен вместо edgecolors.

Параметры

segmentsсписок массивоподобных объектов

Последовательность (line0, line1, line2), где:

linen = (x0, y0), (x1, y1), ... (xm, ym)

или эквивалентный массив NumPy с двумя столбцами. Каждая линия может иметь разное количество сегментов.

linewidthsчисловой тип или список чисел, по умолчанию: rcParams["lines.linewidth"] (по умолчанию: 1.5)

Ширина каждой линии в пунктах.

colorsцвет или список цветов, по умолчанию: rcParams["lines.color"] (по умолчанию: 'C0')

Последовательность кортежей RGBA (например, строковые обозначения цветов и т.п., не допускаются).

antialiasedsлогическое значение или список логических значений, по умолчанию: rcParams["lines.antialiased"] (по умолчанию: True)

Использовать ли сглаживание для каждой линии.

zorderцелое число, по умолчанию: 2

z-порядок линий после отрисовки.

facecolorsцвет или список цветов, по умолчанию: 'none'

При установке facecolors каждая линия интерпретируется как граница области, неявно закрывая путь от последней точки к первой. Заключённая область заполняется facecolor. Для ручного указания того, что должно считаться "внутренней" частью каждой линии, используйте PathCollection вместо него, где "внутреннюю" часть можно указать с помощью CLOSEPOLY.

**kwargs

Передаётся в Collection.

add_callback(func)[исходный код]

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется один из атрибутов Artist.

Параметры

funcфункция

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist – вызываемый Artist. Возвращаемые значения могут быть любыми, но они игнорируются.

Возвращает

целое число: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback в дальнейшем.

См. также

remove_callback

autoscale()[исходный код]: Автомасштабирование пределов скаляров на экземпляре нормы с использованием текущего массива

autoscale_None()[исходный код]: Автомасштабирование пределов скаляров на экземпляре нормы с использованием текущего массива, изменяя только пределы, которые равны None

свойствоaxes: Экземпляр Axes, в котором находится элемент, или None.

свойствоcallbacksSM[исходный код]

changed()[исходный код]: Вызывается всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей callbackSM о событии 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может иметь значение None.

contains(mouseevent)[исходный код]

Проверяет, произошло ли событие мыши внутри коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразовать x с использованием типа единиц оси x.

Если элемент не находится в Axes или ось x не имеет единиц, возвращается само x.

convert_yunits(y)[исходный код]

Преобразовать y с использованием типа единиц оси y.

Если элемент не находится в Axes или ось y не имеет единиц, возвращается само y.

draw(renderer)[исходный код]

Отрисовать элемент (и его дочерние элементы) с помощью заданного средства визуализации.

Это не имеет эффекта, если элемент не видим (Artist.get_visible возвращает False).

Параметры

rendererподкласс RendererBase.

Примечания

Этот метод переопределён в подклассах Artist.

findobj(match=None, include_self=True)[исходный код]

Поиск объектов художника.

Рекурсивно найти все экземпляры Artist, содержащиеся в художнике.

Параметры

match

Критерий фильтрации совпадений. Это может быть

None: Возвращает все объекты, содержащиеся в художнике.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только художников этого класса или его подклассов (проверка isinstance).

include_selfbool

Включать self в список для проверки соответствия.

Возвращает

список Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами художников. Пользователь Matplotlib, скорее всего, не будет вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа и массивы целых и вещественных чисел в строку, разделенную запятыми, заключенную в квадратные скобки, если у художника нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[исходный код]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[исходный код]: Возвращает значение альфа для смешивания — не поддерживается на всех бэкендах.

get_animated()[исходный код]: Возвращает значение, указывающее, анимирован ли художник.

get_array()[исходный код]

Возвращает массив значений, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

get_children()[исходный код]: Возвращает список дочерних элементов Artist этого Artist.

get_clim()[исходный код]: Возвращает значения (мин, макс), которые сопоставляются с пределами цветовой карты.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает значение, указывающее, использует ли художник обрезку.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_color()[исходный код]

get_colors()[исходный код]

get_cursor_data(event)[исходный код]

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами графических элементов. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

Данные курсора могут использоваться графическими элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика при перемещении указателя мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure()[исходный код]: Возвращает экземпляр Figure, к которому принадлежит графический элемент.

get_fill()[исходный код]: Возвращает, закрашен ли объект.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_in_layout()[исходный код]

Возвращает логическое значение, True если графический элемент включён в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

get_label()[исходный код]: Возвращает метку, используемую для этого графического элемента в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, будет ли элемент растрирован.

get_segments()[исходный код]

Возвращает

список: Список отрезков в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()[исходный код]

Возвращает параметры наброска для элемента.

Возвращает

кортеж или None

3-кортеж со следующими элементами:

масштаб: Амплитуда колебаний, перпендикулярных исходной линии.
длина: Длина колебаний по линии.
случайность: Коэффициент масштабирования, по которому длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были заданы.

get_snap()[исходный код]

Возвращает значение настройки привязки.

Подробности см. в set_snap.

get_tightbbox(renderer)[исходный код]

Подобно Artist.get_window_extent, но включает любые обрезки.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки рисунков (т.е. fig.canvas.get_renderer())

Возвращает

Bbox: Включающая ограничивающая рамка (в пикселях координат фигуры).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с примененной частью преобразования, не зависящей от аффина, и оставшейся аффинной частью преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL-адресов, по одному на каждый элемент коллекции.

Список содержит None для элементов без URL-адреса. См. Гиперссылки для примера.

get_visible()[исходный код]: Возвращает значение видимости.

get_window_extent(renderer)[исходный код]

Получает прямоугольник ограничивающей рамки элемента в пространстве отображения.

Ширина и высота прямоугольника ограничивающей рамки неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотного" прямоугольника ограничивающей рамки. По умолчанию возвращает пустой прямоугольник в координатах 0, 0.

Будьте осторожны при использовании этой функции, результаты не будут обновляться, если прямоугольник ограничивающей рамки элемента изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к непредсказуемому поведению, где интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder()[исходный код]: Возвращает z-порядок элемента.

have_units()[исходный код]: Возвращает значение, указывающее, установлены ли единицы на какой-либо оси.

is_transform_set()[исходный код]

Возвращает значение, указывающее, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

propertymouseover

Если это свойство установлено в True, элемент будет запрошен для получения пользовательской информации о контексте, когда курсор мыши перемещается над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и для элемента установлен параметр picker.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает значение, указывающее, можно ли выбрать элемент.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь со всеми свойствами элемента.

remove()[исходный код]

Удаляет элемент из фигуры, если это возможно.

Эффект будет виден только после перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[исходный код]

Удаляет обратный вызов на основе его идентификатора наблюдателя.

См. также

add_callback

set(*, agg_filter=<НЕ ЗАДАНО>, alpha=<НЕ ЗАДАНО>, animated=<НЕ ЗАДАНО>, antialiased=<НЕ ЗАДАНО>, array=<НЕ ЗАДАНО>, capstyle=<НЕ ЗАДАНО>, clim=<НЕ ЗАДАНО>, clip_box=<НЕ ЗАДАНО>, clip_on=<НЕ ЗАДАНО>, clip_path=<НЕ ЗАДАНО>, cmap=<НЕ ЗАДАНО>, color=<НЕ ЗАДАНО>, colors=<НЕ ЗАДАНО>, edgecolor=<НЕ ЗАДАНО>, facecolor=<НЕ ЗАДАНО>, gid=<НЕ ЗАДАНО>, hatch=<НЕ ЗАДАНО>, in_layout=<НЕ ЗАДАНО>, joinstyle=<НЕ ЗАДАНО>, label=<НЕ ЗАДАНО>, linestyle=<НЕ ЗАДАНО>, linewidth=<НЕ ЗАДАНО>, norm=<НЕ ЗАДАНО>, offset_transform=<НЕ ЗАДАНО>, offsets=<НЕ ЗАДАНО>, path_effects=<НЕ ЗАДАНО>, paths=<НЕ ЗАДАНО>, picker=<НЕ ЗАДАНО>, pickradius=<НЕ ЗАДАНО>, rasterized=<НЕ ЗАДАНО>, segments=<НЕ ЗАДАНО>, sketch_params=<НЕ ЗАДАНО>, snap=<НЕ ЗАДАНО>, transform=<НЕ ЗАДАНО>, url=<НЕ ЗАДАНО>, urls=<НЕ ЗАДАНО>, verts=<НЕ ЗАДАНО>, visible=<НЕ ЗАДАНО>, zorder=<НЕ ЗАДАНО>)[исходный код]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
`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`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список цветов
`colors`	цвет или список цветов
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`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`	число с плавающей точкой

END_OF_DOCUMENT_MARKER

set_aa(aa)[исходный код]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi, и возвращает массив (m, n, 3).

set_alpha(alpha)[исходный код]

Установить значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

Параметры

alphaмассив-подобный объект или скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли художник для использования в анимации.

Если True, художник исключается из обычного рисования фигуры. Вам необходимо явно вызвать Figure.draw_artist / Axes.draw_artist на художнике. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Более быстрое отображение с использованием blitting.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние антиалиасинга для рендеринга.

Параметры

aabool или список bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассив-подобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Установить CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормализации для масштабирования изображения.

Параметры

vmin, vmaxчисло с плавающей точкой

Пределы.

Пределы также можно передать как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(clipbox)[исходный код]

Установить область обрезки объекта для художника.

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, использует ли художник обрезку.

Если False, художники будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установить область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан объект Path, необходимо также указать transform. Если None, ранее заданная область обрезки будет удалена.
transformTransform, необязательно: Используется только если path является объектом Path, в этом случае заданный объект Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path является объектом Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и установит путь обрезки в None.

set_cmap(cmap)[исходный код]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

set_color(c)[исходный код]

Установить цвет(а) контура LineCollection.

Параметры

cцвет или список цветов: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически использовать цвета из последовательности.

set_colors(c)[исходный код]

Установить цвет(а) контура LineCollection.

Параметры

cцвет или список цветов: Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически использовать цвета из последовательности.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Установить цвет(а) контура коллекции.

Параметры

cцвет или список цветов или 'face': Цвет(а) контура коллекции. Если последовательность, элементы будут циклически использоваться для рисования. Если 'face', будет использоваться цвет заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Установить цвет(а) заливки коллекции. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если это последовательность, элементы будут циклически использовать цвета из последовательности.

Если c равно 'none', элемент не будет заливаться.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Установить экземпляр Figure, к которому относится элемент.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор (группы) для объекта.

Параметры

gidstr

set_hatch(hatch)[исходный код]

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого узора.

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всего набора, а не для каждого элемента по отдельности.

Параметры

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[исходный код]

Установить, должен ли элемент отображаться в расчетах макета, например, в руководстве по ограниченным макетам, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Установить JoinStyle для коллекции (для всех ее элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sobject: s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль(и) линии(й) для коллекции.

linestyle	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	штриховая линия

В качестве альтернативы можно предоставить кортеж с точками:

(offset, onoffseq),

где onoffseq - кортеж чётной длины, содержащий значения включения и выключения чернил в пунктах.

Параметры

lsстрока или кортеж: Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность вкл-выкл)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить толщину(ы) линии(й) для коллекции. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить через последовательность.

Параметры

lwчисловой или список чисел

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие отображаемый объект для этой нормализации, установка нормализации отображаемого объекта сбросит нормализацию, локализацию и форматтеры цветовой шкалы по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить преобразование смещения элемента.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установить смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[исходный код]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_paths(segments)[исходный код]

set_picker(picker)[исходный код]

Определение поведения выбора элемента.

Параметры

pickerNone, bool, float или вызываемый объект

Это может быть одно из следующих значений:

None: выбор отключён для данного элемента (по умолчанию).
Логическое значение: если True, выбор будет включён, и элемент сгенерирует событие выбора, если курсор мыши находится над элементом.
Число с плавающей точкой: если picker — число, оно интерпретируется как радиус допуска в точках, и элемент сгенерирует событие, если данные находятся в пределах этого радиуса от события мыши. Для некоторых элементов, таких как линии и коллекции объектов, элемент может передать в событие выбора дополнительные данные, например индексы данных, находящихся в пределах радиуса допуска от места выбора.
Функция: если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли элемент под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если курсор мыши находится над элементом, верните hit=True, а также props — словарь свойств, которые нужно добавить к атрибутам PickEvent.

set_pickradius(pr)[исходный код]

Установить радиус выбора, используемый для проверки попадания.

Параметры

prfloat: Радиус выбора в точках.

set_rasterized(rasterized)[исходный код]

Принудительное растровое (битовое) отображение для векторной графики.

Растровое отображение поддерживается не всеми элементами. Если попытаться включить его для элемента, который его не поддерживает, команда не даст результата и будет выдано предупреждение.

Это свойство игнорируется для растровой графики.

См. также Растровое отображение для векторной графики.

Параметры

rasterizedbool

set_segments(segments)[исходный код]

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установить параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда волнообразного смещения перпендикулярно исходной линии в пикселях. Если scale — None или не указан, фильтр наброска применяться не будет.

lengthfloat, необязательно

Длина волнообразного смещения вдоль линии в пикселях (по умолчанию 128.0).

randomnessfloat, необязательно

Коэффициент масштабирования, определяющий, насколько укорачивается или увеличивается длина (по умолчанию 16.0).

Бэкенд PGF использует этот аргумент как начальное значение для генератора случайных чисел, а не в описанном выше смысле. Использование одинаковых начальных значений приводит к одинаковой случайной форме.

set_snap(snap)[исходный код]

Установить поведение привязки.

Привязка выравнивает позиции по пиксельной сетке, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель задана в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть оба соседних пикселя будут серыми. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что результирующее изображение действительно будет содержать чёрную линию шириной 1 пиксель.

В настоящее время привязка поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: привязать вершины к ближайшему центру пикселя.
False: не изменять позиции вершин.
None: (автоматически) округлить до ближайшего центра пикселя, если путь содержит только прямолинейные отрезки.

set_transform(t)[исходный код]

Установить преобразование элемента.

Параметры

tTransform

set_url(url)[исходный код]

Установить URL объекта.

Параметры

urlстрока

set_urls(urls)[исходный код]

Параметры

urlsсписок строк или None

Примечания

В настоящее время URL реализованы только в бэкенде SVG. Все остальные бэкенды их игнорируют.

set_verts(segments)[исходный код]

set_visible(b)[исходный код]

Установить видимость объекта.

Параметры

bbool

set_zorder(level)[исходный код]

Установить 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)[исходный код]

Возвращает нормализованный массив RGBA, соответствующий x.

В обычном случае x представляет собой одномерную или двумерную последовательность скалярных значений, а соответствующий массив значений RGBA возвращается на основе заданных нормы и цветовой карты этого объекта ScalarMappable.

Существует особый случай для обработки изображений, уже представленных в формате RGB или RGBA, например прочитанных из файла изображения. Если x представляет собой трёхмерный массив, последнее измерение которого равно 3 или 4, он обрабатывается как массив RGB или RGBA, и отображение не выполняется. Массив может иметь тип uint8 или содержать числа с плавающей точкой в диапазоне от 0 до 1; в противном случае будет вызвано исключение ValueError. Если массив содержит маску, она игнорируется. Если последнее измерение равно 3, параметр alpha (по умолчанию 1) используется для заполнения значений прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется и не заменяет существующие значения прозрачности. Если третье измерение не равно 3 или 4, будет вызвано исключение ValueError.

В любом случае, если bytes равно False (по умолчанию), массив RGBA содержит числа с плавающей точкой в диапазоне от 0 до 1; если он равен True, возвращаемый массив RGBA будет иметь тип uint8 и значения в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется; предполагается, что они находятся в диапазоне (0–1).

update(props)[исходный код]

Обновить свойства этого объекта из словаря props.

Параметры

propsсловарь

update_from(other)[исходный код]: Скопировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета из массива скалярного отображаемого объекта, если таковой имеется.

Назначить цвета рёбрам и граням на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.

zorder=0

классmatplotlib.collections.PatchCollection(patches, match_original=False, **kwargs)[исходный код]

Основы: matplotlib.collections.Collection

Общее множество элементов.

Это упрощает назначение цветовой карты неоднородному множеству элементов.

Это также может повысить скорость построения графиков, поскольку PatchCollection будет отображаться быстрее, чем большое количество элементов.

patches: последовательность объектов Patch. Этот список может содержать разнородный набор различных типов элементов.
match_original: Если True, используйте цвета и ширины линий исходных элементов. Если False, новые цвета могут быть назначены путем предоставления стандартных аргументов коллекции, facecolor, edgecolor, linewidths, norm или cmap.

Если какие-либо из edgecolors, facecolors, linewidths, antialiaseds равны None, они по умолчанию принимают значение соответствующей настройки rcParams для элементов, в последовательном формате.

Использование функциональности ScalarMappable является необязательным. Если матрица ScalarMappable _A была установлена (через вызов set_array), во время рисования будет вызван вызов скалярного отображаемого объекта для установки цветов заливки.

add_callback(func)[исходный код]

Добавьте функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Параметры

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующий вид:

def func(artist: Artist) -> Any

где artist является вызывающим Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback в дальнейшем.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует пределы скаляров на объекте norm с использованием текущего массива.

autoscale_None()[исходный код]: Автоматически масштабирует пределы скаляров на объекте norm с использованием текущего массива, изменяя только пределы, которые равны None.

свойствоaxes: Объект Axes, в котором находится элемент, или None.

свойствоcallbacksSM[исходный код]

changed()[исходный код]: Вызовите эту функцию всякий раз, когда изменяется отображение, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим объектом ScalarMappable. Может быть None.

contains(mouseevent)[исходный код]

Проверка, произошло ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразование x с использованием типа единиц оси x.

Если элемент не находится в оси или если ось x не имеет единиц, возвращается значение x.

convert_yunits(y)[исходный код]

Преобразование y с использованием типа единиц оси y.

Если элемент не находится в оси или если ось y не имеет единиц, возвращается значение y.

draw(renderer)[исходный код]

Отображение элемента (и его дочерних элементов) с помощью указанного рендерера.

Это не имеет эффекта, если элемент не отображается (Artist.get_visible возвращает False).

Параметры

rendererподкласс RendererBase.

Примечания

Этот метод переопределен в подклассах Artist.

findobj(match=None, include_self=True)[исходный код]

Поиск элементов.

Рекурсивно находит все экземпляры Artist, содержащиеся в элементе.

Параметры

match

Критерий фильтрации соответствий. Это может быть

None: Возвращает все элементы, содержащиеся в элементе.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (проверка isinstance).

include_selfbool

Включать self в список, который будет проверяться на соответствие.

Возвращает

список Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами элементов управления. Пользователю Matplotlib, скорее всего, не нужно вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа и массивы целых и вещественных чисел в строку, разделенную запятыми, заключённую в квадратные скобки, если у элемента управления нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[исходный код]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания — не поддерживается во всех бэкендах.

get_animated()[исходный код]: Возвращает, анимирован ли элемент управления.

get_array()[исходный код]

Возвращает массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

get_children()[исходный код]: Возвращает список дочерних элементов Artist этого Artist.

get_clim()[исходный код]: Возвращает значения (min, max), отображаемые на цветовой шкале.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает, используется ли обрезка для элемента управления.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

Возвращает данные курсора для данного события.

Примечание

Данные курсора могут использоваться элементами управления для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Единственный текущий случай использования — отображение значения z объекта AxesImage в строке состояния окна графика при перемещении мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure()[исходный код]: Возвращает экземпляр Figure, к которому относится данный элемент.

get_fill()[исходный код]: Возвращает значение, указывающее, заливается ли объект цветом.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_in_layout()[исходный код]

Возвращает логическое значение, True указывающее, включён ли элемент в расчёт макета.

Например, Руководство по увязке компоновки, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

get_label()[исходный код]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом для смещения.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

END_OF_DOCUMENT_MARKER

get_picker()[исходный код]

Возвращает поведение выбора объекта.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, растрирован ли объект.

get_sketch_params()[исходный код]

Возвращает параметры наброска для объекта.

Возвращает

tuple или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, с которым длина сжимается или расширяется.

Возвращает None, если параметры наброска не были установлены.

get_snap()[исходный код]

Возвращает установку привязки.

Подробности см. в set_snap.

get_tightbbox(renderer)[исходный код]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает

Bbox: Включающая ограничивающая рамка (в пиксельных координатах фигуры).

get_transform()[исходный код]: Возвращает объект Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой не-аффинной частью его преобразования и оставшейся аффинной частью преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Гиперссылки для примера.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer)[исходный код]

Получение ограничивающей рамки объекта в пространстве отображения.

Ширина и высота ограничивающей рамки неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотной" ограничивающей рамки. По умолчанию возвращается пустая ограничивающая рамка в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если ограничивающая рамка окна объекта изменится. Ограничивающая рамка может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, где интерактивные фигуры будут выглядеть нормально на экране, но будут сохраняться неправильно.

get_zorder()[исходный код]: Возвращает z-порядок объекта.

have_units()[исходный код]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[исходный код]

Возвращает, есть ли у объекта явно установленное преобразование.

Это True после вызова set_transform.

END_OF_DOCUMENT_MARKER

свойствоmouseover

Если это свойство установлено в True, объект будет запрашиваться для пользовательской информации контекста при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойство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]

Удаляет графический элемент из фигуры, если это возможно.

Примечание: 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>, 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`	`Bbox`
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(alpha)[исходный код]

Установить значение альфа-канала, используемое для смешивания — поддерживается не всеми бэкендами.

Параметры

alphaмассив-подобный объект, скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли объект для использования в анимации.

Если True, объект исключается из обычного рисования фигуры. Вам необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для объекта. Данный подход используется для ускорения анимации с помощью кеширования.

См. также matplotlib.animation и Более быстрое отображение с помощью кеширования.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние сглаживания при рендеринге.

Параметры

aabool или список bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассив-подобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Установить стиль окончания штриха CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормы для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также могут быть переданы как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[исходный код]

Установить ограничивающую рамку обрезки объекта Bbox.

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, используется ли обрезка для объекта.

Если False, объекты будут видны за пределами осей, что может привести к непредсказуемым результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установить путь обрезки объекта.

Параметры

pathPatch или Path или TransformedPath или None: Путь обрезки. Если задан Path, необходимо также указать transform. Если задано значение None, ранее установленный путь обрезки будет удалён.
transformTransform, необязательно: Используется только если path является Path; в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит рамку обрезки соответствующего прямоугольника и установит путь обрезки в None.

По техническим причинам (поддержка set) в качестве единственного позиционного параметра также принимается кортеж (path, transform).

set_cmap(cmap)[исходный код]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

set_color(c)[исходный код]

Установить цвет края и цвет заливки.

Параметры

cцвет или список кортежей rgba

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для отдельной настройки цвета края или заливки.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Установить цвет(а) обводки коллекции.

Параметры

cцвет или список цветов или 'face': Цвет(а) обводки коллекции. Если задана последовательность, фигуры циклически проходят по ней. Если задано значение 'face', цвет совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Установить цвет(а) заливки коллекции. c может быть цветом (все фигуры имеют один цвет) или последовательностью цветов; если задана последовательность, фигуры будут перебирать её элементы.

Если c равно 'none', фигура не будет закрашена.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Установить экземпляр Figure, которому принадлежит объект.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор (группы) для графического элемента.

Параметры

gidstr

set_hatch(hatch)[исходный код]

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, плотность штриховки этого узора увеличивается.

Штриховка поддерживается только в графических движках PostScript, PDF, SVG и Agg.

Параметры

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[исходный код]

Установить, будет ли графический элемент включён в расчёт макета, например, в Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Установить стиль соединения JoinStyle для всего набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль(и) линии для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	пунктирная линия
`':'` или `'dotted'`	точечная линия

В качестве альтернативы можно указать кортеж с делениями в следующем формате:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий интервалы включения и выключения чернил в пунктах.

Параметры

lsстрока или кортеж/список элементов: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения)}. Смотрите Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить ширину линии(й) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, то области будут циклически проходить через последовательность.

Параметры

lwчисло или список чисел

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если какие-либо цветные шкалы используют карту цветов для этой нормализации, установка нормализации карты цветов сбросит нормализацию, локатор и форматирование на цветной шкале на значения по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить преобразование смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установить смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[исходный код]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_paths(patches)[исходный код]

set_picker(picker)[исходный код]

Определить поведение выбора объекта.

Параметры

pickerNone или bool или float или вызываемая функция

Это может быть одно из следующих значений:

None: Выбор отключен для этого объекта (по умолчанию).
Булево значение: если True, выбор будет включен, и объект будет генерировать событие выбора, если указатель мыши находится над ним.
Число с плавающей точкой: если picker — это число, оно интерпретируется как допуск в точках, и объект будет генерировать событие, если его данные находятся в пределах допуска от события мыши. Для некоторых объектов, таких как линии и коллекции фигур, объект может предоставлять дополнительные данные для события выбора, например, индексы данных, находящихся в пределах допуска от события выбора.
Вызываемая функция: если picker — это вызываемая функция, это функция, предоставленная пользователем, которая определяет, попадает ли объект под курсор мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если указатель мыши находится над объектом, верните hit=True, а props — это словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pr)[исходный код]

Установить радиус выбора, используемый для проверки попадания.

Параметры

prfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительное растровое (битовое) отображение для векторизованного графического вывода.

Растровое отображение не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не будет иметь никакого эффекта, и будет выдано предупреждение.

Эта настройка игнорируется для пиксельного вывода.

См. также Растрирование векторной графики.

Параметры

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установить параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебания перпендикулярно исходной линии в пикселях. Если scale — None или не предоставлено, фильтр наброска применяться не будет.

lengthfloat, необязательно

Длина колебания вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, с которым длина сжимается или расширяется (по умолчанию 16.0)

Бэкенд PGF использует этот аргумент как начальное значение генератора случайных чисел, а не так, как описано выше. Использование одного и того же начального значения приводит к одному и тому же случайному рисунку.

set_snap(snap)[исходный код]

Установить поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением на обеих смежных пиксельных позициях. В противоположность этому, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что результирующее изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только графическими движками Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя.

set_transform(t)[исходный код]

Установить преобразование объекта.

Параметры

tTransform

set_url(url)[исходный код]

Установить URL для объекта.

Параметры

urlstr

set_urls(urls)[source]

Параметры

urlsсписок строк или None

Примечания

В настоящее время URL-адреса реализованы только в бэкенде SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установить видимость объекта.

Параметры

bbool

set_zorder(level)[source]

Установить z-порядок объекта. Объекты с более низкими значениями zorder рисуются первыми.

Параметры

levelfloat

propertystale: Является ли объект "неактуальным" и нуждается ли он в перерисовке для соответствия внутреннему состоянию.

propertysticky_edges

x и y списки прилипающих границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется - предел просмотра «прилипает» к краю. Типичный пример использования - гистограммы, где обычно не ожидается отступ на нижнем краю (0) гистограммы.

Кроме того, расширение отступа «натыкается» на прилипающие края и не может их пересечь. Например, если верхний предел данных составляет 1,0, верхний предел просмотра, вычисленный с применением простого отступа, составляет 1,2, но существует прилипающий край в 1,1, то фактический верхний предел просмотра будет 1,1.

Этому атрибуту нельзя присваивать значения; однако списки x и y могут быть изменены на месте по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[source]

Возвращает массив rgba, соответствующий x, в нормализованном виде.

В обычном случае x — это 1D или 2D последовательность скаляров, и будет возвращён соответствующий массив rgba-значений, основанный на установленном нормализующем и цветовом отображении для этого объекта ScalarMappable.

Существует один особый случай, для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x — это массив с 3 измерениями, и последнее измерение — 3 или 4, то он будет обработан как rgb или rgba массив и отображение не будет выполнено. Массив может быть uint8 или плавающей точкой с значениями в диапазоне от 0 до 1; в противном случае будет возбуждено исключение ValueError. Если это массив с маскировкой, маска будет проигнорирована. Если последнее измерение равно 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 в self.

update_scalarmappable()[source]

Обновить цвета из массива скалярного отображения, если таковой имеется.

Присвоить цвета границам и граням на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.PathCollection(paths, sizes=None, **kwargs)[source]

Базовые классы: matplotlib.collections._CollectionWithSizes

Коллекция объектов Path, создаваемых, например, с помощью scatter.

Параметры

pathsсписок объектов path.Path: Пути, из которых будет состоять Collection.
sizesмассивоподобный объект: Коэффициент масштабирования каждого отображаемого объекта Path. Одна квадратная единица в пространстве данных Path масштабируется до sizes**2 пунктов при отображении.
**kwargs: Передаются в Collection.

add_callback(func)[source]

Добавить функцию обратного вызова, которая будет вызываться при изменении любого из свойств объекта Artist.

Параметры

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующую сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий объект Artist. Возвращаемые значения допустимы, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с функцией обратного вызова. Этот идентификатор можно позже использовать для удаления функции обратного вызова с помощью remove_callback.

См. также

remove_callback

autoscale()[source]: Автоматически масштабировать скалярные пределы экземпляра norm, используя текущий массив

autoscale_None()[source]: Автоматически масштабировать скалярные пределы экземпляра norm, используя текущий массив; изменяются только пределы, равные None

propertyaxes: Экземпляр Axes, в котором находится объект Artist, или None.

propertycallbacksSM[source]

changed()[source]: Вызывать этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех прослушивателей callbackSM о сигнале 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим объектом ScalarMappable. Может быть равна None.

contains(mouseevent)[source]

Проверить, произошло ли событие мыши внутри коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент itemlist содержит событие.

convert_xunits(x)[source]

Преобразовать x, используя тип единиц оси x.

Если объект Artist не находится внутри Axes или если у оси x нет единиц измерения, возвращается само значение x.

convert_yunits(y)[source]

Преобразовать y, используя тип единиц оси y.

Если объект Artist не находится внутри Axes или если у оси y нет единиц измерения, возвращается само значение y.

draw(renderer)[source]

Нарисовать объект Artist (и его дочерние объекты) с помощью указанного средства визуализации.

Ничего не делает, если объект Artist невидим (Artist.get_visible возвращает False).

Параметры

rendererподкласс RendererBase.

Примечания

Этот метод переопределён в подклассах Artist.

findobj(match=None, include_self=True)[source]

Найти объекты Artist.

Рекурсивно найти все экземпляры Artist, содержащиеся в объекте Artist.

Параметры

match

Критерий фильтрации результатов. Возможные значения:

None: вернуть все объекты, содержащиеся в объекте Artist.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только объекты Artist, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только объекты Artist этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список объектов, проверяемых на соответствие.

Возвращает

список объектов Artist

format_cursor_data(data)[источник]

Возвращает строковое представление данных data.

Примечание

Этот метод предназначен для переопределения в подклассах элементов. Скорее всего, вам, как пользователю Matplotlib, не придётся вызывать его самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделенную запятыми и заключенную в квадратные скобки, если у элемента нет связанной цветовой шкалы. В противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[источник]: Возвращает функцию фильтра для использования с agg фильтром.

get_alpha()[источник]: Возвращает значение альфа-канала, используемое для смешивания — не поддерживается всеми бэкендами.

get_animated()[источник]: Возвращает значение, указывающее, является ли элемент анимированным.

get_array()[источник]

Возвращает массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[источник]

get_children()[источник]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[источник]: Возвращает значения (минимальное, максимальное), которые отображаются в пределы цветовой карты.

get_clip_box()[источник]: Возвращает ограничивающую рамку.

get_clip_on()[источник]: Возвращает значение, указывающее, используется ли обрезка.

get_clip_path()[источник]: Возвращает путь обрезки.

get_cmap()[источник]: Возвращает экземпляр Colormap.

get_cursor_data(event)[источник]

Возвращает данные курсора для заданного события.

Примечание

Данные курсора могут быть использованы элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Подклассы могут переопределять метод и возвращать произвольные данные. Однако, при этом они должны убедиться, что format_cursor_data может преобразовать данные в строковое представление.

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика при перемещении мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[источник]: Псевдоним для get_linestyle.

get_datalim(transData)[источник]

get_ec()[источник]: Псевдоним для get_edgecolor.

get_edgecolor()[источник]

get_edgecolors()[источник]: Псевдоним для get_edgecolor.

get_facecolor()[источник]

get_facecolors()[источник]: Псевдоним для get_facecolor.

get_fc()[источник]: Псевдоним для get_facecolor.

get_figure()[источник]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[источник]: Возвращает значение, указывающее, закрашена ли область.

get_gid()[источник]: Возвращает идентификатор группы.

get_hatch()[источник]: Возвращает текущий шаблон штриховки.

get_in_layout()[источник]

Возвращает логическое значение, True если элемент включён в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[источник]

get_label()[источник]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[источник]

get_linestyles()[источник]: Псевдоним для get_linestyle.

get_linewidth()[источник]

get_linewidths()[источник]: Псевдоним для get_linewidth.

get_ls()[источник]: Псевдоним для get_linestyle.

get_lw()[источник]: Псевдоним для get_linewidth.

get_offset_transform()[источник]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[источник]: Возвращает смещения для коллекции.

get_path_effects()[источник]

get_paths()[источник]

get_picker()[исходный код]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, должен ли элемент быть растрированным.

get_sizes()[исходный код]

Возвращает размеры (площади) элементов в коллекции.

Возвращает

массив: Площадь каждого элемента.

get_sketch_params()[исходный код]

Возвращает параметры наброска для элемента.

Возвращает

кортеж или None

3-кортеж со следующими элементами:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.

Возвращает None, если параметры наброска не были заданы.

get_snap()[исходный код]

Возвращает установку привязки.

Подробности см. в set_snap.

get_tightbbox(renderer)[исходный код]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры

rendererподкласс RendererBase: объект рендерера, который будет использоваться для отрисовки графиков (т. е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая прямоугольная область (в пикселях координат рисунка).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой неаффинной частью преобразования и оставшейся аффинной частью преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному на каждый элемент коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer)[исходный код]

Получение прямоугольника элемента в пространстве отображения.

Ширина и высота прямоугольника неотрицательны.

Подклассы должны переопределять для включения в вычисление «узкого» прямоугольника. По умолчанию возвращает пустой прямоугольник в координатах 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если прямоугольник окна элемента изменится. Это может произойти из-за изменений в стеке преобразований, например, при изменении пределов осей, размера рисунка или используемой области рисования (как при сохранении рисунка). Это может привести к неожиданному поведению, когда интерактивные рисунки будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder()[исходный код]: Возвращает z-порядок элемента.

have_units()[исходный код]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[исходный код]

Возвращает, имеет ли элемент управления явно заданное преобразование.

Это True после вызова set_transform.

legend_elements(prop='colors', num='auto', fmt=None, func=<function PathCollection.<lambda>>, **kwargs)[исходный код]

Создает элементы легенды для PathCollection.

Каждый элемент легенды — это Line2D, представляющий путь, который был нарисован, а каждое описание — строка, обозначающая, что представляет собой каждый путь.

Это полезно для получения легенды для графика scatter; например:

scatter = plt.scatter([1, 2, 3],  [4, 5, 6],  c=[7, 2, 3])
plt.legend(*scatter.legend_elements())

создает три элемента легенды, по одному для каждого цвета с числовыми значениями, переданными в c, как описания.

См. также пример Автоматическое создание легенды.

Параметры

prop{"colors", "sizes"}, по умолчанию: "colors": Если "colors", элементы легенды будут показывать разные цвета коллекции. Если "sizes", легенда будет показывать разные размеры. Чтобы установить оба, используйте kwargs для непосредственного изменения свойств Line2D.
numint, None, "auto" (по умолчанию), массив-подобный или Locator: Целевое количество элементов для создания. Если None, используйте все уникальные элементы массива отображаемого объекта. Если целое число, используйте num элементов в нормированном диапазоне. Если "auto", попробуйте определить, какой вариант лучше подходит для данных. Количество созданных элементов может незначительно отличаться от num из-за использования Locator для поиска подходящих позиций. Если список или массив, используйте именно эти элементы для легенды. Наконец, можно указать Locator.
fmtстрока, Formatter или None (по умолчанию): Формат или форматировщик для использования для меток. Если строка, должна быть допустимым входом для StrMethodFormatter. Если None (по умолчанию), используйте ScalarFormatter.
funcфункция, по умолчанию: lambda x: x: Функция для вычисления меток. Часто аргумент размера (или цвета) для scatter будет предварительно обработан пользователем с помощью функции s = f(x) для отображения маркеров; например, size = np.log10(x). Предоставление обратной функции позволяет инвертировать эту предварительную обработку, чтобы метки легенды имели правильные значения; например, func = lambda x: 10**x.
**kwargs: Допустимыми ключевыми аргументами являются color и size. Например, может быть полезно установить цвет маркеров, если используется prop="sizes"; аналогично, для установки размера маркеров, если используется prop="colors". Все дополнительные параметры передаются экземпляру Line2D. Это может быть полезно, например, для задания другого markeredgecolor или alpha для элементов легенды.

Возвращает

handlesсписок Line2D: Визуальное представление каждого элемента легенды.
labelsсписок строк: Строковые метки для элементов легенды.

свойствоmouseover

Если это свойство установлено в True, элемент управления будет запрошен для получения информации о контексте при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойствоnorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний элемент управления запустит событие выбора, если mouseevent находится над элементом управления и для элемента управления установлен picker.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает, является ли элемент управления выбираемым.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь со всеми свойствами элемента управления.

remove()[исходный код]

Удалить элемент графического объекта из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim, чтобы обновить пределы осей, если это необходимо.

Примечание: relim не будут учитывать коллекции, даже если коллекция была добавлена на ось с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта.

remove_callback(oid)[исходный код]

Удалить обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массивоподобное значение или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобное значение или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобное значение
`path_effects`	`AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или float или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[исходный код]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(alpha)[исходный код]

Установить значение альфа-канала, используемое для смешивания. Не поддерживается на всех бэкендах.

Параметры

alphaмассив-подобный объект, скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли художник для использования в анимации.

Если True, художник исключается из обычного рисования фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_artist для художника. Этот подход используется для ускорения анимаций с помощью кеширования.

См. также matplotlib.animation и Более быстрое отображение с использованием кеширования.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние антиалиасинга для отрисовки.

Параметры

aabool или список bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассив-подобный объект или None

Значения, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Установить стиль обрезки CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормы для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также можно передать в виде кортежа (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[исходный код]

Установить область обрезки художника Bbox.

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, использует ли художник обрезку.

Если False, художники будут видны вне осей, что может привести к непредсказуемым результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установить область обрезки для объекта.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если указан Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит ограничивающую рамку соответствующему прямоугольнику и установит путь обрезки в None.

По техническим причинам (поддержка set), также принимается кортеж (path, transform) как единственный позиционный параметр.

set_cmap(cmap)[исходный код]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

set_color(c)[исходный код]

Установить цвет обводки и заливки.

Параметры

cцвет или список кортежей rgba

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для отдельной настройки цвета обводки или заливки.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Установить цвет(а) обводки коллекции.

Параметры

cцвет или список цветов или 'face': Цвет обводки коллекции. Если последовательность, фигуры циклически используют ее элементы. Если 'face', соответствовать цвету заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Установить цвет заливки коллекции. c может быть цветом (у всех фигур одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать элементы последовательности.

Если c равно 'none', фигура не будет закрашена.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Установить объект Figure, к которому принадлежит элемент.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор (группы) для объекта.

Параметры

gidstr

set_hatch(hatch)[исходный код]

Установить шаблон штриховки.

hatch может быть одним из следующих:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Можно комбинировать буквы, в этом случае будут выполнены все указанные штриховки. Если одна и та же буква повторяется, плотность штриховки этого шаблона увеличивается.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg бэкендах.

Параметры

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[исходный код]

Установить, включить ли объект в вычисления макета, например, Руководство по ограниченным макетам, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Установить стиль соединения JoinStyle для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль(и) линии для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж-список в следующем формате:

(offset, onoffseq),

где onoffseq - кортеж чётной длины, содержащий отступы и последовательность включения/выключения чернил в точках.

Параметры

lsstr или кортеж или список кортежей: Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Параметры

lwfloat или список float

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие карту отображения для этой нормализации, установка нормализации отображения сбросит нормализацию, локали и форматы цветовой шкалы по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить преобразование смещения художника.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установить смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[исходный код]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_paths(paths)[исходный код]

set_picker(picker)[исходный код]

Определить поведение выбора объекта.

Параметры

pickerNone или bool или float или вызываемая функция

Это может быть одно из следующих:

None: Выбор отключён для этого объекта (по умолчанию).
Булево значение: Если True, то выбор будет включён, и объект сгенерирует событие выбора, если курсор мыши находится над объектом.
Число типа float: Если picker — число, оно интерпретируется как допуск в точках, и объект сгенерирует событие, если его данные находятся в пределах допуска от события мыши. Для некоторых объектов, таких как линии и коллекции участков, объект может предоставить дополнительные данные в событие выбора, например, индексы данных в пределах допуска от события выбора
Вызываемая функция: Если picker — вызываемая функция, это пользовательская функция, определяющая, попадает ли объект под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над объектом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pr)[исходный код]

Установить радиус выбора, используемый для проверок вхождения.

Параметры

prfloat: Радиус выбора в точках.

set_rasterized(rasterized)[исходный код]

Принудительно растрировать (битмап) отрисовку для векторной графики.

Растрирование не поддерживается всеми объектами. Если вы попытаетесь включить это для объекта, который его не поддерживает, команда не повлияет, и будет выведено сообщение об ошибке.

Это значение игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Установить размеры каждого элемента коллекции.

Параметры

sizesndarray или None: Размер для установки каждого элемента коллекции. Значение — «площадь» элемента.
dpifloat, по умолчанию: 72: DPI холста.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установить параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не указан, фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебания вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Множитель масштаба, по которому длина укорачивается или расширяется (по умолчанию 16.0)

Бэкенд PGF использует это значение как начальное число генератора случайных чисел, а не так, как описано выше. При использовании одного и того же начального числа получаются одинаковые случайные фигуры.

set_snap(snap)[исходный код]

Установить поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением на двух смежных пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя.

set_transform(t)[исходный код]

Установить преобразование объекта.

Параметры

tTransform

set_url(url)[исходный код]

Установить URL для элемента.

Параметры

urlстрока

set_urls(urls)[исходный код]

Параметры

urlsсписок строк или None

Примечания

В настоящее время URL реализованы только для бэкенда SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[исходный код]

Установить видимость элемента.

Параметры

bbool

set_zorder(level)[исходный код]

Установить 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)[исходный код]

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x представляет собой 1D- или 2D-последовательность скаляров, и соответствующий массив значений rgba будет возвращён на основе нормализации и цветовой карты, установленных для этого ScalarMappable.

Есть один особый случай для обработки изображений, которые уже являются rgb или rgba, например, считанных из файла изображения. Если x является массивом с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обработан как массив rgb или rgba, и никакой обработки не будет выполнено. Массив может быть uint8 или массивом с плавающей точкой со значениями в диапазоне 0–1; в противном случае будет возбуждено исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение alpha (по умолчанию 1) будет использовано для заполнения прозрачности. Если последнее измерение равно 4, значение alpha игнорируется; оно не заменяет существующее значение alpha. Будет возбуждено исключение ValueError, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать числа с плавающей точкой в диапазоне 0–1; если оно равно True, возвращаемый массив rgba будет иметь тип uint8 и значения в диапазоне от 0 до 255.

update(props)[исходный код]

Обновить свойства этого элемента из словаря props.

Параметры

propsсловарь

update_from(other)[исходный код]: Копировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета из массива скалярной отображаемой функции, если таковой имеется.

Назначить цвета краям и граням на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.

zorder=0

classmatplotlib.collections.PolyCollection(verts, sizes=None, closed=True, **kwargs)[исходный код]

Bases: matplotlib.collections._CollectionWithSizes

Параметры

vertslist of array-like: Последовательность полигонов [verts0, verts1, ...] где каждый элемент verts_i определяет вершины полигона i как двумерный массив-подобный объект формы (M, 2).
sizesarray-like, default: None: Квадратные коэффициенты масштабирования для полигонов. Координаты каждого полигона verts_i умножаются на квадратный корень соответствующей записи в sizes (т. е., sizes задают масштабирование площадей). Масштабирование применяется перед преобразованием главного элемента Artist.
closedbool, default: True: Указывает, должен ли полигон быть замкнутым путём добавления соединения CLOSEPOLY в конце.
**kwargs: Передаётся в Collection.

add_callback(func)[исходный код]

Параметры

funccallable

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[исходный код]: Автоматическое масштабирование пределов скалярных значений в экземпляре norm с использованием текущего массива.

autoscale_None()[исходный код]: Автоматическое масштабирование пределов скалярных значений в экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None.

propertyaxes: Экземпляр Axes, в котором находится элемент художника, или None.

propertycallbacksSM[исходный код]

changed()[исходный код]: Вызывайте эту функцию всякий раз, когда изменяется отображаемый объект, чтобы уведомить всех слушателей callbackSM об изменении сигнала 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[исходный код]

Проверка, произошло ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в списке itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразовать x с использованием типа единиц оси x.

Если элемент художника не находится в Axes или ось x не имеет единиц, возвращается само x.

convert_yunits(y)[исходный код]

Преобразовать y с использованием типа единиц оси y.

Если элемент художника не находится в Axes или ось y не имеет единиц, возвращается само y.

draw(renderer)[исходный код]

Отрисовать элемент художника (и его потомков) с помощью заданного рендерера.

Это не оказывает никакого влияния, если элемент художника не видим (Artist.get_visible возвращает False).

Параметры

rendererподкласс RendererBase.

Примечания

Этот метод переопределяется в подклассах Artist.

findobj(match=None, include_self=True)[исходный код]

Поиск элементов художника.

Рекурсивно находит все экземпляры Artist, содержащиеся в элементе художника.

Параметры

match

Критерий фильтра для совпадений. Это может быть

None: Возвращает все объекты, содержащиеся в элементе художника.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только художников этого класса или его подклассов (isinstance проверка).

include_selfbool

Включать self в список, который будет проверяться на соответствие.

Возвращает

список Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами элементов. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у элемента нет связанной цветовой шкалы; в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[исходный код]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешения цветов — поддерживается не всеми бэкендами.

get_animated()[исходный код]: Возвращает значение, указывающее, анимируется ли элемент.

get_array()[исходный код]

Возвращает массив значений, сопоставляемых с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

get_children()[исходный код]: Возвращает список дочерних элементов Artist данного Artist.

get_clim()[исходный код]: Возвращает значения (минимум, максимум), отображаемые на пределы цветовой шкалы.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает значение, указывающее, используется ли обрезка для элемента.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

Возвращает данные курсора для заданного события.

Примечание

Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны убедиться, что format_cursor_data может преобразовать данные в строковое представление.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure()[исходный код]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[исходный код]: Возвращает, закрашена ли область.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_in_layout()[исходный код]

Возвращает булевую метку, True если элемент включён в расчёт макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

get_label()[исходный код]: Возвращает метку, используемую для этого элемента на легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом для смещения.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает значение, определяющее, растрируется ли элемент.

get_sizes()[исходный код]

Возвращает размеры (площади) элементов в коллекции.

Возвращает

массив: Площадь каждого элемента.

get_sketch_params()[исходный код]

Возвращает параметры рисунка.

Возвращает

кортеж или None

Трехэлементный кортеж, содержащий следующие значения:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.

Возвращает None, если параметры рисунка не заданы.

get_snap()[исходный код]

Возвращает значение настройки приближения.

Подробности см. в set_snap.

get_tightbbox(renderer)[исходный код]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки фигур (т. е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая область (в пикселах координат фигуры).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с примененной неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL-адреса. См. Ссылки для примера.

get_visible()[исходный код]: Возвращает значение видимости.

get_window_extent(renderer)[исходный код]

Получает область элемента в пространстве отображения.

Ширина и высота области неотрицательны.

Подклассы должны переопределять для включения в вычисление области «уплотнения». По умолчанию возвращается пустая область в 0, 0.

Будьте осторожны при использовании этой функции; результаты не обновятся, если область элемента в пространстве окна изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это происходит при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неверно.

get_zorder()[исходный код]: Возвращает z-порядок элемента.

have_units()[исходный код]: Возвращает значение, указывающее, установлены ли единицы на какой-либо оси.

END_OF_DOCUMENT_MARKER

is_transform_set()[исходный код]

Возвращает, имеет ли объект-графический элемент явно заданное преобразование.

Это True после вызова set_transform.

propertymouseover

Если это свойство установлено в True, объект-графический элемент будет запрашиваться для получения пользовательской информации о контексте при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обработка события выбора.

Каждый дочерний объект-графический элемент будет генерировать событие выбора, если mouseevent находится над объектом, и у объекта задан обработчик выбора.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает, является ли объект-графический элемент выбираемым.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь со всеми свойствами графического элемента.

remove()[исходный код]

Удаляет объект-графический элемент из рисунка, если это возможно.

Эффект не будет виден до перерисовки рисунка, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта-графического элемента.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массивоподобный объект или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`paths`	список массивоподобных объектов
`picker`	None или bool или число с плавающей точкой или вызываемая функция
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или 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)[источник]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[источник]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив float размером (m, n, 3) и значение dpi и возвращает массив (m, n, 3).

set_alpha(alpha)[источник]

Установить значение альфа-канала, используемое для смешивания цветов — не поддерживается на всех бэкендах.

Параметры

alphaмассив-подобный объект, скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[источник]

Установить, предназначен ли элемент для использования в анимации.

См. также matplotlib.animation и Ускорение рендеринга с помощью blitting.

Параметры

bbool

set_antialiased(aa)[источник]

Установить состояние антиалиасинга для рендеринга.

Параметры

aabool или список bool

set_antialiaseds(aa)[источник]: Псевдоним для set_antialiased.

set_array(A)[источник]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассив-подобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[источник]

Установить стиль обрезки CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[источник]

Установить пределы нормы для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[источник]

Установить область обрезки элемента Bbox.

Параметры

clipboxBbox

set_clip_on(b)[источник]

Установить, использует ли элемент обрезку.

Когда False, элементы будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[источник]

Установить область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если указан объект Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена.
transformTransform, необязательно: Используется только если path является объектом Path, в этом случае заданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит ограничивающую прямоугольную область и задаст область обрезки в виде None.

set_cmap(cmap)[источник]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

set_color(c)[источник]

Установить цвет обводки и заливки.

Параметры

cцвет или список кортежей rgba

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для настройки цвета обводки или заливки индивидуально.

set_dashes(ls)[источник]: Псевдоним для set_linestyle.

set_ec(c)[источник]: Псевдоним для set_edgecolor.

set_edgecolor(c)[источник]

Установить цвет обводки коллекции.

Параметры

cцвет или список цветов или 'face': Цвет обводки коллекции. Если последовательность, фигуры циклически проходятся по ней. Если 'face', цвет соответствует цвету заливки.

set_edgecolors(c)[источник]: Псевдоним для set_edgecolor.

set_facecolor(c)[источник]

Установить цвет заливки коллекции. c может быть цветом (все фигуры имеют один и тот же цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически проходить по последовательности.

Если c равно 'none', фигура не будет заполнена.

Параметры

cцвет или список цветов

set_facecolors(c)[источник]: Псевдоним для set_facecolor.

set_fc(c)[источник]: Псевдоним для set_facecolor.

set_figure(fig)[источник]

Установить экземпляр Figure, к которому принадлежит элемент.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор (группы) для элемента.

Параметры

gidstr

set_hatch(hatch)[исходный код]

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Штриховка поддерживается только в постскриптовых, PDF, SVG и Agg-бекендах.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно задать только для всего набора, а не для каждого отдельного элемента.

Параметры

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[исходный код]

Установить, будет ли элемент включен в расчёты макета, например, Руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Установить JoinStyle для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль линии(й) для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж тире следующей формы:

(offset, onoffseq),

где onoffseq — это кортеж чётной длины, содержащий значения включения и выключения чернил в пунктах.

Параметры

lsстрока или кортеж или список таких кортежей: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить ширину линии(й) для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить через последовательность.

Параметры

lwчисловой тип или список чисел

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если существуют какие-либо цветовые шкалы, использующие карту отображения для этой нормализации, установка нормализации карты отображения сбросит нормализацию, локатор и форматеры на цветовой шкале по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить преобразование смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установить смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[исходный код]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_paths(verts, closed=True)[исходный код]

Установить вершины многоугольников.

Параметры

vertsсписок массивоподобных объектов: Последовательность многоугольников [verts0, verts1, ...], где каждый элемент verts_i определяет вершины многоугольника i как двумерный массивоподобный объект формы (M, 2).
closedbool, по умолчанию: True: Следует ли замкнуть многоугольник, добавив в конце соединение CLOSEPOLY.

set_picker(picker)[исходный код]

Определение поведения выбора объекта.

Параметры

pickerNone или bool или float или вызываемая функция

Это может быть одно из следующего:

None: Выбор отключен для этого объекта (по умолчанию).
Булево значение: Если True, выбор будет включен, и объект сгенерирует событие выбора, если указатель мыши находится над ним.
Число с плавающей точкой: Если picker — число, оно интерпретируется как значение допуска в пунктах, и объект будет генерировать событие, если его данные находятся в пределах допуска от события указателя мыши. Для некоторых объектов, таких как линии и коллекции патчей, объект может предоставить дополнительные данные для события выбора, например, индексы данных, находящихся в пределах допуска от события выбора.
Вызываемая функция: Если picker — вызываемая функция, это пользовательская функция, которая определяет, попадает ли объект под событие указателя мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если указатель мыши находится над объектом, верните hit=True, а props — словарь свойств, которые вы хотите добавить в атрибуты PickEvent.

set_pickradius(pr)[исходный код]

Установить радиус выбора, используемый для проверок попадания.

Параметры

prfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно использовать растровое (битовое) отображение для выходных данных векторной графики.

Растровое отображение поддерживается не всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не повлияет на результат, и будет выведено предупреждение.

Эта настройка игнорируется для выходных данных на основе пикселей.

См. также Растрирование векторной графики.

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Установить размеры каждого элемента коллекции.

Параметры

sizesndarray или None: Размер, устанавливаемый для каждого элемента коллекции. Значение соответствует «площади» элемента.
dpifloat, по умолчанию: 72: Точек на дюйм холста.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установить параметры эскиза.

Параметры

scalefloat, необязательно

Амплитуда волны, перпендикулярной исходной линии, в пикселях. Если scale — None или не указано, фильтр эскиза не будет применён.

lengthfloat, необязательно

Длина волны вдоль линии в пикселях (по умолчанию 128.0).

randomnessfloat, необязательно

Коэффициент масштабирования, на который длина уменьшается или увеличивается (по умолчанию 16.0).

Бэкенд PGF использует это значение в качестве начального значения генератора случайных чисел, а не так, как описано выше. Использование одинакового начального значения даёт одинаковую случайную форму.

set_snap(snap)[исходный код]

Установить поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в положении между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть серое значение в обеих смежных позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(t)[исходный код]

Установить преобразование объекта.

Параметры

tTransform

set_url(url)[исходный код]

Установить URL для объекта.

Параметры

urlстрока

set_urls(urls)[исходный код]

Параметры

urlsсписок строк или None

Примечания

В настоящее время URL реализованы только в бэкенде SVG. Они игнорируются всеми другими бэкендами.

set_verts(verts, closed=True)[исходный код]

Установить вершины многоугольников.

Параметры

vertsсписок массивоподобных объектов: Последовательность многоугольников [verts0, verts1, ...], где каждый элемент verts_i определяет вершины многоугольника i как двумерный массивоподобный объект формы (M, 2).
closedлогическое значение, по умолчанию: True: Закрывать ли многоугольник, добавив соединение CLOSEPOLY в конце.

set_verts_and_codes(verts, codes)[исходный код]: Инициализация вершин с кодами пути.

set_visible(b)[исходный код]

Установить видимость объекта.

Параметры

bлогическое значение

set_zorder(level)[исходный код]

Установить z-порядок объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры

levelвещественное число

propertystale: Является ли объект «недействительным» и требует перерисовки, чтобы вывод соответствовал внутреннему состоянию объекта.

propertysticky_edges

x и y списки приклеенных границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра «прилипает» к краю. Типичный пример использования — гистограммы, где обычно не ожидается отступ на нижней границе (0) гистограммы.

Кроме того, расширение отступа «натыкается» на приклеенные края и не может их пересекать. Например, если верхний предел данных равен 1,0, верхний предел просмотра, вычисленный при простом применении отступа, равен 1,2, но есть приклеенный край в 1,1, то фактический верхний предел просмотра будет равен 1,1.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x — одномерный или двумерный массив скаляров, и будет возвращен соответствующий массив значений rgba, основанный на нормализации и цветовой карте, установленной для этого объекта ScalarMappable.

Есть один особый случай для обработки изображений, которые уже являются rgb или rgba, например прочитанных из файла изображения. Если x — массив с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакого отображения не будет выполнено. Массив может быть uint8 или вещественным со значениями в диапазоне 0–1; в противном случае будет поднято исключение ValueError. Если это массив с пропускаемыми значениями, маска будет проигнорирована. Если последнее измерение равно 3, аргумент alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующую прозрачность. ValueError будет поднят, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать значения с плавающей точкой в диапазоне 0–1; если True, массив rgba будет содержать целые числа uint8 в диапазоне от 0 до 255.

update(props)[исходный код]

Обновить свойства этого объекта из словаря props.

Параметры

propsсловарь

update_from(other)[исходный код]: Скопировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета из массива скалярной отображаемой функции, если таковой имеется.

Присвоить цвета краям и граням на основе массива и/или цветов, которые были установлены непосредственно.

zorder=0

classmatplotlib.collections.QuadMesh(coordinates, *, antialiased=True, shading='flat', pickradius=0, **kwargs)[исходный код]

Основания: matplotlib.collections.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).
antialiasedлогическое значение, по умолчанию: True
shading{'flat', 'gouraud'}, по умолчанию: 'flat'

Примечания

В отличие от других Collection, значение по умолчанию pickradius для QuadMesh равно 0, т. е. contains проверяет, находится ли тестовая точка внутри любого из четырёхугольников сетки.

Существует устаревшая версия API QuadMesh(M, N, coords), где размерности задаются явно, и coords — это массивоподобный объект формы (M*N, 2). Эта версия устарела в Matplotlib 3.5. Далее приводится описание семантики этой устаревшей API.

Сетка четырёхугольников состоит из сетки вершин. Размерности этого массива — (meshWidth + 1, meshHeight + 1). У каждой вершины сетки есть свой набор «координат сетки», представляющих её положение в топологии сетки. Для любых значений (m, n) таких, что 0 <= m <= meshWidth и 0 <= n <= meshHeight, вершины с координатами сетки (m, n), (m, n + 1), (m + 1, n + 1) и (m + 1, n) образуют один из четырёхугольников в сетке. Таким образом, в сетке находится (meshWidth * meshHeight) четырёхугольников. Сетка необязательно должна быть регулярной, а многоугольники — выпуклыми.

Сетка четырёхугольников представлена массивом NumPy coordinates размера (2 x ((meshWidth + 1) * (meshHeight + 1))), где каждая строка содержит координаты x и y одной из вершин. Чтобы определить функцию, которая отображает точку данных в соответствующий цвет, используйте метод set_cmap(). Каждый из этих массивов индексируется в порядке следования строк по координатам сетки вершины (или по координатам сетки левой нижней вершины в случае с цветами).

Например, первый элемент в coordinates — это координаты вершины с координатами сетки (0, 0), затем вершины (0, 1), затем (0, 2) .. (0, meshWidth), (1, 0), (1, 1) и так далее.

Параметры

edgecolorsцвет или список цветов, по умолчанию: rcParams["patch.edgecolor"] (по умолчанию: 'black')

Цвет края для каждого фрагмента, составляющего коллекцию. Специальное значение 'face' может быть передано, чтобы цвет края совпадал с цветом заливки.

facecolorsцвет или список цветов, по умолчанию: rcParams["patch.facecolor"] (по умолчанию: 'C0')

Цвет заливки для каждого фрагмента, составляющего коллекцию.

linewidthsвещественное число или список вещественных чисел, по умолчанию: rcParams["patch.linewidth"] (по умолчанию: 1.0)

Толщина линии для каждого фрагмента, составляющего коллекцию.

linestylesстрока, кортеж или список таких кортежей, по умолчанию: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий длины штрихов и промежутков в пунктах. Примеры см. в разделе Стили линий.

capstyleобъект, подобный CapStyle, по умолчанию: rcParams["patch.capstyle"]

Стиль обрезки линий для всех путей в коллекции. Допустимые значения — {'butt', 'projecting', 'round'}.

joinstyleобъект, подобный JoinStyle, по умолчанию: rcParams["patch.joinstyle"]

Стиль соединения линий для всех путей в коллекции. Допустимые значения — {'miter', 'round', 'bevel'}.

Определяет, должен ли каждый фрагмент в коллекции рисоваться со сглаживанием.

offsets(вещественное число, вещественное число) или список таких кортежей, по умолчанию: (0, 0)

Вектор, используемый для перемещения каждого фрагмента после отрисовки (по умолчанию — без перемещения). Перемещение выполняется в экранных (пиксельных) координатах (т. е. после применения преобразования объекта Artist).

transOffsetTransform, по умолчанию: IdentityTransform

Преобразование, которое будет применяться к каждому вектору offsets перед его использованием.

normNormalize, необязательно

Передаётся в ScalarMappable. Значение по умолчанию None означает, что первый вызов draw установит vmin и vmax с использованием минимального и максимального значений данных.

cmapColormap, необязательно

Передаётся в ScalarMappable. Значение по умолчанию None приведёт к использованию rcParams["image.cmap"] (по умолчанию: 'viridis').

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)[исходный код]

Параметры

funcвызываемый объект

Функция обратного вызова. Она должна иметь следующий прототип:

def func(artist: Artist) -> Any

где artist — вызываемый объект Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова позже с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабировать пределы скаляров на экземпляре нормы, используя текущий массив

autoscale_None()[исходный код]: Автоматически масштабировать пределы скаляров на экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None

propertyaxes: Экземпляр Axes , в котором находится элемент, или None.

propertycallbacksSM[исходный код]

changed()[исходный код]: Вызывайте эту функцию всякий раз, когда изменяется отображаемый элемент, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[исходный код]

Проверить, произошло ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в списке элементов содержит событие.

staticconvert_mesh_to_paths(meshWidth, meshHeight, coordinates)[исходный код]: [Устарело]

Примечания

Устарело начиная с версии 3.5:

convert_mesh_to_triangles(meshWidth, meshHeight, coordinates)[исходный код]: [Устарело]

Примечания

Устарело начиная с версии 3.5:

convert_xunits(x)[исходный код]

Преобразовать x с использованием типа единиц оси x.

Если элемент не находится в оси или у оси x нет единиц, возвращается x сам по себе.

convert_yunits(y)[исходный код]

Преобразовать y с использованием типа единиц оси y.

Если элемент не находится в оси или у оси y нет единиц, возвращается y сам по себе.

draw(renderer)[исходный код]

Отобразить элемент (и его дочерние элементы) с помощью заданного рендерера.

Это не повлияет, если элемент не видим (Artist.get_visible возвращает False).

Параметры

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах Artist.

findobj(match=None, include_self=True)[исходный код]

Найти элементы объекта.

Рекурсивно найти все Artist экземпляры, содержащиеся в элементе.

Параметры

match

Критерий фильтрации совпадений. Это может быть

None: Вернуть все объекты, содержащиеся в элементе.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список для проверки совпадения.

Возвращает

список Artist

format_cursor_data(data)[исходный код]

Вернуть строковое представление данных.

Примечание

По умолчанию реализация преобразует целые и плавающие числа и массивы целых и плавающих чисел в строку, разделенную запятыми, заключенную в квадратные скобки, если у элемента нет связанной цветовой шкалы, в этом случае скалярные значения форматируются с помощью формата цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[исходный код]: Возвращает функцию фильтра, используемую для фильтра agg.

get_alpha()[исходный код]: Возвращает значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

get_animated()[исходный код]: Возвращает, анимирован ли элемент.

get_array()[исходный код]

Возвращает массив значений, которые отображаются цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

get_children()[исходный код]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[исходный код]: Возвращает значения (мин, макс), которые отображаются пределом цветовой карты.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает, использует ли элемент обрезку.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_coordinates()[исходный код]

Возвращает вершины сетки как массив (M+1, N+1, 2).

M, N — количество четырёхугольников в строках/столбцах сетки, соответствующих (M+1, N+1) вершинам. Последнее измерение указывает компоненты (x, y).

get_cursor_data(event)[исходный код]

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов. Вероятно, как конечный пользователь Matplotlib, вы сами не будете вызывать этот метод.

Единственный текущий случай использования — отображение значения z изображения AxesImage в строке состояния окна графика при перемещении мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure()[исходный код]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[исходный код]: Возвращает, закрашены ли грани.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_in_layout()[исходный код]

Возвращает логический флаг, True если элемент включен в вычисления макета.

Например, Руководство по макетам с ограничением, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

get_label()[исходный код]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, растрируется ли элемент.

get_sketch_params()[исходный код]

Возвращает параметры наброска для элемента.

Возвращает

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, с помощью которого длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были установлены.

get_snap()[исходный код]

Возвращает значение настройки snap.

См. set_snap для получения подробностей.

get_tightbbox(renderer)[исходный код]

Аналогично Artist.get_window_extent, но включает любую обрезку.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая область (в пикселях координат фигуры).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой частью преобразования, не относящейся к аффинной части, и оставшейся аффинной частью преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному на каждый элемент коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer)[исходный код]

Получить область элемента на экране.

Ширина и высота области должны быть неотрицательными.

Будьте внимательны при использовании этой функции, результаты не обновятся, если область элемента на экране изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но будут сохранены неправильно.

get_zorder()[исходный код]: Возвращает порядок z элемента.

have_units()[исходный код]: Возвращает, установлены ли единицы измерения на какой-либо оси.

is_transform_set()[исходный код]

Возвращает, имеет ли элемент явно установленное преобразование.

Это True после вызова set_transform.

свойствоmouseover

Если это свойство установлено в True, элемент будет запрашиваться для получения пользовательской информации о контексте при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойствоnorm

pchanged()[исходный код]

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обработка события выбора.

Каждый дочерний элемент-графический объект сгенерирует событие выбора, если mouseevent находится над этим объектом и у объекта установлен обработчик выбора.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает, является ли графический объект выбираемым.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь всех свойств графического объекта.

remove()[исходный код]

Удаляет графический объект из графика, если это возможно.

Эффект не будет виден до повторной отрисовки графика, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim, чтобы обновить пределы осей, если необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.

Примечание: нет поддержки удаления записи легенды графического объекта.

remove_callback(oid)[исходный код]

Удаление обработчика на основе идентификатора наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив float (m, n, 3) и значение dpi, и возвращающая массив (m, n, 3)
`alpha`	подобный массиву, скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массив (M, N) или подобный массиву M*N
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`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)[исходный код]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив.

set_alpha(alpha)[исходный код]

Установить значение альфа для смешивания — не поддерживается во всех бэкендах.

Параметры

alphaмассив или скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли объект для использования в анимации.

Если True, объект исключается из обычного рисования фигуры. Вам необходимо явно вызвать Figure.draw_artist / Axes.draw_artist на объекте. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Ускорение рендеринга с помощью blitting.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние антиалиасинга при рендеринге.

Параметры

aabool или список bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить значения данных.

Параметры

A(M, N) массив или массив M*N: Если значения предоставляются в виде двумерной сетки, форма должна соответствовать форме сетки координат. Если значения одномерные, они преобразуются в двумерные. M, N определяются сеткой координат, форма которой равна (M, N) для затенения 'gouraud' и (M+1, N+1) для плоского затенения 'flat'.

set_capstyle(cs)[исходный код]

Установить CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормализации для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также можно передать в виде кортежа (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[исходный код]

Установить область обрезки объекта Bbox.

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, использует ли объект обрезку.

Когда False, объекты будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установить область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан объект Path, также необходимо указать transform. Если None, ранее установленная область обрезки удаляется.
transformTransform, необязательно: Используется только если path является Path, в этом случае указанный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит область обрезки соответствующему прямоугольнику и установит область обрезки в None.

По техническим причинам (поддержка set) также принимается кортеж (path, transform) как единственный позиционный параметр.

set_cmap(cmap)[исходный код]

Устанавливает цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

set_color(c)[исходный код]

Устанавливает цвет обводки и заливки.

Параметры

cцвет или список кортежей rgba

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета обводки или заливки индивидуально.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Устанавливает цвет(а) обводки коллекции.

Параметры

cцвет или список цветов или 'face': Цвет(а) обводки коллекции. Если последовательность, то фигуры будут перебирать ее по очереди. Если 'face', то цвет будет совпадать с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Устанавливает цвет(а) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут перебирать ее по очереди.

Если c равно 'none', фигура не будет закрашиваться.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Устанавливает экземпляр Figure, к которому относится элемент.

Параметры

figFigure

set_gid(gid)[исходный код]

Устанавливает идентификатор (группы) для элемента.

Параметры

gidstr

set_hatch(hatch)[исходный код]

Установить узор штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бекендах.

Параметры

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[исходный код]

Установить, нужно ли включать графический элемент в вычисления макета, например, в Руководстве по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Установить JoinStyle для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль линии(й) для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж данных о типе штриховки следующей формы:

(offset, onoffseq),

где onoffseq — кортеж чётной длины с чередующимися значениями длины пробелов и черт в пунктах.

Параметры

lsстрока или кортеж или список кортежей: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включений-выключений)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить ширину(ы) линии для набора. lw может быть скаляром или последовательностью; если это последовательность, то фигуры будут циклически проходить по последовательности

Параметры

lwчисло или список чисел

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие отображаемый объект для этой нормализации, установка нормализации отображаемого объекта сбросит нормализацию, локатор и форматировщики цветовой шкалы по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить трансформацию смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установите смещения для коллекции.

Параметры

смещения(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[исходный код]

Установить эффекты траектории.

Параметры

path_effectsAbstractPathEffect

set_paths()[исходный код]

set_picker(picker)[исходный код]

Определите поведение выбора элемента графического объекта.

Параметры

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующего:

None: Выбор отключен для этого элемента (по умолчанию).
Булево значение: Если True, выбор будет включен, и элемент сгенерирует событие выбора, если курсор мыши находится над элементом.
Число с плавающей точкой: Если значение picker является числом, оно интерпретируется как допустимая погрешность в точках, и элемент сгенерирует событие выбора, если его данные находятся в пределах погрешности от события выбора. Для некоторых элементов, например, линий и коллекций фигур, элемент может предоставить дополнительные данные для события выбора, например, индексы данных, находящихся в пределах погрешности от события выбора
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли элемент под действие события мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить в атрибуты PickEvent.

set_pickradius(pr)[исходный код]

Установите радиус выбора, используемый для проверок попадания.

Параметры

prfloat: Радиус выбора в точках.

set_rasterized(rasterized)[исходный код]

Принудительно выполняется растровый (битовое) отображение для векторной графики.

Растровый вывод не поддерживается всеми элементами. Если вы попытаетесь включить это для элемента, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.

Эта настройка игнорируется для вывода на основе пикселей.

См. также Растрирование для векторной графики.

Параметры

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установить параметры наброска.

Параметры

scalefloat, необязательно

lengthfloat, необязательно

Длина колебания по линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Множитель масштабирования, с помощью которого длина уменьшается или увеличивается (по умолчанию 16.0)

Бэкенд PGF использует этот аргумент как семя генератора случайных чисел, а не как описано выше. Использование одного и того же семени приводит к одному и тому же случайному рисунку.

set_snap(snap)[исходный код]

Установите поведение привязки.

Привязка выравнивает позиции с сеткой пикселей, что приводит к более четким изображениям. Например, если черная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в сетке пикселей, что будет серым значением в двух соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, таким образом, полученное изображение действительно будет содержать черную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязка вершин к центру ближайшего пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя.

set_transform(t)[исходный код]

Установить преобразование элемента.

Параметры

tTransform

set_url(url)[исходный код]

Установить URL для элемента.

Параметры

urlstr

set_urls(urls)[исходный код]

Параметры

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[исходный код]

Установите видимость объекта.

Параметры

bbool

set_zorder(level)[исходный код]

Установите значение zorder для объекта. Объекты с меньшими значениями zorder отрисовываются первыми.

Параметры

levelfloat

свойство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)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает массив rgba, соответствующий x, в нормализованном виде.

В нормальном случае x — это 1D или 2D последовательность скаляров, и будет возвращен соответствующий массив rgba, основанный на нормализации и цветовой карте, установленных для этого объекта ScalarMappable.

Существует один особый случай для обработки изображений, которые уже являются rgb или rgba, например, считанных из файла изображения. Если x — это массив с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакого преобразования не будет выполнено. Массив может быть uint8 или иметь плавающее значение с величиной от 0 до 1; в противном случае будет возбуждено исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение аргумента alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет ранее существовавшее значение alpha. Если третье измерение не равно 3 или 4, возбуждается исключение ValueError.

В обоих случаях, если bytes равно False (по умолчанию), массив rgba будет иметь значения float в диапазоне от 0 до 1; если он равен True, массив rgba будет иметь значения uint8 в диапазоне от 0 до 255.

Если norm равен False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)[исходный код]

Обновить свойства этого объекта из словаря props.

Параметры

propsdict

update_from(other)[исходный код]: Скопировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета из массива скалярной отображаемой информации, если он есть.

Присвоить цвета границам и граням на основе массива и/или непосредственно заданных цветов, как это подходит.

zorder=0

END_OF_DOCUMENT_MARKER

классmatplotlib.collections.RegularPolyCollection(numsides, rotation=0, sizes=(1,), **kwargs)[исходный код]

Базовые классы: matplotlib.collections._CollectionWithSizes

Коллекция правильных многоугольников.

Параметры

numsidesint: Количество сторон многоугольника.
rotationfloat: Угол поворота многоугольника в радианах.
sizesкортеж из чисел с плавающей точкой: Площадь окружности, описанной около многоугольника, в пунктах^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,
    transOffset=ax.transData,
    )

add_callback(func)[исходный код]

Добавить функцию обратного вызова, которая будет вызываться всякий раз, когда меняется одно из свойств Artist.

Параметры

funcвызываемая функция

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Значения возврата могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позднее.

См. также

remove_callback

autoscale()[исходный код]: Автомасштабирование пределов скаляров на экземпляре нормы с использованием текущего массива

autoscale_None()[исходный код]: Автомасштабирование пределов скаляров на экземпляре нормы с использованием текущего массива, изменяя только пределы, равные None

свойствоaxes: Экземпляр Axes, в котором находится элемент, или None.

свойствоcallbacksSM[исходный код]

changed()[исходный код]: Вызовите эту функцию всякий раз, когда изменяется сопоставитель карт, чтобы уведомить всех слушателей callbackSM о сигнале «изменено».

colorbar: Последняя связанная с этим ScalarMappable цветовая шкала. Может быть None.

contains(mouseevent)[исходный код]

Проверка, произошло ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразование x с использованием типа единиц оси x.

Если элемент не находится в Axes или у оси x нет единиц, возвращается x сам по себе.

convert_yunits(y)[исходный код]

Преобразование y с использованием типа единиц оси y.

Если элемент не находится в Axes или у оси y нет единиц, возвращается y сам по себе.

draw(renderer)[исходный код]

Отрисовка элемента (и его потомков) с помощью заданного рендерера.

Это не имеет эффекта, если элемент не отображается (Artist.get_visible возвращает False).

Параметры

rendererподкласс RendererBase.

Примечания

Этот метод переопределяется в подклассах Artist.

findobj(match=None, include_self=True)[исходный код]

Поиск элементов художника.

Рекурсивно находит все экземпляры Artist, содержащиеся в элементе художника.

Параметры

match

Критерий фильтрации соответствий. Это может быть

None: Возвращает все элементы, содержащиеся в элементе.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
Экземпляр класса, например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (проверка isinstance).

include_selfbool

Включать self в список для проверки соответствия.

Возвращает

список из Artist

END_OF_DOCUMENT_MARKER

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами художников. Пользователю Matplotlib, скорее всего, не нужно будет вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделенную запятыми, заключенную в квадратные скобки, если у художника нет связанной цветовой шкалы. В противном случае скалярные значения форматируются с использованием форматировщика цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[исходный код]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается всеми бэкендами.

get_animated()[исходный код]: Возвращает значение, указывающее, является ли художник анимированным.

get_array()[исходный код]

Возвращает массив значений, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

get_children()[исходный код]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[исходный код]: Возвращает значения (мин, макс), которые отображаются в пределы цветовой карты.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает значение, указывающее, используется ли обрезка художником.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

Возвращает данные курсора для заданного события.

Примечание

Данные курсора могут быть использованы художниками для предоставления дополнительной контекстной информации для данного события. По умолчанию метод возвращает None.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure()[исходный код]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()[исходный код]: Возвращает значение, указывающее, закрашена ли фигура.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий узор штриховки.

get_in_layout()[исходный код]

Возвращает логическое значение, True указывающее, включён ли элемент в расчёт макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

get_label()[исходный код]: Возвращает метку, используемую для этого элемента на легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_numsides()[исходный код]

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора объекта.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, растрируется ли объект.

get_rotation()[исходный код]

get_sizes()[исходный код]

Возвращает размеры (площади) элементов в коллекции.

Возвращает

массив: Площадь каждого элемента.

get_sketch_params()[исходный код]

Возвращает параметры наброска для объекта.

Возвращает

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.

Возвращает None, если параметры наброска не были заданы.

get_snap()[исходный код]

Возвращает настройку привязки.

Подробности см. в set_snap.

get_tightbbox(renderer)[исходный код]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая область (в пикселях координат изображения).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает обрезающую траекторию с применённой неаффинной частью её преобразования, и оставшейся аффинной частью её преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Гиперссылки для примера.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer)[исходный код]

Получает область элемента на экране.

Ширина и высота прямоугольника неотрицательны.

Подклассы должны переопределять для включения в вычисление "уплотнённой" области. По умолчанию возвращается пустая область в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если область элемента на экране изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся неправильно.

get_zorder()[исходный код]: Возвращает z-порядок объекта.

have_units()[исходный код]: Возвращает, установлены ли единицы измерения на любой оси.

is_transform_set()[исходный код]

Возвращает, имеет ли объект-графический элемент явно заданное преобразование.

Это True после вызова set_transform.

propertymouseover

Если это свойство установлено в True, при наведении курсора мыши на объект-графический элемент будет запрошена пользовательская информация контекста.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается в системе, когда изменяется свойство.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний объект-графический элемент сгенерирует событие выбора, если mouseevent находится над объектом-графическим элементом и у него установлен picker.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает, является ли объект-графический элемент выбираемым.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь со всеми свойствами объекта-графического элемента.

remove()[исходный код]

Удаляет объект-графический элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim, чтобы обновить пределы осей, если необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта-графического элемента.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив 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`	`Bbox`
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[исходный код]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой размера (m, n, 3).

set_alpha(alpha)[исходный код]

Установить значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

Параметры

alphaмассивоподобный объект или скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли художник для использования в анимации.

Если True, художник исключается из обычного рисования фигуры. Вам нужно явно вызвать Figure.draw_artist / Axes.draw_artist на художнике. Этот подход используется для ускорения анимаций с помощью блиттинга.

См. также matplotlib.animation и Более быстрая отрисовка с использованием блиттинга.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние антиалиасинга для рендеринга.

Параметры

aabool или список bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассивоподобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Установить стиль закругления для коллекции (для всех ее элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормы для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также можно передать как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(clipbox)[исходный код]

Установить область обрезки художника Bbox.

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, использует ли художник обрезку.

Если False, художники будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установить область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан Path, необходимо также указать transform. Если None, ранее заданная область обрезки удаляется.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

set_cmap(cmap)[исходный код]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или строка или None

set_color(c)[исходный код]

Установить цвет контура и заливки.

Параметры

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для самостоятельной настройки цвета контура или заливки.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Установить цвет контура(ов) коллекции.

Параметры

cцвет или список цветов или 'face': Цвет контура(ов) коллекции. Если последовательность, фигуры циклически будут получать цвета из нее. Если 'face', подстраивается под цвет заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Установить цвет заливки(ов) коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически получать цвета из неё.

Если c равно 'none', фигура не будет закрашена.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Установить экземпляр Figure, к которому относится элемент.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор (группы) для объекта.

Параметры

gidstr

set_hatch(hatch)[исходный код]

Установить узор штриховки.

hatch может быть одним из следующих:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные типы штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого типа.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бэкендах.

Параметры

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[исходный код]

Установить, должен ли объект быть включен в вычисления макета, например, в Руководстве по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Установить JoinStyle для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль линии(ей) для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж с отступами в следующем формате:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий значения включения и выключения чернил в пунктах.

Параметры

lsстрока или кортеж, или список таковых: Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить ширину линии(ей) для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности

Параметры

lwчисло с плавающей точкой или список чисел с плавающей точкой

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие mappable для этой нормализации, установка нормализации mappable сбросит нормализацию, локатор и форматеры на цветовой шкале по умолчанию.

set_offset_transform(transOffset)[источник]

Установите преобразование смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[источник]

Установите смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[источник]

Установите эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_paths()[источник]

set_picker(picker)[источник]

Определите поведение выбора элемента.

Параметры

pickerNone или bool или float или вызываемая функция

Это может быть одно из следующего:

None: Выбор отключён для данного объекта (по умолчанию).
Булево значение: Если True, выбор включён, и объект будет генерировать событие выбора, если указатель мыши находится над ним.
Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск в точках, и объект будет генерировать событие выбора, если его данные находятся в пределах допуска от события мыши. Для некоторых объектов, таких как линии и коллекции областей, объект может предоставить дополнительные данные в событие выбора, например, индексы данных, находящихся в пределах допуска от события выбора
Вызываемая функция: Если picker — вызываемая функция, это функция, предоставляемая пользователем, которая определяет, попадает ли объект под указатель мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если указатель мыши находится над объектом, верните hit=True и props — словарь свойств, которые вы хотите добавить в атрибуты PickEvent.

set_pickradius(pr)[источник]

Установите радиус выбора, используемый для проверок на попадание.

Параметры

prfloat: Радиус выбора, в точках.

set_rasterized(rasterized)[источник]

Принудительное растровое (битовое) отображение для вывода векторной графики.

Растровое отображение не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не сработает, и будет выведено предупреждение.

Это значение игнорируется для вывода на основе пикселей.

См. также Растрирование векторной графики.

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[источник]

Установите размеры каждого элемента коллекции.

Параметры

sizesndarray или None: Размер для установки каждому элементу коллекции. Значение — это «площадь» элемента.
dpifloat, по умолчанию: 72: dpi холста.

set_sketch_params(scale=None, length=None, randomness=None)[источник]

Установите параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии, в пикселях. Если scale — None или не указан, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина колебаний вдоль линии, в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, на который длина сжимается или расширяется (по умолчанию 16.0)

Фронтенд PGF использует этот аргумент как начальное значение генератора случайных чисел, а не так, как описано выше. Использование одного и того же начального значения приводит к одинаковой случайной форме.

set_snap(snap)[источник]

Установите поведение привязки.

Привязка выравнивает позиции по пиксельной сетке, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть серую градацию на двух смежных пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя.

set_transform(t)[источник]

Установите преобразование объекта.

Параметры

tTransform

set_url(url)[источник]

Установите URL для объекта.

Параметры

urlстрока

set_urls(urls)[источник]

Параметры

urlsсписок строк или None

Примечания

В настоящее время URL-адреса реализованы только в бэкенде SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[источник]

Установить видимость объекта.

Параметры

bbool

set_zorder(level)[источник]

Установить 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)[источник]

Возвращает массив rgba, соответствующий x, в нормализованном виде.

В обычном случае x — это одномерный или двумерный набор скаляров, и возвращается соответствующий массив rgba, основанный на нормализации и палитре цветов, заданных для этого объекта ScalarMappable.

Есть один особый случай для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x — это массив с 3 измерениями, а последнее измерение равно 3 или 4, он рассматривается как массив rgb или rgba, и никакой обработки не выполняется. Массив может быть uint8 или иметь значения с плавающей точкой в диапазоне 0-1; в противном случае будет вызвано исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение alpha (по умолчанию 1) будет использовано для заполнения прозрачности. Если последнее измерение равно 4, значение alpha игнорируется; оно не заменяет существующее alpha. Если третье измерение отличается от 3 или 4, будет вызвано исключение ValueError.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет иметь значения с плавающей точкой в диапазоне 0-1; если True, возвращаемый массив rgba будет иметь значения uint8 в диапазоне 0-255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне 0-1.

update(props)[источник]

Обновить свойства этого объекта из словаря props.

Параметры

propsсловарь

update_from(other)[источник]: Скопировать свойства из other в self.

update_scalarmappable()[источник]

Обновить цвета из массива отображаемого скаляра, если он есть.

Назначить цвета краям и граням соответственно на основе массива и/или цветов, заданных напрямую.

zorder=0

классmatplotlib.collections.StarPolygonCollection(numsides, rotation=0, sizes=(1,), **kwargs)[источник]

Базовый класс: matplotlib.collections.RegularPolyCollection

Рисует набор правильных звёзд с numsides точками.

Параметры

numsidesint: Количество сторон многоугольника.
rotationfloat: Поворот многоугольника в радианах.
sizesкортеж из float: Площадь окружности, описанной вокруг многоугольника, в пунктах^2.
**kwargs: Передаётся в Collection.

Примеры

См. Демонстрацию Lasso для полного примера:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    transOffset=ax.transData,
    )

add_callback(func)[исходный код]

Параметры

funcвызываемая функция

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Значения возврата могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует пределы скалярных значений в экземпляре norm с использованием текущего массива

autoscale_None()[исходный код]: Автоматически масштабирует пределы скалярных значений в экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None

свойствоaxes: Экземпляр Axes, в котором находится элемент, или None.

свойствоcallbacksSM[исходный код]

changed()[исходный код]: Вызывайте эту функцию всякий раз, когда изменяется объект отображения, чтобы уведомить всех слушателей обратного вызова callbacksSM о сигнале "изменено".

colorbar: Последняя связанная с этим объектом отображения скалярных значений полоса цвета. Может быть None.

contains(mouseevent)[исходный код]

Проверяет, произошёл ли мышиный щелчок внутри коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[исходный код]

Преобразует x, используя тип единиц измерения оси x.

Если элемент не находится в пределах оси или у оси x нет единиц измерения, возвращается x.

convert_yunits(y)[исходный код]

Преобразует y, используя тип единиц измерения оси y.

Если элемент не находится в пределах оси или у оси y нет единиц измерения, возвращается y.

draw(renderer)[исходный код]

Отображает элемент (и его потомков) с помощью заданного рендерера.

Это не имеет эффекта, если элемент не виден (Artist.get_visible возвращает False).

Параметры

rendererподкласс RendererBase.

Примечания

Этот метод переопределён в подклассах элемента.

findobj(match=None, include_self=True)[исходный код]

Находит элементы графических объектов.

Рекурсивно находит все экземпляры Artist, содержащиеся в элементе.

Параметры

match

Критерий фильтрации совпадений. Может быть

None: Возвращает все объекты, содержащиеся в элементе.
Функцией с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
Экземпляром класса: например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (проверка isinstance).

include_selfbool

Включать self в список, подлежащий проверке на соответствие.

Возвращает

список Artist

format_cursor_data(data)[исходный код]

Возвращает строковое представление data.

Примечание

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у элемента нет связанной цветовой шкалы, в противном случае числовые значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[исходный код]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[исходный код]: Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается на всех бэкендах.

get_animated()[исходный код]: Возвращает, анимирован ли элемент.

get_array()[исходный код]

Возвращает массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[исходный код]

get_children()[исходный код]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[исходный код]: Возвращает значения (минимум, максимум), которые отображаются в пределы цветовой карты.

get_clip_box()[исходный код]: Возвращает область обрезки.

get_clip_on()[исходный код]: Возвращает, используется ли обрезка элемента.

get_clip_path()[исходный код]: Возвращает путь обрезки.

get_cmap()[исходный код]: Возвращает экземпляр Colormap.

get_cursor_data(event)[исходный код]

Возвращает данные указателя для заданного события.

Примечание

Данные указателя могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[исходный код]: Псевдоним для get_linestyle.

get_datalim(transData)[исходный код]

get_ec()[исходный код]: Псевдоним для get_edgecolor.

get_edgecolor()[исходный код]

get_edgecolors()[исходный код]: Псевдоним для get_edgecolor.

get_facecolor()[исходный код]

get_facecolors()[исходный код]: Псевдоним для get_facecolor.

get_fc()[исходный код]: Псевдоним для get_facecolor.

get_figure()[исходный код]: Возвращает экземпляр Figure, к которому принадлежит данный элемент.

get_fill()[исходный код]: Возвращает значение, указывающее, закрашен ли элемент.

get_gid()[исходный код]: Возвращает идентификатор группы.

get_hatch()[исходный код]: Возвращает текущий шаблон штриховки.

get_in_layout()[исходный код]

Возвращает логическое значение, True показывающее, включён ли элемент в вычисления компоновки.

Например, Руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[исходный код]

get_label()[исходный код]: Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[исходный код]

get_linestyles()[исходный код]: Псевдоним для get_linestyle.

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_numsides()[исходный код]

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый для смещения данного элемента.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, будет ли элемент растрирован.

get_rotation()[исходный код]

get_sizes()[исходный код]

Возвращает размеры (площади) элементов в коллекции.

Возвращает

массив: Площадь каждого элемента.

get_sketch_params()[исходный код]

Возвращает параметры эскиза для элемента.

Возвращает

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.

Возвращает None, если параметры эскиза не заданы.

get_snap()[исходный код]

Возвращает значение параметра привязки.

Подробнее см. set_snap.

get_tightbbox(renderer)[исходный код]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая прямоугольная область (в пикселях координат фигуры).

get_transform()[исходный код]: Возвращает объект Transform, используемый данным элементом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с примененной к нему не-аффинной частью преобразования и оставшейся аффинной частью преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Гиперссылки для примера.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer)[исходный код]

Получает прямоугольную область элемента в пространстве отображения.

Ширина и высота прямоугольной области неотрицательны.

Подклассы должны переопределять для включения в вычисления прямоугольной области "tight". По умолчанию возвращает пустую прямоугольную область в 0, 0.

Будьте внимательны при использовании этой функции, результаты не обновляются, если прямоугольная область элемента изменилась. Область может измениться из-за любых изменений в стеке преобразований, например, при изменении пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к неожиданному поведению, где интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся неправильно.

get_zorder()[исходный код]: Возвращает z-порядок элемента.

have_units()[исходный код]: Возвращает, установлены ли единицы измерения на любой оси.

is_transform_set()[исходный код]

Возвращает, имеет ли элемент отображения явно установленное преобразование.

Это True после того, как был вызван set_transform.

propertymouseover

Если это свойство установлено в True, элемент отображения будет запрошен для получения пользовательских данных контекста при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

propertynorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обрабатывает событие выбора.

Каждый дочерний элемент отображения сгенерирует событие выбора, если mouseevent находится над элементом отображения, и для элемента отображения установлено свойство picker.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает, можно ли выбрать элемент отображения.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь со всеми свойствами элемента отображения.

remove()[исходный код]

Удаляет элемент отображения из рисунка, если это возможно.

Эффект не будет виден до перерисовки рисунка, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей при необходимости вызовите relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента отображения.

remove_callback(oid)[исходный код]

Удаляет обратный вызов на основе его идентификатора наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, а возвращает массив чисел с плавающей точкой (m, n, 3)
`alpha`	массивоподобный объект или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`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	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массивоподобный объект (N, 2) или (2,)
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[исходный код]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(alpha)[исходный код]

Установить значение альфа, используемое для смешивания. Не поддерживается на всех бэкендах.

Параметры

alphaмассив-подобный объект, скаляр или None: Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли элемент для использования в анимации.

Если True, элемент исключается из обычного рисования фигуры. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist на элементе. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Более быстрое отображение с использованием blitting.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние антиалиасинга для отображения.

Параметры

aabool или список bool

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассив-подобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Установить стиль обрезки CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормы для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также могут быть переданы как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(clipbox)[исходный код]

Установить область обрезки элемента Bbox.

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, использует ли элемент обрезку.

Если False, элементы будут видны за пределами осей, что может привести к непредсказуемым результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установите область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит прямоугольник обрезки и задаст путь обрезки в виде None.

set_cmap(cmap)[исходный код]

Устанавливает палитру цветов для данных яркости.

Параметры

cmapColormap или строка или None

set_color(c)[исходный код]

Устанавливает цвет обводки и заливки.

Параметры

cцвет или список кортежей rgba

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета обводки или заливки индивидуально.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Установка цвета(ов) обводки коллекции.

Параметры

cцвет или список цветов или 'face': Цвет обводки коллекции. Если последовательность, фигуры циклически используют её. Если 'face', соответствует цвету заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Установка цвета(ов) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать её.

Если c равно 'none', фигура не будет заполнена.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Устанавливает экземпляр Figure, к которому принадлежит элемент.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор группы (gid) для графического элемента.

Параметры

gidstr

set_hatch(hatch)[исходный код]

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняется вся указанная штриховка. Если одна и та же буква повторяется, это увеличивает плотность штриховки данного узора.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бекендах.

Параметры

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[исходный код]

Установить, должен ли графический элемент включаться в вычисления макета, например, в руководстве по ограниченным макетам, Руководство по ограниченным макетам, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Установить JoinStyle для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль(и) линии для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы может быть предоставлена кортеж с делениями следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, задающий включения и выключения чернил в точках.

Параметры

lsstr или кортеж или список кортежей: Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. Смотрите Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить ширину(ы) линии(й) для коллекции. lw может быть скалярным значением или последовательностью; если это последовательность, фигуры будут циклически проходить через последовательность.

Параметры

lwfloat или список float

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие отображаемый объект для этой нормализации, установка нормализации отображаемого объекта сбросит нормализующую, локатор и форматировщик на цветовой шкале по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить преобразование смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установить смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[исходный код]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_paths()[исходный код]

set_picker(picker)[исходный код]

Определить поведение выбора объекта.

Параметры

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующего:

None: Выбор отключён для этого объекта (по умолчанию).
Булево значение: Если True, то выбор включён, и объект сгенерирует событие выбора, если курсор находится над ним.
Число с плавающей точкой: Если picker — число, оно интерпретируется как толерантность ε в точках, и объект сгенерирует событие, если его данные находятся в пределах ε от события мыши. Для некоторых объектов, например, линий и коллекций фигур, объект может предоставить дополнительные данные для события выбора, например, индексы данных в пределах ε от события выбора
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли объект под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над объектом, вернуть hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pr)[исходный код]

Установить радиус выбора, используемый для проверок нахождения внутри.

Параметры

prfloat: Радиус выбора, в точках.

set_rasterized(rasterized)[исходный код]

Принудительно использовать растрирование (рисование растром) для векторной графики.

Растрирование не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не будет иметь эффекта, и будет выдано предупреждение.

Это свойство игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[исходный код]

Установить размеры каждого элемента коллекции.

Параметры

sizesndarray или None: Размер для каждого элемента коллекции. Значение — «площадь» элемента.
dpifloat, по умолчанию: 72: Точек на дюйм холста.

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установить параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии, в пикселях. Если scale — None, или не указано, никакой фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебания вдоль линии, в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, с которым длина сжимается или расширяется (по умолчанию 16.0)

Бэкенд PGF использует это значение как начальное значение генератора случайных чисел, а не так, как описано выше. При использовании одного и того же начального значения получаются одинаковые случайные формы.

set_snap(snap)[исходный код]

Установить поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением в двух смежных позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение будет действительно содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (автоматически) Если путь содержит только прямолинейные сегменты, округлить до ближайшего центра пикселя.

set_transform(t)[исходный код]

Установить преобразование объекта.

Параметры

tTransform

set_url(url)[исходный код]

Установить URL для объекта.

Параметры

urlstr

set_urls(urls)[исходный код]

Параметры

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только в SVG-бэкенде. Они игнорируются всеми другими бэкендами.

set_visible(b)[исходный код]

Установить видимость объекта.

Параметры

bbool

set_zorder(level)[исходный код]

Установить 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)[исходный код]

Возвращает массив rgba, соответствующий x.

В обычном случае x представляет собой 1D или 2D последовательность скаляров, и соответствующий массив rgba будет возвращён на основе нормализации и цветовой карты, заданной для этого объекта ScalarMappable.

Есть один специальный случай для обработки изображений, которые уже являются rgb или rgba, таких как изображения, прочитанные из файла. Если x является массивом с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никаких преобразований не будет произведено. Массив может быть uint8 или массивом чисел с плавающей запятой со значениями в диапазоне 0–1; в противном случае будет вызвано исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, аргумент alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующую прозрачность. Будет вызвано исключение ValueError, если третье измерение отличается от 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать числа с плавающей запятой в диапазоне 0–1; если это True, возвращаемый массив rgba будет содержать значения uint8 в диапазоне от 0 до 255.

update(props)[исходный код]

Обновить свойства этого объекта из словаря props.

Параметры

propsсловарь

update_from(other)[исходный код]: Копировать свойства из other в self.

update_scalarmappable()[исходный код]

Обновить цвета из массива скалярной отображаемой функции, если таковой имеется.

Назначить цвета границам и граням на основе массива и/или непосредственно заданных цветов соответственно.

zorder=0

classmatplotlib.collections.TriMesh(triangulation, **kwargs)[исходный код]

Базовые классы: matplotlib.collections.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'}.

Определяет, должна ли каждая область в коллекции отображаться со сглаживанием.

offsets(вещественное число, вещественное число) или список таких, по умолчанию: (0, 0)

Вектор, используемый для перемещения каждого элемента после отрисовки (по умолчанию смещения нет). Перемещение выполняется в координатах экрана (пикселях) (т. е. после применения преобразования художника).

transOffsetTransform, по умолчанию: IdentityTransform

Единственное преобразование, которое будет применено к каждому вектору offsets перед его использованием.

normNormalize, необязательно

Передаётся в ScalarMappable. По умолчанию None означает, что первый вызов отрисовки установит vmin и vmax с помощью минимального и максимального значений данных.

cmapColormap, необязательно

Передаётся в ScalarMappable. По умолчанию None приведет к использованию rcParams["image.cmap"] (по умолчанию: 'viridis')

hatchстрока, необязательно

Шаблон штриховки для заполненных путей, если таковые имеются. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Описание каждого типа штриховки см. в разделе Справочник по стилям штриховки.

pickradiusвещественное число, по умолчанию: 5.0

Если pickradius <= 0, то Collection.contains вернёт True всякий раз, когда тестовая точка находится внутри одного из многоугольников, образованных контрольными точками Path в Collection. С другой стороны, если он больше 0, то вместо этого проверяется, находится ли тестовая точка в штрихе шириной 2*pickradius вдоль любого из Path в Collection.

urlsсписок строк, по умолчанию: None

URL для каждого элемента, чтобы можно было создать ссылку после отрисовки. В настоящее время работает только для SVG-бэкенда. Примеры см. в разделе Гиперссылки.

zorderвещественное число, по умолчанию: 1

Порядок рисования, общий для всех патчей в Collection. Все значения по умолчанию и примеры см. в разделе Демонстрация Zorder.

add_callback(func)[исходный код]

Параметры

funcфункция

Функция обратного вызова. Она должна иметь следующий вид:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Возвращаемые значения могут быть, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать позднее для удаления обратного вызова с помощью remove_callback.

См. также

remove_callback

autoscale()[исходный код]: Автоматически масштабирует пределы скалярных величин в экземпляре norm с использованием текущего массива

autoscale_None()[исходный код]: Автоматически масштабирует пределы скалярных величин в экземпляре norm с использованием текущего массива, изменяя только пределы, равные None

propertyaxes: Экземпляр Axes, в котором находится художник, или None.

propertycallbacksSM[исходный код]

changed()[исходный код]: Вызовите эту функцию при изменении сопоставителя, чтобы уведомить всех слушателей callbackSM о сигнале «changed».

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть равна None.

contains(mouseevent)[исходный код]

Проверяет, произошло ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент списка items содержит событие.

staticconvert_mesh_to_paths(tri)[источник]

Преобразовать заданную сетку в последовательность объектов Path.

Эта функция в основном полезна для разработчиков бэкэндов, которые не поддерживают сетки напрямую.

convert_xunits(x)[источник]

Преобразовать x, используя тип единиц измерения оси x.

Если объект-артист не находится в Axes или ось x не имеет единиц измерения, возвращается само x.

convert_yunits(y)[источник]

Преобразовать y, используя тип единиц измерения оси y.

Если объект-артист не находится в Axes или ось y не имеет единиц измерения, возвращается само y.

draw(renderer)[источник]

Отрисовать объект-артист (и его потомков) с помощью заданного рендерера.

Это не оказывает никакого влияния, если объект-артист не виден (Artist.get_visible возвращает False).

Параметры

rendererRendererBase подкласс.

Примечания

Этот метод переопределён в подклассах Artist.

findobj(match=None, include_self=True)[источник]

Найти объекты-артисты.

Рекурсивно найти все экземпляры Artist, содержащиеся в артисте.

Параметры

match

Критерий фильтрации совпадений. Может быть

None: Вернуть все объекты, содержащиеся в артисте.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только артисты, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только артисты этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список для проверки на совпадение.

Возвращает

Список Artist

format_cursor_data(data)[источник]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами артиста. В качестве конечного пользователя Matplotlib вы, скорее всего, не будете вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и плавающие числа и массивы целых и плавающих чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у артиста нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[источник]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[источник]: Возвращает значение альфа, используемое для смешивания — не поддерживается на всех бэкэндах.

get_animated()[источник]: Возвращает, анимирован ли артист.

get_array()[источник]

Возвращает массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[источник]

get_children()[источник]: Возвращает список дочерних объектов-артистов Artist этого объекта Artist.

get_clim()[источник]: Возвращает значения (мин, макс), которые отображаются в пределы цветовой карты.

get_clip_box()[источник]: Возвращает область обрезки.

get_clip_on()[источник]: Возвращает, использует ли артист обрезку.

get_clip_path()[источник]: Возвращает путь обрезки.

get_cmap()[источник]: Возвращает экземпляр Colormap.

get_cursor_data(event)[источник]

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами объектов-артистов. Вероятно, конечный пользователь Matplotlib не будет вызывать этот метод самостоятельно.

Данные курсора могут использоваться объектами-артистами для предоставления дополнительной контекстной информации для данного события. По умолчанию метод возвращает None.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes()[источник]: Псевдоним для get_linestyle.

get_datalim(transData)[источник]

get_ec()[источник]: Псевдоним для get_edgecolor.

get_edgecolor()[источник]

get_edgecolors()[источник]: Псевдоним для get_edgecolor.

get_facecolor()[источник]

get_facecolors()[источник]: Псевдоним для get_facecolor.

get_fc()[источник]: Псевдоним для get_facecolor.

get_figure()[источник]: Возвращает экземпляр Figure, к которому принадлежит объект-артист.

get_fill()[источник]: Возвращает значение, указывающее, окрашена ли фигура.

get_gid()[источник]: Возвращает идентификатор группы.

get_hatch()[источник]: Возвращает текущую схему штриховки.

get_in_layout()[источник]

Возвращает логическое значение, True если объект-артист включён в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[источник]

get_label()[источник]: Возвращает метку, используемую для этого объекта-артиста в легенде.

get_linestyle()[источник]

get_linestyles()[источник]: Псевдоним для get_linestyle.

END_OF_DOCUMENT_MARKER

get_linewidth()[исходный код]

get_linewidths()[исходный код]: Псевдоним для get_linewidth.

get_ls()[исходный код]: Псевдоним для get_linestyle.

get_lw()[исходный код]: Псевдоним для get_linewidth.

get_offset_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом для смещения.

get_offsets()[исходный код]: Возвращает смещения для коллекции.

get_path_effects()[исходный код]

get_paths()[исходный код]

get_picker()[исходный код]

Возвращает поведение выделения элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[исходный код]

get_rasterized()[исходный код]: Возвращает, следует ли растрировать элемент.

get_sketch_params()[исходный код]

Возвращает параметры наброска для элемента.

Возвращаемое значение

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.

Возвращает None, если параметры наброска не были установлены.

get_snap()[исходный код]

Возвращает значение параметра привязки.

Подробнее см. set_snap.

get_tightbbox(renderer)[исходный код]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())

Возвращаемое значение

Bbox: Охватывающая рамка (в пикселях координат фигуры).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[исходный код]: Возвращает путь обрезки с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()[исходный код]

get_url()[исходный код]: Возвращает URL.

get_urls()[исходный код]

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL-адреса. См. Ссылки для примера.

get_visible()[исходный код]: Возвращает видимость.

get_window_extent(renderer)[исходный код]

Получить прямоугольник объекта в пространстве отображения.

Ширина и высота прямоугольника неотрицательны.

Подклассы должны переопределять этот метод для включения в вычисление компактного прямоугольника. По умолчанию возвращается пустой прямоугольник в координатах (0, 0).

Будьте внимательны при использовании этой функции, результаты не обновятся, если прямоугольник объекта изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры выглядят нормально на экране, но сохраняются неправильно.

get_zorder()[исходный код]: Возвращает z-порядок объекта.

have_units()[исходный код]: Возвращает, установлены ли единицы измерения на какой-либо оси.

is_transform_set()[исходный код]

Возвращает, задано ли преобразование для элемента.

Это True после вызова set_transform.

свойствоmouseover

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойствоnorm

pchanged()[исходный код]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[исходный код]

Обработка события выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом и для элемента установлен режим выбора.

См. также

set_picker, get_picker, pickable

pickable()[исходный код]

Возвращает, может ли элемент быть выбран.

См. также

set_picker, get_picker, pick

properties()[исходный код]: Возвращает словарь всех свойств элемента.

remove()[исходный код]

Удаляет элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей, если нужно, вызовите relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[исходный код]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив 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`	`Bbox`
`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	float или список float
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массив (N, 2) или (2,) подобный массиву
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`pickradius`	float
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	float

set_aa(aa)[исходный код]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[исходный код]

Установить фильтр agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой размера (m, n, 3).

set_alpha(alpha)[исходный код]

Установить значение альфа для смешивания — поддерживается не всеми бэкендами.

Параметры

alphaмассивоподобный объект, скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[исходный код]

Установить, предназначен ли художник для использования в анимации.

Если значение True, художник исключается из обычной отрисовки фигуры. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для художника. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Более быстрая отрисовка с помощью блиттинга.

Параметры

bbool

set_antialiased(aa)[исходный код]

Установить состояние сглаживания при отрисовке.

Параметры

aabool или список булевых значений

set_antialiaseds(aa)[исходный код]: Псевдоним для set_antialiased.

set_array(A)[исходный код]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассивоподобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[исходный код]

Установить стиль окончания CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[исходный код]

Установить пределы нормализации для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также можно передать кортежем (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[исходный код]

Установить область обрезки художника Bbox.

Параметры

clipboxBbox

set_clip_on(b)[исходный код]

Установить, применяется ли к художнику обрезка.

Если значение False, художники будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[исходный код]

Установить обрезку для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

По техническим причинам (поддержка set) также допускается кортеж (path, transform) в качестве единственного позиционного параметра.

set_cmap(cmap)[исходный код]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

set_color(c)[исходный код]

Установить цвет обводки и заливки.

Параметры

cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для отдельной настройки цвета обводки или заливки.

set_dashes(ls)[исходный код]: Псевдоним для set_linestyle.

set_ec(c)[исходный код]: Псевдоним для set_edgecolor.

set_edgecolor(c)[исходный код]

Установить цвет обводки.

Параметры

cцвет или список цветов или 'face': Цвет обводки. Если последовательность, элементы будут циклически использовать значения из последовательности. Если 'face', цвет совпадает с цветом заливки.

set_edgecolors(c)[исходный код]: Псевдоним для set_edgecolor.

set_facecolor(c)[исходный код]

Установить цвет заливки. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если это последовательность, элементы будут циклически использовать значения из последовательности.

Если c равно 'none', элемент не будет заливаться.

Параметры

cцвет или список цветов

set_facecolors(c)[исходный код]: Псевдоним для set_facecolor.

set_fc(c)[исходный код]: Псевдоним для set_facecolor.

set_figure(fig)[исходный код]

Установить экземпляр Figure, к которому принадлежит элемент.

Параметры

figFigure

set_gid(gid)[исходный код]

Установить идентификатор группы для элемента.

Параметры

gidстрока

set_hatch(hatch)[исходный код]

Установить узор штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна буква повторяется, это увеличивает плотность штриховки для данного узора.

Штриховка поддерживается только в постскриптовых, PDF, SVG и Agg-бекендах.

Параметры

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)[исходный код]

Установить, должен ли объект быть включён в расчёты макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_joinstyle(js)[исходный код]

Установить JoinStyle для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[исходный код]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[исходный код]

Установить стиль(и) линии для набора.

стиль линии	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно предоставить кортеж дефисов следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины из значений включения и выключения чернил в пунктах.

Параметры

lsстрока или кортеж или список кортежей: Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[исходный код]: Псевдоним для set_linestyle.

set_linewidth(lw)[исходный код]

Установить толщину(ы) линии(й) для набора. lw может быть скаляром или последовательностью; если это последовательность, области будут циклически переходить по последовательности

Параметры

lwчисло или список чисел

set_linewidths(lw)[исходный код]: Псевдоним для set_linewidth.

set_ls(ls)[исходный код]: Псевдоним для set_linestyle.

set_lw(lw)[исходный код]: Псевдоним для set_linewidth.

set_norm(norm)[исходный код]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие отображаемую информацию для этой нормализации, установка нормализации отображаемой информации сбросит нормализацию, локатор и форматирование в цветовой шкале по умолчанию.

set_offset_transform(transOffset)[исходный код]

Установить трансформирование смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[исходный код]

Установите смещения для коллекции.

Параметры

смещения(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[исходный код]

Установите эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_paths()[исходный код]

set_picker(picker)[исходный код]

Определите поведение выбора для объекта.

Параметры

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующего:

None: Выбор отключен для данного объекта (по умолчанию).
Булево значение: Если True, выбор будет включен, и объект будет генерировать событие выбора, если курсор мыши находится над ним.
Число с плавающей точкой: Если picker — число, оно интерпретируется как толерантность к погрешности в точках, и объект будет генерировать событие, если его данные находятся в пределах погрешности от события мыши. Для некоторых объектов, таких как линии и коллекции фигур, объект может предоставлять дополнительные данные к событию выбора, например, индексы данных, находящихся в пределах погрешности от события выбора
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли объект под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над объектом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pr)[исходный код]

Установите радиус выбора, используемый для проверки попадания.

Параметры

prfloat: Радиус выбора в пунктах.

set_rasterized(rasterized)[исходный код]

Принудительно растрировать (преобразовать в растровый формат) отрисовку для выходных данных векторной графики.

Растровое отображение не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который не поддерживает его, команда не повлияет, и будет выведено предупреждение.

Это значение игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[исходный код]

Установите параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебания перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебания вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, на который длина сжимается или расширяется (по умолчанию 16.0)

Бэкенд PGF использует это значение как зерно для генератора псевдослучайных чисел, а не как описано выше. Использование одного и того же зерна приводит к одному и тому же случайному наброску.

set_snap(snap)[исходный код]

Установите поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чистым изображениям. Например, если черная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением на двух смежных пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что результирующее изображение будет действительно содержать черную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к центру ближайшего пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные сегменты, округлить до ближайшего центра пикселя.

set_transform(t)[исходный код]

Установите преобразование объекта.

Параметры

tTransform

set_url(url)[исходный код]

Установите URL для объекта.

Параметры

urlстрока

set_urls(urls)[исходный код]

Параметры

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[исходный код]

Установите видимость объекта.

Параметры

bbool

set_zorder(level)[исходный код]

Установите порядок отрисовки (zorder) объекта. Объекты с меньшим значением zorder отрисовываются первыми.

Параметры

levelfloat

propertystale: Указывает, является ли объект устаревшим и требует ли перерисовки для отображения актуального состояния.

propertysticky_edges

x и y списки прилипающих границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра прилипает к границе. Типичный пример использования — гистограммы, где, как правило, не ожидается отступ на нижней границе (0) гистограммы.

Кроме того, расширение отступов «натыкается» на прилипающие границы и не может их пересечь. Например, если верхний предел данных равен 1,0, а верхний предел просмотра, рассчитанный с помощью простого добавления отступа, равен 1,2, но есть прилипающая граница в 1,1, то фактический верхний предел просмотра будет равен 1,1.

Этому атрибуту нельзя присвоить значение; однако списки x и y можно изменять непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)[исходный код]

Возвращает массив rgba, соответствующий значению x, в нормализованном формате.

В обычном случае x представляет собой одномерную или двумерную последовательность скаляров, и на основе заданных нормализации и цветовой карты для этого объекта ScalarMappable будет возвращён соответствующий массив значений rgba.

Существует один специальный случай для обработки изображений, которые уже представлены в формате rgb или rgba, например, считанных из файла изображения. Если x представляет собой массив с 3 измерениями, а последнее измерение равно 3 или 4, то он будет обработан как rgb или rgba массив, и преобразование не будет выполнено. Массив может быть uint8 или иметь значения с плавающей запятой в диапазоне 0-1; в противном случае будет возбуждено исключение ValueError. Если это массив с пропусками, маска будет проигнорирована. Если последнее измерение равно 3, аргумент alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменит существующую прозрачность. ValueError будет возбужден, если третье измерение отлично от 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет представлять собой числа с плавающей точкой в диапазоне 0-1; если оно равно True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.

Если norm равно False, то нормализация входных данных не производится, и предполагается, что они находятся в диапазоне (0-1).

update(props)[исходный код]

Обновление свойств этого объекта из словаря props.

Параметры

propsdict

update_from(other)[исходный код]: Копирование свойств из other в self.

update_scalarmappable()[исходный код]

Обновление цветов из массива скалярной карты, если таковой имеется.

Присвоение цветов краям и граням на основе массива и/или цветов, заданных напрямую, в соответствии с требованиями.

zorder=0