matplotlib.collections

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

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

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

END_OF_DOCUMENT_MARKER

Bases: matplotlib.collections.RegularPolyCollection

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

Параметры

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

Примеры

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

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

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

add_callback(func)[source]

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

Параметры

funccallable

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

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позднее.

См. также

remove_callback

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

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

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

свойствоcallbacksSM[source]

changed()[source]: Вызовите это, когда карта значений изменится, чтобы уведомить всех слушателей callbackSM о сигнале '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).

Параметры

rendererRendererBase подкласс.

Примечания

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

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_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с agg-фильтром.

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

get_animated()[source]: Возвращает, анимирован ли элемент.

get_array()[source]

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

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

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

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

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

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

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

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

get_cursor_data(event)[source]

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

Примечание

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

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

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

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

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

Параметры

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

Возвращает

Bbox: Охватывающая область (в пикселях координат фигуры).

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

Получает область элемента на экране.

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

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

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

get_zorder()[source]: Возвращает порядок отрисовки объекта.

have_units()[source]: Возвращает, установлены ли единицы измерения на какой-либо оси.

is_transform_set()[source]

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

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

свойствоmouseover

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

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

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

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<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]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi и возвращает массив (m, n, 3)
`alpha`	подобный массиву или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	подобный массиву или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей rgba
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список таких кортежей
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) подобный массиву
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

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 для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или str или None

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, к которому принадлежит элемент.

Параметры

figFigure

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 для всего набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

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

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

Параметры

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

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

Параметры

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

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: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

END_OF_DOCUMENT_MARKER

set_transform(t)[source]

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

Параметры

tTransform

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 — это одномерный или двумерный набор скалярных величин, и будет возвращён соответствующий массив значений rgba, на основе установленных нормализации и цветовой карты для этого ScalarMappable.

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

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

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

update(props)[source]

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

Параметры

propsdict

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

update_scalarmappable()[source]

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

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

zorder=0

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

Bases: matplotlib.collections.PolyCollection

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

Параметры

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

add_callback(func)[source]

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

Параметры

funcвызываемая функция

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

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

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

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

propertycallbacksSM[source]

changed()[source]: Вызовите этот метод всякий раз, когда изменяется mappable, чтобы уведомить все слушатели callbackSM о сигнале '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).

Параметры

rendererRendererBase подкласс.

Примечания

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

findobj(match=None, include_self=True)[source]

Найти элементы художника.

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

Параметры

match

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

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

include_selfbool

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

Возвращает

список Artist

END_OF_DOCUMENT_MARKER

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

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

get_animated()[source]: Возвращает значение, указывающее, анимирован ли элемент.

get_array()[source]

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

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

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

get_clim()[source]: Возвращает значения (минимальное, максимальное), которые сопоставляются с пределами цветовой карты.

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

get_clip_on()[source]: Возвращает значение, указывающее, используется ли обрезка элемента.

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

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

get_cursor_data(event)[source]

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

Примечание

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

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

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого объекта.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, должен ли элемент быть растрирован.

get_sizes()[source]

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

Возвращает

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

get_sketch_params()[source]

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

Возвращает

кортеж или None

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

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

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

get_snap()[source]

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

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

get_tightbbox(renderer)[source]

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

Параметры

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

Возвращает

Bbox: Охватывающая область (в пикселях координат фигуры).

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

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

Ширина и высота области имеют неотрицательные значения.

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

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

get_zorder()[source]: Возвращает z-порядок элемента.

have_units()[source]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[source]

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

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

propertymouseover

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

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

propertynorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств элемента.

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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>, 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]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массивоподобный объект или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (объект Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список кортежей
`linewidth` или linewidths или lw	вещественное число или список вещественных чисел
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массив (N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`paths`	список массивоподобных объектов
`picker`	None или bool или float или вызываемый объект
`pickradius`	вещественное число
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`verts`	список массивоподобных объектов
`verts_and_codes`	неизвестно
`visible`	bool
`zorder`	вещественное число

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

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 для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или строка или None

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, к которому принадлежит элемент.

Параметры

figFigure

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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

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

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

Параметры

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

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

Параметры

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

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 пиксель.

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

Параметры

snapbool или None

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

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

set_transform(t)[source]

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

Параметры

tTransform

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-порядок для объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры

levelfloat

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

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

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

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)

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. Если это массив masked, маска будет проигнорирована. Если последнее измерение равно 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.

Параметры

propsdict

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

update_scalarmappable()[source]

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

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

zorder=0

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

Bases: matplotlib.collections._CollectionWithSizes

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

Параметры

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

add_callback(func)[source]

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

Параметры

funcвызываемый объект

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

def func(artist: Artist) -> Any

где artist — вызываемый объект Artist. Значения возвращаемых результатов могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может использоваться для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

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

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

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

propertycallbacksSM[source]

changed()[source]: Вызов при изменении отображаемой области, чтобы уведомить всех слушателей сигналов 'changed' в callbacksSM.

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.

Примечания

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

findobj(match=None, include_self=True)[source]

Найти объекты artist.

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

Параметры

match

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

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

include_selfbool

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

Возвращает

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтрации для использования с agg фильтром.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешивания цветов - не поддерживается на всех бэкендах.

get_animated()[source]: Возвращает значение, указывающее, анимирован ли элемент.

get_array()[source]

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

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[source]

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

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.

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый этим элементом для смещения.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает значение, указывающее, должен ли элемент быть растровым.

get_sizes()[source]

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

Возвращает

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

get_sketch_params()[source]

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

Возвращает

кортеж или None

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

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

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

get_snap()[source]

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

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

get_tightbbox(renderer)[source]

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

Параметры

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

Возвращает

Bbox: Охватывающая область (в пикселях координат фигуры).

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

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

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

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

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

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

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

is_transform_set()[source]

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

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

свойствоmouseover

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

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств графического объекта.

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<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]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, а возвращает массив (m, n, 3)
`alpha`	массивоподобный объект, скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей rgba
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

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 для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или str или None

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, к которому принадлежит объект.

Параметры

figFigure

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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

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

Параметры

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

set_linestyle(ls)[source]

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

стиль линии	описание
`'-'` или `'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_norm(norm)[source]

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

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

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

Параметры

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

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

Параметры

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

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

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

Параметры

tTransform

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 — это 1D или 2D последовательность скаляров, и соответствующий массив значений rgba будет возвращен на основе установленных для данного ScalarMappable нормализации и цветовой карты.

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

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

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

update(props)[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, transOffset=None, norm=None, cmap=None, pickradius=5.0, hatch=None, urls=None, *, zorder=1, **kwargs)[source]

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

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

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

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

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

prop[i % len(prop)]

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

Параметры

edgecolorsцвет или список цветов, по умолчанию: rcParams["patch.edgecolor"] (по умолчанию: 'black')

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

facecolorsцвет или список цветов, по умолчанию: rcParams["patch.facecolor"] (по умолчанию: 'C0')

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

linewidthsвещественное число или список вещественных чисел, по умолчанию: rcParams["patch.linewidth"] (по умолчанию: 1.0)

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

linestylesстрока или кортеж или список таковых, по умолчанию: 'solid'

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

(offset, onoffseq),

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

capstyleCapStyle-подобное, по умолчанию: rcParams["patch.capstyle"]

Стиль окончания линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.

joinstyleJoinStyle-подобное, по умолчанию: rcParams["patch.joinstyle"]

Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.

antialiasedsлогическое значение или список логических значений, по умолчанию: rcParams["patch.antialiased"] (по умолчанию: True)

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

offsets(вещественное число, вещественное число) или список таковых, по умолчанию: (0, 0)

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

transOffsetTransform, по умолчанию: IdentityTransform

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

normNormalize, необязательно

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

cmapColormap, необязательно

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

hatchстрока, необязательно

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

pickradiusвещественное число, по умолчанию: 5.0

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

urlsсписок строк, по умолчанию: None

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

zorderвещественное число, по умолчанию: 1

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

add_callback(func)[source]

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

Параметры

funccallable

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

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позднее.

См. также

remove_callback

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

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

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

propertycallbacksSM[source]

changed()[source]: Вызывайте эту функцию всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей callbackSM о сигнале '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).

Параметры

rendererRendererBase подкласс.

Примечания

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

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_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

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

get_animated()[source]: Возвращает, анимирован ли элемент.

get_array()[source]

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

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[source]

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

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, вы, скорее всего, не будете вызывать этот метод самостоятельно.

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

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

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

Параметры

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

Возвращает

Bbox: Охватывающая рамка (в пикселях координат фигуры).

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

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

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

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

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

have_units()[source]: Возвращает, установлены ли единицы измерения на какой-либо оси.

is_transform_set()[source]

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

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

propertymouseover

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

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

propertynorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

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

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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>, 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]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	подобный массиву, скалярное значение или None
`animated`	bool
`antialiased`	bool или список bool
`array`	подобный массиву или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей rgba
`edgecolor`	цвет или список цветов или 'face'
`facecolor`	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle`	строка или кортеж или список таковых
`linewidth`	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массив-подобный объект
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sketch_params`	(scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

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 или список булевых значений

set_antialiaseds(aa)[source]: Псевдоним для set_antialiased.

set_array(A)[source]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассив-подобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[source]

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

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или str или None

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, к которому относится элемент.

Параметры

figFigure

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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

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

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

Параметры

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

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

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

Параметры

tTransform

set_url(url)[source]

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

Параметры

urlstr

set_urls(urls)[source]

Параметры

urlsсписок строк или None

Примечания

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

set_visible(b)[source]

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

Параметры

bbool

set_zorder(level)[source]

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

Параметры

levelfloat

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

propertysticky_edges

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

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

Кроме того, расширение отступа «натыкается» на приклеенные края и не может их пересекать. Например, если верхний предел данных равен 1,0, а верхний предел отображения, вычисленный с помощью простого добавления отступа, равен 1,2, но есть приклеенный край в 1,1, то фактический верхний предел отображения будет равен 1,1.

Примеры

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

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

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

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

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

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

update(props)[source]

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

Параметры

propsdict

update_from(other)[source]: Копировать свойства из other в self.

update_scalarmappable()[source]

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

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

zorder=0

classmatplotlib.collections.EllipseCollection(widths, heights, angles, units='points', **kwargs)[source]

Bases: matplotlib.collections.Collection

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

Параметры

widthsarray-like: Длина первой оси (например, длина большой оси).
heightsarray-like: Длина второй оси.
anglesarray-like: Углы первой оси, градусы против часовой стрелки от оси x.
units{'points', 'inches', 'dots', 'width', 'height', 'x', 'y', 'xy'}: Единицы измерения длин большой и малой осей; 'width' и 'height' относятся к размерам осей, а 'x' и 'y' — к данным единицам измерения смещения. 'xy' отличается от всех остальных тем, что угол, отображаемый на графике, меняется в зависимости от соотношения сторон, и равен указанному углу только в случае единичного соотношения сторон. Таким образом, он ведет себя так же, как Ellipse с axes.transData в качестве своего преобразования.
**kwargs: Передаётся в Collection.

add_callback(func)[source]

Параметры

funccallable

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

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

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

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

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

propertycallbacksSM[source]

changed()[source]: Вызывайте этот метод всякий раз, когда изменяется отображаемое значение, чтобы оповестить всех слушателей callbackSM о сигнале '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 (и его дочерние элементы) с помощью заданного рендерера.

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

Параметры

rendererRendererBase подкласс.

Примечания

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

findobj(match=None, include_self=True)[source]

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

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

Параметры

match

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

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

include_selfbool

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

Возвращает

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с agg-фильтром.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешения. Не поддерживается на всех бэкендах.

get_animated()[source]: Возвращает значение, указывающее, анимирован ли элемент.

get_array()[source]

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

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

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

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

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

get_clip_on()[source]: Возвращает значение, указывающее, использует ли художник обрезку.

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

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

get_cursor_data(event)[source]

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

Примечание

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

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения данного элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, растрируется ли элемент.

get_sketch_params()[source]

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

Возвращает

кортеж или None

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

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

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

get_snap()[source]

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

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

get_tightbbox(renderer)[source]

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

Параметры

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

Возвращает

Bbox: Охватывающая область (в пикселях координат фигуры).

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

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

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

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

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

get_zorder()[source]: Возвращает z-порядок элемента.

have_units()[source]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[source]

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

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

свойствоmouseover

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

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств элемента.

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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>, 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]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	Функция фильтра, которая принимает массив (m, n, 3) с плавающей запятой и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массив-подобный объект или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массив-подобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массив (N, 2) или (2,) массивоподобный
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

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 для коллекции (для всех ее элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или строка или None

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, к которому принадлежит объект.

Параметры

figFigure

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_layoutлогическое

set_joinstyle(js)[source]

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

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

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

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

Параметры

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

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

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

Параметры

tTransform

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 является одномерным или двумерным последовательностью скаляров, и возвращается соответствующий массив значений rgba, основанный на установленной для этой ScalarMappable нормализации и цветовой карте.

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

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

update(props)[source]

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

Параметры

propsсловарь

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]

Базы: matplotlib.collections.LineCollection

Коллекция положений вдоль одной оси, в которых произошло «событие».

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

Параметры

positionsОдномерный массив-подобный объект

Каждое значение — это событие.

orientation{'horizontal', 'vertical'}, по умолчанию: 'horizontal'

Последовательность событий отображается в этом направлении. Линии маркеров отдельных событий направлены в перпендикулярном направлении.

lineoffsetfloat, по умолчанию: 0

Смещение центра маркеров от начала координат в направлении, перпендикулярном orientation.

linelengthfloat, по умолчанию: 1

Общая высота маркера (т.е. маркер простирается от lineoffset - linelength/2 до lineoffset + linelength/2).

linewidthfloat или список float, по умолчанию: rcParams["lines.linewidth"] (по умолчанию: 1.5)

Толщина линий событий в пунктах.

colorцвет или список цветов, по умолчанию: rcParams["lines.color"] (по умолчанию: 'C0')

Цвет линий событий.

linestyleстрока или кортеж или список кортежей, по умолчанию: 'solid'

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

(offset, onoffseq),

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

antialiasedbool или список bool, по умолчанию: rcParams["lines.antialiased"] (по умолчанию: True)

Использовать ли сглаживание для рисования линий.

**kwargs

Передаются методу LineCollection.

Примеры

(Исходный код, png, pdf)

add_callback(func)[source]

Параметры

funcвызываемый объект

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

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

add_positions(position)[source]: Добавляет одно или несколько событий в указанных позициях.

append_positions(position)[source]: Добавляет одно или несколько событий в указанных позициях.

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

autoscale_None()[source]: Автоматически масштабирует пределы скаляров в экземпляре нормы с помощью текущего массива, изменяя только отсутствующие пределы.

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

propertycallbacksSM[source]

changed()[source]: Вызовите этот метод всякий раз, когда изменяется отображаемый объект, чтобы оповестить все слушатели обратных вызовов callbacksSM о сигнале «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).

Параметры

rendererRendererBase подкласс.

Примечания

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

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_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешения цветов - не поддерживается на всех бэкендах.

get_animated()[source]: Возвращает, анимирован ли художник.

get_array()[source]

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

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

get_children()[source]: Возвращает список дочерних художников Artist этого художника Artist.

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 в строке состояния окна графика при перемещении указателя мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый этим художником для смещения.

get_offsets()[source]: Возвращает смещения для коллекции.

get_orientation()[source]: Возвращает ориентацию линии события ('горизонтальная' или 'вертикальная').

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

get_positions()[source]: Возвращает массив, содержащий значения позиций с плавающей запятой.

get_rasterized()[source]: Возвращает, следует ли растрировать элемент.

get_segments()[source]

Возвращает

список: Список сегментов в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()[source]

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

Возвращает

кортеж или None

Кортеж длиной 3 с последующими элементами:

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

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

get_snap()[source]

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

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

get_tightbbox(renderer)[source]

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

Параметры

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

Возвращает

Bbox: Охватывающая область (в пикселях координат рисунка).

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

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

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

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

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

get_zorder()[source]: Возвращает z-порядок элемента.

have_units()[source]: Возвращает, установлены ли единицы на какой-либо оси.

is_horizontal()[source]: True, если коллекция событий горизонтальная, False, если вертикальная.

is_transform_set()[source]

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

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

свойствоmouseover

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

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств графического объекта.

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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>, 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]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массивоподобный объект, скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список цветов
`colors`	цвет или список цветов
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linelength`	неизвестно
`lineoffset`	неизвестно
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массив (N, 2) или (2,) типа array-like
`orientation`	{'горизонтально', 'вертикально'}
`path_effects`	`AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или число с плавающей точкой или вызываемая функция
`pickradius`	число с плавающей точкой
`positions`	неизвестно
`rasterized`	bool
`segments`	неизвестно
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None

`verts`	неизвестно
`visible`	bool
`zorder`	float

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

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) для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или str или None

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, к которому принадлежит элемент.

Параметры

figFigure

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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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 может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить через последовательность

Параметры

lwfloat или список чисел с плавающей точкой

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_norm(norm)[source]

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_orientation(orientation)[source]

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

Параметры

orientation{'горизонтально', 'вертикально'}

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

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

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

Параметры

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

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 использует это значение как начальное значение генератора псевдослучайных чисел, а не так, как описано выше. Использование одного и того же начального значения приводит к одному и тому же случайному изображению.

set_snap(snap)[source]

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

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

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

Параметры

snapbool или None

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

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

set_transform(t)[source]

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

Параметры

tTransform

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-порядок для объекта. Объекты с меньшими значениями 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)

switch_orientation()[source]: Переключить ориентацию линии события с вертикальной на горизонтальную или наоборот.

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

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

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

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

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

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

update(props)[source]

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

Параметры

propsdict

update_from(other)[source]: Копировать свойства из other в self.

update_scalarmappable()[source]

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

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

zorder=0

classmatplotlib.collections.LineCollection(segments, *args, zorder=2, **kwargs)[source]

Bases: matplotlib.collections.Collection

Представляет последовательность Line2D, которые должны быть нарисованы вместе.

Этот класс расширяет Collection, чтобы представлять последовательность Line2D вместо просто последовательности Patch. Как и в Collection, каждый атрибут LineCollection может быть либо одним значением, либо списком значений. Этот список циклически используется для каждого элемента LineCollection, поэтому атрибут i-го элемента коллекции:

prop[i % len(prop)]

Атрибуты каждого элемента LineCollection по умолчанию принимают значения из rcParams["lines.*"] вместо rcParams["patch.*"], и атрибут colors добавлен вместо edgecolors.

Параметры

segmentsсписок массивоподобных объектов

Последовательность (line0, line1, line2), где:

linen = (x0, y0), (x1, y1), ... (xm, ym)

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

linewidthsчисловой тип или список чисел, по умолчанию: rcParams["lines.linewidth"] (по умолчанию: 1.5)

Ширина каждой линии в пунктах.

colorsцвет или список цветов, по умолчанию: rcParams["lines.color"] (по умолчанию: 'C0')

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

antialiasedsлогическое значение или список логических значений, по умолчанию: rcParams["lines.antialiased"] (по умолчанию: True)

Использовать ли сглаживание для каждой линии.

zorderцелое число, по умолчанию: 2

z-порядок линий после отрисовки.

facecolorsцвет или список цветов, по умолчанию: 'none'

При установке facecolors каждая линия интерпретируется как граница области, неявно закрывая путь от последней точки к первой. Заключённая область заполняется facecolor. Для ручного указания того, что должно считаться "внутренней" частью каждой линии, используйте PathCollection вместо него, где "внутреннюю" часть можно указать с помощью CLOSEPOLY.

**kwargs

Передаётся в Collection.

add_callback(func)[source]

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

Параметры

funcфункция

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist – вызываемый Artist. Значения возврата могут существовать, но игнорируются.

Возвращает

целое число: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback в дальнейшем.

См. также

remove_callback

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

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

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

свойствоcallbacksSM[source]

changed()[source]: Вызывается всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей callbackSM о событии '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]

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

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

Параметры

rendererподкласс RendererBase.

Примечания

Этот метод переопределён в подклассах 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_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа для смешивания — не поддерживается на всех бэкендах.

get_animated()[source]: Возвращает значение, указывающее, анимирован ли художник.

get_array()[source]

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

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

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

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.

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, будет ли элемент растрирован.

get_segments()[source]

Возвращает

список: Список отрезков в LineCollection. Каждый элемент списка содержит массив вершин.

get_sketch_params()[source]

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

Возвращает

кортеж или None

3-кортеж со следующими элементами:

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

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

get_snap()[source]

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

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

get_tightbbox(renderer)[source]

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

Параметры

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

Возвращает

Bbox: Включающая ограничивающая рамка (в пикселях координат фигуры).

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

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

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

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

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

get_zorder()[source]: Возвращает z-порядок элемента.

have_units()[source]: Возвращает значение, указывающее, установлены ли единицы на какой-либо оси.

is_transform_set()[source]

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

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

propertymouseover

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

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

propertynorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь со всеми свойствами элемента.

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

set(*, agg_filter=<НЕ ЗАДАНО>, alpha=<НЕ ЗАДАНО>, animated=<НЕ ЗАДАНО>, antialiased=<НЕ ЗАДАНО>, array=<НЕ ЗАДАНО>, capstyle=<НЕ ЗАДАНО>, clim=<НЕ ЗАДАНО>, clip_box=<НЕ ЗАДАНО>, clip_on=<НЕ ЗАДАНО>, clip_path=<НЕ ЗАДАНО>, cmap=<НЕ ЗАДАНО>, color=<НЕ ЗАДАНО>, colors=<НЕ ЗАДАНО>, edgecolor=<НЕ ЗАДАНО>, facecolor=<НЕ ЗАДАНО>, gid=<НЕ ЗАДАНО>, hatch=<НЕ ЗАДАНО>, in_layout=<НЕ ЗАДАНО>, joinstyle=<НЕ ЗАДАНО>, label=<НЕ ЗАДАНО>, linestyle=<НЕ ЗАДАНО>, linewidth=<НЕ ЗАДАНО>, norm=<НЕ ЗАДАНО>, offset_transform=<НЕ ЗАДАНО>, offsets=<НЕ ЗАДАНО>, path_effects=<НЕ ЗАДАНО>, paths=<НЕ ЗАДАНО>, picker=<НЕ ЗАДАНО>, pickradius=<НЕ ЗАДАНО>, rasterized=<НЕ ЗАДАНО>, segments=<НЕ ЗАДАНО>, sketch_params=<НЕ ЗАДАНО>, snap=<НЕ ЗАДАНО>, transform=<НЕ ЗАДАНО>, url=<НЕ ЗАДАНО>, urls=<НЕ ЗАДАНО>, verts=<НЕ ЗАДАНО>, visible=<НЕ ЗАДАНО>, zorder=<НЕ ЗАДАНО>)[source]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi и возвращает массив (m, n, 3)
`alpha`	подобный массиву, скалярное значение или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	подобный массиву или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список цветов
`colors`	цвет или список цветов
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) подобный массиву
`path_effects`	`AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`segments`	неизвестно
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`verts`	неизвестно
`visible`	bool
`zorder`	число с плавающей точкой

END_OF_DOCUMENT_MARKER

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

set_alpha(alpha)[source]

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

Параметры

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

set_animated(b)[source]

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

См. также 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 для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или str или None

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, к которому относится элемент.

Параметры

figFigure

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 для коллекции (для всех ее элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

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

Параметры

sobject: 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_norm(norm)[source]

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

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

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

Параметры

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

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

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

Параметры

tTransform

set_url(url)[source]

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

Параметры

urlстрока

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: Является ли объект 'неактуальным' и нуждается ли он в перерисовке для соответствия внутреннему состоянию объекта.

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

update(props)[source]

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

Параметры

propsсловарь

update_from(other)[source]: Копирование свойств из other в self.

update_scalarmappable()[source]

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

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

zorder=0

classmatplotlib.collections.PatchCollection(patches, match_original=False, **kwargs)[source]

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

Общее множество элементов.

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

Это также может повысить скорость построения графиков, поскольку PatchCollection будет отображаться быстрее, чем большое количество элементов.

patches: последовательность объектов Patch. Этот список может содержать разнородный набор различных типов элементов.
match_original: Если True, используйте цвета и ширины линий исходных элементов. Если False, новые цвета могут быть назначены путем предоставления стандартных аргументов коллекции, facecolor, edgecolor, linewidths, norm или cmap.

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

Использование функциональности ScalarMappable является необязательным. Если матрица ScalarMappable _A была установлена (через вызов set_array), во время рисования будет вызван вызов скалярного отображаемого объекта для установки цветов заливки.

add_callback(func)[source]

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

Параметры

funccallable

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

def func(artist: Artist) -> Any

где artist является вызывающим Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback в дальнейшем.

См. также

remove_callback

autoscale()[source]: Автоматически масштабирует пределы скаляров на объекте norm с использованием текущего массива.

autoscale_None()[source]: Автоматически масштабирует пределы скаляров на объекте norm с использованием текущего массива, изменяя только пределы, которые равны None.

propertyaxes: Объект Axes, в котором находится элемент, или None.

propertycallbacksSM[source]

changed()[source]: Вызовите эту функцию всякий раз, когда изменяется отображение, чтобы уведомить всех слушателей callbackSM о сигнале '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).

Параметры

rendererRendererBase подкласс.

Примечания

Этот метод переопределен в подклассах 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_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешивания — не поддерживается во всех бэкендах.

get_animated()[source]: Возвращает, анимирован ли элемент управления.

get_array()[source]

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

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

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

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]

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

Примечание

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

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

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый этим элементом для смещения.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

END_OF_DOCUMENT_MARKER

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

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

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

Параметры

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

Возвращает

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

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

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

Ширина и высота ограничивающей рамки неотрицательны.

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

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

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

have_units()[source]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[source]

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

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

END_OF_DOCUMENT_MARKER

свойствоmouseover

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

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств графического элемента.

remove()[source]

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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>, 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]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив
`alpha`	массивоподобный объект, скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список кортежей
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

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 для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или str или None

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, к которому принадлежит объект.

Параметры

figFigure

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

Параметры

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 для всего набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

set_paths(patches)[source]

set_picker(picker)[source]

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

Параметры

pickerNone или bool или float или вызываемая функция

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

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

set_pickradius(pr)[source]

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

Параметры

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

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 использует этот аргумент как seed для генератора случайных чисел, а не как описано выше. Использование одного и того же seed приводит к одному и тому же случайному рисунку.

set_snap(snap)[source]

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

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

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

Параметры

snapbool или None

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

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

set_transform(t)[source]

Установите трансформирование объекта.

Параметры

tTransform

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: matplotlib.collections._CollectionWithSizes

A 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 be sizes**2 points when rendered.
**kwargs: Forwarded to Collection.

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_callback later.

Notes

This method is overridden in the Artist subclasses.

findobj(match=None, include_self=True)[source]

Find artist objects.

Recursively find all Artist instances contained in the artist.

Parameters

match

A filter criterion for the matches. This can be

None: Return all objects contained in artist.
A function with signature def match(artist: Artist) -> bool. The result will only contain artists for which the function returns True.
A class instance: e.g., Line2D. The result will only contain artists of this class or its subclasses (isinstance check).

include_selfbool

Include self in the list to be checked for a match.

Returns

list of Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с agg фильтром.

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

get_animated()[source]: Возвращает значение, указывающее, является ли элемент анимированным.

get_array()[source]

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

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

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

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

get_clip_box()[source]: Возвращает ограничивающую рамку.

get_clip_on()[source]: Возвращает значение, указывающее, используется ли обрезка.

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

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

get_cursor_data(event)[source]

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

Примечание

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

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, должен ли элемент быть растрированным.

get_sizes()[source]

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

Возвращает

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

get_sketch_params()[source]

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

Возвращает

кортеж или None

3-кортеж со следующими элементами:

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

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

get_snap()[source]

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

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

get_tightbbox(renderer)[source]

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

Параметры

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

Возвращает

Bbox: Охватывающая прямоугольная область (в пикселях координат рисунка).

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)[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, используйте все уникальные элементы массива отображаемого объекта. Если целое число, используйте 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список строк: Строковые метки для элементов легенды.

свойствоmouseover

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

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

свойствоnorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь со всеми свойствами элемента управления.

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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>, 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]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массивоподобное значение или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобное значение или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список кортежей
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобное значение
`path_effects`	`AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или float или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

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 для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или str или None

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, к которому принадлежит элемент.

Параметры

figFigure

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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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]

Параметры

lwfloat или список float

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_norm(norm)[source]

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

set_paths(paths)[source]

set_picker(picker)[source]

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

Параметры

pickerNone или bool или float или вызываемая функция

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

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

set_pickradius(pr)[source]

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

Параметры

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

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

Параметры

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

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

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

Параметры

tTransform

set_url(url)[source]

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

Параметры

urlстрока

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 является массивом с 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.

update(props)[source]

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

Параметры

propsсловарь

update_from(other)[source]: Копировать свойства из other в self.

update_scalarmappable()[source]

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

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

zorder=0

classmatplotlib.collections.PolyCollection(verts, sizes=None, closed=True, **kwargs)[source]

Bases: matplotlib.collections._CollectionWithSizes

Parameters

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

add_callback(func)[source]

Parameters

funccallable

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Returns

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

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

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

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

propertycallbacksSM[source]

changed()[source]: Вызывайте эту функцию всякий раз, когда изменяется mappable, чтобы уведомить всех слушателей callbackSM об изменении сигнала '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).

Parameters

rendererRendererBase подкласс.

Примечания

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

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_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с agg фильтром.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешения цветов — не поддерживается всеми бэкендами.

get_animated()[source]: Возвращает значение, указывающее, анимируется ли элемент.

get_array()[source]

Возвращает массив значений, сопоставляемых с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

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

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

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

get_clip_on()[source]: Возвращает значение, указывающее, используется ли обрезка для элемента.

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

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

get_cursor_data(event)[source]

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

Примечание

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

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый этим элементом для смещения.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает значение, определяющее, растрируется ли элемент.

get_sizes()[source]

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

Возвращает

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

get_sketch_params()[source]

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

Возвращает

кортеж или None

Трехэлементный кортеж, содержащий следующие значения:

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

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

get_snap()[source]

Возвращает значение настройки приближения.

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

get_tightbbox(renderer)[source]

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

Параметры

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

Возвращает

Bbox: Охватывающая область (в пикселах координат фигуры).

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

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

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

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

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

get_zorder()[source]: Возвращает z-порядок элемента.

have_units()[source]: Возвращает значение, указывающее, установлены ли единицы на какой-либо оси.

END_OF_DOCUMENT_MARKER

is_transform_set()[source]

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

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

propertymouseover

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

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

propertynorm

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь со всеми свойствами графического элемента.

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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>, 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]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массивоподобный объект или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей rgba
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`paths`	список массивоподобных объектов
`picker`	None или bool или число с плавающей точкой или вызываемая функция
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`verts`	список массивоподобных объектов
`verts_and_codes`	неизвестно
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

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

Параметры

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

set_alpha(alpha)[source]

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

Параметры

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

set_animated(b)[source]

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

См. также 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 для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

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

Параметры

vmin, vmaxfloat

Пределы.

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

set_clip_box(clipbox)[source]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Примечания

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

set_cmap(cmap)[source]

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

Параметры

cmapColormap или str или None

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, к которому принадлежит элемент.

Параметры

figFigure

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

Штриховка поддерживается только в постскриптовых, 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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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

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

Параметры

normNormalize или None

Примечания

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

set_offset_transform(transOffset)[source]

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

Параметры

transOffsetTransform

set_offsets(offsets)[source]

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

Параметры

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

set_path_effects(path_effects)[source]

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

Параметры

path_effectsAbstractPathEffect

set_paths(verts, closed=True)[source]

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

Параметры

vertsсписок массивоподобных объектов: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как 2D массив-подобный объект формы (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(pr)[source]

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

Параметры

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

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

Параметры

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

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_transform(t)[source]

Установить преобразование объекта.

Параметры

tTransform

set_url(url)[source]

Установить URL для объекта.

Параметры

urlстрока

set_urls(urls)[source]

Параметры

urlsсписок строк или None

Примечания

В настоящее время URL реализованы только в бэкенде SVG. Они игнорируются всеми другими бэкендами.

set_verts(verts, closed=True)[source]

Установить вершины многоугольников.

Параметры

vertsсписок массивоподобных объектов: Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массивоподобный объект формы (M, 2).
closedлогическое значение, по умолчанию: True: Закрывать ли многоугольник, добавив соединение CLOSEPOLY в конце.

set_verts_and_codes(verts, codes)[source]: Инициализация вершин с кодами пути.

set_visible(b)[source]

Установить видимость объекта.

Параметры

bлогическое значение

set_zorder(level)[source]

Установить z-порядок объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры

levelвещественное число

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 — одномерный или двумерный массив скаляров, и будет возвращен соответствующий массив значений 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.

update(props)[source]

Обновить свойства этого объекта из словаря props.

Параметры

propsсловарь

update_from(other)[source]: Скопировать свойства из other в self.

update_scalarmappable()[source]

Обновить цвета из массива скалярной отображаемой функции, если таковой имеется.

Присвоить цвета к краям и граням на основе массива и/или цветов, которые были непосредственно установлены, в соответствии с тем.

zorder=0

classmatplotlib.collections.QuadMesh(coordinates, *, antialiased=True, shading='flat', pickradius=0, **kwargs)[source]

Основания: matplotlib.collections.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) array-like: Вершины. coordinates[m, n] указывает (x, y) координаты вершины (m, n).
antialiasedbool, default: True
shading{'flat', 'gouraud'}, default: 'flat'

Примечания

В отличие от других Collection, значение по умолчанию pickradius для QuadMesh равно 0, т.е. contains проверяет, находится ли тестовая точка внутри любого из четырёхугольников сетки.

Существует устаревшая версия API QuadMesh(M, N, coords), где размерности задаются явно, и coords — это (M*N, 2) массив-подобный объект. Это было устаревшим в Matplotlib 3.5. Следующее описание семантики этой устаревшей API.

Сетка четырёхугольников состоит из сетки вершин. Размерности этого массива — (meshWidth + 1, meshHeight + 1). У каждой вершины сетки есть свой набор «координат сетки», представляющих её положение в топологии сетки. Для любых значений (m, n) таких, что 0 <= m <= meshWidth и 0 <= n <= meshHeight, вершины с координатами сетки (m, n), (m, n + 1), (m + 1, n + 1) и (m + 1, n) образуют один из четырёхугольников в сетке. Таким образом, в сетке находится (meshWidth * meshHeight) четырёхугольников. Сетка необязательно должна быть регулярной, а многоугольники — выпуклыми.

Сетка четырёхугольников представлена (2 x ((meshWidth + 1) * (meshHeight + 1))) массивом NumPy coordinates, где каждая строка — x и y координаты одной из вершин. Для определения функции, которая отображает точку данных в соответствующий цвет, используйте метод set_cmap(). Каждый из этих массивов индексируется в порядке следования строк по координатам сетки вершины (или по координатам сетки левой нижней вершины в случае с цветами).

Например, первый элемент в coordinates — это координаты вершины с координатами сетки (0, 0), затем вершины (0, 1), затем (0, 2) .. (0, meshWidth), (1, 0), (1, 1) и так далее.

Параметры

edgecolorsцвет или список цветов, по умолчанию: rcParams["patch.edgecolor"] (по умолчанию: 'black')

Цвет края для каждого фрагмента, составляющего коллекцию. Специальное значение 'face' может быть передано, чтобы сделать цвет края совпадающим с цветом заливки.

facecolorsцвет или список цветов, по умолчанию: rcParams["patch.facecolor"] (по умолчанию: 'C0')

Цвет заливки для каждого фрагмента, составляющего коллекцию.

linewidthsвещественное число или список вещественных чисел, по умолчанию: rcParams["patch.linewidth"] (по умолчанию: 1.0)

Толщина линии для каждого фрагмента, составляющего коллекцию.

linestylesстрока или кортеж или список таких кортежей, по умолчанию: 'solid'

Допустимые строки: ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']. Кортежи штрихов должны иметь вид:

(offset, onoffseq),

где onoffseq — кортеж чётной длины, содержащий длины заливки и пробелов в пунктах. Примеры см. в Стилях линий.

capstyleCapStyle-подобный, по умолчанию: rcParams["patch.capstyle"]

Стиль, используемый для обрезки линий для всех путей в коллекции. Допустимые значения — {'butt', 'projecting', 'round'}

joinstyleJoinStyle-подобный, по умолчанию: rcParams["patch.joinstyle"]

Стиль, используемый для соединения линий для всех путей в коллекции. Допустимые значения — {'miter', 'round', 'bevel'}

antialiasedsbool или список bool, по умолчанию: rcParams["patch.antialiased"] (по умолчанию: True)

Определяет, должен ли каждый фрагмент в коллекции рисоваться с сглаживанием.

offsets(float, float) или список таких кортежей, по умолчанию: (0, 0)

Вектор, используемый для перемещения каждого фрагмента после отрисовки (по умолчанию — без перемещения). Перемещение выполняется в экранных (пиксельных) координатах (т.е. после применения преобразования объекта Artist).

transOffsetTransform, по умолчанию: IdentityTransform

Преобразование, которое будет применяться к каждому вектору offsets перед его использованием.

normNormalize, опционально

Передаётся в ScalarMappable. Значение по умолчанию None означает, что первый вызов draw установит vmin и vmax с использованием минимального и максимального значений данных.

cmapColormap, опционально

Передаётся в ScalarMappable. Значение по умолчанию None приведёт к использованию rcParams["image.cmap"] (по умолчанию: 'viridis') .

hatchстрока, опционально

Стиль штриховки, используемый для заполненных путей, если таковые имеются. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. См. Список стилей штриховки для значения каждого типа штриховки.

pickradiusвещественное число, по умолчанию: 5.0

Если pickradius <= 0, тогда Collection.contains вернёт True всякий раз, когда тестовая точка находится внутри одного из многоугольников, образованных контрольными точками пути в коллекции. С другой стороны, если оно больше 0, то вместо этого мы проверяем, содержится ли тестовая точка внутри штриха шириной 2*pickradius по любому из путей в коллекции.

urlsсписок строк, по умолчанию: None

URL для каждого фрагмента для ссылки на него после отрисовки. В настоящее время работает только для бэкэнда SVG. Примеры см. в Ссылки.

zorderвещественное число, по умолчанию: 1

Порядок рисования, общий для всех фрагментов в коллекции. Примеры и значения по умолчанию см. в Демонстрация zorder.

add_callback(func)[source]

Параметры

funccallable

Функция обратного вызова. Она должна иметь следующий прототип:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[source]: Автоматически масштабировать пределы скаляров на экземпляре нормы, используя текущий массив

autoscale_None()[source]: Автоматически масштабировать пределы скаляров на экземпляре нормы, используя текущий массив, изменяя только пределы, которые равны None

propertyaxes: Экземпляр Axes , в котором находится элемент, или None.

propertycallbacksSM[source]

changed()[source]: Вызывайте эту функцию всякий раз, когда изменяется отображаемый элемент, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[source]

Проверить, произошла ли обработка события мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

staticconvert_mesh_to_paths(meshWidth, meshHeight, coordinates)[source]: [Устарело]

Примечания

Устарело начиная с версии 3.5:

convert_mesh_to_triangles(meshWidth, meshHeight, coordinates)[source]: [Устарело]

Примечания

Устарело начиная с версии 3.5:

convert_xunits(x)[source]

Преобразовать x с использованием типа единиц оси x.

Если элемент не находится в оси или у оси x нет единиц, возвращается x сам по себе.

convert_yunits(y)[source]

Преобразовать y с использованием типа единиц оси y.

Если элемент не находится в оси или у оси y нет единиц, возвращается y сам по себе.

draw(renderer)[source]

Отобразить элемент (и его дочерние элементы) с помощью заданного рендерера.

Это не повлияет, если элемент не видим (Artist.get_visible возвращает False).

Параметры

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах 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]

Вернуть строковое представление данных.

Примечание

По умолчанию реализация преобразует целые и плавающие числа и массивы целых и плавающих чисел в строку, разделенную запятыми, заключенную в квадратные скобки, если у элемента нет связанной цветовой шкалы, в этом случае скалярные значения форматируются с помощью формата цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра, используемую для фильтра agg.

get_alpha()[source]: Возвращает значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

get_animated()[source]: Возвращает, анимирован ли элемент.

get_array()[source]

Возвращает массив значений, которые отображаются цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

get_children()[source]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[source]: Возвращает значения (мин, макс), которые отображаются пределом цветовой карты.

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, вы сами не будете вызывать этот метод.

Единственный текущий случай использования — отображение значения z изображения AxesImage в строке состояния окна графика при перемещении мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

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)[source]

Аналогично Artist.get_window_extent, но включает любую обрезку.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая область (в пикселях координат фигуры).

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)[source]

Получить область элемента на экране.

Ширина и высота области должны быть неотрицательными.

Будьте внимательны при использовании этой функции, результаты не обновятся, если область элемента на экране изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но будут сохранены неправильно.

get_zorder()[source]: Возвращает порядок z элемента.

have_units()[source]: Возвращает, установлены ли единицы измерения на какой-либо оси.

is_transform_set()[source]

Возвращает, имеет ли элемент явно установленное преобразование.

Это True после вызова set_transform.

свойствоmouseover

Если это свойство установлено в True, элемент будет запрашиваться для получения пользовательской информации о контексте при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойствоnorm

pchanged()[source]

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний элемент-графический объект сгенерирует событие выбора, если mouseevent находится над этим объектом и у объекта установлен обработчик выбора.

См. также

set_picker, get_picker, pickable

pickable()[source]

Возвращает, является ли графический объект выбираемым.

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств графического объекта.

remove()[source]

Удаляет графический объект из графика, если это возможно.

Эффект не будет виден до повторной отрисовки графика, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim, чтобы обновить пределы осей, если необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.

Примечание: нет поддержки удаления записи легенды графического объекта.

remove_callback(oid)[source]

Удаление обработчика на основе идентификатора наблюдателя.

См. также

add_callback

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>, 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]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив float (m, n, 3) и значение dpi, и возвращающая массив (m, n, 3)
`alpha`	подобный массиву, скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массив (M, N) или подобный массиву M*N
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей rgba
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массив (N, 2) или (2,)
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры

filter_funccallable: Функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив.

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(M, N) массив или массив M*N: Если значения предоставляются в виде двумерной сетки, форма должна соответствовать форме сетки координат. Если значения одномерные, они преобразуются в двумерные. M, N следуют из сетки координат, где форма сетки координат — (M, N) для 'gouraud' shading и (M+1, N+1) для 'flat' shading.

set_capstyle(cs)[source]

Установить CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

Установить пределы нормализации для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также можно передать в виде кортежа (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[source]

Установить область обрезки объекта Bbox.

Параметры

clipboxBbox

set_clip_on(b)[source]

Установить, использует ли объект обрезку.

Когда False, объекты будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[source]

Установить область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан объект Path, также необходимо указать transform. Если None, ранее установленная область обрезки удаляется.
transformTransform, необязательно: Используется только если path является Path, в этом случае указанный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит область обрезки соответствующему прямоугольнику и установит область обрезки в None.

По техническим причинам (поддержка set) также принимается кортеж (path, transform) как единственный позиционный параметр.

set_cmap(cmap)[source]

Устанавливает цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

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, к которому относится элемент.

Параметры

figFigure

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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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_norm(norm)[source]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие отображаемый объект для этой нормализации, установка нормализации отображаемого объекта сбросит нормализацию, локатор и форматировщики цветовой шкалы по умолчанию.

set_offset_transform(transOffset)[source]

Установить трансформацию смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[source]

Установите смещения для коллекции.

Параметры

смещения(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установить эффекты траектории.

Параметры

path_effectsAbstractPathEffect

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(pr)[source]

Установите радиус выбора, используемый для проверок попадания.

Параметры

prfloat: Радиус выбора в точках.

set_rasterized(rasterized)[source]

Принудительно выполняется растровый (битовое) отображение для векторной графики.

Растровый вывод не поддерживается всеми элементами. Если вы попытаетесь включить это для элемента, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.

Эта настройка игнорируется для вывода на основе пикселей.

См. также Растрирование для векторной графики.

Параметры

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры

scalefloat, необязательно

lengthfloat, необязательно

Длина колебания по линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Множитель масштабирования, с помощью которого длина уменьшается или увеличивается (по умолчанию 16.0)

Бэкенд PGF использует этот аргумент как семя генератора случайных чисел, а не как описано выше. Использование одного и того же семени приводит к одному и тому же случайному рисунку.

set_snap(snap)[source]

Установите поведение привязки.

Привязка выравнивает позиции с сеткой пикселей, что приводит к более четким изображениям. Например, если черная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в сетке пикселей, что будет серым значением в двух соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, таким образом, полученное изображение действительно будет содержать черную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязка вершин к центру ближайшего пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные отрезки, округлять до ближайшего центра пикселя.

set_transform(t)[source]

Установить преобразование элемента.

Параметры

tTransform

set_url(url)[source]

Установить URL для элемента.

Параметры

urlstr

set_urls(urls)[source]

Параметры

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установите видимость объекта.

Параметры

bbool

set_zorder(level)[source]

Установите значение zorder для объекта. Объекты с меньшими значениями 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 игнорируется; он не заменяет ранее существовавшее значение alpha. Если третье измерение не равно 3 или 4, возбуждается исключение ValueError.

В обоих случаях, если 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 в self.

update_scalarmappable()[source]

Обновить цвета из массива скалярной отображаемой информации, если он есть.

Присвоить цвета границам и граням на основе массива и/или непосредственно заданных цветов, как это подходит.

zorder=0

END_OF_DOCUMENT_MARKER

classmatplotlib.collections.RegularPolyCollection(numsides, rotation=0, sizes=(1,), **kwargs)[source]

Bases: matplotlib.collections._CollectionWithSizes

Коллекция правильных многоугольников.

Параметры

numsidesint: Количество сторон многоугольника.
rotationfloat: Угол поворота многоугольника в радианах.
sizesкортеж из чисел с плавающей точкой: Площадь окружности, описанной около многоугольника, в пунктах^2.
**kwargs: Передаётся в Collection.

Примеры

См. Демонстрацию Lasso для полного примера:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    transOffset=ax.transData,
    )

add_callback(func)[source]

Добавить функцию обратного вызова, которая будет вызываться всякий раз, когда меняется одно из свойств Artist.

Параметры

funcвызываемая функция

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Значения возврата могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позднее.

См. также

remove_callback

autoscale()[source]: Автомасштабирование пределов скаляров на экземпляре нормы с использованием текущего массива

autoscale_None()[source]: Автомасштабирование пределов скаляров на экземпляре нормы с использованием текущего массива, изменяя только пределы, равные None

propertyaxes: Экземпляр Axes, в котором находится элемент, или None.

propertycallbacksSM[source]

changed()[source]: Вызовите эту функцию всякий раз, когда изменяется сопоставитель карт, чтобы уведомить всех слушателей callbackSM о сигнале «изменено».

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).

Параметры

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах Artist.

findobj(match=None, include_self=True)[source]

Поиск элементов художника.

Рекурсивно находит все экземпляры Artist, содержащиеся в элементе художника.

Параметры

match

Критерий фильтрации соответствий. Это может быть

None: Возвращает все элементы, содержащиеся в элементе.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
Экземпляр класса, например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (isinstance проверка).

include_selfbool

Включать self в список для проверки соответствия.

Возвращает

список из Artist

END_OF_DOCUMENT_MARKER

format_cursor_data(data)[source]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами художников. Пользователю Matplotlib, скорее всего, не нужно будет вызывать этот метод самостоятельно.

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделенную запятыми, заключенную в квадратные скобки, если у художника нет связанной цветовой шкалы. В противном случае скалярные значения форматируются с использованием форматировщика цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается всеми бэкендами.

get_animated()[source]: Возвращает значение, указывающее, является ли художник анимированным.

get_array()[source]

Возвращает массив значений, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

get_children()[source]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[source]: Возвращает значения (мин, макс), которые отображаются в пределы цветовой карты.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает значение, указывающее, используется ли обрезка художником.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные курсора для заданного события.

Примечание

Данные курсора могут быть использованы художниками для предоставления дополнительной контекстной информации для данного события. По умолчанию метод возвращает None.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_numsides()[source]

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора объекта.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

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)[source]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая область (в пикселях координат изображения).

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)[source]

Получает область элемента на экране.

Ширина и высота прямоугольника неотрицательны.

Подклассы должны переопределять для включения в вычисление "уплотнённой" области. По умолчанию возвращается пустая область в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если область элемента на экране изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся неправильно.

get_zorder()[source]: Возвращает z-порядок объекта.

have_units()[source]: Возвращает, установлены ли единицы измерения на любой оси.

is_transform_set()[source]

Возвращает, имеет ли объект-графический элемент явно заданное преобразование.

Это True после вызова set_transform.

propertymouseover

Если это свойство установлено в True, при наведении курсора мыши на объект-графический элемент будет запрошена пользовательская информация контекста.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается в системе, когда изменяется свойство.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обрабатывает событие выбора.

Каждый дочерний объект-графический элемент сгенерирует событие выбора, если mouseevent находится над объектом-графическим элементом и у него установлен picker.

См. также

set_picker, get_picker, pickable

pickable()[source]

Возвращает, является ли объект-графический элемент выбираемым.

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь со всеми свойствами объекта-графического элемента.

remove()[source]

Удаляет объект-графический элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim, чтобы обновить пределы осей, если необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта-графического элемента.

remove_callback(oid)[source]

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

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>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<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]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	массивоподобный объект, скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей rgba
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	(N, 2) или (2,) массивоподобный объект
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры

filter_funccallable: Функция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой размера (m, n, 3).

set_alpha(alpha)[source]

Установить значение альфа, используемое для смешивания — не поддерживается во всех бэкендах.

Параметры

alphaмассивоподобный объект или скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

См. также 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]

Установить стиль закругления для коллекции (для всех ее элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

Установить пределы нормы для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также можно передать как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(clipbox)[source]

Установить область обрезки художника Bbox.

Параметры

clipboxBbox

set_clip_on(b)[source]

Установить, использует ли художник обрезку.

Если False, художники будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[source]

Установить область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан Path, необходимо также указать transform. Если None, ранее заданная область обрезки удаляется.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

set_cmap(cmap)[source]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или строка или None

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, к которому относится элемент.

Параметры

figFigure

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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_label(s)[source]

Установить метку, которая будет отображаться в легенде.

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установить стиль линии(ей) для набора.

стиль линии	описание
`'-'` или `'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_norm(norm)[source]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие mappable для этой нормализации, установка нормализации mappable сбросит нормализацию, локатор и форматеры на цветовой шкале по умолчанию.

set_offset_transform(transOffset)[source]

Установите преобразование смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[source]

Установите смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установите эффекты пути.

Параметры

path_effectsAbstractPathEffect

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(pr)[source]

Установите радиус выбора, используемый для проверок на попадание.

Параметры

prfloat: Радиус выбора, в точках.

set_rasterized(rasterized)[source]

Принудительное растровое (битовое) отображение для вывода векторной графики.

Растровое отображение не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не сработает, и будет выведено предупреждение.

Это значение игнорируется для вывода на основе пикселей.

См. также Растризация для векторной графики.

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

Установите размеры каждого элемента коллекции.

Параметры

sizesndarray или None: Размер для установки каждому элементу коллекции. Значение — это 'площадь' элемента.
dpifloat, по умолчанию: 72: dpi холста.

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_transform(t)[source]

Установите преобразование объекта.

Параметры

tTransform

set_url(url)[source]

Установите URL для объекта.

Параметры

urlстрока

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 — это одномерный или двумерный набор скаляров, и возвращается соответствующий массив rgba, основанный на нормализации и палитре цветов, заданных для этого объекта ScalarMappable.

Есть один особый случай для обработки изображений, которые уже являются rgb или rgba, например, прочитанных из файла изображения. Если x — это массив с 3 измерениями, а последнее измерение равно 3 или 4, он рассматривается как массив rgb или rgba, и никакой обработки не выполняется. Массив может быть uint8 или иметь значения с плавающей точкой в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение alpha (по умолчанию 1) будет использовано для заполнения прозрачности. Если последнее измерение равно 4, значение alpha игнорируется; оно не заменяет существующее alpha. Если третье измерение отличается от 3 или 4, будет поднято исключение ValueError.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет иметь значения с плавающей точкой в диапазоне 0-1; если True, возвращаемый массив rgba будет иметь значения uint8 в диапазоне 0-255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне 0-1.

update(props)[source]

Обновить свойства этого объекта из словаря props.

Параметры

propsсловарь

update_from(other)[source]: Скопировать свойства из other в self.

update_scalarmappable()[source]

Обновить цвета из массива отображаемого скаляра, если он есть.

Присвоить цвета краям и граням, основываясь на массиве и/или цветах, заданных напрямую, соответственно.

zorder=0

classmatplotlib.collections.StarPolygonCollection(numsides, rotation=0, sizes=(1,), **kwargs)[source]

Bases: matplotlib.collections.RegularPolyCollection

Рисует набор правильных звёзд с numsides точками.

Параметры

numsidesint: Количество сторон многоугольника.
rotationfloat: Поворот многоугольника в радианах.
sizesкортеж из float: Площадь окружности, описанной вокруг многоугольника, в пунктах^2.
**kwargs: Передаётся в Collection.

Примеры

См. Демонстрацию Lasso для полного примера:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    transOffset=ax.transData,
    )

add_callback(func)[source]

Параметры

funcвызываемая функция

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Значения возврата могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

autoscale()[source]: Автоматически масштабирует пределы скалярных значений в экземпляре norm с использованием текущего массива

autoscale_None()[source]: Автоматически масштабирует пределы скалярных значений в экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None

свойствоaxes: Экземпляр Axes, в котором находится элемент, или None.

свойствоcallbacksSM[source]

changed()[source]: Вызывайте эту функцию всякий раз, когда изменяется объект отображения, чтобы уведомить всех слушателей обратного вызова callbacksSM о сигнале "изменено".

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.

Примечания

Этот метод переопределён в подклассах элемента.

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.

Примечание

По умолчанию реализация преобразует целые и вещественные числа, а также массивы целых и вещественных чисел в строку, разделённую запятыми, заключённую в квадратные скобки, если у элемента нет связанной цветовой шкалы, в противном случае числовые значения форматируются с помощью форматировщика цветовой шкалы.

См. также

get_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается на всех бэкендах.

get_animated()[source]: Возвращает, анимирован ли элемент.

get_array()[source]

Возвращает массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

get_children()[source]: Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[source]: Возвращает значения (минимум, максимум), которые отображаются в пределы цветовой карты.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает, используется ли обрезка элемента.

get_clip_path()[source]: Возвращает путь обрезки.

get_cmap()[source]: Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные указателя для заданного события.

Примечание

Данные указателя могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию реализация возвращает None.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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_numsides()[source]

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый для смещения данного элемента.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

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)[source]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Возвращает

Bbox: Охватывающая прямоугольная область (в пикселях координат фигуры).

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)[source]

Получает прямоугольную область элемента в пространстве отображения.

Ширина и высота прямоугольной области неотрицательны.

Подклассы должны переопределять для включения в вычисления прямоугольной области "tight". По умолчанию возвращает пустую прямоугольную область в 0, 0.

Будьте внимательны при использовании этой функции, результаты не обновляются, если прямоугольная область элемента изменилась. Область может измениться из-за любых изменений в стеке преобразований, например, при изменении пределов осей, размера фигуры или используемого холста (как при сохранении фигуры). Это может привести к неожиданному поведению, где интерактивные фигуры будут выглядеть хорошо на экране, но сохранятся неправильно.

get_zorder()[source]: Возвращает z-порядок элемента.

have_units()[source]: Возвращает, установлены ли единицы измерения на любой оси.

is_transform_set()[source]

Возвращает, имеет ли элемент отображения явно установленное преобразование.

Это True после того, как был вызван set_transform.

propertymouseover

Если это свойство установлено в True, элемент отображения будет запрошен для получения пользовательских данных контекста при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

propertynorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обрабатывает событие выбора.

Каждый дочерний элемент отображения сгенерирует событие выбора, если mouseevent находится над элементом отображения, и для элемента отображения установлено свойство picker.

См. также

set_picker, get_picker, pickable

pickable()[source]

Возвращает, можно ли выбрать элемент отображения.

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь со всеми свойствами элемента отображения.

remove()[source]

Удаляет элемент отображения из рисунка, если это возможно.

Эффект не будет виден до перерисовки рисунка, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей при необходимости вызовите relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента отображения.

remove_callback(oid)[source]

Удаляет обратный вызов на основе его идентификатора наблюдателя.

См. также

add_callback

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>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<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]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, а возвращает массив чисел с плавающей точкой (m, n, 3)
`alpha`	массивоподобный объект или скаляр или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список таких кортежей
`linewidth` или linewidths или lw	число с плавающей точкой или список чисел с плавающей точкой
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массивоподобный объект (N, 2) или (2,)
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`pickradius`	число с плавающей точкой
`rasterized`	bool
`sizes`	массив NumPy или None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	число с плавающей точкой

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры

filter_funccallable: Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

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 для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

Установить пределы нормы для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также могут быть переданы как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(clipbox)[source]

Установить область обрезки элемента Bbox.

Параметры

clipboxBbox

set_clip_on(b)[source]

Установить, использует ли элемент обрезку.

Если False, элементы будут видны за пределами осей, что может привести к непредсказуемым результатам.

Параметры

bbool

set_clip_path(path, transform=None)[source]

Установите область обрезки для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит прямоугольник обрезки и задаст путь обрезки в виде None.

set_cmap(cmap)[source]

Устанавливает палитру цветов для данных яркости.

Параметры

cmapColormap или строка или None

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, к которому принадлежит элемент.

Параметры

figFigure

set_gid(gid)[source]

Установить идентификатор группы (gid) для графического элемента.

Параметры

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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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 или список float

set_linewidths(lw)[source]: Псевдоним для set_linewidth.

set_ls(ls)[source]: Псевдоним для set_linestyle.

set_lw(lw)[source]: Псевдоним для set_linewidth.

set_norm(norm)[source]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие отображаемый объект для этой нормализации, установка нормализации отображаемого объекта сбросит нормализующую, локатор и форматировщик на цветовой шкале по умолчанию.

set_offset_transform(transOffset)[source]

Установить преобразование смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[source]

Установить смещения для коллекции.

Параметры

offsets(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

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(pr)[source]

Установить радиус выбора, используемый для проверок нахождения внутри.

Параметры

prfloat: Радиус выбора, в точках.

set_rasterized(rasterized)[source]

Принудительно использовать растрирование (рисование растром) для векторной графики.

Растрирование не поддерживается всеми объектами. Если вы попытаетесь включить его для объекта, который его не поддерживает, команда не будет иметь эффекта, и будет выдано предупреждение.

Это свойство игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры

rasterizedbool

set_sizes(sizes, dpi=72.0)[source]

Установить размеры каждого элемента коллекции.

Параметры

sizesndarray или None: Размер для каждого элемента коллекции. Значение — 'площадь' элемента.
dpifloat, по умолчанию: 72: Точки на дюйм холста.

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 пиксель.

Привязка в настоящее время поддерживается только backends Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к ближайшему центру пикселя.
False: Не изменять позиции вершин.
None: (автоматически) Если путь содержит только прямолинейные сегменты, округлить до ближайшего центра пикселя.

set_transform(t)[source]

Установить преобразование объекта.

Параметры

tTransform

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.

update(props)[source]

Обновить свойства этого объекта из словаря props.

Параметры

propsсловарь

update_from(other)[source]: Копировать свойства из other в self.

update_scalarmappable()[source]

Обновить цвета из массива скалярной отображаемой функции, если таковой имеется.

Назначить цвета границам и граням, основываясь на массиве и/или непосредственно заданных цветах, соответственно.

zorder=0

classmatplotlib.collections.TriMesh(triangulation, **kwargs)[source]

Bases: matplotlib.collections.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 — кортеж чётной длины с длиной включения и выключения чернил в пунктах. Примеры см. в Linestyles.

capstyleCapStyle-подобный, по умолчанию: rcParams["patch.capstyle"]

Стиль окончания линий для всех путей в коллекции. Допустимые значения: {'butt', 'projecting', 'round'}.

joinstyleJoinStyle-подобный, по умолчанию: rcParams["patch.joinstyle"]

Стиль соединения линий для всех путей в коллекции. Допустимые значения: {'miter', 'round', 'bevel'}.

Определяет, должна ли каждая область в коллекции отображаться с сглаживанием.

offsets(вещественное число, вещественное число) или список таких, по умолчанию: (0, 0)

Вектор, используемый для перемещения каждого элемента после отрисовки (по умолчанию смещения нет). Перемещение выполняется в координатах экрана (пикселей) (т.е. после применения преобразования художника).

transOffsetTransform, по умолчанию: IdentityTransform

Единственное преобразование, которое будет применено к каждому вектору offsets перед его использованием.

normNormalize, необязательно

Передаётся в ScalarMappable. По умолчанию None означает, что первый вызов отрисовки установит vmin и vmax с помощью минимального и максимального значений данных.

cmapColormap, необязательно

Передаётся в ScalarMappable. По умолчанию None приведет к использованию rcParams["image.cmap"] (по умолчанию: 'viridis')

hatchстрока, необязательно

Шаблон штриховки для заполненных путей, если таковые имеются. Допустимые строки: ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']. См. Hatch style reference для значения каждого типа штриховки.

pickradiusвещественное число, по умолчанию: 5.0

Если pickradius <= 0, то Collection.contains вернёт True всякий раз, когда тестовая точка находится внутри одной из многоугольников, образованных контрольными точками Path в Collection. С другой стороны, если он больше 0, то мы вместо этого проверяем, содержится ли тестовая точка в штрихе шириной 2*pickradius по любому из Path в Collection.

urlsсписок строк, по умолчанию: None

URL для каждого элемента, чтобы можно было создать ссылку после отрисовки. В настоящее время работает только для бэкенда SVG. Примеры см. в Hyperlinks.

zorderвещественное число, по умолчанию: 1

Порядок рисования, общий для всех Patches в Collection. Все значения по умолчанию и примеры см. в Zorder Demo.

add_callback(func)[source]

Параметры

funcфункция

Функция обратного вызова. Она должна иметь следующий вид:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позднее.

См. также

remove_callback

autoscale()[source]: Автоматически масштабирует пределы скалярных величин в экземпляре norm с использованием текущего массива

autoscale_None()[source]: Автоматически масштабирует пределы скалярных величин в экземпляре norm с использованием текущего массива, изменяя только пределы, которые равны None

propertyaxes: Экземпляр Axes, в котором находится художник, или None.

propertycallbacksSM[source]

changed()[source]: Вызовите эту функцию при изменении сопоставителя, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

colorbar: Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[source]

Проверяет, произошла ли событие мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в списке items содержит событие.

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).

Параметры

rendererRendererBase подкласс.

Примечания

Этот метод переопределён в подклассах 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_cursor_data

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа, используемое для смешивания — не поддерживается на всех бэкэндах.

get_animated()[source]: Возвращает, анимирован ли артист.

get_array()[source]

Возвращает массив значений, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]

get_children()[source]: Возвращает список дочерних объектов-артистов Artist этого объекта Artist.

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.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

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.

END_OF_DOCUMENT_MARKER

get_linewidth()[source]

get_linewidths()[source]: Псевдоним для get_linewidth.

get_ls()[source]: Псевдоним для get_linestyle.

get_lw()[source]: Псевдоним для get_linewidth.

get_offset_transform()[source]: Возвращает экземпляр Transform, используемый этим элементом для смещения.

get_offsets()[source]: Возвращает смещения для коллекции.

get_path_effects()[source]

get_paths()[source]

get_picker()[source]

Возвращает поведение выделения элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_pickradius()[source]

get_rasterized()[source]: Возвращает, следует ли растрировать элемент.

get_sketch_params()[source]

Возвращает параметры наброска для элемента.

Возвращаемое значение

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает значение параметра привязки.

Подробнее см. set_snap.

get_tightbbox(renderer)[source]

Аналогично Artist.get_window_extent, но включает любое обрезание.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())

Возвращаемое значение

Bbox: Охватывающая рамка (в пикселях координат фигуры).

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)[source]

Получить прямоугольник объекта в пространстве отображения.

Ширина и высота прямоугольника неотрицательны.

Подклассы должны переопределять этот метод для включения в вычисление прямоугольника "tight". По умолчанию возвращается пустой прямоугольник в координатах (0, 0).

Будьте внимательны при использовании этой функции, результаты не обновятся, если прямоугольник объекта изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры выглядят нормально на экране, но сохраняются неправильно.

get_zorder()[source]: Возвращает z-порядок объекта.

have_units()[source]: Возвращает, установлены ли единицы измерения на какой-либо оси.

is_transform_set()[source]

Возвращает, задано ли преобразование для элемента.

Это True после вызова set_transform.

свойствоmouseover

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

свойствоnorm

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом и для элемента установлен picker.

См. также

set_picker, get_picker, pickable

pickable()[source]

Возвращает, может ли элемент быть выбран.

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств элемента.

remove()[source]

Удаляет элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей, если нужно, вызовите relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[source]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback

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>, 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]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	подобный массиву, скалярное значение или None
`animated`	bool
`antialiased` или aa или antialiaseds	bool или список bool
`array`	подобный массиву или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или строка или None
`color`	цвет или список кортежей RGBA
`edgecolor` или ec или edgecolors	цвет или список цветов или 'face'
`facecolor` или facecolors или fc	цвет или список цветов
`figure`	`Figure`
`gid`	строка
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или dashes или linestyles или ls	строка или кортеж или список
`linewidth` или linewidths или lw	float или список float
`norm`	`Normalize` или None
`offset_transform`	`Transform`
`offsets`	массив (N, 2) или (2,) подобный массиву
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`pickradius`	float
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`urls`	список строк или None
`visible`	bool
`zorder`	float

set_aa(aa)[source]: Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры

filter_funccallable: Функция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой размера (m, n, 3).

set_alpha(alpha)[source]

Установить значение альфа для смешивания – не поддерживается на всех бэкэндах.

Параметры

alphaмассив-подобный объект, скаляр или None: Все значения должны находиться в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

См. также matplotlib.animation и Более быстрое рендеринг с помощью блиттинга.

Параметры

bbool

set_antialiased(aa)[source]

Установить состояние антиалиасинга для рендеринга.

Параметры

aabool или список булевых значений

set_antialiaseds(aa)[source]: Псевдоним для set_antialiased.

set_array(A)[source]

Установить массив значений из массивоподобного объекта A.

Параметры

Aмассив-подобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[source]

Установить стиль окончания CapStyle для коллекции (для всех её элементов).

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)[source]

Установить пределы нормализации для масштабирования изображения.

Параметры

vmin, vmaxfloat

Пределы.

Пределы также могут быть переданы как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(clipbox)[source]

Установить область обрезки художника Bbox.

Параметры

clipboxBbox

set_clip_on(b)[source]

Установить, использует ли художник обрезку.

Когда False, художники будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[source]

Установить обрезку для элемента.

Параметры

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан Path, необходимо также указать transform. Если None, ранее установленная область обрезки будет удалена.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

По техническим причинам (поддержка set) также допускается кортеж (path, transform) в качестве единственного позиционного параметра.

set_cmap(cmap)[source]

Установить цветовую карту для данных яркости.

Параметры

cmapColormap или str или None

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, к которому принадлежит элемент.

Параметры

figFigure

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

Буквы могут быть объединены, в этом случае выполняются все указанные штриховки. Если одна буква повторяется, это увеличивает плотность штриховки для данного узора.

Штриховка поддерживается только в постскриптовых, 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 для набора (для всех его элементов).

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

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_norm(norm)[source]

Установить экземпляр нормализации.

Параметры

normNormalize или None

Примечания

Если есть какие-либо цветовые шкалы, использующие отображаемую информацию для этой нормализации, установка нормализации отображаемой информации сбросит нормализацию, локатор и форматирование в цветовой шкале по умолчанию.

set_offset_transform(transOffset)[source]

Установить трансформирование смещения объекта.

Параметры

transOffsetTransform

set_offsets(offsets)[source]

Установите смещения для коллекции.

Параметры

смещения(N, 2) или (2,) массив-подобный объект

set_path_effects(path_effects)[source]

Установите эффекты пути.

Параметры

path_effectsAbstractPathEffect

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(pr)[source]

Установите радиус выбора, используемый для проверки попадания.

Параметры

prfloat: Радиус выбора в пунктах.

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_transform(t)[source]

Установите преобразование объекта.

Параметры

tTransform

set_url(url)[source]

Установите URL для объекта.

Параметры

urlстрока

set_urls(urls)[source]

Параметры

urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установите видимость объекта.

Параметры

bbool

set_zorder(level)[source]

Установите порядок отрисовки (zorder) объекта. Объекты с меньшим значением zorder отрисовываются первыми.

Параметры

levelfloat

propertystale: Указывает, является ли объект устаревшим и требует ли перерисовки для отображения актуального состояния.

propertysticky_edges

x и y списки прилипающих границ для автоматического масштабирования.

При автоматическом масштабировании, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра прилипает к границе. Типичный пример использования — гистограммы, где, как правило, не ожидается отступ на нижней границе (0) гистограммы.

Кроме того, расширение отступов «натыкается» на прилипающие границы и не может их пересечь. Например, если верхний предел данных равен 1,0, а верхний предел просмотра, рассчитанный с помощью простого добавления отступа, равен 1,2, но есть прилипающая граница в 1,1, то фактический верхний предел просмотра будет равен 1,1.

Примеры

>>> 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 представляет собой одномерную или двумерную последовательность скаляров, и на основе заданных нормализации и цветовой карты для этого объекта ScalarMappable будет возвращён соответствующий массив значений rgba.

Существует один специальный случай для обработки изображений, которые уже представлены в формате 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.

Параметры

propsdict

update_from(other)[source]: Копирование свойств из other в self.

update_scalarmappable()[source]

Обновление цветов из массива скалярной карты, если таковой имеется.

Присвоение цветов краям и граням на основе массива и/или цветов, заданных напрямую, в соответствии с требованиями.

zorder=0