matplotlib.figure.Figure

class matplotlib.figure.Figure(figsize=None, dpi=None, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, subplotpars=None, tight_layout=None, constrained_layout=None) [source]

Bases: matplotlib.artist.Artist

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

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

Атрибуты:

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

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

Параметры:

Параметры:	`figsize2-tuple of floats, default: rcParams["figure.figsize"] (default: [6.4, 4.8])` Размер фигуры `(width, height)` в дюймах. `dpifloat, default: rcParams["figure.dpi"] (default: 100.0)` Точек на дюйм. `facecolordefault: rcParams["figure.facecolor"] (default: 'white')` Цвет заливки фонового прямоугольника фигуры. `edgecolordefault: rcParams["figure.edgecolor"] (default: 'white')` Цвет контура фонового прямоугольника фигуры. `linewidthfloat` Ширина линии рамки (т.е. ширина линии контура фонового прямоугольника фигуры). `frameonbool, default: rcParams["figure.frameon"] (default: True)` Если `False`, запретить рисование фонового прямоугольника фигуры. `subplotparsSubplotParams` Параметры подграфиков. Если не указаны, используются параметры подграфиков по умолчанию `rcParams["figure.subplot."]`. `tight_layoutbool or dict, default: rcParams["figure.autolayout"] (default: False)` Если `False` использовать subplotpars*. Если `True` настроить параметры подграфиков с помощью `tight_layout` с отступами по умолчанию. При указании словаря, содержащего ключи `pad`, `w_pad`, `h_pad`, и `rect`, отступы по умолчанию для `tight_layout` будут переопределены. `constrained_layoutbool` Если `True` использовать ограниченную компоновку для изменения расположения элементов графика. Подобно `tight_layout`, но разработан для большей гибкости. Примеры см. в Руководстве по ограниченной компоновке. (Примечание: не работает с `subplot()` или `subplot2grid()`.) По умолчанию `rcParams["figure.constrained_layout.use"]` (значение по умолчанию: False).

figsize2-tuple of floats, default: rcParams["figure.figsize"] (default: [6.4, 4.8]): Размер фигуры (width, height) в дюймах.
dpifloat, default: rcParams["figure.dpi"] (default: 100.0): Точек на дюйм.
facecolordefault: rcParams["figure.facecolor"] (default: 'white'): Цвет заливки фонового прямоугольника фигуры.
edgecolordefault: rcParams["figure.edgecolor"] (default: 'white'): Цвет контура фонового прямоугольника фигуры.
linewidthfloat: Ширина линии рамки (т.е. ширина линии контура фонового прямоугольника фигуры).
frameonbool, default: rcParams["figure.frameon"] (default: True): Если False, запретить рисование фонового прямоугольника фигуры.
subplotparsSubplotParams: Параметры подграфиков. Если не указаны, используются параметры подграфиков по умолчанию rcParams["figure.subplot.*"].
tight_layoutbool or dict, default: rcParams["figure.autolayout"] (default: False): Если False использовать subplotpars. Если True настроить параметры подграфиков с помощью tight_layout с отступами по умолчанию. При указании словаря, содержащего ключи pad, w_pad, h_pad, и rect, отступы по умолчанию для tight_layout будут переопределены.
constrained_layoutbool: Если True использовать ограниченную компоновку для изменения расположения элементов графика. Подобно tight_layout, но разработан для большей гибкости. Примеры см. в Руководстве по ограниченной компоновке. (Примечание: не работает с subplot() или subplot2grid().) По умолчанию rcParams["figure.constrained_layout.use"] (значение по умолчанию: False).

add_artist(self, artist, clip=False) [source]

Добавить любой Artist в фигуру.

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

Параметры:

Параметры:	`artistArtist` Элемент для добавления в фигуру. Если у добавленного элемента нет ранее установленного преобразования, его преобразование будет установлено в `figure.transFigure`. `clipbool, optional, default False` Необязательный параметр `clip` определяет, должен ли добавленный элемент обрезаться фоновым прямоугольником фигуры. Значение по умолчанию — False, т.е. обрезка не выполняется.
Возвращает:	`artistThe added Artist`

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

Возвращает:

artistThe added Artist

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

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

Вызов:

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

Параметры:	`rectsequence of float` Размеры [левый, нижний, ширина, высота] новой оси. Все величины указаны в долях ширины и высоты фигуры. `projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional` Тип проекции `Axes`. str — имя настраиваемой проекции, см. `projections`. По умолчанию None — 'rectilinear' проекция. `polarboolean, optional` Если True, эквивалентно projection='polar'. `sharex, shareyAxes, optional` Поделиться осью x или y с sharex и/или sharey. Ось будет иметь те же пределы, деления и масштаб, что и ось на связанной оси. `labelstr` Метка для возвращаемой оси.
Возвращает:	`axesAxes (or a subclass of Axes)` Возвращаемый класс оси зависит от используемой проекции. Это `Axes`, если используется прямолинейная проекция, и `projections.polar.PolarAxes`, если используется полярная проекция.
Другие параметры:	**kwargs Этот метод также принимает ключевые аргументы для возвращаемого класса оси. Ключевые аргументы для класса прямолинейных осей `Axes` можно найти в следующей таблице, но могут быть и другие ключевые аргументы, если используется другая проекция, см. фактический класс оси.

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

`yscale`	{"линейный", "логарифмический", "симлогирифмический", "логит", ...}
`yticklabels`	Список[строка]
`yticks`	неизвестно
`zorder`	вещественное число

См. также

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

Примечания

Если в графике уже есть ось с ключом (args, kwargs), то она просто станет текущей и будет возвращена. Это поведение устарело. В то же время, если вы не хотите этого поведения (т.е. хотите принудительно создать новую ось), вы должны использовать уникальный набор аргументов и ключевых слов. Атрибут оси label был доступен для этой цели: если вы хотите добавить на график две оси, которые в остальном идентичны, убедитесь, что у них уникальные метки.

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

Примеры

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

rect = l, b, w, h
fig = plt.figure()
fig.add_axes(rect, label=label1)
fig.add_axes(rect, label=label2)
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(self, func) [source]: Всякий раз, когда состояние оси изменяется, func(self) будет вызвано.

add_gridspec(self, nrows, ncols, **kwargs) [source]

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

Параметры:	`nrowsint` Число строк в сетке. `ncolsint` Число столбцов в сетке.
Возвращает:	`gridspecGridSpec`
Другие параметры:	**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_subplot(self, *args, **kwargs) [source]

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

Подписи функций:

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

Параметры:	args Целое число из 3 цифр или три отдельных целых числа, описывающие положение подграфика. Если три целых числа — это nrows, ncols* и index в порядке следования, подграфик займет index позицию на сетке с nrows строками и ncols столбцами. index начинается с 1 в верхнем левом углу и увеличивается вправо. pos — целое число из 3 цифр, где первая цифра — число строк, вторая — число столбцов, а третья — индекс подграфика. Например, fig.add_subplot(235) эквивалентно fig.add_subplot(2, 3, 5). Обратите внимание, что все целые числа должны быть меньше 10, чтобы этот формат работал. Если позиционные аргументы не указаны, используется по умолчанию (1, 1, 1). В редких случаях, `add_subplot` может быть вызван с одним аргументом, экземпляром подграфика, уже созданным в текущем графике, но не в списке осей графика. `projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional` Тип проекции подграфика (`Axes`). str — имя пользовательской проекции, см. `projections`. По умолчанию None используется 'прямолинейная' проекция. `polarboolean, optional` Если True, эквивалентно projection='polar'. `sharex, shareyAxes, optional` Поделиться осью x или y `axis` с sharex и/или sharey. Ось будет иметь те же пределы, деления и масштаб, что и ось совмещенной оси. `labelstr` Метка возвращенной оси.
Возвращает:	`axesaxes.SubplotBase, or another subclass of Axes` Ось подграфика. Базовый класс возвращенной оси зависит от используемой проекции. Это `Axes`, если используется прямолинейная проекция, и `projections.polar.PolarAxes`, если используется полярная проекция. Возвращенная ось является подклассом базового класса для подграфика.
Другие параметры:	*kwargs Этот метод также принимает ключевые аргументы для возвращаемого базового класса оси; за исключением аргумента figure*. Ключевые аргументы для прямолинейного базового класса `Axes` можно найти в следующей таблице, но могут быть и другие ключевые аргументы, если используется другая проекция.

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

`yscale`	{"linear", "log", "symlog", "logit", ...}
`yticklabels`	Список[строка]
`yticks`	неизвестно
`zorder`	число с плавающей точкой

См. также

Figure.add_axes
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примечания

Если в фигуре уже есть подграфик с ключом (args, kwargs), то он просто сделает этот подграфик текущим и вернёт его. Это поведение устарело. В то же время, если вы не хотите этого поведения (т.е. хотите принудительно создать новый подграфик), вы должны использовать уникальный набор args и kwargs. Атрибут оси label был добавлен для этой цели: если вы хотите добавить в фигуру два подграфика, которые в остальном идентичны, убедитесь, что вы дали им уникальные метки.

Примеры

fig = plt.figure()
fig.add_subplot(221)

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

# add a subplot with no frame
ax2 = fig.add_subplot(222, frameon=False)

# add a polar subplot
fig.add_subplot(223, projection='polar')

# add a red subplot that share the x-axis with ax1
fig.add_subplot(224, sharex=ax1, facecolor='red')

#delete x2 from the figure
fig.delaxes(ax2)

#add x2 to the figure again
fig.add_subplot(ax2)

align_labels(self, axs=None) [source]

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

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

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

См. также

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

align_xlabels(self, axs=None) [source]

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

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

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

Параметры:	`axslist of Axes` Необязательный список (или массив NumPy) `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(self, axs=None) [source]

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

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

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

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_labels

Примечания

Примеры

Пример с большими метками 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(self, bottom=0.2, rotation=30, ha='right', which=None) [source]

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

Параметры:

Параметры:	`bottomscalar` Нижняя часть подграфиков для `subplots_adjust()`. `rotationangle in degrees` Угол поворота меток x. `hastr` Горизонтальное выравнивание меток x. `which{None, 'major', 'minor', 'both'}` Выбирает метки, которые нужно повернуть. По умолчанию None, что работает так же, как major.

bottomscalar: Нижняя часть подграфиков для subplots_adjust().
rotationangle in degrees: Угол поворота меток x.
hastr: Горизонтальное выравнивание меток x.
which{None, 'major', 'minor', 'both'}: Выбирает метки, которые нужно повернуть. По умолчанию None, что работает так же, как major.

property axes: Список осей на фигуре. Вы можете получить доступ к осям на фигуре через этот список. Не изменяйте сам список. Вместо этого используйте add_axes, subplot или delaxes для добавления или удаления оси.

clear(self, keep_observers=False) [source]: Очистить фигуру — синоним для clf().

clf(self, keep_observers=False) [source]

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

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

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

Создать полосу цвета для объекта ScalarMappable, mappable.

Документация для тонкого обёртки pyplot:

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

Подписи функций для интерфейса pyplot; все кроме первой также являются подписями методов для метода colorbar():

colorbar(**kwargs)
colorbar(mappable, **kwargs)
colorbar(mappable, cax=cax, **kwargs)
colorbar(mappable, ax=ax, **kwargs)

Параметры:

Параметры:	mappable `matplotlib.cm.ScalarMappable` (т.е., `Image`, `ContourSet` и т.д.), описываемый этой полосой цвета. Этот аргумент обязателен для метода `Figure.colorbar`, но необязателен для функции `pyplot.colorbar`, которая устанавливает значение по умолчанию для текущего изображения. Обратите внимание, что можно создать `ScalarMappable` "на лету", чтобы генерировать полосы цвета, не прикреплённые к ранее нарисованному объекту, например: fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax) `caxAxes object, optional` Ось, в которую будет нарисована полоса цвета. `axAxes, list of Axes, optional` Родительская ось, из которой будет взято место для новой оси полосы цвета. Если задан список осей, все они будут изменены, чтобы освободить место для оси полосы цвета. `use_gridspecbool, optional` Если cax является `None`, новая cax создаётся как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec `True`, cax создаётся как экземпляр Subplot, используя модуль `gridspec`.
Возвращает:	`colorbarColorbar` См. также базовый класс `ColorbarBase`.

mappable

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

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

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

caxAxes object, optional

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

axAxes, list of Axes, optional

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

use_gridspecbool, optional

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

Возвращает:

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

Примечания

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

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

Свойство	Описание
orientation	вертикальное или горизонтальное
fraction	0,15; доля исходной оси, используемая для полосы цвета
pad	0,05 при вертикальном расположении, 0,15 при горизонтальном; доля исходной оси между полосой цвета и новой осью изображения
shrink	1,0; доля, на которую умножается размер полосы цвета
aspect	20; отношение длинных к коротким сторонам
anchor	(0,0, 0,5) при вертикальном расположении; (0,5, 1,0) при горизонтальном; точка якорной точки оси полосы цвета
panchor	(1,0, 0,5) при вертикальном расположении; (0,5, 0,0) при горизонтальном; точка якорной точки родительской оси полосы цвета. Если False, якорь родительской оси останется неизменным

свойства полосы цвета:

Свойство	Описание
extend	{'neither', 'both', 'min', 'max'} Если не 'neither', добавляются острые концы для значений вне диапазона. Они устанавливаются для данной цветовой карты, используя методы colormap set_under и set_over.
extendfrac	{None, 'auto', length, lengths} Если установлено в None, минимальное и максимальное треугольные расширения полосы цвета будут иметь длину 5% от длины внутренней полосы цвета (это значение по умолчанию). Если установлено в 'auto', делает треугольные расширения полосы цвета такой же длины, как внутренние прямоугольники (когда spacing установлено в 'uniform') или такой же длины, как соответствующие смежные внутренние прямоугольники (когда spacing установлено в 'proportional'). Если скаляр, указывает длину минимального и максимального треугольных расширений полосы цвета как долю от длины внутренней полосы цвета. Также может быть задана двухелементная последовательность дробей, указывающая длину минимального и максимального расширений полосы цвета соответственно как долю от длины внутренней полосы цвета.
extendrect	bool Если False, минимальное и максимальное расширения полосы цвета будут треугольными (значение по умолчанию). Если True, расширения будут прямоугольными.
spacing	{'uniform', 'proportional'} Равномерное расстояние даёт каждому дискретному цвету одинаковое пространство; пропорциональное делает пространство пропорциональным интервалу данных.
ticks	None или список делений или Locator Если None, деления автоматически определяются из ввода.
format	None или строка или Formatter Если None, используется `ScalarFormatter`. Если задана строка формата, например '%.3f', она используется. Вместо этого может быть задан альтернативный объект `Formatter`.
drawedges	bool Выводить ли линии на границах цветов.
label	строка Подпись по длинной оси полосы цвета.

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

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

Свойство

Описание

boundaries

None или последовательность

values

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

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

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

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

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

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

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

contains(self, mouseevent) [source]

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

Возвращает:	bool, {}

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

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

draw(self, renderer) [source]: Отобразить рисунок с помощью экземпляра matplotlib.backend_bases.RendererBase renderer.

draw_artist(self, a) [source]: Отобразить только экземпляр matplotlib.artist.Artist a. Это доступно только после отображения рисунка.

execute_constrained_layout(self, renderer=None) [source]

Используйте layoutbox для определения позиций pos внутри осей.

См. также set_constrained_layout_pads.

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

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

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

Параметры:	X Данные изображения. Это массив одной из следующих форм: MxN: значения яркости (серого цвета) MxNx3: значения RGB MxNx4: значения RGBA `xo, yoint` Смещение изображения по осям x/y в пикселях. `alphaNone or float` Значение альфа-смешения. `normmatplotlib.colors.Normalize` Объект `Normalize`, для сопоставления яркости в диапазон [0, 1]. `cmapstr or matplotlib.colors.Colormap` Цветовая карта для использования. По умолчанию: `rcParams["image.cmap"]` (по умолчанию: 'viridis'). `vmin, vmaxscalar` Если norm не указан, эти значения задают пределы данных для цветовой карты. `origin{'upper', 'lower'}` Указывает, где индекс [0, 0] массива находится в верхнем левом или нижнем левом углу осей. По умолчанию `rcParams["image.origin"]` (по умолчанию: 'upper'). `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()

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

gca(self, **kwargs) [source]

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

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

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

`yticklabels`	Список[строка]
`yticks`	неизвестно
`zorder`	вещественное число

get_axes(self) [source]

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

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

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

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

get_constrained_layout(self) [source]

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

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

get_constrained_layout_pads(self, relative=False) [source]

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

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

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

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

get_default_bbox_extra_artists(self) [source]

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

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

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

get_figheight(self) [source]: Возвращает высоту фигуры как вещественное число.

get_figwidth(self) [source]: Возвращает ширину фигуры как вещественное число.

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

get_size_inches(self) [source]

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

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

См. также

matplotlib.Figure.set_size_inches

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

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

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

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

Параметры:

Параметры:	`rendererRendererBase instance` рендерер, который будет использоваться для отрисовки фигур (т.е. `fig.canvas.get_renderer()`) `bbox_extra_artistslist of Artist or None` Список элементов графического интерфейса, которые нужно включить в ограничивающий прямоугольник. Если `None` (по умолчанию), то все элементы графического интерфейса каждого подграфика включаются в ограничивающий прямоугольник.
Возвращает:	`bboxBboxBase` содержащий ограничивающий прямоугольник (в дюймах фигуры).

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

Возвращает:

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

get_window_extent(self, *args, **kwargs) [source]: Возвращает ограничивающий прямоугольник фигуры в пространстве отображения. Аргументы игнорируются.

ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1, mouse_pop=3, mouse_stop=2) [source]

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

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

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

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

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

1: левая кнопка мыши
2: средняя кнопка мыши
3: правая кнопка мыши
None: ни одна кнопка мыши

Параметры:

Параметры:	`nint, optional, default: 1` Количество щелчков мышью для накопления. Если отрицательно, накапливать щелчки до тех пор, пока ввод не будет завершен вручную. `timeoutscalar, optional, default: 30` Время ожидания в секундах. Если равно нулю или отрицательно, таймаут никогда не наступит. `show_clicksbool, optional, default: True` Если True, отобразить красный крестик в месте каждого щелчка. `mouse_add{1, 2, 3, None}, optional, default: 1 (left click)` Кнопка мыши для добавления точек. `mouse_pop{1, 2, 3, None}, optional, default: 3 (right click)` Кнопка мыши для удаления последней добавленной точки. `mouse_stop{1, 2, 3, None}, optional, default: 2 (middle click)` Кнопка мыши для завершения ввода.
Возвращает:	`pointslist of tuples` Список координат щелчков (x, y).

nint, optional, default: 1: Количество щелчков мышью для накопления. Если отрицательно, накапливать щелчки до тех пор, пока ввод не будет завершен вручную.
timeoutscalar, optional, default: 30: Время ожидания в секундах. Если равно нулю или отрицательно, таймаут никогда не наступит.
show_clicksbool, optional, default: True: Если True, отобразить красный крестик в месте каждого щелчка.
mouse_add{1, 2, 3, None}, optional, default: 1 (left click): Кнопка мыши для добавления точек.
mouse_pop{1, 2, 3, None}, optional, default: 3 (right click): Кнопка мыши для удаления последней добавленной точки.
mouse_stop{1, 2, 3, None}, optional, default: 2 (middle click): Кнопка мыши для завершения ввода.

Возвращает:

pointslist of tuples: Список координат щелчков (x, y).

Примечания

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

init_layoutbox(self) [source]: Инициализировать layoutbox для использования в constrained_layout.

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

Размещение легенды на рисунке.

Для создания легенды из существующих элементов на каждом осей:

legend()

Для создания легенды для списка линий и подписей:

legend(
    (line1, line2, line3),
    ('label1', 'label2', 'label3'),
    loc='upper right')

Эти значения также можно указать с помощью ключевых слов:

legend(
    handles=(line1, line2, line3),
    labels=('label1', 'label2', 'label3'),
    loc='upper right')

Параметры:

handleslist of Artist, optional

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

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

labelslist of str, optional

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

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

matplotlib.legend.Legend instance

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

locstr or pair of floats, default: rcParams["legend.loc"] (default: 'best') ('best' for axes, 'upper right' for figures)

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

Строки '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-tuple, or 4-tuple of floats

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

Координаты Bbox интерпретируются в системе координат, заданной bbox_transform, с преобразованием по умолчанию Оси или Рисунок, в зависимости от того, какой legend вызван.

Если задан 4-кортеж или BboxBase, то он определяет bbox (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)

ncolinteger

Количество столбцов в легенде. По умолчанию 1.

propNone or matplotlib.font_manager.FontProperties or dict

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

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

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

numpointsNone or int

Количество маркеров в легенде при создании записи для Line2D (линия). Значение по умолчанию None, что означает использование rcParams["legend.numpoints"] (по умолчанию: 1).

scatterpointsNone or int

Количество маркеров в легенде при создании записи для PathCollection (разброс). Значение по умолчанию None, что означает использование rcParams["legend.scatterpoints"] (по умолчанию: 1).

scatteryoffsetsiterable of floats

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

markerscaleNone or int or float

Относительный размер маркеров легенды по сравнению с первоначально нарисованными. Значение по умолчанию None, что означает использование rcParams["legend.markerscale"] (по умолчанию: 1,0).

markerfirstbool

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

frameonNone or bool

Необходимо ли рисовать легенду на области (рамке). Значение по умолчанию None, что означает использование rcParams["legend.frameon"] (по умолчанию: True).

fancyboxNone or bool

Нужно ли включить закругленные углы вокруг FancyBboxPatch, которая составляет фон легенды. Значение по умолчанию None, что означает использование rcParams["legend.fancybox"] (по умолчанию: True).

shadowNone or bool

Необходимо ли рисовать тень за легендой. Значение по умолчанию None, что означает использование rcParams["legend.shadow"] (по умолчанию: False).

framealphaNone or float

Альфа-прозрачность фона легенды. Значение по умолчанию None, что означает использование rcParams["legend.framealpha"] (по умолчанию: 0,8). Если shadow включен, а framealpha – None, значение по умолчанию игнорируется.

facecolorNone or "inherit" or color

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

edgecolorNone or "inherit" or color

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

mode{"expand", None}

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

bbox_transformNone or matplotlib.transforms.Transform

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

titlestr or None

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

title_fontsize: str or None

Размер шрифта заголовка легенды. По умолчанию – размер шрифта по умолчанию.

borderpadfloat or None

Пробел внутри рамки легенды в единицах размера шрифта. Значение по умолчанию None, что означает использование rcParams["legend.borderpad"] (по умолчанию: 0,4).

labelspacingfloat or None

Вертикальное расстояние между записями легенды в единицах размера шрифта. Значение по умолчанию None, что означает использование rcParams["legend.labelspacing"] (по умолчанию: 0,5).

handlelengthfloat or None

Длина элементов легенды в единицах размера шрифта. Значение по умолчанию None, что означает использование rcParams["legend.handlelength"] (по умолчанию: 2,0).

handletextpadfloat or None

Отступ между элементом легенды и текстом в единицах размера шрифта. Значение по умолчанию None, что означает использование rcParams["legend.handletextpad"] (по умолчанию: 0,8).

borderaxespadfloat or None

Отступ между осями и рамкой легенды в единицах размера шрифта. Значение по умолчанию None, что означает использование rcParams["legend.borderaxespad"] (по умолчанию: 0,5).

columnspacingfloat or None

Интервал между столбцами в единицах размера шрифта. Значение по умолчанию None, что означает использование rcParams["legend.columnspacing"] (по умолчанию: 2,0).

handler_mapdict or None

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

Примечания

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

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

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

Вызов функции:

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

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

Параметры:

Параметры:	`fnamestr or PathLike or file-like object` Путь, или объект типа Python-подобного файла, или, возможно, какой-либо объект, зависящий от бэкэнда, например `matplotlib.backends.backend_pdf.PdfPages`. Если формат не задан, тогда формат вывода определяется по расширению fname, если таковое есть, и из `rcParams["savefig.format"]` (по умолчанию: 'png') в противном случае. Если формат задан, он определяет формат вывода. Поэтому, если fname не является путём или не имеет расширения, помните, чтобы указать формат, чтобы убедиться, что используется правильный бэкэнд.
Другие параметры:	`dpi[ None \| scalar > 0 \| 'figure' ]` Разрешение в точках на дюйм. Если None, по умолчанию используется `rcParams["savefig.dpi"]` (по умолчанию: 'figure'). Если 'figure', используется значение dpi фигуры. `quality[ None \| 1 <= scalar <= 100 ]` Качество изображения в масштабе от 1 (худшее) до 95 (лучшее). Применимо только если формат — jpg или jpeg, в противном случае игнорируется. Если None, по умолчанию используется `rcParams["savefig.jpeg_quality"]` (по умолчанию: 95). Значения выше 95 следует избегать; 100 полностью отключает этап квантования JPEG. `optimizebool` Если True, указывает, что кодировщик JPEG должен выполнить дополнительный проход по изображению, чтобы выбрать оптимальные параметры кодировщика. Применимо только если формат — jpg или jpeg, в противном случае игнорируется. По умолчанию False. `progressivebool` Если True, указывает, что это изображение должно быть сохранено как прогрессивный JPEG-файл. Применимо только если формат — jpg или jpeg, в противном случае игнорируется. По умолчанию False. `facecolorcolor or None, optional` Цвет фона фигуры; если None, по умолчанию используется `rcParams["savefig.facecolor"]` (по умолчанию: 'white'). `edgecolorcolor or None, optional` Цвет обводки фигуры; если None, по умолчанию используется `rcParams["savefig.edgecolor"]` (по умолчанию: 'white') `orientation{'landscape', 'portrait'}` В настоящее время поддерживается только бэкэндом postscript. `papertypestr` Один из 'letter', 'legal', 'executive', 'ledger', 'a0' через 'a10', 'b0' через 'b10'. Поддерживается только для вывода postscript. `formatstr` Формат файла, например 'png', 'pdf', 'svg' и т.д. Поведение, когда это не установлено, документировано в fname. `transparentbool` Если True, области графиков (axes patches) будут прозрачными; область фигуры (figure patch) также будет прозрачной, если не указаны facecolor и/или edgecolor через kwargs. Это полезно, например, для отображения графика поверх цветного фона на веб-странице. Прозрачность этих областей будет восстановлена до исходных значений при выходе из этой функции. `bbox_inchesstr or Bbox, optional` Bbox в дюймах. Сохраняется только заданная часть фигуры. Если 'tight', попытаться определить строгий bbox фигуры. Если None, используется savefig.bbox `pad_inchesscalar, optional` Количество отступов вокруг фигуры, когда bbox_inches — 'tight'. Если None, используется savefig.pad_inches `bbox_extra_artistslist of Artist, optional` Список дополнительных графических объектов, которые будут учтены при расчете строгого bbox. `metadatadict, optional` Ключевые/значения пары для хранения в метаданных изображения. Поддерживаемые ключи и значения по умолчанию зависят от формата изображения и бэкэнда: 'png' с бэкэндом Agg: см. параметр `metadata` `print_png`. 'pdf' с бэкэндом pdf: см. параметр `metadata` `PdfPages`. 'eps' и 'ps' с бэкэндом PS: поддерживается только 'Creator'. `pil_kwargsdict, optional` Дополнительные ключевые параметры, которые передаются в `PIL.Image.save` при сохранении фигуры. Применимо только для форматов, которые сохраняются с помощью Pillow, т.е. JPEG, TIFF и (если ключевое слово задано отличным от None значением) PNG.

fnamestr or PathLike or file-like object

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

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

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

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

dpi[ None | scalar > 0 | 'figure' ]

Разрешение в точках на дюйм. Если None, по умолчанию используется rcParams["savefig.dpi"] (по умолчанию: 'figure'). Если 'figure', используется значение dpi фигуры.

quality[ None | 1 <= scalar <= 100 ]

Качество изображения в масштабе от 1 (худшее) до 95 (лучшее). Применимо только если формат — jpg или jpeg, в противном случае игнорируется. Если None, по умолчанию используется rcParams["savefig.jpeg_quality"] (по умолчанию: 95). Значения выше 95 следует избегать; 100 полностью отключает этап квантования JPEG.

optimizebool

Если True, указывает, что кодировщик JPEG должен выполнить дополнительный проход по изображению, чтобы выбрать оптимальные параметры кодировщика. Применимо только если формат — jpg или jpeg, в противном случае игнорируется. По умолчанию False.

progressivebool

Если True, указывает, что это изображение должно быть сохранено как прогрессивный JPEG-файл. Применимо только если формат — jpg или jpeg, в противном случае игнорируется. По умолчанию False.

facecolorcolor or None, optional

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

edgecolorcolor or None, optional

Цвет обводки фигуры; если None, по умолчанию используется rcParams["savefig.edgecolor"] (по умолчанию: 'white')

orientation{'landscape', 'portrait'}

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

papertypestr

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

formatstr

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

transparentbool

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

bbox_inchesstr or Bbox, optional

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

pad_inchesscalar, optional

Количество отступов вокруг фигуры, когда bbox_inches — 'tight'. Если None, используется savefig.pad_inches

bbox_extra_artistslist of Artist, optional

Список дополнительных графических объектов, которые будут учтены при расчете строгого bbox.

metadatadict, optional

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

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

pil_kwargsdict, optional

Дополнительные ключевые параметры, которые передаются в PIL.Image.save при сохранении фигуры. Применимо только для форматов, которые сохраняются с помощью Pillow, т.е. JPEG, TIFF и (если ключевое слово задано отличным от None значением) PNG.

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

set_canvas(self, canvas) [source]

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

Параметры:	`canvasFigureCanvas`

set_constrained_layout(self, constrained) [source]

Установить, используется ли constrained_layout при отрисовке. Если None, будет использоваться значение rcParams['figure.constrained_layout.use'].

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

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

Параметры:	`constrainedbool or dict or None`

set_constrained_layout_pads(self, **kwargs) [source]

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

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

Параметры:

Параметры:	`w_padscalar` Отступ по ширине в дюймах. Это отступ вокруг осей, предназначенный для того, чтобы гарантировать, что шрифты выглядят хорошо. По умолчанию 3 pt = 0.04167 дюйма `h_padscalar` Отступ по высоте в дюймах. По умолчанию 3 pt. `wspacescalar` Отступ по ширине между подграфиками, выраженный как доля ширины подграфика. Общий отступ получается в результате w_pad + wspace. `hspacescalar` Отступ по высоте между подграфиками, выраженный как доля ширины подграфика. Общий отступ получается в результате h_pad + hspace.

w_padscalar: Отступ по ширине в дюймах. Это отступ вокруг осей, предназначенный для того, чтобы гарантировать, что шрифты выглядят хорошо. По умолчанию 3 pt = 0.04167 дюйма
h_padscalar: Отступ по высоте в дюймах. По умолчанию 3 pt.
wspacescalar: Отступ по ширине между подграфиками, выраженный как доля ширины подграфика. Общий отступ получается в результате w_pad + wspace.
hspacescalar: Отступ по высоте между подграфиками, выраженный как доля ширины подграфика. Общий отступ получается в результате h_pad + hspace.

set_dpi(self, val) [source]

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

Параметры:	`valfloat`

set_edgecolor(self, color) [source]

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

Параметры:	`colorcolor`

set_facecolor(self, color) [source]

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

Параметры:	`colorcolor`

set_figheight(self, val, forward=True) [source]

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

Параметры:	`valfloat` `forwardbool`

set_figwidth(self, val, forward=True) [source]

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

Параметры:	`valfloat` `forwardbool`

set_frameon(self, b) [source]

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

Параметры:	`bbool`

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

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

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

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

Параметры:

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

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

См. также

matplotlib.Figure.get_size_inches

set_tight_layout(self, tight) [source]

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

Параметры:

Параметры:	`tightbool or dict with keys "pad", "w_pad", "h_pad", "rect" or None` Если булевское значение, устанавливает, вызывать ли `tight_layout` при рисовании. Если `None`, используйте `figure.autolayout` rcparam вместо. Если словарь, передайте его как kwargs в `tight_layout`, переопределяя значения по умолчанию отступов.

tightbool or dict with keys "pad", "w_pad", "h_pad", "rect" or None: Если булевское значение, устанавливает, вызывать ли tight_layout при рисовании. Если None, используйте figure.autolayout rcparam вместо. Если словарь, передайте его как kwargs в tight_layout, переопределяя значения по умолчанию отступов.

show(self, warn=True) [source]

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

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

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

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

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

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

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

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

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

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

Параметры:

Параметры:	`nrows, ncolsint, optional, default: 1` Число строк/столбцов сетки подграфиков. `sharex, shareybool or {'none', 'all', 'row', 'col'}, default: 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, optional, default: True` Если True, из возвращаемого массива осей удаляются дополнительные измерения: если создан только один подграфик (nrows=ncols=1), возвращается единственный объект Axes как скаляр. для подграфиков Nx1 или 1xM возвращаемый объект — это одномерный массив numpy объектов Axes. для подграфиков NxM с N>1 и M>1 возвращается двумерный массив. Если False, никакого сжатия не выполняется: возвращаемый объект Axes всегда является двумерным массивом, содержащим объекты Axes, даже если он оказывается 1x1. `subplot_kwdict, optional` Словарь с ключевыми словами, передаваемыми вызову `add_subplot()` для создания каждого подграфика. `gridspec_kwdict, optional` Словарь с ключевыми словами, передаваемыми конструктору `GridSpec` для создания сетки, на которой размещаются подграфики.
Возвращает:	`axAxes object or array of Axes objects.` ax может быть либо единственным объектом `Axes`, либо массивом объектов Axes, если было создано более одного подграфика. Размеры возвращаемого массива можно контролировать с помощью ключевого слова squeeze, см. выше.

nrows, ncolsint, optional, default: 1

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

sharex, shareybool or {'none', 'all', 'row', 'col'}, default: 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, optional, default: True

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

subplot_kwdict, optional

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

gridspec_kwdict, optional

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

Возвращает:

axAxes object or array of Axes objects.: ax может быть либо единственным объектом 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(polar=True))
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(self, left=None, bottom=None, right=None, top=None, wspace=None, hspace=None) [source]: Обновить SubplotParams с помощью kwargs (по умолчанию rc, когда None) и обновить расположение подграфиков.

suptitle(self, 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"]` (значение по умолчанию: 'large') и `rcParams["figure.titleweight"]` (значение по умолчанию: 'normal') игнорируются в этом случае. **kwargs Дополнительные параметры являются свойствами `matplotlib.text.Text`.

Примеры

>>> fig.suptitle('This is the figure title', fontsize=12)

text(self, x, y, s, fontdict=None, withdash=<deprecated parameter>, **kwargs) [source]

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

Параметры:

Параметры:	`x, yfloat` Позиция размещения текста. По умолчанию в координатах рисунка, числа в диапазоне [0, 1]. Система координат может быть изменена с помощью параметра transform. `sstr` Строка текста. `fontdictdictionary, optional, default: None` Словарь для переопределения свойств текста по умолчанию. Если fontdict равен None, значения по умолчанию определяются параметрами rc. Свойство в kwargs переопределяет соответствующее свойство в fontdict. `withdashboolean, optional, default: False` Создаёт экземпляр `TextWithDash` вместо экземпляра `Text`.
Возвращает:	`textText`

x, yfloat: Позиция размещения текста. По умолчанию в координатах рисунка, числа в диапазоне [0, 1]. Система координат может быть изменена с помощью параметра transform.
sstr: Строка текста.
fontdictdictionary, optional, default: None: Словарь для переопределения свойств текста по умолчанию. Если fontdict равен None, значения по умолчанию определяются параметрами rc. Свойство в kwargs переопределяет соответствующее свойство в fontdict.
withdashboolean, optional, default: False: Создаёт экземпляр TextWithDash вместо экземпляра Text.

Возвращает:

textText

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

**kwargsText properties

Дополнительные параметры текстовых параметров.

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

См. также

Axes.text
pyplot.text

tight_layout(self, renderer=<deprecated parameter>, pad=1.08, h_pad=None, w_pad=None, rect=None) [source]

Автоматически настраивает параметры подграфиков, чтобы обеспечить заданный отступ.

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

Параметры:

renderersubclass of RendererBase, optional: По умолчанию рендерер для фигуры. Устарело.
padfloat, optional: Отступ между краем фигуры и краями подграфиков, как доля размера шрифта.
h_pad, w_padfloat, optional: Отступ (высота/ширина) между краями смежных подграфиков, как доля размера шрифта. По умолчанию совпадает с параметром pad.
recttuple (left, bottom, right, top), optional: Прямоугольник (слева, снизу, справа, сверху) в нормализованных координатах фигуры, в который будет помещена вся область подграфиков (включая подписи). По умолчанию (0, 0, 1, 1).

См. также

Figure.set_tight_layout
pyplot.tight_layout

waitforbuttonpress(self, timeout=- 1) [source]

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

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

Если timeout отрицателен, таймаут не используется.