matplotlib.figure

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

Figure: Основной Artist, содержащий все элементы графика. Многие методы реализованы в FigureBase.
SubFigure: Логическая фигура внутри фигуры, обычно добавляется в фигуру (или родительскую SubFigure) с помощью методов Figure.add_subfigure или Figure.subfigures (временный API v3.4).
SubplotParams: Управление стандартным отступом между подграфиками.

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

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

Атрибуты:

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

Параметры:

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

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

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

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

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

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

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

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

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

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

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

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

subplotparsSubplotParams

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

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

Использовать ли механизм tight layout. См. set_tight_layout.

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

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

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

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

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

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

layout{'constrained', 'compressed', 'tight', LayoutEngine, None}

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

'constrained': решатель constrained layout изменяет размеры осей

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

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

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

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

END_OF_DOCUMENT_MARKER

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

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

add_artist(artist, clip=False)[source]

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

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

Параметры:

artistArtist: Элемент для добавления в рисунок. Если у добавленного элемента нет ранее установленного преобразования, его преобразование будет установлено в figure.transSubfigure.
clipbool, по умолчанию: False: Определяет, должен ли добавленный элемент обрезаться по области рисунка.

Возвращает:

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

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

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

Вызовы:

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

Параметры:

rectкортеж (left, bottom, width, height): Размеры (left, bottom, width, height) новой области Axes. Все величины выражены в долях ширины и высоты рисунка.
projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', строка}, необязательно: Тип проекции Axes. строка — имя пользовательской проекции, см. projections. По умолчанию None соответствует проекции 'rectilinear'.
polarbool, по умолчанию: False: Если True, эквивалентно projection='polar'.
axes_classподкласс Axes, необязательно: Подкласс axes.Axes, который будет создан. Этот параметр несовместим с projection и polar. См. axisartist для примеров.
sharex, shareyAxes, необязательно: Поделиться осью x или y с sharex и/или sharey. Ось будет иметь те же пределы, деления и масштаб, что и ось у общей оси.
labelстрока: Метка для возвращаемой области Axes.

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

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

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

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

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

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

См. также

Figure.add_subplot
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примечания

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

Примеры

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

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]: Всякий раз, когда изменяется состояние оси, func(self) будет вызвано.

add_callback(func)[source]

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

Возвращает:

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, если используется проекция rectilinear, и projections.polar.PolarAxes, если используется проекция polar. Возвращаемый Axes затем является подклассом подграфика базового класса.

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

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

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

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

См. также

Figure.add_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: Необязательный список (Axes) для выравнивания меток. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels

align_xlabels(axs=None)[source]

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

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

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

Параметры:

axsсписок Axes: Необязательный список 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: Необязательный список (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': Выбирает, какие метки повернуть.

свойствоaxes

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

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

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

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

clear(keep_observers=False)[source]

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

Параметры:

keep_observers: bool, по умолчанию: False: Установите keep_observers в значение True, если, например, виджет gui отслеживает оси в рисунке.

clf(keep_observers=False)[source]

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

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

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

Параметры:

keep_observers: bool, по умолчанию: False: Установите keep_observers в значение True, если, например, виджет gui отслеживает оси в рисунке.

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

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

Параметры:

mappable

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

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

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

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

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

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

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

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

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

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

colorbarColorbar

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

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', length, lengths}

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

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

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

extendrectbool

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

spacing{'uniform', 'proportional'}

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

ticksNone или список делений или Locator

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

formatNone или строка или Formatter

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

drawedgesbool

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

labelstr

Подпись по длинной оси цветовой шкалы.

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

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

Примечания

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

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

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

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

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

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

contains(mouseevent)[source]

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

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

bool, {}

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

delaxes(ax)[source]: Удалить Axes ax из графика; обновить текущую ось.

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

draw(renderer)[source]

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

Это не повлияет, если объект-график не виден (Artist.get_visible возвращает False).

Parameters:

rendererRendererBase подкласс.

Примечания

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

draw_artist(a)[source]: Отобразить только Artist a.

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

execute_constrained_layout(renderer=None)[source]

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

См. также set_constrained_layout_pads.

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

layoutgridприватный объект отладки

Примечания

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

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

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

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

Параметры:

X

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

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

xo, yoint

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

alphaNone или float

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

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

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

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

normstr или Normalize, необязательно

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

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

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

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

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

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

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

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

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

resizebool

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

Возвращает:

matplotlib.image.FigureImage

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

**kwargs: Дополнительные параметры kwargs передаются в Artist и используются в 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)[source]

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

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

Параметры:

match

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

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

include_selfbool

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

Возвращает:

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

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

gca()[source]

Получение текущих осей.

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

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

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

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

get_axes()[source]

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

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

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

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

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

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

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

get_constrained_layout()[source]

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

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

get_constrained_layout_pads(relative=False)[source]

[Устарело] Возвращает отступы для constrained_layout.

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

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

Parameters:

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

Notes

Deprecated since version 3.6: Используйте fig.get_layout_engine().get() вместо этого.

get_cursor_data(event)[source]

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

Примечание

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

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

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

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

Parameters:

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_default_bbox_extra_artists()[source]

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

get_edgecolor()[source]: Возвращает цвет рамки прямоугольника фигуры.

get_facecolor()[source]: Возвращает цвет заливки прямоугольника фигуры.

get_figheight()[source]: Возвращает высоту фигуры в дюймах.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_figwidth()[source]: Возвращает ширину фигуры в дюймах.

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

get_gid()[source]: Возвращает идентификатор группы.

get_in_layout()[source]

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

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

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

get_layout_engine()[source]

get_linewidth()[source]: Получить ширину линии прямоугольника фигуры.

get_mouseover()[source]: Возвращает, запрашивается ли у этого элемента графика информация о контексте при перемещении курсора мыши над ним.

get_path_effects()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

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

get_size_inches()[source]

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

Возвращает:

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

См. также

matplotlib.figure.Figure.set_size_inches
matplotlib.figure.Figure.get_figwidth
matplotlib.figure.Figure.get_figheight

Примечания

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

get_sketch_params()[source]

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

Возвращает:

кортеж или None

Кортеж из 3 элементов с указанными параметрами:

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

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

get_snap()[source]

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

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

get_tight_layout()[source]: Возвращает, вызывается ли tight_layout при отрисовке.

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

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

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

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

Параметры:

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

Возвращает:

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

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

get_transformed_clip_path_and_affine()[source]: Возвращает путь обрезки с примененной неаффинной частью его преобразования и оставшейся аффинной частью его преобразования.

get_url()[source]: Возвращает URL.

get_visible()[source]: Возвращает видимость.

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

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

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

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

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

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

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

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

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

Существует три возможных взаимодействия:

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

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

Параметры:

nint, по умолчанию: 1: Количество щелчков мышью для накопления. Если отрицательное, накапливает щелчки до тех пор, пока ввод не будет завершен вручную.
timeoutfloat, по умолчанию: 30 секунд: Количество секунд ожидания до истечения времени. Если ноль или отрицательное число, таймаут никогда не наступит.
show_clicksbool, по умолчанию: True: Если True, показывать красный крест в месте каждого щелчка.
mouse_addMouseButton или None, по умолчанию: MouseButton.LEFT: Кнопка мыши, используемая для добавления точек.
mouse_popMouseButton или None, по умолчанию: MouseButton.RIGHT: Кнопка мыши, используемая для удаления последней добавленной точки.
mouse_stopMouseButton или None, по умолчанию: MouseButton.MIDDLE: Кнопка мыши, используемая для остановки ввода.

Возвращает:

список кортежей: Список нажатых координат (x, y).

Примечания

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

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

is_transform_set()[source]

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

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

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

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

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

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

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

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

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

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

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

или:

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

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

2. Явное указание графических объектов и меток в легенде

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

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

3. Явное указание графических объектов в легенде

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

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

4. Подпись существующих элементов графика

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

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

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

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

Параметры:

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

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

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

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

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

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

Legend

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

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)

ncolsцелое число, по умолчанию: 1

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

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

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

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

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

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

labelcolorстрока или список, по умолчанию: rcParams["legend.labelcolor"] (по умолчанию: 'None').

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

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

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_fontpropertiesNone или matplotlib.font_manager.FontProperties или словарь

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

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

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

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

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

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

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

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

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

handlelengthfloat, default: rcParams["legend.handlelength"] (default: 2.0): Длина маркеров легенды, в единицах размера шрифта.
handleheightfloat, default: rcParams["legend.handleheight"] (default: 0.7): Высота маркеров легенды, в единицах размера шрифта.
handletextpadfloat, default: rcParams["legend.handletextpad"] (default: 0.8): Отступ между маркером легенды и текстом, в единицах размера шрифта.
borderaxespadfloat, default: rcParams["legend.borderaxespad"] (default: 0.5): Отступ между осями и границей легенды, в единицах размера шрифта.
columnspacingfloat, default: rcParams["legend.columnspacing"] (default: 2.0): Отступ между столбцами, в единицах размера шрифта.
handler_mapdict or None: Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет словарь стандартных обработчиков, расположенный по адресу matplotlib.legend.Legend.get_legend_handler_map.

См. также

Axes.legend

Примечания

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

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

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

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

remove()[source]

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

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

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

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

Вызов:

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

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

Параметры:

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

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

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

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

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

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

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

formatстрока

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

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

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

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

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

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

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

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

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

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

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

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

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

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

orientation{'landscape', 'portrait'}

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

papertypeстрока

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

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

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

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

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

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

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

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

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

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

sca(a)[source]: Установить текущую ось на a и вернуть a.

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

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

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

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

set_agg_filter(filter_func)[source]

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

Параметры:

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

set_alpha(alpha)[source]

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

Параметры:

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

set_animated(b)[source]

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

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

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

Параметры:

bbool

set_canvas(canvas)[source]

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

Параметры:

canvasFigureCanvas

set_clip_box(clipbox)[source]

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

Параметры:

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры:

bbool

set_clip_path(path, transform=None)[source]

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

Параметры:

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

Примечания

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

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

set_constrained_layout(constrained)[source]

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

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

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

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

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

Параметры:

constrainedbool или dict или None

Примечания

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

set_constrained_layout_pads(**kwargs)[source]

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

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

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

Параметры:

w_padfloat, по умолчанию: rcParams["figure.constrained_layout.w_pad"] (по умолчанию: 0.04167): Отступ по ширине в дюймах. Это отступ вокруг Oсей, предназначенный для обеспечения достаточного места для хорошего отображения шрифтов. По умолчанию 3 пункта = 0,04167 дюйма.
h_padfloat, по умолчанию: rcParams["figure.constrained_layout.h_pad"] (по умолчанию: 0.04167): Отступ по высоте в дюймах. По умолчанию 3 пункта.
wspacefloat, по умолчанию: rcParams["figure.constrained_layout.wspace"] (по умолчанию: 0.02): Отступ по ширине между подграфиками, выраженный как доля ширины подграфика. Общий отступ получается в результате w_pad + wspace.
hspacefloat, по умолчанию: rcParams["figure.constrained_layout.hspace"] (по умолчанию: 0.02): Отступ по высоте между подграфиками, выраженный как доля ширины подграфика. Общий отступ получается в результате h_pad + hspace.

Примечания

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

set_dpi(val)[source]

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

Параметры:

valfloat

set_edgecolor(color)[source]

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

Параметры:

colorцвет

set_facecolor(color)[source]

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

Параметры:

colorцвет

set_figheight(val, forward=True)[source]

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

Параметры:

valfloat
forwardbool: См. set_size_inches.

См. также

matplotlib.figure.Figure.set_figwidth
matplotlib.figure.Figure.set_size_inches

set_figure(fig)[source]

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

Параметры:

figFigure

set_figwidth(val, forward=True)[source]

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

Параметры:

valfloat
forwardbool: См. set_size_inches.

См. также

matplotlib.figure.Figure.set_figheight
matplotlib.figure.Figure.set_size_inches

set_frameon(b)[source]

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

Параметры:

bbool

set_gid(gid)[source]

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

Параметры:

gidstr

set_in_layout(in_layout)[source]

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

Параметры:

in_layoutbool

set_label(s)[source]

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

Параметры:

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

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

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

Параметры:

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

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

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

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

kwargs: dict

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

set_linewidth(linewidth)[source]

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

Параметры:

linewidthчисло

set_mouseover(mouseover)[source]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_path_effects(path_effects)[source]

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

Параметры:

path_effectsAbstractPathEffect

set_picker(picker)[source]

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

Параметры:

pickerNone или bool или float или callable

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

None: Выбор отключен для этого объекта (по умолчанию).
Булево значение: Если True, выбор будет включен, и объект сгенерирует событие выбора, если курсор мыши находится над объектом.
Число с плавающей точкой: Если picker является числом, оно интерпретируется как допустимая погрешность в пунктах, и объект сгенерирует событие, если его данные находятся в пределах погрешности от события мыши. Для некоторых объектов, таких как линии и коллекции фигур, объект может предоставить дополнительные данные в событие выбора, например, индексы данных в пределах погрешности от события выбора.
Функция: Если picker вызываемая, это пользовательская функция, которая определяет, попадает ли объект под курсор мыши:
```
hit, props = picker(artist, mouseevent)
```
чтобы определить проверку попадания. Если курсор мыши находится над объектом, возвращает hit=True и props - это словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_rasterized(rasterized)[source]

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

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

Эта настройка игнорируется для пиксельной графики.

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

Параметры:

rasterizedbool

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

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

Вызовы:

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

Параметры:

w(float, float) или float: Ширина и высота в дюймах (если высота не указана как отдельный аргумент) или ширина.
hfloat: Высота в дюймах.
forwardbool, по умолчанию: True: Если True, размер холста автоматически обновляется, например, вы можете изменить размер окна фигуры из командной строки.

См. также

matplotlib.figure.Figure.get_size_inches
matplotlib.figure.Figure.set_figwidth
matplotlib.figure.Figure.set_figheight

Примечания

Для преобразования из пикселей в дюймы разделите на Figure.dpi.

set_sketch_params(scale=None, length=None, randomness=None)[source]

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

Параметры:

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

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

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

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

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

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

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

set_snap(snap)[source]

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

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

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

Параметры:

snapbool или None

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

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

set_tight_layout(tight)[source]

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

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

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

Параметры:

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

Примечания

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

set_transform(t)[source]

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

Параметры:

tTransform

set_url(url)[source]

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

Параметры:

urlstr

set_visible(b)[source]

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

Параметры:

bbool

set_zorder(level)[source]

Установить zorder элемента. Элементы с меньшими значениями zorder рисуются первыми.

Параметры:

levelfloat

show(warn=True)[source]

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

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

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

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

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

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

Параметры:

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

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

propertysticky_edges

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

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

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

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

Примеры

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

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, *, sharex=False, sharey=False, width_ratios=None, height_ratios=None, empty_sentinel='.', subplot_kw=None, gridspec_kw=None)[source]

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

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

Примечание

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

См. Сложная и семантическая композиция рисунков для примера и полной документации 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'

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

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

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

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

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

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

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

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

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

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

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

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

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

Возвращает:

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

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

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

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

Параметры:

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

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

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

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

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

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

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

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

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

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

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

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, default: 0.5: Положение текста по оси x в координатах рисунка.
yfloat, default: 0.98: Положение текста по оси y в координатах рисунка.
horizontalalignment, ha{'center', 'left', 'right'}, default: center: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, default: top: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizedefault: rcParams["figure.titlesize"] (default: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightdefault: rcParams["figure.titleweight"] (default: 'normal'): Начертание шрифта текста. См. Text.set_weight для возможных значений.

Возвращает:

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

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

fontpropertiesNone or dict, optional: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.titlesize"] (default: 'large') и rcParams["figure.titleweight"] (default: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные параметры kwargs являются свойствами matplotlib.text.Text.

supxlabel(t, **kwargs)[source]

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

Параметры:

tstr: Текст нижнего заголовка.
xfloat, default: 0.5: Положение текста по оси x в координатах рисунка.
yfloat, default: 0.01: Положение текста по оси y в координатах рисунка.
horizontalalignment, ha{'center', 'left', 'right'}, default: center: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, default: bottom: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizedefault: rcParams["figure.labelsize"] (default: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightdefault: rcParams["figure.labelweight"] (default: 'normal'): Начертание шрифта текста. См. Text.set_weight для возможных значений.

Возвращает:

text: Экземпляр Text нижнего заголовка.

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

fontpropertiesNone or dict, optional: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.labelsize"] (default: 'large') и rcParams["figure.labelweight"] (default: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные параметры kwargs являются свойствами matplotlib.text.Text.

supylabel(t, **kwargs)[source]

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

Параметры:

tstr: Текст бокового заголовка.
xfloat, default: 0.02: Положение текста по оси x в координатах рисунка.
yfloat, default: 0.5: Положение текста по оси y в координатах рисунка.
horizontalalignment, ha{'center', 'left', 'right'}, default: left: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, default: center: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizedefault: rcParams["figure.labelsize"] (default: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightdefault: rcParams["figure.labelweight"] (default: 'normal'): Начертание шрифта текста. См. Text.set_weight для возможных значений.

Возвращает:

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

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

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

`x`	float
`y`	float
`zorder`	float

См. также

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

См. также

Figure.set_layout_engine
pyplot.tight_layout

update(props)[source]

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

Параметры:

propsсловарь

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

waitforbuttonpress(timeout=-1)[source]

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

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

zorder=0

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

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

add_artist(artist, clip=False)[source]

Добавить элемент Artist на график.

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

Параметры:

artistArtist: Элемент, который нужно добавить на график. Если у добавленного элемента нет предварительно установленного преобразования, его преобразование будет установлено в figure.transSubfigure.
clipbool, по умолчанию: False: Определяет, следует ли обрезать добавленный элемент по области графика.

Возвращает:

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

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

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

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

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

Параметры:

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

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

См. также

Figure.add_subplot
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примечания

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

Примеры

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

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

add_callback(func)[source]

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

Параметры:

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

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

def func(artist: Artist) -> Any

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

Возвращает:

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

См. также

remove_callback

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

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

Параметры:

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

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

Параметры:

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

Возвращает:

SubFigure

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

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

См. также

Figure.subfigures

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

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

Возможные подписи функций:

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

Параметры:

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

Положение подграфика, заданное одним из:

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

В редких случаях, add_subplot может быть вызвано с одним аргументом — экземпляром подграфика Axes, уже созданным в текущем графике, но не в списке 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`	(число, число) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	булево значение
`aspect`	{'auto', 'equal'} или число
`autoscale_on`	булево значение
`autoscalex_on`	неизвестно
`autoscaley_on`	неизвестно
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	булево значение или 'line'
`box_aspect`	число или None
`clip_box`	`Bbox`
`clip_on`	булево значение
`clip_path`	объект Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	булево значение
`gid`	строка
`in_layout`	булево значение
`label`	объект
`mouseover`	булево значение
`navigate`	булево значение
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или булево значение или число с плавающей точкой или вызываемый объект
`position`	[левое, нижнее, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	число с плавающей точкой или None
`rasterized`	булево значение
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	булево значение или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	булево значение
`xbound`	неизвестно
`xlabel`	строка
`xlim`	(нижняя граница: число, верхняя граница: число)
`xmargin`	число больше -0.5
`xscale`	неизвестно
`xticklabels`	неизвестно
`xticks`	неизвестно

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

См. также

Figure.add_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: Необязательный список (или массив) Axes для выравнивания меток. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels

align_xlabels(axs=None)[source]

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

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

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

Параметры:

axsсписок Axes: Необязательный список (или массив) 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: Необязательный список (или массив) 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 представляют даты. Метки часто длинные, и полезно их поворачивать в нижнем подграфике и отключать в других подграфиках, а также отключать метки оси x.

Параметры:

bottomfloat, по умолчанию: 0.2: Нижняя граница подграфиков для subplots_adjust.
rotationfloat, по умолчанию: 30 градусов: Угол поворота меток на оси x в градусах.
ha{'left', 'center', 'right'}, по умолчанию: 'right': Горизонтальное выравнивание меток на оси x.
which{'major', 'minor', 'both'}, по умолчанию: 'major': Выбирает метки, которые нужно повернуть.

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

clear(keep_observers=False)[source]

Очистить фигуру.

Параметры:

keep_observers: bool, по умолчанию: False: Установите keep_observers в значение True, если, например, виджет графического интерфейса отслеживает оси в фигуре.

clf(keep_observers=False)[source]

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

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

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

Параметры:

keep_observers: bool, по умолчанию: False: Установите keep_observers в значение True, если, например, виджет графического интерфейса отслеживает оси в фигуре.

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

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

Параметры:

mappable

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

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

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

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', length, lengths}

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

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

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

extendrectbool

spacing{'uniform', 'proportional'}

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

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

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

formatNone или строка или Formatter

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

drawedgesbool

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

labelstr

Метка по длинной оси цветовой шкалы.

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

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

Примечания

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

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

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

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

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

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

contains(mouseevent)[source]

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

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

bool, {}

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

delaxes(ax)[source]: Удалить Axes ax из фигуры; обновить текущую ось.

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

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

Найти объекты элементов управления.

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

Параметры:

match

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

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

include_selfbool

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

Возвращает:

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

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

gca()[source]

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

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

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

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

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

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

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

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

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

get_cursor_data(event)[source]

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

Примечание

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

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

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

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

Параметры:

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_default_bbox_extra_artists()[source]

get_edgecolor()[source]: Получить цвет обводки прямоугольника Figure.

get_facecolor()[source]: Получить цвет заливки прямоугольника Figure.

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

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

get_gid()[source]: Возвращает идентификатор группы.

get_in_layout()[source]

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

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

get_label()[source]: Возвращает метку, используемую для этого художника в легенде.

get_linewidth()[source]: Получить ширину линии прямоугольника Figure.

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

get_path_effects()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

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

get_sketch_params()[source]

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

Возвращает:

кортеж или None

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

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

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

get_snap()[source]

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

Подробнее см. set_snap.

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

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

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

Элементы, которые имеют artist.set_in_layout(False) не включаются в ограничивающий прямоугольник.

Параметры:

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())
bbox_extra_artistsсписок Artist или None: Список элементов, которые следует включить в плотное ограничивающее прямоугольник. Если None (по умолчанию), то все дочерние элементы каждого Axes включаются в плотное ограничивающее прямоугольник.

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

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

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

get_transformed_clip_path_and_affine()[source]: Возвращает обрезной путь с применённой частью преобразования, не зависящей от аффинных преобразований, и оставшейся аффинной частью преобразования.

get_url()[source]: Возвращает URL.

get_visible()[source]: Возвращает видимость.

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

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

Ширина и высота ограничивающего прямоугольника неотрицательны.

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

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

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

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

is_transform_set()[source]

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

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

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

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

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

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

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

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

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

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

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

или:

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

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

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

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

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

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

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

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

4. Подпись существующих элементов графика

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

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

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

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

Параметры:

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

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

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

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

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

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

Legend

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

locstr или пара чисел с плавающей точкой, по умолчанию: rcParams["legend.loc"] (по умолчанию: 'best') ('best' для осей, 'upper right' для фигур)

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

Строки '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
'upper right'	1
'upper left'	2
'lower left'	3
'lower right'	4
'right'	5
'center left'	6
'center right'	7
'lower center'	8
'upper center'	9
'center'	10

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)

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

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

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

propNone или matplotlib.font_manager.FontProperties или dict

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

fontsizeint или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

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

labelcolorstr или список, по умолчанию: rcParams["legend.labelcolor"] (по умолчанию: 'None')

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

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

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

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

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

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

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

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

markerscalefloat, по умолчанию: rcParams["legend.markerscale"] (по умолчанию: 1.0)

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

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

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

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

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

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

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

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

framealphafloat, по умолчанию: 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}

bbox_transformNone или matplotlib.transforms.Transform

titlestr или None

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

title_fontpropertiesNone или matplotlib.font_manager.FontProperties или dict

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

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

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

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

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

borderpadfloat, по умолчанию: rcParams["legend.borderpad"] (по умолчанию: 0.4)

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

labelspacingfloat, по умолчанию: rcParams["legend.labelspacing"] (по умолчанию: 0.5)

Вертикальное пространство между записями легенды, в единицах размера шрифта.
handlelengthfloat, значение по умолчанию: rcParams["legend.handlelength"] (значение по умолчанию: 2.0): Длина маркеров легенды, в единицах размера шрифта.
handleheightfloat, значение по умолчанию: rcParams["legend.handleheight"] (значение по умолчанию: 0.7): Высота маркеров легенды, в единицах размера шрифта.
handletextpadfloat, значение по умолчанию: rcParams["legend.handletextpad"] (значение по умолчанию: 0.8): Отступ между маркером легенды и текстом, в единицах размера шрифта.
borderaxespadfloat, значение по умолчанию: rcParams["legend.borderaxespad"] (значение по умолчанию: 0.5): Отступ между осями и рамкой легенды, в единицах размера шрифта.
columnspacingfloat, значение по умолчанию: rcParams["legend.columnspacing"] (значение по умолчанию: 2.0): Отступ между колонками, в единицах размера шрифта.
handler_mapdict или None: Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет словарь обработчиков по умолчанию, расположенный по адресу matplotlib.legend.Legend.get_legend_handler_map.

См. также

Axes.legend

Примечания

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

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

pchanged()[source]

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

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

См. также

add_callback
remove_callback

pick(mouseevent)[source]

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

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

См. также

set_picker, get_picker, pickable

pickable()[source]

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

См. также

set_picker, get_picker, pick

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

remove()[source]

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

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

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

remove_callback(oid)[source]

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

См. также

add_callback

sca(a)[source]: Устанавливает текущей осью a и возвращает a.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, frameon=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

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

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

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

set_agg_filter(filter_func)[source]

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

Parameters:

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

set_alpha(alpha)[source]

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

Parameters:

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

set_animated(b)[source]

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

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

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

Параметры:

bbool

set_clip_box(clipbox)[source]

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

Параметры:

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры:

bbool

set_clip_path(path, transform=None)[source]

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

Параметры:

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

Примечания

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

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

set_edgecolor(color)[source]

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

Параметры:

colorцвет

set_facecolor(color)[source]

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

Параметры:

colorцвет

set_figure(fig)[source]

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

Параметры:

figFigure

set_frameon(b)[source]

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

Параметры:

bbool

set_gid(gid)[source]

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

Параметры:

gidstr

set_in_layout(in_layout)[source]

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

Параметры:

in_layoutbool

set_label(s)[source]

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

Параметры:

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

set_linewidth(linewidth)[source]

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

Параметры:

linewidthчисло

set_mouseover(mouseover)[source]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_path_effects(path_effects)[source]

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

Параметры:

path_effectsAbstractPathEffect

set_picker(picker)[source]

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

Параметры:

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

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

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

set_rasterized(rasterized)[source]

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

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

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

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

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

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

Параметры:

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

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

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

Длина волнообразного движения по линии в пикселях (по умолчанию 128.0)

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

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

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

set_snap(snap)[source]

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

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

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

Параметры:

snapbool или None

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

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

set_transform(t)[source]

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

Параметры:

tTransform

set_url(url)[source]

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

Параметры:

urlstr

set_visible(b)[source]

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

Параметры:

bbool

set_zorder(level)[source]

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

Параметры:

levelfloat

propertystale: Указывает, является ли объект "недействительным" (stale) и нуждается ли он в перерисовке, чтобы выходные данные соответствовали внутреннему состоянию объекта.

propertysticky_edges

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

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

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

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

Примеры

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

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, *, sharex=False, sharey=False, width_ratios=None, height_ratios=None, empty_sentinel='.', subplot_kw=None, gridspec_kw=None)[source]

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

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

Примечание

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

См. Сложное и семантическое составление фигуры для примера и полной документации 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'

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры:

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

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

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

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

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

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

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

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

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

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

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

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

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

Возвращает:

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: Дополнительные параметры являются свойствами matplotlib.text.Text.

supxlabel(t, **kwargs)[source]

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

Параметры:

tstr: Текст надписи.
xfloat, по умолчанию: 0.5: Положение x текста в координатах рисунка.
yfloat, по умолчанию: 0.01: Положение y текста в координатах рисунка.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: bottom: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

Возвращает:

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

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

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

supylabel(t, **kwargs)[source]

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

Параметры:

tstr: Текст надписи.
xfloat, по умолчанию: 0.02: Положение x текста в координатах рисунка.
yfloat, по умолчанию: 0.5: Положение y текста в координатах рисунка.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: left: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: center: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

Возвращает:

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

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

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

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

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

Параметры:

x, yfloat: Позиция для размещения текста. По умолчанию, в координатах рисунка, числа в [0, 1]. Система координат может быть изменена с помощью ключевого слова transform.
sstr: Строка текста.
fontdictdict, необязательно: Словарь для переопределения свойств текста по умолчанию. Если не указан, значения определяются по умолчанию rcParams["font.*"]. Свойства, переданные в качестве kwargs, переопределяют соответствующие свойства, указанные в fontdict.

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

Text

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

**kwargsText свойства: Другие различные параметры текста.

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

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

См. также

Axes.text
pyplot.text

update(props)[source]

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

Параметры:

propsсловарь

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

zorder=0

classmatplotlib.figure.SubFigure(parent, subplotspec, *, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, **kwargs)[source]

Логическая фигура, которая может быть размещена внутри фигуры.

Обычно создаётся с помощью Figure.add_subfigure или SubFigure.add_subfigure, или SubFigure.subfigures. Подфигура имеет те же методы, что и фигура, за исключением методов, непосредственно связанных с размером или разрешением фигуры, и ограничена заданной областью фигуры. Например, следующее размещает две подфигуры рядом друг с другом:

fig = plt.figure()
sfigs = fig.subfigures(1, 2)
axsL = sfigs[0].subplots(1, 2)
axsR = sfigs[1].subplots(2, 1)

См. Подфигуры фигуры

Параметры:

parentFigure или SubFigure: Фигура или подфигура, содержащая подфигуру. Подфигуры могут быть вложены.
subplotspecgridspec.SubplotSpec: Определяет область в родительской сетке gridspec, где будет размещена подфигура.
facecolorпо умолчанию: rcParams["figure.facecolor"] (по умолчанию: 'white'): Цвет заливки области фигуры.
edgecolorпо умолчанию: rcParams["figure.edgecolor"] (по умолчанию: 'white'): Цвет границы области фигуры.
linewidthfloat: Толщина линии рамки (т.е. толщина линии границы области фигуры).
frameonbool, по умолчанию: rcParams["figure.frameon"] (по умолчанию: True): Если False, подавление отрисовки области фона фигуры.

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

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

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

add_artist(artist, clip=False)[source]

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

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

Параметры:

artistArtist: Элемент для добавления на график. Если для добавленного элемента не задан преобразования, его преобразование будет установлено в figure.transSubfigure.
clipbool, по умолчанию: False: Определяет, должен ли добавленный элемент обрезаться областью графика.

Возвращает:

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

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

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

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

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

Параметры:

rectкортеж (left, bottom, width, height): Размеры (left, bottom, width, height) нового Axes. Все значения задаются в долях ширины и высоты графика.
projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, необязательно: Тип проекции Axes. str - имя пользовательской проекции, см. projections. По умолчанию None соответствует проекции 'rectilinear'.
polarbool, по умолчанию: False: Если True, эквивалентно projection='polar'.
axes_classподкласс Axes, необязательно: Подкласс axes.Axes для инстанцирования. Этот параметр несовместим с projection и polar. См. axisartist для примеров.
sharex, shareyAxes, необязательно: Поделиться осями x или y с sharex и/или sharey. Оси будут иметь одинаковые пределы, деления и масштаб с осями совмещенного объекта.
labelstr: Метка для возвращаемого Axes.

Возвращает:

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

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

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

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

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

См. также

Figure.add_subplot
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примечания

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

Примеры

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

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

add_callback(func)[source]

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

Параметры:

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

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

def func(artist: Artist) -> Any

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

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

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

См. также

remove_callback

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

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

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

Параметры:

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

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

SubFigure

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

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

См. также

Figure.subfigures

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

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

Возможные варианты вызова:

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

Параметры:

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

Позиция подграфика, определяемая одним из:

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

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

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

См. также

Figure.add_axes
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примеры

fig = plt.figure()

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

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

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

align_labels(axs=None)[source]

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

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

Параметры:

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

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels

align_xlabels(axs=None)[source]

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

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

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

Параметры:

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

См. также

matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_labels

Примечания

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

Примеры

Пример с повернутыми метками оси 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': Выбирает, какие метки повернуть.

propertyaxes

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

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

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

propertycallbacks[source]

clear(keep_observers=False)[source]

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

Параметры:

keep_observers: bool, по умолчанию: False: Установите keep_observers в значение True, если, например, виджет графического интерфейса отслеживает оси Axes на рисунке.

clf(keep_observers=False)[source]

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

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

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

Параметры:

keep_observers: bool, по умолчанию: False: Установите keep_observers в значение True, если, например, виджет графического интерфейса отслеживает оси Axes на рисунке.

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

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

Параметры:

mappable

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

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

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

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'}
extendfrac{None, 'auto', length, lengths}
extendrectbool
spacing{'uniform', 'proportional'}
ticksNone или список меток или Locator
formatNone или str или Formatter
drawedgesbool
labelstr
boundaries, valuesNone или последовательность

Примечания

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

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

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

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

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

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

contains(mouseevent)[source]

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

Возвращает:

bool, {}

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

delaxes(ax)[source]: Удалить Axes ax из фигуры; обновить текущие оси.

propertydpi

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

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

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

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

Параметры:

match

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

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

include_selfbool

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

Возвращает:

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

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

gca()[source]

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

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

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

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

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

get_axes()[source]

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

Изменение этого списка не имеет эффекта. Используйте вместо этого add_axes, add_subplot или delaxes для добавления или удаления осей.

Примечание: Свойство SubFigure.axes и метод get_axes эквивалентны.

get_children()[source]: Получить список элементов, содержащихся в фигуре.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает, использует ли элемент обрезку.

get_clip_path()[source]: Возвращает область обрезки.

get_constrained_layout()[source]

Возвращает, используется ли ограниченная компоновка.

См. Руководство по ограниченной компоновке.

get_constrained_layout_pads(relative=False)[source]

Получение отступов для constrained_layout.

Возвращает список w_pad, h_pad в дюймах и wspace и hspace в виде дробей от подграфика.

См. Руководство по ограниченной компоновке.

Параметры:

relativebool: Если True, то конвертировать из дюймов в относительные значения по отношению к рисунку.

get_cursor_data(event)[source]

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов. Как конечный пользователь Matplotlib, вы, скорее всего, не будете вызывать этот метод самостоятельно.

Данные курсора могут быть использованы элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Подклассы могут переопределять метод и возвращать произвольные данные. Однако при этом необходимо убедиться, что format_cursor_data может преобразовать данные в строковое представление.

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика при перемещении указателя мыши.

Параметры:

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_default_bbox_extra_artists()[source]

get_dpi()[source]: Возвращает разрешение родительского рисунка в точках на дюйм в виде числа с плавающей точкой.

get_edgecolor()[source]: Возвращает цвет границы прямоугольника рисунка.

get_facecolor()[source]: Возвращает цвет заливки прямоугольника рисунка.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_frameon()[source]: Возвращает видимость фонового заливки рисунка (т. е. будет ли отрисовываться фоновый рисунок). Эквивалентно Figure.patch.get_visible().

get_gid()[source]: Возвращает идентификатор группы.

get_in_layout()[source]

Возвращает логический флаг, True если элемент включён в расчёт компоновки.

Например, Руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_label()[source]: Возвращает метку, используемую для этого элемента в легенде.

get_layout_engine()[source]

get_linewidth()[source]: Возвращает толщину линии прямоугольника рисунка.

get_mouseover()[source]: Возвращает, запрашивается ли у этого элемента пользовательская контекстная информация, когда курсор мыши перемещается по нему.

get_path_effects()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_rasterized()[source]: Возвращает, должен ли элемент быть растрированным.

get_sketch_params()[source]

Возвращает параметры наброска для элемента.

Возвращаемое значение:

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, на который сжимается или расширяется длина.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает настройку привязки.

Подробности см. в set_snap.

get_tightbbox(renderer=None, bbox_extra_artists=None)[source]

Возвращает (усечённую) область размещения фигуры в дюймах.

Обратите внимание, что FigureBase отличается от всех других элементов, которые возвращают их Bbox в пикселях.

Элементы, у которых artist.set_in_layout(False) не включаются в область размещения.

Параметры:

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки фигур (т. е. fig.canvas.get_renderer())
bbox_extra_artistsсписок Artist или None: Список элементов, которые необходимо включить в усечённую область размещения. Если None (по умолчанию), то все дочерние элементы каждого оси включаются в усечённую область размещения.

Возвращаемое значение:

BboxBase: содержащая область размещения (в дюймах фигуры).

get_transform()[source]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[source]: Возвращает путь обрезки с применённой частью преобразования, не связанной с аффином, и оставшейся аффинной частью преобразования.

get_url()[source]: Возвращает URL.

get_visible()[source]: Возвращает видимость.

get_window_extent(renderer=None, *args, **kwargs)[source]

Получение области размещения элемента в пространстве отображения.

Ширина и высота области размещения неотрицательны.

Подклассы должны переопределять для включения в вычисление "усечённой" области размещения. По умолчанию возвращает пустую область размещения в координатах 0, 0.

Будьте внимательны при использовании этой функции, результаты не обновляются, если область размещения элемента в окне меняется. Область размещения может измениться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

get_zorder()[source]: Возвращает порядок элемента z.

have_units()[source]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[source]

Возвращает, есть ли у элемента явно заданное преобразование.

Это True после вызова set_transform.

legend(*args, **kwargs)[source]

Разместить легенду на рисунке.

Возможные подписи:

legend()
legend(handles, labels)
legend(handles=handles)
legend(labels)

Эти подписи соответствуют различным способам использования этого метода:

1. Автоматическое определение элементов для отображения в легенде

Элементы, которые нужно добавить в легенду, определяются автоматически, если вы не передаете дополнительных аргументов.

В этом случае метки берутся из объекта-артиста. Вы можете указать их при создании объекта-артиста или вызвав метод set_label() для объекта-артиста:

ax.plot([1, 2, 3], label='Inline label')
fig.legend()

или:

line, = ax.plot([1, 2, 3])
line.set_label('Label via method')
fig.legend()

Отдельные линии можно исключить из автоматического выбора элементов легенды, определив метку, начинающуюся с символа подчеркивания. Это значение по умолчанию для всех объектов-артистов, поэтому вызов Figure.legend без аргументов и без ручного задания меток не приведет к отображению легенды.

2. Явное указание объектов-артистов и меток в легенде

Для полного управления тем, какие объекты-артисты имеют запись в легенде, можно передать итерируемый объект объектов-артистов легенды, за которым следует итерируемый объект меток легенды:

fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])

3. Явное указание объектов-артистов в легенде

Это аналогично пункту 2, но метки берутся из свойств меток объектов-артистов. Пример:

line1, = ax1.plot([1, 2, 3], label='label1')
line2, = ax2.plot([1, 2, 3], label='label2')
fig.legend(handles=[line1, line2])

4. Назначение меток существующим элементам графика

Не рекомендуется

Эта сигнатура вызова не рекомендуется, так как связь между элементами графика и метками является лишь неявной из-за их порядка и может легко быть нарушена.

Чтобы создать легенду для всех объектов-артистов на всех осях, вызовите эту функцию с итерируемым объектом строк, по одной для каждого элемента легенды. Например:

fig, (ax1, ax2) = plt.subplots(1, 2)
ax1.plot([1, 3, 5], color='blue')
ax2.plot([2, 4, 6], color='red')
fig.legend(['the blues', 'the reds'])

Параметры:

handlesсписок Artist, необязательно

Список объектов-артистов (линий, фигур), которые нужно добавить в легенду. Используйте вместе с labels, если вам нужен полный контроль над отображаемыми элементами в легенде, и автоматический механизм, описанный выше, недостаточен.

Длина списков handles и labels должна быть одинаковой. Если это не так, списки усекаются до меньшей длины.

labelsсписок строк, необязательно

Список меток, которые нужно отобразить рядом с объектами-артистами. Используйте вместе с handles, если вам нужен полный контроль над отображаемыми элементами в легенде, и автоматический механизм, описанный выше, недостаточен.

Возвращает:

Legend

Другие параметры:

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)

ncolsцелое число, по умолчанию: 1

Количество столбцов в легенде.

Для обратной совместимости поддерживается написание ncol, но от него рекомендуется отказаться. Если оба указаны, ncols имеет приоритет.

propNone или matplotlib.font_manager.FontProperties или словарь

Свойства шрифта легенды. Если None (по умолчанию), будут использованы текущие matplotlib.rcParams.

fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

Размер шрифта легенды. Если значение является числом, размер будет абсолютным размером шрифта в пунктах. Строковые значения относятся к текущему размеру шрифта по умолчанию. Этот аргумент используется только если prop не указан.

labelcolorстрока или список, по умолчанию: rcParams["legend.labelcolor"] (по умолчанию: 'None')

Цвет текста в легенде. Допустимая строка цвета (например, 'red') или список строк цвета. Цвет метки также можно сделать совпадающим с цветом линии или маркера, используя 'linecolor', 'markerfacecolor' (или 'mfc') или 'markeredgecolor' (или 'mec').

Цвет метки можно установить глобально с помощью rcParams["legend.labelcolor"] (по умолчанию: 'None'). Если None, использовать rcParams["text.color"] (по умолчанию: 'black').

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

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_fontpropertiesNone или matplotlib.font_manager.FontProperties или словарь

Свойства шрифта заголовка легенды. Если None (по умолчанию), будет использован аргумент title_fontsize, если он присутствует; если title_fontsize также None, будут использованы текущие rcParams["legend.title_fontsize"] (по умолчанию: None).

Размер шрифта заголовка легенды. Примечание: Этот аргумент не может быть использован совместно с title_fontproperties. Если вы хотите установить размер шрифта вместе с другими свойствами шрифта, используйте параметр size в title_fontproperties.

alignment{'center', 'left', 'right'}, по умолчанию: 'center'

Выравнивание заголовка легенды и блока записей. Записи выравниваются как единый блок, чтобы маркеры всегда находились на одной линии.

borderpadчисло с плавающей точкой, по умолчанию: rcParams["legend.borderpad"] (по умолчанию: 0.4)

Дополнительное свободное пространство внутри рамки легенды, в единицах размера шрифта.

labelspacingчисло с плавающей точкой, по умолчанию: rcParams["legend.labelspacing"] (по умолчанию: 0.5)

Вертикальное пространство между записями легенды в единицах размера шрифта.
handlelengthfloat, default: rcParams["legend.handlelength"] (default: 2.0): Длина маркеров легенды в единицах размера шрифта.
handleheightfloat, default: rcParams["legend.handleheight"] (default: 0.7): Высота маркеров легенды в единицах размера шрифта.
handletextpadfloat, default: rcParams["legend.handletextpad"] (default: 0.8): Отступ между маркером легенды и текстом в единицах размера шрифта.
borderaxespadfloat, default: rcParams["legend.borderaxespad"] (default: 0.5): Отступ между осями и границей легенды в единицах размера шрифта.
columnspacingfloat, default: rcParams["legend.columnspacing"] (default: 2.0): Расстояние между столбцами в единицах размера шрифта.
handler_mapdict or None: Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет стандартный словарь обработчиков, который находится в matplotlib.legend.Legend.get_legend_handler_map.

См. также

Axes.legend

Примечания

Некоторые объекты не поддерживаются этой функцией. Подробности см. в Руководстве по легендам.

свойствоmouseover: Возвращает значение, указывающее, запрашивается ли у этого объекта пользовательская информация о контексте, когда курсор мыши находится над ним.

pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обрабатывает событие выбора.

Каждый дочерний объект вызовет событие выбора, если mouseevent находится над объектом, и у объекта установлен флаг picker.

См. также

set_picker, get_picker, pickable

pickable()[source]

Возвращает значение, указывающее, можно ли выбрать объект.

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств объекта.

remove()[source]

Удаляет объект из фигуры, если это возможно.

Эффект будет виден только после перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды объекта.

remove_callback(oid)[source]

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback

sca(a)[source]: Устанавливает текущую ось на a и возвращает a.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, dpi=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, frameon=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, а возвращает массив (m, n, 3) и два смещения с левого нижнего угла изображения
`alpha`	скаляр или None
`animated`	bool
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`dpi`	float
`edgecolor`	цвет
`facecolor`	цвет
`figure`	`Figure`
`frameon`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`linewidth`	число
`mouseover`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`rasterized`	bool
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`visible`	bool
`zorder`	float

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Parameters:

filter_funccallable: Функция фильтра, которая принимает массив float (m, n, depth) и значение dpi, и возвращает массив (m, n, depth) и два смещения с левого нижнего угла изображения

set_alpha(alpha)[source]

Установить значение альфа для смешивания – не поддерживается на всех бэкэндах.

Parameters:

alphaскаляр или None: alpha должен быть в диапазоне от 0 до 1 включительно.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

Если True, художник исключается из обычного рисования фигуры. Вам необходимо явно вызвать Figure.draw_artist / Axes.draw_artist для художника. Этот подход используется для ускорения анимаций с помощью блиттинга.

См. также matplotlib.animation и Более быстрое отображение с помощью блиттинга.

Параметры:

bbool

set_clip_box(clipbox)[source]

Установить обрезку художника Bbox.

Параметры:

clipboxBbox

set_clip_on(b)[source]

Установить, использует ли художник обрезку.

При значении False художники будут видны за пределами осей, что может привести к непредвиденным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[source]

Установить обрезку художника.

Параметры:

pathPatch или Path или TransformedPath или None: Область обрезки. Если задан Path, необходимо также предоставить transform. Если None, ранее установленная область обрезки удаляется.
transformTransform, необязательно: Используется только если path — Path, в этом случае данный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — Rectangle, этот метод установит область обрезки соответствующему прямоугольнику и установит обрезку к None.

По техническим причинам (поддержка set) также допускается кортеж (path, transform) как единственный позиционный параметр.

set_dpi(val)[source]

Установить разрешение родительской фигуры в точках на дюйм.

Параметры:

valfloat

set_edgecolor(color)[source]

Установить цвет рамки прямоугольника фигуры.

Параметры:

colorцвет

set_facecolor(color)[source]

Установить цвет заливки прямоугольника фигуры.

Параметры:

colorцвет

set_figure(fig)[source]

Установить экземпляр Figure, к которому принадлежит художник.

Параметры:

figFigure

set_frameon(b)[source]

Установить видимость фона фигуры, т.е. будет ли нарисован фон фигуры. Эквивалентно Figure.patch.set_visible().

Параметры:

bbool

set_gid(gid)[source]

Установить идентификатор (группы) для художника.

Параметры:

gidstr

set_in_layout(in_layout)[source]

Указывает, нужно ли включать элемент в вычисления макета. Например, в Руководстве по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:

in_layoutbool

set_label(s)[source]

Устанавливает метку, которая будет отображаться в легенде.

Параметры:

sobject: s будет преобразовано в строку с помощью вызова str.

set_linewidth(linewidth)[source]

Устанавливает ширину линии прямоугольника Figure.

Параметры:

linewidthчисло

set_mouseover(mouseover)[source]

Устанавливает, запрашивается ли у этого элемента информация о контексте, когда курсор мыши находится над ним.

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_path_effects(path_effects)[source]

Устанавливает эффекты траектории.

Параметры:

path_effectsAbstractPathEffect

set_picker(picker)[source]

Определяет поведение выбора элемента.

Параметры:

pickerNone или bool или float или callable

Может быть одним из следующих:

None: Выбор отключен для этого элемента (по умолчанию).
bool: Если True, выбор включен, и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
float: Если picker число, оно интерпретируется как толерантность эпсилон в пунктах, и элемент сгенерирует событие, если его данные находятся в пределах эпсилон от события мыши. Для некоторых элементов, таких как линии и коллекции участков, элемент может предоставить дополнительные данные для события выбора, например, индексы данных, находящихся в пределах эпсилон от события выбора
callable: Если picker вызываемый объект, это пользовательская функция, которая определяет, попадает ли элемент под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True и props - словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_rasterized(rasterized)[source]

Принудительно использовать растрирование (битовое отображение) для векторизованного графического вывода.

Это свойство игнорируется для пиксельного вывода.

См. также Растрирование для векторизованной графики.

Параметры:

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Устанавливает параметры наброска.

Параметры:

scalefloat, необязательно

Амплитуда волны перпендикулярно исходной линии в пикселях. Если scale None или не указана, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина волны вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, с которым длина уменьшается или увеличивается (по умолчанию 16.0)

Backend PGF использует это значение как seed генератора случайных чисел, а не так, как описано выше. Использование одинакового значения seed приводит к одному и тому же случайному виду.

set_snap(snap)[source]

Устанавливает поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более четким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением на обоих смежных пикселях. В отличие от этого, привязка переместит линию к ближайшему целочисленному пиксельному значению, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:

snapbool или None

Возможные значения:

True: Привязка вершин к центрам ближайших пикселей.
False: Не изменять положения вершин.
None: (авто) Если траектория содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(t)[source]

Установить преобразование объекта.

Параметры:

tTransform

set_url(url)[source]

Установить URL для объекта.

Параметры:

urlstr

set_visible(b)[source]

Установить видимость объекта.

Параметры:

bbool

set_zorder(level)[source]

Установить z-порядок объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры:

levelfloat

свойствоstale: Является ли объект 'недействительным' и требуется ли его перерисовка для соответствия внутреннему состоянию объекта.

свойствоsticky_edges

x и y списки «прилипающих» границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то никакой отступ не добавляется — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно не ожидается отступ снизу (0) гистограммы.

Кроме того, расширение отступа «натыкается» на прилипающие края и не может их пересечь. Например, если верхний предел данных равен 1,0, верхний предел просмотра, вычисленный с помощью простого применения отступа, равен 1,2, но есть прилипающий край в 1,1, то фактический верхний предел просмотра будет равен 1,1.

К этому атрибуту нельзя обращаться для присваивания; тем не менее, списки x и y можно изменять непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

subfigures(nrows=1, ncols=1, squeeze=True, wspace=None, hspace=None, width_ratios=None, height_ratios=None, **kwargs)[source]

Добавить подфигуру к этой фигуре или подфигуре.

Подфигура имеет те же методы художника, что и фигура, и логически идентична фигуре, но не может выводить себя. См. Подфигуры фигуры.

Параметры:

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, *, sharex=False, sharey=False, width_ratios=None, height_ratios=None, empty_sentinel='.', subplot_kw=None, gridspec_kw=None)[source]

Создаёт макет осей на основе ASCII-искусства или вложенных списков.

Это вспомогательная функция для создания сложных макетов GridSpec визуально.

Примечание

Этот API является предварительным и может быть пересмотрен в будущем на основе отзывов ранних пользователей.

См. Составление сложных и осмысленных изображений для примера и полного описания 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'

Формат строк позволяет использовать только метки осей из одного символа и не поддерживает вложение, но очень компактен.

sharex, shareybool, по умолчанию: False

Если True, ось x (sharex) или ось y (sharey) будут совмещены между всеми подграфиками. В этом случае видимость меток делений и единицы оси ведут себя как для subplots. Если False, каждая ось x или y подграфика будет независимой.

width_ratiosмассив-подобный длины ncols, необязательно

height_ratiosмассив-подобный длины nrows, необязательно

subplot_kwсловарь, необязательно

Словарь с ключевыми словами, передаваемыми в вызов Figure.add_subplot для создания каждого подграфика.

gridspec_kwсловарь, необязательно

empty_sentinelобъект, необязательно

Элемент в макете, означающий «оставить это место пустым». По умолчанию '.'. Обратите внимание, что если layout является строкой, она обрабатывается с помощью inspect.cleandoc для удаления начального пробела, что может помешать использованию пробела в качестве пустого маркер.

Возвращает:

словарь[метка, ось]: Словарь, сопоставляющий метки с объектами осей. Порядок осей слева направо и сверху вниз в их позиции в общем макете.

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, width_ratios=None, height_ratios=None, subplot_kw=None, gridspec_kw=None)[source]

Добавление набора подграфиков к этой фигуре.

Этот утилитарный обёртчик упрощает создание общих макетов подграфиков в одном вызове.

Параметры:

nrows, ncolsint, по умолчанию: 1

Количество строк/столбцов сетки подграфиков.

sharex, shareybool или {'none', 'all', 'row', 'col'}, по умолчанию: False

Управление совместным использованием оси x (sharex) или оси y (sharey):

True или 'all': ось x или y будет общей для всех подграфиков.
False или 'none': каждая ось x или y подграфика будет независимой.
'row': каждая строка подграфиков будет совместно использовать ось x или y.
'col': каждый столбец подграфиков будет совместно использовать ось x или y.

Когда подграфики совместно используют ось x в столбце, метки делений оси x отображаются только в нижнем подграфике. Аналогично, когда подграфики совместно используют ось y в строке, метки делений оси y отображаются только в подграфике первого столбца. Для последующего включения меток делений других подграфиков используйте tick_params.

Когда подграфики совместно используют ось с единицами измерения, вызов Axis.set_units обновит каждую ось с новыми единицами.

squeezebool, по умолчанию: True

Если True, лишние измерения удаляются из возвращаемого массива объектов Axes:
- если создан только один подграфик (nrows=ncols=1), возвращается единственный объект Axes в качестве скаляра.
- для Nx1 или 1xM подграфиков возвращаемый объект — одномерный массив numpy объектов Axes.
- для NxM, подграфиков с N>1 и M>1 возвращается двумерный массив.
Если False, сжатие не выполняется: возвращаемый объект Axes всегда является двумерным массивом, содержащим объекты Axes, даже если он оказывается 1x1.

width_ratiosмассив-подобный объект длиной ncols, необязательно

height_ratiosмассив-подобный объект длиной nrows, необязательно

subplot_kwсловарь, необязательно

Словарь с ключевыми словами, передаваемыми в вызов Figure.add_subplot для создания каждого подграфика.

gridspec_kwсловарь, необязательно

Словарь с ключевыми словами, передаваемыми в конструктор 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: Текст надписи.
xfloat, по умолчанию: 0.5: Положение x текста в координатах рисунка.
yfloat, по умолчанию: 0.01: Положение y текста в координатах рисунка.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: bottom: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

Возвращаемое значение:

text: Экземпляр Text подписи.

Другие параметры:

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и веса шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.labelsize"] (по умолчанию: 'large') и rcParams["figure.labelweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные kwargs — свойства matplotlib.text.Text.

supylabel(t, **kwargs)[source]

Добавить центральную надпись у оси y рисунка.

Параметры:

tstr: Текст надписи.
xfloat, по умолчанию: 0.02: Положение x текста в координатах рисунка.
yfloat, по умолчанию: 0.5: Положение y текста в координатах рисунка.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: left: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: center: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

Возвращаемое значение:

text: Экземпляр Text подписи.

Другие параметры:

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и веса шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.labelsize"] (по умолчанию: 'large') и rcParams["figure.labelweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные 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`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или c	цвет
`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`	str
`horizontalalignment` или ha	{'left', 'center', 'right'}
`in_layout`	bool
`label`	объект
`linespacing`	числовой тип (кратное размеру шрифта)
`math_fontfamily`	str
`mouseover`	bool
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или числовой тип или вызываемая функция
`position`	(числовой тип, числовой тип)
`rasterized`	bool
`rotation`	числовой тип или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: числовой тип, length: числовой тип, randomness: числовой тип)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	str
`usetex`	bool или None
`verticalalignment` или va	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
`visible`	bool
`wrap`	bool

`x`	число с плавающей точкой
`y`	число с плавающей точкой
`zorder`	число с плавающей точкой

См. также

Axes.text
pyplot.text

update(props)[source]

Обновить свойства этого объекта-графического элемента из словаря props.

Параметры:

propsdict

update_from(other)[source]: Копировать свойства из other в self.

zorder=0

classmatplotlib.figure.SubplotParams(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)[source]

Класс для хранения параметров подграфика.

Значения по умолчанию указаны в rcParams["figure.subplot.[name]"].

Параметры:

leftfloat: Положение левой границы подграфиков, как доля ширины фигуры.
rightfloat: Положение правой границы подграфиков, как доля ширины фигуры.
bottomfloat: Положение нижней границы подграфиков, как доля высоты фигуры.
topfloat: Положение верхней границы подграфиков, как доля высоты фигуры.
wspacefloat: Ширина отступа между подграфиками, как доля средней ширины осей.
hspacefloat: Высота отступа между подграфиками, как доля средней высоты осей.

update(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)[source]: Обновить размеры переданных параметров. None означает без изменений.

propertyvalidate[source]

matplotlib.figure.figaspect(arg)[source]

Вычислить ширину и высоту фигуры с заданным соотношением сторон.

В то время как высота берется из rcParams["figure.figsize"] (по умолчанию [6.4, 4.8]), ширина корректируется для соответствия желаемому соотношению сторон. Кроме того, гарантируется, что ширина находится в диапазоне [4., 16.], а высота — в диапазоне [2., 16.]. При необходимости, высота по умолчанию корректируется.

Параметры:

argfloat или 2D массив: Если число с плавающей точкой, это определяет соотношение сторон (т. е. отношение высота / ширина). В случае массива соотношение сторон равно числу строк / числу столбцов, чтобы массив можно было вставить в фигуру без искажений.

Возвращает:

width, heightfloat: Размер фигуры в дюймах.

Примечания

Если вы хотите создать ось внутри фигуры, которая все еще сохраняет соотношение сторон, обязательно создавайте ее с равной шириной и высотой. См. примеры ниже.

Благодарим Фернандо Переса за эту функцию.

Примеры

Создать фигуру, вдвое более высокую, чем широкую:

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)