matplotlib.collections

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

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

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

Bases: matplotlib.collections.RegularPolyCollection

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

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

Примеры

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

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

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

add_callback(self, func)

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

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

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

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

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

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

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

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

check_update(self, checker): [Устарело]

Примечания

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

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

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

Примечания

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

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

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

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

Параметры:

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

match

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

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

include_selfbool

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

Возвращает:

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): Возвращает clipbox.

get_clip_on(self): Возвращает, использует ли объект обрезку.

get_clip_path(self): Возвращает путь обрезки.

get_cmap(self): Возвращает экземпляр Colormap.

get_contains(self)

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

См. также

set_contains

Примечания

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

get_cursor_data(self, event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

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

get_fill(self): Возвращает, установлена ли заливка.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий шаблон штриховки.

get_in_layout(self)

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

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

get_joinstyle(self)

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

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_numsides(self)

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

Примечания

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

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)

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

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

get_sketch_params(self)

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

Возвращает:

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

кортеж или None

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

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

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

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

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

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

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

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

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self): Возвращает z-порядок объекта.

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

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback
remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств объекта.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs): Установщик свойств по партиям. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

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

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

set_animated(self, b)

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

Параметры:	`bbool`

set_antialiased(self, aa)

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

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

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

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

Параметры:	`Andarray`

set_capstyle(self, cs)

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

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

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

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

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

set_clip_box(self, clipbox)

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

Параметры:	`clipboxBbox`

set_clip_on(self, b)

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

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

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

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

Параметры:

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

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

Примечания

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

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

set_cmap(self, cmap)

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

Параметры:	`cmapColormap or str or None`

set_color(self, c)

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

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

См. также

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

set_contains(self, picker)

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

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

Параметры:

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

pickercallable

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

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

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

Примечания

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

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

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

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

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

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

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

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

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	`figFigure`

set_gid(self, gid)

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

Параметры:	`gidstr`

set_hatch(self, hatch)

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

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

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

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

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

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

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

set_in_layout(self, in_layout)

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

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

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

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

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

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

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

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

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

Параметры:	`normNormalize or None`

Примечания

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

set_offset_position(self, offset_position)

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

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

Примечания

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

set_offsets(self, offsets)

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

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

set_path_effects(self, path_effects)

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

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self)

set_picker(self, picker)

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

Параметры:

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

pickerNone or bool or callable

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

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

set_pickradius(self, pr)

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

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

set_rasterized(self, rasterized)

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

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

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

set_sizes(self, sizes, dpi=72.0)

Задайте размеры каждого элемента коллекции.

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

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

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

Параметры:

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

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

set_snap(self, snap)

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

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

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

Параметры:

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

snapbool or None

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

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

set_transform(self, t)

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

Параметры:	`tTransform`

set_url(self, url)

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

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

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

set_visible(self, b)

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

Параметры:	`bbool`

set_zorder(self, level)

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

Параметры:	`levelfloat`

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

property sticky_edges

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

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

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

Примеры

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

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

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

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

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

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

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

update(self, props)

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

Параметры:	`propsdict`

property update_dict

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.

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

add_callback(self, func)

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

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

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

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

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

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

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

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

check_update(self, checker): [Устарело]

Примечания

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

contains(self, mouseevent)

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer)

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

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

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

Примечания

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

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

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

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

Параметры:

match

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

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

include_selfbool

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

Возвращает:

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): Возвращает экземпляр Colormap.

get_contains(self)

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

См. также

set_contains

Примечания

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

get_cursor_data(self, event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

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

get_fill(self): Возвращает, установлено ли заполнение.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

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

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

get_joinstyle(self)

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

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

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

Примечания

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

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)

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

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

get_sketch_params(self)

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

Возвращает:

кортеж или None

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

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

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

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

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

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

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

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

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self): Возвращает z-порядок объекта.

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

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback
remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств объекта-артиста.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs): Установщик свойств в пакете. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

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

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

set_animated(self, b)

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

Параметры:	`bbool`

set_antialiased(self, aa)

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

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

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

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

Параметры:	`Andarray`

set_capstyle(self, cs)

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

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

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

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

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

set_clip_box(self, clipbox)

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

Параметры:	`clipboxBbox`

set_clip_on(self, b)

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

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

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

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

Параметры:

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

Примечания

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

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

set_cmap(self, cmap)

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

Параметры:	`cmapColormap or str or None`

set_color(self, c)

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

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

См. также

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

set_contains(self, picker)

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

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

Параметры:

pickercallable

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

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

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

Примечания

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

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

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

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

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

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

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

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

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	`figFigure`

set_gid(self, gid)

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

Параметры:	`gidstr`

set_hatch(self, hatch)

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

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

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

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

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

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

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

set_in_layout(self, in_layout)

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

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

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

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

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

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

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

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

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

Параметры:	`normNormalize or None`

Примечания

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

set_offset_position(self, offset_position)

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

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

Примечания

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

set_offsets(self, offsets)

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

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

set_path_effects(self, path_effects)

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

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self, verts, closed=True)

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

Параметры:

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

set_picker(self, picker)

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

Параметры:

pickerNone or bool or callable

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

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

set_pickradius(self, pr)

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

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

set_rasterized(self, rasterized)

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

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

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

set_sizes(self, sizes, dpi=72.0)

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

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

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

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

Параметры:

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

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	`tTransform`

set_url(self, url)

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

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

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

set_verts(self, verts, closed=True)

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

Параметры:

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

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

set_visible(self, b)

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

Параметры:	`bbool`

set_zorder(self, level)

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

Параметры:	`levelfloat`

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

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

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

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

property sticky_edges

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

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

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

Примеры

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

to_rgba(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.

Параметры:	`propsdict`

property update_dict

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

update_scalarmappable(self): Обновить цвета из массива сопоставителя скаляров, если он не равен None.

zorder = 0

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

Bases: matplotlib.collections._CollectionWithSizes

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

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

add_callback(self, func)

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

См. также

remove_callback

add_checker(self, checker): [Устарело]

Заметки

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

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

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

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

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

check_update(self, checker): [Устарело]

Заметки

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

contains(self, mouseevent)

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

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

convert_xunits(self, x)

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

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

convert_yunits(self, y)

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

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

draw(self, renderer)

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

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

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

Заметки

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

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

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

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

Параметры:

match

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

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

include_selfbool

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

Возвращает:

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): Возвращает экземпляр Colormap.

get_contains(self)

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

См. также

set_contains

Заметки

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

END_OF_DOCUMENT_MARKER

get_cursor_data(self, event)

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

Примечание

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

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

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

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

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

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

get_fill(self): Возвращает, установлено ли заполнение.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

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

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

get_joinstyle(self)

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

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

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

Примечания

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

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)

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

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

get_sketch_params(self)

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

Возвращает:

кортеж или None

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

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

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

get_snap(self)

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

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

END_OF_DOCUMENT_MARKER

get_tightbbox(self, renderer)

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

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

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

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

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

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

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

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

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

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

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

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

get_zorder(self): Возвращает z-порядок объекта.

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

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback
remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств объекта-артиста.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs): Установка свойств в пакетном режиме. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

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

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

set_animated(self, b)

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

Параметры:	`bbool`

set_antialiased(self, aa)

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

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

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

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

Параметры:	`Andarray`

set_capstyle(self, cs)

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

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

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

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

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

set_clip_box(self, clipbox)

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

Параметры:	`clipboxBbox`

set_clip_on(self, b)

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

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

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

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

Параметры:

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

Примечания

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

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

set_cmap(self, cmap)

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

Параметры:	`cmapColormap or str or None`

set_color(self, c)

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

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

См. также

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

set_contains(self, picker)

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

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

Параметры:

pickercallable

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

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

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

Примечания

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

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

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

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

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

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

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

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

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	`figFigure`

set_gid(self, gid)

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

Параметры:	`gidstr`

set_hatch(self, hatch)

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

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

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

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

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

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

set_in_layout(self, in_layout)

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

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

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

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

set_label(self, s)

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

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

set_linestyle(self, ls)

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

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

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

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

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

Параметры:	`normNormalize or None`

Примечания

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

set_offset_position(self, offset_position)

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

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

Примечания

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

set_offsets(self, offsets)

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

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

set_path_effects(self, path_effects)

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

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self)

set_picker(self, picker)

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

Параметры:

pickerNone or bool or callable

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

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

set_pickradius(self, pr)

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

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

set_rasterized(self, rasterized)

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

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

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

set_sizes(self, sizes, dpi=72.0)

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

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

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

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

Параметры:

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

set_snap(self, snap)

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

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

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

Параметры:

snapbool or None

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

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

set_transform(self, t)

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

Параметры:	`tTransform`

set_url(self, url)

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

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

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

set_visible(self, b)

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

Параметры:	`bbool`

set_zorder(self, level)

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

Параметры:	`levelfloat`

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

property sticky_edges

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

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

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

Примеры

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

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

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

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

Параметры:	`propsdict`

property update_dict

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

Bases: matplotlib.artist.Artist, matplotlib.cm.ScalarMappable

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

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

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

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

prop[i % len(prop)]

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

Параметры:

edgecolorscolor or list of colors, default: rcParams["patch.edgecolor"] (default: 'black')

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

facecolorscolor or list of colors, default: rcParams["patch.facecolor"] (default: 'C0')

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

linewidthsfloat or list of floats, default: rcParams["patch.linewidth"] (default: 1.0)

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

linestylesstr or tuple or list thereof, default: 'solid'

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

(offset, onoffseq),

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

capstylestr, default: rcParams["patch.capstyle"]

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

joinstylestr, default: rcParams["patch.joinstyle"]

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

antialiasedsbool or list of bool, default: rcParams["patch.antialiased"] (default: True)

Определяет, будет ли каждый элемент в коллекции нарисован с антиалиасингом.

offsets(float, float) or list thereof, default: (0, 0)

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

transOffsetTransform, default: IdentityTransform

Единственное преобразование, которое будет применено к каждому вектору смещений offsets перед его использованием.

offset_position{'screen' (default), 'data' (deprecated)}

Если установлено 'data' (устарело), offsets будет интерпретироваться как координаты данных, а не координаты экрана.

normNormalize, optional

Передается ScalarMappable. Значение по умолчанию None означает, что при первом вызове рисования будут установлены vmin и vmax используя минимальное и максимальное значения данных.

cmapColormap, optional

Передаётся ScalarMappable. Значение по умолчанию None приведёт к использованию rcParams["image.cmap"] (по умолчанию: 'viridis')

hatchstr, optional

Стиль штриховки для залитых путей, если таковые имеются. Допустимые значения: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Значение каждого типа штриховки см. на странице примера штриховки.

pickradiusfloat, default: 5.0

Если pickradius <= 0, Collection.contains вернёт True, если точка попадает внутрь одного из многоугольников, образованных контрольными точками пути в коллекции. В противном случае, если значение больше 0, то проверяется, содержится ли точка в контуре шириной 2*pickradius вокруг одного из путей в коллекции.

urlslist of str, default: None

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

zorderfloat, default: 1

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

add_callback(self, func)

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

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

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

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

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

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

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

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

check_update(self, checker): [Устарело]

Примечания

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

contains(self, mouseevent) [source]

Проверка, произошёл ли щелчок мыши в пределах коллекции.

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

convert_xunits(self, x)

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

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

END_OF_DOCUMENT_MARKER

convert_yunits(self, y)

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

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

draw(self, renderer) [source]

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

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

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

Примечания

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

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

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

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

Параметры:

match

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

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

include_selfbool

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

Возвращает:

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

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

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

get_clip_box(self): Возвращает область обрезки.

get_clip_on(self): Возвращает, использует ли элемент управления обрезку.

get_clip_path(self): Возвращает путь обрезки.

get_cmap(self): Возвращает экземпляр Colormap.

get_contains(self)

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

См. также

set_contains

Примечания

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

get_cursor_data(self, event)

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

Примечание

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

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

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

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

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData) [source]

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self) [source]

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self) [source]

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

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

get_fill(self) [source]: Возвращает, установлено ли заполнение.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self) [source]: Возвращает текущий узор штриховки.

get_in_layout(self)

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

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

get_joinstyle(self) [source]

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

get_linestyle(self) [source]

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self) [source]

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

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

Примечания

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

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)

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

Возвращает:

кортеж или None

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

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

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

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

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

get_transforms(self) [source]

get_url(self): Возвращает URL.

get_urls(self) [source]

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

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

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer) [source]

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

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

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

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

get_zorder(self): Возвращает z-порядок объекта.

END_OF_DOCUMENT_MARKER

have_units(self): Возвращает True, если единицы измерения установлены на любой оси.

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback
remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

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

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs): Установщик свойств пакетного типа. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha) [source]

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

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

set_animated(self, b)

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

Параметры:	`bbool`

set_antialiased(self, aa) [source]

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

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

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

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

Параметры:	`Andarray`

set_capstyle(self, cs) [source]

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

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

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

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

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

set_clip_box(self, clipbox)

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

Параметры:	`clipboxBbox`

set_clip_on(self, b)

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

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

Параметры:	`bbool`

END_OF_DOCUMENT_MARKER

set_clip_path(self, path, transform=None)

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

Параметры:

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

Примечания

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

set_cmap(self, cmap)

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

Параметры:	`cmapColormap or str or None`

set_color(self, c) [source]

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

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

См. также

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

set_contains(self, picker)

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

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

Параметры:

pickercallable

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

def contains(artist: Artist, event: MouseEvent) -> bool, dict

и возвращать:

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

Примечания

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

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c) [source]

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

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

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c) [source]

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

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

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

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	`figFigure`

set_gid(self, gid)

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

Параметры:	`gidstr`

set_hatch(self, hatch) [source]

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

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

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

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

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

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

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

set_in_layout(self, in_layout)

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

Параметры:	`in_layoutbool`

set_joinstyle(self, js) [source]

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

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

set_label(self, s)

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

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

set_linestyle(self, ls) [source]

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

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

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

(offset, onoffseq),

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

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

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw) [source]

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

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

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

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

Параметры:	`normNormalize or None`

Примечания

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

set_offset_position(self, offset_position) [source]

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

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

Примечания

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

set_offsets(self, offsets) [source]

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

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

set_path_effects(self, path_effects)

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

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self) [source]

set_picker(self, picker)

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

Параметры:

pickerNone or bool or callable

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

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

set_pickradius(self, pr) [source]

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

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

set_rasterized(self, rasterized)

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

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

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

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

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

Параметры:

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

set_snap(self, snap)

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

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

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

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

set_transform(self, t)

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

Параметры:	`tTransform`

set_url(self, url)

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

Параметры:	`urlstr`

set_urls(self, urls) [source]

Параметры:	`urlslist of str or None`

Примечания

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

set_visible(self, b)

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

Параметры:	`bbool`

set_zorder(self, level)

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

Параметры:	`levelfloat`

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

property sticky_edges

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

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

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

Примеры

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

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

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

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

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

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

update(self, props)

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

Параметры:	`propsdict`

property update_dict

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

update_scalarmappable(self) [source]: Обновить цвета из массива scalar mappable, если он не равен None.

zorder = 0

class matplotlib.collections.EllipseCollection(widths, heights, angles, units='points', **kwargs) [source]

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

Коллекция эллипсов, отрисованных с использованием сплайнов.

Параметры:

widthsarray-like: Длины первых осей (например, длины большой оси).
heightsarray-like: Длины вторых осей.
anglesarray-like: Углы первых осей, градусы против часовой стрелки от оси x.
units{'points', 'inches', 'dots', 'width', 'height', 'x', 'y', 'xy'}: Единицы, в которых заданы большие и малые оси; 'width' и 'height' относятся к размерам осей, а 'x' и 'y' относятся к данным о смещениях. 'xy' отличается от всех остальных тем, что угол, отображаемый на графике, изменяется в зависимости от соотношения сторон, и равен заданному углу только при единичном соотношении сторон. Следовательно, он ведет себя так же, как Ellipse с axes.transData в качестве своего преобразования.
**kwargs: Передаётся в Collection.

add_callback(self, func)

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

См. также

remove_callback

add_checker(self, checker): [Устаревшее]

Примечания

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

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

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

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

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

check_update(self, checker): [Устаревшее]

Примечания

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

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

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

Примечания

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

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

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

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

Параметры:

match

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

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

include_selfbool

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

Возвращает:

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): Возвращает clipbox.

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

get_clip_path(self): Возвращает путь обрезки.

get_cmap(self): Возвращает экземпляр Colormap.

get_contains(self)

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

См. также

set_contains

Примечания

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

get_cursor_data(self, event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

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

get_fill(self): Возвращает, установлено ли заполнение.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

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

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

get_joinstyle(self)

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

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

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

Примечания

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

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)

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

Возвращает:

кортеж или None

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

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

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

get_snap(self)

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

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

get_tightbbox(self, renderer)

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

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

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

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

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

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

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

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

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

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

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

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

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

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

is_transform_set(self)

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

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

property mouseover

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

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

pchanged(self)

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

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

См. также

add_callback
remove_callback

pick(self, mouseevent)

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

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

См. также

set_picker, get_picker, pickable

pickable(self)

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

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств элемента.

remove(self)

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

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

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

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

remove_callback(self, oid)

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

См. также

add_callback

set(self, **kwargs): Установка свойств по частям. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

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

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

set_alpha(self, alpha)

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

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

set_animated(self, b)

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

Параметры:	`bbool`

set_antialiased(self, aa)

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

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

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

END_OF_DOCUMENT_MARKER

set_array(self, A)

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

Параметры:	`Andarray`

set_capstyle(self, cs)

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

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

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

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

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

set_clip_box(self, clipbox)

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

Параметры:	`clipboxBbox`

set_clip_on(self, b)

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

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

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

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

Параметры:

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

Примечания

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

set_cmap(self, cmap)

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

Параметры:	`cmapColormap or str or None`

set_color(self, c)

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

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

См. также

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

set_contains(self, picker)

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

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

Параметры:

pickercallable

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

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

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

Примечания

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

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

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

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

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

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

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

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

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

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

Параметры:	`figFigure`

set_gid(self, gid)

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

Параметры:	`gidstr`

set_hatch(self, hatch)

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

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

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

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

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

set_in_layout(self, in_layout)

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

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

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

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

set_label(self, s)

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

Параметры:	`sobject` s будет преобразовано в строку с помощью вызова `str`.

set_linestyle(self, ls)

Установить стиль(и) линии для набора.

linestyle	описание
`'-'` or `'solid'`	сплошная линия
`'--'` or `'dashed'`	штриховая линия
`'-.'` or `'dashdot'`	пунктирная линия
`':'` or `'dotted'`	точечная линия

В качестве альтернативы можно указать кортеж с отступами следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий значения включения/выключения чернил в пунктах.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения)}. См. `Line2D.set_linestyle` для полного описания.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Установить ширину(ы) линии для набора. lw может быть скалярным или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установить экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если какие-либо цветные шкалы используют отображаемый объект для этой нормализации, установка нормализации отображаемого объекта сбросит нормализации, локаторы и форматеры на цветной шкале до значения по умолчанию.

set_offset_position(self, offset_position)

[Устаревшее] Установить способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования родительского объекта, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется перед преобразованием родительского объекта, т.е. смещения находятся в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Установить смещения для набора.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

set_path_effects(self, path_effects)

Установить эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self)

set_picker(self, picker)

Определение поведения выбора элемента.

Параметры:

pickerNone or bool or callable

Это может быть одним из следующих:

None: Выбор отключен для этого элемента (по умолчанию).
Логическое значение: Если True, выбор будет включён, и элемент сгенерирует событие выбора, если курсор мыши находится над элементом.
Функция: Если picker вызываемый, это функция, предоставляемая пользователем, которая определяет, попадает ли элемент под курсор мыши:
```
hit, props = picker(artist, mouseevent)
```
чтобы определить тест на попадание. Если курсор мыши находится над элементом, вернуть hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
Устаревшее: Для Line2D только, picker также может быть числом с плавающей точкой, которое задаёт толерантность для проверки, произошла ли событие "над" линией; это устарело. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Установить радиус выбора, используемый для тестов принадлежности.

Параметры:	`dfloat` Радиус выбора в пунктах.

set_rasterized(self, rasterized)

Вынужденное растрирование (отображение битовой карты) в векторном выводе бэкенда.

По умолчанию None, что подразумевает поведение по умолчанию бэкенда.

Параметры:	`rasterizedbool or None`

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:

scalefloat, optional: Амплитуда колебания перпендикулярно исходной линии, в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применён.
lengthfloat, optional: Длина колебания вдоль линии, в пикселях (по умолчанию 128.0)
randomnessfloat, optional: Коэффициент масштабирования, с помощью которого длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(self, snap)

Устанавливает поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением на обоих смежных пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:	`snapbool or None` Возможные значения: True: Привязать вершины к ближайшему центру пикселя. False: Не изменять позиции вершин. None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(self, t)

Установить преобразование художника.

Параметры:	`tTransform`

set_url(self, url)

Установить URL для художника.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(self, b)

Установить видимость художника.

Параметры:	`bbool`

set_zorder(self, level)

Установить z-порядок для художника. Художники с меньшими значениями zorder рисуются первыми.

Параметры:	`levelfloat`

property stale: Является ли художник «недействительным» и нужно ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию художника.

property sticky_edges

x и y списки прилипших краёв для автоматической масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно ожидается отсутствие отступа на нижнем краю (0) гистограммы.

К этому атрибуту нельзя обратиться; однако списки x и y можно изменять непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(self, x, alpha=None, bytes=False, norm=True)

Возвращает нормализованный массив rgba, соответствующий x.

В нормальном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий массив ndarray значений rgba будет возвращен, основываясь на нормализации и цветовой карте, установленной для этого ScalarMappable.

Существует один особый случай обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x — это массив ndarray с 3 измерениями, и последнее измерение равно 3 или 4, он будет обрабатываться как массив rgb или rgba, и отображение не будет выполнено. Массив может быть uint8 или он может быть с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет возбуждено исключение ValueError. Если это массив с пропусками (masked array), маска будет проигнорирована. Если последнее измерение равно 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.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Скопировать свойства из other в self.

update_scalarmappable(self): Обновить цвета из массива отображения скаляров, если он не равен None.

zorder = 0

class matplotlib.collections.EventCollection(positions, orientation='horizontal', lineoffset=0, linelength=1, linewidth=None, color=None, linestyle='solid', antialiased=None, **kwargs) [source]

Bases: matplotlib.collections.LineCollection

Коллекция местоположений вдоль одной оси, в которых произошло «событие».

События задаются одномерным массивом. У них нет амплитуды, и они отображаются как параллельные линии.

Параметры:

positions1D array-like

Каждое значение — это событие.

orientation{'horizontal', 'vertical'}, default: 'horizontal'

Последовательность событий отображается вдоль этого направления. Маркеры отдельных событий располагаются вдоль ортогонального направления.

lineoffsetfloat, default: 0

Смещение центра маркеров от начала координат в направлении, ортогональном orientation.

linelengthfloat, default: 1

Общая высота маркера (то есть маркер простирается от lineoffset - linelength/2 до lineoffset + linelength/2).

linewidthfloat or list thereof, default: rcParams["lines.linewidth"] (default: 1.5)

Ширина линии событий в пунктах.

colorcolor or list of colors, default: rcParams["lines.color"] (default: 'C0')

Цвет линий событий.

linestylestr or tuple or list thereof, default: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штриховки должны иметь вид:

(offset, onoffseq),

где onoffseq — кортеж чётной длины значений включения и выключения чернил в пунктах.

antialiasedbool or list thereof, default: rcParams["lines.antialiased"] (default: True)

Использовать ли антиалиасинг для рисования линий.

**kwargs

Передаётся в LineCollection.

Примеры

(Исходный код, png, pdf)

add_callback(self, func)

Параметры:	`funccallable` Функция обратного вызова. Она должна иметь следующий вид: def func(artist: Artist) -> Any где artist — вызываемый `Artist`. Значения возврата могут существовать, но игнорируются.
Возвращает:	int Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью `remove_callback` позже.

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

add_positions(self, position) [исходный код]: Добавить одно или несколько событий в указанных позициях.

append_positions(self, position): Добавить одно или несколько событий в указанных позициях.

autoscale(self): Автомасштабирование пределов скаляра на экземпляре нормы с использованием текущего массива.

autoscale_None(self): Автомасштабирование пределов скаляра на экземпляре нормы с использованием текущего массива, изменяя только пределы, которые равны None.

property axes: Экземпляр Axes, в котором находится объект, или None.

changed(self): Вызов при изменении отображаемого объекта для уведомления всех слушателей обратного вызова о событии 'changed'.

check_update(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

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).

Параметры:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределяется в подклассах Artist.

extend_positions(self, position): Добавить одно или несколько событий в указанных позициях.

findobj(self, match=None, include_self=True)

Поиск объектов художника.

Рекурсивно находит все Artist экземпляры, содержащиеся в объекте художника.

Параметры:

match

Критерий фильтрации соответствий. Может быть

None: Вернуть все объекты, содержащиеся в объекте художника.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только объекты художника, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только объекты художника этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список, который будет проверен на соответствие.

Возвращает:

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): Возвращает экземпляр Colormap.

get_color(self) [source]: Возвращает цвет линий, используемых для маркировки каждого события.

get_colors(self)

get_contains(self)

[Устарело] Возвращает пользовательскую функцию определения попадания в элемент, если она задана, или None.

См. также

set_contains

Примечания

Устарело начиная с версии 3.3.

get_cursor_data(self, event)

Возвращает данные курсора для данного события.

Примечание

Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация просто возвращает None.

Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны убедиться, что format_cursor_data может преобразовать данные в строковое представление.

Параметры:	`eventmatplotlib.backend_bases.MouseEvent`

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

get_figure(self): Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill(self): Возвращает, установлен ли заполнение.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

Возвращает логическое значение, True если элемент включён в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self): Возвращает метку, используемую для этого элемента на легенде.

get_linelength(self) [source]: Возвращает длину линий, используемых для маркировки каждого события.

get_lineoffset(self) [source]: Возвращает смещение линий, используемых для маркировки каждого события.

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self) [source]: Возвращает ширину линий, используемых для маркировки каждого события.

get_linewidths(self) [source]: Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_offset_position(self): [Устарело] Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования родительского элемента, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования родительского элемента, то есть смещения находятся в координатах данных.

Примечания

Устарело начиная с версии 3.3.

get_offset_transform(self)

get_offsets(self): Возвращает смещения для коллекции.

get_orientation(self) [source]: Возвращает ориентацию линии события ('горизонтальная' или 'вертикальная').

get_path_effects(self)

get_paths(self)

get_picker(self)

Возвращает поведение выбора для элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius(self)

get_positions(self) [source]: Возвращает массив, содержащий плавающие значения позиций.

get_rasterized(self): Возвращает, нужно ли растрировать элемент.

get_segments(self)

Возвращает:	список Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params(self)

Возвращает параметры наброска для элемента.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.

Возвращает None, если параметры наброска не были установлены.

get_snap(self)

Возвращает установку привязки.

Подробнее см. set_snap.

get_tightbbox(self, renderer)

Подобно Artist.get_window_extent, но включает любое обрезание.

Параметры:	`rendererRendererBase subclass` рендерер, который будет использоваться для отрисовки фигур (т.е. `fig.canvas.get_renderer()`)
Возвращает:	`Bbox` Охватывающая область (в пикселях координат фигуры).

get_transform(self): Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine(self): Возвращает обрезной путь с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Гиперссылки для примера.

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

Получает область осей в пространстве отображения.

Ширина и высота области осей неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотной" области. По умолчанию возвращается пустая область в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если область окна элемента изменяется. Область может измениться из-за любых изменений в стеке преобразования, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder(self): Возвращает z-порядок элемента.

have_units(self): Возвращает True, если единицы установлены на любой оси.

is_horizontal(self) [source]: True, если eventcollection горизонтальная, False, если вертикальная.

is_transform_set(self)

Возвращает, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

property mouseover

Если это свойство установлено в True, элемент будет запрошен для получения пользовательской информации о контексте, когда курсор мыши будет над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged(self)

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри, когда свойство изменяется.

См. также

add_callback
remove_callback

pick(self, mouseevent)

Обрабатывает событие выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен picker.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, можно ли выбрать элемент.

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств элемента.

remove(self)

Удалить элемент графического объекта с фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей, если необходимо, вызовите relim.

Примечание: relim не будут видеть коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента графического объекта.

remove_callback(self, oid)

Удалить обратный вызов на основе его идентификатора наблюдателя.

См. также

add_callback

set(self, **kwargs): Сеттер для пакетного изменения свойств. Передайте kwargs для изменения свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Установить фильтр agg.

Параметры:	`filter_funccallable` Функция фильтра, которая принимает массив с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(self, alpha)

Установить значение альфа для смешивания - не поддерживается на всех бэкэндах.

Параметры:	`alphafloat or None`

set_animated(self, b)

Установить состояние анимации графического объекта.

Параметры:	`bbool`

set_antialiased(self, aa)

Установить состояние сглаживания для рендеринга.

Параметры:	`aabool or list of bools`

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображения из массива NumPy A.

Параметры:	`Andarray`

set_capstyle(self, cs)

Установить стиль окончания для коллекции (для всех ее элементов).

Параметры:	`cs{'butt', 'round', 'projecting'}` Стиль окончания.

set_clim(self, vmin=None, vmax=None)

Установить пределы нормы для масштабирования изображения.

Параметры:	`vmin, vmaxfloat` Пределы. Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(self, clipbox)

Установить область обрезки графического объекта Bbox.

Параметры:	`clipboxBbox`

set_clip_on(self, b)

Установить, использует ли графический объект обрезку.

Если значение False, графические объекты будут отображаться за пределами осей, что может привести к непредсказуемым результатам.

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

Установить путь обрезки графического объекта.

Параметры:

pathPatch or Path or TransformedPath or None: Путь обрезки. Если задан Path, необходимо также указать transform. Если None, ранее заданный путь обрезки удаляется.
transformTransform, optional: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит область обрезки на соответствующий прямоугольник и установит путь обрезки на None.

По техническим причинам (поддержка set) также принимается кортеж (path, transform) как единственный позиционный параметр.

set_cmap(self, cmap)

Установить цветовую карту для данных яркости.

Параметры:	`cmapColormap or str or None`

set_color(self, c)

Установить цвет(ы) для LineCollection.

Параметры:	`ccolor or list of colors` Один цвет (все фигуры имеют одинаковый цвет) или последовательность кортежей rgba; если это последовательность, фигуры будут циклически проходить через последовательность.

set_contains(self, picker)

[Устарело] Определите пользовательскую проверку на содержание для графического объекта.

Предоставленная функция заменяет метод contains по умолчанию для графического объекта.

Параметры:

pickercallable

Пользовательская функция выбора для оценки, находится ли событие внутри графического объекта. Функция должна иметь следующий синтаксис:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

булево значение, указывающее, находится ли событие внутри графического объекта
словарь с дополнительной информацией. Словарь должен возвращать по крайней мере ту же информацию, что и реализация contains() по умолчанию для соответствующего графического объекта, но может содержать дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Установить цвет(цвета) обводки коллекции.

Параметры:	`ccolor or list of colors or 'face'` Цвет(цвета) обводки коллекции. Если последовательность, фигуры циклически используют цвета из неё. Если 'face', используется цвет заливки.

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

Установить цвет(цвета) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать цвета из неё.

Если c равно 'none', фигура не будет закрашена.

Параметры:	`ccolor or list of colors`

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

Установить экземпляр Figure, к которому принадлежит элемент.

Параметры:	`figFigure`

set_gid(self, gid)

Установить идентификатор группы для элемента.

Параметры:	`gidstr`

set_hatch(self, hatch)

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут комбинироваться, в этом случае выполняются все указанные штриховки. Если буква повторяется, это увеличивает плотность штриховки этого узора.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg backends.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно указать только для всей коллекции, а не для каждого элемента по отдельности.

Параметры:	`hatch{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}`

set_in_layout(self, in_layout)

Установить, будет ли элемент включён в вычисления макета, например, Руководство по макетам с ограниченным размером, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

Установить стиль соединения для коллекции (для всех её элементов).

Параметры:	`js{'miter', 'round', 'bevel'}` Стиль соединения.

set_label(self, s)

Установить метку, которая будет отображаться в легенде.

Параметры:	`sobject` s будет преобразовано в строку с помощью вызова `str`.

set_linelength(self, linelength) [source]: Установить длину линий, используемых для обозначения каждого события.

set_lineoffset(self, lineoffset) [source]: Установить смещение линий, используемых для обозначения каждого события.

set_linestyle(self, ls)

Установить стиль(стили) линий для коллекции.

linestyle	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	штрих-пунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж с делениями в следующем формате:

(offset, onoffseq),

где onoffseq — кортеж чётной длины с значениями отступов и включённой/выключённой линии в пунктах.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. См. `Line2D.set_linestyle` для полного описания.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Установить ширину(ширины) линии для коллекции. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически использовать значения из неё.

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установить экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если есть какие-либо цветовые шкалы, использующие карту отображения для этой нормализации, установка нормализации карты отображения сбросит нормализацию, локатор и форматирование на цветовой шкале по умолчанию.

set_offset_position(self, offset_position)

[Устаревшее] Устанавливает, как применяются смещения. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования master, то есть смещения заданы в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования master, т.е. смещения заданы в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Устанавливает смещения для коллекции.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

set_orientation(self, orientation=None) [source]

Устанавливает ориентацию линии события.

Параметры:	`orientation{'horizontal', 'vertical'}`

set_path_effects(self, path_effects)

Устанавливает эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self, segments)

set_picker(self, picker)

Определяет поведение выбора элемента.

Параметры:

pickerNone or bool or callable

Это может быть одно из следующего:

None: Выбор отключён для этого элемента (по умолчанию).
Логическое значение: Если True, то выбор будет включён, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
Функция: Если picker является вызываемой функцией, то это пользовательская функция, которая определяет, попадает ли элемент под действие события мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить в атрибуты события PickEvent.
устаревшее: Только для Line2D, picker также может быть числом с плавающей точкой, задающим допуск для проверки того, произошло ли событие «над» линией; это устаревшее свойство. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Устанавливает радиус выбора, используемый для проверки попадания.

Параметры:	`dfloat` Радиус выбора в пунктах.

set_positions(self, positions) [source]: Устанавливает позиции событий.

set_rasterized(self, rasterized)

Принудительно задаёт растрированное (растровое) рисование в выходных данных векторного бэкенда.

По умолчанию None, что подразумевает стандартное поведение бэкенда.

Параметры:	`rasterizedbool or None`

set_segments(self, segments)

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:

scalefloat, optional: Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применяться.
lengthfloat, optional: Длина колебаний вдоль линии в пикселях (по умолчанию 128,0)
randomnessfloat, optional: Коэффициент масштаба, с которым длина сжимается или расширяется (по умолчанию 16,0)

set_snap(self, snap)

Устанавливает поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если была определена чёрная линия шириной 1 пиксель в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет иметь серые значения в обоих смежных пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение будет содержать действительно чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Возможные значения:

True: Привязывать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные сегменты, округлять до ближайшего центра пикселя.

set_transform(self, t)

Устанавливает преобразование элемента.

Параметры:	`tTransform`

set_url(self, url)

Устанавливает URL для элемента.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

URL в настоящее время реализованы только в бэкенде SVG. Они игнорируются всеми другими бэкендами.

set_verts(self, segments)

set_visible(self, b)

Устанавливает видимость элемента.

Параметры:	`bbool`

set_zorder(self, level)

Устанавливает z-порядок элемента. Элементы с меньшими значениями z-порядка рисуются первыми.

Параметры:	`levelfloat`

property stale: Является ли элемент 'устаревшим' и нужно ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию элемента.

property sticky_edges

x и y списки привязанных границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется — предел просмотра «прикрепляется» к краю. Типичный случай использования — гистограммы, где обычно ожидается отсутствие отступа на нижней границе (0) гистограммы.

К этому атрибуту нельзя присвоить значение; однако списки x и y можно изменять на месте по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

switch_orientation(self) [source]: Переключить ориентацию линии события, либо с вертикальной на горизонтальную, или наоборот.

to_rgba(self, x, alpha=None, bytes=False, norm=True)

Возвращает массив rgba, соответствующий x, в нормализованном формате.

В обычном случае x является 1-мерной или 2-мерной последовательностью скаляров, и соответствующий массив значений 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.

update(self, props)

Обновить свойства этого объекта от словаря props.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Копировать свойства из other в self.

update_scalarmappable(self): Обновить цвета из массива скалярного отображающего объекта, если он не равен None.

zorder = 0

class matplotlib.collections.LineCollection(segments, linewidths=None, colors=None, antialiaseds=None, linestyles='solid', offsets=None, transOffset=None, norm=None, cmap=None, pickradius=5, zorder=2, facecolors='none', **kwargs) [source]

Базы: matplotlib.collections.Collection

Представляет последовательность Line2D, которые должны быть нарисованы вместе.

Этот класс расширяет Collection, чтобы представлять последовательность Line2D вместо просто последовательности Patch. Как и в Collection, каждый атрибут LineCollection может быть либо единственным значением, либо списком значений. Этот список затем циклически используется для каждого элемента LineCollection, поэтому атрибут i-го элемента коллекции:

prop[i % len(prop)]

Атрибуты каждого элемента LineCollection по умолчанию принимают значения из rcParams["lines.*"] вместо rcParams["patch.*"], и к атрибуту colors добавлен вместо edgecolors.

Параметры:

segments: список массивоподобных объектов

Последовательность (line0, line1, line2), где:

linen = (x0, y0), (x1, y1), ... (xm, ym)

или эквивалентный массив NumPy с двумя столбцами. Каждая линия может иметь разное количество сегментов.

linewidthsfloat or list of float, default: rcParams["lines.linewidth"] (default: 1.5)

Ширина каждой линии в пунктах.

colorscolor or list of color, default: rcParams["lines.color"] (default: 'C0')

Последовательность кортежей RGBA (например, произвольные цветовые строки и т. д., недопустимы).

antialiasedsbool or list of bool, default: rcParams["lines.antialiased"] (default: True)

Использовать ли сглаживание для каждой линии.

zorderint, default: 2

zorder линий после отрисовки.

facecolorscolor or list of color, default: 'none'

Цвета заливки LineCollection. Установка значения, отличного от 'none', приведёт к заполнению каждой линии, как будто есть неявный сегмент линии, соединяющий последнюю и первую точки этой линии, замыкая её в замкнутый контур. Для того, чтобы вручную указать, что должно считаться "внутренней" частью каждой линии, используйте PathCollection вместо этого, где "внутренняя" часть может быть указана соответствующим использованием CLOSEPOLY.

**kwargs

Передаётся в Collection.

add_callback(self, func)

Добавить функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется один из атрибутов Artist.

Параметры:	`funccallable` Функция обратного вызова. Она должна иметь сигнатуру: def func(artist: Artist) -> Any где artist — вызываемый `Artist`. Возвращаемые значения могут существовать, но игнорируются.
Возвращает:	int Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью `remove_callback` позднее.

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

autoscale(self): Автомасштабировать пределы скалярных значений в экземпляре нормы, используя текущий массив

autoscale_None(self): Автомасштабировать пределы скалярных значений в экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None

property axes: Экземпляр Axes, в котором находится объект-художник, или None.

changed(self): Вызовите это, когда карта значений изменяется, чтобы уведомить всех слушателей обратных вызовов о сигнале 'changed'.

check_update(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

contains(self, mouseevent)

Проверка, произошла ли событие мыши внутри коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(self, x)

Преобразовать x, используя тип единиц измерения оси x.

Если объект-художник не находится внутри Axes или ось x не имеет единиц измерения, возвращается само значение x.

convert_yunits(self, y)

Преобразовать y, используя тип единиц измерения оси y.

Если объект-художник не находится внутри Axes или ось y не имеет единиц измерения, возвращается само значение y.

draw(self, renderer)

Отрисовать объект-художника (и его дочерние элементы) с помощью заданного рендерера.

Это не имеет никакого эффекта, если объект-художник не виден (Artist.get_visible возвращает False).

Параметры:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределяется в подклассах объекта-художника.

findobj(self, match=None, include_self=True)

Найти объекты-художники.

Рекурсивно найти все Artist экземпляры, содержащиеся в художнике.

Параметры:

match

Критерий фильтра для соответствий. Это может быть

None: Вернуть все объекты, содержащиеся в художнике.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только художников этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список для проверки соответствия.

Возвращает:

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): Возвращает экземпляр Colormap.

get_color(self) [source]

get_colors(self)

get_contains(self)

[Устарело] Возвращает пользовательскую функцию contains элемента, если она задана, иначе None.

См. также

set_contains

Примечания

Устарело начиная с версии 3.3.

get_cursor_data(self, event)

Возвращает данные курсора для данного события.

Примечание

Параметры:	`eventmatplotlib.backend_bases.MouseEvent`

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

get_figure(self): Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill(self): Возвращает, установлена ли закраска.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

Возвращает флаг, True если элемент включен в расчеты макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self): Возвращает метку, используемую для этого элемента в легенде.

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_offset_position(self): [Устарело] Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования мастера, то есть смещения в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования мастера, то есть смещения в координатах данных.

Примечания

Устарело начиная с версии 3.3.

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_segments(self) [source]

Возвращает:	список Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params(self)

Возвращает параметры наброска для элемента.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.

Возвращает None, если параметры наброска не были установлены.

get_snap(self)

Возвращает настройку привязки.

См. set_snap для получения подробностей.

get_tightbbox(self, renderer)

Подобно Artist.get_window_extent, но включает любые обрезки.

Параметры:	`rendererRendererBase subclass` рендерер, который будет использоваться для рисования графиков (т.е. `fig.canvas.get_renderer()`)
Возвращает:	`Bbox` Охватывающая область (в пиксельных координатах фигуры).

get_transform(self): Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine(self): Возвращает обрезку с применённой неаффинной частью её преобразования и оставшейся аффинной частью её преобразования.

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

Получить область графика в пространстве отображения.

Ширина и высота области графиков неотрицательны.

Подклассы должны переопределять для включения в вычисление "узкой" области графиков. По умолчанию возвращается пустая область графиков в координатах 0, 0.

Будьте осторожны при использовании этой функции, результаты не будут обновляться, если изменяется область окна элемента графиков. Область может измениться из-за любых изменений в стеке преобразования, таких как изменение пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры выглядят нормально на экране, но сохраняются неправильно.

get_zorder(self): Возвращает z-порядок элемента.

have_units(self): Возвращает True, если на любой оси установлены единицы.

is_transform_set(self)

Возвращает, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

property mouseover

Если эта свойство установлено в True, элемент будет запрошен для получения пользовательской информации контекста, когда указатель мыши перемещается над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged(self)

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(self, mouseevent)

Обработка события выбора.

Каждый дочерний элемент будет генерировать событие выбора, если mouseevent находится над элементом и у элемента установлена функция выбора.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, можно ли выбрать элемент.

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств элемента.

remove(self)

Удалить элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(self, oid)

Удаление обратного вызова на основе его идентификатора наблюдателя.

См. также

add_callback

set(self, **kwargs): Установщик свойств пакетным способом. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Установить фильтр agg.

Параметры:	`filter_funccallable` Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi и возвращает массив чисел с плавающей точкой (m, n, 3).

set_alpha(self, alpha)

Установить значение альфа для смешивания — не поддерживается на всех бэкендах.

Параметры:	`alphafloat or None`

set_animated(self, b)

Установить состояние анимации объекта.

Параметры:	`bbool`

set_antialiased(self, aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:	`aabool or list of bools`

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображений из массива NumPy A.

Параметры:	`Andarray`

set_capstyle(self, cs)

Установить стиль окончания для коллекции (для всех её элементов).

Параметры:	`cs{'butt', 'round', 'projecting'}` Стиль окончания.

set_clim(self, vmin=None, vmax=None)

Установить пределы нормализации для масштабирования изображения.

Параметры:	`vmin, vmaxfloat` Пределы. Пределы также можно передать как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(self, clipbox)

Установить обрезку объекта Bbox.

Параметры:	`clipboxBbox`

set_clip_on(self, b)

Установить, использует ли объект обрезку.

Если False, объекты будут отображаться за пределами осей, что может привести к неожиданным результатам.

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

Установить путь обрезки объекта.

Параметры:

pathPatch or Path or TransformedPath or None: Путь обрезки. Если задан как Path, transform также должен быть указан. Если None, ранее установленный путь обрезки удаляется.
transformTransform, optional: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path является Rectangle этот метод установит область обрезки соответствующему прямоугольнику и установит путь обрезки в None.

set_cmap(self, cmap)

Установить цветовую карту для данных яркости.

Параметры:	`cmapColormap or str or None`

set_color(self, c) [source]

Установить цвет(а) LineCollection.

Параметры:	`ccolor or list of colors` Единственный цвет (все области имеют одинаковый цвет) или последовательность кортежей rgba; если это последовательность, области будут циклически проходить по последовательности.

set_contains(self, picker)

[Устарело] Определить пользовательскую проверку на наличие объекта для художника.

Предоставленная вызываемая функция заменяет метод contains объекта по умолчанию.

Параметры:

pickercallable

Пользовательская функция выбора, которая проверяет, находится ли событие внутри объекта. Функция должна иметь следующий сигнатуру:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

булево значение, указывающее, находится ли событие внутри объекта
словарь дополнительной информации. Словарь должен по крайней мере возвращать ту же информацию, что и реализация contains() по умолчанию для соответствующего объекта, но может предоставлять дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Установить цвет(а) обводки коллекции.

Параметры:	`ccolor or list of colors or 'face'` Цвет(а) обводки коллекции. Если последовательность, области циклически проходят по ней. Если 'face', совпадает с цветом заливки.

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

Установить цвет(а) заливки коллекции. c может быть цветом (все области имеют одинаковый цвет) или последовательностью цветов; если это последовательность, области будут циклически проходить по последовательности.

Если c равно 'none', область не будет закрашена.

Параметры:	`ccolor or list of colors`

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

Установить экземпляр Figure, к которому принадлежит элемент.

Параметры:	`figFigure`

set_gid(self, gid)

Установить идентификатор группы для элемента.

Параметры:	`gidstr`

set_hatch(self, hatch)

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае все указанные штриховки выполняются. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого узора.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бэкендах.

Параметры:	`hatch{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}`

set_in_layout(self, in_layout)

Указать, будет ли элемент включён в расчёт макета, например, Руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

Установить стиль соединения для набора (для всех его элементов).

Параметры:	`js{'miter', 'round', 'bevel'}` Стиль соединения.

set_label(self, s)

Установить метку, которая будет отображаться в легенде.

Параметры:	`sobject` s будет преобразовано в строку с помощью вызова `str`.

set_linestyle(self, ls)

Установить стиль(и) линии для набора.

linestyle	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	пунктирная линия
`'-.'` или `'dashdot'`	штрихпунктирная линия
`':'` или `'dotted'`	пунктирная линия

В качестве альтернативы может быть предоставлена кортеж пунктира следующего вида:

(offset, onoffseq),

где onoffseq - кортеж чётной длины, содержащий значения включения и выключения чернил в пунктах.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения отдельных стилей линии включают {'-', '--', '-.', ':', '', (смещение, последовательность включение-выключение)}. См. `Line2D.set_linestyle` для полного описания.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Установить толщину(ы) линии для набора. lw может быть скалярным значением или последовательностью; если это последовательность, элементы будут циклически проходить через последовательность.

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установить экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если используются какие-либо цветовые шкалы, использующие карту отображения для этой нормализации, установка нормы карты отображения сбросит нормализация, локатор и форматирование на цветовой шкале по умолчанию.

set_offset_position(self, offset_position)

[Устарело] Установить способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования главного уровня, то есть смещения заданы в координатах экрана. Если offset_position равен 'data', смещение применяется перед преобразованием главного уровня, то есть смещения заданы в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Установить смещения для набора.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

set_path_effects(self, path_effects)

Установить эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self, segments)

set_picker(self, picker)

Определение поведения выбора элемента.

Параметры:

pickerNone or bool or callable

Может быть одним из следующих:

None: Выбор отключён для данного элемента (по умолчанию).
Булево значение: Если True, выбор включён, и элемент сработает при наведении курсора.
Функция: Если picker — вызываемая функция, то это пользовательская функция, определяющая, попадает ли элемент под действие события мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если курсор наведён на элемент, верните hit=True, и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
deprecated: Только для Line2D, picker также может быть числом с плавающей точкой, устанавливающим толерантность для проверки, произошла ли активация события «на» линии; это устаревшее свойство. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Установка радиуса выбора для проверки попадания.

Параметры:	`dfloat` Радиус выбора в пунктах.

set_rasterized(self, rasterized)

Вынужденное растрирование (преобразование в растровый формат) отрисовки в выводе векторного бэкенда.

По умолчанию равно None, что подразумевает стандартное поведение бэкенда.

Параметры:	`rasterizedbool or None`

set_segments(self, segments) [source]

set_sketch_params(self, scale=None, length=None, randomness=None)

Установка параметров наброска.

Параметры:

scalefloat, optional: Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применён.
lengthfloat, optional: Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)
randomnessfloat, optional: Коэффициент масштабирования, с которым длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(self, snap)

Установка поведения привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением на обеих смежных позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что результирующее изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(self, t)

Устанавливает преобразование элемента.

Параметры:	`tTransform`

set_url(self, url)

Устанавливает URL для элемента.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

URL в настоящее время реализованы только бэкендом SVG. В других бэкендах они игнорируются.

set_verts(self, segments)

set_visible(self, b)

Устанавливает видимость элемента.

Параметры:	`bbool`

set_zorder(self, level)

Установка z-порядка элемента. Элементы с меньшими значениями zorder рисуются первыми.

Параметры:	`levelfloat`

property stale: Является ли элемент 'недействительным' и требует ли он повторной отрисовки для соответствия внутреннего состояния элемента.

property sticky_edges

x и y списки привязанных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно не требуется отступ на нижнем крае (0) гистограммы.

Этот атрибут нельзя назначать; однако списки x и y можно изменять на месте по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(self, x, alpha=None, bytes=False, norm=True)

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x — это последовательность скаляров 1-го или 2-го порядка, и соответствующий массив значений rgba будет возвращён на основе нормы и цветовой карты, заданных для этого ScalarMappable.

Есть один специальный случай для обработки изображений, которые уже являются rgb или rgba, например, считанных из файла изображения. Если x — это массив с 3 измерениями, и последнее измерение равно 3 или 4, то он будет интерпретирован как массив rgb или rgba, и никакое преобразование не будет выполнено. Массив может быть uint8 или иметь значения с плавающей точкой в диапазоне 0-1; в противном случае будет возбуждено исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение alpha (по умолчанию 1) будет использовано для заполнения прозрачности. Если последнее измерение равно 4, значение alpha игнорируется; оно не заменяет существующее значение alpha. Возбуждение исключения ValueError произойдёт, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать значения с плавающей точкой в диапазоне 0-1; если True, возвращаемый массив rgba будет содержать uint8 в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне 0-1.

update(self, props)

Обновление свойств этого элемента из словаря props.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Копирование свойств из other в self.

update_scalarmappable(self): Обновление цветов из массива scalar mappable, если он не равен None.

zorder = 0

class matplotlib.collections.PatchCollection(patches, match_original=False, **kwargs) [source]

Bases: matplotlib.collections.Collection

Общее множество фигур.

Это упрощает назначение цветовой карты неоднородному набору фигур.

Это также может улучшить скорость построения графиков, так как PatchCollection будет рисовать быстрее, чем большое количество отдельных фигур.

patches: последовательность объектов Patch. Этот список может содержать разнородный набор различных типов фигур.
match_original: Если True, используются цвета и толщины линий исходных фигур. Если False, новые цвета могут быть назначены, предоставив стандартные аргументы коллекции, facecolor, edgecolor, linewidths, norm или cmap.

Если какие-либо из edgecolors, facecolors, linewidths, antialiaseds равны None, они по умолчанию принимают значения из настроек rcParams фигуры в порядке перечисления.

Использование функциональности ScalarMappable является необязательным. Если матрица ScalarMappable _A была задана (через вызов set_array), во время отрисовки будет выполнен вызов скалярного отображаемого объекта для установки цветов заполнения.

add_callback(self, func)

Параметры:	`funccallable` Функция обратного вызова. Она должна иметь сигнатуру: def func(artist: Artist) -> Any где artist — вызывающий `Artist`. Возвращаемые значения могут существовать, но игнорируются.
Возвращаемое значение:	int Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью `remove_callback` позже.

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

autoscale(self): Автоматически масштабирует пределы скаляра в экземпляре norm, используя текущий массив

autoscale_None(self): Автоматически масштабирует пределы скаляра в экземпляре norm, используя текущий массив, изменяя только пределы, равные None

property axes: Экземпляр Axes, в котором находится элемент, или None.

changed(self): Вызывается всякий раз, когда изменяется отображение, чтобы уведомить всех слушателей обратного вызова SM о сигнале 'changed'.

check_update(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

contains(self, mouseevent)

Проверить, произошло ли событие мыши внутри коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(self, x)

Преобразовать x, используя тип единиц измерения оси x.

Если элемент не находится в пределах оси или у оси x нет единиц измерения, возвращается x.

convert_yunits(self, y)

Преобразовать y, используя тип единиц измерения оси y.

Если элемент не находится в пределах оси или у оси y нет единиц измерения, возвращается y.

draw(self, renderer)

Отобразить элемент (и его потомков) с помощью заданного рендерера.

Не оказывает влияния, если элемент не отображается (Artist.get_visible возвращает False).

Параметры:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределяется в подклассах элемента.

findobj(self, match=None, include_self=True)

Найти объекты элементов.

Рекурсивно найти все экземпляры Artist, содержащиеся в элементе.

Параметры:

match

Критерий фильтрации для совпадений. Может быть

None: вернуть все объекты, содержащиеся в элементе.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список, подлежащий проверке на соответствие.

Возвращаемое значение:

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): Возвращает clipbox.

get_clip_on(self): Возвращает, использует ли элемент обрезку.

get_clip_path(self): Возвращает путь обрезки.

get_cmap(self): Возвращает экземпляр Colormap.

get_contains(self)

[Устарело] Возвращает пользовательскую функцию проверки попадания для объекта, если она задана, иначе None.

См. также

set_contains

Примечания

Устарело начиная с версии 3.3.

get_cursor_data(self, event)

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами объектов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Данные курсора могут использоваться объектами для предоставления дополнительной контекстной информации для данного события. По умолчанию метод возвращает None.

Единственное текущее применение — отображение значения z AxesImage в строке состояния окна графика при перемещении мыши.

Параметры:	`eventmatplotlib.backend_bases.MouseEvent`

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

get_figure(self): Возвращает экземпляр Figure, к которому принадлежит объект.

get_fill(self): Возвращает, установлен ли параметр заливки.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

Возвращает логический флаг, True если объект включён в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self): Возвращает метку, используемую для этого объекта в легенде.

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_offset_position(self): [Устарело] Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования master, то есть смещения заданы в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования master, то есть смещения заданы в координатах данных.

Примечания

Устарело начиная с версии 3.3.

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)

Возвращает параметры схематизации объекта.

Возвращает:

кортеж или None

3-х элементный кортеж с следующими элементами:

scale: Амплитуда колебаний, перпендикулярных исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, с которым длина сокращается или расширяется.

Возвращает None, если параметры схематизации не были заданы.

get_snap(self)

Возвращает установку snap.

См. set_snap для получения подробностей.

get_tightbbox(self, renderer)

Как Artist.get_window_extent, но включает любые обрезки.

Параметры:	`rendererRendererBase subclass` рендерер, который будет использоваться для отрисовки фигур (т.е. `fig.canvas.get_renderer()`)
Возвращает:	`Bbox` Охватывающая область (в пикселях координат фигуры).

get_transform(self): Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine(self): Возвращает путь обрезки с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL-адреса. См. Ссылки для примера.

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

Получить область осей в пространстве отображения.

Ширина и высота области осей неотрицательны.

Подклассы должны переопределять для включения в вычисление «плотной» области осей. По умолчанию возвращается пустая область в точке (0, 0).

Будьте внимательны при использовании этой функции, результаты не будут обновлены, если область элемента на экране изменяется. Область может изменяться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся неправильно.

get_zorder(self): Возвращает z-порядок элемента.

have_units(self): Возвращает True, если единицы заданы на любой оси.

is_transform_set(self)

Возвращает, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

property mouseover

Если этот параметр установлен в True, элемент будет запрошен для получения пользовательской информации контекста, когда курсор мыши перемещается над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged(self)

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(self, mouseevent)

Обработка события выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен выбор.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, можно ли выбрать элемент.

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств элемента.

remove(self)

Удалить элемент из фигуры, если это возможно.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(self, oid)

Удалить обратный вызов на основе его идентификатора наблюдателя.

См. также

add_callback

set(self, **kwargs): Установщик свойств в пакетном режиме. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Установить фильтр agg.

Параметры:	`filter_funccallable` Функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi и возвращает массив (m, n, 3).

set_alpha(self, alpha)

Установить значение alpha, используемое для смешивания — не поддерживается во всех бэкендах.

Параметры:	`alphafloat or None`

set_animated(self, b)

Установить состояние анимации элемента.

Параметры:	`bbool`

set_antialiased(self, aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:	`aabool or list of bools`

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

Установите массив изображений из массива NumPy A.

Параметры:	`Andarray`

set_capstyle(self, cs)

Установите стиль закругления для коллекции (для всех её элементов).

Параметры:	`cs{'butt', 'round', 'projecting'}` Стиль закругления.

set_clim(self, vmin=None, vmax=None)

Установите пределы нормы для масштабирования изображения.

Параметры:	`vmin, vmaxfloat` Пределы. Пределы также могут быть переданы как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(self, clipbox)

Установите обрезку объекта Bbox.

Параметры:	`clipboxBbox`

set_clip_on(self, b)

Установите, использует ли объект обрезку.

Когда False, объекты будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

Установите путь обрезки объекта.

Параметры:

pathPatch or Path or TransformedPath or None: Путь обрезки. Если задан Path, transform должен быть предоставлен также. Если None, ранее установленный путь обрезки удаляется.
transformTransform, optional: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle этот метод установит ограничивающую рамку для соответствующего прямоугольника и установит путь обрезки на None.

По техническим причинам (поддержка set), также принимается кортеж (path, transform) как единственный позиционный параметр.

set_cmap(self, cmap)

Установите цветовую карту для данных яркости.

Параметры:	`cmapColormap or str or None`

set_color(self, c)

Установите цвет границы и заливки.

Параметры:	`ccolor or list of rgba tuples`

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета границы или заливки индивидуально.

set_contains(self, picker)

[Устарело] Определите пользовательскую проверку нахождения точки внутри объекта.

Предоставленная функция заменяет стандартный метод contains объекта.

Параметры:

pickercallable

Пользовательская функция выбора для оценки, находится ли событие внутри объекта. Функция должна иметь следующий вид:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

булево значение, указывающее, находится ли событие внутри объекта
словарь с дополнительной информацией. Словарь должен возвращать по крайней мере ту же информацию, что и стандартная реализация contains() соответствующего объекта, но может предоставлять дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Установите цвет границы коллекции.

Параметры:	`ccolor or list of colors or 'face'` Цвет границы коллекции. Если последовательность, элементы циклически используют её. Если 'face', соответствует цвету заливки.

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

Установите цвет заливки коллекции. c может быть цветом (все элементы имеют один и тот же цвет) или последовательностью цветов; если это последовательность, элементы будут циклически использовать её. Если c равно 'none', элемент не будет заполнен.

Параметры:	`ccolor or list of colors`

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

Установите экземпляр Figure, к которому принадлежит объект.

Параметры:	`figFigure`

set_gid(self, gid)

Установите идентификатор (группы) объекта.

Параметры:	`gidstr`

set_hatch(self, hatch)

Установить узор штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого рисунка.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg backends.

В отличие от других свойств, таких как толщина линии и цвета, штриховка может быть указана только для всего набора, а не для каждого элемента по отдельности.

Параметры:	`hatch{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}`

set_in_layout(self, in_layout)

Установить, должен ли элемент включаться в вычисления макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

Установить стиль соединения для набора (для всех его элементов).

Параметры:	`js{'miter', 'round', 'bevel'}` Стиль соединения.

set_label(self, s)

Установить метку, которая будет отображаться в легенде.

Параметры:	`sobject` s будет преобразовано в строку с помощью вызова `str`.

set_linestyle(self, ls)

Установить стиль(и) линии для набора.

linestyle	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	пунктирная линия
`':'` или `'dotted'`	штрихпунктирная линия

В качестве альтернативы можно указать кортеж с черточками следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины чередующихся значений "включено" и "выключено" в пунктах.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Подробное описание см. в `Line2D.set_linestyle`.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установить экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если есть какие-либо цветовые шкалы, использующие mappable для этой нормализации, установка нормализации mappable сбросит нормализацию, локатор и форматы на цветовой шкале до значений по умолчанию.

set_offset_position(self, offset_position)

[Устарело] Установить способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования master, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования master, то есть смещения находятся в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Установить смещения для набора.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

set_path_effects(self, path_effects)

Установить эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self, patches) [источник]

set_picker(self, picker)

Определить поведение выбора элемента.

Параметры:

pickerNone or bool or callable

Это может быть одно из следующих:

None: Выбор отключён для этого элемента (по умолчанию).
Булево значение: Если True, то выбор включён, и элемент будет генерировать событие выбора, если курсор находится над ним.
Функция: Если picker является вызываемой функцией, она является пользовательской функцией, определяющей, попадает ли элемент под действие события мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над элементом, вернуть hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
Устарело: Только для Line2D, picker также может быть числом с плавающей запятой, которое устанавливает допуск для проверки того, произошло ли событие "на" линии; это устарело. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Установить радиус выбора, используемый для проверок соприкасаемости.

Параметры:	`dfloat` Радиус выбора в пунктах.

set_rasterized(self, rasterized)

Принудительно выполнить растрирование (отображение растровой графики) в выводе векторного бэкенда.

По умолчанию значение None, что подразумевает поведение по умолчанию для бэкенда.

Параметры:	`rasterizedbool or None`

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:

scalefloat, optional: Амплитуда колебаний, перпендикулярных исходной линии, в пикселях. Если scale равен None или не указан, фильтр наброска не будет применён.
lengthfloat, optional: Длина колебания по линии в пикселях (по умолчанию 128.0)
randomnessfloat, optional: Множитель масштаба, на который уменьшается или увеличивается длина (по умолчанию 16.0)

set_snap(self, snap)

Устанавливает поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в двух соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:	`snapbool or None` Возможные значения: True: Привязать вершины к ближайшему центру пикселя. False: Не изменять позиции вершин. None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(self, t)

Установить преобразование художника.

Параметры:	`tTransform`

set_url(self, url)

Установить URL для художника.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(self, b)

Установить видимость художника.

Параметры:	`bbool`

set_zorder(self, level)

Установить значение zorder для художника. Художники с меньшими значениями zorder рисуются первыми.

Параметры:	`levelfloat`

property stale: Является ли художник «неактуальным» и требует перерисовки для соответствия внутреннего состояния художника выводу.

property sticky_edges

x и y списки привязанных границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно не ожидается отступ на нижнем краю (0) гистограммы.

К этому атрибуту нельзя присваивать значения; однако списки x и y можно изменять по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(self, x, alpha=None, bytes=False, norm=True)

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x является одномерной или двумерной последовательностью скаляров, и возвращается соответствующий массив ndarray значений rgba на основе нормы и цветовой карты, установленных для этого объекта ScalarMappable.

Существует один особый случай для обработки изображений, которые уже являются rgb или rgba, например, которые были прочитаны из файла изображения. Если x является массивом ndarray с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакого отображения не будет выполнено. Массив может быть uint8 или иметь значения с плавающей точкой в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, аргумент alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующую альфа-компоненту. Будет поднято исключение ValueError, если третье измерение отличается от 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать числа с плавающей точкой в диапазоне 0-1; если это True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.

update(self, props)

Обновить свойства этого художника из словаря props.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Копирование свойств из other в self.

update_scalarmappable(self): Обновить цвета из массива скалярной карты, если он не равен None.

zorder = 0

class matplotlib.collections.PathCollection(paths, sizes=None, **kwargs) [source]

Bases: matplotlib.collections._CollectionWithSizes

Коллекция Path, созданная, например, с помощью scatter.

Параметры:

pathslist of path.Path: Пути, которые будут составлять Collection.
sizesarray-like: Множитель масштабирования каждого отрисовываемого Path. Одна квадратная единица в пространстве данных пути масштабируется до sizes**2 точек при отрисовке.
**kwargs: Передаются в Collection.

add_callback(self, func)

Параметры:	`funccallable` Функция обратного вызова. Она должна иметь следующий сигнатуру: def func(artist: Artist) -> Any где artist — вызывающий `Artist`. Возвращаемые значения могут существовать, но игнорируются.
Возвращает:	int Идентификатор наблюдателя, связанный с функцией обратного вызова. Этот идентификатор может быть использован для удаления функции обратного вызова с помощью `remove_callback` позже.

См. также

remove_callback

add_checker(self, checker): [Устаревшее]

Примечания

Устарело начиная с версии 3.3:

autoscale(self): Автоматически масштабировать пределы скаляров в экземпляре нормы с использованием текущего массива

autoscale_None(self): Автоматически масштабировать пределы скаляров в экземпляре нормы с использованием текущего массива, изменяя только пределы, которые равны None

property axes: Экземпляр Axes, в котором находится элемент, или None.

changed(self): Вызовите эту функцию при изменении отображаемого объекта, чтобы уведомить всех слушателей обратного вызова о сигнале «изменено».

check_update(self, checker): [Устаревшее]

Примечания

Устарело начиная с версии 3.3:

contains(self, mouseevent)

Проверить, произошла ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(self, x)

Преобразовать x с использованием типа единиц оси x.

Если элемент не находится в осях или ось x не имеет единиц, возвращается значение x.

convert_yunits(self, y)

Преобразовать y с использованием типа единиц оси y.

Если элемент не находится в осях или ось y не имеет единиц, возвращается значение y.

draw(self, renderer)

Отрисовать элемент (и его дочерние элементы) с помощью заданного рендерера.

Это не повлияет на элемент, если он не видим (Artist.get_visible возвращает False).

Параметры:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределен в подклассах элементов.

findobj(self, match=None, include_self=True)

Найти объекты элементов.

Рекурсивно найти все Artist экземпляры, содержащиеся в элементе.

Параметры:

match

Критерий фильтрации соответствий. Может быть:

None: вернуть все объекты, содержащиеся в элементе.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (isinstance проверка).

include_selfbool

Включить self в список, подлежащий проверке на соответствие.

Возвращает:

list of Artist

format_cursor_data(self, data)

Возвращает строковое представление data.

Примечание

По умолчанию реализация преобразует целые и плавающие числа и массивы целых и плавающих чисел в строку, разделенную запятыми, заключенную в квадратные скобки.

См. также

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): Возвращает экземпляр Colormap.

get_contains(self)

[Устаревшее] Возвращает пользовательскую функцию проверки принадлежности элемента к области отрисовки, если она установлена, или None.

См. также

set_contains

Примечания

Устаревшее начиная с версии 3.3.

get_cursor_data(self, event)

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения в подклассах элементов отрисовки. Пользователю Matplotlib, скорее всего, не нужно будет вызывать этот метод самостоятельно.

Данные курсора могут использоваться элементами отрисовки для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Параметры:	`eventmatplotlib.backend_bases.MouseEvent`

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

get_figure(self): Возвращает экземпляр Figure, к которому принадлежит элемент отрисовки.

get_fill(self): Возвращает, установлено ли заполнение.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий шаблон штриховки.

get_in_layout(self)

Возвращает булево значение, True указывающее, включён ли элемент отрисовки в расчёты макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self): Возвращает метку, используемую для этого элемента отрисовки в легенде.

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_offset_position(self): [Устаревшее] Возвращает способ применения смещений для коллекции. Если offset_position равно 'screen', смещение применяется после применения преобразования основного объекта, то есть смещения в координатах экрана. Если offset_position равно 'data', смещение применяется до преобразования основного объекта, т.е. смещения в координатах данных.

Примечания

Устаревшее начиная с версии 3.3.

get_offset_transform(self)

get_offsets(self): Возвращает смещения для коллекции.

get_path_effects(self)

get_paths(self) [source]

get_picker(self)

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self): Возвращает, должен ли элемент отрисовки быть растрированным.

get_sizes(self)

Возвращает размеры ('площади') элементов в коллекции.

Возвращает:	массив Площадь каждого элемента.

get_sketch_params(self)

Возвращает параметры наброска для элемента отрисовки.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, с помощью которого длина сжимается или расширяется.

Возвращает None, если параметры наброска не были установлены.

get_snap(self)

Возвращает значение настройки «привязка».

См. set_snap для подробностей.

get_tightbbox(self, renderer)

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:	`rendererRendererBase subclass` рендер, который будет использоваться для отрисовки графиков (т.е. `fig.canvas.get_renderer()`)
Возвращает:	`Bbox` Охватывающая область (в пикселях координат изображения).

get_transform(self): Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine(self): Возвращает обрезку с применённой частью преобразования, не относящейся к аффинной, и оставшейся аффинной частью преобразования.

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Гиперссылки для примера.

get_visible(self): Возвращает значение видимости.

get_window_extent(self, renderer)

Получение области графика в пространстве отображения.

Ширина и высота области графика неотрицательны.

Подклассы должны переопределять для включения в вычисление области "узкого" графика. По умолчанию возвращается пустая область в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновляются, если область отображения объекта изменяется. Область может изменяться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но будут сохранены неправильно.

get_zorder(self): Возвращает z-порядок объекта.

have_units(self): Возвращает True, если единицы установлены на любой оси.

is_transform_set(self)

Возвращает, имеет ли объект явно установленное преобразование.

Это True после вызова set_transform.

legend_elements(self, prop='colors', num='auto', fmt=None, func=<function PathCollection.<lambda> at 0x7fba55097af0>, **kwargs) [source]

Создает элементы легенды для PathCollection.

Каждый элемент легенды — это Line2D, представляющий прорисованный путь, а каждое имя — строка, описывающая, что представляет каждый путь.

Это полезно для получения легенды для графика scatter; например:

scatter = plt.scatter([1, 2, 3],  [4, 5, 6],  c=[7, 2, 3])
plt.legend(*scatter.legend_elements())

создаёт три элемента легенды, по одному для каждого цвета с числовыми значениями, переданными в c, в качестве имен.

Также см. пример Автоматическое создание легенды.

Параметры:

prop{"colors", "sizes"}, default: "colors": Если «цвета», элементы легенды будут отображать разные цвета коллекции. Если «размеры», легенда будет отображать разные размеры. Чтобы установить и то, и другое, используйте kwargs для непосредственного изменения свойств Line2D.
numint, None, "auto" (default), array-like, or Locator,: Целевое количество элементов для создания. Если None, используются все уникальные элементы массива отображаемого объекта. Если целое число, цель состоит в использовании num элементов в нормированном диапазоне. Если «авто», попробуйте определить, какой вариант лучше подходит для природы данных. Количество созданных элементов может немного отклоняться от num из-за использования Locator для поиска полезных расположений. Если список или массив, используются ровно эти элементы для легенды. Наконец, можно указать Locator.
fmtstr, Formatter, or None (default): Формат или форматировщик для использования в именах. Если строка, должна быть допустимым вводом для StrMethodFormatter. Если None (по умолчанию), используйте ScalarFormatter.
funcfunction, default lambda x: x: Функция для расчета названий. Часто аргумент размера (или цвета) для scatter будет предварительно обработан пользователем с помощью функции s = f(x) для отображения маркеров; например, size = np.log10(x). Предоставление обратной функции здесь позволяет инвертировать эту предварительную обработку, чтобы имена в легенде имели правильные значения; например, func = lambda x: 10**x.
**kwargs: Допустимые ключевые аргументы — цвет и размер. Например, может быть полезно установить цвет маркеров, если используется prop="sizes"; аналогично, установить размер маркеров, если используется prop="colors". Все дополнительные параметры передаются экземпляру Line2D. Это может быть полезно для, например, задания другого markeredgecolor или alpha для элементов легенды.

Возвращает:

handleslist of Line2D: Визуальное представление каждого элемента легенды.
labelslist of str: Строковые имена элементов легенды.

property mouseover

Если это свойство установлено в True, объект будет запрошен для получения пользовательской информации о контексте при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged(self)

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(self, mouseevent)

Обработка события выбора.

Каждый дочерний объект будет вызывать событие выбора, если mouseevent находится над объектом, и для объекта установлен picker.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, является ли элемент графики выбираемым.

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств элемента графики.

remove(self)

Удаляет элемент графики из фигуры, если это возможно.

Эффект не будет виден до повторной отрисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей используйте relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента графики.

remove_callback(self, oid)

Удаляет обработчик на основе его идентификатора наблюдателя.

См. также

add_callback

set(self, **kwargs): Устанавливает свойства. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Устанавливает фильтр agg.

Параметры:	`filter_funccallable` Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(self, alpha)

Устанавливает значение альфа-канала для смешивания. Не поддерживается во всех бэкендах.

Параметры:	`alphafloat or None`

set_animated(self, b)

Устанавливает состояние анимации элемента графики.

Параметры:	`bbool`

set_antialiased(self, aa)

Устанавливает состояние антиалиасинга для рендеринга.

Параметры:	`aabool or list of bools`

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

Устанавливает массив изображения из массива numpy A.

Параметры:	`Andarray`

set_capstyle(self, cs)

Устанавливает стиль закругления для коллекции (для всех ее элементов).

Параметры:	`cs{'butt', 'round', 'projecting'}` Стиль закругления.

set_clim(self, vmin=None, vmax=None)

Устанавливает пределы нормы для масштабирования изображения.

Параметры:	`vmin, vmaxfloat` Пределы. Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(self, clipbox)

Устанавливает область обрезки элемента графики.

Параметры:	`clipboxBbox`

set_clip_on(self, b)

Устанавливает, использует ли элемент графики обрезку.

При значении False элементы графики будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

Устанавливает путь обрезки элемента графики.

Параметры:

pathPatch or Path or TransformedPath or None: Путь обрезки. Если задан Path, необходимо также указать transform. Если None, ранее установленный путь обрезки удаляется.
transformTransform, optional: Используется только если path - Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path - Rectangle, этот метод установит область обрезки на соответствующий прямоугольник и установит путь обрезки на None.

set_cmap(self, cmap)

Устанавливает карту цветов для данных яркости.

Параметры:	`cmapColormap or str or None`

set_color(self, c)

Устанавливает цвет границы и заливки.

Параметры:	`ccolor or list of rgba tuples`

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета границы или заливки по отдельности.

set_contains(self, picker)

[Устарело] Определяет пользовательскую проверку нахождения события внутри объекта.

Предоставленная функция заменяет метод contains по умолчанию.

Параметры:

pickercallable

Пользовательская функция проверки нахождения события внутри объекта. Функция должна иметь следующий сигнатуру:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

и возвращать:

булево значение, указывающее, находится ли событие внутри объекта
словарь дополнительной информации. Словарь должен, по крайней мере, возвращать ту же информацию, что и реализация contains() по умолчанию, но может содержать дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Устанавливает цвет(а) обводки коллекции.

Параметры:	`ccolor or list of colors or 'face'` Цвет(а) обводки коллекции. Если последовательность, то фигуры циклически просматривают её. Если 'face', то соответствует цвету заливки.

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

Устанавливает цвет(а) заливки коллекции. c может быть цветом (все фигуры имеют один и тот же цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически просматривать последовательность.

Если c равно 'none', фигура не будет закрашена.

Параметры:	`ccolor or list of colors`

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

Устанавливает экземпляр Figure, к которому принадлежит объект.

Параметры:	`figFigure`

set_gid(self, gid)

Устанавливает идентификатор группы для объекта.

Параметры:	`gidstr`

set_hatch(self, hatch)

Устанавливает шаблон штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут комбинироваться, в этом случае выполняются все указанные штриховки. Если одна буква повторяется, это увеличивает плотность штриховки этого шаблона.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg бэкендах.

В отличие от других свойств, таких как толщина линии и цвета, штриховка может быть задана только для всей коллекции, а не для каждого элемента по отдельности.

Параметры:	`hatch{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}`

set_in_layout(self, in_layout)

Устанавливает, должен ли объект включаться в вычисления макета, например, в Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

Устанавливает стиль соединения для коллекции (для всех её элементов).

Параметры:	`js{'miter', 'round', 'bevel'}` Стиль соединения.

set_label(self, s)

Устанавливает метку, которая будет отображаться в легенде.

Параметры:	`sobject` s будет преобразовано в строку с помощью `str`.

set_linestyle(self, ls)

Устанавливает стиль линии(й) для коллекции.

linestyle	описание
`'-'` or `'solid'`	сплошная линия
`'--'` or `'dashed'`	пунктирная линия
`'-.'` or `'dashdot'`	штрихпунктирная линия
`':'` or `'dotted'`	точковая линия

В качестве альтернативы можно указать кортеж с последовательностью включения и выключения чернил (dash tuple) следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, представляющий включение и выключение чернил в пунктах.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См. `Line2D.set_linestyle` для полного описания.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Устанавливает толщину линии(й) для коллекции. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически просматривать её.

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установите экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если есть какие-либо цветовые шкалы, использующие mappable для этой нормализации, установка нормализации mappable сбросит нормализацию, локатор и форматеры на цветовой шкале по умолчанию.

set_offset_position(self, offset_position)

[Устарело] Установите способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования master, то есть смещения заданы в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования master, то есть смещения заданы в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Установите смещения для коллекции.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

set_path_effects(self, path_effects)

Установите эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self, paths) [source]

set_picker(self, picker)

Определите поведение выбора для объекта-артиста.

Параметры:

pickerNone or bool or callable

Это может быть одно из следующего:

None: Выбор отключён для данного объекта-артиста (по умолчанию).
Булево значение: Если True, то выбор будет включён, и объект-артист будет генерировать событие выбора, если курсор мыши находится над ним.
Функция: Если picker — вызываемая функция, это пользовательская функция, которая определяет, попадает ли объект-артист под действие события мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения теста на попадание. Если курсор мыши находится над объектом-артистом, верните hit=True, а props — словарь свойств, которые вы хотите добавить в атрибуты PickEvent.
Устарело: Только для Line2D, picker также может быть числом с плавающей точкой, которое устанавливает допустимость для проверки того, произошло ли событие «на» линии; это устарело. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Установите радиус выбора, используемый для тестов на попадание.

Параметры:	`dfloat` Радиус выбора в пунктах.

set_rasterized(self, rasterized)

Вынудительно растрировать (битовое) отображение в выходных данных векторного бэкенда.

По умолчанию None, что подразумевает поведение по умолчанию бэкенда.

Параметры:	`rasterizedbool or None`

set_sizes(self, sizes, dpi=72.0)

Установите размеры каждого элемента коллекции.

Параметры:	`sizesndarray or None` Размер, который нужно установить для каждого элемента коллекции. Значение — это «площадь» элемента. `dpifloat, default: 72` Точки на дюйм холста.

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:

scalefloat, optional: Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не указано, фильтр наброска не будет предоставлен.
lengthfloat, optional: Длина колебания вдоль линии в пикселях (по умолчанию 128.0).
randomnessfloat, optional: Коэффициент масштабирования, с помощью которого длина уменьшается или увеличивается (по умолчанию 16.0).

set_snap(self, snap)

Установите поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет иметь серые значения на двух соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение будет действительно содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:	`snapbool or None` Возможные значения: True: Привязать вершины к ближайшему центру пикселя. False: Не изменять позиции вершин. None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(self, t)

Установите преобразование объекта-артиста.

Параметры:	`tTransform`

set_url(self, url)

Установите URL для объекта-артиста.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

В настоящее время URL реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(self, b)

Установите видимость объекта-артиста.

Параметры:	`bbool`

set_zorder(self, level)

Установите z-порядок для объекта-артиста. Объекты-артисты с меньшими значениями z-порядка рисуются первыми.

Параметры:	`levelfloat`

property stale: Является ли объект-артист «недействительным» и требует перерисовки, чтобы вывод соответствовал внутреннему состоянию объекта-артиста.

property sticky_edges

x и y списки прилипших границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно ожидается отсутствие отступа на нижнем краю (0) гистограммы.

Примеры

>>> 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.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Копирует свойства из other в self.

update_scalarmappable(self): Обновляет цвета из массива отображения скаляров, если он не равен None.

zorder = 0

class matplotlib.collections.PolyCollection(verts, sizes=None, closed=True, **kwargs) [source]

Bases: matplotlib.collections._CollectionWithSizes

Parameters:

vertslist of array-like: Последовательность полигонов [verts0, verts1, ...] где каждый элемент verts_i определяет вершины полигона i как двумерный массив-подобный объект формы (M, 2).
sizesarray-like, default: None: Квадратичные коэффициенты масштабирования для полигонов. Координаты каждого полигона verts_i умножаются на квадратный корень соответствующей записи в sizes (т.е., sizes определяют масштабирование площадей). Масштабирование применяется до преобразования мастера художника.
closedbool, default: True: Определяет, следует ли замыкать полигон, добавив соединение CLOSEPOLY в конце.
**kwargs: Передается в Collection.

add_callback(self, func)

Parameters:	`funccallable` Функция обратного вызова. Она должна иметь сигнатуру: def func(artist: Artist) -> Any где artist — вызываемый `Artist`. Значения возвращаемых результатов могут существовать, но игнорируются.
Returns:	int Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью `remove_callback` позже.

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

autoscale(self): Автомасштабирование пределов скаляров на экземпляре нормы с использованием текущего массива

autoscale_None(self): Автомасштабирование пределов скаляров на экземпляре нормы с использованием текущего массива, изменяя только пределы, которые равны None

property axes: Экземпляр Axes, в котором находится объект художника, или None.

changed(self): Вызовите эту функцию всякий раз, когда изменяется отображаемый объект, чтобы уведомить всех слушателей обратных вызовов о событии 'изменено'.

check_update(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

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).

Parameters:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределяется в подклассах объекта художника.

findobj(self, match=None, include_self=True)

Поиск объектов художника.

Рекурсивно ищет все экземпляры Artist, содержащиеся в художнике.

Parameters:

match

Критерий фильтрации соответствий. Может быть

None: Возвращает все объекты, содержащиеся в художнике.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только художников этого класса или его подклассов (isinstance проверка).

include_selfbool

Включать self в список, подлежащий проверке на соответствие.

Returns:

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): Возвращает экземпляр Colormap.

get_contains(self)

[Устарело] Возвращает пользовательскую функцию содержит, если она установлена, или None.

См. также

set_contains

Примечания

Устарело начиная с версии 3.3.

END_OF_DOCUMENT_MARKER

get_cursor_data(self, event)

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов графики. Как конечный пользователь Matplotlib, вы вряд ли будете вызывать этот метод самостоятельно.

Данные курсора могут использоваться элементами графики для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Параметры:	`eventmatplotlib.backend_bases.MouseEvent`

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

get_figure(self): Возвращает экземпляр Figure, которому принадлежит элемент графики.

get_fill(self): Возвращает, установлено ли заполнение.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

Возвращает логическое значение, True указывающее, включён ли элемент графики в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self): Возвращает метку, используемую для этого элемента графики в легенде.

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_offset_position(self): [Устарело] Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования родительского уровня, то есть смещения заданы в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования родительского уровня, то есть смещения заданы в координатах данных.

Примечания

Устарело начиная с версии 3.3.

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)

Возвращает размеры ('площади') элементов в коллекции.

Возвращает:	массив Площадь каждого элемента.

get_sketch_params(self)

Возвращает параметры наброска для элемента графики.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, по которому длина сжимается или растягивается.

Возвращает None, если параметры наброска не были заданы.

get_snap(self)

Возвращает значение настройки snap.

См. set_snap для получения подробностей.

get_tightbbox(self, renderer)

Как Artist.get_window_extent, но включает любые обрезки.

Параметры:	`rendererRendererBase subclass` рендерер, который будет использоваться для рисования фигур (т.е. `fig.canvas.get_renderer()`)
Возвращает:	`Bbox` Включающая ограничивающая рамка (в пиксельных координатах фигуры).

get_transform(self): Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine(self): Возвращает путь обрезки с применённой неаффинной частью её преобразования и оставшейся аффинной частью её преобразования.

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

Получение области осей в пространстве отображения.

Ширина и высота ограничивающей рамки неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотного" ограничивающего прямоугольника. По умолчанию возвращается пустая ограничивающая рамка в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если изменится область окна элемента.

Преобразования, такие как изменение пределов осей, размер фигуры или используемый холст (как при сохранении фигуры), могут привести к непредвиденному поведению. Взаимодействующие фигуры могут выглядеть нормально на экране, но сохраняться некорректно.

get_zorder(self): Возвращает z-порядок элемента.

have_units(self): Возвращает True, если единицы установлены на любой оси.

is_transform_set(self)

Возвращает, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

property mouseover

Если это свойство установлено в True, элемент будет запрошен для получения пользовательской информации контекста, когда курсор мыши будет над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged(self)

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(self, mouseevent)

Обработка события выбора.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, можно ли выбрать элемент.

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств элемента.

remove(self)

Удаляет элемент из фигуры, если это возможно.

Эффект не будет виден до повторного отрисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей, при необходимости, вызовите relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(self, oid)

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

set(self, **kwargs): Функция установки свойств по-блокам. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Установить фильтр agg.

Параметры:	`filter_funccallable` Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(self, alpha)

Установить значение альфа, используемое для смешивания - не поддерживается во всех бэкендах.

Параметры:	`alphafloat or None`

set_animated(self, b)

Установить состояние анимации элемента.

Параметры:	`bbool`

set_antialiased(self, aa)

Установить состояние сглаживания при отрисовке.

Параметры:	`aabool or list of bools`

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

Установите массив изображений из массива NumPy A.

Параметры:	`Andarray`

set_capstyle(self, cs)

Установите стиль окончания для коллекции (для всех ее элементов).

Параметры:	`cs{'butt', 'round', 'projecting'}` Стиль окончания.

set_clim(self, vmin=None, vmax=None)

Установите пределы нормализации для масштабирования изображения.

Параметры:	`vmin, vmaxfloat` Пределы. Пределы также можно передать в виде кортежа (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(self, clipbox)

Установите область обрезки элемента Bbox.

Параметры:	`clipboxBbox`

set_clip_on(self, b)

Установите, использует ли элемент обрезку.

Когда значение False, элементы будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

Установите область обрезки элемента.

Параметры:

pathPatch or Path or TransformedPath or None: Область обрезки. Если задан Path, необходимо также указать transform. Если None, ранее заданная область обрезки будет удалена.
transformTransform, optional: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

set_cmap(self, cmap)

Установите цветовую карту для данных яркости.

Параметры:	`cmapColormap or str or None`

set_color(self, c)

Установите и цвет обводки, и цвет заливки.

Параметры:	`ccolor or list of rgba tuples`

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета обводки или заливки индивидуально.

set_contains(self, picker)

[Устаревший] Определите пользовательскую проверку принадлежности для элемента.

Предоставленная вызываемая функция заменяет метод contains по умолчанию для элемента.

Параметры:

pickercallable

Пользовательская функция определения принадлежности события элементу. Функция должна иметь следующий прототип:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

булево значение, указывающее, находится ли событие внутри элемента
словарь дополнительной информации. Словарь должен, по крайней мере, возвращать ту же информацию, что и реализация contains() по умолчанию для соответствующего элемента, но может содержать дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Установите цвет обводки(обводок) коллекции.

Параметры:	`ccolor or list of colors or 'face'` Цвет обводки(обводок) коллекции. Если последовательность, фигуры циклически проходятся по ней. Если 'face', соответствует цвету заливки.

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

Установите цвет заливки(заливок) коллекции. c может быть цветом (у всех фигурок одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически проходить по последовательности.

Если c равно 'none', фигурка не будет закрашена.

Параметры:	`ccolor or list of colors`

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

Установите экземпляр Figure, к которому принадлежит элемент.

Параметры:	`figFigure`

set_gid(self, gid)

Установите идентификатор (группы) элемента.

Параметры:	`gidstr`

set_hatch(self, hatch)

Установить узор штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Штриховка поддерживается только в задних концах PostScript, PDF, SVG и Agg.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно задать только для всего набора, а не для каждого элемента по отдельности.

Параметры:	`hatch{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}`

set_in_layout(self, in_layout)

Установить, следует ли включать элемент в вычисления макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

Установить стиль соединения для набора (для всех его элементов).

Параметры:	`js{'miter', 'round', 'bevel'}` Стиль соединения.

set_label(self, s)

Установить метку, которая будет отображаться в легенде.

Параметры:	`sobject` s будет преобразовано в строку с помощью вызова `str`.

set_linestyle(self, ls)

Установить стиль линии(ей) для набора.

linestyle	описание
`'-'` or `'solid'`	сплошная линия
`'--'` or `'dashed'`	пунктирная линия
`'-.'` or `'dashdot'`	штрихпунктирная линия
`':'` or `'dotted'`	штриховая линия

В качестве альтернативы можно указать кортеж штрихов с последующей формой:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий длины включения и выключения чернил в пунктах.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Полное описание см. в `Line2D.set_linestyle`.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Установить толщину линии(ей) для набора. lw может быть скалярным или последовательностью; если это последовательность, фигуры будут циклически проходить через последовательность

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установить экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если есть какие-либо цветовые шкалы, использующие карту отображения для этой нормализации, установка нормализации карты отображения сбросит нормализацию, локатор и форматировщики цветовой шкалы по умолчанию.

set_offset_position(self, offset_position)

[Устарело] Установить, как применяются смещения. Если offset_position равно 'screen' (по умолчанию), смещение применяется после применения преобразования родительского элемента, то есть смещения находятся в координатах экрана. Если offset_position равно 'data', смещение применяется до преобразования родительского элемента, т. е. смещения находятся в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Установить смещения для набора.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

set_path_effects(self, path_effects)

Установить эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self, verts, closed=True)

Установить вершины многоугольников.

Параметры:

vertslist of array-like: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массив, подобный массиву, с формой (M, 2).
closedbool, default: True: Следует ли закрывать многоугольник добавлением соединения CLOSEPOLY в конце.

set_picker(self, picker)

Определение поведения выбора элемента.

Параметры:

pickerNone or bool or callable

Это может быть одним из следующего:

None: Выбор отключен для этого элемента (по умолчанию).
Булево значение: если True, выбор будет включён, и элемент будет генерировать событие выбора, если курсор мыши находится над элементом.
Функция: если picker вызываемая, это пользовательская функция, которая определяет, попадает ли элемент под курсор мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. если курсор мыши находится над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
Устаревшее: Только для Line2D, picker также может быть числом с плавающей точкой, которое задаёт допуск проверки, произошёл ли событие "над" линией; это устаревшее свойство. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Установить радиус выбора, используемый для проверок попадания.

Параметры:	`dfloat` Радиус выбора, в пунктах.

set_rasterized(self, rasterized)

Принудительно использовать растрированное (битовое) отображение в выходных данных векторного бэкенда.

По умолчанию None, что подразумевает поведение по умолчанию для бэкенда.

Параметры:	`rasterizedbool or None`

set_sizes(self, sizes, dpi=72.0)

Установить размеры каждого элемента коллекции.

Параметры:	`sizesndarray or None` Размер для каждого элемента коллекции. Значение — это 'площадь' элемента. `dpifloat, default: 72` Точки на дюйм (dpi) холста.

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:

scalefloat, optional: Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None или не указано, фильтр наброска не будет применён.
lengthfloat, optional: Длина колебаний вдоль линии в пикселях (по умолчанию 128.0).
randomnessfloat, optional: Коэффициент масштабирования, на который умножается длина (по умолчанию 16.0).

set_snap(self, snap)

Установить поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением в обоих смежных пиксельных позициях. В противоположность этому, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что результирующее изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Возможные значения:

True: Привязка вершин к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (авто) Если траектория содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя.

set_transform(self, t)

Установить преобразование объекта.

Параметры:	`tTransform`

set_url(self, url)

Установить URL для объекта.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_verts(self, verts, closed=True) [source]

Установить вершины многоугольников.

Параметры:

vertslist of array-like: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массив-подобный объект формы (M, 2).
closedbool, default: True: Требуется ли закрыть многоугольник добавлением подключения CLOSEPOLY в конце.

set_verts_and_codes(self, verts, codes) [source]: Инициализировать вершины с кодами траектории.

set_visible(self, b)

Установить видимость объекта.

Параметры:	`bbool`

set_zorder(self, level)

Установить z-порядок для объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры:	`levelfloat`

property stale: Является ли объект 'недействительным' и требуется ли перерисовать его, чтобы вывод соответствовал внутреннему состоянию объекта.

property sticky_edges

x и y списки привязанных границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, тогда не будет добавлен никакой отступ — предел просмотра "прилипает" к краю. Типичный пример использования — гистограммы, где обычно не ожидается отступ на нижнем краю (0) гистограммы.

К этому атрибуту нельзя присваивать; однако списки x и y можно изменять по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(self, x, alpha=None, bytes=False, norm=True)

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скаляров, и будет возвращен соответствующий массив ndarray значений rgba, основанный на норме и цветовой карте, установленной для этого ScalarMappable.

Существует один особый случай для обработки изображений, которые уже находятся в формате rgb или rgba, таких как изображения, прочитанные из файла изображения. Если x — это ndarray с 3 измерениями, и последнее измерение — 3 или 4, то он будет интерпретироваться как массив rgb или rgba, и никакого сопоставления не будет произведено. Массив может быть uint8 или он может быть с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массивы с пропусками, пропуски будут проигнорированы. Если последнее измерение равно 3, значение аргумента alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующий alpha. ValueError будет поднято, если третье измерение отличается от 3 или 4.

update(self, props)

Обновить свойства этого объекта из словаря props.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Скопировать свойства из other в self.

update_scalarmappable(self): Обновить цвета из массива скалярной карты, если он не равен None.

zorder = 0

class matplotlib.collections.QuadMesh(meshWidth, meshHeight, coordinates, antialiased=True, shading='flat', **kwargs) [source]

Bases: matplotlib.collections.Collection

Класс для эффективного рисования сетки четырехугольников.

Сетка четырехугольников состоит из сетки вершин. Размеры этого массива составляют (meshWidth + 1, meshHeight + 1). Каждая вершина в сетке имеет набор «координат сетки», представляющих её положение в топологии сетки. Для любых значений (m, n) таких, что 0 <= m <= meshWidth и 0 <= n <= meshHeight, вершины с координатами сетки (m, n), (m, n + 1), (m + 1, n + 1) и (m + 1, n) образуют один из четырехугольников в сетке. Таким образом, в сетке содержится (meshWidth * meshHeight) четырехугольников. Сетка необязательно должна быть регулярной, а многоугольники необязательно должны быть выпуклыми.

Сетка четырехугольников представляется (2 x ((meshWidth + 1) * (meshHeight + 1))) массивом numpy coordinates, где каждая строка — это координаты x и y одной из вершин. Для определения функции, отображающей данные точки в соответствующий цвет, используйте метод set_cmap(). Каждый из этих массивов индексируется в порядке следования строк координатами сетки вершины (или координатами сетки нижней левой вершины в случае с цветами).

Например, первая запись в coordinates — это координаты вершины с координатами сетки (0, 0), затем (0, 1), затем (0, 2) .. (0, meshWidth), (1, 0), (1, 1) и так далее.

shading может быть 'flat' или 'gouraud'

Параметры:

edgecolorscolor or list of colors, default: rcParams["patch.edgecolor"] (default: 'black')

Цвет границы для каждого элемента, образующего коллекцию. Специальное значение 'face' может быть передано для того, чтобы цвет границы соответствовал цвету заливки.

facecolorscolor or list of colors, default: rcParams["patch.facecolor"] (default: 'C0')

Цвет заливки для каждого элемента, образующего коллекцию.

linewidthsfloat or list of floats, default: rcParams["patch.linewidth"] (default: 1.0)

Ширина линии для каждого элемента, образующего коллекцию.

linestylesstr or tuple or list thereof, default: 'solid'

Допустимыми строками являются ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи пунктира должны иметь вид:

(offset, onoffseq),

где onoffseq — это кортеж чётной длины, содержащий длины включения и выключения чернил в пунктах. Примеры см. в Стилях линий.

capstylestr, default: rcParams["patch.capstyle"]

Стиль окончания линий для всех путей в коллекции. Смотрите Стили соединений и концов линий для демонстрации допустимых значений.

joinstylestr, default: rcParams["patch.joinstyle"]

Стиль соединения линий для всех путей в коллекции. Смотрите Стили соединений и концов линий для демонстрации допустимых значений.

antialiasedsbool or list of bool, default: rcParams["patch.antialiased"] (default: True)

Будет ли каждый элемент в коллекции нарисован с антиалиасингом.

offsets(float, float) or list thereof, default: (0, 0)

Вектор для перемещения каждого элемента после отрисовки (по умолчанию перемещения нет). Перемещение выполняется в координатах экрана (пикселей) (т. е. после применения преобразования объекта Artist).

transOffsetTransform, default: IdentityTransform

Единственное преобразование, которое будет применено к каждому вектору offsets перед его использованием.

offset_position{'screen' (default), 'data' (deprecated)}

Если установлено в 'data' (устарело), offsets будет обрабатываться как если бы он находился в координатах данных, а не в координатах экрана.

normNormalize, optional

Передается в ScalarMappable. По умолчанию None означает, что первый вызов отрисовки установит vmin и vmax, используя минимальные и максимальные значения данных.

cmapColormap, optional

Передается в ScalarMappable. По умолчанию None приведет к использованию rcParams["image.cmap"] (по умолчанию: 'viridis').

hatchstr, optional

Образец штриховки, используемый в залитых путях, если таковые имеются. Допустимыми строками являются ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. См. Демонстрация штриховки для значения каждого типа штриховки.

pickradiusfloat, default: 5.0

Если pickradius <= 0, то Collection.contains вернёт True, когда тестовая точка находится внутри одного из многоугольников, образованных контрольными точками пути в коллекции. С другой стороны, если оно больше 0, то мы проверяем, содержится ли тестовая точка в штрихе шириной 2*pickradius вдоль любого из путей в коллекции.

urlslist of str, default: None

URL для каждого элемента для перехода по ссылке после отрисовки. В настоящее время работает только для бэкэнда SVG. См. Гиперссылки для примеров.

zorderfloat, default: 1

Порядок отрисовки, общий для всех элементов в коллекции. См. Демонстрация zorder для всех значений по умолчанию и примеров.

add_callback(self, func)

Добавить функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется свойство одного из Artist.

Параметры:	`funccallable` Функция обратного вызова. Она должна иметь сигнатуру: def func(artist: Artist) -> Any где artist — вызываемый `Artist`. Возвращаемые значения могут существовать, но игнорируются.
Возвращает:	int Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может использоваться для удаления обратного вызова с помощью `remove_callback` впоследствии.

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

autoscale(self): Автоматически масштабировать пределы скалярных значений в экземпляре norm, используя текущий массив.

autoscale_None(self): Автоматически масштабировать пределы скалярных значений в экземпляре norm, используя текущий массив, изменяя только отсутствующие пределы.

property axes: Экземпляр Axes, в котором находится объект-художник, или None.

changed(self): Вызывайте это всякий раз, когда изменяется отображаемый объект, чтобы уведомить всех слушателей обратного вызова 'changed'.

check_update(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

contains(self, mouseevent)

Проверка, произошла ли обработка события мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

static convert_mesh_to_paths(meshWidth, meshHeight, coordinates) [source]

Преобразование заданной сетки в последовательность объектов Path.

Эта функция в основном полезна для разработчиков бэкэндов, которые не поддерживают сетки четырехугольников напрямую.

convert_mesh_to_triangles(self, meshWidth, meshHeight, coordinates) [source]: Преобразование заданной сетки в последовательность треугольников, каждая точка с собственным цветом. Это полезно для экспериментов с использованием draw_gouraud_triangle.

convert_xunits(self, x)

Преобразование x, используя тип единиц оси x.

Если объект-художник не находится в осях или если ось x не имеет единиц, возвращается сам x.

convert_yunits(self, y)

Преобразовать y с использованием типа единиц измерения оси y.

Если элемент управления не находится в пределах Axes или у оси y нет единиц измерения, возвращается само значение y.

draw(self, renderer) [source]

Отобразить элемент управления (и его дочерние элементы) с использованием заданного рендерера.

Это не имеет эффекта, если элемент управления не отображается (Artist.get_visible возвращает False).

Параметры:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределяется в подклассах элементов управления.

findobj(self, match=None, include_self=True)

Поиск объектов элементов управления.

Рекурсивно находят все Artist экземпляры, содержащиеся в элементе управления.

Параметры:

match

Критерий фильтра для совпадений. Может быть

None: Возвратить все объекты, содержащиеся в элементе управления.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы управления, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы управления этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список, который будет проверяться на соответствие.

Возвращает:

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): Возвращает экземпляр Colormap.

get_contains(self)

[Устарело] Возвращает пользовательскую функцию содержит элемента управления, если она задана, или None.

См. также

set_contains

Примечания

Устарело начиная с версии 3.3.

get_cursor_data(self, event)

Возвращает данные указателя для данного события.

Примечание

Данные указателя могут использоваться элементами управления для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.

Подклассы могут переопределить метод и возвращать произвольные данные. Однако при этом они должны обеспечить, чтобы format_cursor_data мог преобразовать данные в строковое представление.

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика во время перемещения мыши.

Параметры:	`eventmatplotlib.backend_bases.MouseEvent`

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData) [source]

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

get_figure(self): Возвращает экземпляр Figure, к которому относится элемент управления.

get_fill(self): Возвращает, установлен ли fill.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

Возвращает логический флаг, True если элемент включён в расчёты макета.

Например, Руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self): Возвращает метку, используемую для этого элемента в легенде.

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_offset_position(self): [Устаревшее] Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования основного объекта, то есть смещения в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования основного объекта, то есть смещения в координатах данных.

Примечания

Устарело начиная с версии 3.3.

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)

Возвращает параметры наброска для элемента.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.

Возвращает None, если параметры наброска не были установлены.

get_snap(self)

Возвращает параметр привязки.

См. set_snap для подробностей.

get_tightbbox(self, renderer)

Как Artist.get_window_extent, но включает любые обрезки.

Параметры:	`rendererRendererBase subclass` экранное представление, которое будет использоваться для отрисовки графиков (например, `fig.canvas.get_renderer()`)
Возвращает:	`Bbox` Охватывающая область (в пикселях координат рисунка).

get_transform(self): Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine(self): Возвращает обрезной путь с применённой не-аффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Гиперссылки для примера.

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

Получить область осей в пространстве отображения.

Ширина и высота области осей неотрицательны.

Подклассы должны переопределять для включения в расчёт области "плотного" отображения. По умолчанию возвращается пустая область в координатах 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновляются, если изменяется область отображения элемента. Область может измениться из-за любых изменений в стеке преобразований, например, при изменении пределов осей, размера рисунка или используемой области рисования (как это происходит при сохранении рисунка). Это может привести к неожиданному поведению, когда интерактивные рисунки будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder(self): Возвращает z-порядок элемента.

have_units(self): Возвращает True, если единицы измерения установлены на любой оси.

is_transform_set(self)

Возвращает, имеет ли элемент явно установленное преобразование.

Это True после вызова set_transform.

property mouseover

Если этот параметр установлен в True, элемент будет запрашиваться для получения пользовательской информации о контексте, когда курсор мыши перемещается по нему.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged(self)

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(self, mouseevent)

Обработать событие выбора.

Каждый дочерний элемент-объект будет срабатывать при событии выбора, если mouseevent находится над объектом, и у объекта установлен picker.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, можно ли выбрать элемент-объект.

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь со всеми свойствами элемента-объекта.

remove(self)

Удалить элемент-объект из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это нужно.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента-объекта.

remove_callback(self, oid)

Удалить обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

set(self, **kwargs): Метод для массовой установки свойств. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Установить фильтр agg.

Параметры:	`filter_funccallable` Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3).

set_alpha(self, alpha)

Установить значение альфа для смешивания - не поддерживается всеми бэкендами.

Параметры:	`alphafloat or None`

set_animated(self, b)

Установить состояние анимации объекта.

Параметры:	`bbool`

set_antialiased(self, aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:	`aabool or list of bools`

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображения из массива numpy A.

Параметры:	`Andarray`

set_capstyle(self, cs)

Установить стиль обрезки для коллекции (для всех её элементов).

Параметры:	`cs{'butt', 'round', 'projecting'}` Стиль обрезки.

set_clim(self, vmin=None, vmax=None)

Установить пределы нормирования для масштабирования изображения.

Параметры:	`vmin, vmaxfloat` Пределы. Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(self, clipbox)

Установить область обрезки элемента-объекта Bbox.

Параметры:	`clipboxBbox`

set_clip_on(self, b)

Установить, использует ли элемент-объект обрезку.

При значении False элементы-объекты будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

Установить обрезку элемента-объекта.

Параметры:

pathPatch or Path or TransformedPath or None: Область обрезки. Если задан Path, то transform должен быть указан также. Если None, то ранее установленная область обрезки будет удалена.
transformTransform, optional: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path это Rectangle, этот метод установит область обрезки соответствующему прямоугольнику и установит область обрезки в None.

По техническим причинам (поддержка set), также принимается кортеж (path, transform) в качестве единственного позиционного параметра.

set_cmap(self, cmap)

Установить цветовое отображение для данных яркости.

Параметры:	`cmapColormap or str or None`

set_color(self, c)

Установить цвет границы и заливки.

Параметры:	`ccolor or list of rgba tuples`

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для отдельной установки цвета границы или заливки.

set_contains(self, picker)

[Устаревший] Определение пользовательской проверки принадлежности для художника.

Предоставленная вызываемая функция заменяет метод contains художника по умолчанию.

Параметры:

pickercallable

Пользовательская функция-выборщика для оценки, находится ли событие внутри художника. Функция должна иметь сигнатуру:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

логическое значение, указывающее, находится ли событие внутри художника
словарь дополнительной информации. Словарь должен, по крайней мере, возвращать ту же информацию, что и реализация contains() по умолчанию для соответствующего художника, но может предоставлять дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Установить цвет(а) обводки коллекции.

Параметры:	`ccolor or list of colors or 'face'` Цвет(а) обводки коллекции. Если последовательность, фигуры циклически проходят по ней. Если 'face', совпадает с цветом заливки.

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

Устанавливает цвет(а) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически перебирать последовательность.

Если c равно 'none', фигура не будет закрашена.

Параметры:	`ccolor or list of colors`

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

Установить экземпляр Figure, к которому принадлежит художник.

Параметры:	`figFigure`

set_gid(self, gid)

Установить идентификатор (группы) для художника.

Параметры:	`gidstr`

set_hatch(self, hatch)

Установить шаблон штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одинаковая буква повторяется, плотность штриховки этого шаблона увеличивается.

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

В отличие от других свойств, таких как толщина линии и цвета, штриховка может быть задана только для всей коллекции, а не для каждого элемента отдельно.

Параметры:	`hatch{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}`

set_in_layout(self, in_layout)

Установить, должен ли художник включаться в вычисления макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

Установить тип соединения для коллекции (для всех ее элементов).

Параметры:	`js{'miter', 'round', 'bevel'}` Тип соединения.

set_label(self, s)

Установить метку, которая будет отображаться в легенде.

Параметры:	`sobject` s будет преобразовано в строку с помощью вызова `str`.

set_linestyle(self, ls)

Установить стиль(и) линии для коллекции.

linestyle	описание
`'-'` or `'solid'`	сплошная линия
`'--'` or `'dashed'`	штриховая линия
`'-.'` or `'dashdot'`	штрихпунктирная линия
`':'` or `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж штрихов следующей формы:

(offset, onoffseq),

где onoffseq — кортеж чётной длины с включением и выключением чернил в точках.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включение-выключение)}. См. `Line2D.set_linestyle` для полного описания.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Установить толщину линии(й) для коллекции. lw может быть скалярным значением или последовательностью; если это последовательность, фигуры будут циклически перебирать последовательность.

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установите экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если для этой нормы используются какие-либо цветовые шкалы, использование метода set_norm для объекта отображения обнулит норму, локатор и форматеры цветовой шкалы до значений по умолчанию.

set_offset_position(self, offset_position)

[Устарело] Установите способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения основного преобразования, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется перед основным преобразованием, то есть смещения задаются в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Установите смещения для коллекции.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

set_path_effects(self, path_effects)

Установите эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self) [source]

set_picker(self, picker)

Определение поведения выбора объекта.

Параметры:

pickerNone or bool or callable

Это может быть одним из следующих:

None: Выбор отключён для этого объекта (по умолчанию).
Логическое значение: Если True, выбор будет включён и объект сгенерирует событие выбора, если курсор мыши находится над ним.
Функция: Если picker является вызываемой функцией, она определяет, попадает ли данный объект под курсор мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если курсор мыши находится над объектом, верните hit=True, а в props — словарь свойств, которые необходимо добавить в атрибуты PickEvent.
устарело: Только для Line2D, picker также может быть числом с плавающей точкой, определяющим пороговую величину для проверки нахождения события «над» линией; это устарело. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Установите радиус выбора, используемый для проверок попадания в область.

Параметры:	`dfloat` Радиус выбора в пунктах.

set_rasterized(self, rasterized)

Принудительно использовать растрированное (растровое) изображение при выводе в векторных бэкендах.

По умолчанию значение None, что подразумевает поведение, установленное по умолчанию для бэкенда.

Параметры:	`rasterizedbool or None`

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:

scalefloat, optional: Амплитуда колебаний, перпендикулярных исходной линии, в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применён.
lengthfloat, optional: Длина колебаний вдоль линии в пикселях (по умолчанию 128.0).
randomnessfloat, optional: Коэффициент масштабирования, с которым длина сокращается или расширяется (по умолчанию 16.0).

set_snap(self, snap)

Установите поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серого цвета в обеих соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:	`snapbool or None` Возможные значения: True: Привязать вершины к ближайшему центру пикселя. False: Не изменять позиции вершин. None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(self, t)

Установите преобразование для объекта.

Параметры:	`tTransform`

set_url(self, url)

Установите URL для объекта.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(self, b)

Установите видимость объекта.

Параметры:	`bbool`

set_zorder(self, level)

Установите z-порядок для объекта. Объекты с более низкими значениями zorder рисуются первыми.

Параметры:	`levelfloat`

property stale: Является ли объект «неактуальным» и требует ли перерисовки, чтобы вывод соответствовал внутреннему состоянию объекта.

property sticky_edges

x и y списки прилипающих границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, тогда не добавляется отступ — предел отображения «прилипает» к границе. Типичный пример использования — гистограммы, где обычно ожидается отсутствие отступа на нижней границе (0) гистограммы.

К этому атрибуту нельзя присваивать значения; однако списки sticky_edges и sticky_edges могут быть изменены по мере необходимости.

Примеры

>>> 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.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Копирует свойства из other в self.

update_scalarmappable(self): Обновляет цвета из массива отображения скаляров, если он не равен None.

zorder = 0

class matplotlib.collections.RegularPolyCollection(numsides, rotation=0, sizes=1, **kwargs) [source]

Bases: matplotlib.collections._CollectionWithSizes

Коллекция n-сторонних правильных многоугольников.

Параметры:	`numsidesint` Количество сторон многоугольника. `rotationfloat` Поворот многоугольника в радианах. `sizestuple of float` Площадь окружности, описанной вокруг многоугольника, в пунктах^2. **kwargs Передаётся в `Collection`.

Примеры

См. Демонстрацию с лассо для полного примера:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    transOffset=ax.transData,
    )

add_callback(self, func)

Параметры:	`funccallable` Функция обратного вызова. Она должна иметь сигнатуру: def func(artist: Artist) -> Any где artist — вызываемый `Artist`. Возвращаемые значения могут существовать, но игнорируются.
Возвращает:	int Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью `remove_callback` позже.

См. также

remove_callback

add_checker(self, checker): [Устарело]

Замечания

Устарело начиная с версии 3.3:

autoscale(self): Автомасштабирование пределов скаляра на экземпляре norm с использованием текущего массива

autoscale_None(self): Автомасштабирование пределов скаляра на экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None

property axes: Экземпляр Axes, в котором находится объект, или None.

changed(self): Вызовите этот метод всякий раз, когда изменяется сопоставимый объект, чтобы оповестить все слушатели обратного вызова о событии 'changed'.

check_update(self, checker): [Устарело]

Замечания

Устарело начиная с версии 3.3:

contains(self, mouseevent)

Проверить, произошла ли активность мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(self, x)

Преобразовать x, используя тип единиц измерения оси x.

Если объект не содержится в оси или у оси x нет единиц измерения, возвращается x.

convert_yunits(self, y)

Преобразовать y, используя тип единиц измерения оси y.

Если объект не содержится в оси или у оси y нет единиц измерения, возвращается y.

draw(self, renderer) [source]

Отрисовать объект Artist (и его дочерние элементы) с помощью заданного рендерера.

Это не имеет эффекта, если объект не виден (Artist.get_visible возвращает False).

Параметры:	`rendererRendererBase subclass.`

Замечания

Этот метод переопределяется в подклассах Artist.

findobj(self, match=None, include_self=True)

Найти объекты artist.

Рекурсивно найти все Artist экземпляры, содержащиеся в объекте.

Параметры:

match

Критерий фильтра для совпадений. Это может быть

None: вернуть все объекты, содержащиеся в объекте.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только объекты, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только объекты этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список, который нужно проверить на соответствие.

Возвращает:

list of Artist

format_cursor_data(self, data)

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами artist. Пользователь Matplotlib, скорее всего, не будет вызывать этот метод напрямую.

См. также

get_cursor_data

get_agg_filter(self): Возвращает функцию фильтра для использования с фильтром agg.

get_alpha(self): Возвращает значение alpha, используемое для смешивания — не поддерживается на всех бэкэндах.

get_animated(self): Возвращает, анимирован ли объект.

get_array(self): Возвращает массив данных.

get_capstyle(self)

get_children(self): Возвращает список дочерних элементов Artist этого Artist.

get_clim(self): Возвращает значения (мин, макс), которые сопоставляются с пределами цветовой карты.

get_clip_box(self): Возвращает clipbox.

get_clip_on(self): Возвращает, использует ли объект обрезку.

get_clip_path(self): Возвращает clip path.

get_cmap(self): Возвращает экземпляр Colormap.

get_contains(self)

[Устаревшее] Возвращает пользовательскую функцию проверки попадания в область, если она задана, или None.

См. также

set_contains

Примечания

Устарело начиная с версии 3.3.

get_cursor_data(self, event)

Возвращает данные курсора для заданного события.

Примечание

Этот метод предназначен для переопределения подклассами графических элементов. Пользователю Matplotlib, скорее всего, не нужно вызывать этот метод самостоятельно.

Данные курсора могут использоваться графическими элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.

Единственным текущим случаем использования является отображение значения z AxesImage в строке состояния окна графика во время перемещения мыши.

Параметры:	`eventmatplotlib.backend_bases.MouseEvent`

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

get_figure(self): Возвращает экземпляр Figure, к которому принадлежит графический элемент.

get_fill(self): Возвращает значение, определяющее, установлен ли залив.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

Возвращает логическое значение, True указывающее, включён ли графический элемент в расчёты компоновки.

Например, Руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self): Возвращает метку, используемую для этого графического элемента в легенде.

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_numsides(self) [source]

get_offset_position(self): [Устаревшее] Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования главного объекта, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования главного объекта, т.е. смещения задаются в координатах данных.

Примечания

Устарело начиная с версии 3.3.

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) [source]

get_sizes(self)

Возвращает размеры ('площади') элементов в коллекции.

Возвращает:	массив Площадь каждого элемента.

get_sketch_params(self)

Возвращает параметры наброска для объекта.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда волны, перпендикулярной исходной линии.
length: Длина волны вдоль линии.
randomness: Коэффициент масштабирования, влияющий на сжатие или расширение длины.

Возвращает None, если параметры наброска не были заданы.

get_snap(self)

Возвращает значение опции привязки.

См. set_snap для подробностей.

get_tightbbox(self, renderer)

Подобно Artist.get_window_extent, но включает любые обрезки.

Параметры:	`rendererRendererBase subclass` рендерер, который будет использоваться для рисования фигур (т.е. `fig.canvas.get_renderer()`)
Возвращает:	`Bbox` Охватывающая область (в пикселях координат изображения).

get_transform(self): Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine(self): Возвращает путь обрезки с применённой неаффинной частью преобразования и оставшейся аффинной частью преобразования.

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible(self): Возвращает значение видимости.

get_window_extent(self, renderer)

Получает область построения на осях в пространстве отображения.

Ширина и высота области построения неотрицательны.

Подклассы должны переопределять этот метод для включения в расчёт «плотной» области построения. По умолчанию возвращает пустую область построения в координатах 0, 0.

Будьте внимательны при использовании этой функции. Результаты не обновятся, если область построения объекта изменится. Область построения может меняться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера изображения или используемой области (как при сохранении изображения). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder(self): Возвращает z-порядок объекта.

have_units(self): Возвращает True, если единицы заданы на какой-либо оси.

is_transform_set(self)

Возвращает, имеет ли объект явно заданное преобразование.

Это True после вызова set_transform.

property mouseover

Если это свойство установлено в True, объект будет запрашиваться для получения пользовательских данных контекста, когда курсор мыши находится над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged(self)

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(self, mouseevent)

Обрабатывает событие выбора.

Каждый дочерний объект будет генерировать событие выбора, если mouseevent находится над объектом и для объекта установлено свойство picker.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, доступен ли объект для выбора.

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств объекта.

remove(self)

Удаляет объект из фигуры, если это возможно.

Эффект не будет виден, пока фигура не будет перерисована, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim, чтобы обновить пределы осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта.

remove_callback(self, oid)

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

set(self, **kwargs): Установщик свойств в пакетном режиме. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Устанавливает фильтр agg.

Параметры:	`filter_funccallable` Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi и возвращает массив float (m, n, 3).

set_alpha(self, alpha)

Устанавливает значение альфа-канала для смешивания - не поддерживается во всех бэкендах.

Параметры:	`alphafloat or None`

set_animated(self, b)

Установить состояние анимации объекта.

Параметры:	`bbool`

set_antialiased(self, aa)

Установить состояние сглаживания при отрисовке.

Параметры:	`aabool or list of bools`

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображений из массива NumPy A.

Параметры:	`Andarray`

set_capstyle(self, cs)

Установить стиль закругления для коллекции (для всех её элементов).

Параметры:	`cs{'butt', 'round', 'projecting'}` Стиль закругления.

set_clim(self, vmin=None, vmax=None)

Установить пределы нормы для масштабирования изображения.

Параметры:	`vmin, vmaxfloat` Пределы. Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(self, clipbox)

Установить область обрезки объекта Bbox.

Параметры:	`clipboxBbox`

set_clip_on(self, b)

Установить, использует ли объект обрезку.

При значении False объекты будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

Установить путь обрезки объекта.

Параметры:

pathPatch or Path or TransformedPath or None: Путь обрезки. Если задан Path, то transform должен быть задан также. Если None, ранее установленный путь обрезки удаляется.
transformTransform, optional: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит область обрезки соответствующему прямоугольнику и установит путь обрезки в None.

По техническим причинам (поддержка set), в качестве единственного позиционного параметра также принимается кортеж (path, transform).

set_cmap(self, cmap)

Установить карту цветов для данных яркости.

Параметры:	`cmapColormap or str or None`

set_color(self, c)

Установить и цвет границы, и цвет заливки.

Параметры:	`ccolor or list of rgba tuples`

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для самостоятельной установки цвета границы или заливки.

set_contains(self, picker)

[Устарело] Определить пользовательскую проверку включения для объекта.

Предоставленная вызываемая функция заменяет стандартный метод contains объекта.

Параметры:

pickercallable

Пользовательская функция проверки нажатия для оценки, находится ли событие внутри объекта. Функция должна иметь сигнатуру:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

булево значение, указывающее, находится ли событие внутри объекта
словарь дополнительной информации. Словарь должен по крайней мере возвращать ту же информацию, что и стандартная реализация contains() соответствующего объекта, но может предоставлять дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Установить цвет(ы) границы коллекции.

Параметры:	`ccolor or list of colors or 'face'` Цвет(ы) границы коллекции. Если последовательность, фигуры циклически проходят по ней. Если 'face', соответствует цвету заливки.

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

Установить цвет(ы) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет), или последовательностью цветов; если это последовательность, фигуры будут циклически проходить по последовательности.

Если c равно 'none', фигура не будет заполнена.

Параметры:	`ccolor or list of colors`

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

Установите экземпляр Figure, к которому принадлежит объект.

Параметры:	`figFigure`

set_gid(self, gid)

Установите идентификатор (группы) для объекта.

Параметры:	`gidstr`

set_hatch(self, hatch)

Установите узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

Параметры:	`hatch{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}`

set_in_layout(self, in_layout)

Установите, нужно ли включать объект в вычисления макета, например, в Руководстве по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

Установите стиль соединения для набора (для всех его элементов).

Параметры:	`js{'miter', 'round', 'bevel'}` Стиль соединения.

set_label(self, s)

Установите метку, которая будет отображаться в легенде.

Параметры:	`sobject` s будет преобразован в строку с помощью вызова `str`.

set_linestyle(self, ls)

Установите стиль(и) линии для набора.

linestyle	описание
`'-'` or `'solid'`	сплошная линия
`'--'` or `'dashed'`	пунктирная линия
`'-.'` or `'dashdot'`	штрихпунктирная линия
`':'` or `'dotted'`	пунктирная линия

В качестве альтернативы можно указать кортеж с данными штриховки в следующем формате:

(offset, onoffseq),

где onoffseq - кортеж чётной длины включения и выключения чернил в пунктах.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См. `Line2D.set_linestyle` для полного описания.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Установите толщину линии(ей) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, фигуры будут циклически проходить через последовательность

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установите экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если существуют какие-либо цветные шкалы, использующие отображаемый объект для этой нормализации, установка нормализации отображаемого объекта сбросит нормализацию, локатор и форматировщики на цветовой шкале по умолчанию.

set_offset_position(self, offset_position)

[Устарело] Укажите, как применяются смещения. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования родительской системы координат, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования родительской системы координат, т. е. смещения задаются в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Установите смещения для набора.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

set_path_effects(self, path_effects)

Установите эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self)

set_picker(self, picker)

Определите поведение выбора для элемента.

Параметры:

pickerNone or bool or callable

Это может быть одно из следующего:

None: Выбор отключён для этого элемента (по умолчанию).
Булево значение: Если True, то выбор включён, и элемент сгенерирует событие выбора, если курсор находится над ним.
Функция: Если picker является вызываемым объектом, это пользовательская функция, которая определяет, попадает ли элемент под курсор:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания в область. Если курсор находится над элементом, верните hit=True и props — словарь свойств, которые нужно добавить к атрибутам события выбора.
Deprecated: Только для Line2D, picker также может быть числом с плавающей точкой, устанавливающим допуск для проверки, произошло ли событие «над» линией; это устарело. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Установите радиус выбора, используемый для тестов на содержание.

Параметры:	`dfloat` Радиус выбора в пунктах.

set_rasterized(self, rasterized)

Принудительно выполнить растровое (битовое) отображение в выходных данных векторного бэкэнда.

По умолчанию значение None, что подразумевает стандартное поведение бэкэнда.

Параметры:	`rasterizedbool or None`

set_sizes(self, sizes, dpi=72.0)

Установите размеры каждого элемента коллекции.

Параметры:	`sizesndarray or None` Размер для каждого элемента коллекции. Значение равно площади элемента. `dpifloat, default: 72` Точки на дюйм (dpi) холста.

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:

scalefloat, optional: Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или параметр не предоставлен, фильтр наброска не будет использован.
lengthfloat, optional: Длина колебаний вдоль линии в пикселях (по умолчанию 128.0).
randomnessfloat, optional: Множитель масштаба, на который длина уменьшается или увеличивается (по умолчанию 16.0).

set_snap(self, snap)

Установите поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в двух соседних пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что результирующее изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:	`snapbool or None` Возможные значения: True: Привязка вершин к центру ближайшего пикселя. False: Не изменять позиции вершин. None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя.

set_transform(self, t)

Установите преобразование элемента.

Параметры:	`tTransform`

set_url(self, url)

Установите URL для элемента.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(self, b)

Установите видимость элемента.

Параметры:	`bbool`

set_zorder(self, level)

Установите z-порядок элемента. Элементы с более низкими значениями z-порядка отрисовываются первыми.

Параметры:	`levelfloat`

property stale: Является ли элемент «недействительным» и нуждается ли он в повторной отрисовке, чтобы выходные данные соответствовали внутреннему состоянию элемента.

property sticky_edges

x и y списки привязанных границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то не добавляется отступ — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где, как правило, ожидается отсутствие отступа по нижнему краю (0) гистограммы.

К этому атрибуту нельзя присваивать значение; однако списки x и y можно изменять непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(self, x, alpha=None, bytes=False, norm=True)

Возвращает массив rgba, соответствующий значению x.

В обычном случае x — одномерная или двумерная последовательность чисел, и соответствующий массив 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.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Копировать свойства из других в себя.

update_scalarmappable(self): Обновить цвета из массива отображения скаляра, если он не равен None.

zorder = 0

class matplotlib.collections.StarPolygonCollection(numsides, rotation=0, sizes=1, **kwargs) [source]

Bases: matplotlib.collections.RegularPolyCollection

Отображает коллекцию правильных звезд с numsides вершинами.

Параметры:	`numsidesint` Количество сторон многоугольника. `rotationfloat` Поворот многоугольника в радианах. `sizestuple of float` Площадь окружности, описанной около многоугольника, в единицах измерения точек^2. **kwargs Передаются в `Collection`.

Примеры

См. Демонстрация Lasso для полного примера:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    transOffset=ax.transData,
    )

add_callback(self, func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Параметры:	`funccallable` Функция обратного вызова. Она должна иметь сигнатуру: def func(artist: Artist) -> Any где artist — вызываемый `Artist`. Возвращаемые значения могут существовать, но игнорируются.
Возвращает:	int Идентификатор наблюдателя, связанный с функцией обратного вызова. Этот идентификатор может быть использован для удаления обратного вызова с помощью `remove_callback` позднее.

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

autoscale(self): Автомасштабирует пределы скалярных значений в экземпляре нормы, используя текущий массив.

autoscale_None(self): Автомасштабирует пределы скалярных значений в экземпляре нормы, используя текущий массив, изменяя только пределы, равные None.

property axes: Экземпляр Axes, в котором находится элемент, или None.

changed(self): Вызывайте этот метод всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей обратного вызова о событии 'changed'.

check_update(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

contains(self, mouseevent)

Проверяет, произошла ли событие мыши внутри коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(self, x)

Преобразует x, используя тип единиц измерения оси x.

Если элемент не находится внутри оси или ось x не имеет единиц измерения, возвращается само значение x.

convert_yunits(self, y)

Преобразует y, используя тип единиц измерения оси y.

Если элемент не находится внутри оси или ось y не имеет единиц измерения, возвращается само значение y.

draw(self, renderer)

Отображает элемент (и его дочерние элементы) с помощью данного рендерера.

Не оказывает никакого эффекта, если элемент не виден (Artist.get_visible возвращает False).

Параметры:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределяется в подклассах элементов.

findobj(self, match=None, include_self=True)

Находит элементы.

Рекурсивно находит все Artist в элементе.

Параметры:

match

Критерий фильтрации совпадений. Может быть

None: Возвращает все элементы внутри элемента.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (isinstance проверка).

include_selfbool

Включать self в список для проверки совпадений.

Возвращает:

list of Artist

format_cursor_data(self, data)

Возвращает строковое представление data.

Примечание

В реализации по умолчанию целые и вещественные числа и массивы целых и вещественных чисел преобразуются в строку, разделенную запятыми, заключенную в квадратные скобки.

См. также

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): Возвращает значения (min, max), которые отображаются в пределы цветовой карты.

get_clip_box(self): Возвращает clipbox.

get_clip_on(self): Возвращает, использует ли элемент обрезку.

get_clip_path(self): Возвращает путь обрезки.

get_cmap(self): Возвращает экземпляр Colormap.

get_contains(self)

[Устаревшее] Возвращает пользовательскую функцию проверки попадания в элемент, если она задана, или None.

См. также

set_contains

Замечания

Устарело начиная с версии 3.3.

get_cursor_data(self, event)

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов графического интерфейса. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

Данные курсора могут использоваться элементами графического интерфейса для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Подклассы могут переопределять метод и возвращать произвольные данные. Однако при этом необходимо гарантировать, что format_cursor_data может преобразовать данные в строковое представление.

Параметры:	`eventmatplotlib.backend_bases.MouseEvent`

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

get_figure(self): Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill(self): Возвращает, установлена ли заливка.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий шаблон штриховки.

get_in_layout(self)

Возвращает логическое значение, True указывая, включён ли элемент в расчёт макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self): Возвращает метку, используемую для этого элемента в легенде.

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_numsides(self)

get_offset_position(self): [Устаревшее] Возвращает способ применения смещений для коллекции. Если offset_position равно 'screen', смещение применяется после применения трансформации родительского объекта, то есть смещения заданы в координатах экрана. Если offset_position равно 'data', смещение применяется до трансформации родительского объекта, то есть смещения заданы в координатах данных.

Замечания

Устарело начиная с версии 3.3.

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)

Возвращает размеры ('площади') элементов в коллекции.

Возвращает:	массив Площадь каждого элемента.

get_sketch_params(self)

Возвращает параметры наброска для объекта.

Возвращает:

кортеж или None

Кортеж из 3 элементов со следующим содержанием:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, по которому длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были заданы.

get_snap(self)

Возвращает значение параметра привязки.

Подробности см. в set_snap.

get_tightbbox(self, renderer)

Аналогично Artist.get_window_extent, но включает любой обрезку.

Параметры:	`rendererRendererBase subclass` рендерер, который будет использоваться для отрисовки графиков (т.е. `fig.canvas.get_renderer()`)
Возвращает:	`Bbox` Включающая ограничивающая рамка (в координатах пикселей изображения).

get_transform(self): Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine(self): Возвращает обрезку с применённой неаффинной частью её преобразования и оставшейся аффинной частью её преобразования.

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

Получает прямоугольник области построения в пространстве отображения.

Ширина и высота прямоугольника неотрицательны.

Подклассы должны переопределять этот метод для включения в вычисление «прилегающей» ограничивающей рамки. По умолчанию возвращается пустая ограничивающая рамка в 0, 0.

Будьте внимательны при использовании этой функции, результаты не будут обновлены, если размер окна объекта изменяется. Размер окна может измениться из-за любых изменений в стеке преобразования, таких как изменение пределов осей, размера изображения или используемого холста (как это делается при сохранении изображения). Это может привести к неожиданному поведению, когда интерактивные изображения будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder(self): Возвращает z-порядок объекта.

have_units(self): Возвращает True, если единицы установлены на любой оси.

is_transform_set(self)

Возвращает, имеет ли объект явно заданное преобразование.

Это True после вызова set_transform.

property mouseover

Если этот параметр установлен в True, объект будет запрошен для получения пользовательской информации о контексте, когда курсор мыши наведётся на него.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged(self)

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри, когда свойство изменяется.

См. также

add_callback
remove_callback

pick(self, mouseevent)

Обрабатывает событие выбора.

Каждый дочерний элемент объекта вызовет событие выбора, если mouseevent находится над объектом и у объекта задана возможность выбора.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, можно ли выбрать объект.

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств объекта.

remove(self)

Удаляет объект из изображения, если это возможно.

Эффект не будет виден до перерисовки изображения, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей при необходимости вызовите relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта.

remove_callback(self, oid)

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

set(self, **kwargs): Установщик свойств по частям. Передайте kwargs для установки свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Устанавливает фильтр agg.

Параметры:	`filter_funccallable` Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(self, alpha)

Устанавливает значение альфа, используемое для смешивания - не поддерживается во всех бэкендах.

Параметры:	`alphafloat or None`

set_animated(self, b)

Установить состояние анимации объекта.

Параметры:	`bbool`

set_antialiased(self, aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:	`aabool or list of bools`

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображения из массива numpy A.

Параметры:	`Andarray`

set_capstyle(self, cs)

Установить стиль обрезки для коллекции (для всех ее элементов).

Параметры:	`cs{'butt', 'round', 'projecting'}` Стиль обрезки.

set_clim(self, vmin=None, vmax=None)

Установить пределы нормы для масштабирования изображения.

Параметры:	`vmin, vmaxfloat` Пределы. Пределы также могут быть переданы в виде кортежа (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(self, clipbox)

Установить область обрезки объекта Bbox.

Параметры:	`clipboxBbox`

set_clip_on(self, b)

Установить, использует ли объект обрезку.

Если значение False, объекты будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

Установить путь обрезки объекта.

Параметры:

pathPatch or Path or TransformedPath or None: Путь обрезки. Если задан Path, необходимо также указать transform. Если None, ранее установленный путь обрезки удаляется.
transformTransform, optional: Используется только в случае, если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

set_cmap(self, cmap)

Установить цветовую карту для данных яркости.

Параметры:	`cmapColormap or str or None`

set_color(self, c)

Установить и цвет обводки, и цвет заливки.

Параметры:	`ccolor or list of rgba tuples`

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета обводки или заливки индивидуально.

set_contains(self, picker)

[Устаревшее] Определить пользовательскую проверку для определения принадлежности объекта.

Предоставленная вызываемая функция заменяет метод contains по умолчанию объекта.

Параметры:

pickercallable

Пользовательская функция выбора для проверки, находится ли событие внутри объекта. Функция должна иметь следующий вид:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

что возвращает:

логическое значение, указывающее, находится ли событие внутри объекта
словарь дополнительной информации. Словарь должен возвращать по крайней мере ту же информацию, что и реализация contains() по умолчанию для соответствующего объекта, но может предоставлять дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Установить цвет(ы) обводки коллекции.

Параметры:	`ccolor or list of colors or 'face'` Цвет(ы) обводки коллекции. Если последовательность, фигуры циклически используют ее. Если 'face', сопоставить цвет заливки.

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

Установить цвет(ы) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать ее.

Если c равно 'none', фигура не будет закрашена.

Параметры:	`ccolor or list of colors`

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

Установить экземпляр Figure, к которому принадлежит элемент.

Параметры:	`figFigure`

set_gid(self, gid)

Установить идентификатор (группы) для элемента.

Параметры:	`gidstr`

set_hatch(self, hatch)

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут комбинироваться, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, плотность штриховки этого узора увеличивается.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg бэкендах.

Параметры:	`hatch{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}`

set_in_layout(self, in_layout)

Установить, включать ли элемент в вычисления макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

Установить стиль соединения для набора (для всех его элементов).

Параметры:	`js{'miter', 'round', 'bevel'}` Стиль соединения.

set_label(self, s)

Установить метку, которая будет отображаться в легенде.

Параметры:	`sobject` s будет преобразовано в строку с помощью вызова `str`.

set_linestyle(self, ls)

Установить стиль линии(ей) для коллекции.

linestyle	описание
`'-'` or `'solid'`	сплошная линия
`'--'` or `'dashed'`	штриховая линия
`'-.'` or `'dashdot'`	пунктирно-штриховая линия
`':'` or `'dotted'`	штриховая линия

В качестве альтернативы можно указать кортеж с штрихами следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий отрезки в точках.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность вкл/выкл)}. См. `Line2D.set_linestyle` для полного описания.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Установить толщину линии(ей) для коллекции. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности.

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установить экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если существуют какие-либо цветовые шкалы, использующие карту отображения для этой нормализации, установка нормализации карты отображения сбросит нормализацию, локатор и форматеры на цветовой шкале по умолчанию.

set_offset_position(self, offset_position)

[Устарело] Установить, как применяются смещения. Если offset_position равно 'screen' (по умолчанию), смещение применяется после применения преобразования мастера, то есть смещения находятся в координатах экрана. Если offset_position равно 'data', смещение применяется до преобразования мастера, т.е. смещения находятся в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Установить смещения для коллекции.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

set_path_effects(self, path_effects)

Установить эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self)

set_picker(self, picker)

Определение поведения выбора элемента.

Параметры:

pickerNone or bool or callable

Это может быть одно из следующих значений:

None: Выбор отключён для этого элемента (по умолчанию).
Булево значение: Если True, выбор включён, и при наведении курсора на элемент, будет сгенерировано событие выбора.
Функция: Если picker является вызываемой функцией, это пользовательская функция, которая определяет, попал ли курсор по элементу:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания курсора. Если курсор находится над элементом, вернуть hit=True и props—словарь свойств, которые нужно добавить в атрибуты PickEvent.
устаревшее: Только для Line2D, picker также может быть числом с плавающей запятой, устанавливающим допуск для проверки того, произошла ли «событие на» линии; это устаревшее значение. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Установить радиус выбора, используемый для проверок попадания.

Параметры:	`dfloat` Радиус выбора в пунктах.

set_rasterized(self, rasterized)

Принудительное растровое (битовое) отображение в выходных данных векторного бэкенда.

По умолчанию None, что подразумевает поведение по умолчанию бэкенда.

Параметры:	`rasterizedbool or None`

set_sizes(self, sizes, dpi=72.0)

Установить размеры каждого элемента коллекции.

Параметры:	`sizesndarray or None` Размер, который нужно установить для каждого элемента коллекции. Значение — 'площадь' элемента. `dpifloat, default: 72` Dpi холста.

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:

scalefloat, optional: Амплитуда колебания перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применён.
lengthfloat, optional: Длина колебания вдоль линии в пикселях (по умолчанию 128.0).
randomnessfloat, optional: Коэффициент масштабирования, на который длина уменьшается или увеличивается (по умолчанию 16.0).

set_snap(self, snap)

Настройка поведения привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым цветом в обоих соседних пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что результирующее изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:	`snapbool or None` Возможные значения: True: Привязка вершин к ближайшему центру пикселя. False: Не изменять позиции вершин. None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя.

set_transform(self, t)

Установить преобразование элемента.

Параметры:	`tTransform`

set_url(self, url)

Установить URL для элемента.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(self, b)

Установить видимость элемента.

Параметры:	`bbool`

set_zorder(self, level)

Установить z-порядок элемента. Элементы с меньшими значениями zorder рисуются первыми.

Параметры:	`levelfloat`

property stale: Является ли элемент 'неактуальным' и требует ли повторной отрисовки, чтобы вывод соответствовал внутреннему состоянию элемента.

property sticky_edges

x и y списки привязанных границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен—предел представления «прилипает» к краю. Типичный пример использования — гистограммы, где обычно ожидается отсутствие отступа по нижнему краю (0) гистограммы.

Этому атрибуту нельзя назначать значения; однако списки x и y могут быть изменены по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(self, x, alpha=None, bytes=False, norm=True)

Возвращает массив rgba, соответствующий x.

В стандартном случае, x—это одномерная или двумерная последовательность скаляров, и возвращается соответствующий массив rgba, на основе нормы и цветовой карты, установленных для этого ScalarMappable.

Существует один специальный случай, для обработки изображений, которые уже являются rgb или rgba, например, прочитанными из файла изображения. Если x—это массив ndarray с тремя измерениями, и последнее измерение равно 3 или 4, он будет рассматриваться как rgb или rgba массив, и отображение не будет выполнено. Массив может быть uint8 или число с плавающей запятой со значениями в диапазоне 0-1; в противном случае будет возбуждено исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, значение alpha игнорируется; оно не заменяет существующую прозрачность. ValueError будет возбуждено, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет иметь значения с плавающей запятой в диапазоне 0-1; если True, массив rgba будет uint8 в диапазоне от 0 до 255.

update(self, props)

Обновить свойства этого элемента из словаря props.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Копировать свойства из other в self.

update_scalarmappable(self): Обновить цвета из массива скалярной отображаемой функции, если он не None.

zorder = 0

class matplotlib.collections.TriMesh(triangulation, **kwargs) [source]

Bases: matplotlib.collections.Collection

Класс для эффективного рисования треугольной сетки с использованием затенения Гуро.

Треугольная сетка — это объект Triangulation.

Параметры:

edgecolorscolor or list of colors, default: rcParams["patch.edgecolor"] (default: 'black')

Цвет границы для каждого фрагмента, составляющего коллекцию. Специальное значение 'face' может быть передано для соответствия цвета границы цвету заливки.

facecolorscolor or list of colors, default: rcParams["patch.facecolor"] (default: 'C0')

Цвет заливки для каждого фрагмента, составляющего коллекцию.

linewidthsfloat or list of floats, default: rcParams["patch.linewidth"] (default: 1.0)

Ширина линии для каждого фрагмента, составляющего коллекцию.

linestylesstr or tuple or list thereof, default: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штриховки должны иметь вид:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий длины включения и выключения чернил в пунктах. Примеры см. на странице Стили линий.

capstylestr, default: rcParams["patch.capstyle"]

Стиль окончания линии для всех путей в коллекции. См. Стиль соединения и окончания для демонстрации допустимых значений.

joinstylestr, default: rcParams["patch.joinstyle"]

Стиль соединения линий для всех путей в коллекции. См. Стиль соединения и окончания для демонстрации допустимых значений.

antialiasedsbool or list of bool, default: rcParams["patch.antialiased"] (default: True)

Требуется ли рисовать каждый фрагмент коллекции с сглаживанием.

offsets(float, float) or list thereof, default: (0, 0)

Вектор, на который нужно сдвинуть каждый фрагмент после отрисовки (по умолчанию сдвига нет). Сдвиг выполняется в экранных (пиксельных) координатах (т.е. после применения преобразования Artist).

transOffsetTransform, default: IdentityTransform

Единственное преобразование, которое будет применено к каждому вектору offsets перед его использованием.

offset_position{'screen' (default), 'data' (deprecated)}

Если установлено в 'data' (устарело), offsets будет обрабатываться как если бы он был в координатах данных, а не экранных координатах.

normNormalize, optional

Передаётся в ScalarMappable. Значение по умолчанию None означает, что при первом вызове отрисовки vmin и vmax будут установлены с использованием минимальных и максимальных значений данных.

cmapColormap, optional

Передаётся в ScalarMappable. Значение по умолчанию None приведёт к использованию rcParams["image.cmap"] (по умолчанию: 'viridis') .

hatchstr, optional

Шаблон штриховки для заполненных путей, если таковые имеются. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. См. Демонстрация штриховки для значения каждого типа штриховки.

pickradiusfloat, default: 5.0

Если pickradius <= 0, то Collection.contains вернёт True всякий раз, когда точка проверки находится внутри одного из многоугольников, образованных контрольными точками пути в коллекции. С другой стороны, если оно больше 0, то мы вместо этого проверяем, находится ли тестовая точка внутри штриха шириной 2*pickradius по любому из путей в коллекции.

urlslist of str, default: None

URL для каждого фрагмента, который будет связаны при отрисовке. В настоящее время работает только для SVG-бэкенда. См. Гиперссылки для примеров.

zorderfloat, default: 1

Порядок отрисовки, общие для всех фрагментов в коллекции. См. Демонстрация порядка отрисовки для всех значений по умолчанию и примеров.

add_callback(self, func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется свойство одного из элементов Artist.

Параметры:	`funccallable` Функция обратного вызова. Она должна иметь следующий вид: def func(artist: Artist) -> Any где artist — вызывающий `Artist`. Возвращаемые значения могут существовать, но игнорируются.
Возвращает:	int Идентификатор наблюдателя, связанный с функцией обратного вызова. Этот идентификатор может быть использован для удаления обратного вызова с помощью `remove_callback` позже.

См. также

remove_callback

add_checker(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

autoscale(self): Автоматически масштабировать пределы скаляров в экземпляре нормы, используя текущий массив

autoscale_None(self): Автоматически масштабировать пределы скаляров в экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None

property axes: Экземпляр Axes, в котором находится элемент, или None.

changed(self): Вызывается при изменении отображаемого объекта, чтобы уведомить все слушатели обратного вызова о сигнале 'changed'.

check_update(self, checker): [Устарело]

Примечания

Устарело начиная с версии 3.3:

contains(self, mouseevent)

Проверить, произошла ли обработка события мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

static convert_mesh_to_paths(tri) [source]

Преобразовать заданную сетку в последовательность объектов Path.

Эта функция в основном полезна для разработчиков бэкендов, которые не поддерживают сетки напрямую.

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), это не имеет никакого эффекта.

Параметры:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределяется в подклассах элементов.

END_OF_DOCUMENT_MARKER

findobj(self, match=None, include_self=True)

Найти объекты художников.

Рекурсивно найти все экземпляры Artist, содержащиеся в художнике.

Параметры:

match

Критерий фильтра для совпадений. Это может быть

None: Возвратить все объекты, содержащиеся в художнике.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только художников этого класса или его подклассов (isinstance проверка).

include_selfbool

Включить self в список для проверки на соответствие.

Возвращает:

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): Возвращает значения (мин, макс), которые отображаются в пределах цветовой карты.

get_clip_box(self): Возвращает область обрезки.

get_clip_on(self): Возвращает, использует ли художник обрезку.

get_clip_path(self): Возвращает путь обрезки.

get_cmap(self): Возвращает экземпляр Colormap.

get_contains(self)

[Устаревший] Возвращает пользовательскую функцию contains художника, если она задана, или None.

См. также

set_contains

Примечания

Устарело начиная с версии 3.3.

get_cursor_data(self, event)

Возвращает данные курсора для данного события.

Примечание

Подклассы могут переопределить метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что format_cursor_data может преобразовать данные в строковое представление.

Параметры:	`eventmatplotlib.backend_bases.MouseEvent`

См. также

format_cursor_data

get_dashes(self): Псевдоним для get_linestyle.

get_datalim(self, transData)

get_ec(self): Псевдоним для get_edgecolor.

get_edgecolor(self)

get_edgecolors(self): Псевдоним для get_edgecolor.

get_facecolor(self)

get_facecolors(self): Псевдоним для get_facecolor.

get_fc(self): Псевдоним для get_facecolor.

get_figure(self): Возвращает экземпляр Figure, к которому принадлежит художник.

get_fill(self): Возвращает, установлен ли fill.

get_gid(self): Возвращает идентификатор группы.

get_hatch(self): Возвращает текущий узор штриховки.

get_in_layout(self)

Возвращает логический флаг, True если художник включен в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle(self)

get_label(self): Возвращает метку, используемую для этого художника в легенде.

get_linestyle(self)

get_linestyles(self): Псевдоним для get_linestyle.

get_linewidth(self)

get_linewidths(self): Псевдоним для get_linewidth.

get_ls(self): Псевдоним для get_linestyle.

get_lw(self): Псевдоним для get_linewidth.

get_offset_position(self): [Устаревшее] Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения основного преобразования, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до основного преобразования, то есть смещения задаются в координатах данных.

Примечания

Устарело начиная с версии 3.3.

get_offset_transform(self)

get_offsets(self): Возвращает смещения для коллекции.

get_path_effects(self)

get_paths(self) [source]

get_picker(self)

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius(self)

get_rasterized(self): Возвращает, должен ли элемент быть растрирован.

get_sketch_params(self)

Возвращает параметры рисования контуров.

Возвращает:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.

Возвращает None, если параметры рисования контуров не были установлены.

get_snap(self)

Возвращает настройку привязки.

Подробности см. в set_snap.

get_tightbbox(self, renderer)

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры:	`rendererRendererBase subclass` рендерер, который будет использоваться для рисования фигур (т.е. `fig.canvas.get_renderer()`)
Возвращает:	`Bbox` Охватывающая область (в пикселях изображения).

get_transform(self): Возвращает объект Transform, используемый этим элементом.

get_transformed_clip_path_and_affine(self): Возвращает обрезной путь с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms(self)

get_url(self): Возвращает URL.

get_urls(self)

Возвращает список URL-адресов, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible(self): Возвращает видимость.

get_window_extent(self, renderer)

Получает прямоугольник области осей в пространстве отображения.

Ширина и высота прямоугольника неотрицательны.

Подклассы должны переопределять для включения в вычисление прямоугольника "tight". По умолчанию возвращается пустой прямоугольник в точке 0, 0.

Будьте внимательны при использовании этой функции, результаты не будут обновлены, если изменится область отображения элемента. Область отображения может измениться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или используемой области рисования (как делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder(self): Возвращает z-порядок элемента.

have_units(self): Возвращает True, если на любой оси установлены единицы.

is_transform_set(self)

Возвращает, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

property mouseover

Если этот параметр установлен в True, элемент будет запрашиваться для получения пользовательской контекстной информации при перемещении курсора мыши по нему.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged(self)

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(self, mouseevent)

Обрабатывает событие выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом и для элемента установлен picker.

См. также

set_picker, get_picker, pickable

pickable(self)

Возвращает, может ли элемент быть выбранным.

См. также

set_picker, get_picker, pick

properties(self): Возвращает словарь всех свойств элемента.

remove(self)

Удалить графический объект с фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей, при необходимости, вызовите relim.

Примечание: relim не будет видеть коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды графического объекта.

remove_callback(self, oid)

Удалить обработчик событий на основе его идентификатора наблюдателя.

См. также

add_callback

set(self, **kwargs): Метод для пакетного изменения свойств. Передайте kwargs для изменения свойств.

set_aa(self, aa): Псевдоним для set_antialiased.

set_agg_filter(self, filter_func)

Установить фильтр agg.

Параметры:	`filter_funccallable` Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(self, alpha)

Установить значение альфа для смешения цветов - не поддерживается всеми бэкендами.

Параметры:	`alphafloat or None`

set_animated(self, b)

Установить состояние анимации графического объекта.

Параметры:	`bbool`

set_antialiased(self, aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:	`aabool or list of bools`

set_antialiaseds(self, aa): Псевдоним для set_antialiased.

set_array(self, A)

Установить массив изображений из массива numpy A.

Параметры:	`Andarray`

set_capstyle(self, cs)

Установить стиль закругления для коллекции (для всех её элементов).

Параметры:	`cs{'butt', 'round', 'projecting'}` Стиль закругления.

set_clim(self, vmin=None, vmax=None)

Установить пределы нормы для масштабирования изображения.

Параметры:	`vmin, vmaxfloat` Пределы. Пределы также могут быть переданы как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(self, clipbox)

Установить область обрезки графического объекта.

Параметры:	`clipboxBbox`

set_clip_on(self, b)

Установить, использует ли графический объект обрезку.

Когда False, графические объекты будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:	`bbool`

set_clip_path(self, path, transform=None)

Установить область обрезки графического объекта.

Параметры:

pathPatch or Path or TransformedPath or None: Область обрезки. Если задан Path, transform также должен быть задан. Если None, ранее установленная область обрезки удаляется.
transformTransform, optional: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и установит область обрезки в None.

set_cmap(self, cmap)

Установить цветовую карту для данных светимости.

Параметры:	`cmapColormap or str or None`

set_color(self, c)

Установить цвет границы и заливки.

Параметры:	`ccolor or list of rgba tuples`

См. также

Collection.set_facecolor, Collection.set_edgecolor: Для установки цвета границы или заливки отдельно.

set_contains(self, picker)

[Устаревшее] Определить пользовательское тестирование принадлежности для графического объекта.

Предоставленная функция заменяет метод contains графического объекта по умолчанию.

Параметры:

pickercallable

Пользовательская функция для проверки, находится ли событие внутри графического объекта. Функция должна иметь следующий синтаксис:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

которая возвращает:

булево значение, указывающее, находится ли событие внутри графического объекта
словарь дополнительной информации. Словарь должен возвращать по крайней мере ту же информацию, что и реализация по умолчанию contains() соответствующего графического объекта, но может предоставлять дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_dashes(self, ls): Псевдоним для set_linestyle.

set_ec(self, c): Псевдоним для set_edgecolor.

set_edgecolor(self, c)

Установить цвет(цвета) обводки коллекции.

Параметры:	`ccolor or list of colors or 'face'` Цвет(цвета) обводки коллекции. Если это последовательность, фигуры будут циклически использовать цвета из неё. Если 'face', то цвет совпадёт с цветом заливки.

set_edgecolors(self, c): Псевдоним для set_edgecolor.

set_facecolor(self, c)

Установить цвет(цвета) заливки коллекции. c может быть цветом (все фигуры имеют один цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать цвета из неё.

Если c равно 'none', фигуры не будут заливаться.

Параметры:	`ccolor or list of colors`

set_facecolors(self, c): Псевдоним для set_facecolor.

set_fc(self, c): Псевдоним для set_facecolor.

set_figure(self, fig)

Установить экземпляр Figure, к которому принадлежит объект.

Параметры:	`figFigure`

set_gid(self, gid)

Установить идентификатор (группы) для объекта.

Параметры:	`gidstr`

set_hatch(self, hatch)

Установить узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бэкендах.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всей коллекции в целом, а не для каждого элемента по отдельности.

Параметры:	`hatch{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}`

set_in_layout(self, in_layout)

Установить, должен ли объект включаться в вычисления макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:	`in_layoutbool`

set_joinstyle(self, js)

Установить стиль соединения для коллекции (для всех её элементов).

Параметры:	`js{'miter', 'round', 'bevel'}` Стиль соединения.

set_label(self, s)

Установить метку, которая будет отображаться в легенде.

Параметры:	`sobject` s будет преобразовано в строку с помощью вызова `str`.

set_linestyle(self, ls)

Установить стиль(стили) линии для коллекции.

linestyle	описание
`'-'` или `'solid'`	сплошная линия
`'--'` или `'dashed'`	штриховая линия
`'-.'` или `'dashdot'`	пунктирная линия
`':'` или `'dotted'`	точечная линия

В качестве альтернативы можно указать кортеж делений (dash tuple) следующего вида:

(offset, onoffseq),

где onoffseq — это кортеж чётной длины точек включения и выключения чернил в пунктах.

Параметры:	`lsstr or tuple or list thereof` Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См. `Line2D.set_linestyle` для полного описания.

set_linestyles(self, ls): Псевдоним для set_linestyle.

set_linewidth(self, lw)

Установить ширину(ширины) линии(линий) для коллекции. lw может быть скалярным или последовательностью; если это последовательность, фигуры будут циклически использовать значения из неё.

Параметры:	`lwfloat or list of floats`

set_linewidths(self, lw): Псевдоним для set_linewidth.

set_ls(self, ls): Псевдоним для set_linestyle.

set_lw(self, lw): Псевдоним для set_linewidth.

set_norm(self, norm)

Установить экземпляр нормализации.

Параметры:	`normNormalize or None`

Примечания

Если какие-либо цветовые шкалы используют карту отображения для этой нормализации, установка нормализации для отображаемой карты сбросит нормализацию, локаторы и форматы цветовой шкалы по умолчанию.

set_offset_position(self, offset_position)

[Устаревшее] Установить, как применяются смещения. Если offset_position равно 'screen' (по умолчанию), смещение применяется после применения основного преобразования, то есть смещения заданы в координатах экрана. Если offset_position равно 'data', смещение применяется перед основным преобразованием, т. е. смещения заданы в координатах данных.

Параметры:	`offset_position{'screen', 'data'}`

Примечания

Устарело начиная с версии 3.3.

set_offsets(self, offsets)

Установить смещения для коллекции.

Параметры:	`offsetsarray-like (N, 2) or (2,)`

END_OF_DOCUMENT_MARKER

set_path_effects(self, path_effects)

Установить эффекты пути.

Параметры:	`path_effectsAbstractPathEffect`

set_paths(self) [source]

set_picker(self, picker)

Определить поведение выбора элемента.

Параметры:

pickerNone or bool or callable

Это может быть одно из следующих:

None: Выбор отключен для этого элемента (по умолчанию).
Булево значение: Если True, выбор будет включён, и элемент будет генерировать событие выбора, если курсор находится над ним.
Функция: Если picker вызываемая, это пользовательская функция, определяющая, попадает ли элемент под курсор мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения попадания. Если курсор мыши находится над элементом, вернуть hit=True и props — словарь свойств, которые нужно добавить к атрибутам события выбора.
Устаревшее: Только для Line2D, picker также может быть числом с плавающей точкой, устанавливающим допуск для проверки, произошло ли событие «над» линией; это устаревшее значение. Используйте Line2D.set_pickradius вместо этого.

set_pickradius(self, pr)

Установить радиус выбора, используемый для проверок попадания.

Параметры:	`dfloat` Радиус выбора, в пунктах.

set_rasterized(self, rasterized)

Принудительно растрировать (отображать в растровом формате) при выводе в векторном формате.

По умолчанию None, что подразумевает стандартное поведение для используемого бэкенда.

Параметры:	`rasterizedbool or None`

set_sketch_params(self, scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:

scalefloat, optional: Амплитуда колебаний перпендикулярно исходной линии, в пикселях. Если scale None или не указан, фильтр наброска не будет применён.
lengthfloat, optional: Длина колебания вдоль линии, в пикселях (по умолчанию 128.0).
randomnessfloat, optional: Коэффициент масштабирования, на который уменьшается или увеличивается длина (по умолчанию 16.0).

set_snap(self, snap)

Установить поведение привязки.

Привязка выравнивает позиции с пиксельным сеткой, что приводит к более чётким изображениям. Например, если была определена чёрная линия шириной 1 пиксель в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в обоих смежных позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool or None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять положения вершин.
None: (авто) Если путь содержит только прямолинейные сегменты, округлить до ближайшего центра пикселя.

set_transform(self, t)

Установить преобразование элемента.

Параметры:	`tTransform`

set_url(self, url)

Установить URL для элемента.

Параметры:	`urlstr`

set_urls(self, urls)

Параметры:	`urlslist of str or None`

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(self, b)

Установить видимость элемента.

Параметры:	`bbool`

set_zorder(self, level)

Установить z-порядок элемента. Элементы с меньшими значениями z-порядка рисуются первыми.

Параметры:	`levelfloat`

property stale: Является ли элемент «недействительным» и требует перерисовки, чтобы вывод соответствовал внутреннему состоянию элемента.

property sticky_edges

x и y списки привязанных краёв для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, тогда не будет добавлен марж — предел просмотра «прилипает» к краю. Типичный пример — гистограммы, где обычно не ожидается марж на нижнем крае (0) гистограммы.

К этому атрибуту нельзя присвоить значение; тем не менее, списки x и y можно изменять непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(self, x, alpha=None, bytes=False, norm=True)

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x — одномерная или двумерная последовательность скаляров, и соответствующий массив значений rgba будет возвращён, на основе нормы и цветовой карты, заданной для этого объекта ScalarMappable.

Есть один специальный случай для обработки изображений, которые уже являются rgb или rgba, таких, которые, возможно, были прочитаны из файла изображения. Если x — массив с тремя измерениями, и последнее измерение — 3 или 4, он будет обрабатываться как массив rgb или rgba, и никакое отображение не будет выполнено. Массив может быть uint8 или числом с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение — 3, параметр alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение — 4, параметр alpha игнорируется; он не заменяет существующую прозрачность. Будет поднято исключение ValueError, если третье измерение не равно 3 или 4.

В любом случае, если bytes — False (по умолчанию), массив rgba будет числами с плавающей точкой в диапазоне 0-1; если True, возвращённый массив rgba будет uint8 в диапазоне от 0 до 255.

update(self, props)

Обновить свойства этого элемента из словаря props.

Параметры:	`propsdict`

property update_dict

update_from(self, other): Скопировать свойства из other в self.

update_scalarmappable(self): Обновить цвета из массива отображения скаляров, если он не равен None.

zorder = 0