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(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(*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, и возвращает массив (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`	число с плавающей точкой или None
`rasterized`	bool или None
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	bool
`xbound`	(нижний: float, верхний: float)
`xlabel`	строка
`xlim`	(левый: float, правый: float)
`xmargin`	float больше -0,5
`xscale`	{"линейный", "логарифмический", "симлогарифмический", "логит", ...}
`xticklabels`	Список[строка]
`xticks`	список
`ybound`	(нижний: float, верхний: float)
`ylabel`	строка
`ylim`	(нижняя: float, верхняя: float)
`ymargin`	float больше -0,5

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

См. также

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

Примечания

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

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

Примеры

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

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

add_gridspec(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(*args, **kwargs) [source]

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

Вызовы:

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

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

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (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`	[левый, нижний, ширина, высота] или `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_axes, pyplot.subplot, pyplot.axes, Figure.subplots, pyplot.subplots

Примечания

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

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

Примеры

fig=plt.figure(1)
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(axs=None) [source]

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

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

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

См. также

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

align_xlabels(axs=None) [source]

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

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

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

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

См. также

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

Примечания

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

Примеры

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

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

align_ylabels(axs=None) [source]

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

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

Параметры:	`axs : list of Axes` Необязательный список (или массив ndarray) `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(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'}` Выбирает метки xtick, которые нужно повернуть. По умолчанию None, что работает так же, как major.

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

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

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

clf(keep_observers=False) [source]

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

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

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

Создать цветовой бар для объекта ScalarMappable, mappable.

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

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

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

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

Параметры:

Параметры:	mappable : Объект `Image`, `ContourSet` и т. д., к которому применяется цветовой бар; этот аргумент обязателен для метода Figure `colorbar()`, но необязателен для функции pyplot `colorbar()`, которая устанавливает значение по умолчанию для текущего изображения. `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 с использованием модуля grid_spec.
Возвращает:	экземпляр :class:`~matplotlib.colorbar.Colorbar` См. также его базовый класс, `ColorbarBase`. Используйте метод `set_label()` для подписи цветового бара.

mappable :: Объект Image, ContourSet и т. д., к которому применяется цветовой бар; этот аргумент обязателен для метода Figure colorbar(), но необязателен для функции pyplot colorbar(), которая устанавливает значение по умолчанию для текущего изображения.
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 с использованием модуля grid_spec.

Возвращает:

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

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

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

Свойство

Описание

boundaries

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

values

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

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

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

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

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

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

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

contains(mouseevent) [source]

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

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

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

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

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

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

execute_constrained_layout(renderer=None) [source]

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

См. также set_constrained_layout_pads.

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

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

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

Параметры:	X Данные изображения. Это массив одной из следующих форм: MxN: значения яркости (серого тона) MxNx3: значения RGB MxNx4: значения RGBA `xo, 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, размер рисунка изменяется, чтобы соответствовать заданному размеру изображения.
Возвращает:	:class:`matplotlib.image.FigureImage`
Другие параметры:	**kwargs Дополнительные параметры kwargs, которые передаются `Artist` kwargs, передаваемые методу `FigureImage`.

Примечания

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

Примеры:

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

gca(**kwargs) [source]

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

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

Свойство	Описание
`adjustable`	{'box', '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`	(нижнее значение: float, верхнее значение: float)
`xlabel`	строка
`xlim`	(левый: float, правый: float)
`xmargin`	число больше -0,5
`xscale`	{"линейный", "логарифмический", "симлогарифмический", "логарифмический", ...}
`xticklabels`	Список[строка]
`xticks`	список
`ybound`	(нижнее значение: float, верхнее значение: float)
`ylabel`	строка
`ylim`	(нижнее значение: float, верхнее значение: float)
`ymargin`	число больше -0,5
`yscale`	{"линейный", "логарифмический", "симлогарифмический", "логарифмический", ...}

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

get_axes() [source]

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

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

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

get_children() [source]: Получить список объектов-артистов, содержащихся в графике.

get_constrained_layout() [source]

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

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

get_constrained_layout_pads(relative=False) [source]

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

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

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

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

get_default_bbox_extra_artists() [source]

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

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

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

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

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

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

get_size_inches() [source]

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

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

См. также

matplotlib.Figure.set_size_inches

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

get_tightbbox(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(*args, **kwargs) [source]: Возвращает ограничивающее прямоугольник фигуры в пространстве отображения. Аргументы игнорируются.

ginput(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 для правой.

Параметры:

Параметры:	`n : int, optional, default: 1` Количество кликов мышью для накопления. Если отрицательно, то накапливать клики, пока ввод не будет завершен вручную. `timeout : scalar, optional, default: 30` Количество секунд ожидания перед таймаутом. Если ноль или меньше, таймаут никогда не произойдет. `show_clicks : bool, optional, default: False` Если True, отобразить красный крест в месте каждого клика. `mouse_add : int, one of (1, 2, 3), optional, default: 1 (left click)` Кнопка мыши, используемая для добавления точек. `mouse_pop : int, one of (1, 2, 3), optional, default: 3 (right click)` Кнопка мыши, используемая для удаления последней добавленной точки. `mouse_stop : int, one of (1, 2, 3), 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: False: Если True, отобразить красный крест в месте каждого клика.
mouse_add : int, one of (1, 2, 3), optional, default: 1 (left click): Кнопка мыши, используемая для добавления точек.
mouse_pop : int, one of (1, 2, 3), optional, default: 3 (right click): Кнопка мыши, используемая для удаления последней добавленной точки.
mouse_stop : int, one of (1, 2, 3), optional, default: 2 (middle click): Кнопка мыши, используемая для остановки ввода.

Возвращает:

points : list of tuples: Список координат кликов (x, y).

Примечания

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

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

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

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

labels : sequence of strings, optional

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

Возвращает:

экземпляр :class:`matplotlib.legend.Legend`

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

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

Положение легенды. Возможные коды:

Строковое обозначение положения	Код положения
'best'	0
'верхний правый'	1
'верхний левый'	2
'нижний левый'	3
'нижний правый'	4
'правый'	5
'центр слева'	6
'центр справа'	7
'нижний центр'	8
'верхний центр'	9
'центр'	10

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

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 or 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(fname, *, frameon=None, 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 file-like object` Строка с путём к файлу, объект-подобный файлу Python или, возможно, объект, зависящий от бэкенда, такой как `PdfPages`. Если format имеет значение None, а fname — строку, формат вывода определяется по расширению имени файла. Если у имени файла нет расширения, используется `rcParams["savefig.format"]`. Если fname не является строкой, необходимо указать format, чтобы гарантировать использование корректного бэкенда.
Другие параметры:	`dpi : [ None \| scalar > 0 \| 'figure' ]` Разрешение в точках на дюйм. Если None, используется значение по умолчанию `rcParams["savefig.dpi"]`. Если 'figure', используется значение dpi фигуры. `quality : [ None \| 1 <= scalar <= 100 ]` Качество изображения в диапазоне от 1 (худшее) до 95 (лучшее). Применимо только для форматов jpg или jpeg, в противном случае игнорируется. Если None, используется значение по умолчанию `rcParams["savefig.jpeg_quality"]` (95 по умолчанию). Значения выше 95 следует избегать; 100 полностью отключает стадию квантования JPEG. `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, ps, eps и svg. `transparent : bool` Если True, все области Axes будут прозрачными; область Figure также будет прозрачной, если не заданы facecolor и/или edgecolor с помощью ключевых слов. Это полезно, например, для отображения графика поверх цветного фона на веб-странице. Прозрачность этих областей вернётся к исходным значениям при завершении этой функции. `frameon : bool` Если True, область Figure будет цветной; если False, фон фигуры будет прозрачным. Если не указано, будет использовано значение rcParam 'savefig.frameon'. `bbox_inches : str or Bbox, optional` Bbox в дюймах. Сохраняется только указанная часть фигуры. Если 'tight', то пытается определить tight bbox фигуры. Если None, используется savefig.bbox `pad_inches : scalar, optional` Количество отступа вокруг фигуры, когда bbox_inches равен 'tight'. Если None, используется savefig.pad_inches. `bbox_extra_artists : list of Artist, optional` Список дополнительных объектов-артистов, которые будут учитываться при расчёте tight bbox. `metadata : dict, optional` Ключ-значение для хранения в метаданных изображения. Поддерживаемые ключи и значения по умолчанию зависят от формата изображения и бэкенда: 'png' с бэкендом Agg: См. параметр `metadata` `print_png`. 'pdf' с бэкендом pdf: См. параметр `metadata` `PdfPages`. 'eps' и 'ps' с бэкендом PS: Поддерживается только 'Creator'.

fname : str or file-like object

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

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

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

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

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

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

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

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

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, ps, eps и svg.

transparent : bool

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

frameon : bool

Если True, область Figure будет цветной; если False, фон фигуры будет прозрачным. Если не указано, будет использовано значение rcParam 'savefig.frameon'.

bbox_inches : str or Bbox, optional

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

pad_inches : scalar, optional

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

bbox_extra_artists : list of Artist, optional

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

metadata : dict, optional

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

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

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

set_canvas(canvas) [source]

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

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

set_constrained_layout(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(**kwargs) [source]

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

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

Параметры:

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

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

set_dpi(val) [source]

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

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

set_edgecolor(color) [source]

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

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

set_facecolor(color) [source]

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

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

set_figheight(val, forward=True) [source]: Устанавливает высоту фигуры в дюймах.

set_figwidth(val, forward=True) [source]: Устанавливает ширину фигуры в дюймах.

set_frameon(b) [source]

Устанавливает, отображается ли рамка фигуры (фон) или она скрыта.

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

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

Настройка вызова tight_layout при отрисовке.

Параметры:

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

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

show(warn=True) [source]

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

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

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

Примечания

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

subplots(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, лишние измерения отбрасываются из возвращаемого массива осей: если создан только один подграфик (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, лишние измерения отбрасываются из возвращаемого массива осей:
- если создан только один подграфик (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(1, clear=True)

# 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(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None) [source]: Обновить SubplotParams с помощью kwargs (по умолчанию rc, если None) и обновить расположение подграфиков.

suptitle(t, **kwargs) [source]

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

Параметры:	`t : str` Текст заголовка. `x : float, default 0.5` Положение текста по горизонтали в координатах фигуры. `y : float, default 0.98` Положение текста по вертикали в координатах фигуры. `horizontalalignment, ha : {'center', 'left', right'}, default: 'center'` Горизонтальное выравнивание текста. `verticalalignment, va : {'top', 'center', 'bottom', 'baseline'}, default: 'top'` Вертикальное выравнивание текста. `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 Дополнительные kwargs* являются свойствами `matplotlib.text.Text`.

Примеры

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

text(x, y, s, fontdict=None, withdash=False, **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`	`matplotlib.transforms.Bbox`
`clip_on`	логическое значение
`clip_path`	{ (`path.Path`, `transforms.Transform`), `patches.Patch`, None }
`color`	цвет
`contains`	вызываемая функция
`figure`	`Figure`
`fontfamily`	{НАЗВАНИЕ_ШРИФТА, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontname`	{НАЗВАНИЕ_ШРИФТА, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties`	`font_manager.FontProperties`
`fontsize`	{размер в пунктах, 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
`fontstretch`	{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
`fontstyle`	{'normal', 'italic', 'oblique'}
`fontvariant`	{'normal', 'small-caps'}
`fontweight`	{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
`gid`	строка
`horizontalalignment`	{'center', 'right', 'left'}
`in_layout`	логическое значение
`label`	объект
`linespacing`	вещественное число (кратное размеру шрифта)
`multialignment`	{'left', 'right', 'center'}
`path_effects`	`AbstractPathEffect`
`picker`	None или логическое значение или число с плавающей точкой или вызываемая функция
`position`	(вещественное число, вещественное число)
`rasterized`	логическое значение или None
`rotation`	{угол в градусах, 'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: вещественное число, длина: вещественное число, случайность: вещественное число)
`snap`	логическое значение или None
`text`	строка или объект, преобразуемый в строку (но `None` преобразуется в `''`)
`transform`	`Transform`
`url`	строка
`usetex`	логическое значение или None
`verticalalignment`	{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
`visible`	логическое значение
`wrap`	логическое значение
`x`	вещественное число
`y`	вещественное число
`zorder`	вещественное число

См. также

Axes.text, pyplot.text

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

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

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

Параметры:

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

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

См. также

Figure.set_tight_layout, pyplot.tight_layout

waitforbuttonpress(timeout=-1) [source]

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

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

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