matplotlib.collections
Классы для эффективной отрисовки больших коллекций объектов, которые разделяют большинство свойств, например, большое количество отрезков линий или многоугольников.
Классы не предназначены для такой же гибкости, как их аналоги для отдельных элементов (например, вы не сможете выбрать все стили линий), но они предназначены для быстроты в распространённых случаях использования (например, большой набор сплошных отрезков линий).
- classmatplotlib.collections.AsteriskPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[source]
-
Bases:
RegularPolyCollectionОтображает коллекцию правильных звездочек с numsides вершинами.
- Параметры:
-
- numsidesint
-
Количество сторон многоугольника.
- rotationfloat
-
Угол поворота многоугольника в радианах.
- sizesкортеж float
-
Площадь окружности, описанной вокруг многоугольника, в единицах точек^2.
- **kwargs
-
Передаются в
Collection.
Примеры
См. Демонстрацию Lasso для полного примера:
offsets = np.random.rand(20, 2) facecolors = [cm.jet(x) for x in np.random.rand(20)] collection = RegularPolyCollection( numsides=5, # a pentagon rotation=0, sizes=(50,), facecolors=facecolors, edgecolors=("black",), linewidths=(1,), offsets=offsets, offset_transform=ax.transData, )- add_callback(func)[source]
-
Добавляет функцию обратного вызова, которая вызывается всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funccallable
-
Функция обратного вызова. Она должна иметь сигнатуру:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Значения возврата могут существовать, но игнорируются.
- Возвращает:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автоматически масштабирует пределы скалярного значения в экземпляре norm, используя текущий массив
- autoscale_None()[source]
-
Автоматически масштабирует пределы скалярного значения в экземпляре norm, используя текущий массив, изменяя только пределы, которые равны None
- propertyaxes
-
Экземпляр
Axes, в котором находится элемент, или None.
- changed()[source]
-
Вызывайте это при изменении отображаемого объекта, чтобы уведомить всех слушателей обратного вызова о сигнале 'changed'.
- colorbar
-
Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.
- contains(mouseevent)[source]
-
Проверка, произошла ли событие мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразование x с использованием типа единиц оси x.
Если элемент не находится в Axes или ось x не имеет единиц, возвращается x сам по себе.
- convert_yunits(y)[source]
-
Преобразование y с использованием типа единиц оси y.
Если элемент не находится в Axes или ось y не имеет единиц, возвращается y сам по себе.
- draw(renderer)[source]
-
Отрисовка элемента (и его дочерних элементов) с помощью данного рендерера.
Это не имеет эффекта, если элемент не виден (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределен в подклассах Artist.
- findobj(match=None, include_self=True)[source]
-
Поиск элементов-объектов.
Рекурсивно находит все экземпляры
Artist, содержащиеся в элементе.- Параметры:
-
- match
-
Критерий фильтрации соответствий. Это может быть:
- None: Возвращает все объекты, содержащиеся в элементе.
- Функция с сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только элементы этого класса или его подклассов (isinstanceпроверка).
- include_selfbool
-
Включить self в список для проверки на соответствие.
- Возвращает:
-
- Список
Artist
- Список
- format_cursor_data(data)[source]
-
Возвращает строковое представление данных data.
Примечание
Этот метод предназначен для переопределения подклассами художников. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у художника нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра для использования с фильтром agg.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается на всех бэкендах.
- get_animated()[source]
-
Возвращает, анимирован ли художник.
- get_array()[source]
-
Возвращает массив значений, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (минимум, максимум), которые отображаются в пределы цветовой карты.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает, использует ли художник обрезку.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для заданного события.
Примечание
Этот метод предназначен для переопределения подклассами художников. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
Данные курсора могут быть использованы художниками для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация просто возвращает None.
Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z объекта
AxesImageв строке состояния окна графика при перемещении мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит данный элемент.
- get_fill()[source]
-
Возвращает, закрашена ли фигура.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий шаблон штриховки.
- get_in_layout()[source]
-
Возвращает логическое значение,
Trueесли элемент включен в вычисления макета.Например, Руководство по макетам с ограничением,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает значение, указывающее, запрашивает ли данный элемент пользовательскую контекстную информацию при перемещении курсора мыши над ним.
- get_numsides()[source]
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый для смещения данного элемента.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора объекта.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает, будет ли элемент растрирован.
- get_rotation()[source]
- get_sizes()[source]
-
Возвращает размеры (площади) элементов в коллекции.
- Возвращает:
-
- массив
-
Площадь каждого элемента.
- get_sketch_params()[source]
-
Возвращает параметры наброска для элемента.
- Возвращает:
-
- кортеж или None
-
Кортеж из 3 элементов:
- scale: Амплитуда колебаний перпендикулярно исходной линии.
- length: Длина колебания вдоль линии.
- randomness: Коэффициент масштабирования, с которым длина сжимается или растягивается.
Возвращает None, если параметры наброска не были установлены.
- get_snap()[source]
-
Возвращает значение параметра приближения.
Подробности см. в
set_snap.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любые обрезки.- Параметры:
-
-
renderer
RendererBaseподкласс -
Рендерер, который будет использован для отрисовки графиков (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Охватывающая область (в пикселях координат рисунка).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает путь обрезки с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL. См. Гиперссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получить область заполнения элемента на экране.
Ширина и высота области заполнения неотрицательны.
Подклассы должны переопределять для включения в вычисление области заполнения "плотно". По умолчанию возвращается пустая область заполнения в координатах 0, 0.
Будьте внимательны при использовании этой функции, результаты не будут обновляться, если изменится область заполнения элемента на экране. Область заполнения может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемой области рисования (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, где интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.
- get_zorder()[source]
-
Возвращает порядок отрисовки элемента.
- have_units()[source]
-
Возвращает, установлены ли единицы измерения на любой оси.
- is_transform_set()[source]
-
Возвращает, задано ли преобразование для элемента.
Это True после вызова
set_transform.
- свойствоmouseover
-
Возвращает, запрашивается ли у этого элемента пользовательская информация о контексте при перемещении курсора мыши над ним.
- свойствоnorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутри при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обработка события выбора.
Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом и у элемента установлен picker.
См. также
- pickable()[source]
-
Возвращает, может ли элемент быть выбранным.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента.
- remove()[source]
-
Удаляет элемент с фигуры, если это возможно.
Эффект будет виден только после перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Для обновления пределов осей используйтеrelim.Примечание:
relimне обнаружит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи элемента в легенду.
- remove_callback(oid)[source]
-
Удаляет обратный вызов по идентификатору наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить сразу несколько свойств.
Поддерживаемые свойства:
Свойство
Описание
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, а возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
массив-подобный объект, скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
массив-подобный объект или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Path, Transform) или None
Colormapили str или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список таких кортежей
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массив-подобный объект
неизвестно
None или bool или число с плавающей точкой или вызываемый объект
неизвестно
bool
sizesnumpy.ndarrayили None(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
bool
число с плавающей точкой
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
-
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения.
- set_alpha(alpha)[source]
-
Установить значение альфа, используемое для смешивания - не поддерживается на всех бэкендах.
- Параметры:
-
- alphaмассив-подобный объект или скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли элемент для использования в анимации.
Если True, элемент исключается из обычного рисования фигуры. Вам необходимо явно вызвать
Figure.draw_artist/Axes.draw_artistдля элемента. Этот подход используется для ускорения анимации с помощью буферизации.См. также
matplotlib.animationи Более быстрое отрисовка с помощью буферизации.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для отрисовки.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массива-подобного объекта A.
- Параметры:
-
- Aмассив-подобный объект или None
-
Значения, которые отображаются в цветах.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить стиль окончания
CapStyleдля коллекции (для всех её элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы масштабирования изображения для нормализации.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также могут быть переданы как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.
- set_clip_box(clipbox)[source]
-
Установить область обрезки элемента
Bbox.- Параметры:
-
-
clipbox
Bbox -
Обычно создается из
TransformedBbox. НапримерTransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)— это стандартная область обрезки для элемента, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли элемент обрезку.
Если False, элементы будут видимы за пределами Axes, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установить область обрезки для элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, то необходимо также указать transform. Если None, то ранее установленная область обрезки будет удалена. -
transform
Transform, необязательно -
Используется только если path является
Path, в этом случае заданныйPathпреобразуется вTransformedPathс использованием transform.
-
path
Примечания
Для повышения эффективности, если path является
Rectangle, этот метод установит прямоугольную область обрезки и задаст область обрезки в видеNone.По техническим причинам (поддержка
set) также принимается кортеж (path, transform) как один позиционный параметр.
- set_cmap(cmap)[source]
-
Установить цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили str или None
-
cmap
- set_color(c)[source]
-
Установить цвет обводки и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для отдельной установки цвета обводки или заливки.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет(цвета) обводки коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(цвета) обводки коллекции. Если последовательность, фигуры циклически используют цвета из нее. Если 'face', цвет соответствует цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет(цвета) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать цвета из последовательности.
Если c равно 'none', фигура не будет заливаться.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому относится элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор группы для объекта.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, нужно ли включать объект в вычисления макета, например, Руководство по ограниченным макетам,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sobject
-
s будет преобразовано в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль линии(ей) для набора.
стиль_линии
описание
'-'или'solid'сплошная линия
'--'или'dashed'штриховая линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно указать кортеж с отступами следующей формы:
(offset, onoffseq),
где
onoffseq- кортеж чётной длины, содержащий значения включения и выключения чернил в пунктах.- Параметры:
-
- lsstr или кортеж или список кортежей
-
Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения)}. Смотрите
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить ширину линии(ей) для набора. lw может быть скалярным или последовательностью; если это последовательность, области будут циклически проходить через последовательность.
- Параметры:
-
- lwfloat или список чисел с плавающей точкой
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установить, запрашивается ли у этого элемента информация о контексте при перемещении курсора мыши над ним.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установить экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если есть какие-либо цветовые шкалы, использующие mappable для этой нормализации, установка нормализации mappable сбросит нормализацию, локаторор и форматеры на цветовой шкале до значений по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установить преобразование смещения элемента.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установить смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Установить эффекты траектории.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(paths)[source]
- set_picker(picker)[source]
-
Определить поведение выбора элемента.
- Параметры:
-
- pickerNone или bool или float или вызываемый объект
-
Это может быть одно из следующего:
- None: Выбор отключён для данного элемента (значение по умолчанию).
- Булево значение: Если True, то выбор включён, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
- Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск в пунктах, и элемент сгенерирует событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции фигур, элемент может предоставить дополнительные данные для события выбора, например, индексы данных, находящихся в пределах допуска от события выбора.
-
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, определяющая, попадает ли элемент под событие мыши:
hit, props = picker(artist, mouseevent)
для определения проверки попадания. Если курсор мыши находится над элементом, возвращайте hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установить радиус выбора, используемый для проверок попадания в область.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в пунктах.
- set_rasterized(rasterized)[source]
-
Принудительно использовать растровое (битовое) отображение для векторной графики.
Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить это для элемента, который его не поддерживает, команда не окажет никакого влияния, и будет выведено сообщение об ошибке.
Это значение игнорируется для выходных данных на основе пикселей.
См. также Растризация для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sizes(sizes, dpi=72.0)[source]
-
Установить размеры каждого элемента коллекции.
- Параметры:
-
-
sizes
numpy.ndarrayили None -
Размер для каждого элемента коллекции. Значение — «площадь» элемента.
- dpifloat, по умолчанию: 72
-
Точки на дюйм холста.
-
sizes
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры размытия.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен
Noneили не указан, фильтр размытия не будет применён. - lengthfloat, необязательно
-
Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Множитель масштаба, на который уменьшается или увеличивается длина (по умолчанию 16.0)
Фронт-энд PGF использует этот аргумент как семя генератора случайных чисел, а не как описано выше. Использование одного и того же семени приводит к одному и тому же случайному рисунку.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельным сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в обеих соседних пиксельных позициях. Напротив, привязка сместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только фронт-ендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к ближайшему центру пикселя.
- False: Не изменять позиции вершин.
- None: (авто) Если путь содержит только прямолинейные сегменты, округлять до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование объекта.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для объекта.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок из str или None
Примечания
URL в настоящее время реализованы только в фронт-энде SVG. Они игнорируются во всех остальных фронт-ендах.
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок объекта. Объекты с более низкими значениями z-порядка рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли объект устаревшим и требует перерисовки, чтобы выходной результат соответствовал внутреннему состоянию объекта.
- propertysticky_edges
-
xиyсписки привязных границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется — пределы просмотра «прилипают» к границе. Типичный пример использования — гистограммы, где обычно ожидается отсутствие отступа на нижней границе (0) гистограммы.
Кроме того, расширение отступа «упирается» в привязные границы и не может их пересечь. Например, если верхний предел данных составляет 1,0, вычисленный верхний предел просмотра с помощью простого добавления отступа равен 1,2, но есть привязная граница в 1,1, то фактический верхний предел просмотра будет 1,1.
Этому атрибуту нельзя присвоить значение; однако, списки
xиyможно изменять непосредственно по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает нормализованный массив 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)[source]
-
Обновляет свойства этого объекта из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копирует свойства из other в себя.
- update_scalarmappable()[source]
-
Обновляет цвета из массива скалярной карты, если таковой имеется.
Назначает цвета краям и граням на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.
- zorder=0
- classmatplotlib.collections.BrokenBarHCollection(xranges, yrange, **kwargs)[source]
-
Bases:
PolyCollection[Устаревший] Коллекция горизонтальных столбцов, охватывающих yrange с последовательностью xranges.
Примечания
Устарело начиная с версии 3.7.
- Параметры:
-
- xrangesсписок из (float, float)
-
Последовательность пар (позиция левого края, ширина) для каждой полосы.
- yrange(float, float)
-
Общие для всех полос значения (нижний край, высота).
- **kwargs
-
Передаётся в
Collection.
- add_callback(func)[source]
-
Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funccallable
-
Функция обратного вызова. Она должна иметь сигнатуру:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Возвращаемые значения могут существовать, но игнорируются.
- Возвращает:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автоматически масштабирует пределы скаляров в экземпляре нормы, используя текущий массив
- autoscale_None()[source]
-
Автоматически масштабирует пределы скаляров в экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None
- propertyaxes
-
Экземпляр
Axes, в котором находится элемент, или None.
- changed()[source]
-
Вызывайте это всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей обратных вызовов о сигнале 'changed'.
- colorbar
-
Последняя связанная с этим ScalarMappable цветная шкала. Может быть None.
- contains(mouseevent)[source]
-
Проверяет, произошло ли событие мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразует x, используя тип единиц измерения оси x.
Если элемент не содержится в оси Axes или у оси x нет единиц измерения, возвращается x.
- convert_yunits(y)[source]
-
Преобразует y, используя тип единиц измерения оси y.
Если элемент не содержится в оси Axes или у оси y нет единиц измерения, возвращается y.
- draw(renderer)[source]
-
Рисует элемент (и его дочерние элементы) с помощью заданного рендерера.
Это не имеет эффекта, если элемент не виден (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределяется в подклассах элементов.
- findobj(match=None, include_self=True)[source]
-
Поиск элементов графических объектов.
Рекурсивно находит все экземпляры
Artist, содержащиеся в элементе.- Параметры:
-
- match
-
Критерий фильтрации соответствий. Может быть
- None: Возвращает все объекты, содержащиеся в элементе.
- Функция со сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только элементы этого класса или его подклассов (проверкаisinstance).
- include_selfbool
-
Включить self в список для проверки соответствия.
- Возвращает:
-
- список из
Artist
- список из
- format_cursor_data(data)[source]
-
Возвращает строковое представление данных.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Пользователям Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые и вещественные числа и массивы целых и вещественных чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у элемента нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра для использования с фильтром agg.
- get_alpha()[source]
-
Возвращает значение альфа-канала для смешивания. Не поддерживается во всех бэкендах.
- get_animated()[source]
-
Возвращает, анимирован ли элемент.
- get_array()[source]
-
Возвращает массив значений, которые сопоставляются с цветами.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (минимум, максимум), которые сопоставляются с пределами цветовой карты.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает, использует ли элемент обрезку.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для данного события.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Пользователям Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация просто возвращает None.
Подклассы могут переопределять метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z
AxesImageв строке состояния окна графика при перемещении мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому относится данный элемент.
- get_fill()[source]
-
Возвращает значение, указывающее, окрашивается ли лицо.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий шаблон штриховки.
- get_in_layout()[source]
-
Возвращает логическое значение,
Trueесли элемент включён в вычисления макета.Например, Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для данного элемента в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает значение, указывающее, запрашивается ли информация о пользовательском контексте у этого элемента при перемещении курсора мыши.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим смещённым элементом.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает значение растрирования элемента.
- get_sizes()[source]
-
Возвращает размеры (площади) элементов в коллекции.
- Возвращает:
-
- массив
-
Площадь каждого элемента.
- get_sketch_params()[source]
-
Возвращает параметры наброска для элемента.
- Возвращает:
-
- кортеж или None
-
Кортеж из 3 элементов:
- масштаб: Амплитуда колебания, перпендикулярного исходной линии.
- длина: Длина колебания вдоль линии.
- случайность: Коэффициент масштабирования, по которому длина сжимается или расширяется.
Возвращает None, если параметры наброска не были заданы.
- get_snap()[source]
-
Возвращает установку приближения.
Подробности см. в
set_snap.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любое обрезание.- Параметры:
-
-
renderer
RendererBaseподкласс -
рендерер, который будет использоваться для отрисовки графиков (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Охватывающая область (в пикселях координат фигуры).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает путь обрезки с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL-адресов, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL. См. Ссылки для примера.
- get_visible()[source]
-
Возвращает значение видимости.
- get_window_extent(renderer=None)[source]
-
Получение области элемента на экране.
Ширина и высота области неотрицательны.
Подклассы должны переопределять для включения в вычисление области «удобного» размера. По умолчанию возвращает пустую область в координатах 0, 0.
Будьте внимательны при использовании этой функции, результаты не обновляются, если изменяется область окна элемента. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.
- get_zorder()[source]
-
Возвращает z-порядок объекта.
- have_units()[source]
-
Возвращает значение, указывающее, установлены ли единицы измерения на какой-либо оси.
- is_transform_set()[source]
-
Возвращает, задан ли трансформация объекта.
Это True после вызова
set_transform.
- propertymouseover
-
Возвращает, запрашивается ли у объекта дополнительная информация о контексте при наведении курсора.
- propertynorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутренне при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обрабатывает событие выбора.
Каждый дочерний объект вызовет событие выбора, если mouseevent находится над ним, и у объекта задан обработчик выбора.
См. также
- pickable()[source]
-
Возвращает, может ли объект быть выбран.
См. также
- properties()[source]
-
Возвращает словарь со всеми свойствами объекта.
- remove()[source]
-
Удаляет объект из фигуры, если это возможно.
Эффект будет виден только после перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Вызовитеrelimдля обновления пределов осей, если это необходимо.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи легенды объекта.
- remove_callback(oid)[source]
-
Удаляет обратный вызов по его идентификатору наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установка нескольких свойств сразу.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
массивоподобный объект или скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
массивоподобный объект или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
объект Patch или (Path, Transform) или None
Colormapили str или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массивоподобный объект
список массивоподобных объектов
None или bool или число с плавающей точкой или вызываемая функция
неизвестно
bool
sizesnumpy.ndarrayили None(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
список массивоподобных объектов
неизвестно
bool
число с плавающей точкой
-
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения
- set_alpha(alpha)[source]
-
Установить значение альфа-канала, используемое для смешивания – не поддерживается во всех бэкендах.
- Параметры:
-
- alphaмассив или скаляр или None
-
Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли объект для использования в анимации.
Если True, объект исключается из обычного рисования фигуры. Вам необходимо явно вызвать
Figure.draw_artist/Axes.draw_artistна объекте. Этот подход используется для ускорения анимации с помощью блиттинга.См. также
matplotlib.animationи Более быстрое отображение с помощью блиттинга.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для рендеринга.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного A.
- Параметры:
-
- Aмассив или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить
CapStyleдля коллекции (для всех её элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормы для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.
- set_clip_box(clipbox)[source]
-
Установить область обрезки объекта
Bbox.- Параметры:
-
-
clipbox
Bbox -
Как правило, создается из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)является стандартной обрезкой для объекта, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли объект обрезку.
Когда False, объекты будут видны за пределами Axes, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установить область обрезки элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, transform также должен быть предоставлен. Если None, ранее установленная область обрезки удаляется. -
transform
Transform, необязательно -
Используется только если path является
Path, в этом случае заданныйPathпреобразуется вTransformedPathс использованием transform.
-
path
Примечания
Для повышения эффективности, если path является
Rectangle, этот метод установит область обрезки для соответствующего прямоугольника и установит область обрезки вNone.По техническим причинам (поддержка
set) также допускается кортеж (path, transform) в качестве единственного позиционного параметра.
- set_cmap(cmap)[source]
-
Установить палитру для данных яркости.
- Параметры:
-
-
cmap
Colormapили str или None
-
cmap
- set_color(c)[source]
-
Установить цвет обводки и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для отдельного задания цвета обводки или заливки.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет(ы) обводки коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(ы) обводки коллекции. Если последовательность, элементы поочередно используют значения из неё. Если 'face', соответствует цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет(ы) заливки коллекции. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если это последовательность, элементы будут циклически использовать цвета из неё.
Если c равно 'none', элемент не будет заливаться.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому принадлежит элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор (группы) для объекта.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, следует ли включать объект в вычисления макета, например, Руководство по макетам с ограниченным размером,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sобъект
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль(и) линии для набора.
linestyle
описание
'-'или'solid'сплошная линия
'--'или'dashed'штриховая линия
'-.'или'dashdot'штрих-пунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно предоставить кортеж с типом штриховки следующего формата:
(offset, onoffseq),
где
onoffseqпредставляет собой кортеж чётной длины с указанием включения и выключения чернил в пунктах.- Параметры:
-
- lsstr или кортеж или список
-
Допустимые значения для отдельных стилей линии включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См.
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить ширину(ы) линии(й) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, элементы будут перебираться в последовательности
- Параметры:
-
- lwfloat или список float
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установите, запрашивается ли у этого объекта информация о контексте при наведении курсора мыши.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установите экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если существуют какие-либо цветовые шкалы, использующие mappable для этой нормализации, установка нормализации mappable сбросит нормализацию, локатор и форматировщики на цветовой шкале по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установите трансформирование смещения объекта.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установите смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Установите эффекты пути.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(verts, closed=True)[source]
-
Установите вершины многоугольников.
- Параметры:
-
- vertsсписок массивоподобных объектов
-
Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массив-подобный объект формы (M, 2).
- closedbool, по умолчанию: True
-
Закрыть ли многоугольник, добавив соединение CLOSEPOLY в конце.
- set_picker(picker)[source]
-
Определите поведение выбора объекта.
- Параметры:
-
- pickerNone или bool или float или вызываемая функция
-
Это может быть одно из следующих:
- None: Выбор отключён для этого объекта (по умолчанию).
- Булево значение: Если True, выбор будет включён, и объект сгенерирует событие выбора, если курсор мыши находится над ним.
- Число с плавающей точкой: Если picker является числом, оно интерпретируется как толерантность в точках, и объект сгенерирует событие, если его данные находятся в пределах толерантности от события мыши. Для некоторых объектов, таких как линии и коллекции объектов, объект может предоставить дополнительные данные для события выбора, например, индексы данных в пределах толерантности от события выбора
-
Вызываемая функция: Если picker является вызываемой функцией, это пользовательская функция, которая определяет, попадает ли объект под действие события мыши:
hit, props = picker(artist, mouseevent)
для определения проверки попадания. Если курсор мыши находится над объектом, вернуть hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установите радиус выбора, используемый для проверок попадания.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора, в точках.
- set_rasterized(rasterized)[source]
-
Вынудить растровый (битовое) отображение для векторной графики.
Растровый вывод не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не подействует, и будет выведено предупреждение.
Это настройка игнорируется для выходных данных на основе пикселей.
См. также Растеризация для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sizes(sizes, dpi=72.0)[source]
-
Установите размеры каждого элемента коллекции.
- Параметры:
-
-
sizes
numpy.ndarrayили None -
Размер для установки каждого элемента коллекции. Значение — «площадь» элемента.
- dpifloat, по умолчанию: 72
-
Точки на дюйм холста.
-
sizes
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний, перпендикулярных исходной линии, в пикселях. Если scale равен
None, или не задан, фильтр наброска не будет применён. - lengthfloat, необязательно
-
Длина колебаний вдоль линии, в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Множитель масштаба, на который уменьшается или увеличивается длина (по умолчанию 16.0)
Бэкенд PGF использует этот аргумент как семя генератора случайных чисел, а не как описано выше. Использование одного и того же семени даёт одну и ту же случайную форму.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если определена чёрная линия шириной 1 пиксель в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, то есть серые значения на двух соседних пиксельных позициях. В противоположность этому, привязка переместит линию к ближайшему целочисленному значению пикселя, так что результирующее изображение будет действительно содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к центру ближайшего пикселя.
- False: Не изменять позиции вершин.
- None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование художника.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для художника.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок str или None
Замечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_verts(verts, closed=True)[source]
-
Установить вершины многоугольников.
- Параметры:
-
- vertsсписок массивов
-
Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массив-подобный объект формы (M, 2).
- closedbool, по умолчанию: True
-
Закрывать ли многоугольник добавлением соединения CLOSEPOLY в конце.
- set_verts_and_codes(verts, codes)[source]
-
Инициализировать вершины с кодами пути.
- set_visible(b)[source]
-
Установить видимость художника.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок для художника. Художники с более низкими значениями z-порядка рисуются первыми.
- Параметры:
-
- levelfloat
- classmethodspan_where(x, ymin, ymax, where, **kwargs)[source]
-
[Устарело] Возвращает
BrokenBarHCollection, который рисует горизонтальные полосы по областям в x, где where истинно. Полосы охватывают ось y от ymin до ymaxkwargs передаются в коллекцию.
Замечания
Устарело начиная с версии 3.7: Используйте fill_between вместо этого.
- propertystale
-
Является ли художник 'нестабильным' и требует перерисовки, чтобы выход соответствовал внутреннему состоянию художника.
- свойствоsticky_edges
-
xиyсписки прилипающих границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра "прилипает" к краю. Типичный случай использования — гистограммы, где обычно ожидается отсутствие отступа на нижнем краю (0) гистограммы.
Кроме того, расширение отступа "упирается" в прилипающие края и не может их пересечь. Например, если верхний предел данных равен 1,0, верхний предел просмотра, вычисленный с помощью простого применения отступа, равен 1,2, но есть прилипающий край в 1,1, то фактический верхний предел просмотра будет 1,1.
К этому атрибуту нельзя присвоить значение; однако списки
xиyможно изменять по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает нормализованный массив 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)[source]
-
Обновить свойства этого объекта-артиста из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копирование свойств из other в self.
- update_scalarmappable()[source]
-
Обновление цветов из массива объекта со скалярным отображением, если таковой имеется.
Назначение цветов к границам и граням на основе массива и/или цветов, которые были непосредственно установлены, по мере необходимости.
- zorder=0
- классmatplotlib.collections.CircleCollection(sizes, **kwargs)[source]
-
Базы:
_CollectionWithSizesКоллекция окружностей, нарисованных с помощью сплайнов.
- Параметры:
-
- sizesfloat или array-like
-
Площадь каждой окружности в пунктах^2.
- **kwargs
-
Передаётся в
Collection.
- add_callback(func)[source]
-
Добавить функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funccallable
-
Функция обратного вызова. Она должна иметь сигнатуру:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Значения возврата могут существовать, но игнорируются.
- Возвращает:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью
remove_callbackпозднее.
См. также
- autoscale()[source]
-
Автоматически масштабирует пределы скалярных значений на экземпляре нормы, используя текущий массив
- autoscale_None()[source]
-
Автоматически масштабирует пределы скалярных значений на экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None
- propertyaxes
-
Экземпляр
Axes, в котором находится элемент, или None.
- changed()[source]
-
Вызовите это, когда карта значений изменена, чтобы уведомить всех слушателей обратного вызова о сигнале 'changed'.
- colorbar
-
Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.
- contains(mouseevent)[source]
-
Проверить, произошла ли обработка события мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразовать x, используя тип единиц измерения оси x.
Если элемент не содержится в Axes или у оси x нет единиц измерения, возвращается сам x.
- convert_yunits(y)[source]
-
Преобразовать y, используя тип единиц измерения оси y.
Если элемент не содержится в Axes или у оси y нет единиц измерения, возвращается сам y.
- draw(renderer)[source]
-
Отрисовать элемент (и его потомков) с помощью указанного рендерера.
Это не оказывает никакого влияния, если элемент не отображается (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределяется в подклассах элемента.
- findobj(match=None, include_self=True)[source]
-
Найти элементы художника.
Рекурсивно найти все
Artistэкземпляры, содержащиеся в элементе.- Параметры:
-
- match
-
Критерий фильтрации совпадений. Может быть
- None: Возвратить все элементы, содержащиеся в элементе.
- Функция с сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только те элементы, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только элементы этого класса или его подклассов (проверкаisinstance).
- include_selfbool
-
Включить self в список, проверяемый на соответствие.
- Возвращает:
-
- список
Artist
- список
- format_cursor_data(data)[source]
-
Возвращает строковое представление data.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Вероятно, пользователь Matplotlib не будет вызывать этот метод.
По умолчанию преобразования целых и дробных чисел и массивов целых и дробных чисел в строку, разделенную запятыми, заключенную в квадратные скобки, за исключением случаев, когда у элемента есть связанная цветовая шкала, в этом случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра, используемую для фильтрации agg.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается во всех бэкендах.
- get_animated()[source]
-
Возвращает значение, определяющее, анимирован ли элемент.
- get_array()[source]
-
Возвращает массив значений, сопоставляемых с цветами.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (мин, макс), которые отображаются в пределах цветовой карты.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает значение, указывающее, использует ли элемент обрезку.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для данного события.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Пользователь Matplotlib, скорее всего, не будет вызывать этот метод самостоятельно.
Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.
Подклассы могут переопределять метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z элемента
AxesImageв строке состояния окна графика при перемещении указателя мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит элемент.
- get_fill()[source]
-
Возвращает значение, указывающее, закрашивается ли лицо.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий шаблон штриховки.
- get_in_layout()[source]
-
Возвращает логическое значение,
Trueесли элемент включён в вычисления макета.Например, Руководство по ограниченному макету,
Figure.tight_layout(), иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает значение, указывающее, запрашивается ли у этого элемента информация о контексте при перемещении указателя мыши над ним.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим смещением элемента.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает, растрируется ли элемент графического объекта.
- get_sizes()[source]
-
Возвращает размеры (площади) элементов в коллекции.
- Возвращаемое значение:
-
- массив
-
Площадь каждого элемента.
- get_sketch_params()[source]
-
Возвращает параметры рисования эскиза для графического объекта.
- Возвращаемое значение:
-
- кортеж или None
-
Кортеж из 3 элементов:
- scale: Амплитуда колебания перпендикулярно исходной линии.
- length: Длина колебания вдоль линии.
- randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.
Возвращает None, если параметры эскиза не были заданы.
- get_snap()[source]
-
Возвращает значение настройки snap.
См.
set_snapдля получения подробностей.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любой обрез.- Параметры:
-
-
renderer
RendererBaseподкласс -
объект рендера, который будет использоваться для отрисовки графиков (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращаемое значение:
-
Bbox-
Охватывающая область (в пикселях координат фигуры).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим объектом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает путь обрезки с применённой к нему частью преобразования, не зависящую от аффинного преобразования, и оставшейся аффинной частью преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному на каждый элемент коллекции.
Список содержит None для элементов без URL. См. Ссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получить область объекта в пространстве отображения.
Ширина и высота прямоугольника неотрицательны.
Подклассы должны переопределять для включения в вычисление "жесткой" области. По умолчанию возвращает пустую область в 0, 0.
Будьте осторожны при использовании этой функции, результаты не обновляются, если область отображения объекта изменяется. Область может измениться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.
- get_zorder()[source]
-
Возвращает z-порядок объекта.
- have_units()[source]
-
Возвращает, установлены ли единицы на какой-либо оси.
- is_transform_set()[source]
-
Возвращает, имеет ли графический объект явно установленное преобразование.
Это True после вызова
set_transform.
- свойствоmouseover
-
Возвращает значение, указывающее, запрашивается ли у этого объекта информация о пользовательском контексте, когда курсор мыши находится над ним.
- свойствоnorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутри при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обработка события выбора.
Каждый дочерний объект-графический элемент вызовет событие выбора, если mouseevent находится над объектом и для объекта установлен параметр picker.
См. также
- pickable()[source]
-
Возвращает значение, указывающее, может ли объект быть выбран.
См. также
- properties()[source]
-
Возвращает словарь всех свойств графического элемента.
- remove()[source]
-
Удаляет графический элемент из рисунка, если это возможно.
Эффект не будет виден до перерисовки рисунка, например, с помощью
FigureCanvasBase.draw_idle. Вызовитеrelim, чтобы обновить пределы осей, если это необходимо.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.Примечание: нет поддержки удаления записи легенды графического элемента.
- remove_callback(oid)[source]
-
Удаление обратного вызова по его идентификатору наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить сразу несколько свойств.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
массивоподобный объект или скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
массивоподобный объект или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Path, Transform) или None
Colormapили строка или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массивоподобный объект
неизвестно
None или bool или число с плавающей точкой или вызываемая функция
неизвестно
bool
sizesnumpy.ndarrayили None(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
bool
число с плавающей точкой
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
-
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив (m, n, глубина) и два смещения от нижнего левого угла изображения
- set_alpha(alpha)[source]
-
Установить значение альфа, используемое для смешивания - не поддерживается во всех бэкэндах.
- Параметры:
-
- alphaмассив-подобный объект или скаляр или None
-
Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли художник для использования в анимации.
Если True, художник исключается из обычного рисования фигуры. Вам необходимо явно вызвать
Figure.draw_artist/Axes.draw_artistна художнике. Этот подход используется для ускорения анимации с помощью кеширования.См. также
matplotlib.animationи Более быстрое отображение с помощью кеширования.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для рендеринга.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного объекта A.
- Параметры:
-
- Aмассив-подобный объект или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить
CapStyleдля коллекции (для всех её элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормы для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также могут быть переданы как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.
- set_clip_box(clipbox)[source]
-
Установить область обрезки художника
Bbox.- Параметры:
-
-
clipbox
Bbox -
Обычно создаётся из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)- это стандартная обрезка для художника, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли художник обрезку.
Если False, художники будут видны за пределами Axes, что может привести к непредвиденным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установить область обрезки для элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, необходимо также указать transform. Если None, ранее заданная область обрезки удаляется. -
transform
Transform, необязательно -
Используется только если path является
Path, в этом случае заданныйPathпреобразуется вTransformedPathс помощью transform.
-
path
Примечания
Для повышения эффективности, если path является
Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и установит область обрезки вNone.По техническим причинам (поддержка
set), также принимается кортеж (path, transform) в качестве единственного позиционного параметра.
- set_cmap(cmap)[source]
-
Установить цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили str или None
-
cmap
- set_color(c)[source]
-
Установить цвет контура и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для отдельной установки цвета контура или заливки.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет контура коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет контура коллекции. Если последовательность, элементы циклически проходятся по ней. Если 'face', соответствует цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет заливки коллекции. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если это последовательность, элементы циклически проходятся по ней.
Если c равно 'none', элемент не будет заполнен.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому относится элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор группы для элемента.
- Параметры:
-
- gidстрока
- 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)[source]
-
Установить, будет ли элемент включен в вычисления макета, например, Руководство по ограниченному макету,
Figure.tight_layout(), иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sобъект
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль(и) линии для набора.
стиль линии
описание
'-'или'solid'сплошная линия
'--'или'dashed'штриховая линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно задать кортеж с интервалами в формате:
(offset, onoffseq),
где
onoffseq— кортеж чётной длины, содержащий отступы и длины отрезков в пунктах.- Параметры:
-
- lsстрока или кортеж или список кортежей
-
Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См.
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить ширину(ы) линии для набора. lw может быть скаляром или последовательностью; если это последовательность, области будут циклически проходить через последовательность
- Параметры:
-
- lwчисло с плавающей точкой или список чисел с плавающей точкой
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установить, запрашивается ли у этого элемента информация о контексте при перемещении курсора мыши над ним.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установить экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если какие-либо цветовые шкалы используют отображение для этой нормализации, установка нормализации отображения сбросит нормализацию, локатор и форматировщики на цветовой шкале на значения по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установить преобразование смещения элемента.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установить смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Установить эффекты траектории.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(paths)[source]
- set_picker(picker)[source]
-
Определение поведения выбора элемента.
- Параметры:
-
- pickerNone или bool или float или вызываемый объект
-
Может принимать следующие значения:
- None: Выбор отключен для этого элемента (по умолчанию).
- Булевое значение: Если True, то выбор включен, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
- Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск в пунктах, и элемент сгенерирует событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции фигур, элемент может предоставлять дополнительные данные для события выбора, например, индексы данных в пределах допуска от события выбора
-
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, определяющая, попадает ли элемент в область события мыши:
hit, props = picker(artist, mouseevent)
для определения проверки попадания. Если курсор мыши над элементом, вернуть hit=True и props — словарь свойств, которые нужно добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установить радиус выбора, используемый для проверок принадлежности.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в пунктах.
- set_rasterized(rasterized)[source]
-
Принудительно использовать растровое (битовое) отображение для векторизованного графического вывода.
Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не сработает, и будет выведено предупреждение.
Это значение игнорируется для пиксельного вывода.
См. также Растрирование для векторизованной графики.
- Параметры:
-
- rasterizedbool
- set_sizes(sizes, dpi=72.0)[source]
-
Установить размеры каждого элемента в коллекции.
- Параметры:
-
-
sizes
numpy.ndarrayили None -
Размер, который нужно установить для каждого элемента коллекции. Значение — это «площадь» элемента.
- dpifloat, по умолчанию: 72
-
Разрешение холста.
-
sizes
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен
Noneили не указан, фильтр наброска не будет применён. - lengthfloat, необязательно
-
Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Множитель масштаба, на который длина сжимается или расширяется (по умолчанию 16.0)
Фронт-энд PGF использует это значение как seed для генератора случайных чисел, а не так, как описано выше. Использование одного и того же seed даёт один и тот же случайный рисунок.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если была определена чёрная линия шириной 1 пиксель в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в двух соседних пиксельных позициях. Напротив, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязка вершин к ближайшему центру пикселя.
- False: Не изменять позиции вершин.
- None: (автоматически) Если траектория содержит только прямолинейные сегменты, округлять до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование объекта.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для объекта.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок строк или None
Примечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок для объекта. Объекты с меньшими значениями z-порядка рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли объект "неактуальным" и нуждается ли он в перерисовке, чтобы выходной результат соответствовал внутреннему состоянию объекта.
- propertysticky_edges
-
xиyсписки привязанных границ для автоматического масштабирования.При выполнении автоматического масштабирования, если граница данных совпадает со значением в соответствующем списке sticky_edges, то не добавляется отступ – пределы просмотра «прилипают» к краю. Типичный пример использования – гистограммы, где обычно ожидается отсутствие отступа на нижней границе (0) гистограммы.
Кроме того, расширение отступа «упирается» в привязанные границы и не может их пересекать. Например, если верхняя граница данных равна 1,0, верхняя граница просмотра, вычисленная простым добавлением отступа, равна 1,2, но есть привязанная граница в 1,1, то фактическая верхняя граница просмотра будет 1,1.
Этот атрибут не может быть назначен; однако, списки
xиyможно изменять на месте, если это необходимо.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает нормализованный массив rgba, соответствующий x.
В обычном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий
ndarrayмассив значений rgba будет возвращён на основе нормализации и цветовой карты, установленных для этого объекта отображения скаляров.Существует один особый случай обработки изображений, которые уже находятся в формате 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)[source]
-
Обновляет свойства этого объекта-художника из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копирует свойства из other в себя.
- update_scalarmappable()[source]
-
Обновляет цвета из массива отображения скаляров, если таковой имеется.
Присваивает цвета краям и граням на основе массива и/или непосредственно установленных цветов, соответствующим образом.
- zorder=0
- classmatplotlib.collections.Collection(*, edgecolors=None, facecolors=None, linewidths=None, linestyles='solid', capstyle=None, joinstyle=None, antialiaseds=None, offsets=None, offset_transform=None, norm=None, cmap=None, pickradius=5.0, hatch=None, urls=None, zorder=1, **kwargs)[source]
-
Bases:
Artist,ScalarMappableБазовый класс для коллекций. Должен быть наследоваться, чтобы быть применимым.
Коллекция представляет собой последовательность
Patch, которые могут быть нарисованы более эффективно вместе, чем по отдельности. Например, когда один путь рисуется многократно с различными смещениями, рендерер, как правило, может выполнить вызовdraw_marker()значительно эффективнее, чем серию повторяющихся вызововdraw_path()со смещениями, вводимыми по одному.Большинство свойств коллекции могут быть настроены для каждого элемента. Поэтому у коллекций есть "множественные" версии многих свойств
Patch(например,Collection.get_pathsвместоPatch.get_path). Исключение составляют свойства zorder, hatch, pickradius, capstyle и joinstyle, которые могут быть установлены только глобально для всей коллекции.Помимо этих исключений, все свойства могут быть указаны как единичные значения (применяемые ко всем элементам) или последовательности значений. Свойство
i-го элемента коллекции:prop[i % len(prop)]
Каждая коллекция может быть дополнительно использована как собственная
ScalarMappable, передавая параметры norm и cmap в её конструктор. Если матрицаScalarMappableколлекции_Aбыла установлена (через вызовCollection.set_array), то во время рисования эта внутренняя скалярная сопоставляемая будет использоваться для установкиfacecolorsиedgecolors, игнорируя те, которые были переданы вручную.- Parameters:
-
-
edgecolorsцвет или список цветов, по умолчанию:
rcParams["patch.edgecolor"](по умолчанию:'black') -
Цвет границы для каждого фрагмента, составляющего коллекцию. Специальное значение 'face' может быть передано, чтобы цвет границы соответствовал цвету заливки.
-
facecolorsцвет или список цветов, по умолчанию:
rcParams["patch.facecolor"](по умолчанию:'C0') -
Цвет заливки для каждого фрагмента, составляющего коллекцию.
-
linewidthsчисло или список чисел, по умолчанию:
rcParams["patch.linewidth"](по умолчанию:1.0) -
Ширина линии для каждого фрагмента, составляющего коллекцию.
- linestylesстрока или кортеж или список thereof, по умолчанию: 'solid'
-
Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны быть следующего вида:
(offset, onoffseq),
где onoffseq — кортеж чётной длины из длительностей вкл. и выкл. чернил в пунктах. Примеры см. в Стилях линий.
-
capstyle
CapStyle-подобный, по умолчанию:rcParams["patch.capstyle"] -
Стиль окончания линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.
-
joinstyle
JoinStyle-подобный, по умолчанию:rcParams["patch.joinstyle"] -
Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.
-
antialiasedsbool или список bool, по умолчанию:
rcParams["patch.antialiased"](по умолчанию:True) -
Указывает, должен ли каждый фрагмент в коллекции быть нарисован с антиалайсингом.
- offsets(число, число) или список thereof, по умолчанию: (0, 0)
-
Вектор, на который нужно сдвинуть каждый фрагмент после рендеринга (по умолчанию — без сдвига). Сдвиг выполняется в координатах экрана (пиксели) (т.е. после применения преобразования объекта).
-
offset_transform
Transform, по умолчанию:IdentityTransform -
Единственное преобразование, которое будет применено к каждому вектору offsets перед использованием.
- cmap, norm
-
Параметры нормализации данных и сопоставления цветов. Подробное описание см. в
ScalarMappable. - hatchстрока, необязательно
-
Шаблон штриховки, используемый для заполненных путей, если таковые имеются. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Значение каждого типа штриховки см. в Справочник по стилям штриховки.
- pickradiusчисло, по умолчанию: 5.0
-
Если
pickradius <= 0, тоCollection.containsвернётTrueвсякий раз, когда тестовая точка находится внутри одного из многоугольников, образованных контрольными точками пути в коллекции. С другой стороны, если оно больше 0, то мы вместо этого проверяем, находится ли тестовая точка внутри контура шириной2*pickradiusпо любому из путей в коллекции. - urlsсписок строк, по умолчанию: None
-
URL для каждого фрагмента для ссылки после отрисовки. В настоящее время работает только для SVG-бэкенда. Примеры см. в Ссылки.
- zorderчисло, по умолчанию: 1
-
Порядок отрисовки, общий для всех фрагментов в коллекции. Подробное описание и примеры всех значений по умолчанию см. в Демонстрация zorder.
-
edgecolorsцвет или список цветов, по умолчанию:
- add_callback(func)[source]
-
Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств
Artist.- Parameters:
-
- funcвызываемая функция
-
Функция обратного вызова. Она должна иметь следующий вид:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Возвращаемые значения могут существовать, но игнорируются.
- Returns:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автомасштабировать пределы скаляров на экземпляре norm с использованием текущего массива
- autoscale_None()[source]
-
Автомасштабировать пределы скаляров на экземпляре norm с использованием текущего массива, изменяя только пределы, равные None
- propertyaxes
-
Экземпляр
Axes, в котором находится объект, или None.
- changed()[source]
-
Вызовите этот метод всякий раз, когда изменяется объект отображения карты, чтобы уведомить всех слушателей обратного вызова SM о сигнале «изменён».
- colorbar
-
Последняя связанная с этим объектом отображения карты цветовая шкала. Может быть None.
- contains(mouseevent)[source]
-
Проверить, произошла ли обработка события мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в списке itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразовать x, используя тип единицы измерения оси x.
Если объект-художник не содержится в области Axes или ось x не имеет единиц измерения, возвращается само x.
- convert_yunits(y)[source]
-
Преобразовать y, используя тип единицы измерения оси y.
Если объект-художник не содержится в области Axes или ось y не имеет единиц измерения, возвращается само y.
- draw(renderer)[source]
-
Отобразить объект-художника (и его дочерние элементы) с помощью заданного рендерера.
Это не имеет эффекта, если объект-художник не отображается (
Artist.get_visibleвозвращает False).- Parameters:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределяется в подклассах объекта-художника.
- findobj(match=None, include_self=True)[source]
-
Найти объекты-художники.
Рекурсивно найти все экземпляры
Artist, содержащиеся в объекте-художнике.- Parameters:
-
- match
-
Критерий фильтрации соответствий. Это может быть
- None: вернуть все объекты, содержащиеся в художнике.
- Функция со сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только художников этого класса или его подклассов (проверкаisinstance).
- include_selfbool
-
Включить self в список, который будет проверяться на соответствие.
- Returns:
-
- Список
Artist
- Список
- format_cursor_data(data)[source]
-
Возвращает строковое представление данных data.
Примечание
Этот метод предназначен для переопределения подклассами объекта-художника. Вероятно, пользователь Matplotlib не будет вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделенную запятыми, заключенную в квадратные скобки, если у объекта-художника нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра, используемую для фильтрации agg.
- get_alpha()[source]
-
Возвращает значение alpha, используемое для смешивания - не поддерживается во всех бэкендах.
- get_animated()[source]
-
Возвращает, анимирован ли объект-художник.
- get_array()[source]
-
Возвращает массив значений, которые сопоставляются с цветами.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (min, max), которые отображаются в пределы цветовой карты.
- get_clip_box()[source]
-
Возвращает ограничивающую рамку.
- get_clip_on()[source]
-
Возвращает, использует ли элемент обрезку.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для заданного события.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.
Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращает None.
Подклассы могут переопределять метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z
AxesImageв строке состояния окна графика при перемещении указателя мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит элемент.
- get_fill()[source]
-
Возвращает, заливается ли цвет.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий узор штриховки.
- get_in_layout()[source]
-
Возвращает логический флаг
True, если элемент включён в вычисления макета.Например, Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для данного элемента в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает, запрашивается ли у этого объекта информация о контексте при перемещении курсора мыши над ним.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый для смещения этого объекта.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора объекта.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает, должен ли объект быть растрирован.
- get_sketch_params()[source]
-
Возвращает параметры наброска для объекта.
- Возвращает:
-
- кортеж или None
-
Кортеж из 3 элементов:
- масштаб: Амплитуда колебания перпендикулярно исходной линии.
- длина: Длина колебания вдоль линии.
- случайность: Коэффициент масштабирования, с которым длина сжимается или расширяется.
Возвращает None, если параметры наброска не были заданы.
- get_snap()[source]
-
Возвращает значение параметра привязки.
Подробности см. в
set_snap.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любые обрезки.- Параметры:
-
-
rendererподкласс
RendererBase -
Объект отрисовки, который будет использоваться для отрисовки графиков (то есть
fig.canvas.get_renderer())
-
rendererподкласс
- Возвращает:
-
Bbox-
Включающая ограничивающая прямоугольная область (в пикселях координат изображения).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим объектом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает обрезку пути с применённой неаффинной частью её преобразования и оставшейся аффинной частью преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL. См. Ссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получает область отображения элемента.
Ширина и высота области отображения неотрицательны.
Подклассы должны переопределять для включения в вычисление "плотной" области отображения. По умолчанию возвращает пустую область отображения в точке 0, 0.
Будьте внимательны при использовании этой функции; результаты не обновятся, если область отображения элемента изменится. Область отображения может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся некорректно.
- get_zorder()[source]
-
Возвращает z-порядок элемента.
- have_units()[source]
-
Возвращает, установлены ли единицы на любой оси.
- is_transform_set()[source]
-
Возвращает, задано ли преобразование элемента.
Это True после вызова
set_transform.
- propertymouseover
-
Возвращает, запрашивается ли у этого элемента пользовательская информация контекста при перемещении указателя мыши над ним.
- propertynorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутренне, когда свойство изменяется.
См. также
- pick(mouseevent)[source]
-
Обрабатывает событие выбора.
Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен picker.
См. также
- pickable()[source]
-
Возвращает, можно ли выбрать элемент.
См. также
- properties()[source]
-
Возвращает словарь со всеми свойствами элемента.
- remove()[source]
-
Удаляет элемент из фигуры, если это возможно.
Эффект будет виден только после перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Вызовитеrelimдля обновления пределов осей, если нужно.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи легенды элемента.
- remove_callback(oid)[source]
-
Удалить обратный вызов на основе его идентификатора наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить несколько свойств сразу.
Поддерживаемые свойства:
Свойство
Описание
Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения с левого нижнего угла изображения
Массивоподобный объект, скаляр или None
bool
bool или список bool
Массивоподобный объект или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Path, Transform) или None
Colormapили строка или Noneцвет или список кортежей RGBA
цвет или список цветов или 'face'
цвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
строка или кортеж или список
число с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneнеизвестно
массивоподобный объект (N, 2) или (2,)
неизвестно
None или bool или float или вызываемая функция
неизвестно
bool
(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
bool
число с плавающей точкой
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
-
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funcвызываемая функция
-
Функция фильтра, которая принимает массив float (m, n, глубина) и значение dpi и возвращает массив float (m, n, глубина) и два смещения от левого нижнего угла изображения
- set_alpha(alpha)[source]
-
Установить значение альфа для смешивания — не поддерживается во всех бэкендах.
- Параметры:
-
- alphaмассив-подобный объект или скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Не поддерживаются значения с маской и значения NaN.
- set_animated(b)[source]
-
Установить, предназначен ли объект-художник для использования в анимации.
Если True, объект-художник исключается из обычного рисования фигуры. Вам нужно явно вызвать
Figure.draw_artist/Axes.draw_artistна объекте-художнике. Этот подход используется для ускорения анимации с помощью blitting.См. также
matplotlib.animationи Более быстрое отображение с помощью blitting.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для рендеринга.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного объекта A.
- Параметры:
-
- Aмассив-подобный объект или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить стиль
CapStyleдля коллекции (для всех её элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормализации для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.
- set_clip_box(clipbox)[source]
-
Установить область обрезки объекта-художника
Bbox.- Параметры:
-
-
clipbox
Bbox -
Обычно создаётся из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)является по умолчанию областью обрезки для объекта-художника, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли объект-художник обрезку.
Если False, объекты-художники будут видны за пределами Axes, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установите область обрезки для элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена. -
transform
Transform, необязательно -
Используется только если path является
Path, в этом случае заданныйPathпреобразуется вTransformedPathс использованием transform.
-
path
Замечания
Для повышения эффективности, если path является
Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и установит область обрезки вNone.По техническим причинам (поддержка
set) также принимается кортеж (path, transform) как единственный позиционный параметр.
- set_cmap(cmap)[source]
-
Установить палитру цветов для данных яркости.
- Параметры:
-
-
cmap
Colormapили str или None
-
cmap
- set_color(c)[source]
-
Установить цвет заливки и обводки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для установки цвета заливки или обводки отдельно.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Устанавливает цвет обводки коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет обводки коллекции. Если последовательность, элементы будут циклически использовать ее значения. Если 'face', будет соответствовать цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Устанавливает цвет заливки элементов коллекции. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если это последовательность, элементы будут циклически использовать значения из последовательности.
Если c равно 'none', элемент не будет заливаться.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому относится элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор (группы) для элемента.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, следует ли включать элемент в вычисления макета, например, Руководство по ограниченному макету,
Figure.tight_layout(), иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sобъект
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль линии(й) для набора.
linestyle
описание
'-'или'solid'сплошная линия
'--'или'dashed'пунктирная линия
'-.'или'dashdot'штрих-пунктирная линия
':'или'dotted'штриховая линия
В качестве альтернативы может быть предоставлена кортеж с отступами в следующем формате:
(offset, onoffseq),
где
onoffseq— кортеж чётной длины, содержащий длины включения и выключения чернил в пунктах.- Параметры:
-
- lsстрока или кортеж или список кортежей
-
Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Смотрите
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить ширину линии(й) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, элементы будут циклически проходить через последовательность
- Параметры:
-
- lwчисловой тип или список чисел
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установить, запрашивается ли у данного элемента пользовательская информация о контексте, когда курсор мыши перемещается по нему.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установить экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили строка или None
-
norm
Примечания
Если какие-либо цветные шкалы используют карту отображения для этой нормализации, установка нормализации карты отображения сбросит нормализацию, локатор и форматировщики на цветной шкале до значений по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установить преобразование смещения элемента.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установить смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Установить эффекты пути.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(paths)[source]
- set_picker(picker)[source]
-
Определить поведение выбора элемента.
- Параметры:
-
- pickerNone или bool или float или вызываемый объект
-
Это может быть одно из следующего:
- None: Выбор отключен для данного элемента (по умолчанию).
- Булево значение: Если True, выбор будет включен, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
- Число с плавающей точкой: Если picker — число, оно интерпретируется как значение толерантности epsilon в точках, и элемент сгенерирует событие, если его данные находятся в пределах epsilon от события нажатия мыши. Для некоторых элементов, таких как линии и коллекции набора элементов, элемент может предоставить дополнительные данные событию выбора, например, индексы данных, которые находятся в пределах epsilon от события выбора.
-
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли данный элемент под событие мыши:
hit, props = picker(artist, mouseevent)
для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установить радиус выбора, используемый для проверок попадания.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в точках.
- set_rasterized(rasterized)[source]
-
Принудительное растровое (битовое) отображение для векторной графики.
Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.
Это свойство игнорируется для выходных данных на основе пикселей.
См. также Растровое отображение для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale
None, или не указано, фильтр наброска не будет предоставлен. - lengthfloat, необязательно
-
Длина колебаний вдоль линии в пикселях (по умолчанию 128,0)
- randomnessfloat, необязательно
-
Коэффициент масштабирования, с помощью которого длина уменьшается или увеличивается (по умолчанию 16,0)
Фронтенд PGF использует этот аргумент в качестве значения RNG, а не как описано выше. Использование одного и того же значения seeds приводит к одному и тому же случайному изображению.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением в обеих смежных позициях пикселей. В противоположность этому, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только задними планами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к центру ближайшего пикселя.
- False: Не изменять позиции вершин.
- None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование объекта.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для объекта.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок строк или None
Примечания
URL в настоящее время реализованы только задним планом SVG. Они игнорируются всеми другими задними планами.
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок для объекта. Объекты с меньшими значениями z-порядка рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли объект «неактуальным» и нужно ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию объекта.
- propertysticky_edges
-
xиyсписки прилипающих границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то не будет добавлен никакой отступ — предел просмотра «прилипает» к краю. Типичный пример использования — гистограммы, где обычно не ожидается отступ на нижнем краю (0) гистограммы.
Кроме того, расширение отступа «натыкается» на прилипающие края и не может их пересечь. Например, если верхний предел данных равен 1,0, верхний предел просмотра, вычисленный простым применением отступа, равен 1,2, но есть прилипающий край в 1,1, то фактический верхний предел просмотра будет 1,1.
К этому атрибуту нельзя присваивать; однако, списки
xиyможно изменять на месте по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает массив rgba, соответствующий x.
В обычном случае x является 1D или 2D последовательностью скаляров, и соответствующий массив значений 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)[source]
-
Обновить свойства этого объекта из словаря props.
- Параметры:
-
- propsсловарь
- update_from(other)[source]
-
Копировать свойства из другого в себя.
- update_scalarmappable()[source]
-
Обновить цвета из массива сопоставимого со скаляром, если таковой имеется.
Назначить цвета к границам и граням на основе массива и/или цветов, которые были непосредственно установлены, как это уместно.
- zorder=0
- classmatplotlib.collections.EllipseCollection(widths, heights, angles, *, units='points', **kwargs)[source]
-
Bases:
CollectionКоллекция эллипсов, нарисованных с использованием сплайнов.
- Параметры:
-
- widthsarray-like
-
Длина первой оси (например, длина большой оси).
- heightsarray-like
-
Длина второй оси.
- anglesarray-like
-
Углы первой оси, градусы против часовой стрелки от оси x.
- units{'points', 'inches', 'dots', 'width', 'height', 'x', 'y', 'xy'}
-
Единицы измерения больших и малых осей; 'width' и 'height' относятся к размерам осей, а 'x' и 'y' — к данным единицам смещения. 'xy' отличается от всех остальных тем, что угол, отображаемый на графике, изменяется в зависимости от соотношения сторон, и равен заданному углу только при соотношении сторон равном единице. Таким образом, он ведет себя так же, как
Ellipseсaxes.transDataв качестве своего преобразования. - **kwargs
-
Передаётся в
Collection.
- add_callback(func)[source]
-
Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funccallable
-
Функция обратного вызова. Она должна иметь сигнатуру:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Значения возврата могут существовать, но игнорируются.
- Возвращает:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автоматически масштабирует пределы скаляров на экземпляре norm с использованием текущего массива
- autoscale_None()[source]
-
Автоматически масштабирует пределы скаляров на экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None
- propertyaxes
-
Экземпляр
Axes, в котором находится элемент, или None.
- changed()[source]
-
Вызывайте эту функцию всякий раз, когда карта отображается, чтобы уведомить все слушатели обратного вызова по сигналу 'changed'.
- colorbar
-
Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.
- contains(mouseevent)[source]
-
Проверяет, произошла ли обработка события мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразует x, используя тип единиц измерения оси x.
Если элемент не находится в осях или ось x не имеет единиц измерения, возвращается само x.
- convert_yunits(y)[source]
-
Преобразует y, используя тип единиц измерения оси y.
Если элемент не находится в осях или ось y не имеет единиц измерения, возвращается само y.
- draw(renderer)[source]
-
Отрисовывает элемент (и его дочерние элементы) с помощью данного отрисовщика.
Это не имеет эффекта, если элемент не видим (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределяется в подклассах Artist.
- findobj(match=None, include_self=True)[source]
-
Поиск элементов художника.
Рекурсивно находит все
Artistэкземпляры, содержащиеся в художнике.- Параметры:
-
- match
-
Критерий фильтрации совпадений. Может быть
- None: Возвращает все объекты, содержащиеся в художнике.
- Функция с сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только художников этого класса или его подклассов (isinstanceпроверка).
- include_selfbool
-
Включить self в список для проверки соответствия.
- Возвращает:
-
- Список
Artist
- Список
- format_cursor_data(data)[source]
-
Возвращает строковое представление данных data.
Примечание
Этот метод предназначен для переопределения в подклассах объектов-артистов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые числа, числа с плавающей точкой и массивы целых чисел и чисел с плавающей точкой в строку, разделённую запятыми, заключённую в квадратные скобки, если у артиста нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с использованием форматировщика цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра для использования с agg-фильтром.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемое для смешивания — не поддерживается на всех бэкэндах.
- get_animated()[source]
-
Возвращает, анимирован ли объект-артист.
- get_array()[source]
-
Возвращает массив значений, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (мин, макс), которые отображаются в пределах цветовой шкалы.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает, используется ли обрезка для объекта-артиста.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для заданного события.
Примечание
Этот метод предназначен для переопределения в подклассах объектов-артистов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.
Данные курсора могут использоваться объектами-артистами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация просто возвращает None.
Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z объекта
AxesImageв строке состояния окна графика при перемещении мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит элемент.
- get_fill()[source]
-
Возвращает значение, определяющее, заполнена ли фигура цветом.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий узор штриховки.
- get_in_layout()[source]
-
Возвращает логическое значение,
Trueесли элемент включён в расчёт макета.Например, Руководство по ограниченному макетам,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает значение, определяющее, запрашивается ли у этого элемента пользовательская информация о контексте при перемещении курсора мыши над ним.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый для смещения этого элемента.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает, растрируется ли элемент.
- get_sketch_params()[source]
-
Возвращает параметры наброска для элемента.
- Возвращает:
-
- кортеж или None
-
3-х элементный кортеж с параметрами:
- scale: Амплитуда колебаний перпендикулярно исходной линии.
- length: Длина колебаний вдоль линии.
- randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.
Возвращает None, если параметры наброска не были заданы.
- get_snap()[source]
-
Возвращает значение параметра snap.
Подробнее см.
set_snap.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любые обрезки.- Параметры:
-
-
renderer
RendererBaseподкласс -
объект рендеринга, который будет использоваться для отрисовки изображений (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Охватывающая область (в пикселях координат изображения).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает обрезку с примененной неаффинной частью преобразования и оставшейся аффинной частью преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному на каждый элемент коллекции.
Список содержит None для элементов без URL. См. Ссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получает область элемента в пространстве отображения.
Ширина и высота области неотрицательны.
Подклассы должны переопределять для включения в вычисление области "tight". По умолчанию возвращается пустая область в 0, 0.
Будьте осторожны при использовании этой функции, результаты не обновляются, если область окна элемента изменяется. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но будут сохранены неправильно.
- get_zorder()[source]
-
Возвращает z-порядок элемента.
- have_units()[source]
-
Возвращает, установлены ли единицы измерения на любой оси.
- is_transform_set()[source]
-
Возвращает, имеет ли объект-графический элемент явно заданное преобразование.
Это True после вызова
set_transform.
- propertymouseover
-
Возвращает, запрашивается ли у данного графического элемента информация о контексте при перемещении курсора мыши над ним.
- propertynorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обработка события выбора.
Каждый дочерний графический элемент сработает, если mouseevent находится над элементом и у элемента установлен picker.
См. также
- pickable()[source]
-
Возвращает, может ли элемент быть выбран.
См. также
- properties()[source]
-
Возвращает словарь всех свойств графического элемента.
- remove()[source]
-
Удаляет графический элемент из фигуры, если это возможно.
Эффект будет виден только после перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Для обновления пределов осей вызовитеrelim.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.Примечание: нет поддержки удаления записи легенды элемента.
- remove_callback(oid)[source]
-
Удаляет обратный вызов по его идентификатору наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить несколько свойств сразу.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив с плавающей точкой (m, n, 3) и значение dpi, а возвращает массив (m, n, 3) и два смещения с нижнего левого угла изображения
подобный массиву или скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
подобный массиву или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Patch или (Path, Transform) или None
Colormapили str или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массив-подобный
неизвестно
None или bool или число с плавающей точкой или вызываемый объект
неизвестно
bool
(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
bool
число с плавающей точкой
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
-
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения
- set_alpha(alpha)[source]
-
Установить значение альфа, используемое для смешения - не поддерживается всеми бэкендами.
- Параметры:
-
- alphaмассив-подобный объект или скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли художник для использования в анимации.
Если True, художник исключается из обычного рисования фигуры. Вам необходимо явно вызвать
Figure.draw_artist/Axes.draw_artistна художнике. Этот подход используется для ускорения анимаций с помощью блиттинга.См. также
matplotlib.animationи Ускорение отрисовки с помощью блиттинга.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для отрисовки.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массива-подобного объекта A.
- Параметры:
-
- Aмассив-подобный объект или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить стиль закругления
CapStyleдля коллекции (для всех ее элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормы для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также могут быть переданы в виде кортежа (vmin, vmax) как единственный позиционный аргумент.
- set_clip_box(clipbox)[source]
-
Установить область обрезки художника
Bbox.- Параметры:
-
-
clipbox
Bbox -
Обычно создаётся из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)является стандартной обрезкой для художника, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли художник обрезку.
При значении False художники будут видны вне Axes, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установить область обрезки для элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, transform также должен быть задан. Если None, ранее установленная область обрезки удаляется. -
transform
Transform, необязательно -
Используется только если path является
Path, в этом случае заданныйPathпреобразуется вTransformedPathс помощью transform.
-
path
Примечания
Для повышения эффективности, если path — это
Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и установит область обрезки вNone.По техническим причинам (поддержка
set) также принимается кортеж (path, transform) как единственный позиционный параметр.
- set_cmap(cmap)[source]
-
Установить цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили str или None
-
cmap
- set_color(c)[source]
-
Установить цвет обводки и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для установки цвета обводки или заливки по отдельности.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет обводки коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(а) обводки коллекции. Если последовательность, фигуры перебирают ее по очереди. Если 'face', цвет совпадает с цветом заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет заливки коллекции. c может быть цветом (все фигуры имеют один и тот же цвет) или последовательностью цветов; если это последовательность, фигуры будут перебирать последовательность.
Если c равно 'none', фигура не будет закрашена.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому принадлежит элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установите идентификатор (группы) для объекта графического элемента.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, нужно ли учитывать элемент при расчётах макета, например, в Руководстве по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить
JoinStyleдля коллекции (для всех её элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установите метку, которая будет отображаться в легенде.
- Параметры:
-
- sobject
-
s будет преобразовано в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль линии (линий) для коллекции.
linestyle
описание
'-'или'solid'сплошная линия
'--'или'dashed'пунктирная линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'точечная линия
В качестве альтернативы можно указать кортеж с делениями в следующем формате:
(offset, onoffseq),
где
onoffseq— это кортеж чётной длины с включёнными и выключенными точками чернил в пунктах.- Параметры:
-
- lsstr или кортеж или список кортежей
-
Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См.
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить ширину линии (линий) для коллекции. lw может быть скалярным значением или последовательностью; если это последовательность, элементы будут циклически проходить через последовательность.
- Параметры:
-
- lwfloat или список чисел с плавающей точкой
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Устанавливает, запрашивается ли у этого объекта пользовательская информация контекста, когда курсор мыши перемещается по нему.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Устанавливает экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили строка или None
-
norm
Примечания
Если для этой нормализации используются какие-либо цветовые шкалы, установка нормализации в mappable сбросит нормализацию, локатор и форматирование в цветовой шкале на значения по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Устанавливает трансформирование смещения объекта.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Устанавливает смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный
- set_path_effects(path_effects)[source]
-
Устанавливает эффекты пути.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(paths)[source]
- set_picker(picker)[source]
-
Определяет поведение выбора объекта.
- Параметры:
-
- pickerNone или bool или float или вызываемый объект
-
Это может быть одно из следующего:
- None: Выбор отключен для этого объекта (значение по умолчанию).
- Булево значение: Если True, выбор будет включён, и объект будет генерировать событие выбора, если курсор мыши находится над объектом.
- Число с плавающей запятой: Если picker — число, оно интерпретируется как толерантность к погрешности в точках, и объект будет генерировать событие, если его данные находятся в пределах погрешности от события мыши. Для некоторых объектов, таких как линии и коллекции объектов, объект может предоставлять дополнительные данные для события выбора, например, индексы данных в пределах погрешности от события выбора
-
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли объект под событие мыши:
hit, props = picker(artist, mouseevent)
для определения проверки попадания. Если курсор мыши находится над объектом, возвращается hit=True, а props — это словарь свойств, которые необходимо добавить в атрибуты PickEvent.
- set_pickradius(pickradius)[source]
-
Устанавливает радиус выбора, используемый для проверок на включение.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в пунктах.
- set_rasterized(rasterized)[source]
-
Вынуждает растровое (битовое) отображение для векторной графики.
Растровое отображение не поддерживается всеми объектами. Если вы попытаетесь включить это для объекта, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.
Это значение игнорируется для выходных данных на основе пикселей.
См. также Растрирование для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Устанавливает параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебания перпендикулярно исходной линии в пикселях. Если scale —
None, или не указано, фильтр наброска не будет предоставлен. - lengthfloat, необязательно
-
Длина колебания вдоль линии в пикселях (по умолчанию 128,0)
- randomnessfloat, необязательно
-
Коэффициент масштабирования, на который уменьшается или увеличивается длина (по умолчанию 16,0)
Backend PGF использует это значение в качестве начального значения генератора случайных чисел, а не как описано выше. Использование одного и того же значения приводит к одному и тому же случайному образу.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции к пиксельной сетке, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением на обеих смежных пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение будет действительно содержать черную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к ближайшему центру пикселя.
- False: Не изменять положения вершин.
- None: (авто) Если путь содержит только прямолинейные сегменты, округлять до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование художника.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для художника.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок строк или None
Примечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок объекта. Объекты с меньшими значениями zorder рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли объект «неактуальным» и нужно ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию объекта.
- propertysticky_edges
-
xиyсписки прилипающих границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — пределы просмотра «прилипают» к краю. Типичный пример использования — гистограммы, где, как правило, ожидается отсутствие отступа на нижнем краю (0) гистограммы.
Кроме того, расширение отступа «натыкается» на прилипающие края и не может их пересечь. Например, если верхний предел данных равен 1,0, верхний предел просмотра, вычисленный простым добавлением отступа, равен 1,2, но есть прилипающий край в 1,1, то фактический верхний предел просмотра будет 1,1.
К этому атрибуту нельзя присваивать значения; однако списки
xиyможно изменять по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает нормализованный массив rgba, соответствующий x.
В нормальном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий
ndarrayзначений rgba будет возвращен на основе нормализации и цветовой карты, установленной для данного ScalarMappable.Существует один особый случай для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x — это
ndarrayс 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как rgb или rgba массив, и никакой сопоставления не будет выполнено. Массив может быть uint8 или он может быть с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет возбуждено исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, параметр alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет предварительно существующий альфа-канал. Будет возбуждено исключение ValueError, если третье измерение отличается от 3 или 4.В любом случае, если bytes равен False (по умолчанию), массив rgba будет содержать числа с плавающей точкой в диапазоне 0-1; если он равен True, возвращаемый массив rgba будет содержать значения uint8 в диапазоне от 0 до 255.
Если norm равен False, нормализация входных данных не выполняется, и предполагается, что она находится в диапазоне (0-1).
- update(props)[source]
-
Обновить свойства этого объекта из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копирование свойств из other в self.
- update_scalarmappable()[source]
-
Обновить цвета из массива скалярного отображаемого объекта, если он есть.
Присвоить цвета границам и заполнениям на основе массива и/или цветов, которые были непосредственно установлены, как соответствующим образом.
- zorder=0
- classmatplotlib.collections.EventCollection(positions, orientation='horizontal', *, lineoffset=0, linelength=1, linewidth=None, color=None, linestyle='solid', antialiased=None, **kwargs)[source]
-
Bases:
LineCollectionКоллекция местоположений вдоль одной оси, в которых произошло «событие».
События задаются одномерным массивом. Они не имеют амплитуды и отображаются как параллельные линии.
- Параметры:
-
- positionsОдномерный массив-подобный объект
-
Каждое значение — это событие.
- orientation{'горизонталь', 'вертикаль'}, по умолчанию: 'горизонталь'
-
Последовательность событий изображается в этом направлении. Линии маркеров отдельных событий располагаются в ортогональном направлении.
- lineoffsetчисло, по умолчанию: 0
-
Смещение центра маркеров от начала координат в направлении, ортогональном orientation.
- linelengthчисло, по умолчанию: 1
-
Общая высота маркера (т.е. маркер простирается от
lineoffset - linelength/2доlineoffset + linelength/2). -
linewidthчисло или список чисел, по умолчанию:
rcParams["lines.linewidth"](по умолчанию:1.5) -
Толщина линий событий в пунктах.
-
colorцвет или список цветов, по умолчанию:
rcParams["lines.color"](по умолчанию:'C0') -
Цвет линий событий.
- linestyleстрока или кортеж или список кортежей, по умолчанию: 'сплошная'
-
Допустимые строки: ['сплошная', 'штриховая', 'штрихпунктирная', 'пунктирная', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид:
(offset, onoffseq),
где onoffseq — кортеж чётной длины, содержащий значения длительности включения и выключения чернил в пунктах.
-
antialiasedбулево значение или список булевых значений, по умолчанию:
rcParams["lines.antialiased"](по умолчанию:True) -
Использовать ли антиалиасинг при рисовании линий.
- **kwargs
-
Передаётся в
LineCollection.
Примеры
(
Source code,png)- add_callback(func)[source]
-
Добавить функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funcвызываемый объект
-
Функция обратного вызова. Она должна иметь сигнатуру:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Возвращаемые значения могут существовать, но игнорируются.
- Возвращает:
-
- целое число
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью
remove_callbackвпоследствии.
См. также
- add_positions(position)[source]
-
Добавить одно или несколько событий в указанных позициях.
- append_positions(position)[source]
-
Добавить одно или несколько событий в указанных позициях.
- autoscale()[source]
-
Автоматически масштабировать пределы скаляров на экземпляре нормы, используя текущий массив
- autoscale_None()[source]
-
Автоматически масштабировать пределы скаляров на экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None
- propertyaxes
-
Экземпляр
Axes, в котором находится элемент, или None.
- changed()[source]
-
Вызовите эту функцию всякий раз, когда изменяется карта отображения, чтобы уведомить всех слушателей сигнала 'changed'.
- colorbar
-
Последняя цветовая шкала, связанная с этим объектом ScalarMappable. Может быть None.
- contains(mouseevent)[source]
-
Проверить, произошёл ли щелчок мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразовать x с помощью типа единицы измерения оси x.
Если элемент не входит в Axes или у оси x нет единиц измерения, возвращается сам x.
- convert_yunits(y)[source]
-
Преобразовать y с помощью типа единицы измерения оси y.
Если элемент не входит в Axes или у оси y нет единиц измерения, возвращается сам y.
- draw(renderer)[source]
-
Отобразить элемент (и его дочерние элементы) с помощью заданного рендерера.
Это не оказывает никакого эффекта, если элемент не отображается (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределяется в подклассах Artist.
- extend_positions(position)[source]
-
Добавить одно или несколько событий в указанных позициях.
- findobj(match=None, include_self=True)[source]
-
Найти объекты-артисты.
Рекурсивно найти все экземпляры
Artist, содержащиеся в артисте.- Параметры:
-
- match
-
Критерий фильтрации совпадений. Это может быть
- None: вернуть все объекты, содержащиеся в артисте.
- Функция со сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только артисты, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только артисты этого класса или его подклассов (isinstanceпроверка).
- include_selfbool
-
Включить self в список, который будет проверяться на соответствие.
- Возвращает:
-
- список
Artist
- список
- format_cursor_data(data)[source]
-
Возвращает строковое представление data.
Примечание
Этот метод предназначен для переопределения подклассами артистов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.
Стандартная реализация преобразует целые и вещественные числа и массивы целых и вещественных чисел в строку, разделенную запятыми, заключенную в квадратные скобки, если у артиста нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра для использования с фильтром agg.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемое для смешивания - не поддерживается на всех бэкэндах.
- get_animated()[source]
-
Возвращает, анимирован ли артефакт.
- get_array()[source]
-
Возвращает массив значений, которые отображаются в цветах.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (мин, макс), которые отображаются в пределах цветовой шкалы.
- get_clip_box()[source]
-
Возвращает ограничивающую рамку.
- get_clip_on()[source]
-
Возвращает, используется ли артефактом обрезка.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_color()[source]
-
Возвращает цвет линий, используемых для маркировки каждого события.
- get_colors()[source]
- get_cursor_data(event)[source]
-
Возвращает данные указателя для заданного события.
Примечание
Этот метод предназначен для переопределения подклассами элементов управления. Пользователям Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
Данные указателя могут использоваться элементами управления для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.
Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.В настоящее время единственное применение — отображение значения z
AxesImageв строке состояния окна графика при перемещении мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит элемент управления.
- get_fill()[source]
-
Возвращает, закрашивается ли фигура.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий узор штриховки.
- get_in_layout()[source]
-
Возвращает булево значение,
True— включён ли элемент в вычисления макета.Например, Руководство по макетам с ограничением,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента управления в легенде.
- get_linelength()[source]
-
Возвращает длину линий, используемых для маркировки каждого события.
- get_lineoffset()[source]
-
Возвращает смещение линий, используемых для маркировки каждого события.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
-
Получить ширину линий, используемых для маркировки каждого события.
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает значение, указывающее, запрашивается ли у данного элемента информация о пользовательском контексте при перемещении курсора мыши над ним.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом для смещения.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_orientation()[source]
-
Возвращает ориентацию линии события ('горизонтально' или 'вертикально').
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_positions()[source]
-
Возвращает массив, содержащий значения позиций в формате с плавающей точкой.
- get_rasterized()[source]
-
Возвращает значение, указывающее, нужно ли растрировать элемент.
- get_segments()[source]
-
- Возвращает:
-
- list
-
Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.
- get_sketch_params()[source]
-
Возвращает параметры создания наброска для элемента.
- Возвращает:
-
- кортеж или None
-
3-х элементный кортеж со следующими элементами:
- scale: Амплитуда колебаний перпендикулярно исходной линии.
- length: Длина колебаний вдоль линии.
- randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.
Возвращает None, если параметры создания наброска не были установлены.
- get_snap()[source]
-
Возвращает установку привязки.
См.
set_snapдля получения подробной информации.
- get_tightbbox(renderer=None)[source]
-
Как
Artist.get_window_extent, но включает любой обрезку.- Параметры:
-
-
renderer
RendererBaseподкласс -
рендерер, который будет использоваться для отрисовки графиков (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращаемое значение:
-
Bbox-
Охватывающая область (в координатах пикселей фигуры).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает объект
Transform, используемый этим элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает обрезку пути с применённой неаффинной частью её преобразования и оставшейся аффинной частью преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL. См. Гиперссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получить область элемента в пространстве отображения.
Ширина и высота области неотрицательны.
Подклассы должны переопределить для включения в вычисление "плотной" области. По умолчанию возвращается пустая область в координатах 0, 0.
Будьте осторожны при использовании этой функции, результаты не обновятся, если область элемента изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся неправильно.
- get_zorder()[source]
-
Возвращает порядок элемента z.
- have_units()[source]
-
Возвращает, установлены ли единицы на любой оси.
- is_horizontal()[source]
-
True, если eventcollection горизонтальная, False, если вертикальная.
- is_transform_set()[source]
-
Возвращает, имеет ли элемент явно заданное преобразование.
Это True после вызова
set_transform.
- propertymouseover
-
Возвращает, запрашивается ли у этого элемента пользовательская информация о контексте при перемещении курсора мыши над ним.
- propertynorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутренне, когда свойство изменено.
См. также
- pick(mouseevent)[source]
-
Обрабатывает событие выбора.
Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен picker.
См. также
- pickable()[source]
-
Возвращает, может ли элемент быть выбран.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента.
- remove()[source]
-
Удаляет элемент из фигуры, если это возможно.
Эффект не будет виден до повторного отрисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Для обновления пределов осей используйтеrelim.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи легенды элемента.
- remove_callback(oid)[source]
-
Удаляет обратный вызов по его идентификатору наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, colors=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linelength=<UNSET>, lineoffset=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, orientation=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, positions=<UNSET>, rasterized=<UNSET>, segments=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Устанавливает сразу несколько свойств.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения
массив-подобный объект, скаляр или None
bool
antialiasedили aa или antialiasedsbool или список булевых значений
массив-подобный объект или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Путь, Преобразование) или None
Colormapили строка или Noneцвет или список цветов
цвет или список цветов
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
неизвестно
неизвестно
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массив-подобный объект
{'horizontal', 'vertical'}
неизвестно
None или bool или число с плавающей точкой или вызываемый объект
неизвестно
неизвестно
bool
неизвестно
(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
-
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от нижнего левого угла изображения.
- set_alpha(alpha)[source]
-
Установить значение альфа для смешивания — не поддерживается во всех бэкендах.
- Параметры:
-
- alphaмассив или скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и nan не поддерживаются.
- set_animated(b)[source]
-
Установить, предполагается ли использовать артефакт в анимации.
Если True, артефакт исключается из обычного рисования фигуры. Вы должны явно вызвать
Figure.draw_artist/Axes.draw_artistна артефакте. Этот подход используется для ускорения анимаций с помощью blitting.См. также
matplotlib.animationи Более быстрое отображение с использованием blitting.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для рендеринга.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного A.
- Параметры:
-
- Aмассив или None
-
Значения, которые отображаются в цветах.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить
CapStyleдля коллекции (для всех её элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормы для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.
- set_clip_box(clipbox)[source]
-
Установить область обрезки артефакта
Bbox.- Параметры:
-
-
clipbox
Bbox -
Обычно создаётся из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)— это стандартная обрезка для артефакта, добавленного к Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли артефакт обрезку.
Если False, артефакты будут видны за пределами Axes, что может привести к непредвиденным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установить область обрезки для элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, также необходимо указать transform. Если None, ранее установленная область обрезки удаляется. -
transform
Transform, необязательно -
Используется только если path является
Path. В этом случае указанныйPathпреобразуется вTransformedPathс помощью transform.
-
path
Примечания
Для повышения эффективности, если path — это
Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и установит путь обрезки вNone.По техническим причинам (поддержка
set) также принимается кортеж (path, transform) в качестве единственного позиционного параметра.
- set_cmap(cmap)[source]
-
Установить цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили str или None
-
cmap
- set_color(c)[source]
-
Установить цвет(цвета) контура(ов) LineCollection.
- Параметры:
-
- cцвет или список цветов
-
Один цвет (все линии имеют один цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически принимать цвета из последовательности.
- set_colors(c)[source]
-
Установить цвет(цвета) контура(ов) LineCollection.
- Параметры:
-
- cцвет или список цветов
-
Один цвет (все линии имеют один цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически принимать цвета из последовательности.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет(цвета) контура(ов) коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(цвета) контура(ов) коллекции. Если последовательность, фигуры будут циклически принимать цвета из последовательности. Если 'face', будет соответствовать цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет(цвета) заливки коллекции. c может быть цветом (все фигуры имеют один цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически принимать цвета из последовательности.
Если c равно 'none', фигура не будет заливаться.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установите экземпляр
Figure, к которому принадлежит элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установите идентификатор (группы) для элемента.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, будет ли элемент включен в вычисления макета, например, Руководство по ограниченному макету,
Figure.tight_layout(), иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установите
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установите метку, которая будет отображаться в легенде.
- Параметры:
-
- sобъект
-
s будет преобразован в строку с помощью вызова
str.
- set_linelength(linelength)[source]
-
Установите длину линий, используемых для маркировки каждого события.
- set_lineoffset(lineoffset)[source]
-
Установите смещение линий, используемых для маркировки каждого события.
- set_linestyle(ls)[source]
-
Установите стиль(и) линии для набора.
linestyle
описание
'-'или'solid'сплошная линия
'--'или'dashed'штриховая линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно предоставить кортеж штрихов с последующей формой:
(offset, onoffseq),
где
onoffseqпредставляет собой кортеж четной длины, содержащий значения включения и выключения чернил в пунктах.- Параметры:
-
- lsстрока или кортеж или список таких кортежей
-
Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения)}. См.
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установите ширину(ы) линии(й) для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности.
- Параметры:
-
- lwчисло с плавающей точкой или список чисел с плавающей точкой
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Устанавливает, запрашивается ли у этого элемента информация о контексте при перемещении курсора мыши над ним.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установить экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если какие-либо цветовые шкалы используют отображение для этой нормализации, установка нормализации отображения сбросит нормализацию, локатор и форматирование на цветовой шкале по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установить преобразование смещения элемента.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установить смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_orientation(orientation)[source]
-
Установить ориентацию линии события.
- Параметры:
-
- orientation{'горизонтально', 'вертикально'}
- set_path_effects(path_effects)[source]
-
Установить эффекты траектории.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(segments)[source]
- set_picker(picker)[source]
-
Определить поведение выбора элемента.
- Параметры:
-
- pickerNone или bool или float или вызываемый
-
Может быть одним из следующих:
- None: Выбор отключён для данного элемента (по умолчанию).
- Булево значение: если True, то выбор будет включён, и элемент будет генерировать событие выбора, если указатель мыши находится над ним.
- Число с плавающей точкой: если значение picker — число, оно интерпретируется как значение допуска в пунктах, и элемент будет генерировать событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции участков, элемент может предоставить дополнительные данные событию выбора, например, индексы данных, находящихся в пределах допуска от события выбора
-
Функция: если picker — вызываемый объект, это функция, предоставляемая пользователем, которая определяет, попадает ли элемент в область наведения курсором мыши:
hit, props = picker(artist, mouseevent)
для определения проверки попадания. Если указатель мыши находится над элементом, вернуть hit=True и props — словарь свойств, которые нужно добавить к атрибутам события PickEvent.
- set_pickradius(pickradius)[source]
-
Установить радиус выбора, используемый для проверок включения.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в пунктах.
- set_positions(positions)[source]
-
Установить позиции событий.
- set_rasterized(rasterized)[source]
-
Принудительное растрирование (отображение в виде битовой карты) для векторной графики.
Растрирование не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.
Это свойство игнорируется для выходных данных на основе пикселей.
См. также Растрирование для векторной графики.
- Параметры:
-
- rasterizedbool
- set_segments(segments)[source]
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен
Noneили не указан, фильтр наброска не будет применён. - lengthfloat, необязательно
-
Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Множитель масштаба, с помощью которого длина сжимается или расширяется (по умолчанию 16.0)
Backend PGF использует это значение как seed для генератора случайных чисел, а не так, как описано выше. Использование одного и того же seed приводит к одному и тому же случайному рисунку.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если определена чёрная линия шириной 1 пиксель в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым цветом в обеих смежных пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение будет действительно содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к ближайшему центру пикселя.
- False: Не изменять позиции вершин.
- None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование элемента.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для элемента.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок строк или None
Примечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_verts(segments)[source]
- set_visible(b)[source]
-
Установить видимость элемента.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок элемента. Элементы с меньшими значениями zorder рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли элемент 'stale' и требуется ли его перерисовка для соответствия выходных данных внутреннему состоянию элемента.
- propertysticky_edges
-
xиyсписки привязанных границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра "прилипает" к краю. Типичный пример использования — гистограммы, где обычно не ожидается отступ на нижнем краю (0) гистограммы.
Кроме того, расширение отступа "натыкается" на привязанные края и не может их пересечь. Например, если верхний предел данных равен 1,0, а верхний предел просмотра, вычисленный с помощью простого применения отступа, равен 1,2, но есть привязанный край в 1,1, то фактический верхний предел просмотра будет 1,1.
К этому атрибуту нельзя присваивать; однако, списки
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)[source]
-
Возвращает нормализованный массив 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)[source]
-
Обновить свойства этого объекта из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копирование свойств из other в self.
- update_scalarmappable()[source]
-
Обновление цветов из массива скалярной карты, если он есть.
Присвоение цветов границам и граням на основе массива и/или непосредственно установленных цветов, если это необходимо.
- zorder=0
- classmatplotlib.collections.LineCollection(segments, *, zorder=2, **kwargs)[source]
-
Основы:
CollectionПредставляет последовательность
Line2D, которые должны быть нарисованы вместе.Этот класс расширяет
Collection, чтобы представлять последовательностьLine2D, а не просто последовательностьPatch. Так же, как и вCollection, каждый атрибут LineCollection может быть либо одиночным значением, либо списком значений. Этот список затем циклически используется для каждого элемента LineCollection, поэтому свойствоi-го элемента коллекции:prop[i % len(prop)]
Свойства каждого члена LineCollection по умолчанию принимают значения в
rcParams["lines.*"], а не вrcParams["patch.*"], и свойство colors добавлено вместо edgecolors.- Параметры:
-
- segmentsсписок массивоподобных объектов
-
Последовательность (line0, line1, line2), где:
linen = (x0, y0), (x1, y1), ... (xm, ym)
или эквивалентный массив NumPy с двумя столбцами. Каждая линия может иметь разное количество сегментов.
-
linewidthsfloat или список float, по умолчанию:
rcParams["lines.linewidth"](по умолчанию:1.5) -
Ширина каждой линии в пунктах.
-
colorsцвет или список цветов, по умолчанию:
rcParams["lines.color"](по умолчанию:'C0') -
Последовательность кортежей RGBA (например, строковые представления цветов и т. д., не разрешены).
-
antialiasedsbool или список bool, по умолчанию:
rcParams["lines.antialiased"](по умолчанию:True) -
Использовать ли сглаживание для каждой линии.
- zorderfloat, по умолчанию: 2
-
zorder линий после отрисовки.
- facecolorsцвет или список цветов, по умолчанию: 'none'
-
При установке facecolors, каждая линия интерпретируется как граница области, неявно закрывая путь от последней точки к первой точке. Закрытая область заполнена facecolor. Чтобы вручную указать, что должно считаться «внутренней» частью каждой линии, используйте
PathCollection, где «внутреннюю» часть можно указать соответствующим образом используяCLOSEPOLY. - **kwargs
-
Передается в
Collection.
- add_callback(func)[source]
-
Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funcвызываемый объект
-
Функция обратного вызова. Она должна иметь следующий вид:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Возвращаемые значения могут существовать, но игнорируются.
- Возвращаемое значение:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автоматически масштабирует пределы скаляра на экземпляре нормы, используя текущий массив
- autoscale_None()[source]
-
Автоматически масштабирует пределы скаляра на экземпляре нормы, используя текущий массив, изменяя только пределы, равные None
- propertyaxes
-
Экземпляр
Axes, в котором находится объект, или None.
- changed()[source]
-
Вызовите эту функцию всякий раз, когда изменится отображаемый объект, чтобы уведомить всех слушателей обратных вызовов о сигнале 'changed'.
- colorbar
-
Последняя связанная с этим отображаемым объектом цветовая шкала. Может быть None.
- contains(mouseevent)[source]
-
Проверяет, произошла ли мышь в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразует x, используя тип единиц оси x.
Если объект не находится в осях или у оси x нет единиц, возвращается x.
- convert_yunits(y)[source]
-
Преобразует y, используя тип единиц оси y.
Если объект не находится в осях или у оси y нет единиц, возвращается y.
- draw(renderer)[source]
-
Отрисовывает объект (и его потомков) с помощью указанного рендерера.
Это не имеет эффекта, если объект не виден (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределен в подклассах Artist.
- findobj(match=None, include_self=True)[source]
-
Найти объекты-артисты.
Рекурсивно найти все экземпляры
Artist, содержащиеся в артисте.- Параметры:
-
- match
-
Критерий фильтрации для совпадений. Это может быть
- None: Возвратить все объекты, содержащиеся в артисте.
- Функция со сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только артистов, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только артистов этого класса или его подклассов (isinstanceпроверка).
- include_selfbool
-
Включить self в список, который нужно проверить на соответствие.
- Возвращаемое значение:
-
- список из
Artist
- список из
- format_cursor_data(data)[source]
-
Возвращает строковое представление data.
Примечание
Этот метод предназначен для переопределения подклассами артистов. Как конечный пользователь Matplotlib, скорее всего, вы не будете вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые и вещественные числа и массивы целых и вещественных чисел в строку, разделённую запятыми и заключённую в квадратные скобки, если у артиста нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра для использования с agg-фильтром.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемое для смешивания - не поддерживается на всех бэкендах.
- get_animated()[source]
-
Возвращает, анимирован ли артист.
- get_array()[source]
-
Возвращает массив значений, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (min, max), которые отображаются в пределы цветовой карты.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает, использует ли артист обрезку.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_color()[source]
- get_colors()[source]
- get_cursor_data(event)[source]
-
Возвращает данные курсора для данного события.
Примечание
Этот метод предназначен для переопределения подклассами элементов управления. Скорее всего, пользователь Matplotlib не будет вызывать этот метод самостоятельно.
Данные курсора могут использоваться элементами управления для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.
Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z объекта
AxesImageв строке состояния окна графика во время перемещения мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому относится элемент управления.
- get_fill()[source]
-
Возвращает, закрашен ли объект.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий шаблон штриховки.
- get_in_layout()[source]
-
Возвращает логическое значение,
Trueесли элемент управления включён в вычисления макета.Например, Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента управления в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает значение, указывающее, запрашивается ли у данного элемента информация о контексте при перемещении курсора мыши над ним.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый данным элементом для смещения.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает значение, указывающее, должен ли элемент быть растровым.
- get_segments()[source]
-
- Возвращает:
-
- list
-
Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.
- get_sketch_params()[source]
-
Возвращает параметры наброска для элемента.
- Возвращает:
-
- tuple или None
-
Кортеж из 3 элементов:
- scale: Амплитуда волны перпендикулярно исходной линии.
- length: Длина волны вдоль линии.
- randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.
Возвращает None, если параметры наброска не были заданы.
- get_snap()[source]
-
Возвращает значение параметра привязки.
Подробности см. в
set_snap.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любое обрезание.- Параметры:
-
-
renderer
RendererBaseподкласс -
объект рендеринга, который будет использован для отрисовки графиков (то есть
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Охватывающая рамка (в пикселях координат фигуры).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый данным элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает путь обрезки с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL. См. Гиперссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получить область отображения элемента.
Ширина и высота области отображения неотрицательны.
Подклассы должны переопределять для включения в вычисление области отображения "tight". По умолчанию возвращается пустая область отображения в координатах 0, 0.
Будьте внимательны при использовании этой функции, результаты не обновятся, если область отображения элемента изменится. Область отображения может измениться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или используемого холста (как делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся некорректно.
- get_zorder()[source]
-
Возвращает порядок элемента по z.
- have_units()[source]
-
Возвращает, установлены ли единицы на любой оси.
- is_transform_set()[source]
-
Возвращает, задано ли преобразование для элемента.
Это True после вызова
set_transform.
- propertymouseover
-
Возвращает, запрашивается ли у этого элемента информация о контексте при перемещении указателя мыши над ним.
- propertynorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутри, когда свойство изменяется.
См. также
- pick(mouseevent)[source]
-
Обрабатывает событие выбора.
Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и для элемента установлен picker.
См. также
- pickable()[source]
-
Возвращает, является ли элемент выбираемым.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента.
- remove()[source]
-
Удаляет элемент из фигуры, если это возможно.
Эффект будет виден только после перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Вызовrelimдля обновления пределов осей, если это необходимо.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи легенды элемента.
- remove_callback(oid)[source]
-
Удалить обратный вызов на основе его идентификатора наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, colors=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, segments=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить несколько свойств сразу.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
массив-подобный объект или скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
массив-подобный объект или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Path, Transform) или None
Colormapили строка или Noneцвет или список цветов
цвет или список цветов
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массив-подобный объект
неизвестно
None или bool или float или вызываемый объект
неизвестно
bool
неизвестно
(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
неизвестно
bool
число с плавающей точкой
-
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от нижнего левого угла изображения
- set_alpha(alpha)[source]
-
Установить значение альфа, используемое для смешения - не поддерживается во всех бэкэндах.
- Параметры:
-
- alphaмассив-подобный объект или скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли объект для использования в анимации.
Если True, объект исключается из обычного рисования фигуры. Вам необходимо явно вызвать
Figure.draw_artist/Axes.draw_artistна объекте. Этот подход используется для ускорения анимации с помощью блиттинга.См. также
matplotlib.animationи Более быстрое отображение с использованием блиттинга.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для рендеринга.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного объекта A.
- Параметры:
-
- Aмассив-подобный объект или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить стиль закругления концов (
CapStyle) для коллекции (для всех ее элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормы для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также можно передать как кортеж (vmin, vmax) как единственный позиционный аргумент.
- set_clip_box(clipbox)[source]
-
Установить область обрезки объекта (
Bbox).- Параметры:
-
-
clipbox
Bbox -
Как правило, создается из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)— это стандартная обрезка для объекта, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, используется ли обрезка объектом.
При значении False объекты будут видны за пределами Axes, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установить область обрезки для элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, также необходимо указать transform. Если None, ранее заданная область обрезки будет удалена. -
transform
Transform, необязательно -
Используется только если path —
Path. В этом случае данныйPathпреобразуется вTransformedPathс помощью transform.
-
path
Примечания
Для повышения эффективности, если path —
Rectangle, этот метод установит прямоугольник обрезки и задаст область обрезки в соответствии сNone.По техническим причинам (поддержка
set) в качестве единственного позиционного параметра также принимается кортеж (path, transform).
- set_cmap(cmap)[source]
-
Установить цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили строка или None
-
cmap
- set_color(c)[source]
-
Установить цвет(цвета) обводки LineCollection.
- Параметры:
-
- cцвет или список цветов
-
Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически перебирать цвета из последовательности.
- set_colors(c)[source]
-
Установить цвет(цвета) обводки LineCollection.
- Параметры:
-
- cцвет или список цветов
-
Один цвет (все линии имеют одинаковый цвет) или последовательность кортежей RGBA; если это последовательность, линии будут циклически перебирать цвета из последовательности.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет(цвета) обводки коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(цвета) обводки коллекции. Если это последовательность, элементы будут циклически перебирать цвета из последовательности. Если 'face', соответствовать цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет(цвета) заливки коллекции. c может быть цветом (все элементы имеют одинаковый цвет) или последовательностью цветов; если это последовательность, элементы будут циклически перебирать цвета из последовательности.
Если c — 'none', элемент не будет заливаться.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установите экземпляр
Figure, к которому принадлежит элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установите идентификатор (группы) для элемента.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, следует ли включать элемент в вычисления макета, например, в Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установите стиль соединения
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установите метку, которая будет отображаться в легенде.
- Параметры:
-
- sобъект
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установите стиль(и) линии для набора.
стиль_линии
описание
'-'или'solid'сплошная линия
'--'или'dashed'штриховая линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы может быть предоставлена кортеж точек:
(offset, onoffseq),
где
onoffseq- это кортеж чётной длины, содержащий длины включения и выключения чернил в пунктах.- Параметры:
-
- lsстрока или кортеж или список таких кортежей
-
Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность вкл/выкл)}. См.
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить толщину(ы) линии для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности
- Параметры:
-
- lwfloat или список float
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установить, запрашивается ли у этого элемента информация о контексте при наведении курсора мыши.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установить экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если какие-либо цветовые шкалы используют отображаемый объект для этой нормализации, установка нормализации отображаемого объекта сбросит нормализацию, локатор и форматеры цветовой шкалы по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установить преобразование смещения элемента.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установить смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Установить эффекты пути.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(segments)[source]
- set_picker(picker)[source]
-
Определить поведение выбора элемента.
- Параметры:
-
- pickerNone или bool или float или вызываемый объект
-
Может быть одним из следующих:
- None: Выбор отключен для данного элемента (по умолчанию).
- Булево значение: если True, то выбор будет включен, и элемент будет генерировать событие выбора, если курсор мыши над элементом.
- Число с плавающей точкой: если picker — число, оно интерпретируется как допуск в точках, и элемент будет генерировать событие, если данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции объектов, элемент может предоставлять дополнительные данные для события выбора, например, индексы данных, находящихся в пределах допуска от события выбора
-
Вызываемый объект: если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли элемент под действие события мыши:
hit, props = picker(artist, mouseevent)
чтобы определить проверку попадания. если курсор мыши над элементом, верните hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установить радиус выбора, используемый для тестов на включение.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в точках.
- set_rasterized(rasterized)[source]
-
Принудительно растрировать (отображение по пикселям) для вывода векторной графики.
Растрирование не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не будет иметь эффекта, и будет выведено предупреждение.
Это значение игнорируется для вывода по пикселям.
См. также Растрирование для векторной графики.
- Параметры:
-
- rasterizedbool
- set_segments(segments)[source]
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равно
None, или не предоставлено, фильтр наброска не будет предоставлен. - lengthfloat, необязательно
-
Длина колебания вдоль линии в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Коэффициент масштабирования, с помощью которого длина сжимается или расширяется (по умолчанию 16.0)
Пакет PGF использует это аргумент в качестве семени генератора случайных чисел, а не как описано выше. Использование того же семени дает ту же случайную форму.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в двух соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к центру ближайшего пикселя.
- False: Не изменять позиции вершин.
- None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование объекта.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для объекта.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок str или None
Примечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_verts(segments)[source]
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок объекта. Объекты с более низкими значениями z-порядка рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли объект 'устаревшим' и необходимо ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию объекта.
- propertysticky_edges
-
xиyсписки липких границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен—предел просмотра "прилипает" к краю. Типичный пример использования — гистограммы, где обычно не требуется отступ на нижнем краю (0) гистограммы.
Кроме того, расширение отступа "натыкается" на липкие края и не может их пересекать. Например, если верхний предел данных равен 1.0, верхний предел просмотра, вычисленный простым применением отступа, равен 1.2, но существует липкий край в 1.1, то фактический верхний предел просмотра будет 1.1.
Этот атрибут нельзя присвоить; однако списки
xиyможно изменять на месте по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает массив rgba, соответствующий x, в нормализованном виде.
В обычном случае x является 1D или 2D последовательностью скаляров, и соответствующий массив 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)[source]
-
Обновить свойства этого объекта из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копирует свойства из other в self.
- update_scalarmappable()[source]
-
Обновляет цвета из массива сопоставителей скаляров, если таковой имеется.
Присваивает цвета к границам и граням, основываясь на массиве и/или цветах, которые были непосредственно заданы, соответственно.
- zorder=0
- classmatplotlib.collections.PatchCollection(patches, *, match_original=False, **kwargs)[source]
-
Базы:
CollectionОбщий набор фигурок.
PatchCollection рисует быстрее, чем большое количество отдельных фигурок. Также это упрощает назначение цветовой карты для разнородного набора фигурок.
- Параметры:
-
-
patchesсписок
Patch -
Последовательность объектов Patch. Этот список может содержать разнородный набор различных типов фигурок.
- match_originalbool, по умолчанию: False
-
Если True, используются цвета и линии толщины исходных фигурок. Если False, новые цвета могут быть назначены, предоставив стандартные аргументы коллекции, facecolor, edgecolor, linewidths, norm или cmap.
- **kwargs
-
Все остальные параметры передаются в
Collection.Если какие-либо из edgecolors, facecolors, linewidths, antialiaseds равны None, они по умолчанию принимают значения настроек
rcParamsдля фигурок, в последовательной форме.
-
patchesсписок
Примечания
Использование функциональности
ScalarMappableявляется необязательным. Если матрицаScalarMappableустановлена (через вызовset_array), во время отрисовки будет сделан вызов scalar mappable для установки цветов заливки.- add_callback(func)[source]
-
Добавить функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funccallable
-
Функция обратного вызова. Она должна иметь следующий сигнатуру:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Значения возвращаемых данных могут существовать, но игнорируются.
- Возвращает:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автоматически масштабировать пределы скаляра в экземпляре norm, используя текущий массив
- autoscale_None()[source]
-
Автоматически масштабировать пределы скаляра в экземпляре norm, используя текущий массив, изменяя только пределы, которые равны None
- propertyaxes
-
Экземпляр
Axes, в котором находится элемент, или None.
- changed()[source]
-
Вызовите это, когда карта значений изменится, чтобы уведомить всех слушателей обратного вызоваSM о сигнале 'changed'.
- colorbar
-
Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.
- contains(mouseevent)[source]
-
Проверить, произошёл ли событие мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразовать x, используя тип единиц измерения оси x.
Если элемент не входит в Axes или ось x не имеет единиц измерения, возвращается само x.
- convert_yunits(y)[source]
-
Преобразовать y, используя тип единиц измерения оси y.
Если элемент не входит в Axes или ось y не имеет единиц измерения, возвращается само y.
- draw(renderer)[source]
-
Отобразить элемент (и его потомков) с помощью данного рендерера.
Это не имеет эффекта, если элемент не виден (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределён в подклассах Artist.
- findobj(match=None, include_self=True)[source]
-
Найти объекты элементов.
Рекурсивно найти все
Artistэкземпляры, содержащиеся в элементе.- Параметры:
-
- match
-
Критерий фильтрации соответствий. Это может быть
- None: Вернуть все объекты, содержащиеся в элементе.
- Функция с сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только те элементы, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только элементы этого класса или его подклассы (isinstanceпроверка).
- include_selfbool
-
Включать self в список для проверки на соответствие.
- Возвращает:
-
- список
Artist
- список
- format_cursor_data(data)[source]
-
Возвращает строковое представление data.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Пользователям Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделенную запятыми, заключённую в квадратные скобки, если у элемента нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра для использования с фильтром agg.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается на всех бэкендах.
- get_animated()[source]
-
Возвращает значение, указывающее, анимирован ли элемент.
- get_array()[source]
-
Возвращает массив значений, сопоставленных с цветами.
Базовый класс
ScalarMappableне делает предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (минимум, максимум), которые сопоставляются с пределами цветовой карты.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает значение, указывающее, используется ли обрезка для элемента.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для заданного события.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Пользователям Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.
Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственным текущим случаем использования является отображение значения z объекта
AxesImageв строке состояния окна графика при перемещении курсора мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит объект.
- get_fill()[source]
-
Возвращает, заполнена ли фигура цветом.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий шаблон штриховки.
- get_in_layout()[source]
-
Возвращает логический флаг,
Trueуказывающий, включён ли объект в расчёт макета.Например, Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого объекта в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает значение, указывающее, запрашивается ли у данного объекта пользовательская контекстная информация при перемещении курсора мыши над ним.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый для смещения данного объекта.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает значение растрирования элемента.
- get_sketch_params()[source]
-
Возвращает параметры наброска для элемента.
- Возвращает:
-
- tuple или None
-
Кортеж из 3 элементов:
- scale: Амплитуда колебаний перпендикулярно исходной линии.
- length: Длина колебаний вдоль линии.
- randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.
Возвращает None, если параметры наброска не были установлены.
- get_snap()[source]
-
Возвращает настройку привязки.
Подробности см. в
set_snap.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любое обрезание.- Параметры:
-
-
renderer
RendererBaseподкласс -
рендерер, который будет использован для отрисовки графиков (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Охватывающая область (в пикселях координат рисунка).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает путь обрезки с примененной неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному на каждый элемент коллекции.
Список содержит None для элементов без URL. См. Ссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получает область элемента в пространстве отображения.
Ширина и высота области неотрицательны.
Подклассы должны переопределять для включения в вычисление "плотной" области. По умолчанию возвращается пустая область в 0, 0.
Будьте осторожны при использовании этой функции, результаты не обновятся, если область элемента в пространстве отображения изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера рисунка или используемого холста (как делается при сохранении рисунка). Это может привести к неожиданному поведению, когда интерактивные рисунки будут выглядеть нормально на экране, но будут сохранены неправильно.
- get_zorder()[source]
-
Возвращает z-порядок элемента.
- have_units()[source]
-
Возвращает, установлены ли единицы на любой оси.
- is_transform_set()[source]
-
Возвращает, установлено ли преобразование у элемента.
Это True после вызова
set_transform.
- propertymouseover
-
Возвращает, запрашивается ли у этого элемента пользовательская информация контекста при наведении курсора мыши.
- propertynorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутренне при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обработка события выбора.
Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен picker.
См. также
- pickable()[source]
-
Возвращает, можно ли выбрать элемент.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента.
- remove()[source]
-
Удаляет элемент из фигуры, если возможно.
Эффект будет виден только после перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Вызовитеrelim, чтобы обновить пределы осей, если нужно.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.Примечание: удаление записи легенды элемента не поддерживается.
- remove_callback(oid)[source]
-
Удаляет обратный вызов по его идентификатору наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить сразу несколько свойств.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, принимающая массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращающая массив (m, n, 3) и два смещения от нижнего левого угла изображения
массивоподобный объект, скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
массивоподобный объект или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Patch или (Path, Transform) или None
Colormapили str или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
str
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массивоподобный объект
неизвестно
None или bool или float или вызываемый объект
неизвестно
bool
(scale: float, length: float, randomness: float)
bool или None
str
список строк или None
bool
float
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
-
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения.
- set_alpha(alpha)[source]
-
Установить значение альфа-канала для смешивания. Не поддерживается во всех бэкендах.
- Параметры:
-
- alphaмассив-подобный объект, скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли объект для использования в анимации.
Если True, объект исключается из обычного отображения фигуры. Вам нужно явно вызвать
Figure.draw_artist/Axes.draw_artistна объекте. Этот подход используется для ускорения анимации с помощью блиттинга.См. также
matplotlib.animationи Более быстрое отображение с помощью блиттинга.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для отрисовки.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного объекта A.
- Параметры:
-
- Aмассив-подобный объект или None
-
Значения, которые отображаются в цветах.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить
CapStyleдля коллекции (для всех её элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормы для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также можно передать как кортеж (vmin, vmax) как единственный позиционный аргумент.
- set_clip_box(clipbox)[source]
-
Установить область обрезки объекта.
- Параметры:
-
-
clipbox
Bbox -
Обычно создается из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)- это стандартная область обрезки для объекта, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли объект обрезку.
Если False, объекты будут видимы за пределами Axes, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установите область обрезки для элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если передан
Path, необходимо также указать transform. Если None, ранее заданная область обрезки будет удалена. -
transform
Transform, необязательно -
Используется только если path —
Path, в этом случае переданныйPathпреобразуется вTransformedPathс помощью transform.
-
path
Примечания
Для повышения эффективности, если path —
Rectangle, этот метод установит ограничивающую прямоугольную область и задаст область обрезки вNone.По техническим причинам (поддержка
set) также принимается кортеж (path, transform) в качестве единственного позиционного параметра.
- set_cmap(cmap)[source]
-
Установить цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили str или None
-
cmap
- set_color(c)[source]
-
Установить цвет обводки и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для задания цвета обводки или заливки индивидуально.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет(ы) обводки коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(ы) обводки коллекции. Если последовательность, фигуры циклически используют ее значения. Если 'face', совпадает с цветом заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет(ы) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать ее значения.
Если c равно 'none', фигура не будет залита.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому относится элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор (группы) для объекта-графического элемента.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, должен ли графический элемент включаться в вычисления макета, например, в Руководство по ограниченному макету,
Figure.tight_layout(), иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sobject
-
s будет преобразовано в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль(и) линии для набора.
linestyle
описание
'-'или'solid'сплошная линия
'--'или'dashed'штриховая линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно предоставить кортеж дефисов следующего вида:
(offset, onoffseq),
где
onoffseq- это кортеж чётной длины из значений включения и выключения чернил в пунктах.- Параметры:
-
- lsstr или кортеж или список кортежей
-
Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См.
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить ширину(ы) линии для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности
- Параметры:
-
- lwfloat или список floats
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установить, запрашивается ли у этого элемента информация о контексте при наведении курсора мыши.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установить экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если есть какие-либо цветовые шкалы, использующие отображение для этой нормализации, установка нормализации отображения сбросит нормализацию, локатор и форматирование в цветовой шкале по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установить преобразование смещения элемента.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установить смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Установить эффекты траектории.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(patches)[source]
- set_picker(picker)[source]
-
Определить поведение выбора элемента.
- Параметры:
-
- pickerNone или bool или float или callable
-
Это может быть одно из следующего:
- None: Выбор отключен для этого элемента (по умолчанию).
- Булево значение: Если True, выбор будет включен, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
- Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск в точках, и элемент сгенерирует событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции фигур, элемент может предоставить дополнительные данные в событие выбора, например, индексы данных в пределах допуска от события выбора
-
Функция: Если picker — вызываемая функция, это функция пользователя, которая определяет, попадает ли элемент под событие мыши:
hit, props = picker(artist, mouseevent)
чтобы определить проверку попадания. Если курсор мыши находится над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установить радиус выбора, используемый для проверок попадания.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора, в точках.
- set_rasterized(rasterized)[source]
-
Принудительно использовать растровое (битовое) отображение для векторной графики.
Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.
Эта настройка игнорируется для выходных данных на основе пикселей.
См. также Растрирование для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры эскиза.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебания перпендикулярно исходной линии в пикселях. Если scale —
None, или не указано, фильтр эскиза не будет предоставлен. - lengthfloat, необязательно
-
Длина колебания вдоль линии в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Коэффициент масштабирования, на который уменьшается или увеличивается длина (по умолчанию 16.0)
Фронт-энд PGF использует этот аргумент как семя генератора случайных чисел, а не как описано выше. Использование одного и того же семени дает одну и ту же случайную форму.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением в обоих смежных пикселях. В противоположность этому, привязка переместит линию к ближайшему целочисленному значению пикселя, так что результирующее изображение будет действительно содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только задними планами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к ближайшему центру пикселя.
- False: Не изменять позиции вершин.
- None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование художника.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для художника.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок строк или None
Примечания
URL в настоящее время реализованы только задним планом SVG. Они игнорируются всеми другими задними планами.
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок объекта. Объекты с меньшими значениями zorder рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли объект 'неактуальным' и нужно ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию объекта.
- propertysticky_edges
-
xиyсписки прилипающих границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то не будет добавлено никакого отступа - предел представления «прилипает» к краю. Типичный пример использования - гистограммы, где, как правило, ожидается отсутствие отступа на нижнем краю (0) гистограммы.
Кроме того, расширение отступа «натыкается» на прилипающие края и не может их пересекать. Например, если верхний предел данных равен 1,0, верхний предел представления, вычисленный с помощью простого применения отступа, равен 1,2, но есть прилипающий край в 1,1, то фактический верхний предел представления будет 1,1.
К этому атрибуту нельзя обращаться; однако, списки
xиyмогут быть изменены на месте по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает массив rgba, нормализованный по отношению к x.
В обычном случае x является 1D или 2D последовательностью скаляров, и соответствующий массив 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)[source]
-
Обновить свойства этого художника из словаря props.
- Параметры:
-
- propsсловарь
- update_from(other)[source]
-
Копировать свойства из other в self.
- update_scalarmappable()[source]
-
Обновить цвета из массива скалярного сопоставителя, если таковой имеется.
Присвоить цвета границам и граням на основе массива и/или цветов, которые были непосредственно установлены, соответственно.
- zorder=0
- classmatplotlib.collections.PathCollection(paths, sizes=None, **kwargs)[source]
-
Bases:
_CollectionWithSizesA collection of
Paths, as created by e.g.scatter.- Parameters:
-
-
pathslist of
path.Path -
The paths that will make up the
Collection. - sizesarray-like
-
The factor by which to scale each drawn
Path. One unit squared in the Path's data space is scaled to besizes**2points when rendered. - **kwargs
-
Forwarded to
Collection.
-
pathslist of
- add_callback(func)[source]
-
Add a callback function that will be called whenever one of the
Artist's properties changes.- Parameters:
-
- funccallable
-
The callback function. It must have the signature:
def func(artist: Artist) -> Any
where artist is the calling
Artist. Return values may exist but are ignored.
- Returns:
-
- int
-
The observer id associated with the callback. This id can be used for removing the callback with
remove_callbacklater.
См. также
- autoscale()[source]
-
Autoscale the scalar limits on the norm instance using the current array
- autoscale_None()[source]
-
Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None
- propertyaxes
-
The
Axesinstance the artist resides in, or None.
- changed()[source]
-
Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal.
- colorbar
-
The last colorbar associated with this ScalarMappable. May be None.
- contains(mouseevent)[source]
-
Test whether the mouse event occurred in the collection.
Returns
bool, dict(ind=itemlist), where every item in itemlist contains the event.
- convert_xunits(x)[source]
-
Convert x using the unit type of the xaxis.
If the artist is not contained in an Axes or if the xaxis does not have units, x itself is returned.
- convert_yunits(y)[source]
-
Convert y using the unit type of the yaxis.
If the artist is not contained in an Axes or if the yaxis does not have units, y itself is returned.
- draw(renderer)[source]
-
Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (
Artist.get_visiblereturns False).- Parameters:
-
-
renderer
RendererBasesubclass.
-
renderer
Notes
This method is overridden in the Artist subclasses.
- findobj(match=None, include_self=True)[source]
-
Find artist objects.
Recursively find all
Artistinstances contained in the artist.- Parameters:
-
- match
-
A filter criterion for the matches. This can be
- None: Return all objects contained in artist.
- A function with signature
def match(artist: Artist) -> bool. The result will only contain artists for which the function returns True. - A class instance: e.g.,
Line2D. The result will only contain artists of this class or its subclasses (isinstancecheck).
- include_selfbool
-
Include self in the list to be checked for a match.
- Returns:
-
- list of
Artist
- list of
- format_cursor_data(data)[source]
-
Возвращает строковое представление данных data.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми и заключённую в квадратные скобки, если у элемента нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра, используемую для фильтрации agg.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемое для смешивания - не поддерживается во всех бэкендах.
- get_animated()[source]
-
Возвращает значение, указывающее, анимирован ли элемент.
- get_array()[source]
-
Возвращает массив значений, отображаемых в цвета.
Базовый класс
ScalarMappableне делает предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (минимум, максимум), отображаемые в цветовой шкале.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает значение, указывающее, используется ли обрезка для элемента.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр цветовой карты
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для данного события.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация просто возвращает None.
Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования - отображение значения z элемента
AxesImageв строке состояния окна графика при перемещении указателя мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит элемент.
- get_fill()[source]
-
Возвращает значение, указывающее, окрашен ли заполняемый элемент.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий узор штриховки.
- get_in_layout()[source]
-
Возвращает флаг булевого типа,
Trueесли элемент входит в расчёт макета.Например, Руководство по ограниченному макету,
Figure.tight_layout(), иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает значение, указывающее, запрашивается ли информация о контексте для этого элемента при перемещении курсора мыши по нему.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом для смещения.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента графического объекта.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает значение, указывающее, следует ли растрировать элемент.
- get_sizes()[source]
-
Возвращает размеры (площади) элементов в коллекции.
- Возвращает:
-
- массив
-
Площадь каждого элемента.
- get_sketch_params()[source]
-
Возвращает параметры эскиза для графического объекта.
- Возвращает:
-
- кортеж или None
-
Кортеж из 3 элементов:
- масштаб: Амплитуда колебания перпендикулярно исходной линии.
- длина: Длина колебания вдоль линии.
- случайность: Коэффициент масштабирования, с которым длина сжимается или расширяется.
Возвращает None, если параметры эскиза не были заданы.
- get_snap()[source]
-
Возвращает настройку привязки.
Подробности см. в
set_snap.
- get_tightbbox(renderer=None)[source]
-
Подобно
Artist.get_window_extent, но включает любое обрезание.- Параметры:
-
-
renderer
RendererBaseподкласс -
объект отрисовки, который будет использован для отрисовки фигур (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Охватывающая область (в пикселях координат фигуры).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим объектом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает путь обрезки с применённой не-аффинной частью преобразования и оставшейся аффинной частью преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL. См. Гиперссылки для примера.
- get_visible()[source]
-
Возвращает значение видимости.
- get_window_extent(renderer=None)[source]
-
Получает область элемента в пространстве отображения.
Ширина и высота области неотрицательные.
Подклассы должны переопределять для включения в вычисление "плотной" области. По умолчанию возвращается пустая область в 0, 0.
Будьте осторожны при использовании этой функции, результаты не будут обновлены, если область окна элемента изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся неправильно.
- get_zorder()[source]
-
Возвращает z-порядок графического объекта.
- have_units()[source]
-
Возвращает, установлены ли единицы измерения на любой оси.
- is_transform_set()[source]
-
Возвращает, имеет ли объект-архитектор явно установленное преобразование.
Это True после вызова
set_transform.
- legend_elements(prop='colors', num='auto', fmt=None, func=<function PathCollection.<lambda>>, **kwargs)[source]
-
Создаёт элементы легенды для PathCollection.
Каждый элемент легенды — это
Line2D, представляющий путь, который был нарисован, а каждая метка — это строка, которая представляет каждый путь.Это полезно для получения легенды для графика
scatter; например:scatter = plt.scatter([1, 2, 3], [4, 5, 6], c=[7, 2, 3]) plt.legend(*scatter.legend_elements())
создаёт три элемента легенды, по одному для каждого цвета с числовыми значениями, переданными в c, в качестве меток.
См. также пример Автоматическое создание легенды.
- Параметры:
-
- prop{"colors", "sizes"}, по умолчанию: "colors"
-
Если "colors", элементы легенды будут отображать разные цвета коллекции. Если "sizes", легенда отобразит разные размеры. Чтобы установить оба, используйте kwargs для непосредственного редактирования свойств
Line2D. -
numint, None, "auto" (по умолчанию), массив-подобный тип или
Locator -
Целевое количество элементов для создания. Если None, используются все уникальные элементы массива mappable. Если целое число, целевое использование num элементов в нормированном диапазоне. Если "auto", попробуйте определить, какой вариант лучше подходит для природы данных. Количество созданных элементов может незначительно отличаться от num из-за использования
Locatorдля поиска полезных местоположений. Если список или массив, используются ровно эти элементы для легенды. Наконец, может быть переданLocator. -
fmtстрока,
Formatterили None (по умолчанию) -
Формат или форматтер для меток. Если строка, должна быть допустимым вводом для
StrMethodFormatter. Если None (по умолчанию), используетсяScalarFormatter. -
funcфункция, по умолчанию:
lambda x: x -
Функция для расчёта меток. Часто аргумент размера (или цвета) для
scatterбудет предварительно обработан пользователем с помощью функцииs = f(x)для отображения маркеров; например,size = np.log10(x). Предоставление обратной функции здесь позволяет инвертировать эту предварительную обработку, чтобы метки легенды имели правильные значения; например,func = lambda x: 10**x. - **kwargs
-
Разрешенные ключевые параметры — color и size. Например, может быть полезно установить цвет маркеров, если используется prop="sizes"; аналогично, для установки размера маркеров, если используется prop="colors". Все дальнейшие параметры передаются экземпляру
Line2D. Это может быть полезно, чтобы, например, указать другой markeredgecolor или alpha для элементов легенды.
- Возвращает:
-
-
handlesсписок
Line2D -
Визуальное представление каждого элемента легенды.
- labelsсписок строк
-
Строковые метки для элементов легенды.
-
handlesсписок
- свойствоmouseover
-
Возвращает, запрашивается ли у этого элемента информация о пользовательском контексте при перемещении курсора мыши над ним.
- свойствоnorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутри, когда изменяется свойство.
См. также
- pick(mouseevent)[source]
-
Обрабатывает событие выбора.
Каждый дочерний элемент-архитектор вызовет событие выбора, если mouseevent находится над элементом-архитектором и у элемента-архитектора установлен picker.
См. также
- pickable()[source]
-
Возвращает, является ли элемент-архитектор выбираемым.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента-архитектора.
- remove()[source]
-
Удалить элемент графического объекта из фигуры, если это возможно.
Эффект не будет виден до перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Вызовитеrelim, чтобы обновить пределы осей, если это необходимо.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи легенды элемента графического объекта.
- remove_callback(oid)[source]
-
Удалить обработчик событий на основе идентификатора наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить несколько свойств сразу.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от левого нижнего угла изображения
массивоподобное значение или скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
массивоподобное значение или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Path, Transform) или None
Colormapили строка или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список кортежей
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массивоподобное значение
неизвестно
None или bool или число с плавающей точкой или вызываемая функция
неизвестно
bool
sizesnumpy.ndarrayили None(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
bool
число с плавающей точкой
-
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив float (m, n, глубина) и значение dpi и возвращает массив (m, n, глубина) и два смещения от нижнего левого угла изображения
- set_alpha(alpha)[source]
-
Установить значение альфа, используемое для смешивания — не поддерживается всеми бэкендами.
- Параметры:
-
- alphaarray-like или скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли объект для использования в анимации.
Если True, объект исключается из обычного рисования фигуры. Вы должны явно вызвать
Figure.draw_artist/Axes.draw_artistдля объекта. Этот подход используется для ускорения анимаций с использованием blitting.См. также
matplotlib.animationи Более быстрое отрисовка с помощью blitting.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для отрисовки.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из array-like A.
- Параметры:
-
- Aarray-like или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить
CapStyleдля коллекции (для всех её элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормы для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также могут быть переданы как кортеж (vmin, vmax) как один позиционный аргумент.
- set_clip_box(clipbox)[source]
-
Установить область обрезки объекта.
Bbox.- Параметры:
-
-
clipbox
Bbox -
Обычно создаётся из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)— это стандартная обрезка для объекта, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли объект обрезку.
Когда False, объекты будут видны за пределами Axes, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установите область обрезки объекта.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, transform также должен быть указан. Если None, ранее установленная область обрезки будет удалена. -
transform
Transform, необязательно -
Используется только если path является
Path, в этом случае предоставленныйPathпреобразуется вTransformedPathс использованием transform.
-
path
Примечания
Для повышения эффективности, если path является
Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и установит область обрезки вNone.По техническим причинам (поддержка
set), также принимается кортеж (path, transform) как единственный позиционный параметр.
- set_cmap(cmap)[source]
-
Установите цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили строка или None
-
cmap
- set_color(c)[source]
-
Установите цвет контура и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для установки цвета контура или заливки индивидуально.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установка цвета контура коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет контура коллекции. Если последовательность, фигуры циклически проходят по ней. Если 'face', соответствует цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установка цвета заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически проходить по последовательности.
Если c равно 'none', фигура не будет закрашена.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установите экземпляр
Figure, к которому принадлежит объект.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить (групповой) идентификатор для объекта.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, будет ли объект включён в расчёты макета, например, в Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить стиль соединения для набора (для всех его элементов).
- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sобъект
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль(и) линии для набора.
linestyle
описание
'-'или'solid'сплошная линия
'--'или'dashed'штриховая линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно указать кортеж с чередующимися значениями включения и выключения чернил, например:
(offset, onoffseq),
где
onoffseq- кортеж чётной длины, содержащий длительности включения и выключения чернил в пунктах.- Параметры:
-
- lsстрока или кортеж
-
Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. Подробное описание см. в
Line2D.set_linestyle.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить ширину(ы) линии для набора. lw может быть скалярным значением или последовательностью; если это последовательность, участки будут циклически проходить через последовательность.
- Параметры:
-
- lwчисловое значение или список числовых значений
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установить, запрашивается ли информация о контексте для этого элемента при наведении курсора мыши.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установить экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если есть какие-либо цветовые шкалы, использующие карту отображения для этой нормализации, установка нормализации карты отображения сбросит нормализации, локаторы и форматировщики цветовой шкалы по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установить преобразование смещения элемента.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установить смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный
- set_path_effects(path_effects)[source]
-
Установить эффекты пути.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(paths)[source]
- set_picker(picker)[source]
-
Определите поведение выбора элемента.
- Параметры:
-
- pickerNone или bool или float или вызываемый
-
Это может быть одно из следующих:
- None: Выбор отключён для этого элемента (по умолчанию).
- Булево значение: Если True, выбор будет включён, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
- Число с плавающей точкой: Если picker — число, оно интерпретируется как толерантность в точках, и элемент сгенерирует событие, если его данные находятся в пределах толерантности от события мыши. Для некоторых элементов, таких как линии и коллекции фигур, элемент может предоставить дополнительные данные для события выбора, например, индексы данных, находящихся в пределах толерантности от события выбора
-
Функция: Если picker — вызываемая функция, это пользовательская функция, определяющая, попадает ли элемент под курсор мыши:
hit, props = picker(artist, mouseevent)
чтобы определить проверку на попадание. Если курсор мыши находится над элементом, верните hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установить радиус выбора, используемый для проверок включения.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в точках.
- set_rasterized(rasterized)[source]
-
Принудительное растровое (битовое) отображение для вывода векторной графики.
Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не окажет никакого влияния, и будет выдано предупреждение.
Это значение игнорируется для пиксельного вывода.
См. также Растровое отображение для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sizes(sizes, dpi=72.0)[source]
-
Установить размеры каждого члена коллекции.
- Параметры:
-
-
sizes
numpy.ndarrayили None -
Размер для установки каждого элемента коллекции. Значение — 'площадь' элемента.
- dpifloat, по умолчанию: 72
-
Точки на дюйм (dpi) холста.
-
sizes
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен
Noneили не указан, фильтр наброска не будет применён. - lengthfloat, необязательно
-
Длина колебания по линии в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Множитель масштаба, на который длина уменьшается или увеличивается (по умолчанию 16.0)
Бэкенд PGF использует это значение как seed для генератора случайных чисел, а не как описано выше. Использование одного и того же seed даёт один и тот же случайный рисунок.
- set_snap(snap)[source]
-
Установить поведение привязки к сетке.
Привязка к сетке выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением на обеих соседних позициях пикселей. Напротив, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.
Привязка к сетке в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к центру ближайшего пикселя.
- False: Не изменять положение вершин.
- None: (автоматически) Если путь содержит только прямолинейные сегменты, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование для элемента.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для элемента.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок str или None
Примечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_visible(b)[source]
-
Установить видимость элемента.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок элемента. Элементы с меньшими значениями zorder рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли элемент 'неактуальным' и нуждается ли он в перерисовке для соответствия внутреннему состоянию.
- propertysticky_edges
-
xиyсписки прилипающих границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен—предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно не ожидается отступ на нижней границе (0) гистограммы.
Кроме того, расширение отступа «упирается» в прилипающие края и не может их пересечь. Например, если верхний предел данных равен 1.0, верхний предел просмотра, вычисленный с помощью простого применения отступа, равен 1.2, но существует прилипающий край в 1.1, тогда фактический верхний предел просмотра будет равен 1.1.
К этому атрибуту нельзя обращаться для присвоения значений; тем не менее, списки
xиyможно изменять непосредственно по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает массив rgba, соответствующий x, в нормализованном виде.
В обычном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий
ndarrayмассив значений rgba будет возвращён на основе нормализации и цветовой карты, установленных для этого ScalarMappable.Существует один специальный случай, для обработки изображений, которые уже являются rgb или rgba, например, считанных из файла изображения. Если x — это
ndarrayс 3 измерениями, а последнее измерение равно 3 или 4, то он будет интерпретирован как массив rgb или rgba, и никаких преобразований не будет выполнено. Массив может быть uint8 или иметь тип с плавающей точкой со значениями в диапазоне от 0 до 1; в противном случае будет возбуждено исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, то параметр alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, то параметр alpha игнорируется; он не заменит уже существующее значение альфа-канала. Будет возбуждено исключение ValueError, если третье измерение не равно 3 или 4.В любом случае, если bytes равно False (по умолчанию), массив rgba будет иметь тип float в диапазоне от 0 до 1; если True, возвращаемый массив rgba будет иметь тип uint8 в диапазоне от 0 до 255.
Если norm равно False, то нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне от 0 до 1.
- update(props)[source]
-
Обновляет свойства этого объекта от словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копирует свойства из other в себя.
- update_scalarmappable()[source]
-
Обновляет цвета от массива скалярной сопоставимости, если он есть.
Присваивает цвета границам и поверхностям на основе массива и/или непосредственно заданных цветов, в зависимости от ситуации.
- zorder=0
- classmatplotlib.collections.PolyCollection(verts, sizes=None, *, closed=True, **kwargs)[source]
-
Bases:
_CollectionWithSizes- Параметры:
-
- vertsсписок массивов
-
Последовательность полигонов [verts0, verts1, ...] где каждый элемент verts_i определяет вершины полигона i как двумерный массив-подобный объект формы (M, 2).
- sizesмассив, по умолчанию: None
-
Квадратные коэффициенты масштабирования для полигонов. Координаты каждого полигона verts_i умножаются на квадратный корень соответствующей записи в sizes (то есть, sizes определяют масштабирование площадей). Масштабирование применяется до преобразования главного объекта Artist.
- closedbool, по умолчанию: True
-
Указывает, должен ли полигон быть замкнутым путём добавления соединения CLOSEPOLY в конце.
- **kwargs
-
Передаётся в
Collection.
- add_callback(func)[source]
-
Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funcвызываемый объект
-
Функция обратного вызова. Она должна иметь сигнатуру:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Значения возврата могут существовать, но игнорируются.
- Возвращает:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автомасштабирование пределов скаляра на экземпляре нормы с использованием текущего массива
- autoscale_None()[source]
-
Автомасштабирование пределов скаляра на экземпляре нормы с использованием текущего массива, изменяя только пределы, которые равны None
- propertyaxes
-
Экземпляр
Axes, в котором находится объект, или None.
- changed()[source]
-
Вызовите эту функцию всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей обратного вызова signal 'changed'.
- colorbar
-
Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.
- contains(mouseevent)[source]
-
Проверяет, произошла ли мышь в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразует x с использованием типа единиц оси x.
Если объект не содержится в оси или ось x не имеет единиц, возвращается x сам по себе.
- convert_yunits(y)[source]
-
Преобразует y с использованием типа единиц оси y.
Если объект не содержится в оси или ось y не имеет единиц, возвращается y сам по себе.
- draw(renderer)[source]
-
Отображает объект Artist (и его дочерние элементы) с помощью заданного рендерера.
Это не имеет эффекта, если объект не отображается (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределяется в подклассах Artist.
- findobj(match=None, include_self=True)[source]
-
Находит объекты artist.
Рекурсивно находит все
Artistэкземпляры, содержащиеся в объекте.- Параметры:
-
- match
-
Критерий фильтра для совпадений. Может быть
- None: вернуть все объекты, содержащиеся в объекте.
- Функция с сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только объекты, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только объекты этого класса или его подклассов (isinstanceпроверка).
- include_selfbool
-
Включить self в список для проверки соответствия.
- Возвращает:
-
- список
Artist
- список
- format_cursor_data(data)[source]
-
Возвращает строковое представление data.
Примечание
Этот метод предназначен для переопределения подклассами объектов-артистов. Пользователь Matplotlib, скорее всего, не будет вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделенную запятыми и заключенную в квадратные скобки, если у артиста нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра, используемую для фильтра agg.
- get_alpha()[source]
-
Возвращает значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.
- get_animated()[source]
-
Возвращает, анимирован ли объект-артист.
- get_array()[source]
-
Возвращает массив значений, которые отображаются в цветах.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (мин, макс), которые отображаются в пределы цветовой карты.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает, использует ли объект-артист обрезку.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для заданного события.
Примечание
Этот метод предназначен для переопределения подклассами объектов-артистов. Пользователь Matplotlib, скорее всего, не будет вызывать этот метод самостоятельно.
Данные курсора могут быть использованы объектами-артистами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.
Подклассы могут переопределить метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z объекта
AxesImageв строке состояния окна графика во время перемещения указателя мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит элемент.
- get_fill()[source]
-
Возвращает, закрашена ли область.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий узор штриховки.
- get_in_layout()[source]
-
Возвращает логический флаг,
Trueесли элемент включён в вычисления макета.Например, Руководство по ограниченной компоновке,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента на легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает, запрашивается ли у этого элемента пользовательская информация контекста при перемещении курсора мыши над ним.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый для смещения этого элемента.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора объекта.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает, растрирован ли объект.
- get_sizes()[source]
-
Возвращает размеры (площади) элементов в коллекции.
- Возвращает:
-
- массив
-
Площадь каждого элемента.
- get_sketch_params()[source]
-
Возвращает параметры "наброска" для объекта.
- Возвращает:
-
- кортеж или None
-
Кортеж из 3 элементов:
- масштаб: Амплитуда колебаний перпендикулярно исходной линии.
- длина: Длина колебаний вдоль линии.
- случайность: Коэффициент масштабирования, с которым длина укорачивается или увеличивается.
Возвращает None, если параметры "наброска" не были установлены.
- get_snap()[source]
-
Возвращает настройку привязки.
Подробности см. в
set_snap.
- get_tightbbox(renderer=None)[source]
-
Подобно
Artist.get_window_extent, но включает любое обрезание.- Параметры:
-
-
renderer
RendererBaseподкласс -
Отобразитель, который будет использоваться для рисования фигур (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Охватывающая рамка (в пикселях координат фигуры).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим объектом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает путь обрезки с применённой к нему неаффинной частью преобразования и оставшейся аффинной частью преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL. См. Гиперссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получение области объекта в пространстве отображения.
Ширина и высота области являются неотрицательными.
Подклассы должны переопределять для включения в вычисление "плотной" области. По умолчанию возвращает пустую область в точке 0, 0.
Будьте внимательны при использовании этой функции, результаты не будут обновляться, если область объекта в пространстве отображения изменяется. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.
- get_zorder()[source]
-
Возвращает порядок z объекта.
- have_units()[source]
-
Возвращает, установлены ли единицы измерения на любой оси.
- is_transform_set()[source]
-
Возвращает, имеет ли элемент управления явно установленное преобразование.
Это True после вызова
set_transform.
- propertymouseover
-
Возвращает, запрашивается ли у этого элемента управления пользовательская контекстная информация, когда курсор мыши перемещается по нему.
- propertynorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутри при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обработка события выделения.
Каждый дочерний элемент управления сработает с событием выделения, если mouseevent находится над элементом управления, и для элемента управления установлен параметр picker.
См. также
- pickable()[source]
-
Возвращает, является ли элемент управления выделяемым.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента управления.
- remove()[source]
-
Удаляет элемент управления из фигуры, если это возможно.
Эффект будет виден только после перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Для обновления пределов осей вызовитеrelim, если это необходимо.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи легенды элемента управления.
- remove_callback(oid)[source]
-
Удаление обратного вызова на основе его идентификатора наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить сразу несколько свойств.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив (m, n, 3) float и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
массивоподобное или скалярное значение или None
bool
antialiasedили aa или antialiasedsbool или список bool
массивоподобное или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Patch или (Path, Transform) или None
Colormapили строка или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массивоподобное
список массивоподобных
None или bool или число с плавающей точкой или вызываемая функция
неизвестно
bool
sizesnumpy.ndarrayили None(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
список массивоподобных
неизвестно
bool
число с плавающей точкой
-
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив float с размерами (m, n, глубина) и значение dpi, и возвращает массив (m, n, глубина) и два смещения от нижнего левого угла изображения
- set_alpha(alpha)[source]
-
Установить значение альфа для смешивания - не поддерживается на всех бэкендах.
- Параметры:
-
- alphaмассив-подобный объект или скаляр или None
-
Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли художник для использования в анимации.
Если True, художник исключается из обычной отрисовки фигуры. Вам нужно явно вызвать
Figure.draw_artist/Axes.draw_artistна художнике. Этот подход используется для ускорения анимаций с помощью блиттинга.См. также
matplotlib.animationи Более быстрое отображение с использованием блиттинга.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для рендеринга.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного объекта A.
- Параметры:
-
- Aмассив-подобный объект или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить
CapStyleдля коллекции (для всех ее элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормализации для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также могут быть переданы как кортеж (vmin, vmax) как единственный позиционный аргумент.
- set_clip_box(clipbox)[source]
-
Установить область обрезки объекта для отрисовки.
- Параметры:
-
-
clipbox
Bbox -
Как правило, создается из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)является стандартной обрезкой для объекта, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли объект обрезку.
Если False, объекты будут видны за пределами области рисования, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установите область обрезки для объекта.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, transform также должен быть задан. Если None, ранее установленная область обрезки удаляется. -
transform
Transform, необязательно -
Используется только если path является
Path, в этом случае заданныйPathпреобразуется вTransformedPathс использованием transform.
-
path
Примечания
Для повышения эффективности, если path —
Rectangle, этот метод установит область обрезки в соответствующий прямоугольник и установит область обрезки вNone.По техническим причинам (поддержка
set), в качестве единственного позиционного параметра также принимается кортеж (path, transform).
- set_cmap(cmap)[source]
-
Устанавливает цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили строка или None
-
cmap
- set_color(c)[source]
-
Устанавливает цвет границы и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для установки цвета границы или заливки индивидуально.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Устанавливает цвет(а) границы коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(а) границы коллекции. Если это последовательность, фигуры будут циклически менять цвет. Если 'face', будет соответствовать цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Устанавливает цвет(а) заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически менять цвет. Если c — 'none', фигура не будет закрашена.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому принадлежит объект.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор группы для объекта.
- Параметры:
-
- gidstr
- 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)[source]
-
Устанавливает, следует ли включать объект в расчеты макета, например, в руководстве по ограниченному макету Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Устанавливает
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Устанавливает метку, которая будет отображаться в легенде.
- Параметры:
-
- sобъект
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль линии(ей) для набора.
стиль линии
описание
'-'или'solid'сплошная линия
'--'или'dashed'пунктирная линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно указать кортеж тире следующего формата:
(offset, onoffseq),
где
onoffseqпредставляет собой кортеж чётной длины из отрезков вводимого и выводимого чернил в пунктах.- Параметры:
-
- lsstr или кортеж или список кортежей
-
Допустимые значения для отдельных стилей линии включают {'-', '--', '-.', ':', '', (смещение, последовательность вкл/выкл)}. См.
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Устанавливает толщину линии(й) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, фигуры будут перебирать последовательность
- Параметры:
-
- lwfloat или список чисел с плавающей запятой
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установите, запрашивается ли у этого объекта пользовательская информация о контексте, когда курсор мыши перемещается по нему.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установите экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если какие-либо цветовые шкалы используют карту отображения для этой нормализации, установка нормализации отображаемого объекта сбросит нормализацию, локатор и форматировщики на цветовой шкале по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установите преобразование смещения объекта.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установите смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Установите эффекты траектории.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(verts, closed=True)[source]
-
Установите вершины многоугольников.
- Параметры:
-
- vertsсписок массив-подобных объектов
-
Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массив-подобный объект формы (M, 2).
- closedbool, по умолчанию: True
-
Закрывать ли многоугольник, добавив соединение CLOSEPOLY в конце.
- set_picker(picker)[source]
-
Определите поведение выбора объекта.
- Параметры:
-
- pickerNone или bool или float или вызываемая функция
-
Это может быть одно из следующих:
- None: Выбор отключён для данного объекта (по умолчанию).
- Булево значение: Если True, выбор будет включён, и объект будет генерировать событие выбора, если курсор мыши над ним.
- Число с плавающей запятой: Если значение pickera — число, оно интерпретируется как значение погрешности в пунктах, и объект будет генерировать событие, если его данные находятся в пределах погрешности от события мыши. Для некоторых объектов, таких как линии и коллекции блоков, объект может предоставлять дополнительные данные в событие выбора, сгенерированное, например, индексы данных в пределах погрешности от события выбора
-
Вызываемая функция: Если picker — вызываемая функция, это пользовательская функция, которая определяет, попадает ли объект под событие мыши:
hit, props = picker(artist, mouseevent)
чтобы определить тест на попадание. Если курсор мыши находится над объектом, верните hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установите радиус выбора, используемый для тестов на попадание.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в пунктах.
- set_rasterized(rasterized)[source]
-
Принудительно выполнить растровый (растровый) вывод для векторизованного графического вывода.
Растровый вывод не поддерживается всеми объектами. Если вы попытаетесь включить это для объекта, который его не поддерживает, команда не повлияет, и будет выдано предупреждение.
Это свойство игнорируется для вывода на основе пикселей.
См. также Растеризация для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sizes(sizes, dpi=72.0)[source]
-
Установите размеры каждого элемента коллекции.
- Параметры:
-
-
sizes
numpy.ndarrayили None -
Размер для установки каждого элемента коллекции. Значение — «площадь» элемента.
- dpifloat, по умолчанию: 72
-
Точки на дюйм холста.
-
sizes
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен
Noneили не предоставлен, фильтр наброска не будет применен. - lengthfloat, необязательно
-
Длина колебаний вдоль линии в пикселях (по умолчанию 128.0).
- randomnessfloat, необязательно
-
Множитель масштаба, с помощью которого длина сжимается или растягивается (по умолчанию 16.0).
Backend PGF использует этот аргумент в качестве начального значения генератора случайных чисел, а не так, как описано выше. Использование одного и того же начального значения приводит к одному и тому же случайному рисунку.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает положения с пиксельной сеткой, что приводит к более четким изображениям. Например, если черная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением на обеих смежных позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение будет содержать линию черного цвета шириной 1 пиксель.
Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к центру ближайшего пикселя.
- False: Не изменять положения вершин.
- None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование художника.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для художника.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок строк или None
Примечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_verts(verts, closed=True)[source]
-
Установить вершины многоугольников.
- Параметры:
-
- vertsсписок массивов
-
Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массив, имеющий форму (M, 2).
- closedbool, по умолчанию: True
-
Закрыть ли многоугольник, добавив соединение CLOSEPOLY в конце.
- set_verts_and_codes(verts, codes)[source]
-
Инициализировать вершины с кодами пути.
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок для объекта. Объекты с меньшими значениями z-порядка выводятся первыми.
- Параметры:
-
- levelfloat
- classmethodspan_where(x, ymin, ymax, where, **kwargs)[source]
-
[Устарело] Возвращает
BrokenBarHCollection, который отображает горизонтальные полосы над областями в x, где where истинно. Полосы охватывают диапазон по оси y от ymin до ymax.kwargs передаются в коллекцию.
Примечания
Устарело начиная с версии 3.7: Используйте fill_between вместо этого.
- propertystale
-
Является ли объект 'недействительным' и нужно ли его перерисовать, чтобы выход соответствовал внутреннему состоянию объекта.
- свойствоsticky_edges
-
xиyсписки липких границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра «прилипает» к краю. Типичным примером использования являются гистограммы, где обычно не ожидается отступ на нижней грани (0) гистограммы.
Кроме того, расширение отступа «натыкается» на липкие края и не может их пересечь. Например, если верхний предел данных равен 1,0, а верхний предел просмотра, вычисленный с помощью простого добавления отступа, равен 1,2, но существует липкий край в 1,1, то фактический верхний предел просмотра будет 1,1.
К этому атрибуту нельзя присвоить значение; однако, списки
xиyможно изменять непосредственно по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает массив rgba, соответствующий x, в нормализованном виде.
В обычном случае x является одномерной или двумерной последовательностью скаляров, и соответствующий
ndarrayмассив значений rgba будет возвращен на основе нормы и цветовой карты, установленных для этого ScalarMappable.Существует один особый случай для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x является
ndarrayс 3 измерениями, и последнее измерение равно 3 или 4, то оно будет обрабатываться как rgb или rgba массив, и никакой обработки не будет выполнено. Массив может быть uint8 или может быть с плавающей запятой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с пропусками, маска будет проигнорирована. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, значение параметра alpha игнорируется; оно не заменяет существующую прозрачность. Будет поднято исключение ValueError, если третье измерение не равно 3 или 4.В любом случае, если bytes равно False (по умолчанию), массив rgba будет содержать числа с плавающей точкой в диапазоне 0-1; если оно равно True, возвращаемый массив rgba будет содержать uint8 в диапазоне от 0 до 255.
Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).
- update(props)[source]
-
Обновляет свойства этого объекта-артиста из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копирует свойства из other в self.
- update_scalarmappable()[source]
-
Обновляет цвета из массива scalar mappable, если таковой имеется.
Присваивает цвета краям и граням на основе массива и/или непосредственно заданных цветов, соответственно.
- zorder=0
- классmatplotlib.collections.QuadMesh(coordinates, *, antialiased=True, shading='flat', **kwargs)[source]
-
Bases:
CollectionКласс для эффективного отрисовки сетки четырёхугольников.
Сетка четырёхугольников — это сетка из M на N смежных четырёхугольников, определённых через сетку вершин (M+1, N+1). Четырёхугольник (m, n) определяется вершинами
(m+1, n) ----------- (m+1, n+1) / / / / / / (m, n) -------- (m, n+1)Сетка не обязательно должна быть регулярной, а многоугольники — выпуклыми.
- Параметры:
-
- coordinates(M+1, N+1, 2) массив-подобный объект
-
Вершины.
coordinates[m, n]задаёт координаты (x, y) вершины (m, n). - antialiasedbool, по умолчанию: True
- shading{'flat', 'gouraud'}, по умолчанию: 'flat'
Примечания
В отличие от других
Collection, значение по умолчанию для pickradius уQuadMeshравно 0, т.е.containsпроверяет, находится ли тестовая точка внутри одного из четырёхугольников сетки.- Параметры:
-
-
edgecolorsцвет или список цветов, по умолчанию:
rcParams["patch.edgecolor"](по умолчанию:'black') -
Цвет границы для каждого элемента, составляющего коллекцию. Специальное значение 'face' может быть передано для того, чтобы цвет границы совпадал с цветом заполнения.
-
facecolorsцвет или список цветов, по умолчанию:
rcParams["patch.facecolor"](по умолчанию:'C0') -
Цвет заполнения для каждого элемента, составляющего коллекцию.
-
linewidthsвещественное число или список вещественных чисел, по умолчанию:
rcParams["patch.linewidth"](по умолчанию:1.0) -
Ширина линии для каждого элемента, составляющего коллекцию.
- linestylesстрока или кортеж или список таковых, по умолчанию: 'solid'
-
Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штриховки должны иметь вид:
(offset, onoffseq),
где onoffseq — кортеж чётной длины, содержащий длины включения и выключения чернил в пунктах. Примеры см. в Стилях линий.
-
capstyle
CapStyle-подобный, по умолчанию:rcParams["patch.capstyle"] -
Стиль окончания линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.
-
joinstyle
JoinStyle-подобный, по умолчанию:rcParams["patch.joinstyle"] -
Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.
-
antialiasedsbool или список bool, по умолчанию:
rcParams["patch.antialiased"](по умолчанию:True) -
Определяет, должна ли каждая фигура в коллекции отрисовываться с сглаживанием.
- offsets(float, float) или список таковых, по умолчанию: (0, 0)
-
Вектор, используемый для перемещения каждого элемента после отрисовки (по умолчанию перемещения нет). Перемещение выполняется в координатах экрана (пиксели) (т.е. после применения преобразования объекта-графического элемента).
-
offset_transform
Transform, по умолчанию:IdentityTransform -
Преобразование, которое применяется к каждому вектору offsets перед использованием.
- cmap, norm
-
Параметры нормализации данных и сопоставления цветов. Подробное описание см. в
ScalarMappable. - hatchстрока, необязательно
-
Узор штриховки для заполненных путей, если таковой имеется. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Значение каждого типа штриховки см. в Справочнике по стилям штриховки.
- pickradiusвещественное число, по умолчанию: 5.0
-
Если
pickradius <= 0, тоCollection.containsвернётTrueвсякий раз, когда тестовая точка находится внутри одного из многоугольников, образованных контрольными точками пути в коллекции. С другой стороны, если значение больше 0, то мы вместо этого проверяем, содержится ли тестовая точка в контуре шириной2*pickradiusвдоль любого из путей в коллекции. - urlsсписок строк, по умолчанию: None
-
URL для каждого элемента для создания ссылки после отрисовки. В настоящее время работает только для SVG-бекенда. Примеры см. в Ссылках.
- zorderвещественное число, по умолчанию: 1
-
Порядок отрисовки, общий для всех элементов-фигурок в коллекции. Все значения по умолчанию и примеры см. в Демонстрация zorder.
-
edgecolorsцвет или список цветов, по умолчанию:
- add_callback(func)[source]
-
Добавить функцию обратного вызова, которая будет вызываться всякий раз, когда меняется одно из свойств
Artist.- Параметры:
-
- funcвызываемый объект
-
Функция обратного вызова. Она должна иметь следующий вид:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Возвращаемые значения могут существовать, но игнорируются.
- Возвращаемое значение:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может использоваться для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автомасштабирование пределов скалярных значений на экземпляре нормы с использованием текущего массива
- autoscale_None()[source]
-
Автомасштабирование пределов скалярных значений на экземпляре нормы с использованием текущего массива, изменяя только пределы, равные None
- propertyaxes
-
Экземпляр
Axes, в котором находится графический элемент, или None.
- changed()[source]
-
Вызов при изменении отображаемого объекта для уведомления всех слушателей обратных вызовов сигнала 'changed'.
- colorbar
-
Последняя цветовая шкала, связанная с этим отображаемым скалярным значением. Может быть None.
- contains(mouseevent)[source]
-
Проверка, произошла ли событие мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразовать x используя тип единиц оси x.
Если графический элемент не содержится в Axes или если ось x не имеет единиц измерения, возвращается сам x.
- convert_yunits(y)[source]
-
Преобразовать y используя тип единиц оси y.
Если графический элемент не содержится в Axes или если ось y не имеет единиц измерения, возвращается сам y.
- draw(renderer)[source]
-
Нарисовать графический элемент (и его дочерние элементы) используя заданный рендерер.
Это не оказывает никакого эффекта, если графический элемент не виден (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределен в подклассах Artist.
- findobj(match=None, include_self=True)[source]
-
Найти объекты графических элементов.
Рекурсивно найти все экземпляры
Artist, содержащиеся в графическом элементе.- Параметры:
-
- match
-
Критерий фильтрации для совпадений. Это может быть
- None: Вернуть все объекты, содержащиеся в графическом элементе.
- Функция с сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только графические элементы, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только графические элементы этого класса или его подклассов (isinstanceпроверка).
- include_selfbool
-
Включить self в список, который нужно проверить на соответствие.
- Возвращает:
-
- список
Artist
- список
- format_cursor_data(data)[source]
-
Возвращает строковое представление data.
Примечание
Этот метод предназначен для переопределения подклассами artist. Как конечный пользователь Matplotlib вы, скорее всего, не будете вызывать этот метод самостоятельно.
Реализация по умолчанию преобразует целые числа и числа с плавающей запятой, а также массивы целых чисел и чисел с плавающей запятой в строку, разделённую запятыми и заключенную в квадратные скобки, если у графического элемента нет связанной цветовой шкалы, в этом случае скалярные значения форматируются с использованием форматера цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра, которая будет использоваться для фильтра agg.
- get_alpha()[source]
-
Возвращает значение альфа, используемое для смешивания - не поддерживается во всех бэкэндах.
- get_animated()[source]
-
Возвращает, является ли графический элемент анимированным.
- get_array()[source]
-
Возвращает массив значений, которые сопоставляются с цветами.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (min, max), которые сопоставляются с пределами цветовой карты.
- get_clip_box()[source]
-
Возвращает область отсечения.
- get_clip_on()[source]
-
Возвращает, использует ли графический элемент отсечение.
- get_clip_path()[source]
-
Возвращает путь отсечения.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_coordinates()[source]
-
Возвращает вершины сетки в виде массива (M+1, N+1, 2).
M, N — количество четырехугольников в строках/столбцах сетки, соответствующих (M+1, N+1) вершинам. Последнее измерение определяет компоненты (x, y).
- get_cursor_data(event)[source]
-
Возвращает данные курсора для заданного события.
Примечание
Этот метод предназначен для переопределения подклассами объектов художников. Как пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.
Данные курсора могут использоваться художниками для предоставления дополнительной контекстной информации для данного события. По умолчанию метод возвращает None.
Подклассы могут переопределять метод и возвращать произвольные данные. Однако, при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z
AxesImageв строке состояния окна графика при перемещении мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит объект.
- get_fill()[source]
-
Возвращает значение, указывающее, закрашен ли объект.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущую штриховку.
- get_in_layout()[source]
-
Возвращает логическое значение,
Trueуказывает, включен ли объект в вычисления макета.Например, Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого объекта в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает, запрошено ли у этого элемента информация о контексте при перемещении курсора мыши.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый для смещения этого элемента.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора для элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает, должен ли элемент быть растрированным.
- get_sketch_params()[source]
-
Возвращает параметры наброска для элемента.
- Возвращает:
-
- tuple или None
-
Кортеж из 3 элементов:
- scale: Амплитуда колебания перпендикулярно исходной линии.
- length: Длина колебания вдоль линии.
- randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.
Возвращает None, если параметры наброска не были установлены.
- get_snap()[source]
-
Возвращает значение установки привязки.
Подробнее см.
set_snap.
- get_tightbbox(renderer=None)[source]
-
Подобно
Artist.get_window_extent, но включает любое обрезание.- Параметры:
-
-
renderer
RendererBaseподкласс -
элемент отрисовки, который будет использоваться для рисования графиков (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Охватывающая область (в пиксельных координатах фигуры).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает обрезной путь с применённой неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL. См. Ссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получает прямоугольник отображения элемента.
Ширина и высота прямоугольника неотрицательны.
Подклассы должны переопределять для включения в вычисление прямоугольника «tight». По умолчанию возвращает пустой прямоугольник в координатах 0, 0.
Будьте осторожны при использовании этой функции, результаты не обновятся, если прямоугольник отображения элемента изменится. Прямоугольник может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры выглядят нормально на экране, но сохраняются неправильно.
- get_zorder()[source]
-
Возвращает z-порядок элемента.
- have_units()[source]
-
Возвращает, установлены ли единицы измерения на любой оси.
- is_transform_set()[source]
-
Возвращает, задано ли преобразование элемента явно.
Это True после вызова
set_transform.
- propertymouseover
-
Возвращает, запрашивается ли у этого элемента информация о контексте при перемещении курсора мыши над ним.
- propertynorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается неявно при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обрабатывает событие выбора.
Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен picker.
См. также
- pickable()[source]
-
Возвращает, является ли элемент выбираемым.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента.
- remove()[source]
-
Удаляет элемент из фигуры, если это возможно.
Эффект не будет виден до перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Вызовитеrelimдля обновления пределов осей, если это необходимо.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи легенды элемента.
- remove_callback(oid)[source]
-
Удаляет обратный вызов по его идентификатору наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установите несколько свойств сразу.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения
массивоподобный объект, скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
массивоподобный объект
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Path, Transform) или None
Colormapили строка или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массивоподобный объект
None или bool или float или вызываемый объект
неизвестно
bool
(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
bool
число с плавающей точкой
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
-
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения.
- set_alpha(alpha)[source]
-
Установить значение альфа, используемое для смешивания - не поддерживается во всех бэкэндах.
- Параметры:
-
- alphaмассив или скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли художник для использования в анимации.
Если True, художник исключается из обычного рисования фигуры. Вы должны явно вызвать
Figure.draw_artist/Axes.draw_artistна художнике. Этот подход используется для ускорения анимации с помощью блиттинга.См. также
matplotlib.animationи Ускорение отрисовки с помощью блиттинга.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для отрисовки.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить значения данных.
- Параметры:
-
- Aмассив
-
Данные сетки. Поддерживаемые формы массивов:
- (M, N) или (M*N,): сетка со скалярными данными. Значения отображаются в цветах с помощью нормализации и цветовой карты. См. параметры norm, cmap, vmin, vmax.
- (M, N, 3): изображение с RGB-значениями (числа с плавающей точкой 0-1 или целые числа 0-255).
- (M, N, 4): изображение с RGBA-значениями (числа с плавающей точкой 0-1 или целые числа 0-255), т.е. включая прозрачность.
Если значения заданы в виде 2D сетки, форма должна соответствовать сетке координат. Если значения 1D, они преобразуются в 2D. M, N следуют из сетки координат, где форма сетки координат (M, N) для «gouraud» shading и (M+1, N+1) для «flat» shading.
- set_capstyle(cs)[source]
-
Установить
CapStyleдля коллекции (для всех её элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормализации для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также можно передавать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.
- set_clip_box(clipbox)[source]
-
Установить область обрезки объекта художника.
- Параметры:
-
-
clipbox
Bbox -
Как правило, создаётся из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)— это стандартная область обрезки для художника, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использовать ли обрезку для объекта.
Если False, объекты будут видны за пределами Axes, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установите область обрезки для элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан
Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена. -
transform
Transform, необязательно -
Используется только если path является
Path. В этом случае заданныйPathпреобразуется вTransformedPathс помощью transform.
-
path
Примечания
Для повышения эффективности, если path является
Rectangle, этот метод установит область обрезки для соответствующего прямоугольника и установит область обрезки вNone.По техническим причинам (поддержка
set) также принимается кортеж (path, transform) как единственный позиционный параметр.
- set_cmap(cmap)[source]
-
Установить палитру цветов для данных яркости.
- Параметры:
-
-
cmap
Colormapили str или None
-
cmap
- set_color(c)[source]
-
Установить цвет обводки и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для установки цвета обводки или заливки индивидуально.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет(ы) обводки коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(ы) обводки коллекции. Если последовательность, то участки циклически проходят по ней. Если 'face', совпадает с цветом заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет(ы) заливки коллекции. c может быть цветом (все участки имеют одинаковый цвет) или последовательностью цветов; если это последовательность, участки будут циклически проходить по последовательности.
Если c равно 'none', участок не будет заполнен.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому принадлежит элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор группы для объекта.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, включать ли элемент в расчёты макета, например, Руководство по ограниченному макету,
Figure.tight_layout(), иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sobject
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль(и) линии для набора.
стиль линии
описание
'-'или'solid'сплошная линия
'--'или'dashed'пунктирная линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно указать кортеж с делениями в следующем формате:
(offset, onoffseq),
где
onoffseq- кортеж чётной длины, содержащий интервалы включения и выключения чернил в точках.- Параметры:
-
- lsstr или кортеж или список кортежей
-
Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. Смотрите
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить толщину линии(й) для набора. lw может быть скаляром или последовательностью; если это последовательность, то области будут циклически проходить по последовательности
- Параметры:
-
- lwfloat или список чисел с плавающей точкой
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Устанавливает, запрашивается ли у данного элемента информация о контексте при наведении курсора.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Устанавливает экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если существуют какие-либо цветовые шкалы, использующие отображаемый объект для этой нормализации, установка нормализации отображаемого объекта сбросит нормализацию, локетор и форматеры на цветовой шкале по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Устанавливает трансформирование смещения объекта.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Устанавливает смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Устанавливает эффекты траектории.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths()[source]
- set_picker(picker)[source]
-
Определяет поведение выбора элемента.
- Параметры:
-
- pickerNone или bool или float или вызываемая функция
-
Может быть одним из следующих:
- None: Выбор отключён для этого элемента (по умолчанию).
- Булево значение: Если True, выбор включён, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
- Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск в точках, и элемент сгенерирует событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции патчей, элемент может предоставить дополнительные данные в событии выбора, например, индексы данных, находящихся в пределах допуска от события выбора
-
Вызываемая функция: Если picker — вызываемая функция, это функция, предоставляемая пользователем, которая определяет, попадает ли элемент под курсор мыши:
hit, props = picker(artist, mouseevent)
для определения проверки попадания. Если курсор мыши над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Устанавливает радиус выбора, используемый для проверок на попадание.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора, в точках.
- set_rasterized(rasterized)[source]
-
Вынужденное растровое (битовое) отображение для векторной графики.
Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.
Это значение игнорируется для выходных данных на основе пикселей.
См. также Растрирование для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Устанавливает параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебания перпендикулярно исходной линии, в пикселях. Если scale —
None, или не предоставлено, фильтр наброска не будет предоставлен. - lengthfloat, необязательно
-
Длина колебания вдоль линии, в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Коэффициент масштабирования, на который длина уменьшается или увеличивается (по умолчанию 16.0)
Платформа PGF использует это значение в качестве значения RNG, а не как описано выше. При использовании одного и того же значения семян получается одна и та же случайная форма.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более четким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением в обеих соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что результирующее изображение действительно будет содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к ближайшему центру пикселя.
- False: Не изменять позиции вершин.
- None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование объекта.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для объекта.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок str или None
Примечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок объекта. Объекты с меньшими значениями z-порядка рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли объект «недействительным» и требуется ли его повторная отрисовка для соответствия внутреннему состоянию объекта.
- propertysticky_edges
-
xиyсписки прилипающих границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно ожидается отсутствие отступа по нижнему краю (0) гистограммы.
Кроме того, расширение отступа «упирается» в прилипающие края и не может их пересекать. Например, если верхний предел данных равен 1,0, верхний предел просмотра, вычисленный с применением простого отступа, равен 1,2, но есть прилипающий край в 1,1, то фактический верхний предел просмотра будет 1,1.
К этому атрибуту нельзя присваивать значения; однако списки
xиyмогут быть изменены непосредственно по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает нормализованный массив rgba, соответствующий x.
В обычном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий
ndarrayзначений rgba будет возвращён на основе нормализации и цветовой карты, установленных для этого ScalarMappable.Есть один особый случай, для обработки изображений, которые уже являются rgb или rgba, таких, как могут быть прочитаны из файла изображения. Если x — это
ndarrayс 3 измерениями, и последнее измерение равно 3 или 4, то оно будет обрабатываться как rgb или rgba массив, и никакого отображения не будет выполнено. Массив может быть uint8, или он может быть с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с пропусками, маска будет проигнорирована. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет существующую прозрачность. Будет поднято исключение ValueError, если третье измерение не равно 3 или 4.В любом случае, если bytes равно False (по умолчанию), массив rgba будет числами с плавающей точкой в диапазоне 0-1; если он равен True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.
Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).
- update(props)[source]
-
Обновить свойства этого объекта из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копировать свойства из other в self.
- update_scalarmappable()[source]
-
Обновить цвета из массива отображения скаляра, если таковой имеется.
Присвоить цвета краям и граням на основе массива и/или цветов, которые были непосредственно заданы, в зависимости от ситуации.
- zorder=0
- classmatplotlib.collections.RegularPolyCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[source]
-
Bases:
_CollectionWithSizesКоллекция правильных многоугольников.
- Параметры:
-
- numsidesint
-
Количество сторон многоугольника.
- rotationfloat
-
Поворот многоугольника в радианах.
- sizesкортеж float
-
Площадь окружности, описанной вокруг многоугольника, в точках^2.
- **kwargs
-
Передаются в
Collection.
Примеры
См. Пример Lasso для полного примера:
offsets = np.random.rand(20, 2) facecolors = [cm.jet(x) for x in np.random.rand(20)] collection = RegularPolyCollection( numsides=5, # a pentagon rotation=0, sizes=(50,), facecolors=facecolors, edgecolors=("black",), linewidths=(1,), offsets=offsets, offset_transform=ax.transData, )- add_callback(func)[source]
-
Добавляет функцию обратного вызова, которая вызывается всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funccallable
-
Функция обратного вызова. Она должна иметь сигнатуру:
def func(artist: Artist) -> Any
где artist - вызываемый
Artist. Возвращаемые значения могут существовать, но игнорируются.
- Возвращаемое значение:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автомасштабирование пределов скалярных значений в экземпляре norm на основе текущего массива
- autoscale_None()[source]
-
Автомасштабирование пределов скалярных значений в экземпляре norm на основе текущего массива, изменяя только пределы, равные None
- propertyaxes
-
Экземпляр
Axes, в котором находится объект, или None.
- changed()[source]
-
Вызовите этот метод при изменении отображаемого объекта, чтобы уведомить все слушателей сигнала 'changed'.
- colorbar
-
Последняя связанная с этим ScalarMappable цветовая шкала. Может быть None.
- contains(mouseevent)[source]
-
Проверка, произошла ли событие мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразует x с помощью типа единиц оси x.
Если объект не находится в Axes или ось x не имеет единиц, возвращается x.
- convert_yunits(y)[source]
-
Преобразует y с помощью типа единиц оси y.
Если объект не находится в Axes или ось y не имеет единиц, возвращается y.
- draw(renderer)[source]
-
Отрисовка элемента (и его дочерних элементов) с помощью заданного рендерера.
Это не повлияет на элемент, если он не отображается (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределён в подклассах Artist.
- findobj(match=None, include_self=True)[source]
-
Поиск элементов artist.
Рекурсивный поиск всех
Artistэкземпляров, содержащихся в элементе.- Параметры:
-
- match
-
Критерий фильтра для соответствий. Может быть
- None: Вернуть все объекты, содержащиеся в элементе.
- Функция с сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только элементы этого класса или его подклассов (isinstanceпроверка).
- include_selfbool
-
Включить self в список для проверки соответствия.
- Возвращаемое значение:
-
- Список
Artist
- Список
- format_cursor_data(data)[source]
-
Возвращает строковое представление data.
Примечание
Этот метод предназначен для переопределения подклассами художника. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые числа и числа с плавающей запятой, а также массивы целых чисел и чисел с плавающей запятой в строку, разделенную запятыми, заключенную в квадратные скобки, если у художника нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра для использования с фильтром agg.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемое для смешивания — не поддерживается во всех бэкендах.
- get_animated()[source]
-
Возвращает, анимирован ли элемент.
- get_array()[source]
-
Возвращает массив значений, которые сопоставляются с цветами.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (мин, макс), которые сопоставляются с пределами цветовой карты.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает, используется ли обрезка элемента.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для данного события.
Примечание
Этот метод предназначен для переопределения подклассами художника. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.
Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация просто возвращает None.
Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны убедиться, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z
AxesImageв строке состояния окна графика при перемещении курсора.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит элемент.
- get_fill()[source]
-
Возвращает, закрашен ли элемент.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий узор штриховки.
- get_in_layout()[source]
-
Возвращает флаг boolean,
Trueесли элемент включён в расчёт макета.Например, Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает, запрашивается ли у этого элемента информация для контекста при наведении курсора мыши.
- get_numsides()[source]
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый для смещения этого элемента.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает, нужно ли растрировать элемент.
- get_rotation()[source]
- get_sizes()[source]
-
Возвращает размеры (площади) элементов в коллекции.
- Возвращает:
-
- массив
-
Площадь каждого элемента.
- get_sketch_params()[source]
-
Возвращает параметры наброска для элемента.
- Возвращает:
-
- кортеж или None
-
Кортеж из 3 элементов:
- масштаб: Амплитуда колебания перпендикулярно исходной линии.
- длина: Длина колебания вдоль линии.
- случайность: Коэффициент масштабирования, на который уменьшается или увеличивается длина.
Возвращает None, если параметры наброска не были заданы.
- get_snap()[source]
-
Возвращает установку привязки.
Подробности см. в
set_snap.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любые обрезки.- Параметры:
-
-
renderer
RendererBaseподкласс -
renderer, который будет использоваться для отрисовки фигур (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Окружающая ограничивающая рамка (в пикселях координат фигуры).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает путь обрезки с примененной неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL. См. Гиперссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получить область отображения элемента графического объекта.
Ширина и высота области отображения неотрицательны.
Подклассы должны переопределять этот метод для включения в вычисление «плотной» области отображения. По умолчанию возвращает пустую область отображения в координатах 0, 0.
Будьте внимательны при использовании этой функции, результаты не обновятся, если область отображения элемента графического объекта изменится. Область отображения может измениться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или холста (как при сохранении изображения). Это может привести к неожиданному поведению, где интерактивные фигуры будут отображаться нормально на экране, но будут сохранены неправильно.
- get_zorder()[source]
-
Возвращает порядок z элемента графического объекта.
- have_units()[source]
-
Возвращает, установлены ли единицы измерения на любой оси.
- is_transform_set()[source]
-
Возвращает, задано ли преобразование для элемента графического объекта.
Это True после вызова
set_transform.
- свойствоmouseover
-
Возвращает, запрашивается ли у этого элемента графического объекта информация о контексте при наведении курсора мыши на него.
- свойствоnorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутри при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обрабатывает событие выбора.
Каждый дочерний элемент графического объекта сработает, если mouseevent находится над ним и у элемента графического объекта установлен picker.
См. также
- pickable()[source]
-
Возвращает, может ли элемент графического объекта быть выбран.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента графического объекта.
- remove()[source]
-
Удаляет элемент графического объекта из фигуры, если это возможно.
Эффект не будет виден до перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Вызовитеrelimдля обновления пределов осей, если это необходимо.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи элемента графического объекта в легенде.
- remove_callback(oid)[source]
-
Удаляет обратный вызов на основе его идентификатора наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить сразу несколько свойств.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения
массив, скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
массив или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Path, Transform) или None
Colormapили строка или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массив
неизвестно
None или bool или число с плавающей точкой или вызываемая функция
неизвестно
bool
sizesnumpy.ndarrayили None(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
bool
число с плавающей точкой
-
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funcвызываемый объект
-
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения.
- set_alpha(alpha)[source]
-
Установить значение альфа для смешивания - не поддерживается на всех бэкендах.
- Параметры:
-
- alphaмассив или скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли объект для использования в анимации.
Если True, объект исключается из стандартной отрисовки рисунка. Вам необходимо явно вызвать
Figure.draw_artist/Axes.draw_artistна объекте. Этот подход используется для ускорения анимаций с использованием blitting.См. также
matplotlib.animationи Более быстрое отображение с помощью blitting.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для рендеринга.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного A.
- Параметры:
-
- Aмассив или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить
CapStyleдля коллекции (для всех ее элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормы для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.
- set_clip_box(clipbox)[source]
-
Установить область обрезки объекта
Bbox.- Параметры:
-
-
clipbox
Bbox -
Как правило, создается из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)является стандартной обрезкой для объекта, добавленного в Axes.
-
clipbox
- set_clip_on(b)[source]
-
Установить, используется ли обрезка для объекта.
Когда False, объекты будут видны за пределами осей, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установить область обрезки объекта.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если указан
Path, то также необходимо указать transform. Если None, ранее установленная область обрезки удаляется. -
transform
Transform, необязательно -
Используется только если path является
Path, в этом случае указанныйPathпреобразуется вTransformedPathс помощью transform.
-
path
Примечания
Для повышения эффективности, если path является
Rectangle, этот метод установит прямоугольную область обрезки и задаст путь обрезки кNone.По техническим причинам (поддержка
set), также принимается кортеж (path, transform) в качестве единственного позиционного параметра.
- set_cmap(cmap)[source]
-
Установить цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили строка или None
-
cmap
- set_color(c)[source]
-
Установить цвет обводки и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для установки цвета обводки или заливки индивидуально.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет обводки коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет обводки коллекции. Если последовательность, фигуры будут циклически перебирать её. Если 'face', соответствует цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет заливки коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически перебирать её.
Если c равно 'none', фигура не будет залита.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому принадлежит объект.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор (группы) для объекта-графического элемента.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, включен ли графический элемент в вычисления макета, например, Руководство по ограниченному макету,
Figure.tight_layout(), иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить стиль соединения для набора (для всех его элементов).
- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sobject
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль линии(й) для набора.
linestyle
описание
'-'или'solid'сплошная линия
'--'или'dashed'пунктирная линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно предоставить кортеж с отступами следующей формы:
(offset, onoffseq),
где
onoffseq- кортеж чётной длины, содержащий отступы и значения для начертания линии.- Параметры:
-
- lsstr или кортеж или список кортежей
-
Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. Смотрите
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить толщину линии(й) для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности.
- Параметры:
-
- lwfloat или список чисел с плавающей точкой
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установите, запрашивается ли у этого объекта информация о контексте при перемещении курсора мыши над ним.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установите экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если какие-либо цветные шкалы используют карту отображения для этой нормализации, установка нормализации карты отображения сбросит нормализацию, локатор и форматеры на цветную шкалу в значения по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установите преобразование смещения объекта.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установите смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Установите эффекты траектории.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(paths)[source]
- set_picker(picker)[source]
-
Определите поведение выбора объекта.
- Параметры:
-
- pickerNone или bool или float или вызываемый объект
-
Это может быть одно из следующих:
- None: Выбор отключен для этого объекта (по умолчанию).
- Булево значение: Если True, то выбор будет включен, и объект будет генерировать событие выбора, если курсор мыши находится над объектом.
- Число с плавающей точкой: Если picker — число, оно интерпретируется как значение толерантности epsilon в точках, и объект будет генерировать событие, если его данные находятся в пределах epsilon от события мыши. Для некоторых объектов, таких как линии и коллекции фигур, объект может предоставлять дополнительные данные для события выбора, например, индексы данных в пределах epsilon от события выбора.
-
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, определяющая, попадает ли объект под событие мыши:
hit, props = picker(artist, mouseevent)
для определения проверки попадания. Если курсор мыши находится над объектом, возвращается hit=True, а props — словарь свойств, которые вы хотите добавить в атрибуты PickEvent.
- set_pickradius(pickradius)[source]
-
Установите радиус выбора, используемый для проверок на попадание.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора, в точках.
- set_rasterized(rasterized)[source]
-
Принудительное растрирование (отображение в виде растрового изображения) для векторной графики.
Растрирование не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.
Это настройка игнорируется для выходных данных на основе пикселей.
См. также Растрирование для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sizes(sizes, dpi=72.0)[source]
-
Установите размеры каждого члена коллекции.
- Параметры:
-
-
sizes
numpy.ndarrayили None -
Размер для установки для каждого элемента коллекции. Значение — «площадь» элемента.
- dpifloat, по умолчанию: 72
-
Разрешение холста.
-
sizes
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры эскиза.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии, в пикселях. Если scale равен
None, или не указан, фильтр эскиза не будет применён. - lengthfloat, необязательно
-
Длина колебания вдоль линии, в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Коэффициент масштабирования, на который длина уменьшается или увеличивается (по умолчанию 16.0)
Бэкенд PGF использует это аргумент как начальное значение генератора псевдослучайных чисел (RNG), а не как описано выше. Использование одного и того же начального значения даёт одинаковую случайную форму.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением в двух соседних позициях пикселей. В противоположность этому, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к ближайшему центру пикселя.
- False: Не изменять позиции вершин.
- None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование объекта.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для объекта.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок строк или None
Примечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок для объекта. Объекты с меньшими значениями zorder рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли объект «неактуальным» и требует перерисовки, чтобы вывод соответствовал внутреннему состоянию объекта.
- propertysticky_edges
-
xиyсписки прилипших краёв для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно ожидается отсутствие отступа на нижнем краю (0) гистограммы.
Кроме того, расширение отступа «натыкается» на прилипшие края и не может их пересекать. Например, если верхний предел данных равен 1,0, верхний предел просмотра, вычисленный простым добавлением отступа, равен 1,2, но есть прилипший край в 1,1, то фактический верхний предел просмотра будет 1,1.
Этот атрибут нельзя назначить; однако, списки
xиyможно изменять на месте по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает массив rgba, соответствующий x.
В обычном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий массив
ndarrayзначений rgba будет возвращён на основе установленной для этой ScalarMappable нормализации и цветовой карты.Существует один специальный случай для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x является
ndarrayс 3 измерениями, а последнее измерение равно 3 или 4, то оно будет обработано как rgb или rgba массив, и никаких преобразований не будет выполнено. Массив может быть uint8 или с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, параметр alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет существующее альфа-значение. Будет поднято исключение ValueError, если третье измерение не равно 3 или 4.В любом случае, если bytes равно False (по умолчанию), массив rgba будет числами с плавающей точкой в диапазоне 0-1; если оно равно True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.
Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).
- update(props)[source]
-
Обновляет свойства этого объекта из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копирует свойства из other в self.
- update_scalarmappable()[source]
-
Обновляет цвета из массива скалярной отображаемой карты, если таковой имеется.
Назначает цвета краям и граням на основе массива и/или напрямую заданных цветов, в зависимости от ситуации.
- zorder=0
- classmatplotlib.collections.StarPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[source]
-
Bases:
RegularPolyCollectionОтрисовка набора правильных звезд с numsides точками.
- Параметры:
-
- numsidesint
-
Количество сторон многоугольника.
- rotationfloat
-
Поворот многоугольника в радианах.
- sizestuple из float
-
Площадь окружности, описанной вокруг многоугольника, в точках^2.
- **kwargs
-
Передаётся в
Collection.
Примеры
См. Демонстрация Lasso для полного примера:
offsets = np.random.rand(20, 2) facecolors = [cm.jet(x) for x in np.random.rand(20)] collection = RegularPolyCollection( numsides=5, # a pentagon rotation=0, sizes=(50,), facecolors=facecolors, edgecolors=("black",), linewidths=(1,), offsets=offsets, offset_transform=ax.transData, )- add_callback(func)[source]
-
Добавление функции обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств
Artist.- Параметры:
-
- funccallable
-
Функция обратного вызова. Она должна иметь следующую сигнатуру:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Значения возвращаемых результатов могут существовать, но игнорируются.
- Возвращает:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью
remove_callbackпозже.
См. также
- autoscale()[source]
-
Автоматически масштабирует пределы значений на объекте norm используя текущий массив.
- autoscale_None()[source]
-
Автоматически масштабирует пределы значений на объекте norm используя текущий массив, изменяя только пределы, которые равны None.
- propertyaxes
-
Экземпляр
Axes, в котором находится объект, или None.
- changed()[source]
-
Вызовите этот метод, когда карта отображается для уведомления всех слушателей обратного вызова 'changed'.
- colorbar
-
Последняя связанная с этим ScalarMappable цветовая шкала. Может быть None.
- contains(mouseevent)[source]
-
Проверка, произошла ли обработка события мыши внутри коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- convert_xunits(x)[source]
-
Преобразовать x используя тип единиц измерения оси x.
Если объект не входит в Axes или ось x не имеет единиц измерения, возвращается x сам по себе.
- convert_yunits(y)[source]
-
Преобразовать y используя тип единиц измерения оси y.
Если объект не входит в Axes или ось y не имеет единиц измерения, возвращается y сам по себе.
- draw(renderer)[source]
-
Отрисовка объекта (и его потомков) с помощью указанного рендерера.
Это не повлияет на объект, если он не видим (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределяется в подклассах Artist.
- findobj(match=None, include_self=True)[source]
-
Поиск объектов художников.
Рекурсивно находит все экземпляры
Artist, содержащиеся в художнике.- Параметры:
-
- match
-
Критерий фильтра для совпадений. Может быть
- None: Вернуть все объекты, содержащиеся в художнике.
- Функция с сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только тех художников, для которых функция возвращает True. - Экземпляр класса: например,
Line2D. Результат будет содержать только художников этого класса или его подклассов (isinstanceпроверка).
- include_selfbool
-
Включить self в список для проверки соответствия.
- Возвращает:
-
- список
Artist
- список
- format_cursor_data(data)[source]
-
Возвращает строковое представление data.
Примечание
Этот метод предназначен для переопределения подклассами элементов изображения. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у элемента изображения нет связанной цветовой шкалы, в противном случае скалярные значения форматируются с помощью форматировщика цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра, используемую для фильтрации agg.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемое для смешения — не поддерживается во всех бэкендах.
- get_animated()[source]
-
Возвращает, анимирован ли элемент.
- get_array()[source]
-
Возвращает массив значений, которые сопоставлены с цветами.
Базовый класс
ScalarMappableне делает предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (мин, макс), которые сопоставлены с пределами цветовой карты.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает, использует ли элемент обрезку.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для данного события.
Примечание
Этот метод предназначен для переопределения подклассами элементов изображения. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.
Данные курсора могут использоваться элементами изображения для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация просто возвращает None.
Подклассы могут переопределять метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z
AxesImageв строке состояния окна графика при перемещении указателя мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому принадлежит элемент.
- get_fill()[source]
-
Возвращает значение, указывающее, закрашена ли фигура.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий шаблон штриховки.
- get_in_layout()[source]
-
Возвращает логическое значение,
Trueесли элемент включён в вычисления макета.Например, Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает значение, указывающее, запрашивается ли у этого элемента пользовательская контекстная информация при перемещении курсора мыши над ним.
- get_numsides()[source]
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый для смещения этого элемента.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает, растрируется ли элемент.
- get_rotation()[source]
- get_sizes()[source]
-
Возвращает размеры (площади) элементов в коллекции.
- Возвращает:
-
- массив
-
Площадь каждого элемента.
- get_sketch_params()[source]
-
Возвращает параметры наброска для элемента.
- Возвращает:
-
- кортеж или None
-
Кортеж из 3 элементов:
- scale: Амплитуда колебаний перпендикулярно исходной линии.
- length: Длина колебаний вдоль линии.
- randomness: Коэффициент масштабирования, с которым длина сжимается или расширяется.
Возвращает None, если параметры наброска не были установлены.
- get_snap()[source]
-
Возвращает настройку привязки.
Подробнее см.
set_snap.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любое обрезание.- Параметры:
-
-
renderer
RendererBaseподкласс -
объект, используемый для отрисовки графиков (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Охватывающая область (в пикселях координат фигуры).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает обрезку пути с применённой частью преобразования, не связанной с аффином, и оставшейся аффинной частью преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL, по одному на каждый элемент коллекции.
Список содержит None для элементов без URL. Пример см. в Ссылки.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получить область отображения элемента.
Ширина и высота области отображения неотрицательны.
Подклассы должны переопределять этот метод для включения в вычисление "плотной" области отображения. По умолчанию возвращается пустая область отображения в точке 0, 0.
Будьте внимательны при использовании этой функции, результаты не будут обновляться, если область отображения элемента изменится. Область отображения может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся некорректно.
- get_zorder()[source]
-
Возвращает порядок элемента по z.
- have_units()[source]
-
Возвращает, установлены ли единицы на какой-либо оси.
- is_transform_set()[source]
-
Возвращает, установлен ли преобразование элемента явно.
Это True после вызова
set_transform.
- свойствоmouseover
-
Возвращает, запрашивается ли у этого элемента информация о контексте при перемещении курсора мыши над ним.
- свойствоnorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается неявно при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обработка события выбора.
Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и для элемента установлен picker.
См. также
- pickable()[source]
-
Возвращает, является ли элемент выбираемым.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента.
- remove()[source]
-
Удаляет элемент с фигуры, если это возможно.
Эффект будет виден только после перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Вызовитеrelim, чтобы обновить пределы осей, если это необходимо.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи элемента в легенде.
- remove_callback(oid)[source]
-
Удаляет обратный вызов по его идентификатору наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установите несколько свойств сразу.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от левого нижнего угла изображения
массивоподобный объект или скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
массивоподобный объект или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Path, Transform) или None
Colormapили строка или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили dashes или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwчисло с плавающей точкой или список чисел с плавающей точкой
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массивоподобный объект
неизвестно
None или bool или число с плавающей точкой или вызываемая функция
неизвестно
bool
sizesnumpy.ndarrayили None(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
bool
число с плавающей точкой
-
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив float (m, n, глубина) и значение dpi, и возвращает массив (m, n, глубина) и два смещения от нижнего левого угла изображения
- set_alpha(alpha)[source]
-
Установить значение альфа для смешивания - не поддерживается на всех бэкендах.
- Параметры:
-
- alphaмассив или скаляр или None
-
Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, используется ли художник в анимации.
Если True, художник исключается из обычного рисования фигуры. Вам необходимо явно вызвать
Figure.draw_artist/Axes.draw_artistна художнике. Этот подход используется для ускорения анимаций с помощью блиттинга.См. также
matplotlib.animationи Более быстрое отображение с помощью блиттинга.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для рендеринга.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного объекта A.
- Параметры:
-
- Aмассив или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить стиль
CapStyleдля коллекции (для всех ее элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы масштабирования изображения для нормы.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.
- set_clip_box(clipbox)[source]
-
Установить обрезку художника
Bbox.- Параметры:
-
-
clipbox
Bbox -
Обычно создается из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)является стандартной обрезкой для художника, добавленного к оси.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использует ли художник обрезку.
Если False, художники будут видны за пределами оси, что может привести к неожиданным результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установить обрезку пути художника.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Путь обрезки. Если задан
Path, transform также должен быть указан. Если None, ранее заданный путь обрезки удаляется. -
transform
Transform, необязательно -
Используется только если path является
Path, в этом случае заданныйPathпреобразуется вTransformedPathс использованием transform.
-
path
Примечания
Для повышения эффективности, если path является
Rectangle, этот метод установит рамку обрезки соответствующему прямоугольнику и установит путь обрезки вNone.По техническим причинам (поддержка
set) также принимается кортеж (path, transform) в качестве единственного позиционного параметра.
- set_cmap(cmap)[source]
-
Установить цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили str или None
-
cmap
- set_color(c)[source]
-
Установить цвет границы и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для установки цвета границы или заливки по отдельности.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Установить цвет(цвета) границы коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(цвета) границы коллекции. Если последовательность, фигуры циклически проходят через нее. Если 'face', соответствует цвету заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет заливки(цветов) коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически проходить по последовательности.
Если c равно 'none', фигура не будет залита.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому принадлежит художник.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор (группы) для элемента.
- Параметры:
-
- gidstr
- 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)[source]
-
Указать, следует ли включать элемент в вычисления макета, например, Руководство по ограниченному макету,
Figure.tight_layout(), иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sобъект
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль(и) линии для набора.
linestyle
описание
'-'или'solid'сплошная линия
'--'или'dashed'пунктирная линия
'-.'или'dashdot'штрихпунктирная линия
':'или'dotted'точечная линия
В качестве альтернативы можно указать кортеж штрихов следующим образом:
(offset, onoffseq),
где
onoffseq— кортеж чётной длины, содержащий длины чернил (в точках).- Параметры:
-
- lsstr или кортеж или список
-
Допустимые значения для индивидуальных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность вкл.-выкл.)}. Смотрите
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить ширину(ы) линии(й) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, области будут циклически проходить по последовательности.
- Параметры:
-
- lwfloat или список float
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установить, запрашивается ли у этого объекта пользовательская информация о контексте при перемещении курсора мыши над ним.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установить экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если какие-либо цветовые шкалы используют отображение для этой нормализации, установка нормализации отображения сбросит нормализацию, локатор и форматирование на цветовой шкале до значений по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установить преобразование смещения для объекта.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установить смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный объект
- set_path_effects(path_effects)[source]
-
Установить эффекты траектории.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths(paths)[source]
- set_picker(picker)[source]
-
Определить поведение выбора объекта.
- Параметры:
-
- pickerNone или bool или float или вызываемый объект
-
Это может быть одно из следующих:
- None: Выбор отключён для этого объекта (по умолчанию).
- Булево значение: Если True, выбор будет включён, и объект будет генерировать событие выбора, если курсор мыши находится над ним.
- Число с плавающей точкой: Если picker является числом, оно интерпретируется как значение толерантности ε в пунктах, и объект будет генерировать событие, если его данные находятся в пределах ε от события мыши. Для некоторых объектов, таких как линии и коллекции участков, объект может предоставлять дополнительные данные к событию выбора, например, индексы данных, находящихся в пределах ε от события выбора.
-
Функция: Если picker является вызываемым объектом, это пользовательская функция, которая определяет, попадает ли объект под действие события мыши:
hit, props = picker(artist, mouseevent)
чтобы определить тест на попадание. Если курсор мыши над объектом, верните hit=True, и props является словарем свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установить радиус выбора, используемый для проверок попадания.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в пунктах.
- set_rasterized(rasterized)[source]
-
Принудительное растрирование (отображение в виде битовой карты) для вывода векторной графики.
Растрирование не поддерживается всеми объектами. Если вы попытаетесь включить это для объекта, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.
Это значение игнорируется для выходных данных на основе пикселей.
См. также Растрирование для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sizes(sizes, dpi=72.0)[source]
-
Установить размеры каждого элемента коллекции.
- Параметры:
-
-
sizes
numpy.ndarrayили None -
Размер, который нужно установить для каждого элемента коллекции. Значение — «площадь» элемента.
- dpifloat, по умолчанию: 72
-
Точность dpi холста.
-
sizes
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установите параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен
None, или не указан, фильтр наброска не будет предоставлен. - lengthfloat, необязательно
-
Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Коэффициент масштабирования, с которым длина уменьшается или увеличивается (по умолчанию 16.0)
Бэкенд PGF использует это аргумент как seed для генератора случайных чисел, а не как описано выше. Использование одного и того же seed даёт одинаковую случайную форму.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением на обеих смежных пиксельных позициях. В противоположность этому, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение действительно будет содержать черную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к центру ближайшего пикселя.
- False: Не изменять позиции вершин.
- None: (авто) Если траектория содержит только прямолинейные отрезки, округлить до центра ближайшего пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование объекта.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для объекта.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок str или None
Примечания
URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.
- set_visible(b)[source]
-
Установить видимость объекта.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок объекта. Объекты с меньшими значениями zorder рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли объект 'недействительным' и нуждается ли он в перерисовке, чтобы вывод соответствовал внутреннему состоянию объекта.
- propertysticky_edges
-
xиyсписки приклеенных границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, тогда не добавляется отступ - предел просмотра "прилипает" к краю. Типичный пример использования - гистограммы, где обычно не ожидается отступ на нижнем краю (0) гистограммы.
Кроме того, расширение отступа «упирается» в приклеенные края и не может их пересекать. Например, если верхний предел данных равен 1.0, верхний предел просмотра, вычисленный с помощью простого применения отступа, равен 1.2, но есть приклеенный край на 1.1, то фактический верхний предел просмотра будет 1.1.
К этому атрибуту нельзя присваивать значения; тем не менее, списки
xиyможно изменять на месте по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает нормализованный массив 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)[source]
-
Обновить свойства этого объекта от словаря props.
- Parameters:
-
- propsdict
- update_from(other)[source]
-
Копировать свойства из other в self.
- update_scalarmappable()[source]
-
Обновить цвета из массива скалярной отображающей функции, если таковой имеется.
Назначить цвета границам и сторонам на основе массива и/или непосредственно заданных цветов, при необходимости.
- zorder=0
- classmatplotlib.collections.TriMesh(triangulation, **kwargs)[source]
-
Bases:
CollectionКласс для эффективного рисования треугольной сетки с использованием затенения Гуро.
Треугольная сетка — это объект
Triangulation.- Параметры:
-
-
edgecolorsцвет или список цветов, по умолчанию:
rcParams["patch.edgecolor"](по умолчанию:'black') -
Цвет обводки для каждого фрагмента, составляющего коллекцию. Специальное значение 'face' может быть передано для того, чтобы цвет обводки совпадал с цветом заливки.
-
facecolorsцвет или список цветов, по умолчанию:
rcParams["patch.facecolor"](по умолчанию:'C0') -
Цвет заливки для каждого фрагмента, составляющего коллекцию.
-
linewidthsвещественное число или список вещественных чисел, по умолчанию:
rcParams["patch.linewidth"](по умолчанию:1.0) -
Ширина линии для каждого фрагмента, составляющего коллекцию.
- linestylesстрока или кортеж или список таковых, по умолчанию: 'solid'
-
Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид:
(offset, onoffseq),
где onoffseq — кортеж чётной длины, содержащий длины включения и выключения чернил в пунктах. Примеры см. в Стили штрихов.
-
capstyle
CapStyle-подобный, по умолчанию:rcParams["patch.capstyle"] -
Стиль обрезки линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.
-
joinstyle
JoinStyle-подобный, по умолчанию:rcParams["patch.joinstyle"] -
Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.
-
antialiasedsлогическое значение или список логических значений, по умолчанию:
rcParams["patch.antialiased"](по умолчанию:True) -
Определяет, следует ли отрисовывать каждый фрагмент в коллекции с антиалиасингом.
- offsets(вещественное число, вещественное число) или список таковых, по умолчанию: (0, 0)
-
Вектор, используемый для смещения каждого фрагмента после рендеринга (по умолчанию смещение отсутствует). Смещение выполняется в координатах экрана (пикселей) (то есть после применения преобразования Artist).
-
offset_transform
Transform, по умолчанию:IdentityTransform -
Преобразование, которое будет применено к каждому вектору offsets перед его использованием.
- cmap, norm
-
Параметры нормализации данных и сопоставления цветов. Подробное описание см. в
ScalarMappable. - hatchстрока, необязательно
-
Шаблон штриховки для залитых путей, если таковые имеются. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. Значения каждого типа штриховки см. в Справочник по стилям штриховки.
- pickradiusвещественное число, по умолчанию: 5.0
-
Если
pickradius <= 0, тогдаCollection.containsвернётTrueвсякий раз, когда точка тестирования находится внутри одного из полигонов, образованных контрольными точками пути в коллекции. С другой стороны, если значение больше 0, то вместо этого проверяется, содержится ли точка тестирования в штрихе шириной2*pickradiusпо любому из путей в коллекции. - urlsсписок строк, по умолчанию: None
-
URL для каждого фрагмента, к которому требуется создать ссылку после отрисовки. В настоящее время работает только с бэкэндом SVG. Примеры см. в Ссылки.
- zorderвещественное число, по умолчанию: 1
-
Порядок отрисовки, общий для всех фрагментов в коллекции. Все значения по умолчанию и примеры см. в Демонстрация zorder.
-
edgecolorsцвет или список цветов, по умолчанию:
- add_callback(func)[source]
-
Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется свойство одного из
Artist.- Параметры:
-
- funccallable
-
Функция обратного вызова. Она должна иметь следующий вид:
def func(artist: Artist) -> Any
где artist — вызываемый
Artist. Возвращаемые значения могут существовать, но игнорируются.
- Возвращает:
-
- int
-
Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью
remove_callbackпозднее.
См. также
- autoscale()[source]
-
Автоматическое масштабирование пределов скаляра в экземпляре нормы с использованием текущего массива
- autoscale_None()[source]
-
Автоматическое масштабирование пределов скаляра в экземпляре нормы с использованием текущего массива, изменяя только значения, равные None
- propertyaxes
-
Экземпляр
Axes, в котором находится объект, или None.
- changed()[source]
-
Вызывайте этот метод всякий раз, когда изменяется карта отображения, чтобы уведомить все слушателей сигнала 'changed'.
- colorbar
-
Последняя связанная с этим объектом карта цветов. Может быть None.
- contains(mouseevent)[source]
-
Проверяет, произошло ли событие мыши в коллекции.
Возвращает
bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.
- staticconvert_mesh_to_paths(tri)[source]
-
Преобразует заданную сетку в последовательность объектов
Path.Эта функция в основном полезна для разработчиков бэкэндов, которые не поддерживают сетки напрямую.
- convert_xunits(x)[source]
-
Преобразовать x, используя тип единиц измерения оси x.
Если объект-графический элемент не содержится в оси Axes или у оси x нет единиц измерения, возвращается значение x.
- convert_yunits(y)[source]
-
Преобразовать y, используя тип единиц измерения оси y.
Если объект-графический элемент не содержится в оси Axes или у оси y нет единиц измерения, возвращается значение y.
- draw(renderer)[source]
-
Отрисовка графического элемента (и его дочерних элементов) с помощью заданного рендерера.
Это не оказывает влияния, если графический элемент не виден (
Artist.get_visibleвозвращает False).- Параметры:
-
-
renderer
RendererBaseподкласс.
-
renderer
Примечания
Этот метод переопределяется в подклассах графических элементов.
- findobj(match=None, include_self=True)[source]
-
Поиск объектов графических элементов.
Рекурсивно находит все экземпляры
Artist, содержащиеся в данном графическом элементе.- Параметры:
-
- match
-
Критерий фильтрации совпадений. Может быть:
- None: Возвращает все объекты, содержащиеся в графическом элементе.
- Функция со сигнатурой
def match(artist: Artist) -> bool. Результат будет содержать только графические элементы, для которых функция возвращает True. - Экземпляр класса, например,
Line2D. Результат будет содержать только графические элементы этого класса или его подклассов (проверкаisinstance).
- include_selfbool
-
Включать self в список для проверки соответствия.
- Возвращает:
-
- Список
Artist
- Список
- format_cursor_data(data)[source]
-
Возвращает строковое представление data.
Примечание
Этот метод предназначен для переопределения подклассами графических элементов. Пользователю Matplotlib скорее всего не нужно вызывать этот метод напрямую.
По умолчанию, целые и вещественные числа, а также массивы целых и вещественных чисел преобразуются в строку, разделенную запятыми, заключённую в квадратные скобки, если графический элемент не имеет связанной цветовой шкалы. В противном случае скалярные значения форматируются с помощью форматера цветовой шкалы.
См. также
- get_agg_filter()[source]
-
Возвращает функцию фильтра, используемую для фильтрации agg.
- get_alpha()[source]
-
Возвращает значение альфа-канала, используемого для смешивания — не поддерживается во всех бэкендах.
- get_animated()[source]
-
Возвращает значение, указывающее, анимирован ли графический элемент.
- get_array()[source]
-
Возвращает массив значений, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива.
- get_capstyle()[source]
- get_clim()[source]
-
Возвращает значения (мин, макс), отображаемые в пределы цветовой карты.
- get_clip_box()[source]
-
Возвращает область обрезки.
- get_clip_on()[source]
-
Возвращает значение, указывающее, используется ли обрезка для графического элемента.
- get_clip_path()[source]
-
Возвращает путь обрезки.
- get_cmap()[source]
-
Возвращает экземпляр
Colormap.
- get_cursor_data(event)[source]
-
Возвращает данные курсора для данного события.
Примечание
Этот метод предназначен для переопределения подклассами элементов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.
Данные курсора могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.
Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны гарантировать, что
format_cursor_dataможет преобразовать данные в строковое представление.Единственный текущий случай использования — отображение значения z изображения
AxesImageв строке состояния окна графика при перемещении мыши.- Параметры:
-
-
event
MouseEvent
-
event
См. также
- get_dashes()[source]
-
Псевдоним для
get_linestyle.
- get_datalim(transData)[source]
- get_ec()[source]
-
Псевдоним для
get_edgecolor.
- get_edgecolor()[source]
- get_edgecolors()[source]
-
Псевдоним для
get_edgecolor.
- get_facecolor()[source]
- get_facecolors()[source]
-
Псевдоним для
get_facecolor.
- get_fc()[source]
-
Псевдоним для
get_facecolor.
- get_figure()[source]
-
Возвращает экземпляр
Figure, к которому относится элемент.
- get_fill()[source]
-
Возвращает, закрашена ли область.
- get_gid()[source]
-
Возвращает идентификатор группы.
- get_hatch()[source]
-
Возвращает текущий шаблон штриховки.
- get_in_layout()[source]
-
Возвращает логическое значение,
Trueесли элемент включён в вычисления макета.Например, Руководство по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').
- get_joinstyle()[source]
- get_label()[source]
-
Возвращает метку, используемую для этого элемента в легенде.
- get_linestyle()[source]
- get_linestyles()[source]
-
Псевдоним для
get_linestyle.
- get_linewidth()[source]
- get_linewidths()[source]
-
Псевдоним для
get_linewidth.
- get_ls()[source]
-
Псевдоним для
get_linestyle.
- get_lw()[source]
-
Псевдоним для
get_linewidth.
- get_mouseover()[source]
-
Возвращает, запрашивается ли у этого элемента информация о пользовательском контексте, когда курсор мыши находится над ним.
- get_offset_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим смещенным элементом.
- get_offsets()[source]
-
Возвращает смещения для коллекции.
- get_path_effects()[source]
- get_paths()[source]
- get_picker()[source]
-
Возвращает поведение выбора элемента.
Возможные значения описаны в
set_picker.См. также
- get_pickradius()[source]
- get_rasterized()[source]
-
Возвращает, должен ли элемент быть растрирован.
- get_sketch_params()[source]
-
Возвращает параметры наброска для элемента.
- Возвращает:
-
- tuple или None
-
Кортеж из 3 элементов:
- scale: Амплитуда колебаний перпендикулярно исходной линии.
- length: Длина колебаний вдоль линии.
- randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.
Возвращает None, если параметры наброска не были установлены.
- get_snap()[source]
-
Возвращает установку привязки.
Подробности см. в
set_snap.
- get_tightbbox(renderer=None)[source]
-
Аналогично
Artist.get_window_extent, но включает любое обрезание.- Параметры:
-
-
renderer
RendererBaseподкласс -
рендерер, который будет использоваться для отрисовки рисунков (т.е.
fig.canvas.get_renderer())
-
renderer
- Возвращает:
-
Bbox-
Включающий прямоугольник (в пикселях координат рисунка).
- get_transOffset()[source]
-
Псевдоним для
get_offset_transform.
- get_transform()[source]
-
Возвращает экземпляр
Transform, используемый этим элементом.
- get_transformed_clip_path_and_affine()[source]
-
Возвращает путь обрезки с примененной неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.
- get_transforms()[source]
- get_url()[source]
-
Возвращает URL.
- get_urls()[source]
-
Возвращает список URL-адресов, по одному для каждого элемента коллекции.
Список содержит None для элементов без URL-адреса. См. Гиперссылки для примера.
- get_visible()[source]
-
Возвращает видимость.
- get_window_extent(renderer=None)[source]
-
Получить область отрисовки элемента в пространстве экрана.
Ширина и высота области отрисовки неотрицательны.
Подклассы должны переопределять для включения в вычисление "плотной" области отрисовки. По умолчанию возвращает пустую область отрисовки в координатах 0, 0.
Будьте внимательны при использовании этой функции, результаты не обновятся, если область отрисовки элемента изменится. Область отрисовки может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.
- get_zorder()[source]
-
Возвращает z-порядок элемента.
- have_units()[source]
-
Возвращает, установлены ли единицы измерения на любой оси.
- is_transform_set()[source]
-
Возвращает, имеет ли элемент явно заданное преобразование.
Это True после вызова
set_transform.
- propertymouseover
-
Возвращает, запрашивается ли у этого элемента пользовательская информация о контексте, когда курсор мыши перемещается по нему.
- propertynorm
- pchanged()[source]
-
Вызывает все зарегистрированные обратные вызовы.
Эта функция вызывается внутри при изменении свойства.
См. также
- pick(mouseevent)[source]
-
Обработка события выбора.
Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом и у элемента установлен параметр picker.
См. также
- pickable()[source]
-
Возвращает, можно ли выбрать элемент.
См. также
- properties()[source]
-
Возвращает словарь всех свойств элемента.
- remove()[source]
-
Удаляет элемент из фигуры, если это возможно.
Эффект будет виден только после перерисовки фигуры, например, с помощью
FigureCanvasBase.draw_idle. Вызовитеrelimдля обновления пределов осей, если нужно.Примечание:
relimне увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.Примечание: нет поддержки удаления записи элемента в легенде.
- remove_callback(oid)[source]
-
Удаляет обратный вызов по его идентификатору наблюдателя.
См. также
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
-
Установить сразу несколько свойств.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
подобный массиву, скаляр или None
bool
antialiasedили aa или antialiasedsbool или список bool
подобный массиву или None
CapStyleили {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
bool
Объект Patch или (Path, Transform) или None
Colormapили строка или Noneцвет или список кортежей RGBA
edgecolorили ec или edgecolorsцвет или список цветов или 'face'
facecolorили facecolors или fcцвет или список цветов
строка
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyleили {'miter', 'round', 'bevel'}объект
linestyleили штрихи или linestyles или lsстрока или кортеж или список
linewidthили linewidths или lwвещественное число или список вещественных чисел
bool
Normalizeили строка или Noneoffset_transformили transOffsetнеизвестно
(N, 2) или (2,) массив-подобный объект
None или bool или float или вызываемая функция
неизвестно
bool
(scale: float, length: float, randomness: float)
bool или None
строка
список строк или None
bool
вещественное число
- set_aa(aa)[source]
-
Псевдоним для
set_antialiased.
-
- set_agg_filter(filter_func)[source]
-
Установить фильтр agg.
- Параметры:
-
- filter_funccallable
-
Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения
- set_alpha(alpha)[source]
-
Установить значение альфа-канала, используемое для смешивания - не поддерживается во всех бэкэндах.
- Параметры:
-
- alphaмассив-подобный объект, скаляр или None
-
Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.
- set_animated(b)[source]
-
Установить, предназначен ли элемент для использования в анимации.
Если True, элемент исключается из обычного рисования фигуры. Вам нужно явно вызвать
Figure.draw_artist/Axes.draw_artistна элементе. Этот подход используется для ускорения анимаций с помощью blitting.См. также
matplotlib.animationи Более быстрое отображение с использованием blitting.- Параметры:
-
- bbool
- set_antialiased(aa)[source]
-
Установить состояние антиалиасинга для рендеринга.
- Параметры:
-
- aabool или список bool
- set_antialiaseds(aa)[source]
-
Псевдоним для
set_antialiased.
- set_array(A)[source]
-
Установить массив значений из массивоподобного объекта A.
- Параметры:
-
- Aмассив-подобный объект или None
-
Значения, которые отображаются в цвета.
Базовый класс
ScalarMappableне делает никаких предположений о размерности и форме массива значений A.
- set_capstyle(cs)[source]
-
Установить
CapStyleдля коллекции (для всех её элементов).- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clim(vmin=None, vmax=None)[source]
-
Установить пределы нормы для масштабирования изображения.
- Параметры:
-
- vmin, vmaxfloat
-
Пределы.
Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.
- set_clip_box(clipbox)[source]
-
Установить область обрезки элемента.
- Параметры:
-
-
clipbox
Bbox -
Как правило, создается из
TransformedBbox. Например,TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)является значением по умолчанию для обрезки элемента, добавленного к оси.
-
clipbox
- set_clip_on(b)[source]
-
Установить, использовать ли обрезку элемента.
При значении False элементы будут отображаться за пределами области Axes, что может привести к непредсказуемым результатам.
- Параметры:
-
- bbool
- set_clip_path(path, transform=None)[source]
-
Установить область обрезки для элемента.
- Параметры:
-
-
path
PatchилиPathилиTransformedPathили None -
Область обрезки. Если задан объект
Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена. -
transform
Transform, необязательно -
Используется только если path является объектом
Path. В этом случае данный объектPathпреобразуется вTransformedPathс использованием transform.
-
path
Примечания
Для повышения эффективности, если path является объектом
Rectangle, этот метод установит ограничивающую прямоугольную область и задаст область обрезки вNone.По техническим причинам (поддержка метода
set) также принимается кортеж (path, transform) в качестве единственного позиционного параметра.
- set_cmap(cmap)[source]
-
Установить цветовую карту для данных яркости.
- Параметры:
-
-
cmap
Colormapили строка или None
-
cmap
- set_color(c)[source]
-
Установить цвет обводки и заливки.
- Параметры:
-
- cцвет или список кортежей RGBA
См. также
-
Collection.set_facecolor,Collection.set_edgecolor -
Для отдельной установки цвета обводки или заливки.
- set_dashes(ls)[source]
-
Псевдоним для
set_linestyle.
- set_ec(c)[source]
-
Псевдоним для
set_edgecolor.
- set_edgecolor(c)[source]
-
Устанавливает цвет(цвета) обводки коллекции.
- Параметры:
-
- cцвет или список цветов или 'face'
-
Цвет(цвета) обводки коллекции. Если последовательность, то фигуры циклически используют значения из нее. Если 'face', то совпадает с цветом заливки.
- set_edgecolors(c)[source]
-
Псевдоним для
set_edgecolor.
- set_facecolor(c)[source]
-
Установить цвет заливки для коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, то фигуры будут циклически использовать цвета из неё. Если c равно 'none', фигура не будет закрашиваться.
- Параметры:
-
- cцвет или список цветов
- set_facecolors(c)[source]
-
Псевдоним для
set_facecolor.
- set_fc(c)[source]
-
Псевдоним для
set_facecolor.
- set_figure(fig)[source]
-
Установить экземпляр
Figure, к которому принадлежит элемент.- Параметры:
-
-
fig
Figure
-
fig
- set_gid(gid)[source]
-
Установить идентификатор группы для объекта.
- Параметры:
-
- gidstr
- 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)[source]
-
Установить, нужно ли включать объект в вычисления макета, например, в Руководстве по ограниченному макету,
Figure.tight_layout()иfig.savefig(fname, bbox_inches='tight').- Параметры:
-
- in_layoutbool
- set_joinstyle(js)[source]
-
Установить
JoinStyleдля набора (для всех его элементов).- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_label(s)[source]
-
Установить метку, которая будет отображаться в легенде.
- Параметры:
-
- sobject
-
s будет преобразован в строку с помощью вызова
str.
- set_linestyle(ls)[source]
-
Установить стиль(и) линии для набора.
стиль линии
описание
'-'или'solid'сплошная линия
'--'или'dashed'пунктирная линия
'-.'или'dashdot'штрих-пунктирная линия
':'или'dotted'пунктирная линия
В качестве альтернативы можно указать кортеж с длинами отступов и чернил в формате:
(offset, onoffseq),
где
onoffseq— кортеж четной длины, содержащий длины включений и выключений чернил в пунктах.- Параметры:
-
- lsstr или кортеж или список кортежей
-
Допустимые значения для индивидуальных стилей линии включают {'-', '--', '-.', ':', '', (offset, on-off-seq)}. См.
Line2D.set_linestyleдля полного описания.
- set_linestyles(ls)[source]
-
Псевдоним для
set_linestyle.
- set_linewidth(lw)[source]
-
Установить толщину(ы) линии(й) для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности.
- Параметры:
-
- lwfloat или список float
- set_linewidths(lw)[source]
-
Псевдоним для
set_linewidth.
- set_ls(ls)[source]
-
Псевдоним для
set_linestyle.
- set_lw(lw)[source]
-
Псевдоним для
set_linewidth.
- set_mouseover(mouseover)[source]
-
Установите, запрашивается ли у этого элемента пользовательская информация о контексте, когда курсор мыши перемещается над ним.
- Параметры:
-
- mouseoverbool
- set_norm(norm)[source]
-
Установите экземпляр нормализации.
- Параметры:
-
-
norm
Normalizeили str или None
-
norm
Примечания
Если какие-либо цветовые шкалы используют отображение для этой нормализации, установка нормализации отображения сбросит нормализацию, локали и форматирование на цветовой шкале по умолчанию.
- set_offset_transform(offset_transform)[source]
-
Установить преобразование смещения элемента.
- Параметры:
-
-
offset_transform
Transform
-
offset_transform
- set_offsets(offsets)[source]
-
Установить смещения для коллекции.
- Параметры:
-
- offsets(N, 2) или (2,) массив-подобный
- set_path_effects(path_effects)[source]
-
Установить эффекты траектории.
- Параметры:
-
-
path_effects
AbstractPathEffect
-
path_effects
- set_paths()[source]
- set_picker(picker)[source]
-
Определите поведение выбора элемента.
- Параметры:
-
- pickerNone или bool или float или вызываемый объект
-
Это может быть одно из следующего:
- None: Выбор отключён для этого элемента (по умолчанию).
- Булево значение: Если True, выбор будет включён, и элемент будет генерировать событие выбора, если курсор мыши находится над ним.
- Число с плавающей точкой: Если picker — число, оно интерпретируется как значение допуска в пунктах, и элемент будет генерировать событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции блоков, элемент может предоставить дополнительные данные для события выбора, например, индексы данных в пределах допуска от события выбора
-
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, определяющая, попадает ли элемент под событие мыши:
hit, props = picker(artist, mouseevent)
для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.
- set_pickradius(pickradius)[source]
-
Установить радиус выбора, используемый для проверки попадания.
- Параметры:
-
- pickradiusfloat
-
Радиус выбора в пунктах.
- set_rasterized(rasterized)[source]
-
Вынужденное растровое (битовое) отображение для векторной графики.
Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не окажет влияния, и будет выведено предупреждение.
Это значение игнорируется для выходных данных на основе пикселей.
См. также Растровое отображение для векторной графики.
- Параметры:
-
- rasterizedbool
- set_sketch_params(scale=None, length=None, randomness=None)[source]
-
Установить параметры наброска.
- Параметры:
-
- scalefloat, необязательно
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale —
None, или не указано, никакой фильтр наброска не будет предоставлен. - lengthfloat, необязательно
-
Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)
- randomnessfloat, необязательно
-
Коэффициент масштабирования, с помощью которого длина уменьшается или увеличивается (по умолчанию 16.0)
Пакет PGF использует это аргумент в качестве семени для генератора случайных чисел, а не так, как описано выше. Использование одного и того же семени приводит к одному и тому же случайному наброску.
- set_snap(snap)[source]
-
Установить поведение привязки.
Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, которое будет серым значением на двух смежных пиксельных позициях. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.
Привязка в настоящее время поддерживается только задними планами Agg и MacOSX.
- Параметры:
-
- snapbool или None
-
Возможные значения:
- True: Привязать вершины к центру ближайшего пикселя.
- False: Не изменять позиции вершин.
- None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
- set_transOffset(offset_transform)[source]
-
Псевдоним для
set_offset_transform.
- set_transform(t)[source]
-
Установить преобразование художника.
- Параметры:
-
-
t
Transform
-
t
- set_url(url)[source]
-
Установить URL для художника.
- Параметры:
-
- urlstr
- set_urls(urls)[source]
-
- Параметры:
-
- urlsсписок строк или None
Примечания
URL в настоящее время реализованы только задним планом SVG. Они игнорируются всеми другими задними планами.
- set_visible(b)[source]
-
Установить видимость художника.
- Параметры:
-
- bbool
- set_zorder(level)[source]
-
Установить z-порядок для художника. Художники с более низкими значениями z-порядка рисуются первыми.
- Параметры:
-
- levelfloat
- propertystale
-
Является ли художник «недействительным» и требует перерисовки, чтобы вывод соответствовал внутреннему состоянию художника.
- propertysticky_edges
-
xиyсписки прилипающих границ для автоматического масштабирования.При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, тогда не добавляется отступ — предел представления «прилипает» к краю. Типичный пример использования — гистограммы, где обычно не ожидается отступ на нижнем краю (0) гистограммы.
Кроме того, расширение отступа «упирается» в прилипающие края и не может их пересечь. Например, если верхний предел данных составляет 1,0, верхний предел представления, вычисленный путём простого добавления отступа, равен 1,2, но есть прилипающий край в 1,1, то фактический верхний предел представления будет равен 1,1.
К этому атрибуту нельзя присваивать; однако списки
xиyмогут быть изменены на месте по мере необходимости.Примеры
>>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax)
- to_rgba(x, alpha=None, bytes=False, norm=True)[source]
-
Возвращает массив 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)[source]
-
Обновить свойства этого художника из словаря props.
- Параметры:
-
- propsdict
- update_from(other)[source]
-
Копировать свойства из other в self.
- update_scalarmappable()[source]
-
Обновить цвета из массива сопоставления скаляров, если таковой имеется.
Присвоить цвета к граням и поверхностям на основе массива и/или цветов, которые были непосредственно заданы, в зависимости от ситуации.
- zorder=0
© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.7.5/api/collections_api.html