Spec-Zone.ru › Matplotlib 3.0

Сборки

Inheritance diagram of matplotlib.collections

matplotlib.collections

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

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

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

Bases: matplotlib.collections.RegularPolyCollection

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

numsides
число сторон многоугольника
rotation
угол поворота многоугольника в радианах
sizes

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

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

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

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

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

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

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

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

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

Возвращает id, который полезен для удаления обратного вызова с помощью remove_callback() позже.

add_checker(checker)

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

aname = 'Artist'
autoscale()

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

autoscale_None()

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

axes

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

changed()

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

check_update(checker)

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

contains(mouseevent)

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

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

convert_xunits(x)

Для элементов в axes, если ось x поддерживает единицы измерения, преобразует x с помощью типа единиц оси x

convert_yunits(y)

Для элементов в axes, если ось y поддерживает единицы измерения, преобразует y с помощью типа единиц оси y

draw(renderer)

Метод отрисовки производных классов

findobj(match=None, include_self=True)

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

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

match может быть

  • None: возвращает все объекты, содержащиеся в артисте.
  • функция с сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляр класса: например, Line2D. Возвращает только артистов указанного класса.

Если include_self True (по умолчанию), включает себя в список для проверки совпадения.

format_cursor_data(data)

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

get_agg_filter()

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

get_alpha()

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

get_animated()

Возвращает состояние анимации элемента-артиста

get_array()

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

get_capstyle()
get_children()

Возвращает список дочерних элементов Artist`s this :class:`Artist.

get_clim()

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

get_clip_box()

Возвращает область обрезки элемента-артиста

get_clip_on()

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

get_clip_path()

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

get_cmap()

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

get_contains()

Возвращает тест _contains, используемый элементом-артистом, или None для значения по умолчанию.

get_cursor_data(event)

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

get_dashes(*args, **kwargs)

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

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

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

get_facecolor()
get_facecolors(*args, **kwargs)

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

get_figure()

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

get_fill()

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

get_gid()

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

get_hatch()

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

get_in_layout()

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

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

get_joinstyle()
get_label()

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

get_linestyle()
get_linestyles(*args, **kwargs)

псевдоним для get_linestyle

get_linewidth()
get_linewidths(*args, **kwargs)

псевдоним для get_linewidth

get_lw(*args, **kwargs)

псевдоним для get_linewidth

get_numsides()
get_offset_position()

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

get_offset_transform()
get_offsets()

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

get_path_effects()
get_paths()
get_picker()

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

get_pickradius()
get_rasterized()

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

get_rotation()
get_sizes()

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

Возвращает:
sizes : array

«Площадь» каждого элемента.

get_sketch_params()

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

Возвращает:
sketch_params : tuple or None

Кортеж из 3 элементов с следующими значениями:

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

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

get_snap()

Возвращает параметр «привязка», который может быть:

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

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

get_tightbbox(renderer)

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

Параметры:
renderer : RendererBase instance

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

Возвращает:
bbox : BboxBase

содержащий рамку (в пикселях фигуры).

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms()
get_url()

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

get_urls()
get_visible()

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

get_window_extent(renderer)

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

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

get_zorder()

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

have_units()

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

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов объекта, содержащих событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure is not None

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

is_transform_set()

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

mouseover
pchanged()

Вызывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

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

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

pickable()

Возвращает True, если Artist выбирается.

properties()

возвращает словарь, сопоставляющий имя свойства -> значение для всех свойств объекта.

remove()

Если возможно, удаляет объект из фигуры. Эффект не будет виден до перерисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim() для обновления пределов осей, если это необходимо.

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

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

remove_callback(oid)

Удалить обработчик событий на основе его id.

См. также

add_callback()
Для добавления обработчиков событий
set(**kwargs)

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

set_agg_filter(filter_func)

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

Параметры:
filter_func : callable

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

set_alpha(alpha)

Установить альфа-прозрачность коллекции. alpha должно быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

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

Параметры:
b : bool
set_antialiased(aa)

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

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

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

set_array(A)

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

Параметры:
A : ndarray
set_capstyle(cs)

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

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль обрезки

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

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

Параметры:
clipbox : Bbox
set_clip_on(b)

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

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

Параметры:
b : bool
set_clip_path(path, transform=None)

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

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

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

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

set_cmap(cmap)

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

Параметры:
cmap : colormap or registered colormap name
set_color(c)

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

См. также

set_facecolor(), set_edgecolor()
Для установки цвета границы или заливки по отдельности.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

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

hit, props = picker(artist, mouseevent)

Если курсор мыши находится над объектом, вернуть hit = True и props — словарь свойств, которые вы хотите вернуть с тестом на попадание.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

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

set_edgecolor(c)

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

Если c равно 'face', цвет границы всегда будет таким же, как цвет заливки. Если это 'none', граница области не будет нарисована.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

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

set_facecolor(c)

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

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

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

псевдоним для set_facecolor

set_figure(fig)

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

Параметры:
fig : Figure
set_gid(gid)

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

Параметры:
gid : str
set_hatch(hatch)

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

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

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

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

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

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

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

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

Параметры:
in_layout : bool
set_joinstyle(js)

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

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку для автоматической легенды.

Параметры:
s : object

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

set_linestyle(ls)

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

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

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

(offset, onoffseq),

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

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

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

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

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

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

Параметры:
norm : Normalize
set_offset_position(offset_position)

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

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установить смещения для набора. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

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

Параметры:
path_effects : AbstractPathEffect
set_paths()
set_picker(picker)

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

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

  • None: выбор для этого элемента графического объекта отключён (по умолчанию)
  • Булево значение: если True, то выбор будет включён, и элемент графического объекта будет генерировать событие выбора, если событие мыши попадает на него
  • Число с плавающей точкой: если picker является числом, оно интерпретируется как значение допуска в пунктах, и элемент графического объекта будет генерировать событие, если его данные находятся в пределах допуска от события мыши. Для некоторых графических объектов, таких как линии и коллекции фигур, графический объект может предоставлять дополнительные данные для события выбора, например, индексы данных в пределах допуска от события выбора
  • Функция: если picker является вызываемой функцией, это пользовательская функция, которая определяет, попадает ли событие мыши на графический объект:

    hit, props = picker(artist, mouseevent)
    

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

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

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

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

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

set_rasterized(rasterized)

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

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

Параметры:
rasterized : bool or None
set_sizes(sizes, dpi=72.0)

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

Параметры:
sizes : ndarray or None

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

dpi : float

DPI холста. По умолчанию 72.0.

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

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

Параметры:
scale : float, optional

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

length : float, optional

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

randomness : float, optional

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

set_snap(snap)

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

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

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

Параметры:
snap : bool or None
set_transform(t)

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

Параметры:
t : Transform
set_url(url)

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

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_visible(b)

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

Параметры:
b : bool
set_zorder(level)

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

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

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

sticky_edges

x и y списки привязанных к краю.

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

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

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)

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

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

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

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

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

update(props)

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

update_from(other)

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

update_scalarmappable()

Если массив скалярной карты не равен None, обновляет цвета по данным скаляров.

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

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

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

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

ymin, ywidth

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

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

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

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

add_callback(func)

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

Возвращает id, полезный для удаления обратного вызова с помощью remove_callback() позже.

add_checker(checker)

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

aname = 'Artist'
autoscale()

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

autoscale_None()

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

axes

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

changed()

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

check_update(checker)

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

contains(mouseevent)

Проверка, произошёл ли сдвиг мыши в коллекции.

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

convert_xunits(x)

Для элементов в осях, если ось x поддерживает единицы, преобразовать x с помощью типа единиц оси x

convert_yunits(y)

Для элементов в осях, если ось y поддерживает единицы, преобразовать y с помощью типа единиц оси y

draw(renderer)

Метод отрисовки производных классов

findobj(match=None, include_self=True)

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

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

match может быть

  • None: вернуть все объекты, содержащиеся в элементе.
  • функция с подписью boolean = match(artist) для фильтрации совпадений
  • экземпляр класса: например, Line2D. Вернуть только элементы графики указанного класса.

Если include_self равно True (по умолчанию), включить self в список для проверки на соответствие.

format_cursor_data(data)

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

get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_array()

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

get_capstyle()
get_children()

Возвращает список дочерних элементов Artist`s this :class:`Artist.

get_clim()

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

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_cmap()

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

get_contains()

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

get_cursor_data(event)

Получить данные курсора для заданного события.

get_dashes(*args, **kwargs)

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

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

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

get_facecolor()
get_facecolors(*args, **kwargs)

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

get_figure()

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

get_fill()

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

get_gid()

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

get_hatch()

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

get_in_layout()

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

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

get_joinstyle()
get_label()

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

get_linestyle()
get_linestyles(*args, **kwargs)

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

get_linewidth()
get_linewidths(*args, **kwargs)

псевдоним для get_linewidth

get_lw(*args, **kwargs)

псевдоним для get_linewidth

get_offset_position()

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

get_offset_transform()
get_offsets()

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

get_path_effects()
get_paths()
get_picker()

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

get_pickradius()
get_rasterized()

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

get_sizes()

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

Возвращает:
sizes : array

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

get_sketch_params()

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

Возвращает:
sketch_params : tuple or None

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

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

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

get_snap()

Возвращает настройку привязки, которая может быть:

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

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

get_tightbbox(renderer)

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

Параметры:
renderer : RendererBase instance

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

Возвращает:
bbox : BboxBase

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

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms()
get_url()

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

get_urls()
get_visible()

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

get_window_extent(renderer)

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

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

get_zorder()

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

have_units()

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

hitlist(event)

Устарело с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов элемента, которые содержат событие мыши event.

is_figure_set()

Устарело с версии 2.2: artist.figure is not None

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

is_transform_set()

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

mouseover
pchanged()

Вызывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

Обработка события пика

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

pickable()

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

properties()

Возвращает словарь, сопоставляющий имя свойства -> значение для всех свойств элемента.

remove()

Удаляет элемент из фигуры, если это возможно. Эффект будет виден только после перерисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim(), чтобы обновить пределы осей, если это необходимо.

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

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

remove_callback(oid)

Удаляет обратный вызов по его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

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

set_agg_filter(filter_func)

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

Параметры:
filter_func : callable

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

set_alpha(alpha)

Установите прозрачность альфа-канала коллекции. alpha должно быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

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

Параметры:
b : bool
set_antialiased(aa)

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

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

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

set_array(A)

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

Параметры:
A : ndarray
set_capstyle(cs)

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

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль обрезки

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

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

Параметры:
clipbox : Bbox
set_clip_on(b)

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

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

Параметры:
b : bool
set_clip_path(path, transform=None)

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

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

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

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

set_cmap(cmap)

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

Параметры:
cmap : colormap or registered colormap name
set_color(c)

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

См. также

set_facecolor(), set_edgecolor()
Для установки цвета границы или заливки индивидуально.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

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

hit, props = picker(artist, mouseevent)

Если событие мыши находится над объектом, вернуть hit = True, и props — словарь свойств, которые вы хотите вернуть вместе с тестом принадлежности.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

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

set_edgecolor(c)

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

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

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

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

set_facecolor(c)

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

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

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

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

set_figure(fig)

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

Параметры:
fig : Figure
set_gid(gid)

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

Параметры:
gid : str
set_hatch(hatch)

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

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

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

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

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

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

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

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

Параметры:
in_layout : bool
set_joinstyle(js)

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

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку в s для автоматической легенды.

Параметры:
s : object

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

set_linestyle(ls)

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

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

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

(offset, onoffseq),

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

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

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

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

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

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

Параметры:
norm : Normalize
set_offset_position(offset_position)

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

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установить смещения для набора. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

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

Параметры:
path_effects : AbstractPathEffect
set_paths(verts, closed=True)

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

set_picker(picker)

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

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

  • None: выбор отключен для этого графического объекта (по умолчанию)
  • Булевое значение: если True, то выбор будет включен, и графический объект будет генерировать событие выбора, если курсор находится над ним
  • Вещественное число: если picker — число, оно интерпретируется как допуск эпсилон в пунктах, и графический объект будет генерировать событие, если его данные находятся в пределах эпсилон от события мыши. Для некоторых графических объектов, таких как линии и наборы графических объектов, графический объект может предоставлять дополнительные данные событию выбора, например, индексы данных, находящиеся в пределах эпсилон от события выбора
  • Функция: если picker — вызываемый объект, это функция пользователя, которая определяет, попадает ли графический объект под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения проверки попадания. Если курсор находится над графическим объектом, вернуть hit=True и props — словарь свойств, которые нужно добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

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

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

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

set_rasterized(rasterized)

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

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

Параметры:
rasterized : bool or None
set_sizes(sizes, dpi=72.0)

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

Параметры:
sizes : ndarray or None

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

dpi : float

dpi холста. По умолчанию равно 72.0.

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

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

Параметры:
scale : float, optional

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

length : float, optional

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

randomness : float, optional

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

set_snap(snap)

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

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

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

Параметры:
snap : bool or None
set_transform(t)

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

Параметры:
t : Transform
set_url(url)

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

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_verts(verts, closed=True)

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

set_verts_and_codes(verts, codes)

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

set_visible(b)

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

Параметры:
b : bool
set_zorder(level)

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

Параметры:
level : float
static span_where(x, ymin, ymax, where, **kwargs) [source]

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

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

stale

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

sticky_edges

x и y списки привязанных кромки.

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

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

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)

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

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

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

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

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

update(props)

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

update_from(other)

Копирует свойства из других в себя

update_scalarmappable()

Если массив скалярного сопоставления не равен None, обновляет цвета из скалярных данных

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

Базы: matplotlib.collections._CollectionWithSizes

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

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

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

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

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

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

add_callback(func)

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

Возвращает id, полезный для удаления обратного вызова с помощью remove_callback() позднее.

add_checker(checker)

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

aname = 'Artist'
autoscale()

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

autoscale_None()

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

axes

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

changed()

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

check_update(checker)

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

contains(mouseevent)

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

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

convert_xunits(x)

Для элементов-художников в осях, если ось x поддерживает единицы измерения, преобразует x, используя тип единицы измерения оси x.

convert_yunits(y)

Для элементов-художников в осях, если ось y поддерживает единицы измерения, преобразует y, используя тип единицы измерения оси y.

draw(renderer)

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

findobj(match=None, include_self=True)

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

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

match может быть

  • None: вернуть все объекты, содержащиеся в художнике.
  • функция с сигнатурой boolean = match(artist) для фильтрации совпадений.
  • экземпляр класса: например, Line2D. Вернуть только художников указанного типа.

Если include_self равно True (по умолчанию), включить self в список для проверки соответствия.

format_cursor_data(data)

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

get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_array()

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

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist.

get_clim()

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

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_cmap()

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

get_contains()

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

get_cursor_data(event)

Получить данные курсора для заданного события.

get_dashes(*args, **kwargs)

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

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

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

get_facecolor()
get_facecolors(*args, **kwargs)

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

get_figure()

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

get_fill()

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

get_gid()

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

get_hatch()

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

get_in_layout()

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

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

get_joinstyle()
get_label()

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

get_linestyle()
get_linestyles(*args, **kwargs)

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

get_linewidth()
get_linewidths(*args, **kwargs)

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

get_lw(*args, **kwargs)

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

END_OF_DOCUMENT_MARKER
get_offset_position()

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

get_offset_transform()
get_offsets()

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

get_path_effects()
get_paths()
get_picker()

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

get_pickradius()
get_rasterized()

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

get_sizes()

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

Возвращает:
sizes : array

'Площадь' каждого элемента.

get_sketch_params()

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

Возвращает:
sketch_params : tuple or None

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

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

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

get_snap()

Возвращает настройку привязки, которая может быть:

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

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

get_tightbbox(renderer)

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

Параметры:
renderer : RendererBase instance

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

Возвращает:
bbox : BboxBase

содержащий прямоугольник ограничивающей рамки (в пикселях фигуры).

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms()
get_url()

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

get_urls()
get_visible()

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

get_window_extent(renderer)

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

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

get_zorder()

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

have_units()

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

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов графического элемента, которые содержат событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure не равно None

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

is_transform_set()

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

mouseover
pchanged()

Вызывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

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

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

pickable()

Возвращает True, если Artist подлежит выбору.

properties()

возвращает словарь, сопоставляющий имя свойства -> значение для всех свойств Artist.

remove()

Удаляет элемент из фигуры, если это возможно. Эффект будет виден только после перерисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim(), чтобы обновить пределы осей, если необходимо.

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

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

remove_callback(oid)

Удаляет обратный вызов по его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

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

set_agg_filter(filter_func)

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

Параметры:
filter_func : callable

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

set_alpha(alpha)

Устанавливает альфа-прозрачность коллекции. alpha должно быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

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

Параметры:
b : bool
set_antialiased(aa)

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

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

псевдоним для set_antialiased

set_array(A)

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

Параметры:
A : ndarray
set_capstyle(cs)

Установить стиль окончания отрезка для коллекции. Стиль окончания можно задавать только глобально для всех элементов коллекции.

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль окончания

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

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

Параметры:
clipbox : Bbox
set_clip_on(b)

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

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

Параметры:
b : bool
set_clip_path(path, transform=None)

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

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

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

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

set_cmap(cmap)

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

Параметры:
cmap : colormap or registered colormap name
set_color(c)

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

См. также

set_facecolor(), set_edgecolor()
Для отдельной установки цвета границы или заливки.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

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

hit, props = picker(artist, mouseevent)

Если указание мыши находится над элементом, вернуть hit = True и props — словарь свойств, которые вы хотите вернуть с тестом принадлежности.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

псевдоним для set_linestyle

set_edgecolor(c)

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

Если c — 'face', цвет границы всегда будет таким же, как цвет заливки. Если это 'none', граница области не будет отрисовываться.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

псевдоним для set_edgecolor

set_facecolor(c)

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

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

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

псевдоним для set_facecolor

set_figure(fig)

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

Параметры:
fig : Figure
set_gid(gid)

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

Параметры:
gid : str
END_OF_DOCUMENT_MARKER
set_hatch(hatch)

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

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

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

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

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

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

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

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

Параметры:
in_layout : bool
set_joinstyle(js)

Установить стиль соединения для коллекции. Стиль соединения может быть установлен только глобально для всех элементов коллекции.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку в s для автоматической легенды.

Параметры:
s : object

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

set_linestyle(ls)

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

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

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

(offset, onoffseq),

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

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

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

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

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

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

Параметры:
norm : Normalize
set_offset_position(offset_position)

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

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установить смещения для коллекции. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

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

Параметры:
path_effects : AbstractPathEffect
set_paths()
set_picker(picker)

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

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

  • None: выбор отключён для этого элемента (по умолчанию)
  • Логическое значение: если True, то выбор будет включён, и элемент сгенерирует событие выбора, если курсор мыши находится над элементом
  • Число с плавающей запятой: если picker — число, оно интерпретируется как погрешность в точках, и элемент сгенерирует событие, если данные находятся в пределах погрешности от события мыши. Для некоторых элементов, таких как линии и коллекции областей, элемент может предоставить дополнительные данные событию выбора, например, индексы данных в пределах погрешности от события выбора
  • Функция: если picker — вызываемая функция, это функция, предоставляемая пользователем, которая определяет, попадает ли элемент под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

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

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

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

set_rasterized(rasterized)

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

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

Параметры:
rasterized : bool or None
set_sizes(sizes, dpi=72.0)

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

Параметры:
sizes : ndarray or None

Размер, который нужно установить для каждого элемента коллекции. Значение — "площадь" элемента.

dpi : float

Точки на дюйм холста. По умолчанию 72.0.

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

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

Параметры:
scale : float, optional

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

length : float, optional

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

randomness : float, optional

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

set_snap(snap)

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

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

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

Параметры:
snap : bool or None
set_transform(t)

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

Параметры:
t : Transform
set_url(url)

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

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_visible(b)

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

Параметры:
b : bool
set_zorder(level)

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

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

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

sticky_edges

x и y списки приклеенных границ.

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

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

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)

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

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

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

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

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

update(props)

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

update_from(other)

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

update_scalarmappable()

Если массив скалярного отображаемого объекта не равен None, обновляет цвета из скалярных данных.

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

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

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

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

prop[i % len(props)]

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

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

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

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

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

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

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

%(Collection)s

add_callback(func)

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

Возвращает id, которое полезно для удаления обратного вызова с помощью remove_callback() позднее.

add_checker(checker)

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

aname = 'Artist'
autoscale()

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

autoscale_None()

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

axes

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

changed()

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

check_update(checker)

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

contains(mouseevent) [source]

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

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

convert_xunits(x)

Для элементов на оси, если ось x поддерживает единицы измерения, преобразовать x с использованием типа единиц оси x

convert_yunits(y)

Для элементов на оси, если ось y поддерживает единицы измерения, преобразовать y с использованием типа единиц оси y

draw(renderer) [source]

Метод отрисовки производных классов

findobj(match=None, include_self=True)

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

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

match может быть

  • None: вернуть все объекты, содержащиеся в элементе.
  • функцией с сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляром класса: например, Line2D. Возвращать только элементы типа класса.

Если include_self равно True (по умолчанию), включить self в список, который будет проверяться на соответствие.

format_cursor_data(data)

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

get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_array()

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

get_capstyle() [source]
get_children()

Возвращает список дочерних элементов, которые содержит Artist`s this :class:`Artist.

get_clim()

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

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_cmap()

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

get_contains()

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

get_cursor_data(event)

Получить данные курсора для заданного события.

get_dashes(*args, **kwargs)

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

get_datalim(transData) [source]
get_edgecolor() [source]
get_edgecolors(*args, **kwargs)

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

get_facecolor() [source]
get_facecolors(*args, **kwargs)

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

get_figure()

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

get_fill() [source]

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

END_OF_DOCUMENT_MARKER
get_gid()

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

get_hatch() [source]

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

get_in_layout()

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

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

get_joinstyle() [source]
get_label()

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

get_linestyle() [source]
get_linestyles(*args, **kwargs)

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

get_linewidth() [source]
get_linewidths(*args, **kwargs)

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

get_lw(*args, **kwargs)

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

get_offset_position() [source]

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

get_offset_transform() [source]
get_offsets() [source]

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

get_path_effects()
get_paths() [source]
get_picker()

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

get_pickradius() [source]
get_rasterized()

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

get_sketch_params()

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

Возвращает:
sketch_params : tuple or None

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

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

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

get_snap()

Возвращает параметр привязки, который может быть:

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

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

get_tightbbox(renderer)

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

Параметры:
renderer : RendererBase instance

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

Возвращает:
bbox : BboxBase

содержащий ограничивающую рамку (в пикселях рисунка).

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms() [source]
get_url()

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

get_urls() [source]
get_visible()

Возвращает видимость объекта-артиста.

get_window_extent(renderer) [source]

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

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

get_zorder()

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

have_units()

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

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов объекта-артиста, содержащих событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure is not None

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

is_transform_set()

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

mouseover
pchanged()

Вызвать событие при изменении свойства, вызвав все зарегистрированные обратные вызовы.

pick(mouseevent)

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

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

pickable()

Возвращает True, если Artist выбираем.

properties()

Возвращает словарь, сопоставляющий имя свойства со значением для всех свойств объекта Artist.

remove()

Удалить элемент-объект из рисунка, если это возможно. Эффект не будет виден до перерисовки рисунка, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim(), чтобы обновить пределы осей, если это необходимо.

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

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

remove_callback(oid)

Удаляет обратный вызов по его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

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

set_agg_filter(filter_func)

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

Параметры:
filter_func : callable

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

set_alpha(alpha) [source]

Установить альфа-прозрачность коллекции. alpha должен быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

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

Параметры:
b : bool
set_antialiased(aa) [source]

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

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

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

set_array(A)

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

Параметры:
A : ndarray
set_capstyle(cs) [source]

Установить стиль окончания для коллекции. Стиль окончания можно установить только глобально для всех элементов в коллекции.

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль окончания

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

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

Параметры:
clipbox : Bbox
set_clip_on(b)

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

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

Параметры:
b : bool
set_clip_path(path, transform=None)

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

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

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

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

set_cmap(cmap)

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

Параметры:
cmap : colormap or registered colormap name
set_color(c) [source]

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

См. также

set_facecolor(), set_edgecolor()
Для установки цвета границы или цвета заливки по отдельности.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

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

hit, props = picker(artist, mouseevent)

Если событие мыши находится над элементом-объектом, вернуть hit = True и props—это словарь свойств, которые вы хотите вернуть с результатом проверки содержимого.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

псевдоним для set_linestyle

set_edgecolor(c) [source]

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

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

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

псевдоним для set_edgecolor

set_facecolor(c) [source]

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

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

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

псевдоним для set_facecolor

set_figure(fig)

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

Параметры:
fig : Figure
set_gid(gid)

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

Параметры:
gid : str
set_hatch(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(in_layout)

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

Параметры:
in_layout : bool
set_joinstyle(js) [source]

Устанавливает стиль соединения для коллекции. Стиль соединения может быть установлен только глобально для всех элементов в коллекции.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Устанавливает метку на s для автоматической легенды.

Параметры:
s : object

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

set_linestyle(ls) [source]

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

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

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

(offset, onoffseq),

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

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

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw) [source]

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

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

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

Параметры:
norm : Normalize
set_offset_position(offset_position) [source]

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

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets) [source]

Установите смещения для коллекции. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

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

Параметры:
path_effects : AbstractPathEffect
set_paths() [source]
set_picker(picker)

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

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

  • None: выбор отключён для этого объекта (по умолчанию)
  • Булево значение: если True, выбор будет включён, и объект будет генерировать событие выбора, если указатель мыши находится над объектом
  • Число с плавающей точкой: если picker является числом, оно интерпретируется как толерантность эпсилон в точках, и объект будет генерировать событие, если его данные находятся в пределах эпсилон от события мыши. Для некоторых объектов, таких как линии и коллекции патчей, объект может предоставить дополнительные данные для события выбора, например, индексы данных в пределах эпсилон от события выбора
  • Функция: если picker является вызываемым объектом, это пользовательская функция, которая определяет, попадает ли объект под действие события мыши:

    hit, props = picker(artist, mouseevent)
    

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

Параметры:
picker : None or bool or float or callable
set_pickradius(pr) [source]

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

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

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

set_rasterized(rasterized)

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

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

Параметры:
rasterized : bool or None
set_sketch_params(scale=None, length=None, randomness=None)

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

Параметры:
scale : float, optional

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

length : float, optional

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

randomness : float, optional

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

set_snap(snap)

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

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

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

Параметры:
snap : bool or None
set_transform(t)

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

Параметры:
t : Transform
set_url(url)

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

Параметры:
url : str
set_urls(urls) [source]
Параметры:
urls : List[str] or None
set_visible(b)

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

Параметры:
b : bool
set_zorder(level)

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

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

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

sticky_edges

x и y списки прилипших границ.

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

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

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(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. Если третье измерение отличается от 3 или 4, будет поднята ошибка ValueError.

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

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

update(props)

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

update_from(other) [source]

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

update_scalarmappable() [source]

Если массив скалярного отображения не равен None, обновляет цвета из скалярных данных

zorder = 0
class matplotlib.collections.EllipseCollection(widths, heights, angles, units='points', **kwargs) [source]

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

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

Параметры:
widths : array-like

Длины первых осей (например, длины большой оси).

heights : array-like

Длины вторых осей.

angles : array-like

Углы первых осей, градусы против часовой стрелки от оси x.

units : {'points', 'inches', 'dots', 'width', 'height', 'x', 'y', 'xy'}

Единицы измерения больших и малых осей; 'width' и 'height' относятся к размерам осей, а 'x' и 'y' относятся к данным о смещениях. 'xy' отличается от всех остальных тем, что угол на графике изменяется в зависимости от соотношения сторон, и равен заданному углу только при соотношении сторон, равном единице. Таким образом, он ведет себя так же, как Ellipse с axes.transData в качестве своего преобразования.

Другие параметры:
**kwargs

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

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

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

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

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

add_callback(func)

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

Возвращает id, который полезен для удаления обратного вызова с помощью remove_callback() позже.

add_checker(checker)

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

aname = 'Artist'
autoscale()

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

autoscale_None()

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

axes

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

changed()

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

check_update(checker)

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

contains(mouseevent)

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

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

convert_xunits(x)

Для объектов в осях, если ось x поддерживает единицы, преобразует x с использованием типа единиц оси x

convert_yunits(y)

Для объектов на осях, если ось y поддерживает единицы, преобразует y с использованием типа единиц оси y

draw(renderer) [source]

Метод отрисовки производных классов

findobj(match=None, include_self=True)

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

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

match может быть

  • None: вернуть все объекты, содержащиеся в художнике.
  • функцией со сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляром класса: например, Line2D. Возвращать только художников указанного типа.

Если include_self равно True (по умолчанию), включить self в список для проверки совпадения.

format_cursor_data(data)

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

get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_array()

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

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist элементов.

get_clim()

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

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_cmap()

Возвращает палитру цветов.

get_contains()

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

get_cursor_data(event)

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

get_dashes(*args, **kwargs)

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

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

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

get_facecolor()
get_facecolors(*args, **kwargs)

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

get_figure()

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

get_fill()

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

get_gid()

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

get_hatch()

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

END_OF_DOCUMENT_MARKER
get_in_layout()

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

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

get_joinstyle()
get_label()

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

get_linestyle()
get_linestyles(*args, **kwargs)

псевдоним для get_linestyle

get_linewidth()
get_linewidths(*args, **kwargs)

псевдоним для get_linewidth

get_lw(*args, **kwargs)

псевдоним для get_linewidth

get_offset_position()

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

get_offset_transform()
get_offsets()

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

get_path_effects()
get_paths()
get_picker()

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

get_pickradius()
get_rasterized()

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

get_sketch_params()

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

Возвращает:
sketch_params : tuple or None

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

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

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

get_snap()

Возвращает настройку привязки, которая может быть:

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

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

get_tightbbox(renderer)

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

Параметры:
renderer : RendererBase instance

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

Возвращает:
bbox : BboxBase

содержащий рамку (в пикселях фигуры).

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms()
get_url()

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

get_urls()
get_visible()

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

get_window_extent(renderer)

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

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

get_zorder()

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

have_units()

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

hitlist(event)

Устаревшая с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов художника, которые содержат событие мыши event.

is_figure_set()

Устаревшая с версии 2.2: artist.figure не равно None

Возвращает, назначен ли художник Figure.

is_transform_set()

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

mouseover
pchanged()

Сгенерировать событие при изменении свойства, вызвав все зарегистрированные обработчики.

pick(mouseevent)

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

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

pickable()

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

properties()

возвращает словарь, сопоставляющий имя свойства -> значение для всех свойств художника

remove()

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

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

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

remove_callback(oid)

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

См. также

add_callback()
Для добавления обработчиков
set(**kwargs)

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

set_agg_filter(filter_func)

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

Параметры:
filter_func : callable

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

set_alpha(alpha)

Установить альфа-прозрачность коллекции. alpha должно быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

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

Параметры:
b : bool
set_antialiased(aa)

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

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

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

set_array(A)

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

Параметры:
A : ndarray
set_capstyle(cs)

Установить стиль окончания линии для коллекции. Стиль окончания линии может быть установлен только глобально для всех элементов в коллекции

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль окончания линии

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

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

Параметры:
clipbox : Bbox
set_clip_on(b)

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

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

Параметры:
b : bool
set_clip_path(path, transform=None)

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

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

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

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

set_cmap(cmap)

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

Параметры:
cmap : colormap or registered colormap name
set_color(c)

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

См. также

set_facecolor(), set_edgecolor()
Для отдельной установки цвета обводки или заливки.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

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

hit, props = picker(artist, mouseevent)

Если курсор мыши над объектом, вернуть hit = True и props — словарь свойств, которые нужно вернуть с тестом на попадание.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

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

set_edgecolor(c)

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

Если c — 'face', цвет обводки всегда будет таким же, как цвет заливки. Если это 'none', граница элемента не будет отрисовываться.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

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

set_facecolor(c)

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

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

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

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

set_figure(fig)

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

Параметры:
fig : Figure
set_gid(gid)

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

Параметры:
gid : str
set_hatch(hatch)

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

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

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

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

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

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

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

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

Параметры:
in_layout : bool
set_joinstyle(js)

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

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку на s для автоматической легенды.

Параметры:
s : object

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

set_linestyle(ls)

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

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

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

(offset, onoffseq),

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

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

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

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

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

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

Параметры:
norm : Normalize
set_offset_position(offset_position)

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

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установить смещения для набора. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

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

Параметры:
path_effects : AbstractPathEffect
set_paths()
set_picker(picker)

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

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

  • None: выбор отключен для данного элемента (по умолчанию)
  • Булево значение: если True, выбор включён, и элемент будет генерировать событие выбора, если курсор мыши находится над ним
  • Число с плавающей точкой: если picker — число, оно интерпретируется как толерантность epsilon в точках, и элемент будет генерировать событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых элементов, таких как линии и коллекции наборов фигуры, элемент может предоставить дополнительные данные событию выбора, например, индексы данных в пределах epsilon от события выбора
  • Функция: если picker — вызываемая функция, это функция, предоставленная пользователем, которая определяет, попадает ли элемент под действие события мыши:

    hit, props = picker(artist, mouseevent)
    

    чтобы определить проверку попадания. Если курсор мыши над элементом, верните hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

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

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

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

set_rasterized(rasterized)

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

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

Параметры:
rasterized : bool or None
set_sketch_params(scale=None, length=None, randomness=None)

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

Параметры:
scale : float, optional

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

length : float, optional

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

randomness : float, optional

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

set_snap(snap)

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

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

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

Параметры:
snap : bool or None
set_transform(t)

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

Параметры:
t : Transform
set_url(url)

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

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_visible(b)

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

Параметры:
b : bool
set_zorder(level)

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

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

Если художник «недействителен» и требует перерисовки для соответствия внутреннему состоянию художника.

sticky_edges

x и y списки прилипающих краёв.

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

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

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)

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

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

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

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

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

update(props)

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

update_from(other)

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

update_scalarmappable()

Если массив скалярной сопоставимости не равен None, обновить цвета из скалярных данных

zorder = 0
class matplotlib.collections.EventCollection(positions, orientation=None, lineoffset=0, linelength=1, linewidth=None, color=None, linestyle='solid', antialiased=None, **kwargs) [source]

Базы: matplotlib.collections.LineCollection

Коллекция дискретных событий.

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

Параметры:
positions : 1D array-like object

Каждое значение — это событие.

orientation : {None, 'horizontal', 'vertical'}, optional

Ориентация коллекции (полосы событий расположены вдоль ортогонального направления). По умолчанию 'горизонтальная', если не указано или равно None.

lineoffset : scalar, optional, default: 0

Смещение центра маркеров от начала координат в направлении, ортогональном ориентации.

linelength : scalar, optional, default: 1

Полная высота маркера (т.е. маркер простирается от lineoffset - linelength/2 до lineoffset + linelength/2).

linewidth : scalar or None, optional, default: None

Если None, по умолчанию используется значение из rcParams в последовательном формате.

color : color, sequence of colors or None, optional, default: None

Если None, по умолчанию используется значение из rcParams в последовательном формате.

linestyle : str or tuple, optional, default: 'solid'

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

(offset, onoffseq),

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

antialiased : {None, 1, 2}, optional

Если None, по умолчанию используется значение из rcParams в последовательном формате.

**kwargs : optional

Другие ключевые аргументы — свойства линии коллекции. См. LineCollection для списка допустимых свойств.

Примеры

(Исходный код, png, pdf)

../_images/eventcollection_demo.png
add_callback(func)

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

Возвращает id, который пригодится для удаления обратного вызова с помощью remove_callback() позднее.

add_checker(checker)

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

add_positions(position) [source]

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

aname = 'Artist'
append_positions(position)

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

autoscale()

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

autoscale_None()

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

axes

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

changed()

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

check_update(checker)

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

contains(mouseevent)

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

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

convert_xunits(x)

Для художников в осях, если ось x поддерживает единицы, преобразует x с использованием типа единиц оси x

convert_yunits(y)

Для художников в осях, если ось y поддерживает единицы, преобразует y с использованием типа единиц оси y

draw(renderer)

Метод отрисовки производных классов

extend_positions(position)

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

findobj(match=None, include_self=True)

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

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

match может быть

  • None: вернуть все объекты, содержащиеся в художнике.
  • функция с сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляр класса: например, Line2D. Возвращать только художников указанного класса.

Если include_self равно True (по умолчанию), включить self в список для проверки соответствия.

format_cursor_data(data)

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

get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_array()

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

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist.

get_clim()

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

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_cmap()

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

get_color() [source]

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

get_colors()
get_contains()

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

get_cursor_data(event)

Получение данных курсора для данного события.

get_dashes(*args, **kwargs)

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

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

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

get_facecolor()
get_facecolors(*args, **kwargs)

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

get_figure()

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

get_fill()

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

get_gid()

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

get_hatch()

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

get_in_layout()

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

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

get_joinstyle()
get_label()

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

get_linelength() [source]

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

get_lineoffset() [source]

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

get_linestyle()
get_linestyles(*args, **kwargs)

псевдоним для get_linestyle

get_linewidth() [source]

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

get_linewidths() [source]

псевдоним для get_linewidth

get_lw(*args, **kwargs)

псевдоним для get_linewidth

get_offset_position()

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

get_offset_transform()
get_offsets()

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

get_orientation() [source]

получает ориентацию линии события, может быть: [ 'горизонтально' | 'вертикально' ]

get_path_effects()
get_paths()
get_picker()

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

get_pickradius()
get_positions() [source]

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

get_rasterized()

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

get_segments()
Возвращает:
segments : list

Список отрезков в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()

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

Возвращает:
sketch_params : tuple or None

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

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

Может вернуть None, если параметры наброска не были установлены.

get_snap()

Возвращает значение snap, которое может быть:

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

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

get_tightbbox(renderer)

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

Параметры:
renderer : RendererBase instance

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

Возвращает:
bbox : BboxBase

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

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_transforms()
get_url()

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

get_urls()
get_visible()

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

get_window_extent(renderer)

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

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

get_zorder()

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

have_units()

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

END_OF_DOCUMENT_MARKER
hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов изображения, содержащих событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure не равно None

Возвращает, назначено ли изображение фигуре Figure.

is_horizontal() [source]

Истинно, если EventCollection горизонтален, ложно, если вертикален.

is_transform_set()

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

mouseover
pchanged()

Срабатывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

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

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

pickable()

Возвращает True, если Artist выбираем.

properties()

Возвращает словарь, сопоставляющий имя свойства -> значение для всех свойств объекта Artist.

remove()

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

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

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

remove_callback(oid)

Удаление обратного вызова по его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

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

set_agg_filter(filter_func)

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

Параметры:
filter_func : callable

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

set_alpha(alpha)

Установка прозрачности альфы коллекции. alpha должно быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

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

Параметры:
b : bool
set_antialiased(aa)

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

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

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

set_array(A)

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

Параметры:
A : ndarray
set_capstyle(cs)

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

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль окончания отрезков

set_clim(vmin=None, vmax=None)

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

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

set_clip_box(clipbox)

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

Параметры:
clipbox : Bbox
set_clip_on(b)

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

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

Параметры:
b : bool
set_clip_path(path, transform=None)

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

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

Для повышения эффективности, если путь оказывается прямоугольником, выровненным по осям, этот метод установит ограничивающую рамку соответствующему прямоугольнику и установит путь обрезки в None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(cmap)

установка цветовой карты для данных яркости

Параметры:
cmap : colormap or registered colormap name
set_color(c)

Устанавливает цвет(а) для LineCollection.

Параметры:
c :

Аргумент цвета Matplotlib (все области имеют одинаковый цвет) или последовательность или rgba кортежи; если это последовательность, области будут циклически проходить по последовательности.

set_contains(picker)

Замените тест принадлежности, используемый этим объектом. Новый пикер должен быть вызываемой функцией, которая определяет, попадает ли объект в область действия события мыши:

hit, props = picker(artist, mouseevent)

Если курсор мыши находится над объектом, верните hit = True, а props — словарь свойств, которые вы хотите получить с помощью теста принадлежности.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

псевдоним для set_linestyle

set_edgecolor(c)

Установите цвет(цвета) обводки коллекции. c может быть спецификацией цвета matplotlib (все фигуры имеют один и тот же цвет) или последовательностью спецификаций; если это последовательность, фигуры будут циклически перебирать последовательность.

Если c равно 'face', цвет обводки всегда будет таким же, как цвет заливки. Если это 'none', граница фигуры не будет нарисована.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

псевдоним для set_edgecolor

set_facecolor(c)

Установите цвет(цвета) заливки коллекции. c может быть спецификацией цвета matplotlib (все фигуры имеют один и тот же цвет) или последовательностью спецификаций; если это последовательность, фигуры будут циклически перебирать последовательность.

Если c равно 'none', фигура не будет закрашена.

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

псевдоним для set_facecolor

set_figure(fig)

Установите экземпляр Figure, к которому принадлежит объект.

Параметры:
fig : Figure
set_gid(gid)

Устанавливает идентификатор (группы) для объекта.

Параметры:
gid : str
set_hatch(hatch)

Устанавливает узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут комбинироваться, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого узора.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg backends.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно задать только для всей коллекции, а не для каждого элемента отдельно.

Параметры:
hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)

Установить, будет ли объект включен в вычисления макета, например, Руководство по макетам с ограничениями, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layout : bool
set_joinstyle(js)

Установить стиль соединения для коллекции. Стиль соединения можно задать только глобально для всех элементов в коллекции.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку в s для автоматической легенды.

Параметры:
s : object

s будет преобразовано в строку с помощью вызова str.

set_linelength(linelength) [source]

Установить длину линий, используемых для маркировки каждого события.

set_lineoffset(lineoffset) [source]

Установить смещение линий, используемых для маркировки каждого события.

set_linestyle(ls)

Установить стиль линии(линий) для коллекции.

стиль линии описание
'-' or 'solid' сплошная линия
'--' or 'dashed' пунктирная линия
'-.' or 'dashdot' штрих-пунктирная линия
':' or 'dotted' пунктирная линия

В качестве альтернативы можно предоставить кортеж с делениями в следующем формате:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий значения длины включения и выключения чернил в пунктах.

Параметры:
ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

Установить ширину линии(линий) для коллекции. lw может быть скалярным значением или последовательностью; если это последовательность, фигуры будут циклически перебирать последовательность.

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

Установить экземпляр нормализации.

Параметры:
norm : Normalize
set_offset_position(offset_position)

Указывает, как применяются смещения. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования родительской системы координат, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования родительской системы координат, то есть смещения задаются в координатах данных.

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Устанавливает смещения для коллекции. offsets может быть скалярным значением или последовательностью.

Параметры:
offsets : float or sequence of floats
set_orientation(orientation=None) [source]

Устанавливает ориентацию линии события [ 'горизонтальная' | 'вертикальная' | None ]. По умолчанию 'горизонтальная', если не указано или равно None.

set_path_effects(path_effects)

Устанавливает эффекты пути.

Параметры:
path_effects : AbstractPathEffect
set_paths(segments)
set_picker(picker)

Устанавливает эпсилон для выбора, используемый этим элементом.

picker может принимать следующие значения:

  • None: выбор отключён для этого элемента (по умолчанию)
  • Булево значение: если True, выбор включён, и элемент будет генерировать событие выбора, если курсор находится над ним
  • Число с плавающей точкой: если picker — число, оно интерпретируется как толерантность эпсилона в точках, и элемент будет генерировать событие выбора, если его данные находятся в пределах эпсилона от события мыши. Для некоторых элементов, таких как линии и коллекции объектов, элемент может предоставить дополнительные данные событию выбора, например, индексы данных, находящихся в пределах эпсилона от события выбора
  • Функция: если picker — вызываемая функция, она предоставляет пользователю функцию, определяющую, попадает ли элемент под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    чтобы определить проверку попадания. Если курсор находится над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

Устанавливает радиус выбора, используемый для проверок попадания.

Параметры:
d : float

Радиус выбора в точках.

set_positions(positions) [source]

Устанавливает позиции событий заданному значению.

set_rasterized(rasterized)

Принудительно задать растрированное (битовое) отображение в выходных данных векторного бэкенда.

По умолчанию None, что подразумевает поведение по умолчанию для бэкенда.

Параметры:
rasterized : bool or None
set_segments(segments)
set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:
scale : float, optional

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равно None, или не указано, фильтр наброска не будет предоставлен.

length : float, optional

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomness : float, optional

Коэффициент масштабирования, на который уменьшается или увеличивается длина (по умолчанию 16.0)

set_snap(snap)

Устанавливает настройку привязки, которая может быть:

  • True: привязывает вершины к центрам ближайших пикселей
  • False: оставляет вершины как есть
  • None: (авто) Если путь содержит только прямолинейные отрезки, округляет до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

Параметры:
snap : bool or None
set_transform(t)

Устанавливает преобразование элемента.

Параметры:
t : Transform
set_url(url)

Устанавливает URL для элемента.

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_verts(segments)
set_visible(b)

Устанавливает видимость элемента.

Параметры:
b : bool
set_zorder(level)

Устанавливает z-порядок элемента. Элементы с меньшими значениями z-порядка рисуются первыми.

Параметры:
level : float
stale

Если элемент «неактуален» и его нужно перерисовать, чтобы выходные данные соответствовали внутреннему состоянию элемента.

sticky_edges

x и y списки привязанных краев.

При выполнении автоматической настройки масштаба, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется - предел просмотра «прилипает» к краю. Типичное применение - гистограммы, где обычно не ожидается отступ по нижнему краю (0) гистограммы.

К этому атрибуту нельзя присвоить значение; однако, списки x и y можно изменять на месте по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
switch_orientation() [source]

переключить ориентацию линии события, либо с вертикальной на горизонтальную, либо наоборот

to_rgba(x, alpha=None, bytes=False, norm=True)

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий массив ndarray значений rgba будет возвращен на основе нормализации и цветовой карты, установленных для этого объекта ScalarMappable.

Существует один специальный случай для обработки изображений, которые уже являются rgb или rgba, например, такие, которые были прочитаны из файла изображения. Если x — это массив ndarray с тремя измерениями, а последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакое отображение не будет выполнено. Массив может быть uint8 или может быть с плавающей запятой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с пропусками, маска будет проигнорирована. Если последнее измерение равно 3, параметр alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет существующий альфа-канал. ValueError будет поднято, если третье измерение отличается от 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет числами с плавающей запятой в диапазоне 0-1; если это True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)

Обновляет свойства этого объекта-художника из словаря prop.

update_from(other)

Копирует свойства из other в self.

update_scalarmappable()

Если массив объекта отображения скаляров не равен 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

Все параметры должны быть последовательностями или скалярами; если скалярами, они будут преобразованы в последовательности. Свойство i-го отрезка линии:

prop[i % len(props)]

то есть, свойства циклически повторяются, если количество свойств len меньше, чем количество отрезков.

Параметры:
segments :

Последовательность (line0, line1, line2), где:

linen = (x0, y0), (x1, y1), ... (xm, ym)

или эквивалентная массив NumPy с двумя столбцами. Длина каждой линии может быть разной.

colors : sequence, optional

Последовательность кортежей RGBA (например, произвольные цветовые строки и т. д., не разрешены).

antialiaseds : sequence, optional

Последовательность единиц или нулей.

linestyles : string, tuple, optional

Любое из [ 'solid' | 'dashed' | 'dashdot' | 'dotted' ], или кортеж штрихов. Кортеж штрихов:

(offset, onoffseq)

где onoffseq — это кортеж чётной длины, содержащий значения включения и выключения чернил в пунктах.

norm : Normalize, optional

Normalize экземпляр.

cmap : string or Colormap, optional

Имя цветовой карты или Colormap экземпляр.

pickradius : float, optional

Допуск в пунктах для нажатия мышью на выбор линии. По умолчанию 5 пунктов.

zorder : int, optional

z-порядок LineCollection. По умолчанию 2.

facecolors : optional

Цвета заливки LineCollection. По умолчанию 'none'. Установка значения, отличного от 'none', приведёт к отрисовке заполненного многоугольника между точками на каждой линии.

Примечания

Если linewidths, colors или antialiaseds равно None, они по умолчанию устанавливаются в соответствии с настройками rcParams, в последовательном формате.

Если offsets и transOffset не равны None, то offsets преобразуются с помощью transOffset и применяются после преобразования отрезков в координаты отображения.

Если offsets не равно None, но transOffset равно None, то offsets добавляются к отрезкам до любого преобразования. В этом случае одиночное значение offsets может быть указано как:

offsets=(xo,yo)

и это значение будет кумулятивно добавляться к каждому последующему отрезку, чтобы получить набор последовательно смещённых кривых.

Использование ScalarMappable необязательно. Если массив ScalarMappable _A не равен None (то есть, был вызван set_array()), во время отрисовки будет сделан вызов скалярному отображаемому объекту для установки цветов.

add_callback(func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Возвращает id, который пригодится для удаления обратного вызова с помощью remove_callback() позже.

add_checker(checker)

Добавляет запись в словарь флагов boolean, которые устанавливаются в True, когда изменяется отображаемый объект.

aname = 'Artist'
autoscale()

Автоматически масштабирует пределы скалярных значений на экземпляре norm с использованием текущего массива

autoscale_None()

Автоматически масштабирует пределы скалярных значений на экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None

axes

Экземпляр Axes, в котором находится элемент, или None.

changed()

Вызывайте это всякий раз, когда отображаемый объект изменяется, чтобы уведомить всех слушателей обратного вызова 'changed' сигнала

check_update(checker)

Если отображаемый объект изменился с последней проверки, верните True; в противном случае верните False

contains(mouseevent)

Проверка, произошла ли событие мыши в коллекции.

Возвращает True | False, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)

Для элементов в осях, если ось x поддерживает единицы, преобразуйте x, используя тип единиц оси x

convert_yunits(y)

Для элементов в осях, если ось y поддерживает единицы, преобразуйте y, используя тип единиц оси y

draw(renderer)

Метод отрисовки производных классов

findobj(match=None, include_self=True)

Поиск объектов художника.

Рекурсивно находит все экземпляры Artist, содержащиеся в self.

match может быть

  • None: вернуть все объекты, содержащиеся в художнике.
  • функция со сигнатурой boolean = match(artist) используется для фильтрации совпадений
  • экземпляр класса: например, Line2D. Возвращать только художников заданного класса.

Если include_self равно True (по умолчанию), включить self в список для проверки соответствия.

format_cursor_data(data)

Возвращает строку данных курсора в отформатированном виде.

get_agg_filter()

Возвращает функцию фильтра, которая будет использоваться для фильтра agg.

get_alpha()

Возвращает значение альфа-канала, используемое для смешивания — не поддерживается всеми бэкендами

get_animated()

Возвращает состояние анимации элемента

get_array()

Возвращает массив

get_capstyle()
get_children()

Возвращает список дочерних элементов Artist`s this :class:`Artist.

get_clim()

Возвращает минимальное и максимальное значения пределов цвета для масштабирования изображения

get_clip_box()

Возвращает ограничивающую рамку элемента.

get_clip_on()

Возвращает, использует ли элемент обрезку.

get_clip_path()

Возвращает путь обрезки элемента.

get_cmap()

Возвращает цветовую карту.

get_color() [source]
get_colors()
get_contains()

Возвращает тест _contains, используемый элементом, или None для значения по умолчанию.

get_cursor_data(event)

Получение данных курсора для заданного события.

get_dashes(*args, **kwargs)

Псевдоним для get_linestyle

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

Псевдоним для get_edgecolor

get_facecolor()
get_facecolors(*args, **kwargs)

Псевдоним для get_facecolor

get_figure()

Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()

Возвращает, установлено ли заполнение.

get_gid()

Возвращает идентификатор группы.

get_hatch()

Возвращает текущий узор штриховки.

get_in_layout()

Возвращает логическое значение, True если элемент включён в расчёт макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()
get_label()

Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()
get_linestyles(*args, **kwargs)

Псевдоним для get_linestyle

get_linewidth()
get_linewidths(*args, **kwargs)

Псевдоним для get_linewidth

get_lw(*args, **kwargs)

Псевдоним для get_linewidth

get_offset_position()

Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения основного преобразования, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется до основного преобразования, то есть смещения находятся в координатах данных.

get_offset_transform()
get_offsets()

Возвращает смещения для коллекции.

get_path_effects()
get_paths()
get_picker()

Возвращает объект пикера, используемый этим элементом.

get_pickradius()
get_rasterized()

Возвращает, должен ли элемент быть растрированным.

get_segments() [source]
Возвращает:
segments : list

Список отрезков в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()

Возвращает параметры наброска для элемента.

Возвращает:
sketch_params : tuple or None

Кортеж из 3 элементов:

  • scale: Амплитуда колебаний перпендикулярно исходной линии.
  • length: Длина колебаний вдоль линии.
  • randomness: Коэффициент масштабирования, с которым длина уменьшается или увеличивается.

Может вернуть None, если параметры наброска не были установлены.

get_snap()

Возвращает значение параметра привязки, которое может быть:

  • True: привязывает вершины к центрам ближайших пикселей
  • False: оставляет вершины как есть
  • None: (автоматически) Если путь содержит только прямолинейные отрезки, округляет до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

get_tightbbox(renderer)

Как Artist.get_window_extent, но включает любое обрезание.

Параметры:
renderer : RendererBase instance

рендерер, который будет использоваться для рисования графиков (например, fig.canvas.get_renderer())

Возвращает:
bbox : BboxBase

содержащий область отображения (в пикселях фигуры).

get_transform()

Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()

Возвращает обрезной путь с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()
get_url()

Возвращает URL.

get_urls()
get_visible()

Возвращает видимость элемента.

get_window_extent(renderer)

Получает область отображения оси в пространстве отображения. Подклассы должны переопределять для включения в вычисление области отображения "tight". По умолчанию возвращается пустая область отображения в точке (0, 0).

Будьте осторожны при использовании этой функции. Результаты не обновляются, если область отображения элемента изменилась. Область отображения может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохраняться неправильно.

get_zorder()

Возвращает порядок элемента по z.

have_units()

Возвращает True, если единицы установлены на осях x или y

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов элемента, содержащих событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure is not None

Возвращает, назначен ли элемент Figure.

is_transform_set()

Возвращает True, если Artist имеет явно заданное преобразование.

mouseover
pchanged()

Вызывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

Обработка события выбора.

Каждый дочерний элемент будет вызывать событие выбора, если mouseevent находится над элементом, и у элемента установлен пикер.

pickable()

Возвращает True, если Artist можно выбрать.

properties()

возвращает словарь, сопоставляющий имя свойства -> значение для всех свойств объекта Artist

remove()

Удаляет объект из фигуры, если это возможно. Эффект не будет виден до повторной отрисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim() для обновления пределов осей, если это необходимо.

Примечание: relim() не будут видеть коллекции, даже если коллекция была добавлена ​​к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта.

remove_callback(oid)

Удаляет обратный вызов на основе его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

Функция для пакетного изменения свойств. Передайте kwargs для изменения свойств.

set_agg_filter(filter_func)

Установить фильтр agg.

Параметры:
filter_func : callable

Функция фильтра, которая принимает (m, n, 3) массив с плавающей запятой и значение dpi, и возвращает массив (m, n, 3).

set_alpha(alpha)

Установить прозрачность альфы коллекции. alpha должно быть числом с плавающей запятой или None.

Параметры:
alpha : float or None
set_animated(b)

Установить состояние анимации объекта.

Параметры:
b : bool
set_antialiased(aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

псевдоним для set_antialiased

set_array(A)

Установить массив изображений из массива NumPy A.

Параметры:
A : ndarray
set_capstyle(cs)

Установить стиль обрезки для коллекции. Стиль обрезки может быть задан только глобально для всех элементов коллекции

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль обрезки

set_clim(vmin=None, vmax=None)

установить пределы нормы для масштабирования изображения; если vmin является последовательностью длины 2, интерпретировать ее как (vmin, vmax), которое используется для поддержки setp

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей запятой; может быть переопределён в методах, имеющих vmin и vmax параметры.

set_clip_box(clipbox)

Установить область обрезки объекта Bbox.

Параметры:
clipbox : Bbox
set_clip_on(b)

Установить, использует ли объект обрезку.

При значении False объекты будут видны за пределами осей, что может привести к непредвиденным результатам.

Параметры:
b : bool
set_clip_path(path, transform=None)

Установить путь обрезки объекта, который может быть:

  • экземпляр Patch (или подкласс); или
  • экземпляр Path, в этом случае экземпляр Transform, который будет применен к пути перед использованием его для обрезки, должен быть предоставлен; или
  • None, для удаления ранее установленного пути обрезки.

Для повышения эффективности, если путь оказывается прямоугольником, выровненным по осям, этот метод установит область обрезки соответствующему прямоугольнику и установит путь обрезки на None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(cmap)

установить карту цветов для данных светимости

Параметры:
cmap : colormap or registered colormap name
set_color(c) [source]

Установить цвет(а) LineCollection.

Параметры:
c :

Аргумент цвета Matplotlib (все области имеют одинаковый цвет) или последовательность или кортежи rgba; если это последовательность, области будут циклически проходить по последовательности.

set_contains(picker)

Заменить проверку содержимого, используемую этим объектом. Новый вызываемый должен быть функцией, определяющей, попадает ли мышью по объекту:

hit, props = picker(artist, mouseevent)

Если указатель мыши находится над объектом, верните hit = True, а props — это словарь свойств, которые вы хотите вернуть с результатом проверки содержимого.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

псевдоним для set_linestyle

set_edgecolor(c)

Установить цвет(а) обводки коллекции. c может быть спецификацией цвета Matplotlib (все области имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, области будут циклически проходить по последовательности.

Если c равно 'face', цвет обводки всегда будет таким же, как цвет заливки. Если это 'none', граница области не будет рисоваться.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

псевдоним для set_edgecolor

set_facecolor(c)

Установите цвет заливки(цветов) коллекции. c может быть цветовым представлением matplotlib (все области имеют один цвет) или последовательностью представлений; если это последовательность, области будут циклически проходить по последовательности.

Если c равно 'none', область не будет закрашена.

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

Псевдоним для set_facecolor

set_figure(fig)

Установите экземпляр Figure, к которому принадлежит элемент.

Параметры:
fig : Figure
set_gid(gid)

Устанавливает идентификатор (группы) для элемента.

Параметры:
gid : str
set_hatch(hatch)

Установить узор штриховки

hatch может быть одним из следующих:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняется вся указанная штриховка. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого узора.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бэкендах.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всей коллекции, а не для каждого элемента по отдельности.

Параметры:
hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)

Установить, будет ли элемент включён в расчёт макета, например, Руководство по макетам с ограниченным размером, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layout : bool
set_joinstyle(js)

Устанавливает стиль соединения для коллекции. Стиль соединения можно установить только глобально для всех элементов коллекции.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку на s для автоматической легенды.

Параметры:
s : object

s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)

Установить стиль(стили) линии для коллекции.

linestyle описание
'-' or 'solid' сплошная линия
'--' or 'dashed' штриховая линия
'-.' or 'dashdot' пунктирная линия
':' or 'dotted' штрихпунктирная линия

В качестве альтернативы можно указать кортеж тире следующей формы:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий значения включения и выключения чернил в пунктах.

Параметры:
ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

Стиль линии.

set_linestyles(*args, **kwargs)

Псевдоним для set_linestyle

set_linewidth(lw)

Установить толщину(толщины) линии для коллекции. lw может быть скаляром или последовательностью; если это последовательность, области будут циклически проходить по последовательности

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

Псевдоним для set_linewidth

set_lw(*args, **kwargs)

Псевдоним для set_linewidth

set_norm(norm)

Установить экземпляр нормализации.

Параметры:
norm : Normalize
set_offset_position(offset_position)

Установите способ применения смещений. Если offset_position равно 'screen' (по умолчанию), смещение применяется после применения преобразования главного объекта, то есть смещения в координатах экрана. Если offset_position равно 'data', смещение применяется перед преобразованием главного объекта, т.е. смещения в координатах данных.

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установите смещения для коллекции. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

Установить эффекты траектории.

Параметры:
path_effects : AbstractPathEffect
set_paths(segments)
set_picker(picker)

Установите значение epsilon для выбора, используемого этим элементом.

picker может быть одним из следующих:

  • None: выбор отключён для данного элемента (по умолчанию)
  • Логическое значение: если True, выбор включён, и элемент сгенерирует событие выбора, если курсор мыши находится над ним
  • Вещественное число: если picker — число, оно интерпретируется как значение допуска epsilon в пунктах, и элемент сгенерирует событие, если его данные находятся в пределах epsilon от события курсора мыши. Для некоторых элементов, таких как линии и коллекции фигур, элемент может предоставить дополнительные данные для события выбора, например, индексы данных в пределах epsilon от события выбора
  • Функция: если picker — вызываемый объект, это функция, предоставленная пользователем, которая определяет, попадает ли элемент под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

Установить радиус выделения, используемый для тестов включения.

Параметры:
d : float

Радиус выделения в пунктах.

set_rasterized(rasterized)

Принудительно выполнить растрирование (рисование битовой карты) в выходных данных векторного бэкенда.

По умолчанию None, что подразумевает поведение по умолчанию бэкенда.

Параметры:
rasterized : bool or None
set_segments(segments) [source]
set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:
scale : float, optional

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применён.

length : float, optional

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomness : float, optional

Коэффициент масштабирования, с помощью которого длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(snap)

Устанавливает параметры привязки, которые могут быть:

  • True: привязка вершин к ближайшему центру пикселя
  • False: оставить вершины как есть
  • None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

Параметры:
snap : bool or None
set_transform(t)

Установить преобразование художника.

Параметры:
t : Transform
set_url(url)

Устанавливает URL для художника.

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_verts(segments)
set_visible(b)

Установить видимость художника.

Параметры:
b : bool
set_zorder(level)

Установить z-порядок для художника. Художники с меньшими значениями zorder рисуются первыми.

Параметры:
level : float
stale

Если художник «недействителен» и его необходимо перерисовать, чтобы вывод соответствовал внутреннему состоянию художника.

sticky_edges

x и y списки прилипающих границ.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно не ожидается отступ по нижнему краю (0) гистограммы.

К этому атрибуту нельзя присваивать значения; однако, списки x и y можно изменять непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(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(props)

Обновить свойства этого художника из словаря prop.

update_from(other)

Копировать свойства из other в self

update_scalarmappable()

Если массив скалярного отображателя не равен None, обновить цвета из скалярных данных

zorder = 0
class matplotlib.collections.PatchCollection(patches, match_original=False, **kwargs) [source]

Основы: matplotlib.collections.Collection

Общий набор элементов.

Это упрощает назначение цветовой карты гетерогенному набору элементов.

Это также может повысить скорость построения графиков, так как PatchCollection будет рисовать быстрее, чем большое количество элементов.

patches
последовательность объектов Patch. Этот список может содержать разнородный набор различных типов элементов.
match_original
Если True, используются цвета и ширины линий исходных элементов. Если False, новые цвета могут быть назначены путём предоставления стандартных аргументов коллекции, facecolor, edgecolor, linewidths, norm или cmap.

Если какие-либо из edgecolors, facecolors, linewidths, antialiaseds равны None, они по умолчанию устанавливаются в соответствии с параметрами matplotlib.rcParams элемента, в последовательной форме.

Использование ScalarMappable необязательно. Если матрица ScalarMappable _A не равна None (т. е. был выполнен вызов set_array), во время рисования будет выполнен вызов scalar mappable для установки цветов заливки.

add_callback(func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Возвращает id, который полезен для удаления обратного вызова с помощью remove_callback() позже.

add_checker(checker)

Добавляет запись в словарь флагов булевого типа, которые устанавливаются в True, когда изменяется отображаемый элемент.

aname = 'Artist'
autoscale()

Автоматически масштабировать пределы скалярных значений в экземпляре norm с использованием текущего массива.

autoscale_None()

Автоматически масштабировать пределы скалярных значений в экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None.

axes

Экземпляр Axes, в котором находится элемент, или None.

changed()

Вызывайте этот метод всякий раз, когда изменяется отображаемый элемент, чтобы уведомить всех слушателей обратного вызова об изменении сигнала 'changed'.

check_update(checker)

Если отображаемый элемент изменился с момента последней проверки, верните True; иначе верните False.

contains(mouseevent)

Проверяет, произошла ли событие мыши в коллекции.

Возвращает True | False, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)

Для элементов в осях, если ось x поддерживает единицы, преобразуйте x с использованием типа единиц оси x.

convert_yunits(y)

Для элементов в осях, если ось y поддерживает единицы, преобразуйте y с использованием типа единиц оси y.

draw(renderer)

Метод рисования производных классов.

findobj(match=None, include_self=True)

Поиск объектов элементов.

Рекурсивно находит все экземпляры Artist, содержащиеся в self.

match может быть

  • None: вернуть все объекты, содержащиеся в элементе.
  • функция с сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляр класса: например, Line2D. Возвращаются только элементы класса.

Если include_self равно True (по умолчанию), добавить self в список для проверки соответствия.

format_cursor_data(data)

Возвращает отформатированную строку данных курсора.

get_agg_filter()

Возвращает функцию фильтра, используемую для фильтрации agg.

get_alpha()

Возвращает значение альфа, используемое для смешивания - не поддерживается во всех бэкендах.

get_animated()

Возвращает состояние анимации элемента.

get_array()

Возвращает массив.

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist элементов.

get_clim()

Возвращает минимальное и максимальное значения пределов цвета для масштабирования изображения.

get_clip_box()

Возвращает область обрезки элемента.

get_clip_on()

Возвращает, использует ли элемент обрезку.

get_clip_path()

Возвращает путь обрезки элемента.

get_cmap()

Возвращает карту цветов.

get_contains()

Возвращает метод _contains, используемый элементом, или None для значения по умолчанию.

get_cursor_data(event)

Получить данные курсора для заданного события.

get_dashes(*args, **kwargs)

Псевдоним для get_linestyle

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

Псевдоним для get_edgecolor

get_facecolor()
get_facecolors(*args, **kwargs)

Псевдоним для get_facecolor

get_figure()

Возвращает экземпляр Figure, к которому принадлежит элемент.

get_fill()

Возвращает, задана ли заливка.

get_gid()

Возвращает идентификатор группы.

get_hatch()

Возвращает текущий узор штриховки.

get_in_layout()

Возвращает логический флаг, True если элемент включен в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()
get_label()

Получить метку, используемую для данного элемента в легенде.

get_linestyle()
get_linestyles(*args, **kwargs)

Псевдоним для get_linestyle

get_linewidth()
get_linewidths(*args, **kwargs)

Псевдоним для get_linewidth

get_lw(*args, **kwargs)

псевдоним для get_linewidth

get_offset_position()

Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования master, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется до master преобразования, т.е. смещения находятся в координатах данных.

get_offset_transform()
get_offsets()

Возвращает смещения для коллекции.

get_path_effects()
get_paths()
get_picker()

Возвращает объект пикера, используемый этим элементом.

get_pickradius()
get_rasterized()

Возвращает, следует ли растрировать элемент.

get_sketch_params()

Возвращает параметры наброска для элемента.

Возвращает:
sketch_params : tuple or None

Кортеж из 3 элементов с последующими значениями:

  • scale: Амплитуда колебаний, перпендикулярных исходной линии.
  • length: Длина колебаний по линии.
  • randomness: Коэффициент масштабирования, с помощью которого длина сжимается или расширяется.

Может вернуть None, если параметры наброска не были установлены.

get_snap()

Возвращает значение snap, которое может быть:

  • True: привязывать вершины к ближайшему центру пикселя
  • False: оставлять вершины без изменений
  • None: (автоматически) Если путь содержит только прямолинейные сегменты линии, округлять до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

get_tightbbox(renderer)

Подобно Artist.get_window_extent, но включает любое обрезание.

Параметры:
renderer : RendererBase instance

рендерер, который будет использоваться для рисования фигур (т.е. fig.canvas.get_renderer())

Возвращает:
bbox : BboxBase

содержащий ограничивающую рамку (в пиксельных координатах фигуры).

get_transform()

Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()

Возвращает путь обрезки с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()
get_url()

Возвращает URL.

get_urls()
get_visible()

Возвращает видимость элемента.

get_window_extent(renderer)

Получить прямоугольник области осей в пространстве отображения. Подклассы должны переопределять для включения в вычисление ограничивающей рамки "tight". По умолчанию возвращается пустая ограничивающая рамка в координатах 0, 0.

Будьте осторожны при использовании этой функции, результаты не будут обновляться, если изменится область окна элемента. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder()

Возвращает z-порядок элемента.

have_units()

Возвращает True, если единицы установлены на осях x или y

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов элемента, содержащих событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure is not None

Возвращает, назначен ли элемент фигуре Figure.

is_transform_set()

Возвращает True, если у Artist явно задано преобразование.

mouseover
pchanged()

Вызвать событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

Обработка события выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента задан пикер.

pickable()

Возвращает True, если Artist можно выбрать.

properties()

возвращает словарь, сопоставляющий имя свойства -> значение для всех свойств элемента.

remove()

Удалить элемент из фигуры, если это возможно. Эффект будет виден только после перерисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim(), чтобы обновить пределы осей, если нужно.

Примечание: relim() не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)

Удаляет обратный вызов по его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

Установщик свойств по частям. Передайте kwargs для установки свойств.

set_agg_filter(filter_func)

Установить фильтр agg.

Параметры:
filter_func : callable

Функция фильтра, которая принимает массив с плавающей запятой (m, n, 3) и значение dpi и возвращает массив (m, n, 3).

set_alpha(alpha)

Установите альфа-прозрачность коллекции. alpha должен быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

Установите состояние анимации элемента.

Параметры:
b : bool
set_antialiased(aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

Псевдоним для set_antialiased.

set_array(A)

Установить массив изображения из массива NumPy A.

Параметры:
A : ndarray
set_capstyle(cs)

Установить стиль обрезки для коллекции. Стиль обрезки можно задать только глобально для всех элементов в коллекции.

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль обрезки

set_clim(vmin=None, vmax=None)

установить пределы нормализации для масштабирования изображения; если vmin — последовательность длиной 2, интерпретировать ее как (vmin, vmax), что используется для поддержки setp

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей точкой; может быть переопределено в методах, которые имеют vmin и vmax аргументы.

set_clip_box(clipbox)

Установить область обрезки объекта Bbox.

Параметры:
clipbox : Bbox
set_clip_on(b)

Установить, использует ли объект обрезку.

Когда False, объекты будут видимы за пределами осей, что может привести к неожиданным результатам.

Параметры:
b : bool
set_clip_path(path, transform=None)

Установить путь обрезки объекта, который может быть:

  • объект Patch (или подкласс); или
  • объект Path, в этом случае объект Transform, который будет применен к пути перед его использованием для обрезки, должен быть предоставлен; или
  • None, чтобы удалить ранее установленный путь обрезки.

Для повышения эффективности, если путь оказывается прямоугольником, выровненным по осям, этот метод установит соответствующую прямоугольную область обрезки и установит путь обрезки в None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(cmap)

установить цветовую карту для данных яркости

Параметры:
cmap : colormap or registered colormap name
set_color(c)

Установить цвет границы и заливки.

См. также

set_facecolor(), set_edgecolor()
Для установки цвета границы или заливки индивидуально.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

Заменить тест нахождения, используемый этим объектом. Новый селектор должен быть вызываемой функцией, которая определяет, попадает ли объект под мышью:

hit, props = picker(artist, mouseevent)

Если курсор мыши находится над объектом, вернуть hit = True и props — словарь свойств, которые вы хотите вернуть вместе с результатом проверки соответствия.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

Псевдоним для set_linestyle

set_edgecolor(c)

Установить цвет(ы) границы коллекции. c может быть спецификацией цвета matplotlib (все фигуры имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, фигуры будут циклически проходить по последовательности.

Если c равно 'face', цвет границы всегда будет таким же, как цвет заливки. Если это 'none', граница фигуры не будет отображаться.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

Псевдоним для set_edgecolor

set_facecolor(c)

Установить цвет(ы) заливки коллекции. c может быть спецификацией цвета matplotlib (все фигуры имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, фигуры будут циклически проходить по последовательности.

Если c равно 'none', фигура не будет заполнена.

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

Псевдоним для set_facecolor

set_figure(fig)

Установить экземпляр Figure, к которому относится объект.

Параметры:
fig : Figure
set_gid(gid)

Устанавливает идентификатор группы для объекта.

Параметры:
gid : str
set_hatch(hatch)

Установить узор штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одинаковая буква повторяется, это увеличивает плотность штриховки этого узора.

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно указать только для всей коллекции, а не отдельно для каждого элемента.

Параметры:
hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)

Установить, нужно ли включать элемент в расчёты макета. Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layout : bool
set_joinstyle(js)

Установить стиль соединения для коллекции. Стиль соединения может быть установлен только глобально для всех элементов в коллекции.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку s для автоматического построения легенды.

Параметры:
s : object

s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)

Установить стиль(и) линии для коллекции.

linestyle описание
'-' or 'solid' сплошная линия
'--' or 'dashed' штриховая линия
'-.' or 'dashdot' штрихпунктирная линия
':' or 'dotted' пунктирная линия

В качестве альтернативы можно указать кортеж длин штрихов и пробелов в следующем формате:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий длины штрихов и пробелов в точках.

Параметры:
ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

Установить толщину линии(й) для коллекции. lw может быть скаляром или последовательностью; если это последовательность, элементы будут циклически проходить по последовательности.

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

Установить экземпляр нормализации.

Параметры:
norm : Normalize
set_offset_position(offset_position)

Указать, как применяются смещения. Если offset_position — 'screen' (по умолчанию), смещение применяется после применения преобразования master, т. е. смещения в координатах экрана. Если offset_position — 'data', смещение применяется до преобразования master, т. е. смещения в координатах данных.

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установить смещения для коллекции. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

Установить эффекты пути.

Параметры:
path_effects : AbstractPathEffect
set_paths(patches) [source]
set_picker(picker)

Установить эпсилон для выбора, используемый этим элементом.

picker может быть одним из следующих:

  • None: выбор отключён для этого элемента (по умолчанию)
  • Булево значение: если True, выбор будет включён, и элемент будет генерировать событие выбора, если курсор мыши над ним
  • Число с плавающей точкой: если picker — число, оно интерпретируется как допуск в точках, и элемент будет генерировать событие, если его данные находятся в пределах эпсилона от события мыши. Для некоторых элементов, таких как линии и коллекции фигур, элемент может предоставить дополнительные данные событию выбора, например, индексы данных, находящихся в пределах эпсилона от события выбора
  • Функция: если picker — вызываемая функция, это пользовательская функция, которая определяет, попал ли элемент под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения попадания. Если курсор мыши над элементом, вернуть hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

Установить радиус выбора, используемый для тестов попадания.

Параметры:
d : float

Радиус выбора в точках.

set_rasterized(rasterized)

Принудительно выполнить растрирование (отображение в растровом формате) в выходных данных векторного бэкэнда.

По умолчанию None, что подразумевает поведение по умолчанию бэкэнда.

Параметры:
rasterized : bool or None
set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:
scale : float, optional

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не указан, фильтр наброска не будет применён.

length : float, optional

Длина колебания вдоль линии в пикселях (по умолчанию 128.0)

randomness : float, optional

Коэффициент масштабирования, на который длина сжимается или расширяется (по умолчанию 16.0)

set_snap(snap)

Устанавливает настройку snap, которая может быть:

  • True: привязка вершин к центру ближайшего пикселя
  • False: вершины остаются без изменений
  • None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

Параметры:
snap : bool or None
set_transform(t)

Установить преобразование объекта.

Параметры:
t : Transform
set_url(url)

Устанавливает URL для объекта.

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_visible(b)

Установить видимость объекта.

Параметры:
b : bool
set_zorder(level)

Установить значение zorder для объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры:
level : float
stale

Если объект требует перерисовки для соответствия внутреннему состоянию.

sticky_edges

x и y списки "прилипающих" границ.

При автомасштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется — пределы представления "прилипают" к границе. Типичное применение — гистограммы, где обычно не требуется отступ на нижней границе (0) гистограммы.

К этому атрибуту нельзя присвоить значение; однако списки x и y можно изменять непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)

Возвращает массив rgba, соответствующий значению x.

В обычном случае x — одномерная или двумерная последовательность скаляров, и соответствующий массив значений rgba будет возвращён на основе установленной нормы и цветовой карты для этого объекта ScalarMappable.

Есть один особый случай для обработки изображений, которые уже представлены в формате rgb или rgba, например, загруженных из файла изображения. Если x — массив с 3 измерениями, а последнее измерение равно 3 или 4, то он будет обработан как rgb или rgba массив, и отображение не будет выполнено. Массив может быть uint8 или с плавающей точкой с значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, параметр alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет уже существующую альфу. Будет поднято исключение ValueError, если третье измерение отличается от 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет иметь значения с плавающей точкой в диапазоне 0-1; если оно равно True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)

Обновить свойства этого объекта из словаря prop.

update_from(other)

Скопировать свойства из другого объекта в текущий.

update_scalarmappable()

Если массив скалярного отображения не равен None, обновить цвета из скалярных данных.

zorder = 0
class matplotlib.collections.PathCollection(paths, sizes=None, **kwargs) [source]

Основы: matplotlib.collections._CollectionWithSizes

Это самый базовый подкласс Collection.

paths — последовательность объектов matplotlib.path.Path.

Допустимые ключевые аргументы для Collection:

  • edgecolors: None
  • facecolors: None
  • linewidths: None
  • antialiaseds: None
  • offsets: None
  • transOffset: transforms.IdentityTransform()
  • norm: None (необязательно для matplotlib.cm.ScalarMappable)
  • cmap: None (необязательно для matplotlib.cm.ScalarMappable)

offsets и transOffset используются для перемещения области после отрисовки (по умолчанию без смещений)

Если какой-либо из параметров edgecolors, facecolors, linewidths, antialiaseds равен None, они по умолчанию принимают значения из настроек matplotlib.rcParams для областей, в виде последовательности.

add_callback(func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Возвращает id, который пригодится для удаления обратного вызова с помощью remove_callback() позже.

add_checker(checker)

Добавляет запись в словарь флагов, которые устанавливаются в True, когда изменяется mappable.

aname = 'Artist'
autoscale()

Автоматически масштабирует пределы скаляров в экземпляре norm, используя текущий массив.

autoscale_None()

Автоматически масштабирует пределы скаляров в экземпляре norm, используя текущий массив, изменяя только пределы, которые равны None.

axes

Экземпляр Axes, в котором находится объект, или None.

changed()

Вызывается при изменении mappable, чтобы уведомить все слушателей обратного вызова о сигнале 'changed'.

check_update(checker)

Если mappable изменился с последней проверки, возвращает True; иначе — False.

contains(mouseevent)

Проверяет, произошла ли мышь в коллекции.

Возвращает True | False, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)

Для объектов в осях, если ось x поддерживает единицы, преобразует x с помощью типа единиц оси x.

convert_yunits(y)

Для объектов в осях, если ось y поддерживает единицы, преобразует y с помощью типа единиц оси y.

draw(renderer)

Метод отрисовки для производных классов.

findobj(match=None, include_self=True)

Поиск объектов художника.

Рекурсивно находит все объекты Artist, содержащиеся в self.

match может быть

  • None: вернуть все объекты, содержащиеся в художнике.
  • функция с сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляр класса: например, Line2D. Возвратить только объекты художника указанного типа.

Если include_self равно True (по умолчанию), включить себя в список для проверки на соответствие.

format_cursor_data(data)

Возвращает отформатированную строку данных курсора.

get_agg_filter()

Возвращает функцию фильтра, используемую для agg-фильтра.

get_alpha()

Возвращает значение альфа, используемое для смешивания — не поддерживается на всех бэкендах.

get_animated()

Возвращает состояние анимации объекта.

get_array()

Возвращает массив.

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist.

get_clim()

Возвращает минимальное и максимальное значения пределов цвета для масштабирования изображения.

get_clip_box()

Возвращает область обрезки объекта.

get_clip_on()

Возвращает, использует ли объект обрезку.

get_clip_path()

Возвращает путь обрезки объекта.

get_cmap()

Возвращает карту цветов.

get_contains()

Возвращает метод проверки _contains, используемый объектом, или None для значения по умолчанию.

get_cursor_data(event)

Получает данные курсора для заданного события.

get_dashes(*args, **kwargs)

Псевдоним для get_linestyle.

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

Псевдоним для get_edgecolor.

get_facecolor()
get_facecolors(*args, **kwargs)

Псевдоним для get_facecolor.

get_figure()

Возвращает экземпляр Figure, к которому принадлежит объект.

get_fill()

Возвращает, установлен ли закрас.

get_gid()

Возвращает идентификатор группы.

get_hatch()

Возвращает текущий узор штриховки.

get_in_layout()

Возвращает булев флаг, True если объект включен в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight')

get_joinstyle()
get_label()

Получает метку, используемую для этого объекта в легенде.

get_linestyle()
get_linestyles(*args, **kwargs)

Псевдоним для get_linestyle.

get_linewidth()
get_linewidths(*args, **kwargs)

Псевдоним для get_linewidth.

get_lw(*args, **kwargs)

псевдоним для get_linewidth

get_offset_position()

Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования master, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования master, то есть смещения задаются в координатах данных.

get_offset_transform()
get_offsets()

Возвращает смещения для коллекции.

get_path_effects()
get_paths() [source]
get_picker()

Возвращает объект пикера, используемый этим элементом.

get_pickradius()
get_rasterized()

Возвращает значение, указывающее, должен ли элемент быть растрированным.

get_sizes()

Возвращает размеры элементов в коллекции. Значение представляет собой 'площадь' элемента.

Возвращает:
sizes : array

Площадь каждого элемента.

get_sketch_params()

Возвращает параметры наброска для элемента.

Возвращает:
sketch_params : tuple or None

Кортеж из 3 элементов:

  • scale: Амплитуда колебаний перпендикулярно исходной линии.
  • length: Длина колебаний вдоль линии.
  • randomness: Коэффициент масштабирования длины, сжатия или расширения.

Может вернуть None, если параметры наброска не были заданы.

get_snap()

Возвращает параметр привязки, который может быть:

  • True: вершины привязываются к центру ближайшего пикселя
  • False: вершины остаются неизменными
  • None: (автоматически) Если путь содержит только прямолинейные отрезки, значения округляются до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

get_tightbbox(renderer)

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры:
renderer : RendererBase instance

рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает:
bbox : BboxBase

содержащий рамку ограничительной области (в пикселях пространства фигуры).

get_transform()

Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()

Возвращает путь обрезки с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()
get_url()

Возвращает URL.

get_urls()
get_visible()

Возвращает видимость элемента.

get_window_extent(renderer)

Получение рамки ограничительной области осей в пространстве отображения. Подклассы должны переопределять её для включения в вычисление рамки ограничительной области "tight". По умолчанию возвращает пустую рамку ограничительной области в координатах 0, 0.

Будьте осторожны при использовании этой функции; результаты не обновляются, если рамка ограничительной области элемента изменяется. Ограничительная область может измениться из-за любых изменений в стеке преобразования, таких как изменение пределов осей, размера фигуры или используемой области рисования (как при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неверно.

get_zorder()

Возвращает z-порядок элемента.

have_units()

Возвращает True, если единицы измерения установлены для осей x или y.

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов элемента, содержащих событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure не равно None

Возвращает, назначен ли элемент Figure.

is_transform_set()

Возвращает True, если у Artist явно задано преобразование.

mouseover
pchanged()

Вызывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

Обработка события выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен пикер.

pickable()

Возвращает True, если Artist выбираем.

properties()

Возвращает словарь, сопоставляющий имя свойства со значением для всех свойств элемента.

remove()

Удаляет элемент с фигуры, если это возможно. Эффект будет виден только после повторной отрисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Для обновления пределов осей, если это необходимо, вызовите matplotlib.axes.Axes.relim().

Примечание: relim() не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи элемента в легенду.

remove_callback(oid)

Удаляет обратный вызов на основе его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

Установщик свойств в пакетном режиме. Передайте kwargs для установки свойств.

set_agg_filter(filter_func)

Установить фильтр agg.

Параметры:
filter_func : callable

Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi и возвращает массив float (m, n, 3).

set_alpha(alpha)

Установите альфа-прозрачность коллекции. alpha должен быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

Установите состояние анимации объекта.

Параметры:
b : bool
set_antialiased(aa)

Установите состояние сглаживания при отрисовке.

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

Псевдоним для set_antialiased

set_array(A)

Установите массив изображений из массива NumPy A.

Параметры:
A : ndarray
set_capstyle(cs)

Установите стиль окончания отрезка для коллекции. Стиль окончания можно установить только глобально для всех элементов в коллекции

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль окончания

set_clim(vmin=None, vmax=None)

Установите пределы нормализации для масштабирования изображения; если vmin — последовательность длиной 2, интерпретируйте её как (vmin, vmax), которая используется для поддержки setp

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей точкой; может быть переопределён в методах, имеющих vmin и vmax аргументы.

set_clip_box(clipbox)

Установите область обрезки объекта Bbox.

Параметры:
clipbox : Bbox
set_clip_on(b)

Установите, использует ли объект обрезку.

Если значение False, объекты будут видны за пределами осей, что может привести к непредсказуемым результатам.

Параметры:
b : bool
set_clip_path(path, transform=None)

Установите путь обрезки объекта, который может быть:

  • экземпляр Patch (или подкласс); или
  • экземпляр Path, в этом случае экземпляр Transform, который будет применён к пути перед его использованием для обрезки, должен быть предоставлен; или
  • None, чтобы удалить ранее установленный путь обрезки.

Для повышения эффективности, если путь оказывается прямоугольником, выровненным по осям, этот метод установит область обрезки соответствующему прямоугольнику и установит путь обрезки в None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(cmap)

Установите палитру цветов для данных яркости

Параметры:
cmap : colormap or registered colormap name
set_color(c)

Установите цвет границы и заливки.

См. также

set_facecolor(), set_edgecolor()
Для установки цвета границы или заливки по отдельности.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

Заменить проверку нахождения внутри, используемую этим объектом. Новый функцией выбора должна быть вызываемая функция, определяющая, попадает ли объект в область мышиного события:

hit, props = picker(artist, mouseevent)

Если мышиное событие расположено над объектом, вернуть hit = True, а props — словарь свойств, которые вы хотите вернуть с тестом нахождения.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

Псевдоним для set_linestyle

set_edgecolor(c)

Установите цвет границы(цветов) коллекции. c может быть описанием цвета matplotlib (все области имеют одинаковый цвет) или последовательностью описаний; если это последовательность, области будут циклически проходить по последовательности.

Если c равно 'face', цвет границы всегда будет таким же, как цвет заливки. Если это 'none', граница области не будет нарисована.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

Псевдоним для set_edgecolor

set_facecolor(c)

Установите цвет заливки(цветов) коллекции. c может быть описанием цвета matplotlib (все области имеют одинаковый цвет) или последовательностью описаний; если это последовательность, области будут циклически проходить по последовательности.

Если c равно 'none', область не будет залита.

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

Псевдоним для set_facecolor

set_figure(fig)

Установите экземпляр Figure, к которому принадлежит объект.

Параметры:
fig : Figure
set_gid(gid)

Устанавливает идентификатор (группы) объекта.

Параметры:
gid : str
set_hatch(hatch)

Установить узор штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут комбинироваться, в этом случае все указанные штриховки выполняются. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого узора.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg бэкендах.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно задать только для всего набора, а не для каждого элемента по отдельности.

Параметры:
hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)

Установить, должен ли художник быть включён в расчёты макета, например, Руководство по ограниченным макетам, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layout : bool
set_joinstyle(js)

Установить стиль соединения для набора. Стиль соединения может быть установлен только глобально для всех элементов в наборе.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку на s для автоматической легенды.

Параметры:
s : object

s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)

Установить стиль(и) линии для набора.

linestyle описание
'-' or 'solid' сплошная линия
'--' or 'dashed' штриховая линия
'-.' or 'dashdot' штрихпунктирная линия
':' or 'dotted' пунктирная линия

В качестве альтернативы можно указать кортеж с делениями следующей формы:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий значения включения и выключения чернил в пунктах.

Параметры:
ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

Установить ширину(ы) линии для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

Установить экземпляр нормализации.

Параметры:
norm : Normalize
set_offset_position(offset_position)

Установить, как применяются смещения. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования мастера, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется перед преобразованием мастера, т.е. смещения находятся в координатах данных.

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установить смещения для набора. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

Установить эффекты пути.

Параметры:
path_effects : AbstractPathEffect
set_paths(paths) [исходный код]
set_picker(picker)

Установить эпсилон для выбора, используемого этим объектом

picker может быть одним из следующих:

  • None: выбор отключён для этого объекта (по умолчанию)
  • Булево значение: если True, то выбор будет включён и объект сгенерирует событие выбора, если указатель мыши находится над объектом
  • Число с плавающей точкой: если picker — число, оно интерпретируется как допуск эпсилон в пунктах, и объект сгенерирует событие, если его данные находятся в пределах эпсилон от события указателя мыши. Для некоторых объектов, таких как линии и коллекции наборов, объект может предоставить дополнительные данные событию выбора, например, индексы данных, находящихся в пределах эпсилон от события выбора
  • Функция: если picker вызываемая, это пользовательская функция, которая определяет, попадает ли объект под указатель мыши:

    hit, props = picker(artist, mouseevent)
    

    чтобы определить проверку попадания. Если указатель мыши находится над объектом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

Установить радиус выбора, используемый для тестов содержимого.

Параметры:
d : float

Радиус выбора, в пунктах.

set_rasterized(rasterized)

Принудительно использовать растрирование (отображение битовой карты) в выходных данных векторного бэкенда.

По умолчанию значение None, что подразумевает поведение по умолчанию бэкенда.

Параметры:
rasterized : bool or None
set_sizes(sizes, dpi=72.0)

Установить размеры каждого элемента набора.

Параметры:
sizes : ndarray or None

Размер для установки для каждого элемента набора. Значение — «площадь» элемента.

dpi : float

Разрешение холста. По умолчанию 72.0.

set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:
scale : float, optional

Амплитуда колебаний перпендикулярно исходной линии, в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применен.

length : float, optional

Длина колебаний вдоль линии, в пикселях (по умолчанию 128.0)

randomness : float, optional

Коэффициент масштабирования, с которым длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(snap)

Устанавливает параметры привязки, которые могут быть:

  • True: привязать вершины к ближайшему центру пикселя
  • False: оставить вершины как есть
  • None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

Параметры:
snap : bool or None
set_transform(t)

Установить преобразование художника.

Параметры:
t : Transform
set_url(url)

Устанавливает URL для художника.

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_visible(b)

Установить видимость художника.

Параметры:
b : bool
set_zorder(level)

Установить z-порядок художника. Художники с меньшими значениями z-порядка рисуются первыми.

Параметры:
level : float
stale

Если художник «неисправен» и его необходимо перерисовать, чтобы вывод соответствовал внутреннему состоянию художника.

sticky_edges

x и y списки привязанных границ.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется—предел просмотра «прилипает» к краю. Типичный пример — гистограммы, где обычно не требуется отступ на нижней границе (0) гистограммы.

К этому атрибуту нельзя присвоить значение; однако, списки x и y можно изменять по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(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 игнорируется; он не заменяет существующую альфа-компоненту. ValueError будет поднято, если третье измерение отличается от 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет числами с плавающей точкой в диапазоне 0-1; если он равен True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.

Если norm равен False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)

Обновляет свойства этого художника из словаря prop.

update_from(other)

Копирует свойства из other в self

update_scalarmappable()

Если массив скалярного отображаемого объекта не равен null, обновляет цвета из скалярных данных

zorder = 0
class matplotlib.collections.PolyCollection(verts, sizes=None, closed=True, **kwargs) [source]

Bases: matplotlib.collections._CollectionWithSizes

verts — это последовательность (verts0, verts1, ...) где verts_i — это последовательность кортежей xy вершин или эквивалентная numpy массив формы (nv, 2).

sizes — это None (по умолчанию) или последовательность чисел с плавающей точкой, которые масштабируют соответствующие verts_i. Масштабирование применяется до преобразования мастера художника; если последнее — это преобразование тождества, то общее масштабирование такое, что если verts_i задают единичный квадрат, то sizes_i — это площадь этого квадрата в точках^2. Если len(sizes) < nv, дополнительные значения будут взяты циклически из массива.

closed, когда True, явно закроет многоугольник.

Допустимые ключевые аргументы коллекции:

  • edgecolors: None
  • facecolors: None
  • linewidths: None
  • antialiaseds: None
  • offsets: None
  • transOffset: transforms.IdentityTransform()
  • norm: None (необязательно для matplotlib.cm.ScalarMappable)
  • cmap: None (необязательно для matplotlib.cm.ScalarMappable)

offsets и transOffset используются для перемещения фигуры после рендеринга (по умолчанию нет смещений)

Если любой из edgecolors, facecolors, linewidths, antialiaseds равен None, по умолчанию они устанавливаются на значение matplotlib.rcParams для фигуры, в последовательном формате.

add_callback(func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Возвращает id, который полезен для удаления обратного вызова с помощью remove_callback() позже.

add_checker(checker)

Добавляет запись в словарь флагов булевых значений, которые устанавливаются в True, когда изменяется отображаемый объект.

aname = 'Artist'
autoscale()

Автоматически масштабирует пределы скалярных величин на экземпляре нормы, используя текущий массив.

autoscale_None()

Автоматически масштабирует пределы скалярных величин на экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None.

axes

Экземпляр Axes, в котором находится элемент графического интерфейса, или None.

changed()

Вызовите эту функцию всякий раз, когда изменяется отображаемый объект, чтобы уведомить всех слушателей обратного вызова SM о сигнале 'changed'.

check_update(checker)

Если отображаемый объект изменился с последней проверки, верните True; в противном случае верните False.

contains(mouseevent)

Проверить, произошла ли обработка события мыши в коллекции.

Возвращает True | False, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)

Для элементов графического интерфейса на оси, если ось x поддерживает единицы измерения, преобразуйте x, используя тип единиц измерения оси x.

convert_yunits(y)

Для элементов графического интерфейса на оси, если ось y поддерживает единицы измерения, преобразуйте y, используя тип единиц измерения оси y.

draw(renderer)

Метод отрисовки производных классов.

findobj(match=None, include_self=True)

Найти объекты графических элементов.

Рекурсивно найти все Artist экземпляры, содержащиеся в self.

match может быть

  • None: вернуть все объекты, содержащиеся в элементе графического интерфейса.
  • функция с сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляр класса: например, Line2D. Вернуть только элементы графического интерфейса типа класса.

Если include_self равно True (по умолчанию), включить self в список для проверки соответствия.

format_cursor_data(data)

Вернуть отформатированную строку данных курсора.

get_agg_filter()

Вернуть функцию фильтра для использования с фильтром agg.

get_alpha()

Возвращает значение альфа-канала, используемое для смешивания — не поддерживается во всех бэкендах.

get_animated()

Возвращает состояние анимации элемента графического интерфейса.

get_array()

Возвращает массив.

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist элементов.

get_clim()

Возвращает минимальное и максимальное значения пределов цвета для масштабирования изображения.

get_clip_box()

Возвращает область обрезки элемента графического интерфейса.

get_clip_on()

Возвращает значение, указывающее, используется ли обрезка элемента графического интерфейса.

get_clip_path()

Возвращает путь обрезки элемента графического интерфейса.

get_cmap()

Возвращает цветовое отображение.

get_contains()

Возвращает тест _contains, используемый элементом графического интерфейса, или None для значения по умолчанию.

get_cursor_data(event)

Получить данные курсора для заданного события.

get_dashes(*args, **kwargs)

Псевдоним для get_linestyle.

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

Псевдоним для get_edgecolor.

get_facecolor()
get_facecolors(*args, **kwargs)

Псевдоним для get_facecolor.

get_figure()

Возвращает экземпляр Figure, к которому принадлежит элемент графического интерфейса.

get_fill()

Возвращает значение, указывающее, установлено ли заполнение.

get_gid()

Возвращает идентификатор группы.

get_hatch()

Возвращает текущий узор штриховки.

get_in_layout()

Возвращает булевый флаг, True если элемент графического интерфейса включен в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()
get_label()

Возвращает метку, используемую для этого элемента графического интерфейса в легенде.

get_linestyle()
get_linestyles(*args, **kwargs)

Псевдоним для get_linestyle.

get_linewidth()
get_linewidths(*args, **kwargs)

псевдоним для get_linewidth

get_lw(*args, **kwargs)

псевдоним для get_linewidth

get_offset_position()

Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования мастера, то есть смещения в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования мастера, то есть смещения в координатах данных.

get_offset_transform()
get_offsets()

Возвращает смещения для коллекции.

get_path_effects()
get_paths()
get_picker()

Возвращает объект пикера, используемый этим элементом.

get_pickradius()
get_rasterized()

Возвращает, следует ли растрировать элемент.

get_sizes()

Возвращает размеры элементов в коллекции. Значение представляет собой 'площадь' элемента.

Возвращает:
sizes : array

'Площадь' каждого элемента.

get_sketch_params()

Возвращает параметры наброска для элемента.

Возвращает:
sketch_params : tuple or None

Тройка из 3 элементов:

  • scale: Амплитуда колебаний перпендикулярно исходной линии.
  • length: Длина колебания вдоль линии.
  • randomness: Коэффициент масштабирования, с помощью которого длина уменьшается или увеличивается.

Может вернуть None, если параметры наброска не были заданы.

get_snap()

Возвращает настройку snap, которая может быть:

  • True: Привязывает вершины к ближайшему центру пикселя
  • False: Оставляет вершины как есть
  • None: (авто) Если путь содержит только прямолинейные отрезки, округляет до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

get_tightbbox(renderer)

Как Artist.get_window_extent, но включает в себя любые обрезки.

Параметры:
renderer : RendererBase instance

рендерер, который будет использоваться для рисования графиков (т.е. fig.canvas.get_renderer())

Возвращает:
bbox : BboxBase

содержащий рамку ограничивающего прямоугольника (в пикселях рисунка).

get_transform()

Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()

Возвращает обрезной путь с примененной неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()
get_url()

Возвращает URL.

get_urls()
get_visible()

Возвращает видимость элемента.

get_window_extent(renderer)

Получить рамку ограничивающего прямоугольника осей в пространстве отображения. Подклассы должны переопределять для включения в вычисление рамки ограничивающего прямоугольника "tight". По умолчанию возвращает пустую рамку в координатах 0, 0.

Будьте осторожны при использовании этой функции, результаты не будут обновляться, если изменяется область окна элемента. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder()

Возвращает z-порядок элемента.

have_units()

Возвращает True, если единицы заданы на осях x или y.

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist была устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов элемента, которые содержат событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure не равно None

Возвращает, назначен ли элемент фигуре Figure.

is_transform_set()

Возвращает True, если у Artist явно задано преобразование.

mouseover
pchanged()

Вызывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

Обработка события pick

каждый дочерний элемент вызовет событие pick, если mouseevent находится над элементом, и у элемента установлен pick

pickable()

Возвращает True, если Artist подлежит выбору.

properties()

Возвращает словарь, сопоставляющий имя свойства —> значение для всех свойств элемента.

remove()

Удаляет элемент из фигуры, если это возможно. Эффект будет виден только после перерисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim(), чтобы обновить пределы осей, если это необходимо.

Примечание: relim() не обнаружит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)

Удаляет обратный вызов на основе его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

Метод для пакетной установки свойств. Передайте kwargs для установки свойств.

set_agg_filter(filter_func)

Установить фильтр agg.

Параметры:
filter_func : callable

Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(alpha)

Установите прозрачность альфы коллекции. alpha должно быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

Установите состояние анимации художника.

Параметры:
b : bool
set_antialiased(aa)

Установите состояние антиалиасинга для рендеринга.

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

псевдоним для set_antialiased

set_array(A)

Установите массив изображений из массива numpy A.

Параметры:
A : ndarray
set_capstyle(cs)

Установите стиль обрезки для коллекции. Стиль обрезки может быть установлен только глобально для всех элементов в коллекции

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль обрезки

set_clim(vmin=None, vmax=None)

Установите пределы нормы для масштабирования изображения; если vmin — последовательность длины 2, интерпретируйте ее как (vmin, vmax), которая используется для поддержки setp

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей точкой; может быть переопределён в методах, которые имеют vmin и vmax аргументы.

set_clip_box(clipbox)

Установите область обрезки художника Bbox.

Параметры:
clipbox : Bbox
set_clip_on(b)

Установите, использует ли художник обрезку.

Когда False, художники будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:
b : bool
set_clip_path(path, transform=None)

Установите путь обрезки художника, который может быть:

  • экземпляр Patch (или подкласс); или
  • экземпляр Path, в этом случае экземпляр Transform, который будет применён к пути перед его использованием для обрезки, должен быть предоставлен; или
  • None, чтобы удалить ранее установленный путь обрезки.

Для повышения эффективности, если путь оказывается прямоугольником с выровненными осями, этот метод установит соответствующий прямоугольник в область обрезки и установит путь обрезки в None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(cmap)

установите цветовое отображение для данных яркости

Параметры:
cmap : colormap or registered colormap name
set_color(c)

Установите и цвет обводки, и цвет заливки.

См. также

set_facecolor(), set_edgecolor()
Для установки цвета границы или цвета заливки по отдельности.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

Замените тест на принадлежность, используемый этим художником. Новый пикер должен быть вызываемой функцией, которая определяет, попадает ли художник под событие мыши:

hit, props = picker(artist, mouseevent)

Если событие мыши находится над художником, вернуть hit = True, и props — словарь свойств, которые вы хотите получить с тестом на принадлежность.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

псевдоним для set_linestyle

set_edgecolor(c)

Установите цвет(цвета) границы коллекции. c может быть спецификацией цвета matplotlib (все области имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, области будут циклически проходить через последовательность.

Если c равно 'face', цвет границы всегда будет таким же, как и цвет заливки. Если это 'none', граница области не будет отрисовываться.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

псевдоним для set_edgecolor

set_facecolor(c)

Установите цвет(цвета) заливки коллекции. c может быть спецификацией цвета matplotlib (все области имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, области будут циклически проходить через последовательность.

Если c равно 'none', область не будет заполнена.

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

псевдоним для set_facecolor

set_figure(fig)

Установите экземпляр Figure, к которому принадлежит художник.

Параметры:
fig : Figure
set_gid(gid)

Устанавливает идентификатор (группы) для художника.

Параметры:
gid : str
set_hatch(hatch)

Установить узор штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки данного узора.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg-бекендах.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно указать только для всего набора, а не для каждого элемента по отдельности.

Параметры:
hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)

Установить, нужно ли учитывать элемент при расчёте макета. Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layout : bool
set_joinstyle(js)

Установить стиль соединения для набора. Стиль соединения можно установить только глобально для всех элементов в наборе.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку s для автоматической легенды.

Параметры:
s : object

s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)

Установить стиль(и) линии для набора.

linestyle описание
'-' или 'solid' сплошная линия
'--' или 'dashed' пунктирная линия
'-.' или 'dashdot' штрихпунктирная линия
':' или 'dotted' штриховая линия

В качестве альтернативы можно указать кортеж с последовательностью точек:

(offset, onoffseq),

где onoffseq — это кортеж чётной длины с включённым и выключённым чернилами в пунктах.

Параметры:
ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

Установить ширину линии(ей) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, то фигуры будут циклически проходить по последовательности.

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

Установить экземпляр нормализации.

Параметры:
norm : Normalize
set_offset_position(offset_position)

Установить способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения основного преобразования, то есть смещения заданы в экранных координатах. Если offset_position равен 'data', смещение применяется до основного преобразования, т.е. смещения заданы в координатах данных.

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установить смещения для набора. offsets может быть скалярным значением или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

Установить эффекты траектории.

Параметры:
path_effects : AbstractPathEffect
set_paths(verts, closed=True)

Это позволяет отложить инициализацию вершин.

set_picker(picker)

Установить эпсилон для выбора, используемый этим элементом.

picker может быть одним из следующих:

  • None: выбор отключён для данного элемента (по умолчанию)
  • Булево значение: если True, то выбор будет включён, и элемент сгенерирует событие выбора, если курсор мыши находится над ним
  • Число с плавающей точкой: если picker является числом, оно интерпретируется как допускаемая погрешность в пунктах, и элемент сгенерирует событие, если его данные находятся в пределах погрешности от события мыши. Для некоторых элементов, таких как линии и коллекции фигур, элемент может предоставить дополнительные данные к событию выбора, например, индексы данных в пределах погрешности от события выбора
  • Функция: если picker является вызываемым объектом, это функция пользователя, которая определяет, попадает ли элемент под курсор мыши:

    hit, props = picker(artist, mouseevent)
    

    чтобы определить тест на попадание. Если курсор мыши находится над элементом, верните hit=True, а props — это словарь свойств, которые вы хотите добавить в атрибуты PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

Установить радиус выбора, используемый для тестов на включение.

Параметры:
d : float

Радиус выбора, в пунктах.

set_rasterized(rasterized)

Вынудительная растризация (рисование растровым изображением) в векторном выводе.

По умолчанию None, что подразумевает поведение по умолчанию для бэкенда.

Параметры:
rasterized : bool or None
set_sizes(sizes, dpi=72.0)

Установить размеры каждого элемента коллекции.

Параметры:
sizes : ndarray or None

Размер, устанавливаемый для каждого элемента коллекции. Значение — это «площадь» элемента.

dpi : float

Разрешение холста (dpi). По умолчанию 72.0.

set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:
scale : float, optional

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр наброска не будет применён.

length : float, optional

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0).

randomness : float, optional

Коэффициент масштабирования, на который умножается длина (по умолчанию 16.0).

set_snap(snap)

Устанавливает параметр привязки, который может быть:

  • True: вершины привязываются к ближайшему центру пикселя
  • False: вершины остаются как есть
  • None: (автоматически) Если путь содержит только прямолинейные отрезки, то вершины округляются до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

Параметры:
snap : bool or None
set_transform(t)

Установить преобразование объекта.

Параметры:
t : Transform
set_url(url)

Устанавливает URL для объекта.

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_verts(verts, closed=True) [source]

Это позволяет отложить инициализацию вершин.

set_verts_and_codes(verts, codes) [source]

Это позволяет инициализировать вершины с кодами путей.

set_visible(b)

Установить видимость объекта.

Параметры:
b : bool
set_zorder(level)

Установить z-порядок для объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры:
level : float
stale

Если объект "недействителен" и его нужно перерисовать, чтобы вывод соответствовал внутреннему состоянию объекта.

sticky_edges

x и y списки привязанных границ.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — пределы просмотра «прилипают» к границе. Типичный пример использования — гистограммы, где обычно не ожидается отступ по нижней границе (0) гистограммы.

К этому атрибуту нельзя присвоить значение; однако списки x и y можно изменять по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)

Возвращает нормированный массив rgba, соответствующий x.

В нормальном случае x является одномерной или двумерной последовательностью скаляров, и соответствующий массив значений rgba будет возвращен на основе нормы и цветовой карты, установленных для данного объекта ScalarMappable.

Есть один особый случай для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x является массивом с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакое отображение не будет выполнено. Массив может быть uint8 или иметь тип с плавающей запятой со значениями в диапазоне 0-1; в противном случае будет возбуждено исключение ValueError. Если это массив с маской, то маска будет проигнорирована. Если последнее измерение равно 3, то значение параметра alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, то параметр alpha игнорируется; он не заменяет предварительно существующее значение альфа-канала. Если третье измерение отличается от 3 или 4, то будет возбуждено исключение ValueError.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать числа с плавающей запятой в диапазоне 0-1; если оно равно True, возвращаемый массив rgba будет содержать значения uint8 в диапазоне от 0 до 255.

Если norm равно False, то нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)

Обновляет свойства этого объекта из словаря prop.

update_from(other)

Копирует свойства из other в self.

update_scalarmappable()

Если массив scalar mappable не равен 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) четырёхугольников. Сетка необязательно должна быть регулярной, а многоугольники необязательно должны быть выпуклыми.

Сетка из четырёхугольников представлена массивом numpy (2 x ((meshWidth + 1) * (meshHeight + 1))) coordinates, где каждая строка — координаты x и y одной из вершин. Для определения функции, сопоставляющей точку данных соответствующему цвету, используйте метод set_cmap(). Каждый из этих массивов индексируется в порядке следования строк координатами вершины сетки (или координатами левой нижней вершины сетки в случае цветов).

Например, первый элемент в coordinates — координаты вершины с координатами сетки (0, 0), затем (0, 1), затем (0, 2) .. (0, meshWidth), (1, 0), (1, 1) и так далее.

shading может быть 'flat' или 'gouraud'

add_callback(func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Возвращает id, который полезен для удаления обратного вызова с помощью remove_callback() позднее.

add_checker(checker)

Добавляет запись в словарь флагов булевого типа, которые устанавливаются в значение True, когда изменяется отображаемый объект.

aname = 'Artist'
autoscale()

Автомасштабирование пределов скаляров в экземпляре нормы с использованием текущего массива.

autoscale_None()

Автомасштабирование пределов скаляров в экземпляре нормы с использованием текущего массива, изменяя только пределы, которые равны None.

axes

Экземпляр Axes, в котором находится элемент художника, или None.

changed()

Вызовите этот метод всякий раз, когда изменяется отображаемый объект, чтобы уведомить всех слушателей обратного вызова о сигнале 'changed'.

check_update(checker)

Если отображаемый объект изменился с момента последней проверки, вернуть True; иначе вернуть False.

contains(mouseevent)

Проверка, произошла ли активность мыши в коллекции.

Возвращает True | False, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

static convert_mesh_to_paths(meshWidth, meshHeight, coordinates) [source]

Преобразует заданную сетку в последовательность объектов matplotlib.path.Path для более удобного рендеринга бэкендами, которые не поддерживают quadmeshes напрямую.

Эта функция предназначена в первую очередь для разработчиков бэкендов.

convert_mesh_to_triangles(meshWidth, meshHeight, coordinates) [source]

Преобразует заданную сетку в последовательность треугольников, каждая точка с собственным цветом. Это полезно для экспериментов с draw_qouraud_triangle.

convert_xunits(x)

Для элементов управления в осях, если ось x поддерживает единицы измерения, преобразуйте x с помощью типа единиц измерения оси x.

convert_yunits(y)

Для элементов управления в осях, если ось y поддерживает единицы измерения, преобразуйте y с помощью типа единиц измерения оси y.

draw(renderer) [source]

Метод рисования производных классов.

findobj(match=None, include_self=True)

Поиск объектов художника.

Рекурсивно находит все экземпляры Artist, содержащиеся в self.

match может быть

  • None: вернуть все объекты, содержащиеся в художнике.
  • функция с сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляр класса, например, Line2D. Возвратить только элементы управления типа класса.

Если include_self равно True (по умолчанию), добавить self в список для проверки соответствия.

format_cursor_data(data)

Возвращает отформатированную строку cursor data.

get_agg_filter()

Возвращает функцию фильтра, используемую для фильтрации agg.

get_alpha()

Возвращает значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

get_animated()

Возвращает состояние анимации элемента управления.

get_array()

Возвращает массив.

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist элементов.

get_clim()

Возвращает мин/макс значения пределов цвета для масштабирования изображения.

get_clip_box()

Возвращает область обрезки элемента управления.

get_clip_on()

Возвращает значение, определяющее, использует ли элемент управления обрезку.

get_clip_path()

Возвращает путь обрезки элемента управления.

get_cmap()

Возвращает карту цветов.

get_contains()

Возвращает тест _contains, используемый элементом управления, или None по умолчанию.

get_cursor_data(event)

Получение данных курсора для данного события.

get_dashes(*args, **kwargs)

Псевдоним для get_linestyle

get_datalim(transData) [source]
get_edgecolor()
get_edgecolors(*args, **kwargs)

Псевдоним для get_edgecolor

get_facecolor()
get_facecolors(*args, **kwargs)

Псевдоним для get_facecolor

get_figure()

Возвращает экземпляр Figure, к которому принадлежит элемент управления.

get_fill()

Возвращает, установлен ли fill.

get_gid()

Возвращает идентификатор группы.

get_hatch()

Возвращает текущий узор штриховки.

get_in_layout()

Возвращает логическое значение, True если элемент графика включен в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()
get_label()

Получить метку, используемую для этого элемента графика в легенде.

get_linestyle()
get_linestyles(*args, **kwargs)

псевдоним для get_linestyle

get_linewidth()
get_linewidths(*args, **kwargs)

псевдоним для get_linewidth

get_lw(*args, **kwargs)

псевдоним для get_linewidth

get_offset_position()

Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования мастера, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется перед преобразованием мастера, то есть смещения находятся в координатах данных.

get_offset_transform()
get_offsets()

Возвращает смещения для коллекции.

get_path_effects()
get_paths() [исходный код]
get_picker()

Возвращает объект пикера, используемый этим элементом графика.

get_pickradius()
get_rasterized()

Возвращает, будет ли элемент графика растрирован.

get_sketch_params()

Возвращает параметры наброска для элемента графика.

Возвращает:
sketch_params : tuple or None

Кортеж из 3 элементов со следующим содержанием:

  • scale: Амплитуда колебаний перпендикулярно исходной линии.
  • length: Длина колебаний вдоль линии.
  • randomness: Коэффициент масштабирования, на который масштабируется длина.

Может вернуть None, если параметры наброска не были установлены.

get_snap()

Возвращает параметр привязки, который может быть:

  • True: вершины привязываются к ближайшему центру пикселя
  • False: вершины остаются неизменными
  • None: (автоматически) Если путь содержит только прямолинейные сегменты, округляется до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

get_tightbbox(renderer)

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры:
renderer : RendererBase instance

рендерер, который будет использоваться для рисования графиков (т.е. fig.canvas.get_renderer())

Возвращает:
bbox : BboxBase

содержащий рамку (в пикселях изображения).

get_transform()

Возвращает экземпляр Transform, используемый этим элементом графика.

get_transformed_clip_path_and_affine()

Возвращает путь обрезки с применённой неаффинной частью преобразования и оставшейся аффинной частью преобразования.

get_transforms()
get_url()

Возвращает URL.

get_urls()
get_visible()

Возвращает видимость элемента графика.

get_window_extent(renderer)

Получить рамку области осей в пространстве отображения. Подклассы должны переопределять её для включения в вычисление "плотной" рамки. По умолчанию возвращает пустую рамку в координатах 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если изменяется область окна элемента графика. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемой области рисования (как при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут отображаться правильно на экране, но сохраняться неправильно.

get_zorder()

Возвращает z-порядок элемента графика.

have_units()

Возвращает True, если единицы установлены на осях x или y.

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов графика, содержащих событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure is not None

Возвращает, назначен ли элемент графика фигуре Figure.

is_transform_set()

Возвращает True, если у Artist явно задано преобразование.

mouseover
pchanged()

Вызывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

Обработка события выбора.

Каждый дочерний элемент графика вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен пикер.

pickable()

Возвращает True, если Artist можно выбрать.

properties()

Возвращает словарь, сопоставляющий имя свойства со значением для всех свойств элемента графика.

remove()

Если возможно, удаляет элемент графика из фигуры. Эффект будет виден только после перерисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim(), чтобы обновить пределы осей, если нужно.

Примечание: relim() не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента графика.

remove_callback(oid)

Удаляет обратный вызов по его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

Установщик свойств в пакетном режиме. Передайте kwargs для установки свойств.

set_agg_filter(filter_func)

Установить фильтр agg.

Параметры:
filter_func : callable

Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(alpha)

Установить прозрачность альфа-каналов коллекции. alpha должно быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

Установить состояние анимации объекта.

Параметры:
b : bool
set_antialiased(aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

Псевдоним для set_antialiased

set_array(A)

Установить массив изображения из массива NumPy A.

Параметры:
A : ndarray
set_capstyle(cs)

Установить стиль окончания отрезков для коллекции. Стиль capstyle можно установить только глобально для всех элементов коллекции.

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль окончания отрезков

set_clim(vmin=None, vmax=None)

Устанавливает пределы нормы для масштабирования изображения; если vmin является последовательностью длины 2, интерпретировать её как (vmin, vmax), что используется для поддержки setp

ПРИНИМАЕТ: последовательность длины 2 чисел с плавающей точкой; может быть переопределён в методах, имеющих vmin и vmax аргументы.

set_clip_box(clipbox)

Установить область обрезки объекта Bbox.

Параметры:
clipbox : Bbox
set_clip_on(b)

Установить, использует ли объект обрезку.

Когда False, объекты будут отображаться за пределами осей, что может привести к неожиданным результатам.

Параметры:
b : bool
set_clip_path(path, transform=None)

Установить путь обрезки объекта, который может быть:

  • экземпляр Patch (или подкласс); или
  • экземпляр Path, в этом случае экземпляр Transform, который будет применен к пути перед его использованием для обрезки, должен быть указан; или
  • None, чтобы удалить ранее установленный путь обрезки.

Для повышения эффективности, если путь оказывается прямоугольником с осями, этот метод установит область обрезки для соответствующего прямоугольника и установит путь обрезки в None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(cmap)

установить цветовую карту для данных яркости

Параметры:
cmap : colormap or registered colormap name
set_color(c)

Установить цвет обводки и заливки.

См. также

set_facecolor(), set_edgecolor()
Для установки цвета обводки или заливки отдельно.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

Заменить тест принадлежности, используемый этим объектом. Новый селектор должен быть вызываемой функцией, которая определяет, попадает ли мышь по объекту:

hit, props = picker(artist, mouseevent)

Если курсор мыши находится над объектом, вернуть hit = True и props — словарь свойств, которые вы хотите вернуть вместе с тестом принадлежности.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

Псевдоним для set_linestyle

set_edgecolor(c)

Установить цвет(а) обводки коллекции. c может быть спецификацией цвета matplotlib (все фигуры имеют один и тот же цвет) или последовательностью спецификаций; если это последовательность, фигуры будут циклически перебирать последовательность.

Если c равно 'face', цвет обводки всегда будет таким же, как и цвет заливки. Если это 'none', граница фигуры не будет отрисована.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

Псевдоним для set_edgecolor

set_facecolor(c)

Установить цвет(а) заливки коллекции. c может быть спецификацией цвета matplotlib (все фигуры имеют один и тот же цвет) или последовательностью спецификаций; если это последовательность, фигуры будут циклически перебирать последовательность.

Если c равно 'none', фигура не будет закрашена.

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

Псевдоним для set_facecolor

set_figure(fig)

Установить экземпляр Figure, к которому принадлежит объект.

Параметры:
fig : Figure
set_gid(gid)

Устанавливает идентификатор (группы) для художника.

Параметры:
gid : str
set_hatch(hatch)

Устанавливает узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут комбинироваться, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, плотность штриховки этого узора увеличивается.

Штриховка поддерживается только в постскриптовых, PDF, SVG и Agg-бекендах.

В отличие от других свойств, таких как ширина линии и цвета, штриховку можно указать только для всего набора, а не для каждого элемента отдельно.

Параметры:
hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)

Устанавливает, будет ли художник включён в расчёты макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layout : bool
set_joinstyle(js)

Устанавливает стиль соединения для набора. Стиль соединения может быть установлен только глобально для всех элементов набора.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Устанавливает метку в s для автоматической легенды.

Параметры:
s : object

s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)

Устанавливает стиль(и) линии для набора.

linestyle описание
'-' или 'solid' сплошная линия
'--' или 'dashed' штриховая линия
'-.' или 'dashdot' штрихпунктирная линия
':' или 'dotted' пунктирная линия

В качестве альтернативы можно указать кортеж с даш-паттерном следующего вида:

(offset, onoffseq),

где onoffseq - кортеж чётной длины, содержащий интервалы включения и выключения чернил в пунктах.

Параметры:
ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

Устанавливает ширину линии(ей) для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить через последовательность.

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

Устанавливает экземпляр нормализации.

Параметры:
norm : Normalize
set_offset_position(offset_position)

Устанавливает, как применяются смещения. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования родительского пространства, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования родительского пространства, то есть смещения задаются в координатах данных.

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Устанавливает смещения для набора. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

Устанавливает эффекты пути.

Параметры:
path_effects : AbstractPathEffect
set_paths() [source]
set_picker(picker)

Устанавливает значение эпсилон для выбора, используемого этим художником.

picker может быть одним из следующих:

  • None: выбор отключён для этого художника (по умолчанию)
  • Булево значение: если True, то выбор будет включён, и художник сгенерирует событие выбора, если курсор мыши находится над художником
  • Число с плавающей запятой: если picker - это число, оно интерпретируется как значение эпсилонной погрешности в пунктах, и художник сгенерирует событие, если его данные находятся в пределах эпсилон от события мыши. Для некоторых художников, таких как линии и коллекции патчей, художник может предоставить дополнительные данные для события выбора, например, индексы данных, находящихся в пределах эпсилон от события выбора
  • Функция: если picker - это вызываемая функция, она является пользователем функция, которая определяет, попадает ли художник под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения теста на попадание. Если курсор мыши находится над художником, верните hit=True, а props - словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

Устанавливает радиус выбора, используемый для тестов попадания.

Параметры:
d : float

Радиус выбора в пунктах.

set_rasterized(rasterized)

Принудительно активировать растрирование (отображение растрового изображения) в выходных данных векторного бэкенда.

По умолчанию равно None, что подразумевает поведение, установленное по умолчанию для бэкенда.

Параметры:
rasterized : bool or None
set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:
scale : float, optional

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None или не указан, фильтр наброска не будет применён.

length : float, optional

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0).

randomness : float, optional

Коэффициент масштаба, на который длина сжимается или расширяется (по умолчанию 16.0).

set_snap(snap)

Устанавливает параметр привязки, который может быть:

  • True: привязать вершины к ближайшему центру пикселя
  • False: оставить вершины как есть
  • None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

Параметры:
snap : bool or None
set_transform(t)

Устанавливает преобразование объекта.

Параметры:
t : Transform
set_url(url)

Устанавливает URL для объекта.

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_visible(b)

Устанавливает видимость объекта.

Параметры:
b : bool
set_zorder(level)

Устанавливает z-порядок объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры:
level : float
stale

Если объект «недействителен» и требует перерисовки для соответствия внутреннему состоянию объекта.

sticky_edges

x и y списки прилипших границ.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется — предел просмотра «прилипает» к краю. Типичный пример — гистограммы, где обычно ожидается отсутствие отступа на нижнем краю (0) гистограммы.

К этому атрибуту нельзя обращаться для присваивания; однако списки x и y можно изменять на месте по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)

Возвращает нормализованный массив rgba, соответствующий x.

В нормальном случае x — это последовательность скаляров 1D или 2D, и возвращается соответствующий массив ndarray значений rgba, на основе нормы и цветовой карты, установленных для этого ScalarMappable.

Есть один специальный случай для обработки изображений, которые уже являются rgb или rgba, например, которые были прочитаны из файла изображения. Если x является ndarray с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и отображение не будет производиться. Массив может быть uint8 или иметь тип с плавающей запятой со значениями в диапазоне от 0 до 1; в противном случае будет поднята ошибка ValueError. Если это массив с пропусками, маска будет проигнорирована. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использовано для заполнения прозрачности. Если последнее измерение равно 4, значение параметра alpha игнорируется; оно не заменяет существующую альфу. ValueError будет поднят, если третье измерение отличается от 3 или 4.

В любом случае, если bytes равен False (по умолчанию), массив rgba будет содержать числа с плавающей точкой в диапазоне от 0 до 1; если он равен True, возвращаемый массив rgba будет содержать uint8 в диапазоне от 0 до 255.

Если norm равен False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)

Обновляет свойства данного объекта из словаря prop.

update_from(other)

Копирует свойства из other в self.

update_scalarmappable()

Если массив scalar mappable не равен None, обновляет цвета из скалярных данных.

zorder = 0
class matplotlib.collections.RegularPolyCollection(numsides, rotation=0, sizes=(1, ), **kwargs) [source]

Основания: matplotlib.collections._CollectionWithSizes

Отобразить набор правильных многоугольников с numsides.

numsides
количество сторон многоугольника
rotation
поворот многоугольника в радианах
sizes

указывает площадь окружности, описанной вокруг правильного многоугольника, в точках2

Допустимые аргументы ключевых слов для набора:

  • edgecolors: None
  • facecolors: None
  • linewidths: None
  • antialiaseds: None
  • offsets: None
  • transOffset: transforms.IdentityTransform()
  • norm: None (необязательно для matplotlib.cm.ScalarMappable)
  • cmap: None (необязательно для matplotlib.cm.ScalarMappable)

offsets и transOffset используются для перемещения фигуры после отрисовки (по умолчанию нет смещений)

Если любой из edgecolors, facecolors, linewidths, antialiaseds имеет значение None, он по умолчанию принимает значение настроек фигуры matplotlib.rcParams, в последовательном порядке.

Пример: см. Демонстрацию Lasso для полного примера:

offsets = np.random.rand(20,2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]
black = (0,0,0,1)

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=(black,),
    linewidths=(1,),
    offsets=offsets,
    transOffset=ax.transData,
    )
add_callback(func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Возвращает id, полезный для удаления обратного вызова с помощью remove_callback() позже.

add_checker(checker)

Добавляет запись в словарь логических флагов, которые устанавливаются в True, когда изменяется отображаемый объект.

aname = 'Artist'
autoscale()

Автомасштабировать пределы скаляров в экземпляре norm, используя текущий массив

autoscale_None()

Автомасштабировать пределы скаляров в экземпляре norm, используя текущий массив, изменяя только пределы, которые равны None

axes

Экземпляр Axes, в котором находится объект, или None.

changed()

Вызовите эту функцию всякий раз, когда изменяется отображаемый объект, чтобы уведомить всех слушателей обратного вызова SM об изменении 'changed'

check_update(checker)

Если отображаемый объект изменился с момента последней проверки, верните True; иначе верните False

contains(mouseevent)

Проверить, произошел ли щелчок мыши в коллекции.

Возвращает True | False, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)

Для объектов в осях, если ось x поддерживает единицы, преобразовать x, используя тип единиц оси x

convert_yunits(y)

Для объектов в осях, если ось y поддерживает единицы, преобразовать y, используя тип единиц оси y

draw(renderer) [исходный код]

Метод отрисовки производных классов

findobj(match=None, include_self=True)

Найти объекты художников.

Рекурсивно найти все экземпляры Artist, содержащиеся в self.

match может быть

  • None: вернуть все объекты, содержащиеся в художнике.
  • функция с сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляр класса: например, Line2D. Вернуть только художников типа класса.

Если include_self равно True (по умолчанию), включить self в список для проверки совпадения.

format_cursor_data(data)

Вернуть отформатированную строку данных курсора.

get_agg_filter()

Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()

Возвращает значение альфа, используемое для смешивания — не поддерживается во всех бэкендах

get_animated()

Возвращает состояние анимации художника

get_array()

Возвращает массив

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist.

get_clim()

Возвращает минимальное и максимальное значения пределов цветов для масштабирования изображения

get_clip_box()

Возвращает область обрезки художника

get_clip_on()

Возвращает значение, указывающее, использует ли художник обрезку

get_clip_path()

Возвращает путь обрезки художника

get_cmap()

Возвращает карту цветов

get_contains()

Возвращает тест _contains, используемый художником, или None по умолчанию.

get_cursor_data(event)

Получить данные курсора для заданного события.

get_dashes(*args, **kwargs)

псевдоним для get_linestyle

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

псевдоним для get_edgecolor

get_facecolor()
get_facecolors(*args, **kwargs)

псевдоним для get_facecolor

get_figure()

Возвращает экземпляр Figure, к которому принадлежит художник.

get_fill()

Возвращает значение, указывающее, задан ли закрас

get_gid()

Возвращает идентификатор группы.

get_hatch()

Возвращает текущий узор штриховки.

get_in_layout()

Возвращает логический флаг, True если художник включён в расчёты макета.

Например, Руководство по ограничению макета, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()
get_label()

Получить метку, используемую для этого художника в легенде.

get_linestyle()
get_linestyles(*args, **kwargs)

псевдоним для get_linestyle

get_linewidth()
get_linewidths(*args, **kwargs)

псевдоним для get_linewidth

get_lw(*args, **kwargs)

псевдоним для get_linewidth

get_numsides() [source]
get_offset_position()

Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования родительского объекта, то есть смещения заданы в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования родительского объекта, то есть смещения заданы в координатах данных.

get_offset_transform()
get_offsets()

Возвращает смещения для коллекции.

get_path_effects()
get_paths()
get_picker()

Возвращает объект пикера, используемый этим элементом.

get_pickradius()
get_rasterized()

Возвращает, должен ли элемент быть растрированным.

get_rotation() [source]
get_sizes()

Возвращает размеры элементов в коллекции. Значение представляет собой «площадь» элемента.

Возвращает:
sizes : array

«Площадь» каждого элемента.

get_sketch_params()

Возвращает параметры наброска для элемента.

Возвращает:
sketch_params : tuple or None

Кортеж из 3 элементов:

  • scale: Амплитуда колебания перпендикулярно исходной линии.
  • length: Длина колебания вдоль линии.
  • randomness: Коэффициент масштабирования, с которым длина сжимается или расширяется.

Может вернуть None, если параметры наброска не были заданы.

get_snap()

Возвращает параметр привязки, который может быть:

  • True: вершины привязываются к ближайшему центру пикселя
  • False: вершины остаются без изменений
  • None: (автоматически) Если путь содержит только прямолинейные отрезки, округляются до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

get_tightbbox(renderer)

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:
renderer : RendererBase instance

рендерер, который будет использоваться для рисования графиков (т.е. fig.canvas.get_renderer())

Возвращает:
bbox : BboxBase

содержащий область ограничительной рамки (в пиксельных координатах рисунка).

get_transform()

Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()

Возвращает обрезной путь с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()
get_url()

Возвращает URL.

get_urls()
get_visible()

Возвращает видимость элемента.

get_window_extent(renderer)

Получение области ограничительной рамки осей в пространстве отображения. Подклассы должны переопределять для включения в вычисление «плотной» области ограничительной рамки. По умолчанию возвращает пустую область ограничительной рамки в 0, 0.

Будьте внимательны при использовании этой функции, результаты не обновляются, если область ограничительной рамки элемента изменится. Область ограничительной рамки может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера рисунка или используемой области рисования (как при сохранении рисунка). Это может привести к неожиданному поведению, когда интерактивные рисунки будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder()

Возвращает z-порядок элемента.

have_units()

Возвращает True, если единицы установлены на осях x или y

hitlist(event)

Устаревшее начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов элемента, которые содержат событие мыши event.

is_figure_set()

Устаревшее начиная с версии 2.2: artist.figure is not None

Возвращает, назначен ли элемент Figure.

is_transform_set()

Возвращает True, если у Artist явно задано преобразование.

mouseover
pchanged()

Вызвать событие при изменении свойства, вызвав все зарегистрированные обратные вызовы.

pick(mouseevent)

Обработка события выбора

каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом и у элемента установлен pick

pickable()

Возвращает True, если Artist подлежит выбору.

properties()

Возвращает словарь, сопоставляющий имя свойства со значением для всех свойств элемента.

remove()

Удалить элемент с рисунка, если это возможно. Эффект будет виден только после перерисовки рисунка, например, с помощью matplotlib.axes.Axes.draw_idle(). Для обновления пределов осей при необходимости вызовите matplotlib.axes.Axes.relim().

Примечание: relim() не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)

Удалить обработчик на основе его id.

См. также

add_callback()
Для добавления обработчиков
set(**kwargs)

Метод для пакетной установки свойств. Передайте kwargs для установки свойств.

set_agg_filter(filter_func)

Установить фильтр agg.

Параметры:
filter_func : callable

Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(alpha)

Установить альфа-прозрачность коллекции. alpha должен быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

Установить состояние анимации объекта.

Параметры:
b : bool
set_antialiased(aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

Псевдоним для set_antialiased

set_array(A)

Установить массив изображения из массива numpy A.

Параметры:
A : ndarray
set_capstyle(cs)

Установить стиль окончания для коллекции. Стиль окончания можно установить только глобально для всех элементов в коллекции.

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль окончания

set_clim(vmin=None, vmax=None)

Установить пределы масштабирования нормы изображения; если vmin является последовательностью длиной 2, интерпретировать ее как (vmin, vmax), что используется для поддержки setp.

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей точкой; может быть переопределен в методах, имеющих vmin и vmax в качестве аргументов.

set_clip_box(clipbox)

Установить область обрезки объекта Bbox.

Параметры:
clipbox : Bbox
set_clip_on(b)

Установить, используется ли обрезка объектом.

Если False, объекты будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:
b : bool
set_clip_path(path, transform=None)

Установить путь обрезки объекта, который может быть:

  • экземпляр Patch (или подкласс); или
  • экземпляр Path, в этом случае экземпляр Transform, который будет применён к пути перед использованием его для обрезки, должен быть предоставлен; или
  • None, для удаления ранее установленного пути обрезки.

Для повышения эффективности, если путь оказывается прямоугольником, выровненным по осям, этот метод установит соответствующую прямоугольную область обрезки и установит путь обрезки в None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(cmap)

установить цветовую карту для данных яркости

Параметры:
cmap : colormap or registered colormap name
set_color(c)

Установить цвет обводки и заливки.

См. также

set_facecolor(), set_edgecolor()
Для установки цвета обводки или заливки отдельно.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

Заменить тест на попадание, используемый этим объектом. Новый пикер должен быть вызываемой функцией, которая определяет, попадает ли объект в область события мыши:

hit, props = picker(artist, mouseevent)

Если событие мыши находится над объектом, вернуть hit = True, а props — словарь свойств, которые вы хотите вернуть с тестом на попадание.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

Псевдоним для set_linestyle

set_edgecolor(c)

Установить цвет(а) обводки коллекции. c может быть спецификацией цвета matplotlib (все фигуры имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, фигуры будут циклически использовать значения из последовательности.

Если c равно 'face', цвет обводки всегда будет таким же, как цвет заливки. Если это 'none', граница фигуры не будет нарисована.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

Псевдоним для set_edgecolor

set_facecolor(c)

Установить цвет(а) заливки коллекции. c может быть спецификацией цвета matplotlib (все фигуры имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, фигуры будут циклически использовать значения из последовательности.

Если c равно 'none', фигура не будет заполнена.

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

Псевдоним для set_facecolor

set_figure(fig)

Устанавливает экземпляр Figure, к которому принадлежит элемент.

Параметры:
fig : Figure
set_gid(gid)

Устанавливает идентификатор (группы) для элемента.

Параметры:
gid : str
set_hatch(hatch)

Устанавливает узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, она увеличивает плотность штриховки этого узора.

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно задать только для всего набора, а не для каждого элемента по отдельности.

Параметры:
hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)

Устанавливает, будет ли элемент включён в расчёты макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layout : bool
set_joinstyle(js)

Устанавливает стиль соединения для набора. Стиль соединения может быть установлен только глобально для всех элементов набора.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Устанавливает метку s для автоматической легенды.

Параметры:
s : object

s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)

Устанавливает стиль(и) линии для набора.

linestyle описание
'-' или 'solid' сплошная линия
'--' или 'dashed' штриховая линия
'-.' или 'dashdot' штрихпунктирная линия
':' или 'dotted' пунктирная линия

В качестве альтернативы можно указать кортеж с длиной, имеющий следующий формат:

(offset, onoffseq),

где onoffseq - кортеж чётной длины с параметрами включения и выключения чернил в пунктах.

Параметры:
ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

Стиль линии.

set_linestyles(*args, **kwargs)

Псевдоним для set_linestyle

set_linewidth(lw)

Устанавливает толщину(ы) линии для набора. lw может быть скалярным значением или последовательностью; если это последовательность, то фигуры будут циклически проходить по этой последовательности.

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

Псевдоним для set_linewidth

set_lw(*args, **kwargs)

Псевдоним для set_linewidth

set_norm(norm)

Устанавливает экземпляр нормализации.

Параметры:
norm : Normalize
set_offset_position(offset_position)

Устанавливает способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования мастера, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования мастера, то есть смещения задаются в координатах данных.

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Устанавливает смещения для набора. offsets может быть скалярным значением или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

Устанавливает эффекты траектории.

Параметры:
path_effects : AbstractPathEffect
set_paths()
set_picker(picker)

Устанавливает эпсилон для выбора, используемый этим элементом.

picker может быть следующим:

  • None: выбор отключён для этого элемента (по умолчанию)
  • Булево значение: если True, то выбор будет включён, и элемент будет вызывать событие выбора, если курсор мыши находится над ним
  • Вещественное число: если picker - число, оно интерпретируется как толеранс эпсилон в пунктах, и элемент будет генерировать событие, если его данные находятся в пределах эпсилон от события мыши. Для некоторых элементов, таких как линии и наборы фигур, элемент может предоставлять дополнительные данные событию выбора, например, индексы данных в пределах эпсилон от события выбора
  • Функция: если picker - вызываемая функция, она является функцией пользователя, которая определяет, попадает ли элемент под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения проверки попадания. Если курсор мыши находится над элементом, возвращает hit=True и props - словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

Устанавливает радиус выбора, используемый для проверок нахождения внутри.

Параметры:
d : float

Радиус выбора, в пунктах.

set_rasterized(rasterized)

Принудительно использовать растровый (битовый) вывод в векторизованном бэкенде.

По умолчанию None, что подразумевает поведение по умолчанию бэкенда.

Параметры:
rasterized : bool or None
set_sizes(sizes, dpi=72.0)

Установить размеры каждого элемента коллекции.

Параметры:
sizes : ndarray or None

Размер, который нужно установить для каждого элемента коллекции. Значение — это «площадь» элемента.

dpi : float

DPI холста. По умолчанию 72.0.

set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:
scale : float, optional

Амплитуда колебания перпендикулярно исходной линии в пикселях. Если scale — None, или если параметр не предоставлен, то фильтр наброска не будет применён.

length : float, optional

Длина колебания вдоль линии в пикселях (по умолчанию 128.0).

randomness : float, optional

Коэффициент масштабирования, с которым длина сжимается или расширяется (по умолчанию 16.0).

set_snap(snap)

Устанавливает параметр привязки, который может быть:

  • True: привязывать вершины к центру ближайшего пикселя
  • False: оставлять вершины как есть
  • None: (автоматический) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

Параметры:
snap : bool or None
set_transform(t)

Установить преобразование объекта.

Параметры:
t : Transform
set_url(url)

Устанавливает URL для объекта.

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_visible(b)

Установить видимость объекта.

Параметры:
b : bool
set_zorder(level)

Установить z-порядок объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры:
level : float
stale

Если объект «недействителен» и требуется перерисовка для согласования вывода с внутренним состоянием объекта.

sticky_edges

x и y списки привязанных границ.

При выполнении автоматической масштабировки, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется — предел просмотра «прилипает» к краю. Типичный пример — гистограммы, где обычно ожидается отсутствие отступа на нижней границе (0) гистограммы.

К этому атрибуту нельзя присваивать значения; однако списки x и y можно изменять на месте по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)

Возвращает нормализованный массив rgba, соответствующий x.

В обычном случае x — это одномерная или двумерная последовательность скаляров, и будет возвращён соответствующий массив ndarray значений rgba, на основе установленной для этого ScalarMappable нормы и цветовой карты.

Есть один особый случай, для обработки изображений, которые уже являются rgb или rgba, таких как те, которые могли быть прочитаны из файла изображения. Если x — это массив ndarray с 3 измерениями, и последнее измерение — 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакое сопоставление не будет выполняться. Массив может быть uint8 или он может быть с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднята ошибка ValueError. Если это массив с маской, то маска будет проигнорирована. Если последнее измерение 3, то параметр alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение 4, параметр alpha игнорируется; он не заменяет существующее значение alpha. Будет поднята ошибка ValueError, если третье измерение отличается от 3 или 4.

В любом случае, если bytes — False (по умолчанию), массив rgba будет представлен числами с плавающей точкой в диапазоне 0-1; если это True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.

Если norm — False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)

Обновить свойства этого объекта из словаря prop.

update_from(other)

Копирование свойств от other в self.

update_scalarmappable()

Если массив скалярной сопоставимости не равен None, обновлять цвета по скалярным данным.

zorder = 0
class matplotlib.collections.StarPolygonCollection(numsides, rotation=0, sizes=(1, ), **kwargs) [source]

Основы: matplotlib.collections.RegularPolyCollection

Отображает набор правильных звезд с numsides вершинами.

numsides
количество сторон многоугольника
rotation
угол поворота многоугольника в радианах
sizes

задает площадь окружности, описанной около правильного многоугольника, в единицах точек^2

Допустимые ключевые аргументы для коллекции:

  • edgecolors: None
  • facecolors: None
  • linewidths: None
  • antialiaseds: None
  • offsets: None
  • transOffset: transforms.IdentityTransform()
  • norm: None (необязательно для matplotlib.cm.ScalarMappable)
  • cmap: None (необязательно для matplotlib.cm.ScalarMappable)

offsets и transOffset используются для перемещения фигуры после отрисовки (по умолчанию без смещений)

Если любой из edgecolors, facecolors, linewidths, antialiaseds равен None, они по умолчанию принимают значение из настроек matplotlib.rcParams для фигуры, в последовательном порядке.

Пример: см. Демонстрация лассо для полного примера:

offsets = np.random.rand(20,2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]
black = (0,0,0,1)

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=(black,),
    linewidths=(1,),
    offsets=offsets,
    transOffset=ax.transData,
    )
add_callback(func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Возвращает id, который полезен для удаления обратного вызова с помощью remove_callback() позже.

add_checker(checker)

Добавляет запись в словарь флагов булевых значений, которые устанавливаются в True, когда изменяется отображаемый объект.

aname = 'Artist'
autoscale()

Автоматически масштабирует пределы скалярных значений в экземпляре norm, используя текущий массив

autoscale_None()

Автоматически масштабирует пределы скалярных значений в экземпляре norm, используя текущий массив, изменяя только пределы, равные None.

axes

Экземпляр Axes, в котором находится элемент управления, или None.

changed()

Вызывается при изменении отображаемого объекта для уведомления всех слушателей обратных вызовов о событии 'changed'.

check_update(checker)

Если отображаемый объект изменился с момента последней проверки, возвращает True; иначе возвращает False.

contains(mouseevent)

Проверяет, произошла ли обработка события мыши внутри коллекции.

Возвращает True | False, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)

Для элементов управления в осях, если ось x поддерживает единицы, преобразует x, используя тип единиц оси x.

convert_yunits(y)

Для элементов управления в осях, если ось y поддерживает единицы, преобразует y, используя тип единиц оси y.

draw(renderer)

Метод отрисовки производных классов.

findobj(match=None, include_self=True)

Поиск объектов элементов управления.

Рекурсивно находит все экземпляры Artist, содержащиеся в self.

match может быть:

  • None: возвращает все объекты, содержащиеся в элементе управления.
  • Функция со сигнатурой boolean = match(artist) для фильтрации совпадений.
  • Экземпляр класса: например, Line2D. Возвращает только элементы управления указанного класса.

Если include_self равно True (по умолчанию), self также включается в список для проверки на соответствие.

format_cursor_data(data)

Возвращает строку данных курсора в отформатированном виде.

get_agg_filter()

Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()

Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается на всех бэкендах.

get_animated()

Возвращает состояние анимации элемента управления.

get_array()

Возвращает массив.

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist элементов.

get_clim()

Возвращает минимальное и максимальное значения пределов цветов для масштабирования изображения.

get_clip_box()

Возвращает область обрезки элемента управления.

get_clip_on()

Возвращает, использует ли элемент управления обрезку.

get_clip_path()

Возвращает путь обрезки элемента управления.

get_cmap()

Возвращает карту цветов.

get_contains()

Возвращает тест _contains, используемый элементом управления, или None для значения по умолчанию.

get_cursor_data(event)

Получает данные курсора для заданного события.

get_dashes(*args, **kwargs)

Псевдоним для get_linestyle.

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

Псевдоним для get_edgecolor.

get_facecolor()
get_facecolors(*args, **kwargs)

Псевдоним для get_facecolor.

get_figure()

Возвращает экземпляр Figure, к которому принадлежит элемент управления.

get_fill()

Возвращает, установлена ли заливка.

get_gid()

Возвращает идентификатор группы.

get_hatch()

Возвращает текущий узор штриховки.

get_in_layout()

Возвращает булевый флаг, True указывающий, включен ли элемент управления в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()
get_label()

Возвращает метку, используемую для этого элемента управления в легенде.

get_linestyle()
get_linestyles(*args, **kwargs)

Псевдоним для get_linestyle

get_linewidth()
get_linewidths(*args, **kwargs)

Псевдоним для get_linewidth

get_lw(*args, **kwargs)

Псевдоним для get_linewidth

get_numsides()
get_offset_position()

Возвращает способ применения смещений для коллекции. Если offset_position равен 'screen', смещение применяется после применения основного преобразования, то есть смещения задаются в координатах экрана. Если offset_position равен 'data', смещение применяется до основного преобразования, то есть смещения задаются в координатах данных.

get_offset_transform()
get_offsets()

Возвращает смещения для коллекции.

get_path_effects()
get_paths()
get_picker()

Возвращает объект пикера, используемый этим элементом.

get_pickradius()
get_rasterized()

Возвращает, будет ли элемент растрирован.

get_rotation()
get_sizes()

Возвращает размеры элементов в коллекции. Значение представляет собой «площадь» элемента.

Возвращает:
sizes : array

«Площадь» каждого элемента.

get_sketch_params()

Возвращает параметры наброска для элемента.

Возвращает:
sketch_params : tuple or None

Кортеж из 3 элементов:

  • scale: Амплитуда колебания перпендикулярно исходной линии.
  • length: Длина колебания вдоль линии.
  • randomness: Коэффициент масштабирования, с которым длина уменьшается или увеличивается.

Может вернуть None, если параметры наброска не были установлены.

get_snap()

Возвращает настройку snap, которая может быть:

  • True: привязка вершин к ближайшему центру пикселя
  • False: оставить вершины как есть
  • None: (автоматически) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

get_tightbbox(renderer)

Как Artist.get_window_extent, но включает любое обрезание.

Параметры:
renderer : RendererBase instance

рендерер, который будет использоваться для отрисовки графиков (т. е. fig.canvas.get_renderer())

Возвращает:
bbox : BboxBase

содержащий рамку ограничительной области (в пикселях координат фигуры).

get_transform()

Возвращает объект Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()

Возвращает путь обрезки с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_transforms()
get_url()

Возвращает URL.

get_urls()
get_visible()

Возвращает видимость элемента.

get_window_extent(renderer)

Получает рамку ограничительной области осей в пространстве отображения. Подклассы должны переопределять для включения в вычисление «плотной» рамки ограничительной области. По умолчанию возвращается пустая рамка ограничительной области в точке (0, 0).

Будьте внимательны при использовании этой функции. Результаты не будут обновляться, если изменяется область окна элемента. Область может изменяться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder()

Возвращает порядок элемента z.

have_units()

Возвращает True, если единицы установлены на осях x или y

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних элементов элемента, содержащих событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure is not None

Возвращает, назначен ли элемент фигуре Figure.

is_transform_set()

Возвращает True, если у Artist явно задано преобразование.

mouseover
pchanged()

Возбуждает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

Обрабатывает событие выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, а у элемента установлен пикер.

pickable()

Возвращает True, если Artist подлежит выбору.

properties()

Возвращает словарь, сопоставляющий имя свойства со значением для всех свойств элемента.

remove()

Удаляет элемент с фигуры, если это возможно. Эффект не будет виден до повторной отрисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim() для обновления пределов осей, если это необходимо.

Примечание: relim() не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)

Удаляет обратный вызов по его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

Установщик свойств в пакетном режиме. Передайте kwargs для установки свойств.

set_agg_filter(filter_func)

Установить фильтр agg.

Параметры:
filter_func : callable

Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3).

set_alpha(alpha)

Установить прозрачность альфа-каналов коллекции. alpha должен быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

Установить состояние анимации элемента.

Параметры:
b : bool
set_antialiased(aa)

Установить состояние антиалиасинга для рендеринга.

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

псевдоним для set_antialiased

set_array(A)

Установить массив изображения из массива NumPy A.

Параметры:
A : ndarray
set_capstyle(cs)

Установить стиль окончания линии для коллекции. Стиль окончания линии может быть установлен только глобально для всех элементов коллекции

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль окончания линии

set_clim(vmin=None, vmax=None)

установить пределы масштабирования нормализации для изображения; если vmin является последовательностью длиной 2, интерпретировать ее как (vmin, vmax), что используется для поддержки setp

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей точкой; может быть переопределён в методах, которые имеют vmin и vmax параметры.

set_clip_box(clipbox)

Установить область обрезки элемента Bbox.

Параметры:
clipbox : Bbox
set_clip_on(b)

Установить, использовать ли элемент обрезку.

Когда False, элементы будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:
b : bool
set_clip_path(path, transform=None)

Установить путь обрезки элемента, который может быть:

  • объект Patch (или подкласс); или
  • объект Path, в этом случае объект Transform, который будет применяться к пути перед использованием его для обрезки, должен быть предоставлен; или
  • None, чтобы удалить ранее установленный путь обрезки.

Для повышения эффективности, если путь оказывается прямоугольником, выровненным по осям, этот метод установит соответствующий прямоугольник в области обрезки и установит путь обрезки в None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(cmap)

установить цветовую карту для данных яркости

Параметры:
cmap : colormap or registered colormap name
set_color(c)

Установить одновременно цвет обводки и заливки.

См. также

set_facecolor(), set_edgecolor()
Для отдельной установки цвета обводки или заливки.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

Заменить тест нахождения, используемый данным элементом. Новый селектор должен быть вызываемой функцией, которая определяет, попадает ли указатель мыши в элемент:

hit, props = picker(artist, mouseevent)

Если указатель мыши находится над элементом, вернуть hit = True и props - словарь свойств, которые вы хотите вернуть с тестом нахождения.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

псевдоним для set_linestyle

set_edgecolor(c)

Установить цвет(ы) обводки коллекции. c может быть спецификацией цвета matplotlib (все области имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, области будут циклически использовать последовательность.

Если c равно 'face', цвет обводки всегда будет таким же, как и цвет заливки. Если это 'none', граница области не будет отображаться.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

псевдоним для set_edgecolor

set_facecolor(c)

Установить цвет(ы) заливки коллекции. c может быть спецификацией цвета matplotlib (все области имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, области будут циклически использовать последовательность.

Если c равно 'none', область не будет заливаться.

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

псевдоним для set_facecolor

set_figure(fig)

Установите экземпляр Figure, к которому принадлежит художник.

Параметры:
fig : Figure
set_gid(gid)

Устанавливает идентификатор (группы) для художника.

Параметры:
gid : str
set_hatch(hatch)

Установить шаблон штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одинаковая буква повторяется, она увеличивает плотность штриховки этого шаблона.

Штриховка поддерживается только в PostScript, PDF, SVG и Agg бэкендах.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всего набора, а не для каждого члена по отдельности.

Параметры:
hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)

Установить, следует ли включать художника в вычисления макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layout : bool
set_joinstyle(js)

Установить стиль соединения для набора. Стиль соединения можно установить только глобально для всех элементов в наборе.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установить метку на s для автоматической легенды.

Параметры:
s : object

s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)

Установить стиль(и) линии для набора.

linestyle описание
'-' or 'solid' сплошная линия
'--' or 'dashed' штриховая линия
'-.' or 'dashdot' штрихпунктирная линия
':' or 'dotted' пунктирная линия

В качестве альтернативы можно указать кортеж черт следующим образом:

(offset, onoffseq),

где onoffseq — кортеж чётной длины «вкл» и «выкл» чернил в пунктах.

Параметры:
ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

Установить ширину линии(й) для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

Установить экземпляр нормализации.

Параметры:
norm : Normalize
set_offset_position(offset_position)

Установить, как применяются смещения. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования главного элемента, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования главного элемента, т.е. смещения находятся в координатах данных.

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установить смещения для набора. offsets может быть скаляром или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

Установить эффекты пути.

Параметры:
path_effects : AbstractPathEffect
set_paths()
set_picker(picker)

Установите эпсилон для выбора, используемый этим художником

picker может быть одним из следующих:

  • None: выбор отключён для этого художника (по умолчанию)
  • Булево значение: если True, выбор будет включён, и художник сгенерирует событие выбора, если событие мыши находится над художником
  • Число с плавающей точкой: если picker — число, оно интерпретируется как эпсилон-допуск в точках, и художник сгенерирует событие, если его данные находятся в пределах эпсилона от события мыши. Для некоторых художников, таких как линии и коллекции участков, художник может предоставить дополнительные данные событию выбора, например, индексы данных в пределах эпсилона от события выбора
  • Функция: если picker — вызываемая функция, это функция пользователя, которая определяет, попадает ли художник под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения тестирования на попадание. если событие мыши находится над художником, верните hit=True, и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

Установите радиус выбора, используемый для тестов на попадание.

Параметры:
d : float

Радиус выбора в пунктах.

set_rasterized(rasterized)

Принудительно включить растровое (битовое) отображение в выходных данных векторного бэкэнда.

По умолчанию None, что подразумевает поведение по умолчанию бэкэнда.

Параметры:
rasterized : bool or None
set_sizes(sizes, dpi=72.0)

Установить размеры каждого элемента коллекции.

Параметры:
sizes : ndarray or None

Размер, который нужно установить для каждого элемента коллекции. Значение является 'площадью' элемента.

dpi : float

Разрешение холста. По умолчанию 72.0.

set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:
scale : float, optional

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale None, или не указано, фильтр наброска не будет применен.

length : float, optional

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0).

randomness : float, optional

Коэффициент масштабирования, с помощью которого длина уменьшается или увеличивается (по умолчанию 16.0).

set_snap(snap)

Устанавливает настройки привязки, которые могут быть:

  • True: привязывает вершины к ближайшему центру пикселя
  • False: оставляет вершины как есть
  • None: (автоматически) Если путь содержит только прямолинейные отрезки, округляет до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

Параметры:
snap : bool or None
set_transform(t)

Установить преобразование художника.

Параметры:
t : Transform
set_url(url)

Устанавливает URL для художника.

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_visible(b)

Установить видимость художника.

Параметры:
b : bool
set_zorder(level)

Установить z-порядок для художника. Художники с меньшими значениями zorder рисуются первыми.

Параметры:
level : float
stale

Если художник 'недействителен' и его нужно перерисовать, чтобы вывод соответствовал внутреннему состоянию художника.

sticky_edges

x и y списки прилипающих границ.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, тогда не будет добавлен отступ — предел просмотра "прилипает" к границе. Типичный пример использования — гистограммы, где обычно не ожидается отступ на нижней границе (0) гистограммы.

К этому атрибуту нельзя присваивать значение; однако списки x и y можно изменять непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)

Возвращает массив rgba, соответствующий x, в нормализованном формате.

В обычном случае x представляет собой 1-мерную или 2-мерную последовательность скаляров, и на основе установленных для этой ScalarMappable нормы и цветовой карты возвращается соответствующий массив значений rgba.

Существует один специальный случай для обработки изображений, которые уже являются rgb или rgba, например, таких, которые были прочитаны из файла изображения. Если x представляет собой массив с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакого преобразования не будет выполнено. Массив может быть uint8 или он может быть с плавающей точкой со значениями в диапазоне от 0 до 1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение аргумента alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующий alpha. Будет поднято исключение ValueError, если третье измерение будет другим, чем 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет представлен числами с плавающей точкой в диапазоне от 0 до 1; если он равен True, возвращаемый массив rgba будет представлен целыми числами uint8 в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне от 0 до 1.

update(props)

Обновить свойства этого художника из словаря prop.

update_from(other)

копировать свойства из other в self

update_scalarmappable()

Если массив скалярного отображения не равен None, обновить цвета из скалярных данных

zorder = 0
class matplotlib.collections.TriMesh(triangulation, **kwargs) [source]

Базы: matplotlib.collections.Collection

Класс для эффективного рисования треугольной сетки с использованием затенения Гуро.

Треугольная сетка — это объект Triangulation.

add_callback(func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Возвращает id, полезный для удаления обратного вызова с помощью remove_callback() позднее.

add_checker(checker)

Добавляет запись в словарь флагов булевого типа, которые устанавливаются в True, когда изменяется отображаемый объект.

aname = 'Artist'
autoscale()

Автомасштабировать пределы скаляров на экземпляре нормы с использованием текущего массива

autoscale_None()

Автомасштабировать пределы скаляров на экземпляре нормы с использованием текущего массива, изменяя только пределы, равные None

axes

Экземпляр Axes, в котором находится художник, или None.

changed()

Вызовите эту функцию всякий раз, когда изменяется отображаемый объект, чтобы уведомить всех слушателей обратных вызовов о событии 'changed'

check_update(checker)

Если отображаемый объект изменился с момента последней проверки, верните True; в противном случае верните False

contains(mouseevent)

Проверить, произошла ли обработка события мыши в коллекции.

Возвращает True | False, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

static convert_mesh_to_paths(tri) [source]

Преобразует заданную сетку в последовательность объектов matplotlib.path.Path для более удобного рендеринга бэкендами, которые не поддерживают сетки напрямую.

Эта функция в основном предназначена для разработчиков бэкэндов.

convert_xunits(x)

Для художников в осях, если ось x поддерживает единицы, преобразуйте x с помощью типа единиц оси x

convert_yunits(y)

Для художников в осях, если ось y поддерживает единицы, преобразуйте y с помощью типа единиц оси y

draw(renderer) [source]

Метод рисования производных классов

findobj(match=None, include_self=True)

Найти объекты художников.

Рекурсивно найти все экземпляры Artist, содержащиеся в self.

match может быть

  • None: вернуть все объекты, содержащиеся в художнике.
  • функция со сигнатурой boolean = match(artist) для фильтрации совпадений
  • экземпляр класса: например, Line2D. Возвратить только художников указанного типа класса.

Если include_self равно True (по умолчанию), включить self в список для проверки совпадения.

format_cursor_data(data)

Вернуть отформатированную строку данных курсора.

get_agg_filter()

Вернуть функцию фильтра для использования с agg-фильтром.

get_alpha()

Возвращает значение alpha, используемое для смешивания - не поддерживается во всех бэкендах

get_animated()

Возвращает состояние анимации художника

get_array()

Возвращает массив

get_capstyle()
get_children()

Возвращает список дочерних Artist`s this :class:`Artist элементов.

get_clim()

Возвращает минимальное и максимальное значения пределов цвета для масштабирования изображения

get_clip_box()

Возвращает область обрезки художника

get_clip_on()

Возвращает, использует ли художник обрезку

get_clip_path()

Возвращает путь обрезки художника

get_cmap()

возвращает карту цветов

get_contains()

Возвращает тест _contains, используемый художником, или None для значения по умолчанию.

get_cursor_data(event)

Получить данные курсора для данного события.

get_dashes(*args, **kwargs)

Псевдоним для get_linestyle

get_datalim(transData)
get_edgecolor()
get_edgecolors(*args, **kwargs)

Псевдоним для get_edgecolor

get_facecolor()
get_facecolors(*args, **kwargs)

Псевдоним для get_facecolor

get_figure()

Возвращает экземпляр Figure, к которому принадлежит художник.

get_fill()

возвращает, установлен ли параметр fill

get_gid()

Возвращает идентификатор группы.

get_hatch()

Возвращает текущий узор штриховки.

get_in_layout()

Возвращает флаг булевого типа, True если художник включен в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()
get_label()

Получить метку, используемую для этого художника в легенде.

get_linestyle()
get_linestyles(*args, **kwargs)

Псевдоним для get_linestyle

get_linewidth()
get_linewidths(*args, **kwargs)

Псевдоним для get_linewidth

get_lw(*args, **kwargs)

Псевдоним для get_linewidth

get_offset_position()

Возвращает, как применяются смещения для коллекции. Если offset_position равен 'screen', смещение применяется после применения преобразования master, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется до преобразования master, т.е. смещения находятся в координатах данных.

get_offset_transform()
get_offsets()

Возвращает смещения для коллекции.

get_path_effects()
get_paths() [исходный код]
get_picker()

Возвращает объект пикера, используемый этим объектом.

get_pickradius()
get_rasterized()

Возвращает, следует ли растрировать объект.

get_sketch_params()

Возвращает параметры рисования в стиле "набросок" для объекта.

Возвращает:
sketch_params : tuple or None

Кортеж из 3 элементов:

  • scale: Амплитуда волнообразности перпендикулярно исходной линии.
  • length: Длина волнообразности вдоль линии.
  • randomness: Коэффициент масштабирования длины.

Может вернуть None, если параметры "наброска" не были заданы.

get_snap()

Возвращает настройку привязки:

  • True: привязка вершин к ближайшему центру пикселя
  • False: оставить вершины как есть
  • None: (автоматически) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

get_tightbbox(renderer)

Аналогично Artist.get_window_extent, но включает в себя все обрезки.

Параметры:
renderer : RendererBase instance

рендерер, который будет использоваться для рисования графиков (т.е. fig.canvas.get_renderer())

Возвращает:
bbox : BboxBase

содержащий прямоугольник обводки (в пикселях графического окна).

get_transform()

Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()

Возвращает обрезку пути вместе с неаффинной частью её преобразования и оставшейся аффинной частью преобразования.

get_transforms()
get_url()

Возвращает URL.

get_urls()
get_visible()

Возвращает видимость объекта.

get_window_extent(renderer)

Получение прямоугольника отображения осей. Подклассы должны переопределять для включения в вычисление "плотного" прямоугольника. По умолчанию возвращает пустой прямоугольник в координатах 0, 0.

Будьте внимательны при использовании этой функции, результаты не будут обновляться, если размеры окна объекта изменятся. Размеры могут измениться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к непредсказуемому поведению, где интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder()

Возвращает z-порядок объекта.

have_units()

Возвращает True, если единицы измерения установлены на осях x или y

hitlist(event)

Устарело начиная с версии 2.2: Функция hitlist устарела в Matplotlib 2.2 и будет удалена в 3.1.

Список дочерних объектов, содержащих событие мыши event.

is_figure_set()

Устарело начиная с версии 2.2: artist.figure is not None

Возвращает, присвоена ли фигура объекту Figure.

is_transform_set()

Возвращает True, если Artist имеет явно заданное преобразование.

mouseover
pchanged()

Вызывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

Обработка события выбора.

Каждый дочерний объект вызовет событие выбора, если mouseevent находится над объектом и у объекта задан пикер.

pickable()

Возвращает True, если Artist доступен для выбора.

properties()

Возвращает словарь, сопоставляющий имена свойств с их значениями для всех свойств объекта.

remove()

Удаляет объект из фигуры, если это возможно. Эффект не будет виден до повторной отрисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim() для обновления пределов осей, если необходимо.

Примечание: relim() не обнаружит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи объекта в легенде.

remove_callback(oid)

Удаление обратного вызова по его id.

См. также

add_callback()
Для добавления обратных вызовов
set(**kwargs)

Устанавливает значения нескольких свойств сразу. Передайте kwargs для установки свойств.

set_agg_filter(filter_func)

Установка фильтра agg.

Параметры:
filter_func : callable

Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3).

set_alpha(alpha)

Устанавливает прозрачность альфы коллекции. alpha должно быть числом с плавающей точкой или None.

Параметры:
alpha : float or None
set_animated(b)

Устанавливает состояние анимации объекта.

Параметры:
b : bool
set_antialiased(aa)

Устанавливает состояние антиалиасинга для отрисовки.

Параметры:
aa : bool or sequence of bools
set_antialiaseds(*args, **kwargs)

Псевдоним для set_antialiased

END_OF_DOCUMENT_MARKER
set_array(A)

Установите массив изображений из массива NumPy A.

Параметры:
A : ndarray
set_capstyle(cs)

Установите стиль обрезки для коллекции. Стиль обрезки может быть установлен только глобально для всех элементов в коллекции

Параметры:
cs : {'butt', 'round', 'projecting'}

Стиль обрезки

set_clim(vmin=None, vmax=None)

Установите пределы нормы для масштабирования изображения; если vmin является последовательностью длиной 2, интерпретируйте её как (vmin, vmax), которая используется для поддержки setp

ПРИНИМАЕТ: последовательность длиной 2 из чисел с плавающей запятой; может быть переопределено в методах, имеющих vmin и vmax параметры.

set_clip_box(clipbox)

Установите область обрезки художника Bbox.

Параметры:
clipbox : Bbox
set_clip_on(b)

Установите, использует ли художник обрезку.

Когда значение равно False, художники будут видимы за пределами осей, что может привести к неожиданным результатам.

Параметры:
b : bool
set_clip_path(path, transform=None)

Установите траекторию обрезки художника, которая может быть:

  • экземпляр Patch (или подкласс); или
  • экземпляр Path, в этом случае экземпляр Transform, который будет применяться к траектории перед использованием её для обрезки, должен быть предоставлен; или
  • None, чтобы удалить ранее установленную траекторию обрезки.

Для повышения эффективности, если траектория оказывается прямоугольником, ориентированным по осям, этот метод установит прямоугольник обрезки в соответствующий прямоугольник и установит траекторию обрезки в None.

ПРИНИМАЕТ: [(Path, Transform) | Patch | None]

set_cmap(cmap)

Установите цветовую карту для данных яркости

Параметры:
cmap : colormap or registered colormap name
set_color(c)

Установите цвет обводки и цвет заливки.

См. также

set_facecolor(), set_edgecolor()
Для установки цвета обводки или заливки по отдельности.
Параметры:
c : matplotlib color arg or sequence of rgba tuples
set_contains(picker)

Замените проверку принадлежности, используемую этим художником. Новый обработчик должен быть вызываемой функцией, которая определяет, попадает ли по курсору мыши художник:

hit, props = picker(artist, mouseevent)

Если курсор мыши находится над художником, возвращайте hit = True и props – словарь свойств, которые вы хотите вернуть с тестом принадлежности.

Параметры:
picker : callable
set_dashes(*args, **kwargs)

псевдоним для set_linestyle

set_edgecolor(c)

Установите цвет(ы) обводки коллекции. c может быть спецификацией цвета matplotlib (все области имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, области будут циклически проходить по последовательности.

Если c равно 'face', цвет обводки всегда будет таким же, как цвет заливки. Если это 'none', граница области не будет отображаться.

Параметры:
c : color or sequence of colors
set_edgecolors(*args, **kwargs)

псевдоним для set_edgecolor

set_facecolor(c)

Установите цвет(ы) заливки коллекции. c может быть спецификацией цвета matplotlib (все области имеют одинаковый цвет) или последовательностью спецификаций; если это последовательность, области будут циклически проходить по последовательности.

Если c равно 'none', область не будет закрашиваться.

Параметры:
c : color or sequence of colors
set_facecolors(*args, **kwargs)

псевдоним для set_facecolor

set_figure(fig)

Установите экземпляр Figure, к которому относится художник.

Параметры:
fig : Figure
set_gid(gid)

Устанавливает идентификатор (группы) для художника.

Параметры:
gid : str
set_hatch(hatch)

Установите узор штриховки

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна и та же буква повторяется, это увеличивает плотность штриховки этого узора.

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

В отличие от других свойств, таких как толщина линии и цвета, штриховку можно указать только для всей коллекции, а не для каждого элемента по отдельности.

Параметры:
hatch : {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)

Установите, должен ли художник быть включён в расчёты макета, например, Руководство по макетам с ограничением, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layout : bool
set_joinstyle(js)

Установите стиль соединения для коллекции. Стиль соединения может быть установлен только глобально для всех элементов в коллекции.

Параметры:
js : {'miter', 'round', 'bevel'}

Стиль соединения

set_label(s)

Установите метку в s для автоматической легенды.

Параметры:
s : object

s будет преобразовано в строку с помощью вызова str.

set_linestyle(ls)

Установите стиль(и) линии для коллекции.

linestyle описание
'-' or 'solid' сплошная линия
'--' or 'dashed' штриховая линия
'-.' or 'dashdot' штрих-пунктирная линия
':' or 'dotted' пунктирная линия

В качестве альтернативы можно указать кортеж штрихов следующего формата:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий длины включений и выключений чернил в пунктах.

Параметры:
ls : {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

Стиль линии.

set_linestyles(*args, **kwargs)

псевдоним для set_linestyle

set_linewidth(lw)

Установите ширину(ы) линии для коллекции. lw может быть скалярным или последовательностью; если это последовательность, то элементы будут циклически проходить по последовательности

Параметры:
lw : float or sequence of floats
set_linewidths(*args, **kwargs)

псевдоним для set_linewidth

set_lw(*args, **kwargs)

псевдоним для set_linewidth

set_norm(norm)

Установите экземпляр нормализации.

Параметры:
norm : Normalize
set_offset_position(offset_position)

Установите способ применения смещений. Если offset_position равен 'screen' (по умолчанию), смещение применяется после применения преобразования master, то есть смещения находятся в координатах экрана. Если offset_position равен 'data', смещение применяется перед преобразованием master, т.е. смещения находятся в координатах данных.

Параметры:
offset_position : {'screen', 'data'}
set_offsets(offsets)

Установите смещения для коллекции. offsets может быть скалярным или последовательностью.

Параметры:
offsets : float or sequence of floats
set_path_effects(path_effects)

Установите эффекты пути.

Параметры:
path_effects : AbstractPathEffect
set_paths() [source]
set_picker(picker)

Установите эпсилон для выбора, используемый этим элементом.

picker может быть одним из следующих:

  • None: выбор отключен для этого элемента (по умолчанию)
  • Булево значение: если True, то выбор будет включен, и элемент будет генерировать событие выбора, если событие мыши находится над ним
  • Число с плавающей запятой: если picker является числом, оно интерпретируется как значение эпсилон-толерантности в пунктах, и элемент будет генерировать событие, если его данные находятся в пределах эпсилон от события мыши. Для некоторых элементов, таких как линии и коллекции фигурок, элемент может предоставить дополнительные данные событию выбора, например, индексы данных, находящихся в пределах эпсилон от события выбора
  • Функция: если picker является вызываемым объектом, это пользовательская функция, которая определяет, является ли элемент попаданием в событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения проверки на попадание. Если событие мыши находится над элементом, возвращается hit=True, а props — это словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

Параметры:
picker : None or bool or float or callable
set_pickradius(pr)

Установите радиус выбора, используемый для проверок на попадание.

Параметры:
d : float

Радиус выбора в пунктах.

set_rasterized(rasterized)

Вынуждает растровый (битовое) отображение в выходных данных векторного бэкенда.

По умолчанию равно None, что подразумевает поведение по умолчанию бэкенда.

Параметры:
rasterized : bool or None
set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры наброска.

Параметры:
scale : float, optional

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не указан, фильтр наброска не будет предоставлен.

length : float, optional

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomness : float, optional

Коэффициент масштабирования, с помощью которого длина сжимается или расширяется (по умолчанию 16.0)

set_snap(snap)

Устанавливает настройку привязки, которая может быть:

  • True: привязка вершин к ближайшему центру пикселя
  • False: оставить вершины как есть
  • None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя

Поддерживается только бэкендами Agg и MacOSX.

Параметры:
snap : bool or None
set_transform(t)

Установите преобразование элемента.

Параметры:
t : Transform
set_url(url)

Устанавливает URL элемента.

Параметры:
url : str
set_urls(urls)
Параметры:
urls : List[str] or None
set_visible(b)

Установить видимость объекта.

Параметры:
b : bool
set_zorder(level)

Установить порядок отрисовки объекта. Объекты с меньшим значением zorder рисуются первыми.

Параметры:
level : float
stale

Если объект нуждается в перерисовке, чтобы соответствовать внутреннему состоянию.

sticky_edges

x и y списки прилипающих границ.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра "прилипает" к границе. Типичный пример использования — гистограммы, где обычно нет отступа на нижней границе (0) гистограммы.

К этому атрибуту нельзя присвоить значение; однако списки x и y можно изменять по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(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 игнорируется; он не заменяет существующий alpha. ValueError будет выведен, если третье измерение не равно 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать значения с плавающей точкой в диапазоне 0-1; если оно равно True, возвращаемый массив rgba будет содержать значения uint8 в диапазоне от 0 до 255.

Если norm равен False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)

Обновить свойства этого объекта из словаря prop.

update_from(other)

Копировать свойства из других объектов в текущий.

update_scalarmappable()

Если массив отображения скаляров не равен None, обновить цвета из скалярных данных

zorder = 0

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.0.0/api/collections_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API