`matplotlib.layout_engine`#

Classes para elementos de layout em um arquivo Figure.

As figuras têm uma layout_enginepropriedade que contém uma subclasse LayoutEnginedefinida aqui (ou None para nenhum layout). O tempo de desenho figure.get_layout_engine().execute()é chamado, cujo objetivo geralmente é reorganizar os eixos na figura para produzir um layout agradável. É como um drawcallback, porém ao imprimir desativamos o mecanismo de layout para o desenho final e é útil conhecer o mecanismo de layout enquanto a figura está sendo criada, principalmente para lidar com barras de cores.

O Matplotlib fornece dois mecanismos de layout TightLayoutEnginee o ConstrainedLayoutEngine. Terceiros podem criar seu próprio mecanismo de layout subclassificando LayoutEngine.

classe matplotlib.layout_engine. ConstrainedLayoutEngine ( * , h_pad = Nenhum , w_pad = Nenhum , hspace = Nenhum , wspace = Nenhum , rect = (0, 0, 1, 1) , compress = False , ** kwargs ) [source] #

Implementa o constrained_layoutgerenciamento de geometria. Consulte o Guia de layout restrito para obter detalhes.

Inicializar as constrained_layoutconfigurações.

Parâmetros :

h_pad, w_pad flutuar: Preenchimento em torno dos elementos dos eixos em unidades de figura normalizada. Padrão para rcParams["figure.constrained_layout.h_pad"](padrão: 0.04167) e rcParams["figure.constrained_layout.w_pad"](padrão: 0.04167).
hspace, wspace flutuante: Fração da figura a dedicar ao espaço entre os eixos. Estes são distribuídos uniformemente entre as lacunas entre os eixos. Um valor de 0,2 para um layout de três colunas teria um espaço de 0,1 da largura da figura entre cada coluna. Se h/wspace < h/w_pad, então os pads são usados. Padrão para rcParams["figure.constrained_layout.hspace"](padrão: 0.02) e rcParams["figure.constrained_layout.wspace"](padrão: 0.02).
tupla reta de 4 floats: Retângulo nas coordenadas da figura para executar o layout restrito (esquerda, inferior, largura, altura), cada um de 0-1.
comprimir bool: Se os eixos devem ser deslocados para que o espaço em branco entre eles seja removido. Isso é útil para grades simples de eixos de aspecto fixo (por exemplo, uma grade de imagens). Consulte Grades de eixos de proporção fixa: layout "comprimido" .

propriedade ajuste_compatível #: Retorne um booleano se o mecanismo de layout for compatível com subplots_adjust.

propriedade colorbar_gridspec #: Retorne um booleano se o mecanismo de layout criar barras de cores usando um gridspec.

execute ( fig . ) [fonte] #

Execute o constraintd_layout e mova e redimensione os eixos de acordo.

Parâmetros :

fig Figurepara executar o layout.

get ( ) [fonte] #: Retorna a cópia dos parâmetros para o mecanismo de layout.

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

Defina os pads para constraint_layout.

Parâmetros :

h_pad, w_pad flutuar: Preenchimento em torno dos elementos dos eixos em unidades de figura normalizada. Padrão para rcParams["figure.constrained_layout.h_pad"](padrão: 0.04167) e rcParams["figure.constrained_layout.w_pad"](padrão: 0.04167).
hspace, wspace flutuante: Fração da figura a dedicar ao espaço entre os eixos. Estes são distribuídos uniformemente entre as lacunas entre os eixos. Um valor de 0,2 para um layout de três colunas teria um espaço de 0,1 da largura da figura entre cada coluna. Se h/wspace < h/w_pad, então os pads são usados. Padrão para rcParams["figure.constrained_layout.hspace"](padrão: 0.02) e rcParams["figure.constrained_layout.wspace"](padrão: 0.02).
tupla reta de 4 floats: Retângulo nas coordenadas da figura para executar o layout restrito (esquerda, inferior, largura, altura), cada um de 0-1.

classe matplotlib.layout_engine. LayoutEngine ( ** kwargs ) [fonte] #

Classe base para mecanismos de layout Matplotlib.

Um mecanismo de layout pode ser passado para uma figura na instanciação ou a qualquer momento com set_layout_engine. Uma vez anexado a uma figura, a função do mecanismo de layout executeé chamada no tempo de desenho por draw, fornecendo um gancho especial de tempo de desenho.

Observação

No entanto, observe que os mecanismos de layout afetam a criação de barras de cores, portanto, set_layout_enginedevem ser chamados antes da criação de qualquer barra de cores.

Atualmente, existem duas propriedades de LayoutEngineclasses que são consultadas durante a manipulação da figura:

engine.colorbar_gridspecdiz Figure.colorbarse deve fazer o
eixos usando o método gridspec (consulte colorbar.make_axes_gridspec) ou não (consulte colorbar.make_axes);
engine.adjust_compatibledeixa Figure.subplots_adjustde ser
execute se não for compatível com o mecanismo de layout.

Para implementar um costume LayoutEngine:

substituir _adjust_compatiblee_colorbar_gridspec
substituir LayoutEngine.setpara atualizar self._params
substituir LayoutEngine.executecom sua implementação

propriedade ajuste_compatível #: Retorne um booleano se o mecanismo de layout for compatível com subplots_adjust.

propriedade colorbar_gridspec #: Retorne um booleano se o mecanismo de layout criar barras de cores usando um gridspec.

execute ( fig . ) [fonte] #: Execute o layout da figura dada pela fig .

get ( ) [fonte] #: Retorna a cópia dos parâmetros para o mecanismo de layout.

set ( ** kwargs ) [fonte] #

classe matplotlib.layout_engine. PlaceHolderLayoutEngine ( ajuste_compatível , colorbar_gridspec , ** kwargs ) [fonte] #

Este mecanismo de layout não ajusta o layout da figura.

O objetivo disso LayoutEngineé atuar como um substituto quando o usuário remove um mecanismo de layout para garantir que um incompatível LayoutEnginenão possa ser definido posteriormente.

Parâmetros :

ajuste_compatível, colorbar_gridspec bool: Permita que o PlaceHolderLayoutEngine espelhe o comportamento de qualquer mecanismo de layout que esteja substituindo.

propriedade ajuste_compatível #: Retorne um booleano se o mecanismo de layout for compatível com subplots_adjust.

propriedade colorbar_gridspec #: Retorne um booleano se o mecanismo de layout criar barras de cores usando um gridspec.

execute ( fig . ) [fonte] #: Execute o layout da figura dada pela fig .

get ( ) [fonte] #: Retorna a cópia dos parâmetros para o mecanismo de layout.

set ( ** kwargs ) [fonte] #

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

Implementa o tight_layoutgerenciamento de geometria. Consulte o guia Layout compacto para obter detalhes.

Inicialize o mecanismo tight_layout.

Parâmetros :

almofada flutuante, 1,08: Preenchimento entre a borda da figura e as bordas das subtramas, como uma fração do tamanho da fonte.
h_pad, w_pad flutuar: Preenchimento (altura/largura) entre bordas de subparcelas adjacentes. O padrão é pad .
tupla rect (esquerda, inferior, direita, superior), padrão: (0, 0, 1, 1).: retângulo em coordenadas de figura normalizadas nas quais os subplots (incluindo rótulos) se encaixarão.

propriedade ajuste_compatível #: Retorne um booleano se o mecanismo de layout for compatível com subplots_adjust.

propriedade colorbar_gridspec #: Retorne um booleano se o mecanismo de layout criar barras de cores usando um gridspec.

execute ( fig . ) [fonte] #

Execute tight_layout.

Isso decide os parâmetros da subtrama, dado o preenchimento que permitirá que os rótulos dos eixos não sejam cobertos por outros rótulos e eixos.

Parâmetros :

fig Figurepara executar o layout.
Veja também: `.figure.Figure.tight_layout` e `.pyplot.tight_layout`.

get ( ) [fonte] #: Retorna a cópia dos parâmetros para o mecanismo de layout.

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

matplotlib.layout_engine#

`matplotlib.layout_engine`#