matplotlib.pyplot.figure

matplotlib.pyplot.figure(num=None, figsize=None, dpi=None, *, facecolor=None, edgecolor=None, frameon=True, FigureClass=<class 'matplotlib.figure.Figure'>, clear=False, **kwargs)[source]

Создать новую фигуру или активировать существующую.

Параметры:

numint или str или Figure или SubFigure, необязательно

Уникальный идентификатор фигуры.

Если фигура с этим идентификатором уже существует, эта фигура активируется и возвращается. Целое число относится к атрибуту Figure.number, строка — к метке фигуры.

Если нет фигуры с идентификатором или num не указан, создаётся новая фигура, она активируется и возвращается. Если num — целое число, оно будет использовано для атрибута Figure.number, в противном случае используется сгенерированное автоматически целое число (начиная с 1 и увеличивается для каждой новой фигуры). Если num — строка, метка фигуры и заголовок окна устанавливаются на это значение. Если num — SubFigure, активируется его родительский Figure.

figsize(float, float), по умолчанию: rcParams["figure.figsize"] (по умолчанию: [6.4, 4.8])

Ширина, высота в дюймах.

dpifloat, по умолчанию: rcParams["figure.dpi"] (по умолчанию: 100.0)

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

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

Цвет фона.

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

Цвет рамки.

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

Если False, то рамка фигуры не рисуется.

FigureClassподкласс Figure

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

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

Если True и фигура уже существует, то она очищается.

layout{'constrained', 'compressed', 'tight', 'none', LayoutEngine, None}, по умолчанию: None

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

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

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

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

**kwargs

Дополнительные ключевые аргументы передаются конструктору Figure.

Возвращает:

Figure

Примечания

Новая созданная фигура передается в метод new_manager или функцию new_figure_manager, предоставляемую текущим бэкэндом, которая устанавливает холст и менеджера на фигуре.

После этого вызываются rcParams["figure.hooks"] (по умолчанию: []) по одному на фигуре; эти хуки позволяют произвольно настраивать фигуру (например, добавлять обратные вызовы) или связанные элементы (например, изменять панель инструментов). См. mplcvd — пример настройки панели инструментов для примера настройки панели инструментов.

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

rcParams определяет значения по умолчанию, которые можно изменить в файле matplotlibrc.