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

Нужно ли сдвигать оси, чтобы удалить пустое пространство между ними. Это полезно для простых сетчатых осей с фиксированным аспектом (например, сетка изображений). См. Сетки осей с фиксированным соотношением сторон: макет «сжатый».

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.

classmatplotlib.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:

1. переопределите _adjust_compatible и _colorbar_gridspec
2. переопределите LayoutEngine.set для обновления self._params
3. переопределите LayoutEngine.execute со своей реализацией

propertyadjust_compatible

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

propertycolorbar_gridspec

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

execute(fig)[source]

Выполняет макетирование на фигуре, заданной fig.

get()[source]

Возвращает копию параметров для движка макета.

set(**kwargs)[source]

classmatplotlib.layout_engine.PlaceHolderLayoutEngine(adjust_compatible, colorbar_gridspec, **kwargs)[source]

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

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

Parameters:

adjust_compatible, colorbar_gridspecbool

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

propertyadjust_compatible

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

propertycolorbar_gridspec

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

execute(fig)[source]

Выполняет макетирование на фигуре, заданной fig.

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. Подробную информацию см. в руководстве по Tight Layout.

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

Параметры:

padfloat, 1.08

Отступ между краем фигуры и краями подграфиков в долях размера шрифта.

h_pad, w_padfloat

Отступ (высота/ширина) между краями соседних подграфиков. По умолчанию равен pad.

rectкортеж (left, bottom, right, top), по умолчанию: (0, 0, 1, 1).

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

propertyadjust_compatible

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

propertycolorbar_gridspec

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

execute(fig)[source]

Выполняет tight_layout.

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

Параметры:

figFigure, на котором необходимо выполнить макетирование.

См. также: `.figure.Figure.tight_layout` и `.pyplot.tight_layout`.

get()[source]

Возвращает копию параметров для движка макета.

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