matplotlib.layout_engine

Классы для выравнивания элементов в Figure.

Диаграммы имеют свойство layout_engine, которое содержит подкласс LayoutEngine, определённый здесь (или None для отсутствия выравнивания). Во время отрисовки вызывается figure.get_layout_engine().execute(), цель которого обычно состоит в перераспределении осей на диаграмме для создания приятного макета. Это похоже на draw обратный вызов, но с двумя отличиями. Во-первых, при печати мы отключаем движок выравнивания для окончательной отрисовки. Во-вторых, полезно знать движок выравнивания во время создания диаграммы. В частности, цветные шкалы создаются по-разному с различными движками выравнивания (по историческим причинам).

Matplotlib предоставляет два движка выравнивания, TightLayoutEngine и ConstrainedLayoutEngine. Третьи стороны могут создавать собственные движки выравнивания, наследуя от LayoutEngine.

classmatplotlib.layout_engine.ConstrainedLayoutEngine(*, h_pad=None, w_pad=None, hspace=None, wspace=None, rect=(0, 0, 1, 1), compress=False, **kwargs)[source]

Реализует управление геометрией constrained_layout. См. Руководство по выравниванию с ограничениями для получения подробной информации.

Инициализация настроек constrained_layout.

Параметры:

h_pad, w_padfloat: Отступы вокруг элементов осей в дюймах. По умолчанию rcParams["figure.constrained_layout.h_pad"] (по умолчанию: 0.04167) и rcParams["figure.constrained_layout.w_pad"] (по умолчанию: 0.04167).
hspace, wspacefloat: Доля диаграммы, выделяемая для пространства между осями. Эти значения равномерно распределяются между промежутками между осями. Значение 0,2 для трёхстолбцового макета будет иметь пространство 0,1 ширины диаграммы между каждым столбцом. Если h/wspace < h/w_pad, используются отступы. По умолчанию rcParams["figure.constrained_layout.hspace"] (по умолчанию: 0.02) и rcParams["figure.constrained_layout.wspace"] (по умолчанию: 0.02).
rectкортеж из 4 чисел с плавающей точкой: Прямоугольник в координатах диаграммы для выполнения выравнивания с ограничениями (левый, нижний, ширина, высота), каждое от 0 до 1.
compressbool: Определяет, нужно ли смещать оси, чтобы удалить пустое пространство между ними. Это полезно для простых сеток осей с фиксированным аспектом (например, сетка изображений). См. Сетки осей с фиксированным соотношением сторон: макет "compressed".

propertyadjust_compatible: Возвращает булево значение, если движок выравнивания совместим с subplots_adjust.

propertycolorbar_gridspec: Возвращает булево значение, если движок выравнивания создаёт цветные шкалы с использованием gridspec.

execute(fig)[source]

Выполняет constrained_layout и перемещает и изменяет размеры осей соответственно.

Параметры:

figFigure для выполнения выравнивания.

get()[source]: Возвращает копию параметров для движка выравнивания.

set(*, h_pad=None, w_pad=None, hspace=None, wspace=None, rect=None)[source]

Устанавливает отступы для constrained_layout.

Параметры:

h_pad, w_padfloat: Отступы вокруг элементов осей в дюймах. По умолчанию rcParams["figure.constrained_layout.h_pad"] (по умолчанию: 0.04167) и rcParams["figure.constrained_layout.w_pad"] (по умолчанию: 0.04167).
hspace, wspacefloat: Доля диаграммы, выделяемая для пространства между осями. Эти значения равномерно распределяются между промежутками между осями. Значение 0,2 для трёхстолбцового макета будет иметь пространство 0,1 ширины диаграммы между каждым столбцом. Если h/wspace < h/w_pad, используются отступы. По умолчанию rcParams["figure.constrained_layout.hspace"] (по умолчанию: 0.02) и rcParams["figure.constrained_layout.wspace"] (по умолчанию: 0.02).
rectкортеж из 4 чисел с плавающей точкой: Прямоугольник в координатах диаграммы для выполнения выравнивания с ограничениями (левый, нижний, ширина, высота), каждое от 0 до 1.

классmatplotlib.layout_engine.LayoutEngine(**kwargs)[source]

Базовый класс для движков макета Matplotlib.

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

Примечание

Обратите внимание, что движки макета влияют на создание цветовых панелей, поэтому set_layout_engine следует вызывать до создания каких-либо цветовых панелей.

В настоящее время существуют две свойства классов LayoutEngine, которые используются при манипулировании фигурой:

engine.colorbar_gridspec сообщает Figure.colorbar, использовать ли метод сетки gridspec (см. colorbar.make_axes_gridspec) или нет (см. colorbar.make_axes);
engine.adjust_compatible останавливает Figure.subplots_adjust от выполнения,

если он несовместим с движком макета.

Для реализации пользовательского LayoutEngine:

переопределите _adjust_compatible и _colorbar_gridspec
переопределите LayoutEngine.set, чтобы обновить self._params
переопределите LayoutEngine.execute своей реализацией

свойствоadjust_compatible: Возвращает boolean, если движок макета совместим с subplots_adjust.

свойствоcolorbar_gridspec: Возвращает boolean, если движок макета создает цветовые панели с помощью gridspec.

execute(fig)[source]: Выполнить макет на заданной фигуре fig.

get()[source]: Возвращает копию параметров для движка макета.

set(**kwargs)[source]: Установить параметры для движка макета.

классmatplotlib.layout_engine.PlaceHolderLayoutEngine(adjust_compatible, colorbar_gridspec, **kwargs)[source]

Этот движок макета вообще не изменяет макет фигуры.

Цель этого LayoutEngine — выступать в качестве заглушки, когда пользователь удаляет движок макета, чтобы убедиться, что несовместимый LayoutEngine не может быть установлен позже.

Параметры:

adjust_compatible, colorbar_gridspecbool: Разрешить PlaceHolderLayoutEngine копировать поведение любого движка макета, который он заменяет.

свойствоadjust_compatible: Возвращает boolean, если движок макета совместим с subplots_adjust.

свойствоcolorbar_gridspec: Возвращает boolean, если движок макета создает цветовые панели с помощью gridspec.

execute(fig)[source]: Ничего не делает.

get()[source]: Возвращает копию параметров для движка макета.

set(**kwargs)[source]: Установить параметры для движка макета.

classmatplotlib.layout_engine.TightLayoutEngine(*, pad=1.08, h_pad=None, w_pad=None, rect=(0, 0, 1, 1), **kwargs)[source]

Реализует управление геометрией tight_layout. Подробности см. в Руководстве по плотной компоновке.

Инициализирует движок плотной компоновки.

Параметры:

padfloat, по умолчанию: 1.08: Отступ между краем фигуры и краями подграфиков, как доля размера шрифта.
h_pad, w_padfloat: Отступ (высота/ширина) между краями смежных подграфиков. По умолчанию равен pad.
rectкортеж (левый, нижний, правый, верхний), по умолчанию: (0, 0, 1, 1).: Прямоугольник в нормализованных координатах фигуры, в который будут помещены подграфики (включая метки).

propertyadjust_compatible: Возвращает булево значение, если движок компоновки совместим с subplots_adjust.

propertycolorbar_gridspec: Возвращает булево значение, если движок компоновки создаёт цветные шкалы с помощью gridspec.

execute(fig)[source]

Выполнить плотный макет.

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

Параметры:

figFigure для выполнения макета.

См. также

figure.Figure.tight_layout
pyplot.tight_layout

get()[source]: Возвращает копию параметров для движка макета.

set(*, pad=None, w_pad=None, h_pad=None, rect=None)[source]

Устанавливает отступы для плотной компоновки.

Параметры:

padfloat: Отступ между краем фигуры и краями подграфиков, как доля размера шрифта.
w_pad, h_padfloat: Отступ (ширина/высота) между краями смежных подграфиков. По умолчанию равен pad.
rectкортеж (левый, нижний, правый, верхний): Прямоугольник в нормализованных координатах фигуры, в который будут помещены подграфики (включая метки).