matplotlib.figure

matplotlib.figure реализует следующие классы:

Figure

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

SubFigure

Логическая фигура внутри фигуры, обычно добавляемая в фигуру (или родительскую SubFigure) с помощью методов Figure.add_subfigure или Figure.subfigures (пробный API v3.4).

SubplotParams

Управление значениями отступов по умолчанию между подграфиками.

Фигуры обычно создаются с помощью методов pyplot figure, subplots и subplot_mosaic.

fig, ax = plt.subplots(figsize=(2, 2), facecolor='lightskyblue',
                       layout='constrained')
fig.suptitle('Figure')
ax.set_title('Axes', loc='left', fontstyle='oblique', fontsize='medium')

(Source code, png)

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

classmatplotlib.figure.Figure(figsize=None, dpi=None, *, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, subplotpars=None, tight_layout=None, constrained_layout=None, layout=None, **kwargs)[source]

Основной контейнер для всех элементов графика.

Атрибуты:

patch

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

suppressComposite

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

Параметры:

figsize2-кортеж чисел с плавающей точкой, по умолчанию: rcParams["figure.figsize"] (по умолчанию: [6.4, 4.8])

Размер фигуры (width, height) в дюймах.

dpiчисло с плавающей точкой, по умолчанию: rcParams["figure.dpi"] (по умолчанию: 100.0)

Точек на дюйм.

facecolorпо умолчанию: rcParams["figure.facecolor"] (по умолчанию: 'white')

Цвет заливки области фигуры.

edgecolorпо умолчанию: rcParams["figure.edgecolor"] (по умолчанию: 'white')

Цвет рамки фигуры.

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

Ширина рамки (т.е. ширина линии рамки области фигуры).

frameonбулево значение, по умолчанию: rcParams["figure.frameon"] (по умолчанию: True)

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

subplotparsSubplotParams

Параметры подграфиков. Если не указаны, используются параметры подграфиков по умолчанию rcParams["figure.subplot.*"].

tight_layoutбулево значение или словарь, по умолчанию: rcParams["figure.autolayout"] (по умолчанию: False)

Использовать ли механизм подгонки компоновки. См. set_tight_layout.

Не рекомендуется

Использование этого параметра не рекомендуется. Используйте layout='tight' вместо этого для распространённого случая tight_layout=True и используйте set_tight_layout в противном случае.

constrained_layoutбулево значение, по умолчанию: rcParams["figure.constrained_layout.use"] (по умолчанию: False)

Это равно layout='constrained'.

Не рекомендуется

Использование этого параметра не рекомендуется. Используйте layout='constrained' вместо этого.

layout{'constrained', 'compressed', 'tight', 'none', LayoutEngine, None}, по умолчанию: None

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

• 'constrained': решатель constrained layout изменяет размеры осей, чтобы избежать перекрытия декораций осей. Может обрабатывать сложные макеты графика и полосы цвета, поэтому рекомендуется.

  См. Руководство по ограниченной компоновке для примеров.

• 'compressed': использует тот же алгоритм, что и 'constrained', но удаляет дополнительное пространство между осями с фиксированным соотношением сторон. Лучше всего подходит для простых сеток осей.
• 'tight': Использовать механизм подгонки компоновки. Это относительно простой алгоритм, который настраивает параметры подграфиков таким образом, что декорации не перекрываются. Подробнее см. Figure.set_tight_layout.
• 'none': Не использовать движок компоновки.
• Экземпляр LayoutEngine. Встроенные классы компоновки — ConstrainedLayoutEngine и TightLayoutEngine, более легко доступные как 'constrained' и 'tight'. Передача экземпляра позволяет третьим сторонам предоставлять собственный движок компоновки.

Если не указано, используется параметры tight_layout и constrained_layout, включая их значения по умолчанию конфигурации rcParams["figure.autolayout"] (по умолчанию: False) и rcParams["figure.constrained_layout.use"] (по умолчанию: False).

Другие параметры:

**kwargsFigure свойства, необязательно

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
canvas	FigureCanvas
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
constrained_layout	неизвестно
constrained_layout_pads	неизвестно
dpi	float
edgecolor	цвет
facecolor	цвет
figheight	float
figure	Figure
figwidth	float
frameon	bool
gid	str
in_layout	bool
label	объект
layout_engine	неизвестно
linewidth	число
mouseover	bool
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
rasterized	bool
size_inches	(float, float) или float
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
tight_layout	неизвестно
transform	Transform
url	строка
visible	bool
zorder	float

add_artist(artist, clip=False)[source]

Добавляет Artist в рисунок.

Обычно элементы добавляются к объектам Axes с помощью Axes.add_artist; этот метод можно использовать в редких случаях, когда необходимо добавить элементы непосредственно в рисунок.

Параметры:

artistArtist

Элемент для добавления в рисунок. Если у добавленного элемента нет предварительно установленного преобразования, его преобразование будет установлено в figure.transSubfigure.

clipbool, по умолчанию: False

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

Возвращаемые значения:

Artist

Добавленный элемент.

add_axes(*args, **kwargs)[source]

Добавить Axes на фигуру.

Варианты вызова:

add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)

Параметры:

rectкортеж (левое, нижнее, ширина, высота)

Размеры (левое, нижнее, ширина, высота) нового Axes. Все значения указаны в долях ширины и высоты фигуры.

projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, необязательно

Тип проекции Axes. str — имя пользовательской проекции, см. projections. По умолчанию None соответствует проекции 'rectilinear'.

polarbool, по умолчанию: False

Если True, эквивалентно projection='polar'.

axes_classподкласс Axes, необязательно

Подкласс axes.Axes, который будет создан. Этот параметр несовместим с projection и polar. См. axisartist для примеров.

sharex, shareyAxes, необязательно

Делится осью x или y с sharex и/или sharey. Ось будет иметь те же пределы, деления и масштаб, что и ось совмещенных осей.

labelstr

Метка для возвращаемого объекта Axes.

Возвращаемое значение:

Axes или подкласс Axes

Возвращаемый класс осей зависит от используемой проекции. Это Axes при использовании прямолинейной проекции и projections.polar.PolarAxes при использовании полярной проекции.

Дополнительные параметры:

**kwargs

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

Свойство	Описание
adjustable	{'box', 'datalim'}
agg_filter	функция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой размера (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
anchor	(число, число) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated	логическое значение
aspect	{'auto', 'equal'} или число
autoscale_on	логическое значение
autoscalex_on	неизвестно
autoscaley_on	неизвестно
axes_locator	Callable[[Axes, Renderer], Bbox]
axisbelow	логическое значение или 'line'
box_aspect	число или None
clip_box	Bbox
clip_on	логическое значение
clip_path	Patch или (Path, Transform) или None
facecolor или fc	цвет
figure	Figure
frame_on	логическое значение
gid	строка
in_layout	логическое значение
label	объект
mouseover	логическое значение
navigate	логическое значение
navigate_mode	неизвестно
path_effects	AbstractPathEffect
picker	None или логическое значение или число с плавающей точкой или вызываемый объект
position	[левое, нижнее, ширина, высота] или Bbox
prop_cycle	неизвестно
rasterization_zorder	число с плавающей точкой или None
rasterized	логическое значение
sketch_params	(масштаб: число, длина: число, случайность: число)
snap	логическое значение или None
subplotspec	неизвестно
title	строка
transform	Transform
url	строка
visible	логическое значение
xbound	неизвестно
xlabel	строка
xlim	(нижняя: число, верхняя: число)
xmargin	число больше -0,5
xscale	неизвестно
xticklabels	неизвестно

xticks	неизвестно
ybound	неизвестно
ylabel	строка
ylim	(нижняя: число, верхняя: число)
ymargin	число больше -0,5
yscale	неизвестно
yticklabels	неизвестно
yticks	неизвестно
zorder	число с плавающей точкой

См. также

Figure.add_subplot

pyplot.subplot

pyplot.axes

Figure.subplots

pyplot.subplots

Примечания

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

Примеры

Некоторые простые примеры:

rect = l, b, w, h
fig = plt.figure()
fig.add_axes(rect)
fig.add_axes(rect, frameon=False, facecolor='g')
fig.add_axes(rect, polar=True)
ax = fig.add_axes(rect, projection='polar')
fig.delaxes(ax)
fig.add_axes(ax)

add_axobserver(func)[source]

Всякий раз, когда состояние Axes изменяется, func(self) будет вызван.

add_callback(func)[source]

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

Параметры:

funcвызываемый

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

def func(artist: Artist) -> Any

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

Возвращает:

int

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

См. также

remove_callback

add_gridspec(nrows=1, ncols=1, **kwargs)[source]

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

Параметры:

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

Количество строк в сетке.

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

Количество столбцов в сетке.

Возвращает:

GridSpec

Другие параметры:

**kwargs

Ключевые параметры передаются GridSpec.

См. также

matplotlib.pyplot.subplots

Примеры

Добавление подграфика, который занимает две строки:

fig = plt.figure()
gs = fig.add_gridspec(2, 2)
ax1 = fig.add_subplot(gs[0, 0])
ax2 = fig.add_subplot(gs[1, 0])
# spans two rows:
ax3 = fig.add_subplot(gs[:, 1])

add_subfigure(subplotspec, **kwargs)[source]

Добавить SubFigure к фигуре как часть расположения подграфиков.

Параметры:

subplotspecgridspec.SubplotSpec

Определяет область в родительской сетке, где будет размещен подграфик.

Возвращает:

SubFigure

Другие параметры:

**kwargs

Передаются объекту SubFigure.

См. также

Figure.subfigures

add_subplot(*args, **kwargs)[source]

Добавить Axes на график в качестве части размещения подграфиков.

Возможные подписи:

add_subplot(nrows, ncols, index, **kwargs)
add_subplot(pos, **kwargs)
add_subplot(ax)
add_subplot()

Параметры:

*argsint, (int, int, index), или SubplotSpec, по умолчанию: (1, 1, 1)

Положение подграфика, заданное одним из следующих вариантов:

• Три целых числа (nrows, ncols, index). Подграфик займёт позицию index на сетке с nrows строками и ncols столбцами. index начинается с 1 в верхнем левом углу и увеличивается вправо. index также может быть кортежем из двух элементов, задающим (first, last) индексы подграфика (с 1, включая last), например, fig.add_subplot(3, 1, (1, 2)) создаёт подграфик, занимающий верхнюю 2/3 часть графика.
• Целое число из трёх цифр. Цифры интерпретируются так, как если бы они были заданы по отдельности как три однозначных целых числа, т.е. fig.add_subplot(235) эквивалентно fig.add_subplot(2, 3, 5). Обратите внимание, что это можно использовать только в том случае, если подграфиков не более 9.
• А SubplotSpec.

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

projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional

Тип проекции подграфика (Axes). str — имя пользовательской проекции, см. projections. Значение по умолчанию None соответствует проекции 'rectilinear'.

polarbool, default: False

Если True, эквивалентно projection='polar'.

axes_classподкласс Axes, optional

Подкласс axes.Axes, который будет создан. Этот параметр несовместим с projection и polar. См. axisartist для примеров.

sharex, shareyAxes, optional

Поделиться осью x или y с sharex и/или sharey. Ось будет иметь те же пределы, деления и масштаб, что и ось соответствующей оси.

labelstr

Метка для возвращаемой оси.

Возвращает:

Axes

Ось подграфика. Возвращённая ось может фактически быть экземпляром подкласса, например, projections.polar.PolarAxes для полярных проекций.

Другие параметры:

**kwargs

Этот метод также принимает ключевые аргументы для возвращаемого базового класса оси; за исключением аргумента figure. Ключевые аргументы для прямолинейного базового класса Axes можно найти в следующей таблице, но могут быть и другие ключевые аргументы, если используется другая проекция.

Свойство	Описание
adjustable	{'box', 'datalim'}
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
anchor	(float, float) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated	bool
aspect	{'auto', 'equal'} или float
autoscale_on	bool
autoscalex_on	неизвестно
autoscaley_on	неизвестно
axes_locator	Callable[[Axes, Renderer], Bbox]
axisbelow	bool или 'line'
box_aspect	float или None
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
facecolor или fc	цвет
figure	Figure
frame_on	bool
gid	str
in_layout	bool
label	объект
mouseover	bool
navigate	bool
navigate_mode	неизвестно
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
position	[left, bottom, width, height] или Bbox
prop_cycle	неизвестно
rasterization_zorder	float или None
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
subplotspec	неизвестно
title	str
transform	Transform
url	str
visible	bool
xbound	неизвестно
xlabel	str
xlim	(bottom: float, top: float)
xmargin	float больше чем -0.5
xscale	неизвестно
xticklabels	неизвестно

xticks	неизвестно
ybound	неизвестно
ylabel	строка
ylim	(нижняя: число с плавающей точкой, верхняя: число с плавающей точкой)
ymargin	число с плавающей точкой, больше -0,5
yscale	неизвестно
yticklabels	неизвестно
yticks	неизвестно
zorder	число с плавающей точкой

См. также

Figure.add_axes

pyplot.subplot

pyplot.axes

Figure.subplots

pyplot.subplots

Примеры

fig = plt.figure()

fig.add_subplot(231)
ax1 = fig.add_subplot(2, 3, 1)  # equivalent but more general

fig.add_subplot(232, frameon=False)  # subplot with no frame
fig.add_subplot(233, projection='polar')  # polar subplot
fig.add_subplot(234, sharex=ax1)  # subplot sharing x-axis with ax1
fig.add_subplot(235, facecolor="red")  # red subplot

ax1.remove()  # delete ax1 from the figure
fig.add_subplot(ax1)  # add ax1 back to the figure

align_labels(axs=None)[source]

Выравнивает метки x и y подграфиков в одной строке или столбце подграфиков (соответственно), если выравнивание меток выполняется автоматически (т.е. положение метки не задано вручную).

Выравнивание сохраняется для событий рисования после вызова.

Параметры:

axsсписок Axes

Необязательный список (или ndarray) Axes для выравнивания меток. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_xlabels

matplotlib.figure.Figure.align_ylabels

align_xlabels(axs=None)[source]

Выравнивает метки x подграфиков в одном столбце подграфиков, если выравнивание меток выполняется автоматически (т.е. положение метки не задано вручную).

Выравнивание сохраняется для событий рисования после вызова.

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

Параметры:

axsсписок Axes

Необязательный список (или ndarray) Axes для выравнивания меток x. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_ylabels

matplotlib.figure.Figure.align_labels

Примечания

Предполагается, что axs происходят от одного и того же GridSpec, чтобы их позиции SubplotSpec соответствовали позициям на рисунке.

Примеры

Пример с повернутыми метками xtick:

fig, axs = plt.subplots(1, 2)
for tick in axs[0].get_xticklabels():
    tick.set_rotation(55)
axs[0].set_xlabel('XLabel 0')
axs[1].set_xlabel('XLabel 1')
fig.align_xlabels()

align_ylabels(axs=None)[source]

Выравнивает метки y подграфиков в одном столбце подграфиков, если выравнивание меток выполняется автоматически (т.е. положение метки не задано вручную).

Выравнивание сохраняется для событий рисования после вызова.

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

Параметры:

axsсписок Axes

Необязательный список (или ndarray) Axes для выравнивания меток y. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_xlabels

matplotlib.figure.Figure.align_labels

Примечания

Предполагается, что axs происходят от одного и того же GridSpec, чтобы их позиции SubplotSpec соответствовали позициям на рисунке.

Примеры

Пример с большими метками yticks:

fig, axs = plt.subplots(2, 1)
axs[0].plot(np.arange(0, 1000, 50))
axs[0].set_ylabel('YLabel 0')
axs[1].set_ylabel('YLabel 1')
fig.align_ylabels()

autofmt_xdate(bottom=0.2, rotation=30, ha='right', which='major')[source]

Метки даты на оси x часто перекрываются, поэтому полезно их повернуть и выровнять по правому краю. Также распространённый случай — несколько подграфиков с общей осью x, где данные на оси x — даты. Метки часто длинные, и полезно поворачивать их на нижнем подграфике и отключать на других подграфиках, а также отключать подписи оси x.

Параметры:

bottomfloat, по умолчанию: 0.2

Нижняя граница подграфиков для subplots_adjust.

rotationfloat, по умолчанию: 30 градусов

Угол поворота меток по оси x в градусах.

ha{'left', 'center', 'right'}, по умолчанию: 'right'

Горизонтальное выравнивание меток по оси x.

which{'major', 'minor', 'both'}, по умолчанию: 'major'

Выбирает, какие метки повернуть.

propertyaxes

Список осей Axes в Figure. Вы можете получить доступ к осям и изменить их через этот список.

Не изменяйте сам список. Вместо этого используйте add_axes, add_subplot или delaxes для добавления или удаления оси.

Примечание: свойство Figure.axes и метод get_axes эквивалентны.

propertycallbacks[source]

[Устарело]

Примечания

Устарело начиная с версии 3.6: Используйте сигнал 'resize_event' в Figure.canvas.callbacks вместо него.

clear(keep_observers=False)[source]

Очистить рисунок.

Параметры:

keep_observersbool, по умолчанию: False

Установите keep_observers в True, если, например, виджет gui отслеживает оси в рисунке.

clf(keep_observers=False)[source]

[Не рекомендуется] Псевдоним для метода clear().

Не рекомендуется

Использование clf() не рекомендуется. Используйте clear() вместо него.

Параметры:

keep_observersbool, по умолчанию: False

Установите keep_observers в True, если, например, виджет gui отслеживает оси в рисунке.

colorbar(mappable, cax=None, ax=None, use_gridspec=True, **kwargs)[source]

Добавить цветовой бар к графику.

Параметры:

mappable

Объект matplotlib.cm.ScalarMappable (например, AxesImage, ContourSet и т.д.), к которому относится этот цветовой бар. Этот аргумент обязателен для метода Figure.colorbar, но необязателен для функции pyplot.colorbar, которая устанавливает значение по умолчанию для текущего изображения.

Обратите внимание, что можно создать ScalarMappable "на лету", чтобы создать цветовой бар, не привязанный к ранее нарисованному элементу, например:

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)

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

Оси, на которых будет нарисован цветовой бар. Если None, то создаётся новые оси, и пространство для них будет взято из осей, указанных в ax.

axAxes или итерируемый объект или numpy.ndarray осей, необязательно

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

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

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

Если cax None, новый cax создаётся как экземпляр осей. Если ax размещён с помощью subplotspec и use_gridspec True, то cax также размещается с помощью subplotspec.

Возвращает:

colorbarColorbar

Другие параметры:

locationNone или {'left', 'right', 'top', 'bottom'}

Положение, относительное к родительской оси, где создаются оси цветового бара. Оно также определяет orientation цветового бара (цветовые бары слева и справа вертикальные, сверху и снизу — горизонтальные). Если None, положение определяется из orientation, если оно установлено (вертикальные цветовые бары справа, горизонтальные снизу), или по умолчанию «right», если orientation не задано.

orientationNone или {'vertical', 'horizontal'}

Ориентация цветового бара. Предпочтительнее задавать location цветового бара, так как это также определяет orientation; передача несовместимых значений для location и orientation вызывает исключение.

fractionfloat, по умолчанию: 0.15

Доля исходной оси для использования цветового бара.

shrinkfloat, по умолчанию: 1.0

Доля, на которую нужно умножить размер цветового бара.

aspectfloat, по умолчанию: 20

Соотношение длинных и коротких размеров.

padfloat, по умолчанию: 0.05 если вертикальный, 0.15 если горизонтальный

Доля исходной оси между цветовым баром и новыми осями изображения.

anchor(float, float), необязательно

Точка привязки осей цветового бара. По умолчанию (0.0, 0.5) если вертикальный; (0.5, 1.0) если горизонтальный.

panchor(float, float) или False, необязательно

Точка привязки родительской оси цветового бара. Если False, точка привязки родительской оси не изменяется. По умолчанию (1.0, 0.5) если вертикальный; (0.5, 0.0) если горизонтальный.

extend{'neither', 'both', 'min', 'max'}

Добавляет стрелки для значений вне диапазона (если не 'neither'). Они задаются для данной цветовой карты с помощью методов colormap set_under и set_over.

extendfrac{None, 'auto', length, lengths}

Если None, длина минимального и максимального треугольных расширений цветового бара равна 5% от длины внутреннего цветового бара (это значение по умолчанию).

Если 'auto', делает длину треугольных расширений цветового бара равной длине внутренних прямоугольников (когда spacing равен 'uniform') или равной длине смежных внутренних прямоугольников (когда spacing равен 'proportional').

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

extendrectbool

Если False, минимальные и максимальные расширения цветового бара будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.

spacing{'uniform', 'proportional'}

Для дискретных цветовых баров (BoundaryNorm или контуров), 'uniform' присваивает каждому цвету одинаковое пространство; 'proportional' делает пространство пропорциональным интервалу данных.

ticksNone или список меток или Locator

Если None, метки определяются автоматически из входных данных.

formatNone или str или Formatter

Если None, используется ScalarFormatter. Поддерживаются строковые форматы, например, "%4.2e" или "{x:.2e}". Вместо этого можно указать альтернативный Formatter.

drawedgesbool

Рисовать ли линии на границах цветов.

labelstr

Подпись на длинной оси цветового бара.

boundaries, valuesNone или последовательность

Если не задано, цветовая карта будет отображаться в масштабе 0-1. Если последовательности, values должна иметь длину на 1 меньше, чем boundaries. Для каждого участка, ограниченного соседними элементами в boundaries, используется цвет, сопоставленный соответствующему значению в values. Обычно полезно только для индексированных цветов (т.е. norm=NoNorm()) или в других необычных случаях.

Примечания

Если mappable является ContourSet, его параметр extend включается автоматически.

Параметр shrink обеспечивает простой способ масштабирования цветового бара относительно осей. Обратите внимание, что если cax задан, он определяет размер цветового бара, и параметры shrink и aspect игнорируются.

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

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

cbar = colorbar()
cbar.solids.set_edgecolor("face")
draw()

Однако это имеет негативные последствия в других случаях, например, с полупрозрачными изображениями (alpha < 1) и расширениями цветового бара; поэтому этот обходной путь не используется по умолчанию (см. проблему #1188).

contains(mouseevent)[source]

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

Возвращает:

bool, {}

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

delaxes(ax)[source]

Удалить Axes ax из фигуры; обновить текущую ось.

propertydpi

Разрешение в точках на дюйм.

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

draw_artist(a)[source]

Отрисовать только элемент управления Artist a.

draw_without_rendering()[source]

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

execute_constrained_layout(renderer=None)[source]

[Устарело] Используйте layoutgrid для определения положений pos внутри осей.

См. также set_constrained_layout_pads.

Возвращаемое значение:

layoutgridчастный объект отладки

Примечания

Устарело начиная с версии 3.6: Используйте figure.get_layout_engine().execute() вместо этого.

figimage(X, xo=0, yo=0, alpha=None, norm=None, cmap=None, vmin=None, vmax=None, origin=None, resize=False, **kwargs)[source]

Добавляет нересамплированное изображение в рисунок.

Изображение прикрепляется к нижнему или верхнему левому углу в зависимости от origin.

Параметры:

X

Данные изображения. Это массив одного из следующих типов:

• (M, N): изображение со скалярными данными. Картирование цветов контролируется параметрами cmap, norm, vmin и vmax.
• (M, N, 3): изображение с значениями RGB (float от 0 до 1 или int от 0 до 255).
• (M, N, 4): изображение с значениями RGBA (float от 0 до 1 или int от 0 до 255), т.е. включая прозрачность.

xo, yoint

Смещение изображения по осям x/y в пикселях.

alphaNone или float

Значение альфа-смешивания.

cmapстрока или Colormap, по умолчанию: rcParams["image.cmap"] (по умолчанию: 'viridis')

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

Этот параметр игнорируется, если X является RGB(A).

normстрока или Normalize, необязательно

Метод нормализации, используемый для масштабирования скалярных данных до диапазона [0, 1] перед сопоставлением с цветами с помощью cmap. По умолчанию используется линейное масштабирование, сопоставляющее минимальное значение с 0, а максимальное с 1.

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

• Экземпляр Normalize или один из его подклассов (см. Нормализация цветовой карты).
• Имя масштаба, например, "linear", "log", "symlog", "logit" и т.д. Список доступных масштабов можно получить, вызвав matplotlib.scale.get_scale_names(). В этом случае динамически создается и инициализируется соответствующий подкласс Normalize.

Этот параметр игнорируется, если X является RGB(A).

vmin, vmaxfloat, необязательно

При использовании скалярных данных и отсутствии явного norm, vmin и vmax определяют диапазон данных, который охватывает цветовая карта. По умолчанию цветовая карта охватывает весь диапазон значений предоставленных данных. Использование vmin/vmax при заданном экземпляре norm является ошибкой (но использование имени norm (str) вместе с vmin/vmax допустимо).

Этот параметр игнорируется, если X является RGB(A).

origin{'верхний', 'нижний'}, по умолчанию: rcParams["image.origin"] (по умолчанию: 'upper')

Указывает, где индекс [0, 0] массива находится в верхнем левом или нижнем левом углу осей.

resizebool

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

Возвращает:

matplotlib.image.FigureImage

Другие параметры:

**kwargs

Дополнительные параметры kwargs передаются методу Artist классу FigureImage.

Примечания

figimage дополняет изображение осей (imshow), которое будет ресемплировано для соответствия текущим осям. Если вам нужно ресемплированное изображение, занимающее всю фигуру, вы можете определить ось с extents [0, 0, 1, 1].

Примеры

f = plt.figure()
nx = int(f.get_figwidth() * f.dpi)
ny = int(f.get_figheight() * f.dpi)
data = np.random.random((ny, nx))
f.figimage(data)
plt.show()

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

свойствоframeon

Возвращает видимость фоновой области фигуры, т.е. будет ли отрисовано фоновое изображение фигуры. Эквивалентно Figure.patch.get_visible().

gca()[source]

Получить текущие оси.

Если на этой фигуре нет осей, создается новая с помощью Figure.add_subplot. (Чтобы проверить, есть ли на фигуре оси, проверьте, пуста ли figure.axes. Чтобы проверить, есть ли на стеке фигур pyplot, проверьте, пуста ли pyplot.get_fignums().)

get_agg_filter()[source]

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

get_alpha()[source]

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

get_animated()[source]

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

get_axes()[source]

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

Не изменяйте сам список. Используйте add_axes, add_subplot или delaxes для добавления или удаления оси.

Примечание: Свойство Figure.axes и метод get_axes эквивалентны.

get_children()[source]

Возвращает список элементов (artists), содержащихся в фигуре.

get_clip_box()[source]

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

get_clip_on()[source]

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

get_clip_path()[source]

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

get_constrained_layout()[source]

Возвращает значение, указывающее, используется ли ограниченное расположение.

См. Руководство по ограниченному расположению.

get_constrained_layout_pads(relative=False)[source]

[Устарело] Получить отступы для constrained_layout.

Возвращает список w_pad, h_pad в дюймах и wspace и hspace в долях подграфика. Все значения равны None, если constrained_layout не используется.

См. Руководство по ограниченному расположению.

Параметры:

relativebool

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

Примечания

Устарело начиная с версии 3.6: Используйте fig.get_layout_engine().get() вместо этого.

get_cursor_data(event)[source]

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

Примечание

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

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

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

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

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_default_bbox_extra_artists()[source]

get_dpi()[source]

Возвращает разрешение в точках на дюйм в виде числа с плавающей точкой.

get_edgecolor()[source]

Возвращает цвет рамки прямоугольника фигуры.

get_facecolor()[source]

Возвращает цвет заливки прямоугольника фигуры.

get_figheight()[source]

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

get_figure()[source]

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

get_figwidth()[source]

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

get_frameon()[source]

Возвращает видимость фоновой области рисунка, т.е. будет ли отрисовываться фоновая область рисунка. Эквивалентно Figure.patch.get_visible().

get_gid()[source]

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

get_in_layout()[source]

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

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

get_label()[source]

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

get_layout_engine()[source]

get_linewidth()[source]

Получение ширины линии прямоугольника рисунка.

get_mouseover()[source]

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

get_path_effects()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

get_rasterized()[source]

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

get_size_inches()[source]

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

Возвращает:

ndarray

Размер (ширина, высота) рисунка в дюймах.

См. также

matplotlib.figure.Figure.set_size_inches

matplotlib.figure.Figure.get_figwidth

matplotlib.figure.Figure.get_figheight

Примечания

Размер в пикселях можно получить, умножив на Figure.dpi.

get_sketch_params()[source]

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

Возвращает:

кортеж или None

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

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

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

get_snap()[source]

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

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

get_tight_layout()[source]

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

get_tightbbox(renderer=None, bbox_extra_artists=None)[source]

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

Обратите внимание, что FigureBase отличается от всех других элементов, которые возвращают свои Bbox в пикселях.

Элементы, у которых есть artist.set_in_layout(False), не включаются в область.

Параметры:

rendererRendererBase подкласс

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

bbox_extra_artistsсписок из Artist или None

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

Возвращаемое значение:

BboxBase

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

get_transform()[source]

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

get_transformed_clip_path_and_affine()[source]

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

get_url()[source]

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

get_visible()[source]

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

get_window_extent(renderer=None, *args, **kwargs)[source]

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

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

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

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

get_zorder()[source]

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

ginput(n=1, timeout=30, show_clicks=True, mouse_add=MouseButton.LEFT, mouse_pop=MouseButton.RIGHT, mouse_stop=MouseButton.MIDDLE)[source]

Блокирующий вызов для взаимодействия с фигурой.

Ждёт, пока пользователь n раз кликнет по фигуре, и возвращает координаты каждого клика в списке.

Есть три возможных взаимодействия:

• Добавление точки.
• Удаление последней добавленной точки.
• Остановка взаимодействия и возвращение уже добавленных точек.

Действия назначены кнопкам мыши через аргументы mouse_add, mouse_pop и mouse_stop.

Параметры:

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

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

timeoutfloat, по умолчанию: 30 секунд

Количество секунд ожидания до истечения времени. Если ноль или отрицательное, ожидание не ограничено.

show_clicksbool, по умолчанию: True

Если True, показывает красный крест в месте каждого клика.

mouse_addMouseButton или None, по умолчанию: MouseButton.LEFT

Кнопка мыши, используемая для добавления точек.

mouse_popMouseButton или None, по умолчанию: MouseButton.RIGHT

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

mouse_stopMouseButton или None, по умолчанию: MouseButton.MIDDLE

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

Возвращаемое значение:

список кортежей

Список координат кликов (x, y).

Примечания

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

have_units()[source]

Возвращает, установлены ли единицы измерения на какой-либо оси.

is_transform_set()[source]

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

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

legend(*args, **kwargs)[source]

Разместить легенду на рисунке.

Подписи методов:

legend()
legend(handles, labels)
legend(handles=handles)
legend(labels)

Подписи методов соответствуют различным способам использования этого метода:

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

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

В этом случае метки берутся из элемента. Вы можете указать их либо при создании элемента, либо вызвав метод set_label() для элемента:

ax.plot([1, 2, 3], label='Inline label')
fig.legend()

или:

line, = ax.plot([1, 2, 3])
line.set_label('Label via method')
fig.legend()

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

2. Явное указание элементов и меток в легенде

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

fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])

3. Явное указание элементов в легенде

Это аналогично пункту 2, но метки берутся из свойств меток элементов. Пример:

line1, = ax1.plot([1, 2, 3], label='label1')
line2, = ax2.plot([1, 2, 3], label='label2')
fig.legend(handles=[line1, line2])

4. Размещение меток на существующих элементах графика

Не рекомендуется

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

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

fig, (ax1, ax2) = plt.subplots(1, 2)
ax1.plot([1, 3, 5], color='blue')
ax2.plot([2, 4, 6], color='red')
fig.legend(['the blues', 'the reds'])

Параметры:

handlesсписок Artist, необязательно

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

Длина параметров handles и labels должна быть одинаковой. Если они не одинаковы, они усекаются до меньшей длины.

labelsсписок строк, необязательно

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

Возвращаемое значение:

Legend

Другие параметры:

locstr or pair of floats, default: 'upper right'

Расположение легенды.

Строки 'upper left', 'upper right', 'lower left', 'lower right' помещают легенду в соответствующий угол фигуры.

Строки 'upper center', 'lower center', 'center left', 'center right' помещают легенду в центр соответствующей стороны фигуры.

Строка 'center' помещает легенду в центр фигуры.

Расположение также может быть 2-кортежем, содержащим координаты левого нижнего угла легенды в координатах фигуры (в этом случае bbox_to_anchor будет проигнорирован).

Для обратной совместимости, 'center right' (но не другие расположения) также может быть написано как 'right', и каждое расположение в виде "строки" также может быть задано численным значением:

Строка расположения	Код расположения
'best' (только для Axes)	0
'upper right'	1
'upper left'	2
'lower left'	3
'lower right'	4
'right'	5
'center left'	6
'center right'	7
'lower center'	8
'upper center'	9
'center'	10

Если фигура использует менеджер ограниченного макета, строковые коды аргумента ключевого слова loc могут улучшить поведение макета, используя префикс 'outside'. Возникает неоднозначность в углах, поэтому 'outside upper right' создаст пространство для легенды над остальными осями в макете, а 'outside right upper' — справа от макета. В дополнение к значениям loc, перечисленным выше, у нас есть 'outside right upper', 'outside right lower', 'outside left upper' и 'outside left lower'. Подробнее см. Руководство по легендам.

bbox_to_anchorBboxBase, 2-tuple, or 4-tuple of floats

Прямоугольник, используемый для позиционирования легенды в сочетании с loc. По умолчанию устанавливается в axes.bbox (если вызывается как метод для Axes.legend) или figure.bbox (если Figure.legend). Этот аргумент позволяет произвольно размещать легенду.

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

Если задан 4-кортеж или BboxBase, то он определяет прямоугольник (x, y, width, height), в который помещается легенда. Чтобы разместить легенду в лучшем расположении в нижнем правом квадранте осей (или фигуры):

loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)

2-кортеж (x, y) помещает угол легенды, заданный loc, в координаты x, y. Например, чтобы поместить верхний правый угол легенды в центр осей (или фигуры), можно использовать следующие ключевые слова:

loc='upper right', bbox_to_anchor=(0.5, 0.5)

ncolsint, default: 1

Количество столбцов в легенде.

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

propNone or FontProperties or dict

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

fontsizeint or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

Размер шрифта легенды. Если значение численное, размер будет абсолютным размером шрифта в пунктах. Строковые значения относятся к текущему размеру шрифта по умолчанию. Этот аргумент используется только если prop не указан.

labelcolorstr or list, default: rcParams["legend.labelcolor"] (default: 'None')

Цвет текста в легенде. Может быть строкой, представляющей допустимый цвет (например, 'red'), или списком таких строк. Цвет метки также можно сделать таким же, как цвет линии или маркера, используя 'linecolor', 'markerfacecolor' (или 'mfc'), или 'markeredgecolor' (или 'mec').

Цвет метки можно установить глобально с помощью rcParams["legend.labelcolor"] (default: 'None'). Если None, использовать rcParams["text.color"] (default: 'black').

numpointsint, default: rcParams["legend.numpoints"] (default: 1)

Количество точек маркера в легенде при создании записи легенды для Line2D (линии).

scatterpointsint, default: rcParams["legend.scatterpoints"] (default: 1)

Количество точек маркера в легенде при создании записи легенды для PathCollection (диаграммы рассеяния).

scatteryoffsetsiterable of floats, default: [0.375, 0.5, 0.3125]

Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для записи легенды диаграммы рассеяния. 0.0 находится у основания текста легенды, а 1.0 — вверху. Чтобы отобразить все маркеры на одной высоте, установите значение [0.5].

markerscalefloat, default: rcParams["legend.markerscale"] (default: 1.0)

Относительный размер маркеров легенды по сравнению с первоначально нарисованными.

markerfirstbool, default: True

Если True, маркер легенды размещается слева от метки легенды. Если False, маркер легенды размещается справа от метки легенды.

reversebool, default: False

Если True, метки легенды отображаются в обратном порядке ввода. Если False, метки легенды отображаются в том же порядке, что и ввод.

Добавлена в версии 3.7.

frameonbool, default: rcParams["legend.frameon"] (default: True)

Определяет, будет ли легенда нарисована на области (рамке).

fancyboxbool, default: rcParams["legend.fancybox"] (default: True)

Определяет, будут ли скруглены углы вокруг FancyBboxPatch, который формирует фон легенды.

shadowbool, default: rcParams["legend.shadow"] (default: False)

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

framealphafloat, default: rcParams["legend.framealpha"] (default: 0.8)

Прозрачность фона легенды. Если shadow активирован и framealpha равно None, значение по умолчанию игнорируется.

facecolor"inherit" or color, default: rcParams["legend.facecolor"] (default: 'inherit')

Цвет фона легенды. Если "inherit", использовать rcParams["axes.facecolor"] (default: 'white').

edgecolor"inherit" or color, default: rcParams["legend.edgecolor"] (default: '0.8')

Цвет рамки фона легенды. Если "inherit", использовать rcParams["axes.edgecolor"] (default: 'black').

mode{"expand", None}

Если mode установлено в "expand", легенда будет горизонтально расширена, чтобы заполнить область осей (или bbox_to_anchor, если он определяет размер легенды).

bbox_transformNone or Transform

Преобразование для прямоугольника (bbox_to_anchor). Для значения None (по умолчанию) будет использоваться преобразование transAxes осей.

titlestr or None

Заголовок легенды. По умолчанию заголовок отсутствует (None).

title_fontpropertiesNone or FontProperties or dict

Свойства шрифта заголовка легенды. Если None (по умолчанию), будет использоваться аргумент title_fontsize, если он присутствует; если title_fontsize также None, будет использоваться текущий rcParams["legend.title_fontsize"] (default: None).

title_fontsizeint or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, default: rcParams["legend.title_fontsize"] (default: None)

Размер шрифта заголовка легенды. Примечание: это нельзя комбинировать с title_fontproperties. Если вы хотите установить размер шрифта вместе с другими свойствами шрифта, используйте параметр size в title_fontproperties.

alignment{'center', 'left', 'right'}, default: 'center'

Выравнивание заголовка легенды и блока записей. Записи выравниваются как единый блок, так что маркеры всегда выстроены.

borderpadfloat, default: rcParams["legend.borderpad"] (default: 0.4)

Пробел внутри границы легенды, в единицах размера шрифта.

labelspacingfloat, default: rcParams["legend.labelspacing"] (default: 0.5)

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

handlelengthfloat, default: rcParams["legend.handlelength"] (default: 2.0)

Длина маркеров легенды, в единицах размера шрифта.

handleheightfloat, default: rcParams["legend.handleheight"] (default: 0.7)

Высота маркеров легенды, в единицах размера шрифта.

handletextpadfloat, default: rcParams["legend.handletextpad"] (default: 0.8)

Отступ между маркером легенды и текстом, в единицах размера шрифта.

borderaxespadfloat, default: rcParams["legend.borderaxespad"] (default: 0.5)

Отступ между осями и границей легенды, в единицах размера шрифта.

columnspacingfloat, default: rcParams["legend.columnspacing"] (default: 2.0)

Отступ между столбцами, в единицах размера шрифта.

handler_mapdict or None

Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет стандартный словарь обработчиков по адресу matplotlib.legend.Legend.get_legend_handler_map.

draggablebool, default: False

Можно ли перетаскивать легенду мышкой.

См. также

Axes.legend

Примечания

Некоторые объекты не поддерживаются этой функцией. Подробности см. в Руководстве по легендам.

свойствоmouseover

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

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

savefig(fname, *, transparent=None, **kwargs)[source]

Сохранить текущую фигуру.

Вызов:

savefig(fname, *, dpi='figure', format=None, metadata=None,
        bbox_inches=None, pad_inches=0.1,
        facecolor='auto', edgecolor='auto',
        backend=None, **kwargs
       )

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

Параметры:

fnameстрока или путь или бинарный файл-подобный объект

Путь, или объект Python-подобный файлу, или, возможно, объект, зависящий от бэкенда, например, matplotlib.backends.backend_pdf.PdfPages.

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

Если параметр format не задан, то формат определяется из расширения fname, если оно есть. Если format не задан и fname не имеет расширения, то файл сохраняется с rcParams["savefig.format"] (по умолчанию: 'png') и соответствующее расширение добавляется к fname.

Другие параметры:

dpiчисло с плавающей точкой или 'figure', по умолчанию: rcParams["savefig.dpi"] (по умолчанию: 'figure')

Разрешение в точках на дюйм. Если 'figure', используется значение dpi фигуры.

formatстрока

Формат файла, например, 'png', 'pdf', 'svg' и т. д. Поведение при отсутствии этого параметра описано в разделе fname.

metadataсловарь, необязательно

Ключевые пары для хранения в метаданных изображения. Поддерживаемые ключи и значения по умолчанию зависят от формата изображения и бэкенда:

• 'png' с бэкендом Agg: см. параметр metadata в print_png.
• 'pdf' с бэкендом pdf: см. параметр metadata в PdfPages.
• 'svg' с бэкендом svg: см. параметр metadata в print_svg.
• 'eps' и 'ps' с бэкендом PS: поддерживается только 'Creator'.

bbox_inchesстрока или Bbox, по умолчанию: rcParams["savefig.bbox"] (по умолчанию: None)

Прямоугольник в дюймах: сохраняется только заданная часть фигуры. Если 'tight', попытаться определить плотное прямоугольник фигуры.

pad_inchesчисло с плавающей точкой, по умолчанию: rcParams["savefig.pad_inches"] (по умолчанию: 0.1)

Количество отступа вокруг фигуры, когда bbox_inches равен 'tight'.

facecolorцвет или 'auto', по умолчанию: rcParams["savefig.facecolor"] (по умолчанию: 'auto')

Цвет фона фигуры. Если 'auto', используется текущий цвет фона фигуры.

edgecolorцвет или 'auto', по умолчанию: rcParams["savefig.edgecolor"] (по умолчанию: 'auto')

Цвет границы фигуры. Если 'auto', используется текущий цвет границы фигуры.

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

Использовать нестандартный бэкенд для рендеринга файла, например, для рендеринга файла png с бэкендом "cairo" вместо стандартного "agg" или файла pdf с бэкендом "pgf" вместо стандартного "pdf". Обратите внимание, что стандартный бэкенд обычно достаточен. См. Встроенные бэкенды для получения списка допустимых бэкендов для каждого формата файла. Пользовательские бэкенды могут быть указаны как "module://...".

orientation{'landscape', 'portrait'}

В настоящее время поддерживается только бэкендом postscript.

papertypeстрока

Один из 'letter', 'legal', 'executive', 'ledger', 'a0' до 'a10', 'b0' до 'b10'. Поддерживается только для вывода postscript.

transparentбулево

Если True, области Axes будут прозрачными; область Figure также будет прозрачной, если не указаны facecolor и/или edgecolor через параметры.

Если False, не влияет и цвет областей Axes и Figure не изменяется (если не указаны facecolor и/или edgecolor через параметры, в этом случае используются эти цвета).

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

Это полезно, например, для отображения графика поверх цветного фона на веб-странице.

bbox_extra_artistsсписок Artist, необязательно

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

pil_kwargsсловарь, необязательно

Дополнительные ключевые параметры, которые передаются PIL.Image.Image.save при сохранении фигуры.

sca(a)[source]

Установить текущие Axes в a и вернуть a.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, canvas=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, constrained_layout=<UNSET>, constrained_layout_pads=<UNSET>, dpi=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, figheight=<UNSET>, figwidth=<UNSET>, frameon=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, layout_engine=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, size_inches=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, tight_layout=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

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

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

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
canvas	FigureCanvas
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
constrained_layout	неизвестно
constrained_layout_pads	неизвестно
dpi	float
edgecolor	цвет
facecolor	цвет
figheight	float
figure	Figure
figwidth	float
frameon	bool
gid	str
in_layout	bool
label	объект
layout_engine	неизвестно
linewidth	число
mouseover	bool
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
rasterized	bool
size_inches	(float, float) или float
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
tight_layout	неизвестно
transform	Transform
url	str
visible	bool
zorder	float

set_agg_filter(filter_func)[source]

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

Параметры:

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

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

set_alpha(alpha)[source]

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

Параметры:

alphaскаляр или None

alpha должен быть в диапазоне от 0 до 1 включительно.

set_animated(b)[source]

Установить, предназначен ли объект для использования в анимации.

Если True, объект исключается из обычного рисования фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_artist на объекте. Этот подход используется для ускорения анимаций с помощью blitting.

См. также matplotlib.animation и Более быстрое отображение с помощью blitting.

Параметры:

bbool

set_canvas(canvas)[source]

Установить холст, содержащий фигуру

Параметры:

canvasFigureCanvas

set_clip_box(clipbox)[source]

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

Параметры:

clipboxBbox

Обычно создается из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) — это значение по умолчанию для обрезки объекта, добавленного в Axes.

set_clip_on(b)[source]

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

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

Параметры:

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

[Устаревший] [Не рекомендуется] Установить, используется ли constrained_layout при рисовании.

Если None, будет использовано значение rcParams["figure.constrained_layout.use"] (по умолчанию: False).

При предоставлении словаря, содержащего ключи w_pad, h_pad, значения по умолчанию для constrained_layout отступов будут переопределены. Эти отступы в дюймах и по умолчанию равны 3.0/72.0. w_pad — это ширина отступа, а h_pad — высота отступа.

Не рекомендуется

Этот метод не рекомендуется в пользу set_layout_engine.

Параметры:

constrainedbool или dict или None

Примечания

Устаревшее с версии 3.6: Используйте set_layout_engine('constrained') вместо этого.

set_constrained_layout_pads(**kwargs)[source]

[Устаревшее] Устанавливает отступы для constrained_layout.

Подсказка: параметры можно передать из словаря, используя fig.set_constrained_layout(**pad_dict).

См. Руководство по ограниченному макетированию.

Параметры:

w_padfloat, по умолчанию: rcParams["figure.constrained_layout.w_pad"] (значение по умолчанию: 0.04167)

Отступ по ширине в дюймах. Этот отступ вокруг осей предназначен для обеспечения достаточного места для хорошего отображения шрифтов. По умолчанию 3 пункта = 0,04167 дюйма

h_padfloat, по умолчанию: rcParams["figure.constrained_layout.h_pad"] (значение по умолчанию: 0.04167)

Отступ по высоте в дюймах. По умолчанию 3 пункта.

wspacefloat, по умолчанию: rcParams["figure.constrained_layout.wspace"] (значение по умолчанию: 0.02)

Отступ по ширине между подграфиками, выраженный в долях ширины подграфика. Общий отступ равен w_pad + wspace.

hspacefloat, по умолчанию: rcParams["figure.constrained_layout.hspace"] (значение по умолчанию: 0.02)

Отступ по высоте между подграфиками, выраженный в долях ширины подграфика. Общий отступ равен h_pad + hspace.

Примечания

Устарело начиная с версии 3.6: Используйте figure.get_layout_engine().set() вместо этого.

set_dpi(val)[source]

Устанавливает разрешение рисунка в точках на дюйм.

Параметры:

valfloat

set_edgecolor(color)[source]

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

Параметры:

colorцвет

set_facecolor(color)[source]

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

Параметры:

colorцвет

set_figheight(val, forward=True)[source]

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

Параметры:

valfloat

forwardbool

См. set_size_inches.

См. также

matplotlib.figure.Figure.set_figwidth

matplotlib.figure.Figure.set_size_inches

set_figure(fig)[source]

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

Параметры:

figFigure

set_figwidth(val, forward=True)[source]

Устанавливает ширину рисунка в дюймах.

Параметры:

valfloat

forwardbool

См. set_size_inches.

См. также

matplotlib.figure.Figure.set_figheight

matplotlib.figure.Figure.set_size_inches

set_frameon(b)[source]

Устанавливает видимость фонового патча рисунка, т. е. будет ли отрисовываться фоновое изображение рисунка. Эквивалентно Figure.patch.set_visible().

Параметры:

bbool

set_gid(gid)[source]

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

Параметры:

gidstr

set_in_layout(in_layout)[source]

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

Параметры:

in_layoutbool

set_label(s)[source]

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

Параметры:

sобъект

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

set_layout_engine(layout=None, **kwargs)[source]

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

Параметры:

layout: {'constrained', 'compressed', 'tight', 'none'} или `LayoutEngine` или None

• 'constrained' будет использовать ConstrainedLayoutEngine
• 'compressed' также будет использовать ConstrainedLayoutEngine, но с корректировкой, которая пытается создать хороший макет для осей с фиксированным соотношением сторон.
• 'tight' использует TightLayoutEngine
• 'none' удаляет движок макета.

Если None, поведение контролируется rcParams["figure.autolayout"] (по умолчанию: False) (который, если True, ведет себя так, как будто был передан 'tight') и rcParams["figure.constrained_layout.use"] (по умолчанию: False) (который, если True, ведет себя так, как будто был передан 'constrained'). Если оба равны True, rcParams["figure.autolayout"] (по умолчанию: False) имеет приоритет.

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

kwargs: dict

Ключевые аргументы передаются в движок макета для установки таких параметров, как размеры отступов и отступов. Используется только в том случае, если layout — строка.

set_linewidth(linewidth)[source]

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

Параметры:

linewidthчисло

set_mouseover(mouseover)[source]

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

Параметры:

mouseoverbool

См. также

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_path_effects(path_effects)[source]

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

Параметры:

path_effectsAbstractPathEffect

set_picker(picker)[source]

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

Параметры:

pickerNone или bool или float или вызываемый объект

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

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

• Функция: Если picker — вызываемый объект, это пользовательская функция, определяющая, попадает ли объект в событие мыши:

  hit, props = picker(artist, mouseevent)
  

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры:

rasterizedbool

set_size_inches(w, h=None, forward=True)[source]

Установите размер фигуры в дюймах.

Вызовы:

fig.set_size_inches(w, h)  # OR
fig.set_size_inches((w, h))

Параметры:

w(float, float) или float

Ширина и высота в дюймах (если высота не указана как отдельный аргумент) или ширина.

hfloat

Высота в дюймах.

forwardbool, по умолчанию: True

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

См. также

matplotlib.figure.Figure.get_size_inches

matplotlib.figure.Figure.set_figwidth

matplotlib.figure.Figure.set_figheight

Примечания

Для перевода из пикселей в дюймы разделите на Figure.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_tight_layout(tight)[source]

[Устарело] [Не рекомендуется] Указывает, вызывается ли tight_layout при рисовании.

Не рекомендуется

Этот метод не рекомендуется по сравнению с set_layout_engine.

Параметры:

tightbool или dict с ключами "pad", "w_pad", "h_pad", "rect" или None

Если bool, устанавливает, вызывать ли tight_layout при отрисовке. Если None, используйте rcParams["figure.autolayout"] (по умолчанию: False) вместо этого. Если dict, передайте его как kwargs в tight_layout, перезаписывая значения отступов по умолчанию.

Примечания

Устарело начиная с версии 3.6: Используйте set_layout_engine вместо этого.

set_transform(t)[source]

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

Параметры:

tTransform

set_url(url)[source]

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

Параметры:

urlstr

set_visible(b)[source]

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

Параметры:

bbool

set_zorder(level)[source]

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

Параметры:

levelfloat

show(warn=True)[source]

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

Если фигура не была создана с помощью figure, она будет лишена FigureManagerBase, и этот метод вызовет AttributeError.

Предупреждение

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

Примеры использования Figure.show включают выполнение из приложения графического интерфейса (где постоянно работает цикл событий) или из оболочки, например IPython, которая устанавливает обработчик ввода, чтобы позволить интерактивной оболочке принимать входные данные, пока фигура также отображается и интерактивна. Некоторые, но не все, графические библиотеки будут регистрировать обработчик ввода при импорте. Подробнее см. Интеграция с командной строкой.

Если вы находитесь в оболочке без интеграции обработчика ввода или выполняете скрипт python, вам следует использовать matplotlib.pyplot.show с block=True вместо, что позаботится о запуске и выполнении цикла событий за вас.

Параметры:

warnbool, по умолчанию: True

Если True и мы не работаем в бескамерном режиме (т.е. на Linux без установленного DISPLAY), выводить предупреждение при вызове на бэкенде без графического интерфейса.

свойствоstale

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

свойствоsticky_edges

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

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

Кроме того, расширение отступа "упирается" в прилипающие края и не может их пересечь. Например, если верхний предел данных равен 1.0, а верхний предел представления, вычисленный с помощью простого добавления отступа, равен 1.2, но есть прилипающий край в 1.1, то фактический верхний предел представления будет равен 1.1.

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

Примеры

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

subfigures(nrows=1, ncols=1, squeeze=True, wspace=None, hspace=None, width_ratios=None, height_ratios=None, **kwargs)[source]

Добавить набор подфигур в эту фигуру или подфигуру.

Подфигура имеет те же методы художника, что и фигура, и логически такая же, как и фигура, но не может напечатать себя. Смотрите Подфигуры фигуры.

Примечание

Концепция подфигуры является новой в версии 3.4, и API все еще предварительный.

Параметры:

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

Количество строк/столбцов сетки подфигур.

squeezebool, по умолчанию: True

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

wspace, hspacefloat, по умолчанию: None

Количество ширины/высоты, резервируемое для пространства между подфигурами, выраженное как доля средней ширины/высоты подфигур. Если не задано, значения будут взяты из rcParams, если используется ограниченное расположение (см. ConstrainedLayoutEngine), или нулевое, если движок макета не используется.

width_ratiosarray-like длины ncols, необязательно

Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не задано, все столбцы будут иметь одинаковую ширину.

height_ratiosarray-like длины nrows, необязательно

Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не задано, все строки будут иметь одинаковую высоту.

subplot_mosaic(mosaic, *, sharex=False, sharey=False, width_ratios=None, height_ratios=None, empty_sentinel='.', subplot_kw=None, per_subplot_kw=None, gridspec_kw=None)[source]

Построение макета осей на основе ASCII-графики или вложенных списков.

Это вспомогательная функция для построения сложных макетов GridSpec визуально.

См. Сложное и семантическое построение фигур (subplot_mosaic) для примера и полной документации API.

Параметры:

mosaicсписок списков {хешируемых или вложенных} или строка

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

x = [['A panel', 'A panel', 'edge'],
     ['C panel', '.',       'edge']]

производит 4 оси:

• 'A панель', которая имеет высоту 1 строка и занимает первые два столбца
• 'край', который имеет высоту 2 строки и расположен на правом краю
• 'C панель', которая занимает 1 строку и 1 столбец в левом нижнем углу
• пустое место 1 строка и 1 столбец шириной в центре снизу

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

Если вход — строка, то она может быть многострочной строкой вида

'''
AAE
C.E
'''

где каждый символ — это столбец, а каждая строка — строка. Или это может быть однострочная строка, где строки разделены ;:

'AB;CC'

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

Идентификаторы осей могут быть str или хешируемым объектом, не являющимся итерируемым (например, tuple не могут использоваться).

sharex, shareybool, по умолчанию: False

Если True, ось x (sharex) или ось y (sharey) будут общими для всех подграфиков. В этом случае видимость меток делений и единицы осей ведут себя так же, как и для subplots. Если False, ось x или y каждого подграфика будет независимой.

width_ratiosмассив-подобный, длина ncols, необязательно

Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не задано, все столбцы будут иметь одинаковую ширину. Эквивалентно gridspec_kw={'width_ratios': [...]}. В случае вложенных макетов этот аргумент применяется только к внешнему макету.

height_ratiosмассив-подобный, длина nrows, необязательно

Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не задано, все строки будут иметь одинаковую высоту. Эквивалентно gridspec_kw={'height_ratios': [...]}. В случае вложенных макетов этот аргумент применяется только к внешнему макету.

subplot_kwсловарь, необязательно

Словарь с ключевыми словами, передаваемыми в вызов Figure.add_subplot для создания каждого подграфика. Эти значения могут быть переопределены значениями в per_subplot_kw.

per_subplot_kwсловарь, необязательно

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

Если mosaic — строка, и, следовательно, все ключи — одиночные символы, можно использовать одну строку вместо кортежа в качестве ключей; т.е. "AB" эквивалентно ("A", "B").

Введено в версии 3.7.

gridspec_kwсловарь, необязательно

Словарь с ключевыми словами, передаваемыми в конструктор GridSpec, используемый для создания сетки, на которой размещаются подграфики. В случае вложенных макетов этот аргумент применяется только к внешнему макету. Для более сложных макетов пользователи должны использовать Figure.subfigures для создания вложенности.

empty_sentinelобъект, необязательно

Элемент в макете, означающий "оставьте это место пустым". По умолчанию '.'. Обратите внимание, если layout — строка, она обрабатывается с помощью inspect.cleandoc для удаления начальных пробелов, что может помешать использованию пробелов в качестве пустого маркера.

Возвращает:

словарь[метка, ось]

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

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, width_ratios=None, height_ratios=None, subplot_kw=None, gridspec_kw=None)[source]

Добавляет набор подграфиков к данной фигуре.

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

Параметры:

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

Количество строк/столбцов сетки подграфиков.

sharex, shareybool или {'none', 'all', 'row', 'col'}, по умолчанию: False

Управляет совместным использованием осей x (sharex) или y (sharey):

• True или 'all': ось x или y будет общей для всех подграфиков.
• False или 'none': каждая ось x или y каждого подграфика будет независимой.
• 'row': каждая строка подграфиков будет совместно использовать ось x или y.
• 'col': каждый столбец подграфиков будет совместно использовать ось x или y.

Когда подграфики имеют общую ось x по столбцу, метки делений x отображаются только у нижнего подграфика. Аналогично, когда подграфики имеют общую ось y по строке, метки делений y отображаются только у первого подграфика в столбце. Чтобы позже включить метки делений других подграфиков, используйте tick_params.

Когда подграфики имеют общую ось с единицами измерения, вызов Axis.set_units обновит каждую ось с новыми единицами.

squeezebool, по умолчанию: True

• Если True, лишние размерности удаляются из возвращаемого массива объектов Axes:

  • если создан только один подграфик (nrows=ncols=1), возвращается единственный объект Axes как скаляр.
  • для Nx1 или 1xM подграфиков возвращается одномерный numpy массив объектов Axes.
  • для NxM подграфиков с N>1 и M>1 возвращается двумерный массив.
• Если False, никакой сжатия не происходит: возвращаемый объект Axes всегда является двумерным массивом, содержащим экземпляры Axes, даже если он оказывается 1x1.

width_ratiosмассив длиной ncols, необязательно

Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не указано, все столбцы будут иметь одинаковую ширину. Эквивалентно gridspec_kw={'width_ratios': [...]}.

height_ratiosмассив длиной nrows, необязательно

Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не указано, все строки будут иметь одинаковую высоту. Эквивалентно gridspec_kw={'height_ratios': [...]}.

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

Словарь с ключевыми словами, передаваемыми в вызов Figure.add_subplot для создания каждого подграфика.

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

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

Возвращает:

Axes или массив Axes

Либо один объект Axes, либо массив объектов Axes, если было создано более одного подграфика. Размерности возвращаемого массива можно контролировать с помощью ключевого слова squeeze, см. выше.

См. также

pyplot.subplots

Figure.add_subplot

pyplot.subplot

Примеры

# First create some toy data:
x = np.linspace(0, 2*np.pi, 400)
y = np.sin(x**2)

# Create a figure
plt.figure()

# Create a subplot
ax = fig.subplots()
ax.plot(x, y)
ax.set_title('Simple plot')

# Create two subplots and unpack the output array immediately
ax1, ax2 = fig.subplots(1, 2, sharey=True)
ax1.plot(x, y)
ax1.set_title('Sharing Y axis')
ax2.scatter(x, y)

# Create four polar Axes and access them through the returned array
axes = fig.subplots(2, 2, subplot_kw=dict(projection='polar'))
axes[0, 0].plot(x, y)
axes[1, 1].scatter(x, y)

# Share an X-axis with each column of subplots
fig.subplots(2, 2, sharex='col')

# Share a Y-axis with each row of subplots
fig.subplots(2, 2, sharey='row')

# Share both X- and Y-axes with all subplots
fig.subplots(2, 2, sharex='all', sharey='all')

# Note that this is the same as
fig.subplots(2, 2, sharex=True, sharey=True)

subplots_adjust(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)[source]

Настройка параметров макета подграфиков.

Неустановленные параметры остаются без изменений; начальные значения задаются rcParams["figure.subplot.[name]"].

Параметры:

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

Положение левого края подграфиков, как доля ширины фигуры.

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

Положение правого края подграфиков, как доля ширины фигуры.

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

Положение нижнего края подграфиков, как доля высоты фигуры.

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

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

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

Ширина отступа между подграфиками, как доля средней ширины Axes.

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

Высота отступа между подграфиками, как доля средней высоты Axes.

suptitle(t, **kwargs)[source]

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

Параметры:

tstr

Текст заголовка.

xfloat, по умолчанию: 0.5

Позиция x текста в координатах рисунка.

yfloat, по умолчанию: 0.98

Позиция y текста в координатах рисунка.

horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center

Горизонтальное выравнивание текста относительно (x, y).

verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: top

Вертикальное выравнивание текста относительно (x, y).

fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large')

Размер шрифта текста. См. Text.set_size для возможных значений.

fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal')

Начертание шрифта текста. См. Text.set_weight для возможных значений.

Возвращаемое значение:

text

Экземпляр Text заголовка.

Дополнительные параметры:

fontpropertiesNone или dict, необязательно

Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') игнорируются в этом случае.

**kwargs

Дополнительные параметры являются свойствами matplotlib.text.Text.

supxlabel(t, **kwargs)[source]

Добавить централизованную надпись над осью x к рисунку.

Параметры:

tstr

Текст надписи.

xfloat, по умолчанию: 0.5

Позиция x текста в координатах рисунка.

yfloat, по умолчанию: 0.01

Позиция y текста в координатах рисунка.

horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center

Горизонтальное выравнивание текста относительно (x, y).

verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: bottom

Вертикальное выравнивание текста относительно (x, y).

fontsize, sizeпо умолчанию: rcParams["figure.labelsize"] (по умолчанию: 'large')

Размер шрифта текста. См. Text.set_size для возможных значений.

fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal')

Начертание шрифта текста. См. Text.set_weight для возможных значений.

Возвращаемое значение:

text

Экземпляр Text надписи.

Дополнительные параметры:

fontpropertiesNone или dict, необязательно

Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.labelsize"] (по умолчанию: 'large') и rcParams["figure.labelweight"] (по умолчанию: 'normal') игнорируются в этом случае.

**kwargs

Дополнительные параметры являются свойствами matplotlib.text.Text.

supylabel(t, **kwargs)[source]

Добавить централизованную надпись под осью y к рисунку.

Параметры:

tstr

Текст надписи.

xfloat, по умолчанию: 0.02

Позиция x текста в координатах рисунка.

yfloat, по умолчанию: 0.5

Позиция y текста в координатах рисунка.

horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: left

Горизонтальное выравнивание текста относительно (x, y).

verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: center

Вертикальное выравнивание текста относительно (x, y).

fontsize, sizeпо умолчанию: rcParams["figure.labelsize"] (по умолчанию: 'large')

Размер шрифта текста. См. Text.set_size для возможных значений.

fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal')

Начертание шрифта текста. См. Text.set_weight для возможных значений.

Возвращаемое значение:

text

Экземпляр Text подписи.

Дополнительные параметры:

fontpropertiesNone или dict, необязательно

Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.labelsize"] (по умолчанию: 'large') и rcParams["figure.labelweight"] (по умолчанию: 'normal') игнорируются в этом случае.

**kwargs

Дополнительные параметры являются свойствами matplotlib.text.Text.

text(x, y, s, fontdict=None, **kwargs)[source]

Добавить текст к рисунку.

Параметры:

x, yfloat

Позиция для размещения текста. По умолчанию, в координатах фигуры, числа в диапазоне [0, 1]. Система координат может быть изменена с помощью ключевого слова transform.

sstr

Строка текста.

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

Словарь для переопределения свойств текста по умолчанию. Если не указан, значения по умолчанию определяются rcParams["font.*"]. Свойства, переданные как kwargs, переопределяют соответствующие свойства, заданные в fontdict.

Возвращаемое значение:

Text

Другие параметры:

**kwargsText свойства

Другие параметры текстовых параметров.

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
animated	bool
backgroundcolor	цвет
bbox	словарь с свойствами для patches.FancyBboxPatch
clip_box	неизвестно
clip_on	неизвестно
clip_path	неизвестно
color или c	цвет
figure	Figure
fontfamily или family	{ШРИФТ, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties или font или font_properties	font_manager.FontProperties или str или pathlib.Path
fontsize или size	число с плавающей точкой или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch или stretch	{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle или style	{'normal', 'italic', 'oblique'}
fontvariant или variant	{'normal', 'small-caps'}
fontweight или weight	{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
gid	str
horizontalalignment или ha	{'left', 'center', 'right'}
in_layout	bool
label	объект
linespacing	число с плавающей точкой (кратное размеру шрифта)
math_fontfamily	str
mouseover	bool
multialignment или ma	{'left', 'right', 'center'}
parse_math	bool
path_effects	AbstractPathEffect
picker	None или bool или число с плавающей точкой или вызываемая функция
position	(число с плавающей точкой, число с плавающей точкой)
rasterized	bool
rotation	число с плавающей точкой или {'vertical', 'horizontal'}
rotation_mode	{None, 'default', 'anchor'}
sketch_params	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
snap	bool или None
text	объект
transform	Transform
transform_rotates_text	bool
url	str
usetex	bool или None
verticalalignment или va	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
visible	bool
wrap	bool

x	вещественное число
y	вещественное число
zorder	вещественное число

См. также

Axes.text

pyplot.text

tight_layout(*, pad=1.08, h_pad=None, w_pad=None, rect=None)[source]

Настройка отступов между и вокруг подграфиков.

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

Параметры:

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

Отступ между краем фигуры и краями подграфиков, как доля размера шрифта.

h_pad, w_padвещественное число, по умолчанию: pad

Отступ (высота/ширина) между краями смежных подграфиков, как доля размера шрифта.

rectкортеж (левый, нижний, правый, верхний), по умолчанию: (0, 0, 1, 1)

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

См. также

Figure.set_layout_engine

pyplot.tight_layout

update(props)[source]

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

Параметры:

propsсловарь

update_from(other)[source]

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

waitforbuttonpress(timeout=-1)[source]

Ожидание взаимодействия с фигурой.

Ожидание ввода пользователя и возврат True, если была нажата клавиша, False, если была нажата кнопка мыши, и None, если ввод не был получен в течение timeout секунд. Отрицательные значения отключают timeout.

zorder=0

classmatplotlib.figure.FigureBase(**kwargs)[source]

Базовый класс для Figure и SubFigure, содержащий методы, которые добавляют объекты в график или подграфик, создают оси и т. д.

add_artist(artist, clip=False)[source]

Добавить Artist на график.

Обычно объекты добавляются к объектам Axes с помощью Axes.add_artist; этот метод может использоваться в редких случаях, когда необходимо добавить объекты непосредственно на график вместо этого.

Параметры:

artistArtist

Объект, который нужно добавить на график. Если у добавленного объекта нет предварительно заданного преобразования, его преобразование будет установлено в figure.transSubfigure.

clipbool, по умолчанию: False

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

Возвращаемое значение:

Artist

Добавленный объект.

add_axes(*args, **kwargs)[source]

Добавить Axes на график.

Варианты вызова:

add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)

Параметры:

rectкортеж (left, bottom, width, height)

Размеры (left, bottom, width, height) новой Axes. Все значения в долях ширины и высоты графика.

projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional

Тип проекции Axes. str - имя пользовательской проекции, см. projections. Значение по умолчанию None соответствует проекции 'rectilinear'.

polarbool, по умолчанию: False

Если True, эквивалентно projection='polar'.

axes_classподкласс Axes, необязательно

Подкласс axes.Axes, который нужно создать. Этот параметр несовместим с projection и polar. См. axisartist для примеров.

sharex, shareyAxes, optional

Поделиться осью x или y с sharex и/или sharey. Ось будет иметь те же пределы, метки и масштаб, что и ось совмещенной оси.

labelstr

Метка для возвращаемой оси.

Возвращаемое значение:

Axes или подкласс Axes

Возвращаемый класс оси зависит от используемой проекции. Это Axes, если используется прямолинейная проекция, и projections.polar.PolarAxes, если используется полярная проекция.

Другие параметры:

**kwargs

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

Свойство	Описание
adjustable	{'box', 'datalim'}
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
anchor	(float, float) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated	bool
aspect	{'auto', 'equal'} или float
autoscale_on	bool
autoscalex_on	неизвестно
autoscaley_on	неизвестно
axes_locator	Callable[[Axes, Renderer], Bbox]
axisbelow	bool или 'line'
box_aspect	float или None
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
facecolor или fc	цвет
figure	Figure
frame_on	bool
gid	str
in_layout	bool
label	объект
mouseover	bool
navigate	bool
navigate_mode	неизвестно
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
position	[left, bottom, width, height] или Bbox
prop_cycle	неизвестно
rasterization_zorder	float или None
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
subplotspec	неизвестно
title	str
transform	Transform
url	str
visible	bool
xbound	неизвестно
xlabel	str
xlim	(bottom: float, top: float)
xmargin	float больше -0.5
xscale	неизвестно
xticklabels	неизвестно

xticks	неизвестно
ybound	неизвестно
ylabel	строка
ylim	(нижняя: float, верхняя: float)
ymargin	число, большее -0.5
yscale	неизвестно
yticklabels	неизвестно
yticks	неизвестно
zorder	число с плавающей точкой

См. также

Figure.add_subplot

pyplot.subplot

pyplot.axes

Figure.subplots

pyplot.subplots

Примечания

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

Примеры

Некоторые простые примеры:

rect = l, b, w, h
fig = plt.figure()
fig.add_axes(rect)
fig.add_axes(rect, frameon=False, facecolor='g')
fig.add_axes(rect, polar=True)
ax = fig.add_axes(rect, projection='polar')
fig.delaxes(ax)
fig.add_axes(ax)

add_callback(func)[source]

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

Параметры:

funcвызываемая

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

def func(artist: Artist) -> Any

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

Возвращает:

int

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

См. также

remove_callback

add_gridspec(nrows=1, ncols=1, **kwargs)[source]

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

Параметры:

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

Количество строк в сетке.

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

Количество столбцов в сетке.

Возвращает:

GridSpec

Другие параметры:

**kwargs

Ключевые аргументы передаются в GridSpec.

См. также

matplotlib.pyplot.subplots

Примеры

Добавление подграфика, занимающего две строки:

fig = plt.figure()
gs = fig.add_gridspec(2, 2)
ax1 = fig.add_subplot(gs[0, 0])
ax2 = fig.add_subplot(gs[1, 0])
# spans two rows:
ax3 = fig.add_subplot(gs[:, 1])

add_subfigure(subplotspec, **kwargs)[source]

Добавить SubFigure в фигуру как часть компоновки подграфиков.

Параметры:

subplotspecgridspec.SubplotSpec

Определяет область в родительской сетке, где будет размещен подграфик.

Возвращает:

SubFigure

Другие параметры:

**kwargs

Передаются объекту SubFigure.

См. также

Figure.subfigures

add_subplot(*args, **kwargs)[source]

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

Варианты вызова:

add_subplot(nrows, ncols, index, **kwargs)
add_subplot(pos, **kwargs)
add_subplot(ax)
add_subplot()

Параметры:

*argsint, (int, int, index), или SubplotSpec, по умолчанию: (1, 1, 1)

Положение подграфика, определяемое одним из следующих вариантов:

• Три целых числа (nrows, ncols, index). Подграфик займет позицию index на сетке с nrows строками и ncols столбцами. index начинается с 1 в левом верхнем углу и увеличивается вправо. index также может быть кортежем из двух элементов, задающим (first, last) индексы подграфика (1-основанные, включая last), например, fig.add_subplot(3, 1, (1, 2)) создает подграфик, занимающий верхние 2/3 графика.
• Трехзначное целое число. Цифры интерпретируются так, как если бы они были заданы по отдельности как три однозначные числа, т.е. fig.add_subplot(235) то же самое, что и fig.add_subplot(2, 3, 5). Обратите внимание, что это можно использовать только в случае не более 9 подграфиков.
• A SubplotSpec.

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

projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional

Тип проекции подграфика (Axes). str — имя пользовательской проекции, см. projections. По умолчанию None, что соответствует проекции 'rectilinear'.

polarbool, по умолчанию: False

Если True, эквивалентно projection='polar'.

axes_classподкласс Axes, необязательно

Подкласс axes.Axes, который создается. Этот параметр несовместим с projection и polar. См. axisartist для примеров.

sharex, shareyAxes, необязательно

Поделиться осью x или y с sharex и/или sharey. Ось будет иметь те же пределы, метки и масштаб, что и ось совмещенной оси.

labelstr

Метка для возвращаемого объекта Axes.

Возвращаемое значение:

Axes

Объект Axes подграфика. Возвращаемый объект Axes может фактически быть экземпляром подкласса, например, projections.polar.PolarAxes для полярных проекций.

Другие параметры:

**kwargs

Этот метод также принимает ключевые аргументы для базового класса возвращаемого объекта Axes; за исключением аргумента figure. Ключевые аргументы для прямолинейного базового класса Axes можно найти в следующей таблице, но также могут быть другие ключевые аргументы, если используется другая проекция.

Свойство	Описание
adjustable	{'box', 'datalim'}
agg_filter	функция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой размера (m, n, 3) и два смещения от нижнего левого угла изображения
alpha	скаляр или None
anchor	(число, число) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated	bool
aspect	{'auto', 'equal'} или число
autoscale_on	bool
autoscalex_on	неизвестно
autoscaley_on	неизвестно
axes_locator	Callable[[Axes, Renderer], Bbox]
axisbelow	bool или 'line'
box_aspect	число или None
clip_box	Bbox
clip_on	bool
clip_path	Patch или (Path, Transform) или None
facecolor или fc	цвет
figure	Figure
frame_on	bool
gid	строка
in_layout	bool
label	объект
mouseover	bool
navigate	bool
navigate_mode	неизвестно
path_effects	AbstractPathEffect
picker	None или bool или число или вызываемый объект
position	[левое, нижнее, ширина, высота] или Bbox
prop_cycle	неизвестно
rasterization_zorder	число или None
rasterized	bool
sketch_params	(масштаб: число, длина: число, случайность: число)
snap	bool или None
subplotspec	неизвестно
title	строка
transform	Transform
url	строка
visible	bool
xbound	неизвестно
xlabel	строка
xlim	(низ: число, верх: число)
xmargin	число больше, чем -0,5
xscale	неизвестно
xticklabels	неизвестно