matplotlib.collections

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

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

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

Базы: matplotlib.collections.RegularPolyCollection

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

numsides

количество сторон многоугольника

rotation

вращение многоугольника в радианах

sizes

указывают площадь окружности, описанной вокруг правильного многоугольника, в точках²

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

• edgecolors: None
• facecolors: None
• linewidths: None
• antialiaseds: None
• offsets: None
• transOffset: transforms.IdentityTransform()
• norm: None (необязательно для matplotlib.cm.ScalarMappable)
• cmap: None (необязательно для matplotlib.cm.ScalarMappable)

offsets и transOffset используются для перемещения фигуры после отрисовки (по умолчанию без смещений)

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

Пример: см. Демонстрация 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(self, func)

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

Параметры:	funccallable Функция обратного вызова. Она должна иметь сигнатуру: def func(artist: Artist) -> Any где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.
Возвращает:	oidint Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позднее.

См. также

remove_callback

add_checker(self, checker)

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

property aname

autoscale(self)

Автомасштабирование пределов скалярных значений в объекте norm с использованием текущего массива

autoscale_None(self)

Автомасштабирование пределов скалярных значений в объекте norm с использованием текущего массива, изменяя только пределы, которые равны None

property axes

Объект Axes, в котором находится элемент, или None.

changed(self)

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

check_update(self, checker)

Если отображаемый объект изменился с момента последней проверки, возвращает True; иначе возвращает False

contains(self, mouseevent)

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer)

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

Этот метод переопределяется в подклассах элемента. Обычно он реализуется так, чтобы не иметь никакого эффекта, если элемент не виден (Artist.get_visible равно False).

Параметры:	rendererRendererBase subclass.

findobj(self, match=None, include_self=True)

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

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

Параметры:

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

Возвращает:

artistslist of Artist

format_cursor_data(self, data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter(self)

Возвращает функцию фильтра для использования с agg-фильтром.

get_alpha(self)

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

get_animated(self)

Возвращает состояние анимации.

get_array(self)

Возвращает массив

get_capstyle(self)

get_children(self)

Возвращает список дочерних Artist-элементов данного Artist.

get_clim(self)

возвращает минимальное и максимальное значения пределов цвета для масштабирования изображения

get_clip_box(self)

Возвращает clipbox.

get_clip_on(self)

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

get_clip_path(self)

Возвращает путь обрезки.

get_cmap(self)

возвращает карту цветов

get_contains(self)

Возвращает пользовательскую функцию проверки попадания в элемент, если она установлена, иначе None.

См. также

set_contains

get_cursor_data(self, event)

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

Примечание

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

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

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

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

Параметры:	eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self)

Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self)

Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self)

Псевдоним для get_facecolor.

get_fc(self)

Псевдоним для get_facecolor.

get_figure(self)

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

get_fill(self)

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

get_gid(self)

Возвращает идентификатор группы.

get_hatch(self)

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

get_in_layout(self)

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

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

get_joinstyle(self)

get_label(self)

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

get_linestyle(self)

get_linestyles(self)

Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self)

Псевдоним для get_linewidth.

get_ls(self)

Псевдоним для get_linestyle.

get_lw(self)

Псевдоним для get_linewidth.

get_numsides(self)

get_offset_position(self)

Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования основного объекта, то есть смещения в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования основного объекта, то есть смещения в координатах данных.

get_offset_transform(self)

get_offsets(self)

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

get_path_effects(self)

get_paths(self)

get_picker(self)

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

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

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self)

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

get_rotation(self)

get_sizes(self)

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

Возвращает:	sizesarray 'Площадь' каждого элемента.

get_sketch_params(self)

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

Параметры:	rendererRendererBase instance рендерер, который будет использоваться для отрисовки графиков (например, fig.canvas.get_renderer())
Возвращает:	bboxBbox Охватывающая область (в пикселях изображения).

get_transform(self)

Возвращает объект Transform, используемый этим объектом.

get_transformed_clip_path_and_affine(self)

Возвращает путь обрезки с применённой частью преобразования, не связанной с аффином, и оставшуюся аффинную часть преобразования.

get_transforms(self)

get_url(self)

Возвращает URL.

get_urls(self)

get_visible(self)

Возвращает видимость.

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self)

Возвращает порядок z объекта.

have_units(self)

Возвращает True, если единицы установлены на какой-либо оси.

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback

remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self)

Возвращает словарь всех свойств объекта.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs)

Метод пакетной установки свойств. Передайте kwargs для установки свойств.

set_aa(self, aa)

Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

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

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

set_animated(self, b)

Установка состояния анимации объекта.

Параметры:	bbool

set_antialiased(self, aa)

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

Параметры:	aabool or sequence of bools

set_antialiaseds(self, aa)

Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображения из массива NumPy A.

Параметры:	Andarray

set_capstyle(self, cs)

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

Параметры:	cs{'butt', 'round', 'projecting'} Стиль окончания линии

set_clim(self, vmin=None, vmax=None)

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

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

set_clip_box(self, clipbox)

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

Параметры:	clipboxBbox

set_clip_on(self, b)

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

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

Параметры:	bbool

set_clip_path(self, path, transform=None)

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

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

Примечания

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

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

set_cmap(self, cmap)

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

Параметры:	cmapcolormap or registered colormap name

set_color(self, c)

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

Параметры:	ccolor or sequence of rgba tuples

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(self, picker)

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

Предоставленная вызываемая функция заменяет метод contains по умолчанию объекта.

Параметры:

pickercallable Пользовательская функция для определения, находится ли событие внутри объекта. Функция должна иметь следующий синтаксис: def contains(artist: Artist, event: MouseEvent) -> bool, dict которая возвращает: булево значение, указывающее, находится ли событие внутри объекта словарь дополнительной информации. Словарь должен по крайней мере возвращать ту же информацию, что и реализация contains() по умолчанию соответствующего объекта, но может содержать дополнительную информацию.

set_dashes(self, ls)

Псевдоним для set_linestyle.

set_ec(self, c)

Псевдоним для set_edgecolor.

set_edgecolor(self, c)

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

Параметры:	ccolor or sequence of colors or 'face' Цвет(а) обводки коллекции. Если последовательность, фигуры циклически просматривают её. Если 'face', соответствуют цвету заливки.

set_edgecolors(self, c)

Псевдоним для set_edgecolor.

set_facecolor(self, c)

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

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

Параметры:	ccolor or sequence of colors

set_facecolors(self, c)

Псевдоним для set_facecolor.

set_fc(self, c)

Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	figFigure

set_gid(self, gid)

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

Параметры:	gidstr

set_hatch(self, 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(self, in_layout)

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

Параметры:	in_layoutbool

set_joinstyle(self, js)

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

Параметры:	js{'miter', 'round', 'bevel'} Тип соединения

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls)

Псевдоним для set_linestyle.

set_linewidth(self, lw)

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

Параметры:	lwfloat or sequence of floats

set_linewidths(self, lw)

Псевдоним для set_linewidth.

set_ls(self, ls)

Псевдоним для set_linestyle.

set_lw(self, lw)

Псевдоним для set_linewidth.

set_norm(self, norm)

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

Параметры:	normNormalize

Примечания

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

set_offset_position(self, offset_position)

Установить способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования мастера, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования мастера, то есть смещения находятся в координатах данных.

Параметры:	offset_position{'screen', 'data'}

set_offsets(self, offsets)

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

Параметры:	offsetsarray-like (N, 2) or (2,)

set_path_effects(self, path_effects)

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

Параметры:	path_effectsAbstractPathEffect

set_paths(self)

set_picker(self, picker)

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

Параметры:

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

set_pickradius(self, pr)

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

Параметры:	dfloat Радиус выбора в пунктах.

set_rasterized(self, rasterized)

Вызвать растрирование (отображение в формате bitmap) в выходных данных векторного бэкенда.

По умолчанию None, что подразумевает поведение по умолчанию бэкенда.

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

set_sizes(self, sizes, dpi=72.0)

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

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

set_sketch_params(self, scale=None, length=None, randomness=None)

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

Параметры:	scalefloat, optional Амплитуда колебаний, перпендикулярных линии источника, в пикселях. Если scale — None, или не указана, фильтр наброска не будет применён. lengthfloat, optional Длина колебаний вдоль линии, в пикселях (по умолчанию 128.0) randomnessfloat, optional Коэффициент масштабирования, с которым длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	tTransform

set_url(self, url)

Устанавливает URL для художника.

Параметры:	urlstr

set_urls(self, urls)

Параметры:	urlsList[str] or None

set_visible(self, b)

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

Параметры:	bbool

set_zorder(self, level)

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

Параметры:	levelfloat

property stale

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

property sticky_edges

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

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

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

Примеры

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

to_rgba(self, 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 игнорируется; он не заменяет существующий альфа-канал. Будет возбуждено исключение ValueError, если третье измерение отличается от 3 или 4.

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

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

update(self, props)

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

update_from(self, other)

Копировать свойства из other в self

update_scalarmappable(self)

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

zorder = 0

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

Bases: matplotlib.collections.PolyCollection

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

xranges

последовательность (xmin, xwidth)

yrange

ymin, ywidth

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

• edgecolors: None
• facecolors: None
• linewidths: None
• antialiaseds: None
• offsets: None
• transOffset: transforms.IdentityTransform()
• norm: None (необязательно для matplotlib.cm.ScalarMappable)
• cmap: None (необязательно для matplotlib.cm.ScalarMappable)

offsets и transOffset используются для перемещения области после отрисовки (по умолчанию без смещений)

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

add_callback(self, func)

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

Параметры:	funccallable Функция обратного вызова. Она должна иметь следующий вид: def func(artist: Artist) -> Any где artist — вызывающий Artist. Возвращаемые значения могут существовать, но игнорируются.
Возвращает:	oidint Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

add_checker(self, checker)

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

property aname

autoscale(self)

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

autoscale_None(self)

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

property axes

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

changed(self)

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

check_update(self, checker)

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

contains(self, mouseevent)

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer)

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

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

Параметры:	rendererRendererBase subclass.

findobj(self, match=None, include_self=True)

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

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

Параметры:

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

Возвращает:

artistslist of Artist

format_cursor_data(self, data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter(self)

Возвращает функцию фильтра для использования с agg фильтром.

get_alpha(self)

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

get_animated(self)

Возвращает состояние анимации.

get_array(self)

Возвращает массив.

get_capstyle(self)

get_children(self)

Возвращает список дочерних Artist элементов этого Artist.

get_clim(self)

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

get_clip_box(self)

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

get_clip_on(self)

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

get_clip_path(self)

Возвращает путь обрезки.

get_cmap(self)

Возвращает цветовую карту.

get_contains(self)

Возвращает пользовательскую функцию проверки попадания, если она задана, в противном случае None.

См. также

set_contains

get_cursor_data(self, event)

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

Примечание

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

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

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

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

Параметры:	eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self)

Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self)

Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self)

Псевдоним для get_facecolor.

get_fc(self)

Псевдоним для get_facecolor.

get_figure(self)

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

get_fill(self)

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

get_gid(self)

Возвращает идентификатор группы.

get_hatch(self)

Возвращает текущую схему штриховки.

get_in_layout(self)

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

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

get_joinstyle(self)

get_label(self)

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

get_linestyle(self)

get_linestyles(self)

Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self)

Псевдоним для get_linewidth.

get_ls(self)

Псевдоним для get_linestyle.

get_lw(self)

Псевдоним для get_linewidth.

get_offset_position(self)

Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования главного объекта, то есть смещения заданы в координатах экрана. Если offset_position равен 'data', смещение применяется перед преобразованием главного объекта, т.е. смещения заданы в координатах данных.

get_offset_transform(self)

get_offsets(self)

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

get_path_effects(self)

get_paths(self)

get_picker(self)

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

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

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self)

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

get_sizes(self)

Возвращает размеры элементов в коллекции. Значение представляет собой «площадь» элемента.

Возвращает:	sizesarray «Площадь» каждого элемента.

get_sketch_params(self)

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

Параметры:	rendererRendererBase instance рендерер, который будет использоваться для отрисовки графиков (т. е. fig.canvas.get_renderer())
Возвращает:	bboxBbox Вложенная область отображения (в пиксельных координатах рисунка).

get_transform(self)

Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine(self)

Возвращает область обрезки с применённой неаффинной частью её преобразования и оставшейся аффинной частью её преобразования.

get_transforms(self)

get_url(self)

Возвращает URL.

get_urls(self)

get_visible(self)

Возвращает видимость.

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self)

Возвращает z-порядок объекта.

have_units(self)

Возвращает True, если единицы установлены на любой оси.

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback

remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self)

Возвращает словарь всех свойств объекта.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs)

Установщик свойств в пакетном режиме. Передайте kwargs для установки свойств.

set_aa(self, aa)

Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

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

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

set_animated(self, b)

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

Параметры:	bbool

set_antialiased(self, aa)

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

Параметры:	aabool or sequence of bools

set_antialiaseds(self, aa)

Псевдоним для set_antialiased.

set_array(self, A)

Устанавливает массив изображения из массива NumPy A.

Параметры:	Andarray

set_capstyle(self, cs)

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

Параметры:	cs{'butt', 'round', 'projecting'} Стиль окончания.

set_clim(self, vmin=None, vmax=None)

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

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

set_clip_box(self, clipbox)

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

Параметры:	clipboxBbox

set_clip_on(self, b)

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

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

Параметры:	bbool

set_clip_path(self, path, transform=None)

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

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

Примечания

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

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

set_cmap(self, cmap)

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

Параметры:	cmapcolormap or registered colormap name

set_color(self, c)

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

Параметры:	ccolor or sequence of rgba tuples

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(self, picker)

Определите пользовательскую проверку нахождения элемента внутри области.

Предоставленная вызываемая функция заменяет метод contains элемента по умолчанию.

Параметры:

pickercallable Пользовательская функция определения нахождения события внутри элемента. Функция должна иметь следующий вид: def contains(artist: Artist, event: MouseEvent) -> bool, dict что возвращает: значение boolean, указывающее, находится ли событие внутри элемента словарь дополнительной информации. Словарь должен, как минимум, возвращать ту же информацию, что и реализация contains() по умолчанию для соответствующего элемента, но может содержать дополнительную информацию.

set_dashes(self, ls)

Псевдоним для set_linestyle.

set_ec(self, c)

Псевдоним для set_edgecolor.

set_edgecolor(self, c)

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

Параметры:	ccolor or sequence of colors or 'face' Цвет(цвета) границы коллекции. Если последовательность, фигуры циклически используют её элементы. Если 'face', соответствует цвету заливки.

set_edgecolors(self, c)

Псевдоним для set_edgecolor.

set_facecolor(self, c)

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

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

Параметры:	ccolor or sequence of colors

set_facecolors(self, c)

Псевдоним для set_facecolor.

set_fc(self, c)

Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	figFigure

set_gid(self, gid)

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

Параметры:	gidstr

set_hatch(self, 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(self, in_layout)

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

Параметры:	in_layoutbool

set_joinstyle(self, js)

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

Параметры:	js{'miter', 'round', 'bevel'} Стиль соединения

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls)

Псевдоним для set_linestyle.

set_linewidth(self, lw)

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

Параметры:	lwfloat or sequence of floats

set_linewidths(self, lw)

Псевдоним для set_linewidth.

set_ls(self, ls)

Псевдоним для set_linestyle.

set_lw(self, lw)

Псевдоним для set_linewidth.

set_norm(self, norm)

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

Параметры:	normNormalize

Примечания

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

set_offset_position(self, offset_position)

Указать, как применяются смещения. Если offset_position равно 'screen' (по умолчанию), смещение применяется после применения преобразования мастера, то есть смещения задаются в координатах экрана. Если offset_position равно 'data', смещение применяется до преобразования мастера, т. е. смещения задаются в координатах данных.

Параметры:	offset_position{'screen', 'data'}

set_offsets(self, offsets)

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

Параметры:	offsetsarray-like (N, 2) or (2,)

set_path_effects(self, path_effects)

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

Параметры:	path_effectsAbstractPathEffect

set_paths(self, verts, closed=True)

Это позволяет отложить инициализацию вершин.

set_picker(self, picker)

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

Параметры:

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

set_pickradius(self, pr)

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

Параметры:	dfloat Радиус выбора в пунктах.

set_rasterized(self, rasterized)

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

По умолчанию None, что предполагает поведение, заданное по умолчанию для бэкенда.

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

set_sizes(self, sizes, dpi=72.0)

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

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

set_sketch_params(self, scale=None, length=None, randomness=None)

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

Параметры:	scalefloat, optional Амплитуда колебаний перпендикулярно линии источника, в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применён. lengthfloat, optional Длина колебаний вдоль линии, в пикселях (по умолчанию 128.0) randomnessfloat, optional Коэффициент масштабирования, на который умножается длина (по умолчанию 16.0)

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	tTransform

set_url(self, url)

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

Параметры:	urlstr

set_urls(self, urls)

Параметры:	urlsList[str] or None

set_verts(self, verts, closed=True)

Это позволяет отложить инициализацию вершин.

set_verts_and_codes(self, verts, codes)

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

set_visible(self, b)

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

Параметры:	bbool

set_zorder(self, level)

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

Параметры:	levelfloat

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

Создаёт BrokenBarHCollection для построения горизонтальных полос по областям в x, где where истинно. Полосы простираются по оси y от ymin до ymax.

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

property stale

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

property sticky_edges

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

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

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

Примеры

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

to_rgba(self, x, alpha=None, bytes=False, norm=True)

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

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

Существует один особый случай для обработки изображений, которые уже являются rgb или rgba, например, загруженных из файла изображения. Если x — это массив ndarray с 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(self, props)

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

update_from(self, other)

копирует свойства из other в self

update_scalarmappable(self)

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

zorder = 0

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

Bases: matplotlib.collections._CollectionWithSizes

A collection of circles, drawn using splines.

sizes Gives the area of the circle in points^2

Valid Collection keyword arguments:

• edgecolors: None
• facecolors: None
• linewidths: None
• antialiaseds: None
• offsets: None
• transOffset: transforms.IdentityTransform()
• norm: None (optional for matplotlib.cm.ScalarMappable)
• cmap: None (optional for matplotlib.cm.ScalarMappable)

offsets and transOffset are used to translate the patch after rendering (default no offsets)

If any of edgecolors, facecolors, linewidths, antialiaseds are None, they default to their matplotlib.rcParams patch setting, in sequence form.

add_callback(self, func)

Add a callback function that will be called whenever one of the Artist's properties changes.

Parameters:	funccallable The callback function. It must have the signature: def func(artist: Artist) -> Any where artist is the calling Artist. Return values may exist but are ignored.
Returns:	oidint The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.

See also

remove_callback

add_checker(self, checker)

Add an entry to a dictionary of boolean flags that are set to True when the mappable is changed.

property aname

autoscale(self)

Autoscale the scalar limits on the norm instance using the current array

autoscale_None(self)

Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None

property axes

The Axes instance the artist resides in, or None.

changed(self)

Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal

check_update(self, checker)

If mappable has changed since the last check, return True; else return False

contains(self, mouseevent)

Test whether the mouse event occurred in the collection.

Returns bool, dict(ind=itemlist), where every item in itemlist contains the event.

convert_xunits(self, x)

Convert x using the unit type of the xaxis.

If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.

convert_yunits(self, y)

Convert y using the unit type of the yaxis.

If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.

draw(self, renderer)

Draw the Artist using the given renderer.

This method will be overridden in the Artist subclasses. Typically, it is implemented to not have any effect if the Artist is not visible (Artist.get_visible is False).

Parameters:	rendererRendererBase subclass.

findobj(self, match=None, include_self=True)

Find artist objects.

Recursively find all Artist instances contained in the artist.

Parameters:

match A filter criterion for the matches. This can be None: Return all objects contained in artist. A function with signature def match(artist: Artist) -> bool. The result will only contain artists for which the function returns True. A class instance: e.g., Line2D. The result will only contain artists of this class or its subclasses (isinstance check). include_selfbool Include self in the list to be checked for a match.

Returns:

artistslist of Artist

format_cursor_data(self, data)

Return a string representation of data.

Примечание

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

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

См. также

get_cursor_data

get_agg_filter(self)

Return filter function to be used for agg filter.

get_alpha(self)

Return the alpha value used for blending - not supported on all backends

get_animated(self)

Return the animated state.

get_array(self)

Return the array

get_capstyle(self)

get_children(self)

Return a list of the child Artists of this Artist.

get_clim(self)

return the min, max of the color limits for image scaling

get_clip_box(self)

Return the clipbox.

get_clip_on(self)

Return whether the artist uses clipping.

get_clip_path(self)

Return the clip path.

get_cmap(self)

return the colormap

get_contains(self)

Return the custom contains function of the artist if set, or None.

См. также

set_contains

get_cursor_data(self, event)

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

Примечание

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

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

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

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

Параметры:	eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self)

Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self)

Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self)

Псевдоним для get_facecolor.

get_fc(self)

Псевдоним для get_facecolor.

get_figure(self)

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

get_fill(self)

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

get_gid(self)

Возвращает идентификатор группы.

get_hatch(self)

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

get_in_layout(self)

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

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

get_joinstyle(self)

get_label(self)

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

get_linestyle(self)

get_linestyles(self)

Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self)

Псевдоним для get_linewidth.

get_ls(self)

Псевдоним для get_linestyle.

get_lw(self)

Псевдоним для get_linewidth.

get_offset_position(self)

Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования родительского объекта, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется перед преобразованием родительского объекта, то есть смещения находятся в координатах данных.

get_offset_transform(self)

get_offsets(self)

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

get_path_effects(self)

get_paths(self)

get_picker(self)

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

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

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self)

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

get_sizes(self)

Возвращает размеры элементов в коллекции. Значение представляет собой «площадь» элемента.

Возвращает:	sizesarray «Площадь» каждого элемента.

get_sketch_params(self)

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

Параметры:	rendererRendererBase instance рендерер, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())
Возвращает:	bboxBbox Охватывающая область (в пикселях координат фигуры).

get_transform(self)

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

get_transformed_clip_path_and_affine(self)

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

get_transforms(self)

get_url(self)

Возвращает URL.

get_urls(self)

get_visible(self)

Возвращает видимость.

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self)

Возвращает z-порядок элемента.

have_units(self)

Возвращает True, если единицы установлены на любой оси.

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback

remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self)

Возвращает словарь всех свойств элемента.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs)

Установка свойств по пакету. Передайте kwargs для установки свойств.

set_aa(self, aa)

Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

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

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

set_animated(self, b)

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

Параметры:	bbool

set_antialiased(self, aa)

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

Параметры:	aabool or sequence of bools

set_antialiaseds(self, aa)

Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображения из массива NumPy A.

Параметры:	Andarray

set_capstyle(self, cs)

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

Параметры:	cs{'butt', 'round', 'projecting'} Стиль обрезки

set_clim(self, vmin=None, vmax=None)

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

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

set_clip_box(self, clipbox)

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

Параметры:	clipboxBbox

set_clip_on(self, b)

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

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

Параметры:	bbool

set_clip_path(self, path, transform=None)

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

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

Примечания

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

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

set_cmap(self, cmap)

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

Параметры:	cmapcolormap or registered colormap name

set_color(self, c)

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

Параметры:	ccolor or sequence of rgba tuples

См. также

Collection.set_facecolor, Collection.set_edgecolor

Для настройки цвета обводки или заливки индивидуально.

set_contains(self, picker)

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

Переданная функция заменяет стандартный метод contains элемента.

Параметры:

pickercallable Пользовательская функция проверки принадлежности, оценивающая, находится ли событие внутри элемента. Функция должна иметь следующую сигнатуру: def contains(artist: Artist, event: MouseEvent) -> bool, dict которая возвращает: значение boolean, указывающее, находится ли событие внутри элемента словарь дополнительной информации. Словарь должен возвращать по крайней мере ту же информацию, что и стандартная реализация contains() соответствующего элемента, но может предоставлять дополнительную информацию.

set_dashes(self, ls)

Псевдоним для set_linestyle.

set_ec(self, c)

Псевдоним для set_edgecolor.

set_edgecolor(self, c)

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

Параметры:	ccolor or sequence of colors or 'face' Цвет(а) обводки коллекции. Если это последовательность, то элементы циклически принимают значения из неё. Если 'face', то цвет совпадает с цветом заливки.

set_edgecolors(self, c)

Псевдоним для set_edgecolor.

set_facecolor(self, c)

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

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

Параметры:	ccolor or sequence of colors

set_facecolors(self, c)

Псевдоним для set_facecolor.

set_fc(self, c)

Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	figFigure

set_gid(self, gid)

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

Параметры:	gidstr

set_hatch(self, hatch)

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

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

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

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

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

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

Параметры:	hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(self, in_layout)

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

Параметры:	in_layoutbool

set_joinstyle(self, js)

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

Параметры:	js{'miter', 'round', 'bevel'} Стиль соединения

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls)

Псевдоним для set_linestyle.

set_linewidth(self, lw)

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

Параметры:	lwfloat or sequence of floats

set_linewidths(self, lw)

Псевдоним для set_linewidth.

set_ls(self, ls)

Псевдоним для set_linestyle.

set_lw(self, lw)

Псевдоним для set_linewidth.

set_norm(self, norm)

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

Параметры:	normNormalize

Примечания

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

set_offset_position(self, offset_position)

Установить, как применяются смещения. Если offset_position — 'screen' (по умолчанию), смещение применяется после применения преобразования master, то есть смещения находятся в координатах экрана. Если offset_position — 'data', смещение применяется до преобразования master, то есть смещения находятся в координатах данных.

Параметры:	offset_position{'screen', 'data'}

set_offsets(self, offsets)

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

Параметры:	offsetsarray-like (N, 2) or (2,)

set_path_effects(self, path_effects)

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

Параметры:	path_effectsAbstractPathEffect

set_paths(self)

set_picker(self, picker)

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

Параметры:

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

set_pickradius(self, pr)

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

Параметры:	dfloat Радиус выбора, в пунктах.

set_rasterized(self, rasterized)

Принудительно выполнить растровое (битовое) отображение в векторе вывода.

По умолчанию значение None, что подразумевает поведение по умолчанию для бэкенда.

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

set_sizes(self, sizes, dpi=72.0)

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

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

set_sketch_params(self, scale=None, length=None, randomness=None)

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

Параметры:	scalefloat, optional Амплитуда колебаний, перпендикулярных исходной линии, в пикселях. Если scale — None или не предоставлено, фильтр наброска не будет применён. lengthfloat, optional Длина колебаний вдоль линии, в пикселях (по умолчанию 128.0). randomnessfloat, optional Коэффициент масштабирования, по которому длина уменьшается или увеличивается (по умолчанию 16.0).

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	tTransform

set_url(self, url)

Установить URL для художника.

Параметры:	urlstr

set_urls(self, urls)

Параметры:	urlsList[str] or None

set_visible(self, b)

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

Параметры:	bbool

set_zorder(self, level)

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

Параметры:	levelfloat

property stale

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

property sticky_edges

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

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

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

Примеры

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

to_rgba(self, 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(self, props)

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

update_from(self, other)

копировать свойства из other в self

update_scalarmappable(self)

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

zorder = 0

class matplotlib.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, offset_position='screen', zorder=1, **kwargs) [source]

Базовые классы: matplotlib.artist.Artist, matplotlib.cm.ScalarMappable

Базовый класс для коллекций. Должен быть расширен для использования.

Все свойства в коллекции должны быть последовательностями или скалярами; если скалярами, они будут преобразованы в последовательности. Свойство i-го элемента коллекции:

prop[i % len(props)]

Исключения — свойства capstyle и joinstyle, которые могут быть установлены только глобально для всей коллекции.

Ключевые аргументы и значения по умолчанию:

• edgecolors: None
• facecolors: None
• linewidths: None
• capstyle: None
• joinstyle: None
• antialiaseds: None
• offsets: None
• transOffset: transforms.IdentityTransform()
• offset_position: 'screen' (по умолчанию) или 'data'
• norm: None (необязательно для matplotlib.cm.ScalarMappable)
• cmap: None (необязательно для matplotlib.cm.ScalarMappable)
• hatch: None
• zorder: 1

offsets и transOffset используются для перемещения объекта-патча после отрисовки (по умолчанию без смещений). Если offset_position — 'screen' (по умолчанию), смещение применяется после применения преобразования мастера, то есть смещения в координатах экрана. Если offset_position — 'data', смещение применяется до преобразования мастера, т. е. смещения в координатах данных.

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

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

Создание коллекции

%(Collection)s

add_callback(self, func)

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

Параметры:	funccallable Функция обратного вызова. Она должна иметь следующий сигнатуру: def func(artist: Artist) -> Any где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.
Возвращаемое значение:	oidint Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

add_checker(self, checker)

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

property aname

autoscale(self)

Автомасштабирование пределов скаляров в экземпляре norm с использованием текущего массива

autoscale_None(self)

Автомасштабирование пределов скаляров в экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None

property axes

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

changed(self)

Вызов при изменении mappable, чтобы уведомить всех слушателей обратного вызова о сигнале 'changed'

check_update(self, checker)

Если mappable изменился с момента последней проверки, возвращает True; иначе возвращает False

contains(self, mouseevent) [source]

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer) [source]

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

Этот метод переопределяется в подклассах Artist. Обычно он не имеет эффекта, если объект-артист не виден (Artist.get_visible равен False).

Параметры:	rendererRendererBase subclass.

findobj(self, match=None, include_self=True)

Поиск объектов-артистов.

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

Параметры:

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

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

artistslist of Artist

format_cursor_data(self, data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter(self)

Возвращает функцию фильтра для использования с agg-фильтром.

get_alpha(self)

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

get_animated(self)

Возвращает состояние анимации.

get_array(self)

Возвращает массив.

get_capstyle(self) [source]

get_children(self)

Возвращает список дочерних элементов Artist этого Artist.

get_clim(self)

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

get_clip_box(self)

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

get_clip_on(self)

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

get_clip_path(self)

Возвращает путь обрезки.

get_cmap(self)

Возвращает карту цветов.

get_contains(self)

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

См. также

set_contains

get_cursor_data(self, event)

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

Примечание

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

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

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

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

Параметры:	eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

Псевдоним для get_linestyle.

get_datalim(self, transData) [source]

get_ec(self)

Псевдоним для get_edgecolor.

get_edgecolor(self) [source]

get_edgecolors(self)

Псевдоним для get_edgecolor.

get_facecolor(self) [source]

get_facecolors(self)

Псевдоним для get_facecolor.

get_fc(self)

Псевдоним для get_facecolor.

get_figure(self)

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

get_fill(self) [source]

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

get_gid(self)

Возвращает идентификатор группы.

get_hatch(self) [source]

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

get_in_layout(self)

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

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

get_joinstyle(self) [source]

get_label(self)

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

get_linestyle(self) [source]

get_linestyles(self)

Псевдоним для get_linestyle.

get_linewidth(self) [source]

get_linewidths(self)

Псевдоним для get_linewidth.

get_ls(self)

Псевдоним для get_linestyle.

get_lw(self)

Псевдоним для get_linewidth.

get_offset_position(self) [source]

Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования master, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования master, то есть смещения задаются в координатах данных.

get_offset_transform(self) [source]

get_offsets(self) [source]

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

get_path_effects(self)

get_paths(self) [source]

get_picker(self)

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

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

См. также

set_picker, pickable, pick

get_pickradius(self) [source]

get_rasterized(self)

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

get_sketch_params(self)

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

Параметры:	rendererRendererBase instance рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())
Возвращает:	bboxBbox Охватывающая область (в пикселях изображения).

get_transform(self)

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

get_transformed_clip_path_and_affine(self)

Возвращает путь обрезки с применённой не-аффинной частью преобразования и оставшейся аффинной частью преобразования.

get_transforms(self) [source]

get_url(self)

Возвращает URL.

get_urls(self) [source]

get_visible(self)

Возвращает видимость.

get_window_extent(self, renderer) [source]

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

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

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

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

get_zorder(self)

Возвращает z-порядок элемента.

have_units(self)

Возвращает True, если единицы установлены на любой оси.

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback

remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self)

Возвращает словарь всех свойств элемента.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs)

Установщик свойств по партиям. Передайте kwargs для установки свойств.

set_aa(self, aa)

Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha) [source]

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

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

set_animated(self, b)

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

Параметры:	bbool

set_antialiased(self, aa) [source]

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

Параметры:	aabool or sequence of bools

set_antialiaseds(self, aa)

Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображений из массива NumPy A.

Параметры:	Andarray

set_capstyle(self, cs) [source]

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

Параметры:	cs{'butt', 'round', 'projecting'} Стиль обрезки

set_clim(self, vmin=None, vmax=None)

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

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

set_clip_box(self, clipbox)

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

Параметры:	clipboxBbox

set_clip_on(self, b)

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

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

Параметры:	bbool

set_clip_path(self, path, transform=None)

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

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

Примечания

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

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

set_cmap(self, cmap)

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

Параметры:	cmapcolormap or registered colormap name

set_color(self, c) [source]

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

Параметры:	ccolor or sequence of rgba tuples

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(self, picker)

Определить пользовательскую проверку принадлежности для объекта.

Предоставленная вызываемая функция заменяет стандартный метод contains объекта.

Параметры:

pickercallable Пользовательская функция выбора, определяющая, находится ли событие внутри объекта. Функция должна иметь сигнатуру: def contains(artist: Artist, event: MouseEvent) -> bool, dict которая возвращает: булево значение, указывающее, находится ли событие внутри объекта словарь дополнительной информации. Словарь должен по крайней мере возвращать ту же информацию, что и реализация contains() соответствующего объекта, но может предоставлять дополнительную информацию.

set_dashes(self, ls)

Псевдоним для set_linestyle.

set_ec(self, c)

Псевдоним для set_edgecolor.

set_edgecolor(self, c) [source]

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

Параметры:	ccolor or sequence of colors or 'face' Цвет(цвета) границы коллекции. Если последовательность, то элементы будут циклически использовать значения. Если 'face', соответствовать цвету заливки.

set_edgecolors(self, c)

Псевдоним для set_edgecolor.

set_facecolor(self, c) [source]

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

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

Параметры:	ccolor or sequence of colors

set_facecolors(self, c)

Псевдоним для set_facecolor.

set_fc(self, c)

Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	figFigure

set_gid(self, gid)

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

Параметры:	gidstr

set_hatch(self, hatch) [source]

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

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

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

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

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

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

Параметры:	hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(self, in_layout)

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

Параметры:	in_layoutbool

set_joinstyle(self, js) [source]

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

Параметры:	js{'miter', 'round', 'bevel'} Стиль соединения

set_label(self, s)

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

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

set_linestyle(self, ls) [source]

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls)

Псевдоним для set_linestyle.

set_linewidth(self, lw) [source]

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

Параметры:	lwfloat or sequence of floats

set_linewidths(self, lw)

Псевдоним для set_linewidth.

set_ls(self, ls)

Псевдоним для set_linestyle.

set_lw(self, lw)

Псевдоним для set_linewidth.

set_norm(self, norm)

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

Параметры:	normNormalize

Примечания

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

set_offset_position(self, offset_position) [source]

Установите способ применения смещений. Если offset_position равно 'screen' (по умолчанию), смещение применяется после применения преобразования родительского преобразования, то есть смещения указаны в координатах экрана. Если offset_position равно 'data', смещение применяется до преобразования родительского преобразования, т.е. смещения заданы в координатах данных.

Параметры:	offset_position{'screen', 'data'}

set_offsets(self, offsets) [source]

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

Параметры:	offsetsarray-like (N, 2) or (2,)

set_path_effects(self, path_effects)

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

Параметры:	path_effectsAbstractPathEffect

set_paths(self) [source]

set_picker(self, picker)

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

Параметры:

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

set_pickradius(self, pr) [source]

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

Параметры:	dfloat Радиус выбора, в точках.

set_rasterized(self, rasterized)

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

По умолчанию None, что подразумевает поведение по умолчанию бэкэнда.

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

set_sketch_params(self, scale=None, length=None, randomness=None)

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

Параметры:	scalefloat, optional Амплитуда колебания перпендикулярно исходной линии, в пикселях. Если scale None, или не указан, фильтр наброска не будет применён. lengthfloat, optional Длина колебания вдоль линии, в пикселях (по умолчанию 128.0) randomnessfloat, optional Коэффициент масштабирования, с которым длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	tTransform

set_url(self, url)

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

Параметры:	urlstr

set_urls(self, urls) [source]

Параметры:	urlsList[str] or None

set_visible(self, b)

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

Параметры:	bbool

set_zorder(self, level)

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

Параметры:	levelfloat

property stale

Является ли элемент «неактуальным» и требуется ли его повторная отрисовка для соответствия внутреннего состояния элемента результату.

property sticky_edges

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

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

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

Примеры

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

to_rgba(self, x, alpha=None, bytes=False, norm=True)

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

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

Есть один специальный случай, для обработки изображений, которые уже находятся в формате rgb или rgba, таких, как полученные из файла изображения. Если x — массив ndarray с тремя измерениями, и последнее измерение — 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(self, props)

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

update_from(self, other) [source]

Скопировать свойства из other в self

update_scalarmappable(self) [source]

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

zorder = 0

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

Bases: 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. Допустимые ключевые аргументы для Collection: edgecolors: None facecolors: None linewidths: None antialiaseds: None offsets: None transOffset: transforms.IdentityTransform() norm: None (необязательно для matplotlib.cm.ScalarMappable) cmap: None (необязательно для matplotlib.cm.ScalarMappable) offsets и transOffset используются для перемещения фигуры после рендеринга (по умолчанию смещений нет). Если любые из edgecolors, facecolors, linewidths, antialiaseds равны None, они по умолчанию принимают значения из matplotlib.rcParams для фигуры, в порядке следования.

add_callback(self, func)

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

Параметры:	funccallable Функция обратного вызова. Она должна иметь сигнатуру: def func(artist: Artist) -> Any где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.
Возвращает:	oidint Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

add_checker(self, checker)

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

property aname

autoscale(self)

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

autoscale_None(self)

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

property axes

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

changed(self)

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

check_update(self, checker)

Если отображение изменилось с последней проверки, верните True; иначе верните False

contains(self, mouseevent)

Проверить, произошел ли щелчок мыши в коллекции.

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer) [source]

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

Этот метод переопределяется в подклассах элементов. Как правило, он реализован так, чтобы не иметь никакого эффекта, если элемент не отображается (Artist.get_visible равно False).

Параметры:	rendererRendererBase subclass.

findobj(self, match=None, include_self=True)

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

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

Параметры:

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

Возвращает:

artistslist of Artist

format_cursor_data(self, data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter(self)

Возвращает функцию фильтра, используемую для agg-фильтра.

get_alpha(self)

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

get_animated(self)

Возвращает состояние анимации.

get_array(self)

Возвращает массив

get_capstyle(self)

get_children(self)

Возвращает список дочерних Artist элементов этого Artist.

get_clim(self)

возвращает минимальное и максимальное значения пределов цвета для масштабирования изображения

get_clip_box(self)

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

get_clip_on(self)

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

get_clip_path(self)

Возвращает путь обрезки.

get_cmap(self)

возвращает карту цветов

get_contains(self)

Возвращает пользовательскую функцию проверки попадания в элемент, если она установлена, в противном случае — None.

См. также

set_contains

get_cursor_data(self, event)

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

Примечание

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

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

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

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

Параметры:	eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self)

Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self)

Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self)

Псевдоним для get_facecolor.

get_fc(self)

Псевдоним для get_facecolor.

get_figure(self)

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

get_fill(self)

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

get_gid(self)

Возвращает идентификатор группы.

get_hatch(self)

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

get_in_layout(self)

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

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

get_joinstyle(self)

get_label(self)

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

get_linestyle(self)

get_linestyles(self)

Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self)

Псевдоним для get_linewidth.

get_ls(self)

Псевдоним для get_linestyle.

get_lw(self)

Псевдоним для get_linewidth.

get_offset_position(self)

Возвращает способ применения смещений для коллекции. Если offset_position равно 'screen', смещение применяется после применения трансформации главного объекта, то есть смещения находятся в координатах экрана. Если offset_position равно 'data', смещение применяется до трансформации главного объекта, то есть смещения находятся в координатах данных.

get_offset_transform(self)

get_offsets(self)

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

get_path_effects(self)

get_paths(self)

get_picker(self)

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

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

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self)

Возвращает, должна ли быть растрирована фигура.

get_sketch_params(self)

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

Параметры:	rendererRendererBase instance рендерер, который будет использоваться для отрисовки фигур (т. е. fig.canvas.get_renderer())
Возвращает:	bboxBbox Вложенная область обрезки (в пикселях координат фигуры).

get_transform(self)

Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine(self)

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

get_transforms(self)

get_url(self)

Возвращает URL.

get_urls(self)

get_visible(self)

Возвращает значение видимости.

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self)

Возвращает z-порядок объекта.

have_units(self)

Возвращает True, если на какой-либо оси установлены единицы измерения.

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback

remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self)

Возвращает словарь всех свойств объекта-художника.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs)

Устанавливает свойства по частям. Передайте kwargs для установки свойств.

set_aa(self, aa)

Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

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

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

set_animated(self, b)

Устанавливает состояние анимации объекта-художника.

Параметры:	bbool

set_antialiased(self, aa)

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

Параметры:	aabool or sequence of bools

set_antialiaseds(self, aa)

Псевдоним для set_antialiased.

set_array(self, A)

Устанавливает массив изображения из массива NumPy A.

Параметры:	Andarray

set_capstyle(self, cs)

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

Параметры:	cs{'butt', 'round', 'projecting'} Стиль закругления

set_clim(self, vmin=None, vmax=None)

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

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

set_clip_box(self, clipbox)

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

Параметры:	clipboxBbox

set_clip_on(self, b)

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

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

Параметры:	bbool

set_clip_path(self, path, transform=None)

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

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

Примечания

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

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

set_cmap(self, cmap)

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

Параметры:	cmapcolormap or registered colormap name

set_color(self, c)

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

Параметры:	ccolor or sequence of rgba tuples

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(self, picker)

Определить пользовательскую проверку нахождения внутри для объекта.

Предоставленная вызываемая функция заменяет метод contains объекта по умолчанию.

Параметры:

pickercallable Пользовательская функция выборки для оценки, находится ли событие внутри объекта. Функция должна иметь сигнатуру: def contains(artist: Artist, event: MouseEvent) -> bool, dict которая возвращает: булево значение, указывающее, находится ли событие внутри объекта словарь с дополнительной информацией. Словарь должен, по крайней мере, возвращать ту же информацию, что и реализация contains() по умолчанию для соответствующего объекта, но может содержать дополнительную информацию.

set_dashes(self, ls)

Псевдоним для set_linestyle.

set_ec(self, c)

Псевдоним для set_edgecolor.

set_edgecolor(self, c)

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

Параметры:	ccolor or sequence of colors or 'face' Цвет(ы) обводки коллекции. Если последовательность, фигуры циклически проходятся по ней. Если 'face', соответствует цвету заливки.

set_edgecolors(self, c)

Псевдоним для set_edgecolor.

set_facecolor(self, c)

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

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

Параметры:	ccolor or sequence of colors

set_facecolors(self, c)

Псевдоним для set_facecolor.

set_fc(self, c)

Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	figFigure

set_gid(self, gid)

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

Параметры:	gidstr

set_hatch(self, 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(self, in_layout)

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

Параметры:	in_layoutbool

set_joinstyle(self, js)

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

Параметры:	js{'miter', 'round', 'bevel'} Стиль соединения

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls)

Псевдоним для set_linestyle.

set_linewidth(self, lw)

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

Параметры:	lwfloat or sequence of floats

set_linewidths(self, lw)

Псевдоним для set_linewidth.

set_ls(self, ls)

Псевдоним для set_linestyle.

set_lw(self, lw)

Псевдоним для set_linewidth.

set_norm(self, norm)

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

Параметры:	normNormalize

Примечания

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

set_offset_position(self, offset_position)

Устанавливает способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования макета, то есть смещения в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования макета, то есть смещения в координатах данных.

Параметры:	offset_position{'screen', 'data'}

set_offsets(self, offsets)

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

Параметры:	offsetsarray-like (N, 2) or (2,)

set_path_effects(self, path_effects)

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

Параметры:	path_effectsAbstractPathEffect

set_paths(self)

set_picker(self, picker)

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

Параметры:

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

set_pickradius(self, pr)

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

Параметры:	dfloat Радиус выбора в пунктах.

set_rasterized(self, rasterized)

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

По умолчанию None, что подразумевает поведение бэкэнда по умолчанию.

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

set_sketch_params(self, scale=None, length=None, randomness=None)

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

Параметры:	scalefloat, optional Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None или не указана, фильтр наброска не будет предоставлен. lengthfloat, optional Длина колебания по линии в пикселях (по умолчанию 128.0) randomnessfloat, optional Коэффициент масштабирования, с которым длина уменьшается или увеличивается (по умолчанию 16.0)