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 — булево значение, это переопределит рендеринг.

Параметры:

Параметры:	`figsize : 2-tuple of floats, default: rcParams["figure.figsize"]` Размер фигуры `(width, height)` в дюймах. `dpi : float, default: rcParams["figure.dpi"]` Точек на дюйм. `facecolor : default: rcParams["figure.facecolor"]` Цвет заливки области фона фигуры. `edgecolor : default: rcParams["figure.edgecolor"]` Цвет рамки области фона фигуры. `linewidth : float` Ширина линии рамки (т.е. ширина линии рамки области фона фигуры). `frameon : bool, default: rcParams["figure.frameon"]` Если `False`, подавить отрисовку области фона фигуры. `subplotpars : SubplotParams` Параметры подграфиков. Если не заданы, используются значения по умолчанию `rcParams["figure.subplot."]`. `tight_layout : bool or dict, default: rcParams["figure.autolayout"]` Если `False`, использовать subplotpars*. Если `True`, настроить параметры подграфиков с помощью `tight_layout` с отступами по умолчанию. При указании словаря, содержащего ключи `pad`, `w_pad`, `h_pad`, и `rect`, значения отступов по умолчанию для `tight_layout` будут переопределены. `constrained_layout : bool` Если `True`, использовать ограниченную компоновку для настройки позиционирования элементов графика. Похоже на `tight_layout`, но разработано для большей гибкости. См. Руководство по ограниченной компоновке для примеров. (Примечание: не работает с `subplot()` или `subplot2grid()`.) Значение по умолчанию `rcParams["figure.constrained_layout.use"]`.

figsize : 2-tuple of floats, default: rcParams["figure.figsize"]: Размер фигуры (width, height) в дюймах.
dpi : float, default: rcParams["figure.dpi"]: Точек на дюйм.
facecolor : default: rcParams["figure.facecolor"]: Цвет заливки области фона фигуры.
edgecolor : default: rcParams["figure.edgecolor"]: Цвет рамки области фона фигуры.
linewidth : float: Ширина линии рамки (т.е. ширина линии рамки области фона фигуры).
frameon : bool, default: rcParams["figure.frameon"]: Если False, подавить отрисовку области фона фигуры.
subplotpars : SubplotParams: Параметры подграфиков. Если не заданы, используются значения по умолчанию rcParams["figure.subplot.*"].
tight_layout : bool or dict, default: rcParams["figure.autolayout"]: Если False, использовать subplotpars. Если True, настроить параметры подграфиков с помощью tight_layout с отступами по умолчанию. При указании словаря, содержащего ключи pad, w_pad, h_pad, и rect, значения отступов по умолчанию для tight_layout будут переопределены.
constrained_layout : bool: Если True, использовать ограниченную компоновку для настройки позиционирования элементов графика. Похоже на tight_layout, но разработано для большей гибкости. См. Руководство по ограниченной компоновке для примеров. (Примечание: не работает с subplot() или subplot2grid().) Значение по умолчанию rcParams["figure.constrained_layout.use"].

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

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

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

Параметры:

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

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

Возвращает:

artist : The added Artist

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

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

Подписи:

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

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

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, принимающая массив float (m, n, 3) и значение dpi, и возвращающая массив float (m, n, 3)
`alpha`	вещественное число
`anchor`	2-кортеж вещественных чисел или {'C', 'SW', 'S', 'SE', ...}
`animated`	логическое значение
`aspect`	{'auto', 'equal'} или число
`autoscale_on`	логическое значение
`autoscalex_on`	логическое значение
`autoscaley_on`	логическое значение
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	логическое значение или 'line'
`clip_box`	`Bbox`
`clip_on`	логическое значение
`clip_path`	[(`Path`, `Transform`) \| `Patch` \| None]
`contains`	вызываемая функция
`facecolor`	цвет
`fc`	цвет
`figure`	`Figure`
`frame_on`	логическое значение
`gid`	строка
`in_layout`	логическое значение
`label`	объект
`navigate`	логическое значение
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или логическое значение или вещественное число или вызываемая функция
`position`	[левый, нижний, ширина, высота] или `Bbox`
`rasterization_zorder`	вещественное число или None
`rasterized`	логическое значение или None
`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

Примечания

Если в фигуре уже есть ось с ключом (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, у которой эта фигура является родителем. Это позволяет сложное расположение осей в фигуре.

Параметры:	`nrows : int` Количество строк в сетке. `ncols : int` Количество столбцов в сетке.
Возвращает:	`gridspec : 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_subplot(self, *args, **kwargs) [source]

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

Подписи:

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

Параметры:	args Либо трехзначное целое число, либо три отдельных целых числа, описывающие положение подграфика. Если три целых числа представляют собой nrows, ncols* и index, подграфик займет позицию index в сетке с nrows строками и ncols столбцами. index начинается с 1 в верхнем левом углу и увеличивается вправо. pos — трехзначное целое число, где первая цифра — количество строк, вторая — количество столбцов, а третья — индекс подграфика. Например, 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`). строка — имя пользовательской проекции, см. `projections`. Значение по умолчанию None соответствует проекции 'rectilinear'. `polar : boolean, optional` Если True, эквивалентно projection='polar'. `sharex, sharey : Axes, optional` Поделиться x или y `axis` с sharex и/или sharey. Ось будет иметь те же пределы, деления и масштаб, что и ось уделяемой оси. `label : str` Метка для возвращенной оси.
Возвращает:	`axes : axes.SubplotBase, or another subclass of Axes` Ось подграфика. Базовый класс возвращенной оси зависит от используемой проекции. Это `Axes`, если используется прямолинейная проекция, и `projections.polar.PolarAxes`, если используется полярная проекция. Возвращаемая ось является подклассом базового класса подграфика.
Другие параметры:	**kwargs Этот метод также принимает ключевые аргументы для базового класса возвращенной оси. Ключевые аргументы для прямолинейного базового класса `Axes` можно найти в следующей таблице, но также могут быть другие ключевые аргументы, если используется другая проекция.

Свойство	Описание
`adjustable`	{'рамка', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	float
`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`	[(`Path`, `Transform`) \| `Patch` \| 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`	[левый, нижний, ширина, высота] или `Bbox`
`rasterization_zorder`	float или None
`rasterized`	bool или None
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	bool
`xbound`	неизвестно
`xlabel`	строка
`xlim`	(левый: float, правый: float)
`xmargin`	float больше -0.5
`xscale`	{"линейный", "логарифмический", "симлогический", "логит", ...}
`xticklabels`	Список[строка]
`xticks`	список
`ybound`	неизвестно
`ylabel`	строка
`ylim`	(нижний: float, верхний: float)

`ymargin`	число, большее -0.5
`yscale`	{"линейное", "логарифмическое", "симлогирифмическое", "логит", ...}
`yticklabels`	Список строк
`yticks`	список
`zorder`	число с плавающей точкой

См. также

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

Примечания

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

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

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

См. также

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

align_xlabels(self, axs=None) [source]

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

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

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

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

См. также

matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_labels

Примечания

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

Примеры

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

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

align_ylabels(self, axs=None) [source]

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

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

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

См. также

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

Примечания

Примеры

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

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

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

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

Параметры:

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

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

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) `cax : Axes object, optional` Ось, на которой будет отображаться шкала цветов. `ax : Axes, list of Axes, optional` Родительская ось, из которой будет заимствовано пространство для новой оси шкалы цвета. Если задан список осей, они все будут изменены, чтобы освободить место для оси шкалы цвета. `use_gridspec : bool, optional` Если cax это `None`, новая cax создаётся как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec это `True`, cax создается как экземпляр Subplot с использованием модуля `gridspec`.
Возвращает:	`colorbar : Colorbar` См. также его базовый класс `ColorbarBase`. Используйте `set_label` для маркировки шкалы цвета.

mappable

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

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

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

cax : Axes object, optional

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

ax : Axes, list of Axes, optional

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

use_gridspec : bool, optional

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

Возвращает:

colorbar : Colorbar: См. также его базовый класс ColorbarBase. Используйте set_label для маркировки шкалы цвета.

Примечания

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

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

Свойство	Описание
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	[ 'ничего' \| 'всё' \| 'мин' \| 'макс' ] Если не 'ничего', создаёт нарисованные концы для значений вне диапазона. Эти значения устанавливаются для данной цветовой карты с помощью методов set_under и set_over цветовой карты.
extendfrac	[ None \| 'авто' \| длина \| длины ] Если None, оба треугольных расширения шкалы цветов с минимумом и максимумом имеют длину 5% от длины внутренней шкалы цвета (это значение по умолчанию). Если 'авто', делает треугольные расширения шкалы цветов той же длины, что и внутренние прямоугольники (когда spacing установлен в 'равномерное') или той же длины, что и соответствующие соседние внутренние прямоугольники (когда spacing установлен в 'пропорционально'). Если скаляр, указывает длину обоих треугольных расширений шкалы цветов как долю длины внутренней шкалы цвета. Также можно указать последовательность из двух элементов, указывающую длину минимального и максимального расширений шкалы цветов соответственно как долю длины внутренней шкалы цвета.
extendrect	bool Если False, минимальные и максимальные расширения шкалы цветов будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	[ 'равномерно' \| 'пропорционально' ] Равномерное расстояние обеспечивает каждому дискретному цвету одинаковое пространство; пропорциональное делает пространство пропорциональным интервалу данных.
ticks	[ None \| список меток \| Объект локализации ] Если None, метки определяются автоматически из входных данных.
format	[ None \| строка формата \| объект Формататор ] Если None, используется `ScalarFormatter`. Если задана строка формата, например, '%.3f', используется именно она. Вместо этого можно указать альтернативный объект `Formatter`.
drawedges	bool Отрисовывать ли линии на границах цветов.

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

Известно, что некоторые просмотрщики векторной графики (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 из рисунка и обновить текущую ось.

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 для определения положений внутри осей.

См. также 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, yo : int` Смещение изображения по x/y в пикселях. `alpha : None or float` Значение альфа-смешивания. `norm : matplotlib.colors.Normalize` Экземпляр `Normalize` для сопоставления яркости с интервалом [0, 1]. `cmap : str or matplotlib.colors.Colormap` Цветовая карта для использования. По умолчанию: `rcParams["image.cmap"]`. `vmin, vmax : scalar` Если norm не задан, эти значения устанавливают пределы данных для цветовой карты. `origin : {'upper', 'lower'}` Указывает, где индекс [0, 0] массива находится в верхнем левом или нижнем левом углу осей. По умолчанию `rcParams["image.origin"]`. `resize : bool` Если True, размер фигуры изменяется для соответствия заданному размеру изображения.
Возвращает:	`matplotlib.image.FigureImage`
Другие параметры:	*kwargs Дополнительные параметры kwargs* являются параметрами `Artist`, которые передаются методу `FigureImage`.

Примечания

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

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

gca(self, **kwargs) [source]

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

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

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	вещественное число
`anchor`	2-кортеж с плавающей точкой или {'C', 'SW', 'S', 'SE', ...}
`animated`	логическое значение
`aspect`	{'auto', 'equal'} или число
`autoscale_on`	логическое значение
`autoscalex_on`	логическое значение
`autoscaley_on`	логическое значение
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	логическое значение или 'line'
`clip_box`	`Bbox`
`clip_on`	логическое значение
`clip_path`	[(`Path`, `Transform`) \| `Patch` \| None]
`contains`	вызываемый объект
`facecolor`	цвет
`fc`	цвет
`figure`	`Figure`
`frame_on`	логическое значение
`gid`	строка
`in_layout`	логическое значение
`label`	объект
`navigate`	логическое значение
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или логическое значение или число с плавающей точкой или вызываемый объект
`position`	[left, bottom, width, height] или `Bbox`
`rasterization_zorder`	число с плавающей точкой или None
`rasterized`	логическое значение или None
`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`	вещественное число

get_axes(self) [source]

Возвращает список осей в 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.

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

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

Параметры:	`relative : boolean` Если `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]

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

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

См. также

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) не включаются в прямоугольник.

Параметры:

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

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

Возвращает:

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

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: кнопка мыши не выбрана

Параметры:

Параметры:	`n : int, optional, default: 1` Количество кликов мыши для накопления. Если отрицательно, накапливать клики до тех пор, пока ввод не будет завершен вручную. `timeout : scalar, optional, default: 30` Количество секунд ожидания перед истечением времени. Если равно нулю или меньше, таймаут не срабатывает. `show_clicks : bool, 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)` Кнопка мыши, используемая для остановки ввода.
Возвращаемое значение:	`points : list of tuples` Список координат кликов (x, y).

n : int, optional, default: 1: Количество кликов мыши для накопления. Если отрицательно, накапливать клики до тех пор, пока ввод не будет завершен вручную.
timeout : scalar, optional, default: 30: Количество секунд ожидания перед истечением времени. Если равно нулю или меньше, таймаут не срабатывает.
show_clicks : bool, 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): Кнопка мыши, используемая для остановки ввода.

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

points : list 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')

Параметры:

handles : sequence of Artist, optional

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

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

labels : sequence of strings, optional

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

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

matplotlib.legend.Legend instance

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

loc : str or pair of floats, default: rcParams["legend.loc"] ('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_anchor : BboxBase, 2-tuple, or 4-tuple of floats

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

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

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

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

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

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

ncol : integer

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

prop : None or matplotlib.font_manager.FontProperties or dict

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

fontsize : int or float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

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

numpoints : None or int

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

scatterpoints : None or int

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

scatteryoffsets : iterable of floats

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

markerscale : None or int or float

Относительный размер маркеров легенды по сравнению с первоначально нарисованными. По умолчанию None, которое будет взято из rcParams["legend.markerscale"].

markerfirst : bool

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

frameon : None or bool

Управление отображением легенды на области (рамке). По умолчанию None, которое будет взято из rcParams["legend.frameon"].

fancybox : None or bool

Управление включением скругленных углов вокруг FancyBboxPatch, которые составляют фоновый прямоугольник легенды. По умолчанию None, которое будет взято из rcParams["legend.fancybox"].

shadow : None or bool

Управление отображением тени за легендой. По умолчанию None, которое будет взято из rcParams["legend.shadow"].

framealpha : None or float

Управление альфа-прозрачностью фона легенды. По умолчанию None, которое будет взято из rcParams["legend.framealpha"]. Если тень включена и framealpha равно None, значение по умолчанию игнорируется.

facecolor : None or "inherit" or a color spec

Управление цветом фона легенды. По умолчанию None, которое будет взято из rcParams["legend.facecolor"]. Если "inherit", оно будет взято из rcParams["axes.facecolor"].

edgecolor : None or "inherit" or a color spec

Управление цветом края фоновой области легенды. По умолчанию None, которое будет взято из rcParams["legend.edgecolor"] Если "inherit", оно будет взято из rcParams["axes.edgecolor"].

mode : {"expand", None}

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

bbox_transform : None or matplotlib.transforms.Transform

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

title : str or None

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

title_fontsize: str или None

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

borderpad : float or None

Доля отступа внутри границы легенды. Измеряется в единицах размера шрифта. По умолчанию None, которое будет взято из rcParams["legend.borderpad"].

labelspacing : float or None

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

handlelength : float or None

Длина маркеров легенды. Измеряется в единицах размера шрифта. По умолчанию None, которое будет взято из rcParams["legend.handlelength"].

handletextpad : float or None

Отступ между маркером легенды и текстом. Измеряется в единицах размера шрифта. По умолчанию None, которое будет взято из rcParams["legend.handletextpad"].

borderaxespad : float or None

Отступ между осями и границей легенды. Измеряется в единицах размера шрифта. По умолчанию None, которое будет взято из rcParams["legend.borderaxespad"].

columnspacing : float or None

Интервал между столбцами. Измеряется в единицах размера шрифта. По умолчанию None, которое будет взято из rcParams["legend.columnspacing"].

handler_map : dict 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)

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

Параметры:

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

fname : str or PathLike or file-like object

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

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

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

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

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

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

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

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

optimize : bool

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

progressive : bool

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

facecolor : color spec or None, optional

Цвет фона фигуры; если None, по умолчанию rcParams["savefig.facecolor"].

edgecolor : color spec or None, optional

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

orientation : {'landscape', 'portrait'}

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

papertype : str

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

format : str

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

transparent : bool

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

bbox_inches : str or Bbox, optional

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

pad_inches : scalar, optional

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

bbox_extra_artists : list of Artist, optional

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

metadata : dict, optional

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

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

pil_kwargs : dict, optional

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

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

set_canvas(self, canvas) [source]

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

Параметры:	`canvas : FigureCanvas`

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 — по высоте.

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

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

set_constrained_layout_pads(self, **kwargs) [source]

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

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

Параметры:

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

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

set_dpi(self, val) [source]

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

Параметры:	`val : float`

set_edgecolor(self, color) [source]

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

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

set_facecolor(self, color) [source]

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

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

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

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

Параметры:	`val : float` `forward : bool`

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

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

Параметры:	`val : float` `forward : bool`

set_frameon(self, b) [source]

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

Параметры:	`b : bool`

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

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

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

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

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

ПРИНИМАЕТ: кортеж (w, h) с w, h в дюймах

См. также

matplotlib.Figure.get_size_inches

set_tight_layout(self, tight) [source]

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

Параметры:

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

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

show(self, warn=True) [source]

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

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

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

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

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

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

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

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

Добавить набор подрисунков в данный рисунок.

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

Параметры:

Параметры:	`nrows, ncols : int, optional, default: 1` Число строк/столбцов сетки подрисунков. `sharex, sharey : bool 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`. `squeeze : bool, optional, default: True` Если True, лишние измерения удаляются из возвращаемого массива объектов Axes: если создан только один подрисунок (nrows=ncols=1), возвращается единственный объект Axes в виде скаляра. для подрисунков Nx1 или 1xM, возвращаемый объект — одномерный массив numpy объектов Axes. для NxM, подрисунков с N>1 и M>1, возвращается двумерный массив. Если False, никакого сжатия не выполняется: возвращаемый объект Axes всегда является двумерным массивом, содержащим объекты Axes, даже если он окажется 1x1. `subplot_kw : dict, optional` Словарь с ключевыми словами, передаваемыми в вызов `add_subplot()` для создания каждого подрисунка. `gridspec_kw : dict, optional` Словарь с ключевыми словами, передаваемыми в конструктор `GridSpec`, используемый для создания сетки, на которой размещаются подрисунки.
Возвращает:	`ax : Axes object or array of Axes objects.` ax может быть либо одним объектом `Axes`, либо массивом объектов Axes, если было создано более одного подрисунка. Размеры возвращаемого массива можно контролировать с помощью ключевого слова squeeze, см. выше.

nrows, ncols : int, optional, default: 1

Число строк/столбцов сетки подрисунков.

sharex, sharey : bool 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.

squeeze : bool, optional, default: True

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

subplot_kw : dict, optional

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

gridspec_kw : dict, optional

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

Возвращает:

ax : Axes object or array of Axes objects.: ax может быть либо одним объектом Axes, либо массивом объектов Axes, если было создано более одного подрисунка. Размеры возвращаемого массива можно контролировать с помощью ключевого слова squeeze, см. выше.

Примеры

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

# Create a figure
plt.figure()

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

# Creates two subplots and unpacks 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)

# Creates four polar axes, and accesses 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 (по умолчанию, если None), и обновить расположение подрисунков.

suptitle(self, t, **kwargs) [source]

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

Параметры:	`t : str` Текст заголовка. `x : float, default 0.5` Позиция текста по оси X в координатах рисунка. `y : float, default 0.98` Позиция текста по оси Y в координатах рисунка. `horizontalalignment, ha : {'center', 'left', right'}, default: 'center'` Горизонтальное выравнивание текста относительно (x, y). `verticalalignment, va : {'top', 'center', 'bottom', 'baseline'}, default: 'top'` Вертикальное выравнивание текста относительно (x, y). `fontsize, size : default: rcParams["figure.titlesize"]` Размер шрифта текста. См. `Text.set_size` для возможных значений. `fontweight, weight : default: rcParams["figure.titleweight"]` Начертание шрифта текста. См. `Text.set_weight` для возможных значений.
Возвращаемое значение:	text Экземпляр `Text` заголовка.
Другие параметры:	`fontproperties : None or dict, optional` Словарь свойств шрифта. Если fontproperties указан, значения по умолчанию для размера и начертания шрифта берутся из параметров `FontProperties` по умолчанию. `rcParams["figure.titlesize"]` и `rcParams["figure.titleweight"]` игнорируются в этом случае. **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, y : float` Позиция размещения текста. По умолчанию в координатах рисунка, числа в диапазоне [0, 1]. Система координат может быть изменена с помощью параметра transform. `s : str` Строка текста. `fontdict : dictionary, optional, default: None` Словарь для переопределения свойств текста. Если fontdict равен None, значения по умолчанию определяются параметрами rc. Свойство в kwargs переопределяет то же свойство в fontdict. `withdash : boolean, optional, default: False` Создаёт экземпляр `TextWithDash`, а не `Text`.
Возвращаемое значение:	`text : Text`

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

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

text : Text

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

**kwargs : Text properties

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	вещественное число
`animated`	логическое значение
`backgroundcolor`	цвет
`bbox`	словарь с свойствами для `patches.FancyBboxPatch`
`clip_box`	`Bbox`
`clip_on`	логическое значение
`clip_path`	[(`Path`, `Transform`) \| `Patch` \| 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 или логическое значение или вещественное число или вызываемый объект
`position`	(вещественное число, вещественное число)
`rasterized`	логическое значение или None
`rotation`	{угол в градусах, 'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: вещественное число, длина: вещественное число, случайность: вещественное число)
`snap`	логическое значение или None
`text`	объект
`transform`	`Transform`
`url`	строка
`usetex`	логическое значение или None
`verticalalignment` или va	{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
`visible`	логическое значение
`wrap`	логическое значение
`x`	вещественное число
`y`	вещественное число
`zorder`	вещественное число

См. также

Axes.text
pyplot.text

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

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

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

Параметры:

Параметры:	`renderer : subclass of RendererBase, optional` По умолчанию используется рендерер для фигуры. `rect : tuple (left, bottom, right, top), optional` Отступ между краем фигуры и краями подграфиков, как доля размера шрифта. `h_pad, w_pad : float, optional` Отступ (высота/ширина) между краями смежных подграфиков, как доля размера шрифта. По умолчанию — pad. `pad : float, optional` Прямоугольник (слева, снизу, справа, сверху) в нормированных координатах фигуры, в который будет помещаться вся область подграфиков (включая подписи). По умолчанию (0, 0, 1, 1).

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