matplotlib.layout_engine

Classes aux éléments de mise en page dans un fichier Figure.

Les figures ont une layout_enginepropriété qui contient une sous-classe de LayoutEnginedéfinie ici (ou None pour aucune mise en page). Au moment du tirage figure.get_layout_engine().execute()est appelé, dont le but est généralement de réorganiser les axes sur la figure pour produire une mise en page agréable. C'est comme un drawrappel, cependant lors de l'impression on désactive le moteur de mise en page pour le dessin final et il est utile de connaître le moteur de mise en page lors de la création de la figure, notamment pour gérer les colorbars.

Matplotlib fournit deux moteurs de mise en page TightLayoutEngineet ConstrainedLayoutEngine. Les tiers peuvent créer leur propre moteur de mise en page en sous-classant LayoutEngine.

classe matplotlib.layout_engine. ConstrainedLayoutEngine ( * , h_pad = None , w_pad = None , hspace = None , wspace = None , rect = (0, 0, 1, 1) , compress = False , ** kwargs )

Implémente la constrained_layoutgestion de la géométrie. Voir Guide de mise en page contrainte pour plus de détails.

Initialiser constrained_layoutles paramètres.

Paramètres :

h_pad, w_pad flottant

Remplissage autour des éléments d'axes dans des unités normalisées. Par défaut à rcParams["figure.constrained_layout.h_pad"](par défaut : 0.04167) et rcParams["figure.constrained_layout.w_pad"](par défaut : 0.04167).

hspace, wspace flottant

Fraction de la figure à consacrer à l'espace entre les axes. Ceux-ci sont répartis uniformément entre les écarts entre les axes. Une valeur de 0,2 pour une mise en page à trois colonnes aurait un espace de 0,1 de la largeur de la figure entre chaque colonne. Si h/wspace < h/w_pad, alors les pads sont utilisés à la place. Par défaut à rcParams["figure.constrained_layout.hspace"](par défaut : 0.02) et rcParams["figure.constrained_layout.wspace"](par défaut : 0.02).

tuple rect de 4 flottants

Rectangle dans les coordonnées de la figure pour effectuer une disposition contrainte dans (gauche, bas, largeur, hauteur), chacun de 0 à 1.

compresser booléen

Indique s'il faut déplacer les axes afin que l'espace blanc entre eux soit supprimé. Ceci est utile pour les grilles simples d'axes d'aspect fixe (par exemple une grille d'images). Voir Grilles d'Axes à rapport hauteur/largeur fixe : mise en page "compressée" .

propriété adjust_compatible

Renvoie un booléen si le moteur de mise en page est compatible avec subplots_adjust.

propriété colorbar_gridspec

Renvoie un booléen si le moteur de mise en page crée des barres de couleurs à l'aide d'un gridspec.

exécuter ( fig )

Effectuez Constrained_layout et déplacez et redimensionnez les axes en conséquence.

Paramètres :

fig Figurepour effectuer la mise en page.

obtenir ( )

Renvoie une copie des paramètres du moteur de mise en page.

set ( * , h_pad = Aucun , w_pad = Aucun , hspace = Aucun , wspace = Aucun , rect = Aucun )

Définissez les pads pour Constrained_layout.

Paramètres :

h_pad, w_pad flottant

Remplissage autour des éléments d'axes dans des unités normalisées. Par défaut à rcParams["figure.constrained_layout.h_pad"](par défaut : 0.04167) et rcParams["figure.constrained_layout.w_pad"](par défaut : 0.04167).

hspace, wspace flottant

Fraction de la figure à consacrer à l'espace entre les axes. Ceux-ci sont répartis uniformément entre les écarts entre les axes. Une valeur de 0,2 pour une mise en page à trois colonnes aurait un espace de 0,1 de la largeur de la figure entre chaque colonne. Si h/wspace < h/w_pad, alors les pads sont utilisés à la place. Par défaut à rcParams["figure.constrained_layout.hspace"](par défaut : 0.02) et rcParams["figure.constrained_layout.wspace"](par défaut : 0.02).

tuple rect de 4 flottants

Rectangle dans les coordonnées de la figure pour effectuer une disposition contrainte dans (gauche, bas, largeur, hauteur), chacun de 0 à 1.

classe matplotlib.layout_engine. LayoutEngine ( ** kwargs )

Classe de base pour les moteurs de mise en page Matplotlib.

Un moteur de mise en page peut être passé à une figure lors de l'instanciation ou à tout moment avec set_layout_engine. Une fois attachée à une figure, la fonction du moteur de mise en page executeest appelée au moment du dessin par draw, fournissant un crochet spécial au moment du dessin.

Noter

Cependant, notez que les moteurs de mise en page affectent la création des barres de couleurs, ils set_layout_enginedoivent donc être appelés avant la création de toutes les barres de couleurs.

Actuellement, il y a deux propriétés de LayoutEngineclasses qui sont consultées lors de la manipulation de la figure :

• engine.colorbar_gridspecindique Figure.colorbars'il faut faire le

  axes utilisant la méthode gridspec (voir colorbar.make_axes_gridspec) ou non (voir colorbar.make_axes);

• engine.adjust_compatiblecesse Figure.subplots_adjustd'être

  exécuter s'il n'est pas compatible avec le moteur de mise en page.

Pour implémenter un custom LayoutEngine:

1. outrepasser _adjust_compatibleet_colorbar_gridspec

2. remplacer LayoutEngine.setpour mettre à jour self._params

3. remplacer LayoutEngine.executepar votre implémentation

propriété adjust_compatible

Renvoie un booléen si le moteur de mise en page est compatible avec subplots_adjust.

propriété colorbar_gridspec

Renvoie un booléen si le moteur de mise en page crée des barres de couleurs à l'aide d'un gridspec.

exécuter ( fig )

Exécutez le tracé sur la figure donnée par la fig .

obtenir ( )

Renvoie une copie des paramètres du moteur de mise en page.

ensemble ( ** kwargs )

classe matplotlib.layout_engine. PlaceHolderLayoutEngine ( adjust_compatible , colorbar_gridspec , ** kwargs )

Ce moteur de mise en page n'ajuste pas du tout la mise en page de la figure.

Le but de ceci LayoutEngineest d'agir comme un espace réservé lorsque l'utilisateur supprime un moteur de mise en page pour s'assurer qu'un moteur incompatible LayoutEnginene peut pas être défini ultérieurement.

Paramètres :

adjust_compatible, colorbar_gridspec booléen

Autorisez PlaceHolderLayoutEngine à refléter le comportement du moteur de mise en page qu'il remplace.

propriété adjust_compatible

Renvoie un booléen si le moteur de mise en page est compatible avec subplots_adjust.

propriété colorbar_gridspec

Renvoie un booléen si le moteur de mise en page crée des barres de couleurs à l'aide d'un gridspec.

exécuter ( fig )

Exécutez le tracé sur la figure donnée par la fig .

obtenir ( )

Renvoie une copie des paramètres du moteur de mise en page.

ensemble ( ** kwargs )

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

Implémente la tight_layoutgestion de la géométrie. Voir le guide de mise en page serrée pour plus de détails.

Initialiser le moteur tight_layout.

Paramètres :

flotteur de patin , 1.08

Remplissage entre le bord de la figure et les bords des sous-parcelles, en tant que fraction de la taille de la police.

h_pad, w_pad flottant

Rembourrage (hauteur/largeur) entre les bords des sous-parcelles adjacentes. Par défaut , pad .

tuple rectiligne (gauche, bas, droite, haut), par défaut : (0, 0, 1, 1).

rectangle en coordonnées de figure normalisées dans lesquelles les sous-parcelles (y compris les étiquettes) s'intégreront.

propriété adjust_compatible

Renvoie un booléen si le moteur de mise en page est compatible avec subplots_adjust.

propriété colorbar_gridspec

Renvoie un booléen si le moteur de mise en page crée des barres de couleurs à l'aide d'un gridspec.

exécuter ( fig )

Exécutez tight_layout.

Cela détermine les paramètres de sous-parcelle compte tenu du rembourrage qui permettra aux étiquettes des axes de ne pas être couvertes par d'autres étiquettes et axes.

Paramètres :

fig Figurepour effectuer la mise en page.

Voir aussi : `.figure.Figure.tight_layout` et `.pyplot.tight_layout`.

obtenir ( )

Renvoie une copie des paramètres du moteur de mise en page.

set ( * , pad = Aucun , w_pad = Aucun , h_pad = Aucun , rect = Aucun )