matplotlib.collections

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

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

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

Базы: matplotlib.collections.RegularPolyCollection

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

numsides

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

rotation

угол поворота многоугольника в радианах

sizes

указывает площадь окружности, описанной вокруг правильного многоугольника, в пунктах^2

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

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

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

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

Пример: см. Пример Lasso для полного примера:

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

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

add_callback(self, func)

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

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

См. также

remove_callback

add_checker(self, checker)

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

aname

autoscale(self)

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

autoscale_None(self)

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

axes

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

changed(self)

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

check_update(self, checker)

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

contains(self, mouseevent)

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer)

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

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

Параметры:	renderer : RendererBase subclass.

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

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

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

Параметры:

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

Возвращает:

artists : list of Artist

format_cursor_data(self, data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter(self)

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

get_alpha(self)

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

get_animated(self)

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

get_array(self)

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

get_capstyle(self)

get_children(self)

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

get_clim(self)

возвращает min, max пределов цвета для масштабирования изображения

get_clip_box(self)

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

get_clip_on(self)

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

get_clip_path(self)

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

get_cmap(self)

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

get_contains(self)

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

См. также

set_contains

get_cursor_data(self, event)

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

Примечание

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

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

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

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

Параметры:	event : matplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

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

get_datalim(self, transData)

get_ec(self)

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

get_edgecolor(self)

get_edgecolors(self)

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

get_facecolor(self)

get_facecolors(self)

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

get_fc(self)

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

get_figure(self)

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

get_fill(self)

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

get_gid(self)

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

get_hatch(self)

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

get_in_layout(self)

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

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

get_joinstyle(self)

get_label(self)

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

get_linestyle(self)

get_linestyles(self)

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

get_linewidth(self)

get_linewidths(self)

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

get_ls(self)

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

get_lw(self)

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

get_numsides(self)

get_offset_position(self)

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

get_offset_transform(self)

get_offsets(self)

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

get_path_effects(self)

get_paths(self)

get_picker(self)

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

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

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self)

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

get_rotation(self)

get_sizes(self)

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

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

get_sketch_params(self)

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

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

get_snap(self)

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

Для получения подробной информации см. set_snap.

get_tightbbox(self, renderer)

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

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

get_transform(self)

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

get_transformed_clip_path_and_affine(self)

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

get_transforms(self)

get_url(self)

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

get_urls(self)

get_visible(self)

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

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self)

Возвращает z-порядок художника.

have_units(self)

Возвращает True, если единицы установлены на осях x или y.

is_transform_set(self)

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

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

mouseover

pchanged(self)

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

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

См. также

add_callback

remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self)

Возвращает словарь всех свойств художника.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs)

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

set_aa(self, aa)

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

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

Установите прозрачность альфа-калекции.

Параметры:	alpha : float or None

set_animated(self, b)

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

Параметры:	b : bool

set_antialiased(self, aa)

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

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

set_antialiaseds(self, aa)

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

set_array(self, A)

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

Параметры:	A : ndarray

set_capstyle(self, cs)

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

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

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

установите пределы нормализации для масштабирования изображения; если vmin является последовательностью длиной 2, интерпретируйте её как (vmin, vmax), которая используется для поддержки setp

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей точкой; может быть переопределён в методах, которые имеют vmin и vmax kwargs.

set_clip_box(self, clipbox)

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

Параметры:	clipbox : Bbox

set_clip_on(self, b)

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

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

Параметры:	b : bool

set_clip_path(self, path, transform=None)

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

• экземпляр Patch (или подкласс); или
• экземпляр Path, в этом случае экземпляр Transform, который будет применён к пути перед использованием его для обрезки, должен быть предоставлен; или
• None, чтобы удалить ранее установленный путь обрезки.

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

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(self, cmap)

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

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

set_color(self, c)

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

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

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(self, picker)

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

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

Параметры:

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

set_dashes(self, ls)

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

set_ec(self, c)

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

set_edgecolor(self, c)

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

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

set_edgecolors(self, c)

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

set_facecolor(self, c)

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

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

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

set_facecolors(self, c)

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

set_fc(self, c)

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

set_figure(self, fig)

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

Параметры:	fig : Figure

set_gid(self, gid)

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

Параметры:	gid : str

set_hatch(self, hatch)

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

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

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

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

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

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

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

set_in_layout(self, in_layout)

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

Параметры:	in_layout : bool

set_joinstyle(self, js)

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

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

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls)

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

set_linewidth(self, lw)

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

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

set_linewidths(self, lw)

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

set_ls(self, ls)

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

set_lw(self, lw)

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

set_norm(self, norm)

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

Параметры:	norm : Normalize

Примечания

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

set_offset_position(self, offset_position)

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

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

set_offsets(self, offsets)

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

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

set_path_effects(self, path_effects)

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

Параметры:	path_effects : AbstractPathEffect

set_paths(self)

set_picker(self, picker)

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

Параметры:

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

set_pickradius(self, pr)

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

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

set_rasterized(self, rasterized)

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

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

Параметры:	rasterized : bool or None

set_sizes(self, sizes, dpi=72.0)

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

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

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

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

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

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	t : Transform

set_url(self, url)

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

Параметры:	url : str

set_urls(self, urls)

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

set_visible(self, b)

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

Параметры:	b : bool

set_zorder(self, level)

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

Параметры:	level : float

stale

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

sticky_edges

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

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

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

Примеры

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

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

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

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

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

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

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

update(self, props)

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

update_from(self, other)

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

update_scalarmappable(self)

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

zorder = 0

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

Основания: matplotlib.collections.PolyCollection

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

xranges

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

yrange

ymin, ywidth

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

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

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

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

add_callback(self, func)

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

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

См. также

remove_callback

add_checker(self, checker)

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

aname

autoscale(self)

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

autoscale_None(self)

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

axes

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

changed(self)

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

check_update(self, checker)

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

contains(self, mouseevent)

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer)

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

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

Параметры:	renderer : RendererBase subclass.

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

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

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

Параметры:

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

Возвращает:

artists : list of Artist

format_cursor_data(self, data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter(self)

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

get_alpha(self)

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

get_animated(self)

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

get_array(self)

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

get_capstyle(self)

get_children(self)

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

get_clim(self)

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

get_clip_box(self)

Возвращает ограничивающую рамку.

get_clip_on(self)

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

get_clip_path(self)

Возвращает обрезной путь.

get_cmap(self)

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

get_contains(self)

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

См. также

set_contains

get_cursor_data(self, event)

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

Примечание

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

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

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

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

Параметры:	event : matplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

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

get_datalim(self, transData)

get_ec(self)

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

get_edgecolor(self)

get_edgecolors(self)

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

get_facecolor(self)

get_facecolors(self)

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

get_fc(self)

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

get_figure(self)

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

get_fill(self)

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

get_gid(self)

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

get_hatch(self)

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

get_in_layout(self)

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

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

get_joinstyle(self)

get_label(self)

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

get_linestyle(self)

get_linestyles(self)

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

get_linewidth(self)

get_linewidths(self)

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

get_ls(self)

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

get_lw(self)

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

get_offset_position(self)

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

get_offset_transform(self)

get_offsets(self)

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

get_path_effects(self)

get_paths(self)

get_picker(self)

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

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

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self)

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

get_sizes(self)

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

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

get_sketch_params(self)

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

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

get_transform(self)

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

get_transformed_clip_path_and_affine(self)

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

get_transforms(self)

get_url(self)

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

get_urls(self)

get_visible(self)

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

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self)

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

have_units(self)

Возвращает True, если единицы измерения заданы на осях x или y.

is_transform_set(self)

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

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

mouseover

pchanged(self)

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

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

См. также

add_callback

remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self)

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

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs)

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

set_aa(self, aa)

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

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

Устанавливает альфа-прозрачность коллекции.

Параметры:	alpha : float or None

set_animated(self, b)

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

Параметры:	b : bool

set_antialiased(self, aa)

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

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

set_antialiaseds(self, aa)

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

set_array(self, A)

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

Параметры:	A : ndarray

set_capstyle(self, cs)

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

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

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

Устанавливает пределы нормализации для масштабирования изображения; если vmin является последовательностью длины 2, интерпретируйте её как (vmin, vmax), что используется для поддержки setp

ПРИНИМАЕТ: последовательность длины 2 из чисел с плавающей точкой; может быть переопределён в методах, имеющих vmin и vmax аргументы.

set_clip_box(self, clipbox)

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

Bbox.

Параметры:	clipbox : Bbox

set_clip_on(self, b)

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

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

Параметры:	b : bool

set_clip_path(self, path, transform=None)

Установить область обрезки элемента, которая может быть:

• экземпляр Patch (или подкласс); или
• экземпляр Path, в этом случае необходим экземпляр Transform, который будет применён к пути перед использованием его для обрезки; или
• None, чтобы удалить ранее установленную область обрезки.

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

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(self, cmap)

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

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

set_color(self, c)

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

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

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(self, picker)

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

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

Параметры:

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

set_dashes(self, ls)

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

set_ec(self, c)

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

set_edgecolor(self, c)

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

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

set_edgecolors(self, c)

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

set_facecolor(self, c)

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

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

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

set_facecolors(self, c)

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

set_fc(self, c)

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

set_figure(self, fig)

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

Параметры:	fig : Figure

set_gid(self, gid)

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

Параметры:	gid : str

set_hatch(self, hatch)

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

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

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

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

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

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

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

set_in_layout(self, in_layout)

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

Параметры:	in_layout : bool

set_joinstyle(self, js)

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

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

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls)

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

set_linewidth(self, lw)

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

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

set_linewidths(self, lw)

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

set_ls(self, ls)

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

set_lw(self, lw)

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

set_norm(self, norm)

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

Параметры:	norm : Normalize

Примечания

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

set_offset_position(self, offset_position)

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

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

set_offsets(self, offsets)

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

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

set_path_effects(self, path_effects)

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

Параметры:	path_effects : AbstractPathEffect

set_paths(self, verts, closed=True)

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

set_picker(self, picker)

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

Параметры:

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

set_pickradius(self, pr)

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

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

set_rasterized(self, rasterized)

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

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

Параметры:	rasterized : bool or None

set_sizes(self, sizes, dpi=72.0)

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

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

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

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

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

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	t : Transform

set_url(self, url)

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

Параметры:	url : str

set_urls(self, urls)

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

set_verts(self, verts, closed=True)

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

set_verts_and_codes(self, verts, codes)

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

set_visible(self, b)

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

Параметры:	b : bool

set_zorder(self, level)

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

Параметры:	level : float

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

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

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

stale

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

sticky_edges

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

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

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

Примеры

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

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

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

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

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

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

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

update(self, props)

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

update_from(self, other)

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

update_scalarmappable(self)

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

zorder = 0

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

Bases: matplotlib.collections._CollectionWithSizes

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

sizes Указывает площадь круга в пунктах^2

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

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

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

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

add_callback(self, func)

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

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

См. также

remove_callback

add_checker(self, checker)

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

aname

autoscale(self)

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

autoscale_None(self)

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

axes

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

changed(self)

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

check_update(self, checker)

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

contains(self, mouseevent)

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer)

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

Этот метод переопределяется в подклассах элементов. Как правило, он не имеет эффекта, если элемент не видим (Artist.get_visible равен False).

Параметры:	renderer : RendererBase subclass.

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

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

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

Параметры:

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

Возвращает:

artists : list of Artist

format_cursor_data(self, data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter(self)

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

get_alpha(self)

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

get_animated(self)

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

get_array(self)

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

get_capstyle(self)

get_children(self)

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

get_clim(self)

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

get_clip_box(self)

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

get_clip_on(self)

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

get_clip_path(self)

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

get_cmap(self)

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

get_contains(self)

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

См. также

set_contains

get_cursor_data(self, event)

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

Примечание

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

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

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

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

Параметры:	event : matplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

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

get_datalim(self, transData)

get_ec(self)

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

get_edgecolor(self)

get_edgecolors(self)

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

get_facecolor(self)

get_facecolors(self)

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

get_fc(self)

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

get_figure(self)

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

get_fill(self)

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

get_gid(self)

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

get_hatch(self)

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

get_in_layout(self)

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

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

get_joinstyle(self)

get_label(self)

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

get_linestyle(self)

get_linestyles(self)

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

get_linewidth(self)

get_linewidths(self)

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

get_ls(self)

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

get_lw(self)

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

get_offset_position(self)

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

get_offset_transform(self)

get_offsets(self)

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

get_path_effects(self)

get_paths(self)

get_picker(self)

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

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

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self)

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

get_sizes(self)

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

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

get_sketch_params(self)

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

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

get_snap(self)

Возвращает установку 'snap'.

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

get_tightbbox(self, renderer)

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

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

get_transform(self)

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

get_transformed_clip_path_and_affine(self)

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

get_transforms(self)

get_url(self)

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

get_urls(self)

get_visible(self)

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

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self)

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

have_units(self)

Возвращает True, если единицы установлены на осях x или y.

is_transform_set(self)

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

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

mouseover

pchanged(self)

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

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

См. также

add_callback

remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self)

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

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs)

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

set_aa(self, aa)

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

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

Установить альфа-прозрачность коллекции.

Параметры:	alpha : float or None

set_animated(self, b)

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

Параметры:	b : bool

set_antialiased(self, aa)

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

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

set_antialiaseds(self, aa)

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

set_array(self, A)

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

Параметры:	A : ndarray

set_capstyle(self, cs)

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

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

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

устанавливает пределы нормы для масштабирования изображения; если vmin является последовательностью длиной 2, интерпретирует её как (vmin, vmax), что используется для поддержки setp

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей точкой; может быть переопределено в методах, имеющих vmin и vmax kwargs.

set_clip_box(self, clipbox)

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

Bbox

Параметры:	clipbox : Bbox

set_clip_on(self, b)

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

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

Параметры:	b : bool

set_clip_path(self, path, transform=None)

Установить область обрезки элемента, которая может быть:

• экземпляр Patch (или подкласс); или
• экземпляр Path, в этом случае экземпляр Transform, который будет применён к пути перед использованием его для обрезки, должен быть предоставлен; или
• None, чтобы удалить ранее установленную область обрезки.

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

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(self, cmap)

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

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

set_color(self, c)

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

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

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(self, picker)

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

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

Параметры:

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

set_dashes(self, ls)

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

set_ec(self, c)

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

set_edgecolor(self, c)

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

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

set_edgecolors(self, c)

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

set_facecolor(self, c)

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

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

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

set_facecolors(self, c)

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

set_fc(self, c)

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

set_figure(self, fig)

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

Параметры:	fig : Figure

set_gid(self, gid)

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

Параметры:	gid : str

set_hatch(self, hatch)

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

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

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

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

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

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

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

set_in_layout(self, in_layout)

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

Параметры:	in_layout : bool

set_joinstyle(self, js)

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

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

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls)

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

set_linewidth(self, lw)

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

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

set_linewidths(self, lw)

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

set_ls(self, ls)

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

set_lw(self, lw)

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

set_norm(self, norm)

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

Параметры:	norm : Normalize

Примечания

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

set_offset_position(self, offset_position)

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

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

set_offsets(self, offsets)

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

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

set_path_effects(self, path_effects)

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

Параметры:	path_effects : AbstractPathEffect

set_paths(self)

set_picker(self, picker)

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

Параметры:

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

set_pickradius(self, pr)

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

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

set_rasterized(self, rasterized)

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

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

Параметры:	rasterized : bool or None

set_sizes(self, sizes, dpi=72.0)

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

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

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

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

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

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	t : Transform

set_url(self, url)

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

Параметры:	url : str

set_urls(self, urls)

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

set_visible(self, b)

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

Параметры:	b : bool

set_zorder(self, level)

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

Параметры:	level : float

stale

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

sticky_edges

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

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

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

Примеры

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

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

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

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

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

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

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

update(self, props)

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

update_from(self, other)

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

update_scalarmappable(self)

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

zorder = 0

class matplotlib.collections.Collection(edgecolors=None, facecolors=None, linewidths=None, linestyles='solid', capstyle=None, joinstyle=None, antialiaseds=None, offsets=None, transOffset=None, norm=None, cmap=None, pickradius=5.0, hatch=None, urls=None, offset_position='screen', zorder=1, **kwargs) [source]

Основы: matplotlib.artist.Artist, matplotlib.cm.ScalarMappable

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

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

prop[i % len(props)]

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

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

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

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

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

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

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

%(Collection)s

add_callback(self, func)

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

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

См. также

remove_callback

add_checker(self, checker)

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

aname

autoscale(self)

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

autoscale_None(self)

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

axes

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

changed(self)

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

check_update(self, checker)

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

contains(self, mouseevent) [source]

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer) [source]

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

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

Параметры:	renderer : RendererBase subclass.

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

Поиск объектов Artist.

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

Параметры:

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

Возвращает:

artists : list of Artist

format_cursor_data(self, data)

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter(self)

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

get_alpha(self)

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

get_animated(self)

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

get_array(self)

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

get_capstyle(self) [source]

get_children(self)

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

get_clim(self)

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

get_clip_box(self)

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

get_clip_on(self)

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

get_clip_path(self)

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

get_cmap(self)

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

get_contains(self)

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

См. также

set_contains

get_cursor_data(self, event)

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

Примечание

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

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

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

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

Параметры:	event : matplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

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

get_datalim(self, transData) [source]

get_ec(self)

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

get_edgecolor(self) [source]

get_edgecolors(self)

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

get_facecolor(self) [source]

get_facecolors(self)

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

get_fc(self)

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

get_figure(self)

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

get_fill(self) [source]

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

get_gid(self)

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

get_hatch(self) [source]

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

get_in_layout(self)

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

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

get_joinstyle(self) [source]

get_label(self)

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

get_linestyle(self) [source]

get_linestyles(self)

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

get_linewidth(self) [source]

get_linewidths(self)

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

get_ls(self)

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

get_lw(self)

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

get_offset_position(self) [source]

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

get_offset_transform(self) [source]

get_offsets(self) [source]

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

get_path_effects(self)

get_paths(self) [source]

get_picker(self)

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

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

См. также

set_picker, pickable, pick

get_pickradius(self) [source]

get_rasterized(self)

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

get_sketch_params(self)

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

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

get_transform(self)

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

get_transformed_clip_path_and_affine(self)

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

get_transforms(self) [source]

get_url(self)

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

get_urls(self) [source]

get_visible(self)

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

get_window_extent(self, renderer) [source]

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

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

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

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

get_zorder(self)

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

have_units(self)

Возвращает True, если на осях x или y заданы единицы.

is_transform_set(self)

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

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

mouseover

pchanged(self)

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

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

См. также

add_callback

remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self)

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

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs)

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

set_aa(self, aa)

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

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha) [source]

Устанавливает альфа-прозрачность коллекции.

Параметры:	alpha : float or None

set_animated(self, b)

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

Параметры:	b : bool

set_antialiased(self, aa) [source]

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

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

set_antialiaseds(self, aa)

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

set_array(self, A)

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

Параметры:	A : ndarray

set_capstyle(self, cs) [source]

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

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

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

установите пределы нормы для масштабирования изображения; если vmin является последовательностью длины 2, интерпретируйте ее как (vmin, vmax), которая используется для поддержки setp

ПРИНИМАЕТ: последовательность длины 2 из чисел с плавающей точкой; может быть переопределено в методах, которые имеют vmin и vmax аргументы.

set_clip_box(self, clipbox)

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

Параметры:	clipbox : Bbox

set_clip_on(self, b)

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

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

Параметры:	b : bool

set_clip_path(self, path, transform=None)

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

• объект Patch (или подкласс); или
• объект Path, в этом случае объект Transform, который будет применен к пути перед использованием его для обрезки, должен быть предоставлен; или
• None, чтобы удалить ранее установленную область обрезки.

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

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(self, cmap)

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

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

set_color(self, c) [source]

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

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

См. также

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(self, picker)

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

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

Параметры:

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

set_dashes(self, ls)

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

set_ec(self, c)

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

set_edgecolor(self, c) [source]

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

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

set_edgecolors(self, c)

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

set_facecolor(self, c) [source]

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

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

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

set_facecolors(self, c)

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

set_fc(self, c)

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

set_figure(self, fig)

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

Параметры:	fig : Figure

set_gid(self, gid)

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

Параметры:	gid : str

set_hatch(self, hatch) [source]

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

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

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

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

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

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

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

set_in_layout(self, in_layout)

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

Параметры:	in_layout : bool

set_joinstyle(self, js) [source]

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

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

set_label(self, s)

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

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

set_linestyle(self, ls) [source]

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls)

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

set_linewidth(self, lw) [source]

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

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

set_linewidths(self, lw)

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

set_ls(self, ls)

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

set_lw(self, lw)

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

set_norm(self, norm)

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

Параметры:	norm : Normalize

Примечания

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

set_offset_position(self, offset_position) [source]

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

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

set_offsets(self, offsets) [source]

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

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

set_path_effects(self, path_effects)

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

Параметры:	path_effects : AbstractPathEffect

set_paths(self) [source]

set_picker(self, picker)

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

Параметры:

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

set_pickradius(self, pr) [source]

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

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

set_rasterized(self, rasterized)

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

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

Параметры:	rasterized : bool or None

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

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

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

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	t : Transform

set_url(self, url)

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

Параметры:	url : str

set_urls(self, urls) [source]

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

set_visible(self, b)

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

Параметры:	b : bool

set_zorder(self, level)

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

Параметры:	level : float

stale

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

sticky_edges

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

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

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

Примеры

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

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

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

В обычном случае x — это последовательность скаляров 1D или 2D, и соответствующий массив 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(self, props)

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

update_from(self, other) [source]

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

update_scalarmappable(self) [source]

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

zorder = 0

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

Bases: matplotlib.collections.Collection

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

Параметры:

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

Другие параметры:

**kwargs Дополнительные параметры, унаследованные от базового класса Collection. Допустимые ключевые слова для коллекции: edgecolors: None facecolors: None linewidths: None antialiaseds: None offsets: None transOffset: transforms.IdentityTransform() norm: None (необязательно для matplotlib.cm.ScalarMappable) cmap: None (необязательно для matplotlib.cm.ScalarMappable) offsets и transOffset используются для перемещения фигуры после отрисовки (по умолчанию без смещений) Если любое из edgecolors, facecolors, linewidths, antialiaseds равно None, они по умолчанию принимают значения из matplotlib.rcParams для фигур, в порядке перечисления.

add_callback(self, func)

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

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

См. также

remove_callback

add_checker(self, checker)

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

aname

autoscale(self)

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

autoscale_None(self)

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

axes

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

changed(self)

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

check_update(self, checker)

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

contains(self, mouseevent)

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

Если элемент не входит в Axes или у оси y нет единиц измерения, возвращается y.

draw(self, renderer) [source]

Отрисовка элемента с использованием заданного рендерера.

Этот метод будет переопределен в подклассах элементов. Обычно он реализуется так, что не имеет никакого эффекта, если элемент не виден (Artist.get_visible равно False).

Параметры:	renderer : RendererBase subclass.

findobj(self, match=None, include_self=True)

Найти объекты элементов.

Рекурсивно найти все Artist экземпляры, содержащиеся в элементе.

Параметры:

match Критерий фильтра для совпадений. Это может быть None: вернуть все объекты, содержащиеся в элементе. Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True. Экземпляр класса, например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (проверка isinstance). include_self : bool Включать self в список проверяемых элементов для совпадения.

Возвращает:

artists : list of Artist

format_cursor_data(self, data)

Возвращает строковое представление данных.

Примечание

Этот метод предназначен для переопределения в подклассах элементов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые числа и числа с плавающей запятой, а также массивы целых чисел и чисел с плавающей запятой в строку, разделенную запятыми, заключенную в квадратные скобки.

См. также

get_cursor_data

get_agg_filter(self)

Возвращает функцию фильтра, используемую для фильтра agg.

get_alpha(self)

Возвращает значение альфа, используемое для смешивания — не поддерживается на всех бэкендах.

get_animated(self)

Возвращает состояние анимации.

get_array(self)

Возвращает массив.

get_capstyle(self)

get_children(self)

Возвращает список дочерних элементов Artist этого Artist.

get_clim(self)

возвращает минимальное и максимальное значения пределов цвета для масштабирования изображения

get_clip_box(self)

Возвращает область обрезки.

get_clip_on(self)

Возвращает, использует ли художник обрезку.

get_clip_path(self)

Возвращает путь обрезки.

get_cmap(self)

возвращает карту цветов

get_contains(self)

Возвращает пользовательскую функцию contains объекта, если она задана, или None.

См. также

set_contains

get_cursor_data(self, event)

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами художников. Вероятно, вы, как конечный пользователь Matplotlib, не будете вызывать этот метод самостоятельно.

Данные курсора могут использоваться художниками для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация просто возвращает None.

Подклассы могут переопределять метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что format_cursor_data может преобразовать данные в строковое представление.

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика при перемещении указателя мыши.

Параметры:	event : matplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_dashes(self)

Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self)

Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self)

Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self)

Псевдоним для get_facecolor.

get_fc(self)

Псевдоним для get_facecolor.

get_figure(self)

Возвращает экземпляр Figure, к которому принадлежит художник.

get_fill(self)

возвращает, установлен ли fill

get_gid(self)

Возвращает идентификатор группы.

get_hatch(self)

Возвращает текущий узор штриховки.

get_in_layout(self)

Возвращает логическое значение, True если художник включен в вычисления макета.

Например, Руководство по макетам с ограничением, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self)

Возвращает метку, используемую для этого художника в легенде.

get_linestyle(self)

get_linestyles(self)

Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self)

Псевдоним для get_linewidth.

get_ls(self)

Псевдоним для get_linestyle.

get_lw(self)

Псевдоним для get_linewidth.

get_offset_position(self)

Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования master, то есть смещения в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования master, т.е. смещения в координатах данных.

get_offset_transform(self)

get_offsets(self)

Возвращает смещения для коллекции.

get_path_effects(self)

get_paths(self)

get_picker(self)

Возвращает поведение выделения объекта.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self)

Возвращает, должен ли художник быть растрированным.

get_sketch_params(self)

Возвращает параметры наброска для объекта.

Возвращает:	sketch_params : tuple or None Кортеж из 3 элементов: scale: Амплитуда колебаний перпендикулярно исходной линии. length: Длина колебаний вдоль линии. randomness: Коэффициент масштабирования, с помощью которого длина сжимается или расширяется. Возвращает None, если параметры наброска не были заданы.

get_snap(self)

Возвращает значение параметра привязки.

Подробности см. в set_snap.

get_tightbbox(self, renderer)

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:	renderer : RendererBase instance интерпретатор, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())
Возвращает:	bbox : BBox Охватывающая область (в пиксельных координатах рисунка).

get_transform(self)

Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine(self)

Возвращает обрезку с применённой к её трансформации неаффинной частью и оставшейся аффинной частью её трансформации.

get_transforms(self)

get_url(self)

Возвращает URL.

get_urls(self)

get_visible(self)

Возвращает видимость.

get_window_extent(self, renderer)

Получает область осей в пространстве отображения.

Ширина и высота области осей неотрицательны.

Подклассы должны переопределять для включения в вычисление области "прижатия". По умолчанию возвращает пустую область в (0, 0).

Будьте осторожны при использовании этой функции, результаты не будут обновляться, если область окна объекта изменится. Область может измениться из-за любых изменений в стеке преобразования, таких как изменение пределов осей, размера рисунка или используемой холщовой области (как это делается при сохранении рисунка). Это может привести к неожиданному поведению, где интерактивные рисунки будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder(self)

Возвращает z-порядок объекта.

have_units(self)

Возвращает True, если единицы установлены по осям x или y.

is_transform_set(self)

Возвращает, имеет ли объект явно установленное преобразование.

Это True после вызова set_transform.

mouseover

pchanged(self)

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback

remove_callback

pick(self, mouseevent)

Обрабатывает событие выбора.

Каждый дочерний объект вызовет событие выбора, если mouseevent находится над объектом, и для объекта установлен параметр выбора.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, можно ли выбрать объект.

См. также

set_picker, get_picker, pick

properties(self)

Возвращает словарь всех свойств объекта.

remove(self)

Удаляет объект с рисунка, если это возможно.

Эффект не будет виден, пока рисунок не будет перерисован, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта.

remove_callback(self, oid)

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

set(self, **kwargs)

Установщик свойств в пакетном режиме. Передайте kwargs для установки свойств.

set_aa(self, aa)

Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Устанавливает фильтр agg.

Параметры:	filter_func : callable Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3).

set_alpha(self, alpha)

Устанавливает альфа-прозрачность коллекции.

Параметры:	alpha : float or None

set_animated(self, b)

Устанавливает состояние анимации объекта.

Параметры:	b : bool

set_antialiased(self, aa)

Устанавливает состояние антиалиасинга для рендеринга.

Параметры:	aa : bool or sequence of bools

set_antialiaseds(self, aa)

Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображений из массива numpy A.

Параметры:	A : ndarray

set_capstyle(self, cs)

Установить стиль обрезки для коллекции (для всех её элементов).

Параметры:	cs : {'butt', 'round', 'projecting'} Стиль обрезки

set_clim(self, vmin=None, vmax=None)

Установить пределы нормы для масштабирования изображения; если vmin является последовательностью длиной 2, интерпретировать её как (vmin, vmax), которая используется для поддержки setp

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей точкой; может быть переопределён в методах, имеющих vmin и vmax параметры.

set_clip_box(self, clipbox)

Установить область обрезки для элемента Bbox.

Параметры:	clipbox : Bbox

set_clip_on(self, b)

Установить, использует ли элемент обрезку.

Когда False, элементы будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:	b : bool

set_clip_path(self, path, transform=None)

Установить путь обрезки элемента, который может быть:

• экземпляр класса Patch (или подкласс); или
• экземпляр класса Path, в этом случае экземпляр класса Transform, который будет применяться к пути перед его использованием для обрезки, должен быть предоставлен; или
• None, чтобы удалить ранее заданный путь обрезки.

Для повышения эффективности, если путь оказывается прямоугольником, выровненным по осям, этот метод установит соответствующую область обрезки и установит путь обрезки на None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(self, cmap)

установить цветовую карту для данных яркости

Параметры:	cmap : colormap or registered colormap name

set_color(self, c)

Установить цвет контура и заливки.

Параметры:	c : color or sequence of rgba tuples

См. также

Collection.set_facecolor, Collection.set_edgecolor

Для установки цвета контура или заливки индивидуально.

set_contains(self, picker)

Определить пользовательскую проверку включения для элемента.

Предоставленная вызываемая функция заменяет метод contains по умолчанию для элемента.

Параметры:

picker : callable Пользовательская функция выбора для оценки, находится ли событие внутри элемента. Функция должна иметь следующий сигнатуру: def contains(artist: Artist, event: MouseEvent) -> bool, dict которая возвращает: булево значение, указывающее, находится ли событие внутри элемента словарь дополнительной информации. Словарь должен по крайней мере возвращать ту же информацию, что и реализация по умолчанию contains() для соответствующего элемента, но может предоставлять дополнительную информацию.

set_dashes(self, ls)

Псевдоним для set_linestyle.

set_ec(self, c)

Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Установить цвет контура(ов) коллекции.

Параметры:	c : color or sequence of colors or 'face' Цвет контура(ов) коллекции. Если последовательность, фигуры будут циклически проходить по ней. Если 'face', соответствовать цвету заливки.

set_edgecolors(self, c)

Псевдоним для set_edgecolor.

set_facecolor(self, c)

Установить цвет заливки(ей) коллекции. c может быть спецификацией цвета matplotlib (все фигуры имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, фигуры будут циклически проходить по последовательности.

Если c равно 'none', фигура не будет заполнена.

Параметры:	c : color or sequence of colors

set_facecolors(self, c)

Псевдоним для set_facecolor.

set_fc(self, c)

Псевдоним для set_facecolor.

set_figure(self, fig)

Установить экземпляр Figure, к которому принадлежит элемент.

Параметры:	fig : Figure

set_gid(self, gid)

Установить идентификатор (группы) элемента.

Параметры:	gid : str

set_hatch(self, hatch)

Установить узор штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы можно комбинировать, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки данного узора.

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всей коллекции, а не для каждого члена по отдельности.

Параметры:	hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(self, in_layout)

Указать, будет ли элемент учитываться в расчётах макета, например, в Руководстве по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:	in_layout : bool

set_joinstyle(self, js)

Установить стиль соединения для коллекции (для всех её элементов).

Параметры:	js : {'miter', 'round', 'bevel'} Стиль соединения

set_label(self, s)

Установить метку, которая будет отображаться в легенде.

Параметры:	s : object s будет преобразовано в строку с помощью вызова str.

set_linestyle(self, ls)

Установить стиль(и) линии для коллекции.

linestyle	описание
'-' or 'solid'	сплошная линия
'--' or 'dashed'	штриховая линия
'-.' or 'dashdot'	штрихпунктирная линия
':' or 'dotted'	пунктирная линия

В качестве альтернативы можно указать кортеж с данными в формате:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий значения длины вкл. и выкл. чернил в пунктах.

Параметры:	ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...} Стиль линии.

set_linestyles(self, ls)

Псевдоним для set_linestyle.

set_linewidth(self, lw)

Установить ширину(ы) линии для коллекции. lw может быть скалярным значением или последовательностью; если это последовательность, фигуры будут циклически использовать значения из последовательности.

Параметры:	lw : float or sequence of floats

set_linewidths(self, lw)

Псевдоним для set_linewidth.

set_ls(self, ls)

Псевдоним для set_linestyle.

set_lw(self, lw)

Псевдоним для set_linewidth.

set_norm(self, norm)

Установить экземпляр нормализации.

Параметры:	norm : Normalize

Примечания

Если какие-либо цветовые шкалы используют карту значений для этой нормализации, установка нормализации для карты значений сбросит нормализацию, локатор и форматеры цветовой шкалы по умолчанию.

set_offset_position(self, offset_position)

Указать, как применяются смещения. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения основного преобразования, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до основного преобразования, т.е. смещения задаются в координатах данных.

Параметры:	offset_position : {'screen', 'data'}

set_offsets(self, offsets)

Установить смещения для коллекции.

Параметры:	offsets : float or sequence of floats

set_path_effects(self, path_effects)

Установить эффекты траектории.

Параметры:	path_effects : AbstractPathEffect

set_paths(self)

set_picker(self, picker)

Определить поведение выбора элемента.

Параметры:

picker : None or bool or float or callable Может принимать следующие значения: None: Выбор отключён для этого элемента (по умолчанию). Булево значение: Если True, выбор включён и элемент будет генерировать событие выбора, если курсор находится над ним. Число с плавающей точкой: Если picker — число, оно интерпретируется как толерантность в пунктах, и элемент будет генерировать событие, если его данные находятся в пределах толерантности от события мыши. Для некоторых элементов, таких как линии и коллекции фигур, элемент может предоставить дополнительные данные для события выбора, например, индексы данных, которые находятся в пределах толерантности от события выбора Функция: Если picker — вызываемый объект, это функция пользователя, которая определяет, был ли элемент нажат кнопкой мыши: hit, props = picker(artist, mouseevent) для определения проверки попадания. Если курсор находится над элементом, возвращайте hit=True, а props — словарь свойств, которые вы хотите добавить в атрибуты PickEvent.

set_pickradius(self, pr)

Установить радиус выбора, используемый для проверки попадания.

Параметры:	d : float Радиус выбора в пунктах.

set_rasterized(self, rasterized)

Принудительно выполнить растрированное (растровое) рисование в выходных данных векторного бэкенда.

По умолчанию значение равно None, что подразумевает поведение, заданное по умолчанию для бэкенда.

Параметры:	rasterized : bool or None

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:	scale : float, optional Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равно None или не предоставлено, фильтр наброска не будет применён. length : float, optional Длина колебаний вдоль линии в пикселях (по умолчанию 128,0) randomness : float, optional Коэффициент масштабирования, с помощью которого длина сжимается или расширяется (по умолчанию 16,0)

set_snap(self, snap)

Установить поведение привязки.

Привязка выравнивает позиции к пиксельной сетке, что приводит к более четким изображениям. Например, если черная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением на обеих смежных позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать черную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:	snap : bool or None Возможные значения: True: Привязать вершины к ближайшему центру пикселя. False: Не изменять положения вершин. None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(self, t)

Установить преобразование художника.

Параметры:	t : Transform

set_url(self, url)

Установить URL для художника.

Параметры:	url : str

set_urls(self, urls)

Параметры:	urls : List[str] or None

set_visible(self, b)

Установить видимость художника.

Параметры:	b : bool

set_zorder(self, level)

Установить z-порядок для художника. Художники с меньшими значениями z-порядка рисуются первыми.

Параметры:	level : float

stale

Является ли художник «старым» и требует перерисовки, чтобы вывод соответствовал внутреннему состоянию художника.

sticky_edges

x и y списки привязанных краёв для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно ожидается отсутствие отступа на нижнем крае (0) гистограммы.

К этому атрибуту нельзя присвоить значение; однако, списки x и y могут быть изменены непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(self, x, alpha=None, bytes=False, norm=True)

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x — это 1-мерная или 2-мерная последовательность скаляров, и соответствующий массив ndarray значений rgba будет возвращен на основе нормы и цветовой карты, установленной для этого ScalarMappable.

Существует один особый случай для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x является массивом ndarray с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как rgb или rgba массив, и никакое отображение не будет выполнено. Массив может быть uint8, или он может быть с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, аргумент alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующую прозрачность. Если третье измерение отлично от 3 или 4, будет поднято исключение ValueError.

В любом случае, если bytes — False (по умолчанию), массив rgba будет иметь значения с плавающей точкой в диапазоне 0-1; если True, возвращаемый массив rgba будет иметь тип uint8 в диапазоне от 0 до 255.

Если norm — False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(self, props)

Обновить свойства этого художника из словаря props.

update_from(self, other)

копировать свойства из other в self

update_scalarmappable(self)

Обновить цвета из массива скалярного отображаемого элемента, если он не равен None.

zorder = 0