Spec-Zone.ru › Matplotlib 3.4

matplotlib.figure

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

Figure
Основной уровень Artist, который содержит все элементы графика. Многие методы реализованы в FigureBase.
SubFigure
Логическая фигура внутри фигуры, обычно добавляемая в фигуру (или родительскую SubFigure) с помощью методов Figure.add_subfigure или Figure.subfigures (предварительная версия API v3.4).
SubplotParams
Управление стандартными интервалами между подграфиками.
class matplotlib.figure.Figure(figsize=None, dpi=None, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, subplotpars=None, tight_layout=None, constrained_layout=None)[source]

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

Объект Figure поддерживает обратные вызовы через атрибут callbacks, который является экземпляром CallbackRegistry. События, к которым можно подключиться, — 'dpi_changed', и обратный вызов будет вызван с func(fig), где fig — экземпляр Figure.

Атрибуты:
patch

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

suppressComposite

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

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

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

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

subplotparsSubplotParams

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

tight_layoutbool или dict, по умолчанию: rcParams["figure.autolayout"] (по умолчанию: False)

Если False, использовать subplotpars. Если True, настроить параметры подграфиков с помощью tight_layout с отступами по умолчанию. При предоставлении словаря, содержащего ключи pad, w_pad, h_pad, и rect, отступы по умолчанию для tight_layout будут переопределены.

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

Если True, использовать ограниченное расположение для корректировки позиционирования элементов графика. Как и tight_layout, но разработано для большей гибкости. См. Руководство по ограниченному расположению для примеров. (Примечание: не работает с add_subplot или subplot2grid.)

add_artist(artist, clip=False)

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

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

Параметры:
artistArtist

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

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

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

Возвращает:
Artist

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

add_axes(*args, **kwargs)

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

Подписи вызовов:

add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)
Параметры:
rectпоследовательность чисел с плавающей точкой

Размеры [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, optional

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

sharex, shareyAxes, optional

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

labelstr

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

Возвращает:
Axes, или подкласс Axes

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

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

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

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

См. также

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)

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

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

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

def func(artist: Artist) -> Any

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

Возвращает:
int

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

См. также

remove_callback
add_gridspec(nrows=1, ncols=1, **kwargs)

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

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

Параметры:
subplotspecgridspec.SubplotSpec

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

Возвращает:
figure.SubFigure
Другие параметры:
**kwargs

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

См. также

Figure.subfigures
add_subplot(*args, **kwargs)

Добавление 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.

Возвращаемое значение:
axes.SubplotBase, или другой подкласс Axes

Объект Axes подграфика. Возвращаемый базовый класс Axes зависит от используемой проекции. Это Axes, если используется проекция rectilinear, и projections.polar.PolarAxes, если используется проекция polar. Возвращаемый объект Axes является подклассом базового класса для подграфиков.

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

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

Свойство Описание
adjustable {'box', 'datalim'}
agg_filter функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3)
alpha скаляр или None
anchor 2-кортеж чисел с плавающей точкой или {'C', 'SW', 'S', 'SE', ...}
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
contains неизвестно
facecolor или fc цвет
figure Figure
frame_on булево значение
gid строка
in_layout булево значение
label объект
navigate булево значение
navigate_mode неизвестно
path_effects AbstractPathEffect
picker None или булево значение или число с плавающей точкой или вызываемая функция
position [left, bottom, width, height] или Bbox
prop_cycle неизвестно
rasterization_zorder число с плавающей точкой или None
rasterized булево значение
sketch_params (scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)
snap булево значение или None
title строка
transform Transform
url строка
visible булево значение
xbound неизвестно
xlabel строка
xlim (bottom: число с плавающей точкой, top: число с плавающей точкой)
xmargin число с плавающей точкой больше -0.5
xscale {"линейный", "логарифмический", "симлогарифмический", "логит", ...} или ScaleBase
xticklabels неизвестно
xticks неизвестно
ybound неизвестно
ylabel строка
ylim (bottom: float, top: float)
ymargin float больше -0.5
yscale {"linear", "log", "symlog", "logit", ...} или ScaleBase
yticklabels неизвестно
yticks неизвестно
zorder float

См. также

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)

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

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

Параметры:
axsсписок Axes

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

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels
align_xlabels(axs=None)

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

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

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

Параметры:
axsсписок Axes

Необязательный список (или массив NumPy) 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)

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

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

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

Параметры:
axsсписок Axes

Необязательный список (или массив NumPy) 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')

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

Параметры:
bottomfloat, по умолчанию: 0.2

Нижняя часть подграфиков для subplots_adjust.

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

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

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

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

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

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

свойствоaxes

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

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

clear(keep_observers=False)[source]

Очистить рисунок — синоним для clf.

clf(keep_observers=False)[source]

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

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

colorbar(mappable, cax=None, ax=None, use_gridspec=True, **kw)

Добавление цветовой шкалы к графику.

Параметры:
mappable

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

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

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
caxAxes, необязательно

Оси, на которые будет нарисована цветовая шкала.

axAxes, список осей, необязательно

Одна или несколько родительских осей, из которых будет отобрана область для новых осей цветовой шкалы, если cax равно None. Это не имеет эффекта, если cax задано.

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

Если cax равно None, новая ось cax создаётся как экземпляр осей. Если ax является экземпляром подграфика и use_gridspec равно True, cax создаётся как экземпляр подграфика с использованием модуля gridspec.

Возвращает:
colorbarColorbar

См. также базовый класс ColorbarBase.

Примечания

Дополнительные ключевые аргументы бывают двух типов:

свойства осей:

locationNone или {'left', 'right', 'top', 'bottom'}
Положение, относительно родительских осей, где создаётся ось цветовой шкалы. Оно также определяет ориентацию цветовой шкалы (цветовые шкалы слева и справа — вертикальные, цветовые шкалы сверху и снизу — горизонтальные). Если None, положение будет взято из orientation, если оно задано (вертикальные цветовые шкалы справа, горизонтальные — снизу), или по умолчанию будет равно 'right', если orientation не задано.
orientationNone или {'vertical', 'horizontal'}
Ориентация цветовой шкалы. Предпочтительнее задавать положение цветовой шкалы, так как это также определяет ориентацию; передача несовместимых значений для 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', длина, длины} Если None, длина треугольных расширений цветовой шкалы для минимальных и максимальных значений составляет 5% длины внутренней цветовой шкалы (это значение по умолчанию). Если 'auto', длина треугольных расширений цветовой шкалы устанавливается равной длине внутренних прямоугольников (когда spacing равен 'uniform') или равной длине смежных внутренних прямоугольников (когда spacing равен 'proportional'). Если скаляр, указывает длину треугольных расширений цветовой шкалы для минимальных и максимальных значений как дробь от длины внутренней цветовой шкалы. Также может быть задана двухелементная последовательность дробей, указывающая длину треугольных расширений цветовой шкалы для минимальных и максимальных значений соответственно как дробь от длины внутренней цветовой шкалы.
extendrect bool Если False, расширения цветовой шкалы для минимальных и максимальных значений будут треугольными (значение по умолчанию). Если True, расширения будут прямоугольными.
spacing {'uniform', 'proportional'} Равномерное распределение дает каждому дискретному цвету одинаковое пространство; пропорциональное распределение делает пространство пропорциональным интервалу данных.
ticks None или список делений или локетор Если None, деления определяются автоматически из ввода.
format None или str или Formatter Если None, используется ScalarFormatter. Если задана строка формата, например, '%.3f', она используется. Вместо этого можно указать альтернативный Formatter.
drawedges bool Рисовать ли линии на границах цветов.
label str Подпись на длинной оси цветовой шкалы.

Следующие свойства, вероятно, будут полезны только в контексте индексированных цветов (то есть, когда у объекта mappable norm=NoNorm()) или других необычных ситуаций.

Свойство Описание
boundaries None или последовательность
values None или последовательность, длина которой на 1 меньше длины последовательности boundaries. Для каждого интервала, ограниченного смежными значениями в boundaries, используется цвет, сопоставленный соответствующему значению в values.

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

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

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

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

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

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

contains(mouseevent)

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

Возвращает:
bool, {}
convert_xunits(x)

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

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

convert_yunits(y)

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

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

delaxes(ax)

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

свойствоdpi

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

draw(renderer)[source]

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

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

Параметры:
rendererRendererBase подкласс.

Примечания

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

draw_artist(a)[source]

Отобразить только элемент Artist a.

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

execute_constrained_layout(renderer=None)[source]

Использовать layoutgrid для определения позиций в пределах осей.

См. также set_constrained_layout_pads.

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

Добавить нересамплированное изображение в фигуру.

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

Параметры:
X

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

  • MxN: значения яркости (серого цвета)
  • MxNx3: значения RGB
  • MxNx4: значения RGBA
xo, yoint

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

alphaNone или float

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

normmatplotlib.colors.Normalize

Экземпляр Normalize для отображения яркости в интервале [0, 1].

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

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

vmin, vmaxfloat

Если norm не задан, эти значения устанавливают пределы данных для цветовой карты.

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

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

resizebool

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

Возвращает:
matplotlib.image.FigureImage
Другие параметры:
**kwargs

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

Примечания

figimage дополняет изображение осей (imshow), которое будет ресамплировано для соответствия текущим осям. Если вы хотите ресамплированное изображение, заполняющее всю фигуру, вы можете определить Axes с 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)

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

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

Параметры:
match

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

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

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

Возвращает:
список Artist
format_cursor_data(data)

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

Примечание

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

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

См. также

get_cursor_data
свойствоframeon

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

gca(**kwargs)

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

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

Свойство Описание
adjustable {'box', 'datalim'}
agg_filter функция фильтра, которая принимает массив чисел с плавающей запятой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей запятой (m, n, 3)
alpha скаляр или None
anchor 2-кортеж чисел с плавающей запятой или {'C', 'SW', 'S', 'SE', ...}
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
contains неизвестно
facecolor или fc цвет
figure Figure
frame_on булево значение
gid строка
in_layout булево значение
label объект
navigate булево значение
navigate_mode неизвестно
path_effects AbstractPathEffect
picker None или булево значение или число с плавающей запятой или вызываемая функция
position [left, bottom, width, height] или Bbox
prop_cycle неизвестно
rasterization_zorder число с плавающей запятой или None
rasterized булево значение
sketch_params (scale: число, length: число, randomness: число)
snap булево значение или None
title строка
transform Transform
url строка
visible булево значение
xbound неизвестно
xlabel строка
xlim (bottom: число, top: число)
xmargin число больше, чем -0.5
xscale {"linear", "log", "symlog", "logit", ...} или ScaleBase
xticklabels неизвестно
xticks неизвестно
ybound неизвестно
ylabel строка
ylim (нижняя граница: float, верхняя граница: float)
ymargin число, большее -0.5
yscale {"линейный", "логарифмический", "симлогарифмический", "логит", ...} или ScaleBase
yticklabels неизвестно
yticks неизвестно
zorder число с плавающей точкой
get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_axes()[source]

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

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

Примечание: Это эквивалентно свойству axes.

get_children()

Получить список объектов (artists), содержащихся в рисунке.

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_constrained_layout()[source]

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

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

get_constrained_layout_pads(relative=False)[source]

Получить отступы для constrained_layout.

Возвращает список отступов в дюймах и w_pad, h_pad и wspace как доли подграфика.

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

Параметры:
relativebool

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

get_contains()

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

См. также

set_contains

Примечания

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

get_cursor_data(event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data
get_default_bbox_extra_artists()
get_dpi()[source]

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

get_edgecolor()

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

get_facecolor()

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

get_figheight()[source]

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

get_figure()

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

get_figwidth()[source]

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

get_frameon()

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

get_gid()

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

get_in_layout()

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

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

get_label()

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

get_linewidth()

Получить ширину линии прямоугольника Figure.

get_path_effects()
get_picker()

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

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

См. также

set_picker, pickable, pick
get_rasterized()

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

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

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

Возвращает:
кортеж или None

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

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

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

get_snap()

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

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

get_tight_layout()[source]

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

get_tightbbox(renderer, bbox_extra_artists=None)

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

Объекты графических элементов, у которых artist.set_in_layout(False) не включены в ограничивающую рамку.

Параметры:
rendererRendererBase подкласс

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

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

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

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

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

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_url()

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

get_visible()

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

get_window_extent(*args, **kwargs)

Возвращает ограничивающую рамку фигуры в пространстве отображения. Аргументы игнорируются.

get_zorder()

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

ginput(n=1, timeout=30, show_clicks=True, mouse_add=<MouseButton.LEFT: 1>, mouse_pop=<MouseButton.RIGHT: 3>, mouse_stop=<MouseButton.MIDDLE: 2>)[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()

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

init_layoutgrid()[source]

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

is_transform_set()

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

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

legend(*args, **kwargs)

Размещает легенду на фигуре.

Вызовы:

legend()
legend(labels)
legend(handles, 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, (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'])

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

3. Явное определение элементов в легенде

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

fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])
Параметры:
handleslist of Artist, optional

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

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

labelslist of str, optional

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

Возвращает:
Legend
END_OF_DOCUMENT_MARKER ```
Другие параметры:
locстрока или пара чисел с плавающей точкой, по умолчанию: rcParams["legend.loc"] (по умолчанию: 'best') ('лучшее' для осей, 'верхний правый' для фигур)

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

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

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

Строка 'center' размещает легенду в центре осей/рисунка.

Строка 'best' размещает легенду в расположении из девяти определенных ранее, с минимальным перекрытием с другими отрисованными элементами. Этот вариант может быть довольно медленным для графиков с большим объёмом данных; скорость построения графиков может повыситься, если указать конкретное расположение.

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

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

Расположение (строка) Код расположения
'лучшее' 0
'верхний правый' 1
'верхний левый' 2
'нижний левый' 3
'нижний правый' 4
'правый' 5
'центр слева' 6
'центр справа' 7
'нижний центр' 8
'верхний центр' 9
'центр' 10
bbox_to_anchorBboxBase, 2-кортеж или 4-кортеж чисел с плавающей точкой

Прямоугольник, используемый для позиционирования легенды в сочетании с 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)
ncolцелое число, по умолчанию: 1

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

propNone или matplotlib.font_manager.FontProperties или словарь

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

fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

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

labelcolorстрока или список

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

numpointsцелое число, по умолчанию: rcParams["legend.numpoints"] (по умолчанию: 1)

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

scatterpointsцелое число, по умолчанию: rcParams["legend.scatterpoints"] (по умолчанию: 1)

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

scatteryoffsetsитерируемый объект чисел с плавающей точкой, по умолчанию: [0.375, 0.5, 0.3125]

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

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

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

markerfirstбулево значение, по умолчанию: True

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

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

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

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

Определяет, должны ли быть включены закругленные углы вокруг FancyBboxPatch, что формирует фон легенды.

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

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

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

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

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

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

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

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

mode{"expand", None}

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

bbox_transformNone или matplotlib.transforms.Transform

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

titleстрока или None

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

title_fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, по умолчанию: rcParams["legend.title_fontsize"] (по умолчанию: None)

Размер шрифта заголовка легенды.

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

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

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

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

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

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

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

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

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

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

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

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

handler_mapсловарь или None

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

См. также

Axes.legend

Примечания

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

свойствоmouseover

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

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

pchanged()

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

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

См. также

add_callback
remove_callback
pick(mouseevent)

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

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

См. также

set_picker, get_picker, pickable
pickable()

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

См. также

set_picker, get_picker, pick
properties()

Возвращает словарь всех свойств объекта.

remove()

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

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

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

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

remove_callback(oid)

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

См. также

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

Сохранение текущей фигуры.

Вызов:

savefig(fname, dpi=None, facecolor='w', edgecolor='w',
        orientation='portrait', papertype=None, format=None,
        transparent=False, bbox_inches=None, pad_inches=0.1,
        frameon=None, metadata=None)

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

Параметры:
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 фигуры.

qualityцелое число, по умолчанию: rcParams["savefig.jpeg_quality"] (по умолчанию: 95)

Применимо только если format равен 'jpg' или 'jpeg', в противном случае игнорируется.

Качество изображения в масштабе от 1 (худшее) до 95 (лучшее). Значения выше 95 следует избегать; 100 отключает части алгоритма сжатия JPEG и приводит к большим файлам с едва заметным улучшением качества изображения.

Этот параметр устарел.

optimizeбулево значение, по умолчанию: False

Применимо только если format равен 'jpg' или 'jpeg', в противном случае игнорируется.

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

Этот параметр устарел.

progressiveбулево значение, по умолчанию: False

Применимо только если format равен 'jpg' или 'jpeg', в противном случае игнорируется.

Указывает, должен ли файл изображения быть сохранён как прогрессивный JPEG.

Этот параметр устарел.

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

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

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

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

orientation{'landscape', 'portrait'}

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

papertypeстрока

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

formatстрока

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

transparentбулево значение

Если True, все области Axes будут прозрачными; область фигуры также будет прозрачной, если не указаны facecolor и/или edgecolor через kwargs. Это полезно, например, для отображения графика поверх цветного фона на веб-странице. Прозрачность этих областей будет восстановлена до исходных значений после выхода из этой функции.

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

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

pad_inchesчисло, по умолчанию: rcParams["savefig.pad_inches"] (по умолчанию: 0.1)

Размер отступа вокруг фигуры, когда bbox_inches равен 'tight'.

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

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

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

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

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

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

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

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

sca(a)

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

set(**kwargs)

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

set_agg_filter(filter_func)

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

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

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

set_alpha(alpha)

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

Параметры:
alphaскаляр или None

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

set_animated(b)

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

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

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

Параметры:
bбулево значение
set_canvas(canvas)[source]

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

Параметры:
canvasFigureCanvas
set_clip_box(clipbox)

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

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

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

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

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

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

Параметры:
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 — высота отступа.

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

Параметры:
constrainedbool или dict или None
set_constrained_layout_pads(**kwargs)[source]

Устанавливает отступы для constrained_layout. Обратите внимание, что аргументы kwargs могут быть переданы в виде словаря fig.set_constrained_layout(**paddict).

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

Параметры:
w_padfloat

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

h_padfloat

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

wspacefloat

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

hspacefloat

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

set_contains(picker)

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

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

Параметры:
pickercallable

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

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

что возвращает:

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

Примечания

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

set_dpi(val)[source]

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

Параметры:
valfloat
set_edgecolor(color)

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

Параметры:
colorцвет
set_facecolor(color)

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

Параметры:
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)

Установить экземпляр 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)

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

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

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

Параметры:
gidstr
set_in_layout(in_layout)

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

Параметры:
in_layoutbool
set_label(s)

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

Параметры:
sobject

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

set_linewidth(linewidth)

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

Параметры:
linewidthnumber
set_path_effects(path_effects)

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

Параметры:
path_effectsAbstractPathEffect
set_picker(picker)

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

Параметры:
pickerNone or bool or float or callable

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

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

    hit, props = picker(artist, mouseevent)
    

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

set_rasterized(rasterized)

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

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

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

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

Параметры:
rasterizedbool
END_OF_DOCUMENT_MARKER
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)

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

Параметры:
scalefloat, необязательно

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

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

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

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

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

set_snap(snap)

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

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

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

Параметры:
snapbool или None

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

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

Установить, вызывается ли tight_layout при отрисовке.

Параметры:
tightbool или словарь с ключами "pad", "w_pad", "h_pad", "rect" или None

Если bool, устанавливает, вызывать ли tight_layout при отрисовке. Если None, используйте rcparam figure.autolayout вместо этого. Если словарь, передайте его как kwargs в tight_layout, переопределяя значения по умолчанию для отступов.

set_transform(t)

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

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

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

Параметры:
urlstr
set_visible(b)

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

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

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

Параметры:
levelfloat
show(warn=True)[source]

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

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

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

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

Правильные варианты использования Figure.show включают запуск этого из приложения графического интерфейса пользователя или оболочки IPython.

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

Параметры:
warnbool, по умолчанию: True

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

свойство stale

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

свойство sticky_edges

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

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

К этому атрибуту нельзя присваивать значения; однако списки 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)

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

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

Параметры:
nrows, ncolsint, по умолчанию: 1

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

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

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

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

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

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

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

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

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

subplot_mosaic(mosaic, *, subplot_kw=None, gridspec_kw=None, empty_sentinel='.')

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

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

Примечание

Этот API предварительный и может быть пересмотрен в будущем на основе отзывов ранних пользователей.

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

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

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

Создает 4 оси:

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

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

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

'''
AAE
C.E
'''

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

'AB;CC'

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

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

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

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

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

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

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

Возвращает:
dict[метка, ось]

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

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, subplot_kw=None, gridspec_kw=None)

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

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

Параметры:
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.
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 a 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)

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

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

Параметры:
leftfloat, необязательно

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

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

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

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

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

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

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

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

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

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

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

suptitle(t, **kwargs)

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

Параметры:
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)

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

Параметры:
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.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.

supylabel(t, **kwargs)

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

Параметры:
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.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.

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

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

Параметры:
x, yfloat

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

sstr

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

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

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

Возвращает:
Text
Другие параметры:
**kwargsText свойства

Другие различные параметры текста.

Свойство Описание
agg_filter функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha скаляр или None
animated bool
backgroundcolor цвет
bbox словарь свойств для patches.FancyBboxPatch
clip_box Bbox
clip_on bool
clip_path Объект Patch или (Path, Transform) или None
color или c цвет
contains неизвестно
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 строка
horizontalalignment или ha {'center', 'right', 'left'}
in_layout bool
label объект
linespacing число (кратное размеру шрифта)
math_fontfamily строка
multialignment или ma {'left', 'right', 'center'}
path_effects AbstractPathEffect
picker None или bool или число или вызываемая функция
position (число, число)
rasterized bool
rotation число или {'vertical', 'horizontal'}
rotation_mode {None, 'default', 'anchor'}
sketch_params (scale: число, length: число, randomness: число)
snap bool или None
text объект
transform Transform
transform_rotates_text bool
url строка
usetex bool или None
verticalalignment или va {'center', 'top', 'bottom', 'baseline', 'center_baseline'}
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) для этого объекта.

Параметры:
padfloat, по умолчанию: 1.08

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

h_pad, w_padfloat, по умолчанию: pad

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

rectкортеж (left, bottom, right, top), по умолчанию: (0, 0, 1, 1)

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

См. также

Figure.set_tight_layout
pyplot.tight_layout
update(props)

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

Параметры:
propsсловарь
update_from(other)

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

waitforbuttonpress(timeout=- 1)[source]

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

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

zorder = 0
class matplotlib.figure.FigureBase[source]

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

add_artist(artist, clip=False)[source]

Добавление Artist в фигуру.

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

Параметры:
artistArtist

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

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

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

Возвращает:
Artist

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

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

Добавление оси в фигуру.

Вызовы:

add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)
Параметры:
rectпоследовательность чисел с плавающей точкой

Размеры [лево, низ, ширина, высота] новой оси. Все значения заданы в долях ширины и высоты фигуры.

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

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

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

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

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

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

sharex, shareyAxes, optional

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

labelstr

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

Возвращает:
Axes, или подкласс Axes

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

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

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

Свойство Описание
adjustable {'box', 'datalim'}
agg_filter функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha скаляр или None
anchor 2-кортеж чисел с плавающей точкой или {'C', 'SW', 'S', 'SE', ...}
animated bool
aspect {'auto', 'equal'} или float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
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
contains неизвестно
facecolor или fc цвет
figure Figure
frame_on bool
gid строка
in_layout bool
label объект
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
title строка
transform Transform
url строка
visible bool
xbound неизвестно
xlabel строка
xlim (bottom: float, top: float)
xmargin float больше -0.5
xscale {"linear", "log", "symlog", "logit", ...} или ScaleBase
xticklabels неизвестно
xticks неизвестно
ybound неизвестно
ylabel строка
ylim (нижняя: float, верхняя: float)
ymargin число, большее -0,5
yscale {"линейный", "логарифмический", "симлогический", "логит", ...} или ScaleBase
yticklabels неизвестно
yticks неизвестно
zorder float

См. также

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)

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

Параметры:
funccallable

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

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

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

Возвращает:
figure.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 подграфика, уже созданным в текущем рисунке, но не в списке 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.

Возвращаемое значение:
axes.SubplotBase, или другой подкласс Axes

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

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

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

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

См. также

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 позиции соответствуют позициям на рисунке.

Примеры

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

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 позиции соответствуют позициям на рисунке.

Примеры

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

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.

Параметры:
bottomfloat, по умолчанию: 0.2

Нижняя часть подграфиков для subplots_adjust.

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

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

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

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

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

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

property axes

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

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

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

Параметры:
mappable

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

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

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
caxAxes, необязательно

Ось, на которой будет нарисована полоса цвета.

axAxes, список осей, необязательно

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

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

Если cax None, новая cax создается как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec True, cax создается как экземпляр Subplot с использованием модуля gridspec.

Возвращает:
colorbarColorbar

См. также его базовый класс ColorbarBase.

Примечания

Дополнительные ключевые аргументы бывают двух видов:

свойства осей:

locationNone или {'left', 'right', 'top', 'bottom'}
Положение, относительно родительской оси, где создается ось полосы цвета. Оно также определяет ориентацию полосы цвета (полосы цвета слева и справа вертикальные, полосы цвета сверху и снизу горизонтальные). Если 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', длина, длины} Если установлено None, минимальное и максимальное треугольные расширения полосы цвета будут иметь длину 5% от длины внутренней полосы цвета (это значение по умолчанию). Если установлено 'auto', создает треугольные расширения полосы цвета той же длины, что и внутренние прямоугольники (когда spacing установлено 'uniform') или той же длины, что и соответствующие соседние внутренние прямоугольники (когда spacing установлено 'proportional'). Если число, указывает длину минимального и максимального треугольных расширений полосы цвета как долю от длины внутренней полосы цвета. Также может быть задана последовательность из двух элементов, указывающая длину минимального и максимального расширений полосы цвета, соответственно, как долю от длины внутренней полосы цвета.
extendrect bool Если False, минимальные и максимальные расширения полосы цвета будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing {'uniform', 'proportional'} При равномерном распределении каждый дискретный цвет занимает одинаковое пространство; при пропорциональном - пространство пропорционально интервалу данных.
ticks None или список меток или локатор Если None, метки определяются автоматически из ввода.
format None или str или Formatter Если None, используется ScalarFormatter. Если задана строка форматирования, например, '%.3f', она используется. Вместо этого может быть задан альтернативный Formatter.
drawedges bool Выводить ли линии на границах цветов.
label str Подпись по длинной оси полосы цвета.

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

Свойство Описание
boundaries None или последовательность
values None или последовательность, длина которой на 1 меньше последовательности boundaries. Для каждого региона, ограниченного соседними значениями в boundaries, будет использоваться цвет, сопоставленный с соответствующим значением в values.

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

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

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

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

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

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

contains(mouseevent)[source]

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

Возвращает:
bool, {}
convert_xunits(x)

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

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

convert_yunits(y)

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

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

delaxes(ax)[source]

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

draw(renderer, *args, **kwargs)

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

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

Параметры:
rendererRendererBase подкласс.

Примечания

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

findobj(match=None, include_self=True)

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

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

Параметры:
match

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

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

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

Возвращает:
список Artist
format_cursor_data(data)

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

Примечание

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

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

См. также

get_cursor_data
свойство frameon

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

gca(**kwargs)[source]

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

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

Свойство Описание
adjustable {'box', 'datalim'}
agg_filter функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3)
alpha скаляр или None
anchor 2-кортеж чисел с плавающей точкой или {'C', 'SW', 'S', 'SE', ...}
animated булево значение
aspect {'auto', 'equal'} или число с плавающей точкой
autoscale_on булево значение
autoscalex_on булево значение
autoscaley_on булево значение
axes_locator Вызываемый объект [[Axes, Renderer], Bbox]
axisbelow булево значение или 'line'
box_aspect число с плавающей точкой или None
clip_box Bbox
clip_on булево значение
clip_path Объект Patch или (Path, Transform) или None
contains неизвестно
facecolor или fc цвет
figure Figure
frame_on булево значение
gid строка
in_layout булево значение
label объект
navigate булево значение
navigate_mode неизвестно
path_effects AbstractPathEffect
picker None или булево значение или число с плавающей точкой или вызываемый объект
position [left, bottom, width, height] или Bbox
prop_cycle неизвестно
rasterization_zorder число с плавающей точкой или None
rasterized булево значение
sketch_params (scale: float, length: float, randomness: float)
snap булево значение или None
title строка
transform Transform
url строка
visible булево значение
xbound неизвестно
xlabel строка
xlim (bottom: float, top: float)
xmargin число с плавающей точкой, большее чем -0.5
xscale {"linear", "log", "symlog", "logit", ...} или ScaleBase
xticklabels неизвестно
xticks неизвестно
ybound неизвестно
ylabel строка
ylim (нижняя граница: число с плавающей точкой, верхняя граница: число с плавающей точкой)
ymargin число больше -0,5
yscale {"линейная", "логарифмическая", "симлогирифмическая", "логистическая", ...} или ScaleBase
yticklabels неизвестно
yticks неизвестно
zorder число с плавающей точкой
get_agg_filter()

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

get_alpha()

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

get_animated()

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

get_children()[source]

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

get_clip_box()

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

get_clip_on()

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

get_clip_path()

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

get_contains()

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

См. также

set_contains

Примечания

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

get_cursor_data(event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data
get_default_bbox_extra_artists()[source]
get_edgecolor()[source]

Получить цвет обводки прямоугольника фигуры.

get_facecolor()[source]

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

get_figure()

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

get_frameon()[source]

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

get_gid()

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

get_in_layout()

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

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

get_label()

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

get_linewidth()[source]

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

get_path_effects()
get_picker()

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

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

См. также

set_picker, pickable, pick
get_rasterized()

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

get_sketch_params()

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

Возвращает:
кортеж или None

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

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

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

get_snap()

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

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

get_tightbbox(renderer, bbox_extra_artists=None)[source]

Возвращает (внутреннюю) ограничивающую рамку фигуры в дюймах.

Объекты, у которых artist.set_in_layout(False) не включены в ограничивающую рамку.

Параметры:
rendererподкласс RendererBase

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

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

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

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

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

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_url()

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

get_visible()

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

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

Возвращает ограничивающую рамку фигуры в пространстве отображения. Аргументы игнорируются.

get_zorder()

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

have_units()

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

is_transform_set()

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

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

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

Размещает легенду на фигуре.

Подписи вызовов:

legend()
legend(labels)
legend(handles, 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, (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'])

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

3. Явное определение элементов в легенде

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

fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])
Параметры:
handlesсписок Artist, необязательно

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

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

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

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

Возвращает:
Legend
Другие параметры:
locстрока или пара чисел с плавающей точкой, по умолчанию: rcParams["legend.loc"] (по умолчанию: 'best') ('best' для осей, 'верхний правый' для фигур)

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

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

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

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

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

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

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

Расположение (строка) Код расположения
'best' 0
'верхний правый' 1
'верхний левый' 2
'нижний левый' 3
'нижний правый' 4
'правый' 5
'центр слева' 6
'центр справа' 7
'нижний центр' 8
'верхний центр' 9
'центр' 10
bbox_to_anchorBboxBase, 2-кортеж или 4-кортеж чисел с плавающей точкой

Прямоугольник, используемый для позиционирования легенды совместно с 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)
ncolцелое число, по умолчанию: 1

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

propNone или matplotlib.font_manager.FontProperties или словарь

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

fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

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

labelcolorстрока или список

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

numpointsцелое число, по умолчанию: rcParams["legend.numpoints"] (по умолчанию: 1)

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

scatterpointsцелое число, по умолчанию: rcParams["legend.scatterpoints"] (по умолчанию: 1)

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

scatteryoffsetsитерируемый список чисел с плавающей точкой, по умолчанию: [0.375, 0.5, 0.3125]

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

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

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

markerfirstбулево значение, по умолчанию: True

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

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

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

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

Определяет, следует ли включить закругленные углы вокруг FancyBboxPatch, которые составляют фон легенды.

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

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

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

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

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

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

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

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

mode{"expand", None}

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

bbox_transformNone или matplotlib.transforms.Transform

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

titleстрока или None

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

title_fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, по умолчанию: rcParams["legend.title_fontsize"] (по умолчанию: None)

Размер шрифта заголовка легенды.

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

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

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

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

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

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

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

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

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

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

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

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

handler_mapсловарь или None

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

См. также

Axes.legend

Примечания

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

свойствоmouseover

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

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

pchanged()

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

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

См. также

add_callback
remove_callback
pick(mouseevent)

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

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

См. также

set_picker, get_picker, pickable
pickable()

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

См. также

set_picker, get_picker, pick
properties()

Возвращает словарь всех свойств элемента изображения.

remove()

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

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

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

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

remove_callback(oid)

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

См. также

add_callback
sca(a)[source]

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

set(**kwargs)

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

set_agg_filter(filter_func)

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

Параметры:
filter_funccallable

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

set_alpha(alpha)

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

Параметры:
alphaскаляр или None

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

set_animated(b)

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

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

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

Параметры:
bbool
set_clip_box(clipbox)

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

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

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

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

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

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

Параметры:
pathPatch или Path или TransformedPath или None

Область обрезки. Если задан Path, transform также должен быть задан. Если None, ранее установленная область обрезки удаляется.

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

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

Примечания

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

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

set_contains(picker)

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

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

Параметры:
pickercallable

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

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

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

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

Примечания

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

set_edgecolor(color)[source]

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

Параметры:
colorцвет
set_facecolor(color)[source]

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

Параметры:
colorцвет
set_figure(fig)

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

Параметры:
figFigure
set_frameon(b)[source]

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

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

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

Параметры:
gidstr
set_in_layout(in_layout)

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

Параметры:
in_layoutbool
set_label(s)

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

Параметры:
sобъект

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

set_linewidth(linewidth)[source]

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

Параметры:
linewidthчисло
set_path_effects(path_effects)

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

Параметры:
path_effectsAbstractPathEffect
set_picker(picker)

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

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

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

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

    hit, props = picker(artist, mouseevent)
    

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

set_rasterized(rasterized)

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

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

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

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

Параметры:
rasterizedbool
set_sketch_params(scale=None, length=None, randomness=None)

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

Параметры:
scalefloat, необязательно

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

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

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

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

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

set_snap(snap)

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

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

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

Параметры:
snapbool или None

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

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

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

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

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

Параметры:
urlstr
set_visible(b)

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

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

Установить z-порядок элемента. Элементы с меньшим z-порядком рисуются первыми.

Параметры:
levelfloat
property stale

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

property sticky_edges

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

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

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

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
subfigures(nrows=1, ncols=1, squeeze=True, wspace=None, hspace=None, width_ratios=None, height_ratios=None, **kwargs)[source]

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

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

Параметры:
nrows, ncolsint, по умолчанию: 1

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

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

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

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

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

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

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

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

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

subplot_mosaic(mosaic, *, subplot_kw=None, gridspec_kw=None, empty_sentinel='.')[source]

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

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

Примечание

Этот API предварительный и может быть пересмотрен в будущем на основе ранней обратной связи пользователей.

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

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

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

Создает 4 оси:

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

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

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

'''
AAE
C.E
'''

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

'AB;CC'

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

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

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

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

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

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

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

Возвращает:
словарь[метка, ось]

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

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, 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.
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 a 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

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

supxlabel(t, **kwargs)[source]

Добавить центрированный подзаголовок по оси X к рисунку.

Параметры:
tstr

Текст подзаголовка по оси X.

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.titlesize"] (по умолчанию: 'large')

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

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

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

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

Экземпляр Text подзаголовка по оси X.

Дополнительные параметры:
fontpropertiesNone или dict, необязательно

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

**kwargs

Дополнительные kwargs — свойства matplotlib.text.Text.

supylabel(t, **kwargs)[source]

Добавить центрированный подзаголовок по оси Y к рисунку.

Параметры:
tstr

Текст подзаголовка по оси Y.

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.titlesize"] (по умолчанию: 'large')

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

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

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

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

Экземпляр Text подзаголовка по оси Y.

Дополнительные параметры:
fontpropertiesNone или dict, необязательно

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

**kwargs

Дополнительные 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 функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha скаляр или None
animated bool
backgroundcolor цвет
bbox словарь свойств для patches.FancyBboxPatch
clip_box Bbox
clip_on bool
clip_path Patch или (Path, Transform) или None
color или c цвет
contains неизвестно
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 строка
horizontalalignment или ha {'center', 'right', 'left'}
in_layout bool
label объект
linespacing числовое значение (кратное размеру шрифта)
math_fontfamily строка
multialignment или ma {'left', 'right', 'center'}
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 строка
usetex bool или None
verticalalignment или va {'center', 'top', 'bottom', 'baseline', 'center_baseline'}
visible bool
wrap bool
x число с плавающей запятой
y число с плавающей запятой
zorder float

См. также

Axes.text
pyplot.text
update(props)

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

Параметры:
propsdict
update_from(other)

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

zorder = 0
класс matplotlib.figure.SubFigure(parent, subplotspec, *, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None)[source]

Логическая фигура, которая может быть размещена внутри фигуры.

Обычно создаётся с помощью Figure.add_subfigure или SubFigure.add_subfigure, или SubFigure.subfigures. Подфигура имеет те же методы, что и фигура, за исключением тех, которые связаны с размером или разрешением dpi фигуры, и ограничена заданной областью фигуры. Например, следующее помещает две подфигуры рядом друг с другом:

fig = plt.figure()
sfigs = fig.subfigures(1, 2)
axsL = sfigs[0].subplots(1, 2)
axsR = sfigs[1].subplots(2, 1)

См. Подфигуры в фигурах

Параметры:
parentfigure.Figure или figure.SubFigure

Фигура или подфигура, содержащая SubFigure. Подфигуры могут быть вложены.

subplotspecgridspec.SubplotSpec

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

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

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

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

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

linewidthfloat

Толщина линии рамки (т.е. толщина линии границы области фигуры).

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

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

add_artist(artist, clip=False)

Добавление Artist к фигуре.

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

Параметры:
artistArtist

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

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

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

Возвращает:
Artist

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

add_axes(*args, **kwargs)

Добавление Axes к фигуре.

Подписи:

add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)
Параметры:
rectпоследовательность float

Размеры [левый, нижний, ширина, высота] нового 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. Ключевые аргументы для класса прямолинейных осей Axes можно найти в следующей таблице, но также могут быть другие ключевые аргументы, если используется другая проекция, см. фактический класс осей.

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

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

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

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

def func(artist: Artist) -> Any

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

Возвращает:
целое число

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

См. также

remove_callback
add_gridspec(nrows=1, ncols=1, **kwargs)

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

Параметры:
nrowsцелое число, по умолчанию: 1

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

ncolsцелое число, по умолчанию: 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)

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

Параметры:
subplotspecgridspec.SubplotSpec

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

Возвращает:
figure.SubFigure
Другие параметры:
**kwargs

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

См. также

Figure.subfigures
add_subplot(*args, **kwargs)

Добавить 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, default: False

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

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

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

sharex, shareyAxes, optional

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

labelstr

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

Возвращаемое значение:
axes.SubplotBase, или другой подкласс Axes

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

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

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

Свойство Описание
adjustable {'box', 'datalim'}
agg_filter функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha скаляр или None
anchor 2-кортеж чисел с плавающей точкой или {'C', 'SW', 'S', 'SE', ...}
animated логическое значение
aspect {'auto', 'equal'} или число с плавающей точкой
autoscale_on логическое значение
autoscalex_on логическое значение
autoscaley_on логическое значение
axes_locator Вызываемый объект [[Axes, Renderer], Bbox]
axisbelow логическое значение или 'line'
box_aspect число с плавающей точкой или None
clip_box Bbox
clip_on логическое значение
clip_path объект Patch или (Path, Transform) или None
contains неизвестно
facecolor или fc цвет
figure Figure
frame_on логическое значение
gid строка
in_layout логическое значение
label объект
navigate логическое значение
navigate_mode неизвестно
path_effects AbstractPathEffect
picker None или логическое значение или число с плавающей точкой или вызываемый объект
position [left, bottom, width, height] или Bbox
prop_cycle неизвестно
rasterization_zorder число с плавающей точкой или None
rasterized логическое значение
sketch_params (scale: float, length: float, randomness: float)
snap логическое значение или None
title строка
transform Transform
url строка
visible логическое значение
xbound неизвестно
xlabel строка
xlim (нижняя граница: float, верхняя граница: float)
xmargin число с плавающей точкой, большее чем -0.5
xscale {"линейный", "логарифмический", "симлогарифмический", "логит", ...} или ScaleBase
xticklabels неизвестно
xticks неизвестно
ybound неизвестно
ylabel строка
ylim (нижняя: float, верхняя: float)
ymargin число, больше -0,5
yscale {"линейный", "логарифмический", "симлогирифмический", "логит", ...} или ScaleBase
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)

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

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

Параметры:
axsсписок Axes

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

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels
align_xlabels(axs=None)

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

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

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

Параметры:
axsсписок Axes

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

См. также

matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_labels

Примечания

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

Примеры

Пример с метками делений оси x, повернутыми на 90 градусов:

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)

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

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

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

Параметры:
axsсписок Axes

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

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_labels

Примечания

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

Примеры

Пример с большими метками делений оси y:

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

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

Параметры:
bottomfloat, по умолчанию: 0,2

Нижняя часть подграфиков для subplots_adjust.

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

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

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

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

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

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

свойствоaxes

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

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

colorbar(mappable, cax=None, ax=None, use_gridspec=True, **kw)

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

Параметры:
mappable

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

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

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
caxAxes, необязательно

Ось, на которой будет нарисована полоса цвета.

axAxes, список осей, необязательно

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

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

Если cax None, новая cax создаётся как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec True, cax создаётся как экземпляр Subplot с использованием модуля gridspec.

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

См. также его базовый класс ColorbarBase.

Примечания

Дополнительные ключевые аргументы бывают двух типов:

свойства осей:

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'). Если скаляр, указывает длину минимального и максимального треугольных расширений полосы цвета как долю длины внутренней полосы цвета. Может быть задана последовательность из двух элементов, указывающая длины минимального и максимального расширений полосы цвета соответственно как долю длины внутренней полосы цвета.
extendrect bool Если False минимальные и максимальные расширения полосы цвета будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing {'uniform', 'proportional'} Uniform spacing gives each discrete color the same space; proportional makes the space proportional to the data interval.
ticks None или список делений или Locator Если None, деления определяются автоматически из входных данных.
format None или str или Formatter Если None, используется ScalarFormatter. Если задана строка формата, например, '%.3f', она используется. Вместо этого может быть задан альтернативный Formatter.
drawedges bool Рисовать ли линии на границах цветов.
label str Подпись по длинной оси полосы цвета.

Следующее, вероятно, будет полезно только в контексте индексированных цветов (то есть, когда mappable имеет norm=NoNorm()) или в других необычных обстоятельствах.

Свойство Описание
boundaries None или последовательность
values None или последовательность, которая должна быть длиной на 1 меньше, чем последовательность boundaries. Для каждого региона, ограниченного соседними элементами в boundaries, будет использоваться цвет, сопоставленный с соответствующим значением в values.

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

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

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

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

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

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

contains(mouseevent)

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

Возвращаемое значение:
bool, {}
convert_xunits(x)

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

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

convert_yunits(y)

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

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

delaxes(ax)

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

свойство dpi
draw(renderer)[source]

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

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

Параметры:
rendererRendererBase подкласс.

Примечания

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

findobj(match=None, include_self=True)

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

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

Параметры:
match

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

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

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

Возвращает:
список Artist
format_cursor_data(data)

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

Примечание

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

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

См. также

get_cursor_data
свойство frameon

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

gca(**kwargs)

Получить текущую ось, создав её, если необходимо.

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

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

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

get_alpha()

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

get_animated()

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

get_axes()[source]

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

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

Примечание: это эквивалентно свойству axes.

get_children()

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

get_clip_box()

Возвращает ограничивающую рамку.

get_clip_on()

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

get_clip_path()

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

get_constrained_layout()[source]

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

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

get_constrained_layout_pads(relative=False)[source]

Получить отступы для constrained_layout.

Возвращает список отступов в дюймах и w_pad, h_pad, wspace и hspace в виде дробей от подграфика.

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

Параметры:
relativebool

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

get_contains()

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

См. также

set_contains

Примечания

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

get_cursor_data(event)

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

Примечание

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

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

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

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

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

См. также

format_cursor_data
get_default_bbox_extra_artists()
get_edgecolor()

Получить цвет границы прямоугольника Figure.

get_facecolor()

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

get_figure()

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

get_frameon()

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

get_gid()

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

get_in_layout()

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

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

get_label()

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

get_linewidth()

Получить ширину линии прямоугольника Figure.

get_path_effects()
get_picker()

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

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

См. также

set_picker, pickable, pick
get_rasterized()

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

get_sketch_params()

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

Возвращает:
кортеж или None

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

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

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

get_snap()

Возвращает установку snap.

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

get_tightbbox(renderer, bbox_extra_artists=None)

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

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

Параметры:
rendererподкласс RendererBase

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

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

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

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

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

get_transform()

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

get_transformed_clip_path_and_affine()

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

get_url()

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

get_visible()

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

get_window_extent(*args, **kwargs)

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

get_zorder()

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

have_units()

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

init_layoutgrid()[source]

Инициализирует layoutgrid для использования в constrained_layout.

is_transform_set()

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

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

legend(*args, **kwargs)

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

Вызовы:

legend()
legend(labels)
legend(handles, 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, (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'])

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

3. Явное определение элементов в легенде

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

fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])
Параметры:
handlesсписок Artist, необязательно

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

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

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

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

Возвращает:
Legend
Другие параметры:
locстрока или пара чисел с плавающей точкой, по умолчанию: rcParams["legend.loc"] (по умолчанию: 'best') ('best' для осей, 'верхний правый' для фигур)

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

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

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

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

Строка 'best' помещает легенду в расположение, среди девяти определённых ранее, с минимальным перекрытием с другими отрисованными элементами. Этот вариант может быть довольно медленным для графиков с большим объёмом данных; скорость построения графиков может улучшиться, если указать конкретное расположение.

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

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

Строка расположения Код расположения
'best' 0
'верхний правый' 1
'верхний левый' 2
'нижний левый' 3
'нижний правый' 4
'правый' 5
'центр слева' 6
'центр справа' 7
'нижний центр' 8
'верхний центр' 9
'центр' 10
bbox_to_anchorBboxBase, 2-кортеж или 4-кортеж чисел с плавающей точкой

Прямоугольник, используемый для позиционирования легенды в сочетании с 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)
ncolцелое число, по умолчанию: 1

Количество столбцов в легенде.

propNone или matplotlib.font_manager.FontProperties или словарь

Свойства шрифта легенды. Если None (по умолчанию), будут использоваться текущие значения matplotlib.rcParams.

fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

Размер шрифта легенды. Если значение числовое, размер будет абсолютным размером шрифта в пунктах. Строчные значения относятся к текущему размеру шрифта по умолчанию. Этот аргумент используется только если prop не задан.

labelcolorстрока или список

Цвет текста в легенде. Либо допустимая строка цвета (например, 'red'), либо список строк цвета. Цвет метки также может быть настроен для соответствия цвету линии или маркера, используя 'linecolor', 'markerfacecolor' (или 'mfc') или 'markeredgecolor' (или 'mec').

numpointsцелое число, по умолчанию: rcParams["legend.numpoints"] (по умолчанию: 1)

Количество точек маркера в легенде при создании записи легенды для Line2D (линия).

scatterpointsцелое число, по умолчанию: rcParams["legend.scatterpoints"] (по умолчанию: 1)

Количество точек маркера в легенде при создании записи легенды для PathCollection (график рассеяния).

scatteryoffsetsитерируемый список чисел с плавающей точкой, по умолчанию: [0.375, 0.5, 0.3125]

Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для записи легенды графика рассеяния. 0.0 — внизу текста легенды, 1.0 — вверху. Чтобы разместить все маркеры на одной высоте, установите значение [0.5].

markerscaleчисло с плавающей точкой, по умолчанию: rcParams["legend.markerscale"] (по умолчанию: 1.0)

Относительный размер маркеров легенды по сравнению с исходно нарисованными.

markerfirstбулево значение, по умолчанию: True

Если True, маркер легенды размещается слева от метки легенды. Если False, маркер легенды размещается справа от метки легенды.

frameonбулево значение, по умолчанию: rcParams["legend.frameon"] (по умолчанию: True)

Определяет, должна ли легенда быть нарисована на области (рамке).

fancyboxбулево значение, по умолчанию: rcParams["legend.fancybox"] (по умолчанию: True)

Определяет, должны ли быть включены закругленные углы вокруг FancyBboxPatch, составляющей фон легенды.

shadowбулево значение, по умолчанию: rcParams["legend.shadow"] (по умолчанию: False)

Определяет, должна ли быть отрисована тень за легендой.

framealphaчисло с плавающей точкой, по умолчанию: rcParams["legend.framealpha"] (по умолчанию: 0.8)

Альфа-прозрачность фона легенды. Если shadow активирован и framealpha None, значение по умолчанию игнорируется.

facecolor"inherit" или цвет, по умолчанию: rcParams["legend.facecolor"] (по умолчанию: 'inherit')

Цвет фона легенды. Если "inherit", использовать rcParams["axes.facecolor"] (по умолчанию: 'white').

edgecolor"inherit" или цвет, по умолчанию: rcParams["legend.edgecolor"] (по умолчанию: '0.8')

Цвет границы области фона легенды. Если "inherit", использовать rcParams["axes.edgecolor"] (по умолчанию: 'black').

mode{"expand", None}

Если mode задано как "expand", легенда будет расширена по горизонтали для заполнения области осей (или bbox_to_anchor, если определяет размер легенды).

bbox_transformNone или matplotlib.transforms.Transform

Преобразование для прямоугольника (bbox_to_anchor). Для значения None (по умолчанию) будет использоваться преобразование осей transAxes.

titleстрока или None

Заголовок легенды. По умолчанию заголовок отсутствует (None).

title_fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, по умолчанию: rcParams["legend.title_fontsize"] (по умолчанию: None)

Размер шрифта заголовка легенды.

borderpadчисло с плавающей точкой, по умолчанию: rcParams["legend.borderpad"] (по умолчанию: 0.4)

Межстрочное расстояние внутри рамки легенды в единицах размера шрифта.

labelspacingчисло с плавающей точкой, по умолчанию: rcParams["legend.labelspacing"] (по умолчанию: 0.5)

Вертикальное расстояние между записями легенды в единицах размера шрифта.

handlelengthчисло с плавающей точкой, по умолчанию: rcParams["legend.handlelength"] (по умолчанию: 2.0)

Длина рукояток легенды в единицах размера шрифта.

handletextpadчисло с плавающей точкой, по умолчанию: rcParams["legend.handletextpad"] (по умолчанию: 0.8)

Отступ между рукояткой легенды и текстом в единицах размера шрифта.

borderaxespadчисло с плавающей точкой, по умолчанию: rcParams["legend.borderaxespad"] (по умолчанию: 0.5)

Отступ между осями и рамкой легенды в единицах размера шрифта.

columnspacingчисло с плавающей точкой, по умолчанию: rcParams["legend.columnspacing"] (по умолчанию: 2.0)

Расстояние между столбцами в единицах размера шрифта.

handler_mapсловарь или None

Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет словарь обработчиков по умолчанию, найденный в matplotlib.legend.Legend.get_legend_handler_map.

См. также

Axes.legend

Примечания

Некоторые объекты графических элементов не поддерживаются этой функцией. Подробности см. в Руководстве по легендам.

свойство mouseover

Если это свойство установлено в True, объект графического элемента будет запрошен для получения пользовательской информации контекста при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged()

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback
pick(mouseevent)

Обработка события выбора.

Каждый дочерний графический элемент будет генерировать событие выбора, если mouseevent находится над элементом, и у элемента установлена опция picker.

См. также

set_picker, get_picker, pickable
pickable()

Возвращает, можно ли выбрать объект графического элемента.

См. также

set_picker, get_picker, pick
properties()

Возвращает словарь всех свойств объекта графического элемента.

remove()

Удаляет объект графического элемента из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей используйте relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: удаление записи легенды объекта графического элемента не поддерживается.

remove_callback(oid)

Удаление обратного вызова на основе его идентификатора наблюдателя.

См. также

add_callback
sca(a)

Устанавливает текущую ось в a и возвращает a.

set(**kwargs)

Сеттер для пакетной установки свойств. Передайте kwargs для установки свойств.

set_agg_filter(filter_func)

Установка фильтра agg.

Параметры:
filter_funcвызываемый объект

Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi и возвращает массив float (m, n, 3).

set_alpha(alpha)

Установка значения альфа для смешивания — не поддерживается во всех бэкендах.

Параметры:
alphaскаляр или None

alpha должен быть в диапазоне от 0 до 1 включительно.

set_animated(b)

Установка значения, указывающего, предназначен ли объект графического элемента для использования в анимации.

Если True, объект графического элемента исключается из обычного рисования фигуры. Вам нужно явно вызвать Figure.draw_artist / Axes.draw_artist для объекта графического элемента. Этот подход используется для ускорения анимации с помощью блиттинга.

См. также matplotlib.animation и Ускорение рендеринга с помощью блиттинга.

Параметры:
bbool
set_clip_box(clipbox)

Устанавливает область обрезки объекта графического элемента Bbox.

Параметры:
clipboxBbox
set_clip_on(b)

Устанавливает, использует ли объект графического элемента обрезку.

При значении False объекты графических элементов будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:
bbool
set_clip_path(path, transform=None)

Установить обрезку для элемента.

Параметры:
pathPatch или Path или TransformedPath или None

Путь обрезки. Если указан Path, необходимо также указать transform. Если None, ранее установленный путь обрезки будет удалён.

transformTransform, необязательно

Используется только если path — Path, в этом случае предоставленный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path — Rectangle, этот метод установит прямоугольник обрезки и задаст путь обрезки как None.

По техническим причинам (поддержка set), в качестве единственного позиционного параметра также может быть задана пара (path, transform).

set_contains(picker)

[Устарело] Определить пользовательскую проверку попадания для элемента.

Предоставленная функция заменяет метод contains по умолчанию для элемента.

Параметры:
pickerфункция

Пользовательская функция для определения, находится ли событие внутри элемента. Функция должна иметь следующий вид:

def contains(artist: Artist, event: MouseEvent) -> bool, dict

и возвращать:

  • булево значение, указывающее, находится ли событие внутри элемента
  • словарь дополнительной информации. Словарь должен, по крайней мере, возвращать ту же информацию, что и реализация по умолчанию contains(), но может содержать дополнительную информацию.

Примечания

Устарело начиная с версии 3.3.

set_edgecolor(color)

Установить цвет границы прямоугольника Figure.

Параметры:
colorцвет
set_facecolor(color)

Установить цвет заливки прямоугольника Figure.

Параметры:
colorцвет
set_figure(fig)

Установить экземпляр Figure, к которому относится элемент.

Параметры:
figFigure
set_frameon(b)

Установить видимость фонового патча фигуры, то есть, будет ли отображаться фон фигуры. Эквивалентно Figure.patch.set_visible().

Параметры:
bbool
set_gid(gid)

Установить идентификатор (группы) элемента.

Параметры:
gidstr
set_in_layout(in_layout)

Установить, должен ли элемент учитываться в расчётах макета, например, Руководство по ограниченным макетам, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layoutbool
set_label(s)

Установить метку, которая будет отображаться в легенде.

Параметры:
sобъект

s будет преобразован в строку с помощью вызова str.

set_linewidth(linewidth)

Установить ширину линии прямоугольника Figure.

Параметры:
linewidthчисло
set_path_effects(path_effects)

Установить эффекты пути.

Параметры:
path_effectsAbstractPathEffect
set_picker(picker)

Определите поведение выбора для элемента.

Параметры:
pickerNone или bool или float или вызываемый объект

Это может быть одно из следующих:

  • None: Выбор отключён для этого элемента (по умолчанию).
  • Булево значение: Если True, то выбор включён, и элемент будет генерировать событие выбора, если курсор мыши находится над ним.
  • Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск в точках, и элемент будет генерировать событие, если его данные находятся в пределах допуска от события мыши. Для некоторых элементов, таких как линии и коллекции участков, элемент может предоставлять дополнительные данные событию выбора, например, индексы данных, находящихся в пределах допуска от события выбора.
  • Функция: Если picker — вызываемый объект, это пользовательская функция, определяющая, попадает ли элемент под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения попадания в область. Если курсор мыши находится над элементом, верните hit=True, и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_rasterized(rasterized)

Принудительно использовать растровый (битовое изображение) вывод для векторной графики.

Растровый вывод не поддерживается всеми элементами. Если вы попытаетесь включить это для элемента, который его не поддерживает, команда не окажет никакого влияния, и будет выведено предупреждение.

Эта настройка игнорируется для вывода на основе пикселей.

См. также Растризация для векторной графики.

Параметры:
rasterizedbool
set_sketch_params(scale=None, length=None, randomness=None)

Установить параметры наброска.

Параметры:
scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale None, или не предоставлено, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Множитель масштаба, с помощью которого длина уменьшается или увеличивается (по умолчанию 16.0)

set_snap(snap)

Настройка поведения привязки.

Привязка выравнивает положения с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в двух соседних позициях пикселей. В отличие от этого, привязка переместит линию к ближайшему целочисленному значению пикселя, так что результирующее изображение будет действительно содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:
snapbool или None

Возможные значения:

  • True: Привязать вершины к ближайшему центру пикселя.
  • False: Не изменять позиции вершин.
  • None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
set_transform(t)

Установить преобразование элемента.

Параметры:
tTransform
set_url(url)

Установить URL для элемента.

Параметры:
urlstr
set_visible(b)

Установить видимость элемента.

Параметры:
bbool
set_zorder(level)

Установить z-порядок элемента. Элементы с меньшим z-порядком рисуются первыми.

Параметры:
levelfloat
property stale

Является ли элемент 'неактуальным' и нуждается ли он в перерисовке для соответствия внутреннего состояния элемента.

property sticky_edges

x и y списки привязанных границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то не будет добавляться отступ — предел просмотра «прилипает» к краю. Типичным случаем использования являются гистограммы, где обычно не ожидается отступ на нижнем крае (0) гистограммы.

К этому атрибуту нельзя присваивать значения; однако списки x и y можно изменять по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
subfigures(nrows=1, ncols=1, squeeze=True, wspace=None, hspace=None, width_ratios=None, height_ratios=None, **kwargs)

Добавление подрисунка к этой фигуре или подрисунку.

Подрисунок имеет те же методы художника, что и фигура, и логически эквивалентен фигуре, но не может печатать сам себя. См. Подрисунки фигуры.

Параметры:
nrows, ncolsint, по умолчанию: 1

Количество строк/столбцов в сетке подрисунка.

squeezebool, по умолчанию: True

Если True, лишние измерения удаляются из возвращаемого массива подрисунков.

wspace, hspacefloat, по умолчанию: None

Количество ширины/высоты, зарезервированной для пространства между подрисунками, выраженное как доля от средней ширины/высоты подрисунка. Если не указано, значения будут выведены из фигуры или rcParams при необходимости.

width_ratiosмассив-подобный длины ncols, необязательно

Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не указано, все столбцы будут иметь одинаковую ширину.

height_ratiosмассив-подобный длины nrows, необязательно

Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не указано, все строки будут иметь одинаковую высоту.

subplot_mosaic(mosaic, *, subplot_kw=None, gridspec_kw=None, empty_sentinel='.')

Построение макета Осей на основе ASCII-искусства или вложенных списков.

Это вспомогательная функция для визуального построения сложных макетов GridSpec.

Примечание

Этот API является предварительным и может быть пересмотрен в будущем на основе ранней обратной связи пользователей.

Параметры:
mosaicсписок списков {хешируемых или вложенных} или строка

Визуальный макет того, как вы хотите расположить свои оси, помеченные строками. Например

x = [['A panel', 'A panel', 'edge'],
     ['C panel', '.',       'edge']]

Создает 4 оси:

  • 'A панель', которая имеет высоту 1 строка и занимает первые два столбца
  • 'edge', которая имеет высоту 2 строки и находится на правом краю
  • 'C панель', которая имеет ширину 1 строка и 1 столбец в нижнем левом углу
  • пустое место шириной 1 строка и 1 столбец в нижнем центре

Любой из элементов макета может быть списком списков той же формы для создания вложенных макетов.

Если вход — строка, она может быть либо многострочной строкой вида

'''
AAE
C.E
'''

где каждый символ является столбцом, а каждая строка — строкой. Или это может быть строка с одной строкой, где строки разделены ;:

'AB;CC'

Запись в виде строки допускает только метки осей из одного символа и не поддерживает вложенность, но является очень краткой.

subplot_kwсловарь, необязательно

Словарь с ключевыми словами, передаваемыми в вызов Figure.add_subplot, используемый для создания каждого подграфика.

gridspec_kwсловарь, необязательно

Словарь с ключевыми словами, передаваемыми конструктору GridSpec, используемому для создания сетки, на которой размещаются подграфики.

empty_sentinelобъект, необязательно

Элемент макета, обозначающий "оставьте это место пустым". По умолчанию '.'. Обратите внимание, что если layout является строкой, она обрабатывается через inspect.cleandoc для удаления начальных пробелов, что может помешать использовать пробелы как пустой символ.

Возвращает:
dict[метка, ось]

Словарь, сопоставляющий метки с объектами Оси. Порядок осей слева направо и сверху вниз от их положения в общем макете.

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, subplot_kw=None, gridspec_kw=None)

Добавить набор подграфиков к этой фигуре.

Эта утилитарная оболочка упрощает создание распространённых макетов подграфиков в одном вызове.

Параметры:
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.
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 a 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)

Настройка параметров макета подграфиков.

Неустановленные параметры остаются неизменными; начальные значения задаются rcParams["figure.subplot.[name]"].

Параметры:
leftfloat, необязательно

Положение левого края подграфиков, как доля ширины фигуры.

rightfloat, необязательно

Положение правого края подграфиков, как доля ширины фигуры.

bottomfloat, необязательно

Положение нижнего края подграфиков, как доля высоты фигуры.

topfloat, необязательно

Положение верхнего края подграфиков, как доля высоты фигуры.

wspacefloat, необязательно

Ширина отступа между подграфиками, как доля средней ширины Axes.

hspacefloat, необязательно

Высота отступа между подграфиками, как доля средней высоты Axes.

suptitle(t, **kwargs)

Добавить центрированный заголовок фигуры.

Параметры:
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)

Добавление центрированного надписи над графиком.

Параметры:
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.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.

supylabel(t, **kwargs)

Добавление центрированной подписи слева от графика.

Параметры:
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.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.

text(x, y, s, fontdict=None, **kwargs)

Добавление текста на график.

Параметры:
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 Bbox
clip_on bool
clip_path Объект Patch или (Path, Transform) или None
color или c цвет
contains неизвестно
figure Figure
fontfamily или family {FONTNAME, '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 строка
horizontalalignment или ha {'center', 'right', 'left'}
in_layout bool
label объект
linespacing число с плавающей точкой (кратное размеру шрифта)
math_fontfamily строка
multialignment или ma {'left', 'right', 'center'}
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 строка
usetex bool или None
verticalalignment или va {'center', 'top', 'bottom', 'baseline', 'center_baseline'}
visible bool
wrap bool
x число с плавающей точкой
y число с плавающей точкой
zorder float

См. также

Axes.text
pyplot.text
update(props)

Обновляет свойства этого элемента из словаря props.

Параметры:
propsdict
update_from(other)

Копирует свойства из other в self.

zorder = 0
class matplotlib.figure.SubplotParams(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.

update(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)[source]

Обновляет размеры переданных параметров. None означает без изменений.

matplotlib.figure.figaspect(arg)[source]

Вычисляет ширину и высоту фигуры с заданным соотношением сторон.

В то время как высота берется из rcParams["figure.figsize"] (по умолчанию: [6.4, 4.8]), ширина корректируется для соответствия желаемому соотношению сторон. Кроме того, гарантируется, что ширина находится в диапазоне [4., 16.], а высота — в диапазоне [2., 16.]. При необходимости, по умолчанию корректируется высота.

Параметры:
argfloat или 2D массив

Если float, это определяет соотношение сторон (т.е. отношение высота / ширина). В случае массива соотношение сторон — это число строк / число столбцов, так что массив можно было бы вписать в фигуру без искажения.

Возвращает:
width, heightfloat

Размер фигуры в дюймах.

Примечания

Если вы хотите создать область Axes внутри фигуры, которая все равно сохраняет соотношение сторон, обязательно создайте ее с одинаковой шириной и высотой. См. примеры ниже.

Спасибо Фернандо Пересу за эту функцию.

Примеры

Создайте фигуру, высота которой в два раза больше ширины:

w, h = figaspect(2.)
fig = Figure(figsize=(w, h))
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])
ax.imshow(A, **kwargs)

Создайте фигуру с правильным соотношением сторон для массива:

A = rand(5, 3)
w, h = figaspect(A)
fig = Figure(figsize=(w, h))
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])
ax.imshow(A, **kwargs)

© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/figure_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API