matplotlib.collections

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

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

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

Bases: matplotlib.collections.RegularPolyCollection

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

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

Примеры

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

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

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

add_callback(func)

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

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

См. также

remove_callback

add_checker(checker)

[Устарело]

Замечания

Устарело начиная с версии 3.3:

autoscale()

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

autoscale_None()

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

свойство axes

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

changed()

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

check_update(checker)

[Устарело]

Замечания

Устарело начиная с версии 3.3:

contains(mouseevent)

Проверить, произошёл ли щелчок мыши в коллекции.

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

convert_xunits(x)

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

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

convert_yunits(y)

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

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

draw(renderer)

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

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

Параметры:	rendererRendererBase подкласс.

Замечания

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

findobj(match=None, include_self=True)

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

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

Параметры:

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

Возвращает:

список из Artist

format_cursor_data(data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_array()

Возвращает массив данных.

get_capstyle()

get_children()

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

get_clim()

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

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_cmap()

Возвращает экземпляр Colormap.

get_contains()

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

См. также

set_contains

Примечания

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

get_cursor_data(event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data

get_dashes()

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

get_datalim(transData)

get_ec()

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

get_edgecolor()

get_edgecolors()

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

get_facecolor()

get_facecolors()

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

get_fc()

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

get_figure()

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

get_fill()

Возвращает, закрашивается ли лицо.

get_gid()

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

get_hatch()

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

get_in_layout()

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

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

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

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

get_linewidth()

get_linewidths()

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

get_ls()

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

get_lw()

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

get_numsides()

get_offset_position()

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

Примечания

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

get_offset_transform()

get_offsets()

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

get_path_effects()

get_paths()

get_picker()

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

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

См. также

set_picker, pickable, pick

get_pickradius()

get_rasterized()

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

get_rotation()

get_sizes()

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

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

get_sketch_params()

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

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

get_snap()

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

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

get_tightbbox(renderer)

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

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

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms()

get_url()

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

get_urls()

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

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

get_visible()

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

get_window_extent(renderer)

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

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

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

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

get_zorder()

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

have_units()

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

is_transform_set()

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

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

свойствоmouseover

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

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

pchanged()

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

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

См. также

add_callback

remove_callback

pick(mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable()

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

См. также

set_picker, get_picker, pick

properties()

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

remove()

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

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

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

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

remove_callback(oid)

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

См. также

add_callback

set(**kwargs)

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

set_aa(aa)

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

set_agg_filter(filter_func)

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

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

set_alpha(alpha)

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

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

set_animated(b)

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

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

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

Параметры:	bbool

set_antialiased(aa)

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

Параметры:	aabool или список bool

set_antialiaseds(aa)

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

set_array(A)

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

Параметры:	Andarray или None

set_capstyle(cs)

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

Параметры:	csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

Установите область обрезки объекта-графического элемента Bbox.

Параметры:	clipboxBbox

set_clip_on(b)

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

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

Параметры:	bbool

set_clip_path(path, transform=None)

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

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

Примечания

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

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

set_cmap(cmap)

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

Параметры:	cmapColormap или str или None

set_color(c)

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

Параметры:	cцвет или список кортежей rgba

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Устарело] Определите пользовательское тестирование для включения элементов в графический элемент.

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

Параметры:

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

Примечания

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

set_dashes(ls)

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

set_ec(c)

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

set_edgecolor(c)

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

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

set_edgecolors(c)

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

set_facecolor(c)

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

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

Параметры:	cцвет или список цветов

set_facecolors(c)

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

set_fc(c)

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

set_figure(fig)

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

Параметры:	figFigure

set_gid(gid)

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

Параметры:	gidстрока

set_hatch(hatch)

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

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

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

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

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

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

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

set_in_layout(in_layout)

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

Параметры:	in_layoutbool

set_joinstyle(js)

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

Параметры:	jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)

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

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

set_linestyle(ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(ls)

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

set_linewidth(lw)

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

Параметры:	lwчисло с плавающей точкой или список чисел с плавающей точкой

set_linewidths(lw)

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

set_ls(ls)

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

set_lw(lw)

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

set_norm(norm)

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

Параметры:	normNormalize или None

Примечания

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

set_offset_position(offset_position)

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

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

Примечания

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

set_offsets(offsets)

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

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

set_path_effects(path_effects)

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

Параметры:	path_effectsAbstractPathEffect

set_paths()

set_picker(picker)

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

Параметры:

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

set_pickradius(pr)

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

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

set_rasterized(rasterized)

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

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

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

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

Параметры:	rasterizedbool

set_sizes(sizes, dpi=72.0)

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

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

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

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

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

set_snap(snap)

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

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

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

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

set_transform(t)

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

Параметры:	tTransform

set_url(url)

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

Параметры:	urlstr

set_urls(urls)

Параметры:	urlsсписок строк или None

Примечания

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

set_visible(b)

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

Параметры:	bbool

set_zorder(level)

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

Параметры:	levelfloat

свойство stale

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

свойство sticky_edges

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

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

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

Примеры

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

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

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

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

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

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

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

update(props)

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

Параметры:	propsсловарь

свойство update_dict

update_from(other)

Копирование свойств из other в self.

update_scalarmappable()

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

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

zorder = 0

класс matplotlib.collections.BrokenBarHCollection(xranges, yrange, **kwargs)[source]

Основы: matplotlib.collections.PolyCollection

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

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

add_callback(func)

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

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

См. также

remove_callback

add_checker(checker)

[Устарело]

Примечания

Устарело начиная с версии 3.3:

autoscale()

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

autoscale_None()

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

свойство axes

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

changed()

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

check_update(checker)

[Устарело]

Примечания

Устарело начиная с версии 3.3:

contains(mouseevent)

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

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

convert_xunits(x)

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

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

convert_yunits(y)

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

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

draw(renderer)

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

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

Параметры:	rendererподкласс RendererBase.

Примечания

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

findobj(match=None, include_self=True)

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

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

Параметры:

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

Возвращает:

список Artist

format_cursor_data(data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_array()

Возвращает массив данных.

get_capstyle()

get_children()

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

get_clim()

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

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_cmap()

Возвращает экземпляр Colormap.

get_contains()

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

См. также

set_contains

Примечания

Устаревшее начиная с версии 3.3.

get_cursor_data(event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data

get_dashes()

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

get_datalim(transData)

get_ec()

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

get_edgecolor()

get_edgecolors()

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

get_facecolor()

get_facecolors()

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

get_fc()

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

get_figure()

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

get_fill()

Возвращает, заливается ли фигура цветом.

get_gid()

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

get_hatch()

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

get_in_layout()

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

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

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

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

get_linewidth()

get_linewidths()

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

get_ls()

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

get_lw()

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

get_offset_position()

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

Примечания

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

get_offset_transform()

get_offsets()

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

get_path_effects()

get_paths()

get_picker()

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

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

См. также

set_picker, pickable, pick

get_pickradius()

get_rasterized()

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

get_sizes()

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

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

get_sketch_params()

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

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

get_snap()

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

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

get_tightbbox(renderer)

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

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

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms()

get_url()

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

get_urls()

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

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

get_visible()

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

get_window_extent(renderer)

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

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

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

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

get_zorder()

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

have_units()

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

is_transform_set()

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

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

свойство mouseover

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

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

pchanged()

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

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

См. также

add_callback

remove_callback

pick(mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable()

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

См. также

set_picker, get_picker, pick

properties()

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

remove()

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

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

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

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

remove_callback(oid)

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

См. также

add_callback

set(**kwargs)

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

set_aa(aa)

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

set_agg_filter(filter_func)

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

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

set_alpha(alpha)

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

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

set_animated(b)

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

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

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

Параметры:	bbool

set_antialiased(aa)

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

Параметры:	aabool или список bool

set_antialiaseds(aa)

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

set_array(A)

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

Параметры:	Andarray или None

set_capstyle(cs)

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

Параметры:	csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

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

Параметры:	clipboxBbox

set_clip_on(b)

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

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

Параметры:	bbool

set_clip_path(path, transform=None)

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

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

Примечания

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

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

set_cmap(cmap)

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

Параметры:	cmapColormap или str или None

set_color(c)

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

Параметры:	cцвет или список кортежей rgba

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

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

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

Параметры:

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

Примечания

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

set_dashes(ls)

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

set_ec(c)

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

set_edgecolor(c)

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

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

set_edgecolors(c)

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

set_facecolor(c)

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

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

Параметры:	cцвет или список цветов

set_facecolors(c)

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

set_fc(c)

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

set_figure(fig)

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

Параметры:	figFigure

set_gid(gid)

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

Параметры:	gidstr

set_hatch(hatch)

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

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

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

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

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

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

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

set_in_layout(in_layout)

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

Параметры:	in_layoutbool

set_joinstyle(js)

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

Параметры:	jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)

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

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

set_linestyle(ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(ls)

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

set_linewidth(lw)

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

Параметры:	lwfloat или список float

set_linewidths(lw)

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

set_ls(ls)

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

set_lw(lw)

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

set_norm(norm)

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

Параметры:	normNormalize или None

Примечания

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

set_offset_position(offset_position)

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

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

Примечания

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

set_offsets(offsets)

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

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

set_path_effects(path_effects)

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

Параметры:	path_effectsAbstractPathEffect

set_paths(verts, closed=True)

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

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

set_picker(picker)

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

Параметры:

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

set_pickradius(pr)

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

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

set_rasterized(rasterized)

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

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

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

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

Параметры:	rasterizedbool

set_sizes(sizes, dpi=72.0)

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

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

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

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

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

set_snap(snap)

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

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

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

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

set_transform(t)

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

Параметры:	tTransform

set_url(url)

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

Параметры:	urlstr

set_urls(urls)

Параметры:	urlsсписок str или None

Примечания

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

set_verts(verts, closed=True)

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

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

set_verts_and_codes(verts, codes)

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

set_visible(b)

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

Параметры:	bbool

set_zorder(level)

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

Параметры:	levelfloat

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

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

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(x, alpha=None, bytes=False, norm=True)

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

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

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

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

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

update(props)

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

Параметры:	propsdict

property update_dict

update_from(other)

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

update_scalarmappable()

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

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

zorder = 0

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

Bases: matplotlib.collections._CollectionWithSizes

A collection of circles, drawn using splines.

Parameters:	sizesfloat or array-like The area of each circle in points^2. **kwargs Forwarded to Collection.

add_callback(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:	int 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(checker)

[Deprecated]

Notes

Deprecated since version 3.3:

autoscale()

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

autoscale_None()

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()

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

check_update(checker)

[Deprecated]

Notes

Deprecated since version 3.3:

contains(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(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(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(renderer)

Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (Artist.get_visible returns False).

Parameters:	rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

findobj(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:

list of Artist

format_cursor_data(data)

Return a string representation of data.

Note

This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.

The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets.

See also

get_cursor_data

get_agg_filter()

Return filter function to be used for agg filter.

get_alpha()

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

get_animated()

Return whether the artist is animated.

get_array()

Return the data array.

get_capstyle()

get_children()

Return a list of the child Artists of this Artist.

get_clim()

Return the values (min, max) that are mapped to the colormap limits.

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_cmap()

Возвращает экземпляр Colormap.

get_contains()

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

См. также

set_contains

Примечания

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

get_cursor_data(event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data

get_dashes()

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

get_datalim(transData)

get_ec()

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

get_edgecolor()

get_edgecolors()

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

get_facecolor()

get_facecolors()

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

get_fc()

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

get_figure()

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

get_fill()

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

get_gid()

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

get_hatch()

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

get_in_layout()

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

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

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

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

get_linewidth()

get_linewidths()

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

get_ls()

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

get_lw()

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

get_offset_position()

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

Примечания

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

get_offset_transform()

get_offsets()

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

get_path_effects()

get_paths()

get_picker()

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

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

См. также

set_picker, pickable, pick

get_pickradius()

get_rasterized()

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

get_sizes()

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

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

get_sketch_params()

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

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

get_snap()

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

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

get_tightbbox(renderer)

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

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

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms()

get_url()

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

get_urls()

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

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

get_visible()

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

get_window_extent(renderer)

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

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

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

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

get_zorder()

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

have_units()

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

is_transform_set()

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

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

свойство mouseover

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

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

pchanged()

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

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

См. также

add_callback

remove_callback

pick(mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable()

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

См. также

set_picker, get_picker, pick

properties()

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

remove()

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

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

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

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

remove_callback(oid)

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

См. также

add_callback

set(**kwargs)

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

set_aa(aa)

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

set_agg_filter(filter_func)

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

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

set_alpha(alpha)

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

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

set_animated(b)

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

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

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

Параметры:	bbool

set_antialiased(aa)

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

Параметры:	aabool или список bool

set_antialiaseds(aa)

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

set_array(A)

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

Параметры:	Andarray или None

set_capstyle(cs)

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

Параметры:	csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

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

Параметры:	clipboxBbox

set_clip_on(b)

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

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

Параметры:	bbool

set_clip_path(path, transform=None)

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

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

Примечания

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

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

set_cmap(cmap)

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

Параметры:	cmapColormap или str или None

set_color(c)

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

Параметры:	cцвет или список кортежей rgba

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Устаревшее] Определение пользовательской проверки принадлежности для элемента.

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

Параметры:

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

Примечания

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

set_dashes(ls)

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

set_ec(c)

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

set_edgecolor(c)

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

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

set_edgecolors(c)

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

set_facecolor(c)

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

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

Параметры:	cцвет или список цветов

set_facecolors(c)

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

set_fc(c)

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

set_figure(fig)

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

Параметры:	figFigure

set_gid(gid)

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

Параметры:	gidstr

set_hatch(hatch)

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

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

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

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

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

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

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

set_in_layout(in_layout)

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

Параметры:	in_layoutbool

set_joinstyle(js)

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

Параметры:	jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)

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

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

set_linestyle(ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(ls)

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

set_linewidth(lw)

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

Параметры:	lwчисло или список чисел

set_linewidths(lw)

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

set_ls(ls)

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

set_lw(lw)

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

set_norm(norm)

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

Параметры:	normNormalize или None

Примечания

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

set_offset_position(offset_position)

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

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

Примечания

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

set_offsets(offsets)

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

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

set_path_effects(path_effects)

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

Параметры:	path_effectsAbstractPathEffect

set_paths()

set_picker(picker)

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

Параметры:

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

set_pickradius(pr)

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

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

set_rasterized(rasterized)

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

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

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

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

Параметры:	rasterizedbool

set_sizes(sizes, dpi=72.0)

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

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

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

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

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

set_snap(snap)

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

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

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

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

set_transform(t)

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

Параметры:	tTransform

set_url(url)

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

Параметры:	urlstr

set_urls(urls)

Параметры:	urlsсписок строк или None

Примечания

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

set_visible(b)

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

Параметры:	bbool

set_zorder(level)

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

Параметры:	levelfloat

свойство stale

Указывает, «застарел» ли элемент и требует ли он перерисовки для соответствия внутреннему состоянию.

свойство sticky_edges

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

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

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

Примеры

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

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

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

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

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

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

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

update(props)

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

Параметры:	propsdict

property update_dict

update_from(other)

Копирует свойства из other в себя.

update_scalarmappable()

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

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

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=<deprecated parameter>, zorder=1, **kwargs)[source]

Основания: matplotlib.artist.Artist, matplotlib.cm.ScalarMappable

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

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

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

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

prop[i % len(prop)]

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

Параметры:

edgecolorsцвет или список цветов, по умолчанию: rcParams["patch.edgecolor"] (по умолчанию: 'black') Цвет границы для каждого элемента, составляющего коллекцию. Специальное значение 'face' может быть передано, чтобы цвет границы соответствовал цвету заливки. facecolorsцвет или список цветов, по умолчанию: rcParams["patch.facecolor"] (по умолчанию: 'C0') Цвет заливки для каждого элемента, составляющего коллекцию. linewidthsчисло или список чисел, по умолчанию: rcParams["patch.linewidth"] (по умолчанию: 1.0) Ширина линии для каждого элемента, составляющего коллекцию. linestylesстрока или кортеж или список таковых, по умолчанию: 'solid' Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид: (offset, onoffseq), где onoffseq — кортеж чётной длины с длиной включения и выключения чернил в пунктах. Примеры см. в стилях линий. capstyleCapStyle-подобный, по умолчанию: rcParams["patch.capstyle"] Стиль обрезки линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}. joinstyleJoinStyle-подобный, по умолчанию: rcParams["patch.joinstyle"] Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}. antialiasedsbool или список bool, по умолчанию: rcParams["patch.antialiased"] (по умолчанию: True) Определяет, следует ли рисовать каждый элемент сглаживанием. offsets(float, float) или список таковых, по умолчанию: (0, 0) Вектор для перемещения каждого элемента после отрисовки (по умолчанию — без перемещения). Перемещение выполняется в экранных (пиксельных) координатах (т. е. после применения преобразования объекта-артиста). transOffsetTransform, по умолчанию: IdentityTransform Единственное преобразование, которое будет применено к каждому вектору offsets перед использованием. offset_position{{'screen' (по умолчанию), 'data' (устаревшее)}} Если установлено значение 'data' (устаревшее), offsets будет интерпретироваться как координаты данных, а не экранные координаты. normNormalize, необязательно Передаётся в ScalarMappable. По умолчанию None означает, что первый вызов отрисовки установит vmin и vmax используя минимальное и максимальное значения данных. cmapColormap, необязательно Передаётся в ScalarMappable. По умолчанию None приведет к использованию rcParams["image.cmap"] (по умолчанию: 'viridis') hatchстрока, необязательно Шаблон штриховки для заполненных путей, если таковой имеется. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Значение каждого типа штриховки см. в справочнике стилей штриховки. pickradiusчисло, по умолчанию: 5.0 Если pickradius <= 0, то Collection.contains вернёт True всякий раз, когда тестовая точка находится внутри одного из многоугольников, образованных контрольными точками Path в коллекции. С другой стороны, если оно больше 0, мы проверяем, находится ли тестовая точка внутри контура шириной 2*pickradius по любому из путей в коллекции. urlsсписок строк, по умолчанию: None URL для каждого элемента для создания ссылки при отрисовке. В настоящее время работает только с SVG-бэкендом. Примеры см. в гиперссылках. zorderчисло, по умолчанию: 1 Порядок отрисовки, общий для всех элементов в коллекции. Все значения по умолчанию и примеры см. в примере zorder.

add_callback(func)

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

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

См. также

remove_callback

add_checker(checker)

[Устарело]

Примечания

Устарело начиная с версии 3.3:

autoscale()

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

autoscale_None()

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

property axes

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

changed()

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

check_update(checker)

[Устаревшее]

Примечания

Устарело начиная с версии 3.3:

contains(mouseevent)[source]

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

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

convert_xunits(x)

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

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

convert_yunits(y)

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

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

draw(renderer)[source]

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

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

Параметры:	rendererПодкласс RendererBase.

Примечания

Этот метод переопределяется в подклассах элементов графических объектов.

findobj(match=None, include_self=True)

Найти объекты элементов графических объектов.

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

Параметры:

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

Возвращает:

Список Artist

format_cursor_data(data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_array()

Возвращает массив данных.

get_capstyle()[source]

get_children()

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

get_clim()

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

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_cmap()

Возвращает экземпляр Colormap.

get_contains()

[Устаревшее] Возвращает пользовательскую функцию contains, если она задана, или None.

См. также

set_contains

Примечания

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

get_cursor_data(event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data

get_dashes()

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

get_datalim(transData)[source]

get_ec()

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

get_edgecolor()[source]

get_edgecolors()

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

get_facecolor()[source]

get_facecolors()

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

get_fc()

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

get_figure()

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

get_fill()[source]

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

get_gid()

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

get_hatch()[source]

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

get_in_layout()

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

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

get_joinstyle()[source]

get_label()

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

get_linestyle()[source]

get_linestyles()

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

get_linewidth()[source]

get_linewidths()

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

get_ls()

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

get_lw()

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

get_offset_position()[source]

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

Примечания

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

get_offset_transform()[source]

get_offsets()[source]

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

get_path_effects()

get_paths()[source]

get_picker()

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

get_rasterized()

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

get_sketch_params()

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

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

get_snap()

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

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

get_tightbbox(renderer)

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

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

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms()[source]

get_url()

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

get_urls()[source]

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

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

get_visible()

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

get_window_extent(renderer)[source]

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

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

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

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

get_zorder()

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

have_units()

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

is_transform_set()

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

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

свойство mouseover

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

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

pchanged()

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

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

См. также

add_callback

remove_callback

pick(mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable()

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

См. также

set_picker, get_picker, pick

properties()

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

remove()

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

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

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

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

remove_callback(oid)

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

См. также

add_callback

set(**kwargs)

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

set_aa(aa)

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

set_agg_filter(filter_func)

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

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

set_alpha(alpha)[source]

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

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

set_animated(b)

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

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

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

Параметры:	bbool

set_antialiased(aa)[source]

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

Параметры:	aabool или список bool

set_antialiaseds(aa)

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

set_array(A)

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

Параметры:	Andarray или None

set_capstyle(cs)[source]

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

Параметры:	csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

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

Параметры:	clipboxBbox

set_clip_on(b)

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

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

Параметры:	bbool