matplotlib.offsetbox
#
Classes de conteneur pour Artist
s.
OffsetBox
La base de tous les artistes conteneur définis dans ce module.
AnchoredOffsetbox
,AnchoredText
Ancrer et aligner un arbitraire
Artist
ou un texte par rapport aux axes parents ou à un point d'ancrage spécifique.DrawingArea
Un conteneur avec une largeur et une hauteur fixes. Les enfants ont une position fixe à l'intérieur du conteneur et peuvent être clipsés.
HPacker
,VPacker
Conteneurs pour disposer leurs enfants verticalement ou horizontalement.
PaddedBox
Un conteneur pour ajouter un rembourrage autour d'un fichier
Artist
.TextArea
Contient une seule
Text
instance.
- classe matplotlib.offsetbox. AnchoredOffsetbox ( loc , * , pad = 0.4 , borderpad = 0.5 , child = None , prop = None , frameon = True , bbox_to_anchor = None , bbox_transform = None , ** kwargs ) [source] #
Socles :
OffsetBox
Une boîte de décalage placée selon l'emplacement loc .
AnchoredOffsetbox a un seul enfant. Lorsque plusieurs enfants sont nécessaires, utilisez un OffsetBox supplémentaire pour les enfermer. Par défaut, la boîte de décalage est ancrée sur ses axes parents. Vous pouvez spécifier explicitement le bbox_to_anchor .
- Paramètres :
- rue loc
L'emplacement de la boîte. Les emplacements valides sont 'en haut à gauche', 'en haut au centre', 'en haut à droite', 'au centre à gauche', 'au centre', 'au centre à droite', 'en bas à gauche', 'en bas au centre, 'en bas à droite'. Pour la compatibilité descendante, les valeurs numériques sont également acceptées. Voir le paramètre loc de
Legend
pour plus de détails.- flotteur de pad , par défaut : 0,4
Remplissage autour de l'enfant en tant que fraction de la taille de la police.
- borderpad flottant, par défaut : 0,5
Rembourrage entre le cadre offsetbox et le bbox_to_anchor .
- enfant
OffsetBox
La boîte qui sera ancrée.
- soutenir
FontProperties
Ceci est uniquement utilisé comme référence pour les rembourrages. S'il n'est pas fourni,
rcParams["legend.fontsize"]
(par défaut :'medium'
) est utilisé.- frameon bool
Que ce soit pour dessiner un cadre autour de la boîte.
- bbox_to_anchor
BboxBase
, 2-tuple ou 4-tuple de flottants Case qui sert à positionner la légende en conjonction avec loc .
- bbox_transform Aucun ou
matplotlib.transforms.Transform
La transformation de la boîte englobante ( bbox_to_anchor ).
- **kwargs
Tous les autres paramètres sont transmis à
OffsetBox
.
Remarques
Voir
Legend
pour une description détaillée du mécanisme d'ancrage.- codes = {'centre' : 10, 'centre gauche' : 6, 'centre droit' : 7, 'centre inférieur ' : 8, 'bas gauche' : 3, 'bas droit' : 4, 'droite' : 5, 'en haut au centre' : 9, 'en haut à gauche' : 2, 'en haut à droite' : 1} #
- draw ( moteur de rendu ) [source] #
Mettez à jour l'emplacement des enfants si nécessaire et dessinez-les vers le moteur de rendu donné .
- get_extent ( moteur de rendu ) [source] #
Renvoie l'étendue de la boîte sous la forme (largeur, hauteur, x, y).
C'est l'étendue de l'enfant plus le rembourrage.
- get_window_extent ( moteur de rendu = Aucun ) [source] #
Obtenez la boîte englobante de l'artiste dans l'espace d'affichage.
La largeur et la hauteur de la boîte englobante sont non négatives.
Les sous-classes doivent être remplacées pour être incluses dans le calcul « serré » de la boîte englobante. La valeur par défaut est de renvoyer une boîte englobante vide à 0, 0.
Soyez prudent lorsque vous utilisez cette fonction, les résultats ne seront pas mis à jour si l'étendue de la fenêtre d'artiste de l'artiste change. L'étendue peut changer en raison de toute modification de la pile de transformation, telle que la modification des limites des axes, de la taille de la figure ou du canevas utilisé (comme cela se fait lors de l'enregistrement d'une figure). Cela peut entraîner un comportement inattendu où les figures interactives s'afficheront correctement à l'écran, mais ne seront pas enregistrées correctement.
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , bbox_to_anchor=<UNSET> , child=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET > , gid=<UNSET> , height=<UNSET> , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rastérisé=<UNSET> ,sketch_params=<UNSET> ,snap=<UNSET> , transform=<UNSET> , url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
inconnue
inconnue
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
(flottant, flottant) ou appelable
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
chaîne
bourdonner
flotteur
flotteur
- set_bbox_to_anchor ( bbox , transform = None ) [source] #
Définissez la bbox à laquelle la boîte est ancrée.
bbox peut être une instance de Bbox, une liste de [gauche, bas, largeur, hauteur] ou une liste de [gauche, bas] où la largeur et la hauteur seront supposées être nulles. La bbox sera transformée pour afficher les coordonnées par la transformation donnée.
- zordre = 5 #
- classe matplotlib.offsetbox. AnchoredText ( s , loc , * , pad = 0.4 , borderpad = 0.5 , prop = None , ** kwargs ) [source] #
Socles :
AnchoredOffsetbox
AnchoredOffsetbox avec texte.
- Paramètres :
- s str
Texte.
- rue loc
Le code d'emplacement. Voir
AnchoredOffsetbox
.- flotteur de pad , par défaut : 0,4
Remplissage autour du texte en tant que fraction de la taille de la police.
- borderpad flottant, par défaut : 0,5
Espacement entre le cadre offsetbox et le bbox_to_anchor .
- prop dict, facultatif
Dictionnaire des paramètres de mots clés à transmettre à l'
Text
instance contenue dans AnchoredText.- **kwargs
Tous les autres paramètres sont passés à
AnchoredOffsetbox
.
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , bbox_to_anchor=<UNSET> , child=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET > , gid=<UNSET> , height=<UNSET> , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rastérisé=<UNSET> ,sketch_params=<UNSET> ,snap=<UNSET> , transform=<UNSET> , url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
inconnue
inconnue
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
(flottant, flottant) ou appelable
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
chaîne
bourdonner
flotteur
flotteur
- classe matplotlib.offsetbox. AnnotationBbox ( offsetbox , xy , xybox = None , * , xycoords = 'data' , boxcoords = None , frameon = True , pad = 0.4 , annotation_clip = None , box_alignment = (0.5, 0.5) , bboxprops = None , arrowprops = None , taille de police =Aucun , ** kwargs ) [source] #
Bases :
Artist
,_AnnotationBase
Conteneur pour une
OffsetBox
référence à une position spécifique xy .En option, une flèche pointant de la boîte de décalage vers xy peut être dessinée.
C'est comme
Annotation
, mais avecOffsetBox
au lieu deText
.- Paramètres :
- offsetbox
OffsetBox
- xy (flottant, flottant)
Le point (x, y) à annoter. Le système de coordonnées est déterminé par xycoords .
- xybox (float, float), par défaut : xy
La position (x, y) à laquelle placer le texte. Le système de coordonnées est déterminé par boxcoords .
- xycoords str ou
Artist
ouTransform
ou callable or (float, float), par défaut : 'data' Le système de coordonnées dans lequel xy est donné. Voir le paramètre xycoords dans
Annotation
pour une description détaillée.- boxcoords str ou
Artist
ouTransform
ou callable or (float, float), par défaut : valeur de xycoords Le système de coordonnées dans lequel xybox est donné. Voir le paramètre textcoords dans
Annotation
pour une description détaillée.- frameon bool, par défaut : True
Par défaut, le texte est entouré d'un blanc
FancyBboxPatch
(accessible commepatch
attribut duAnnotationBbox
). Si frameon est défini sur False, ce patch est rendu invisible.- flotteur de pad , par défaut : 0,4
Rembourrage autour de la boîte de décalage.
- box_alignment (flottant, flottant)
Un tuple de deux flottants pour un alignement vertical et horizontal de la boîte de décalage par rapport aux boxcoords . Le coin inférieur gauche est (0, 0) et le coin supérieur droit est (1, 1).
- **kwargs
Les autres paramètres sont identiques à
Annotation
.
- offsetbox
- anncoords de propriété #
- contient ( mouseevent ) [source] #
Teste si l'artiste contient l'événement mouse.
- Paramètres :
- événement de souris
matplotlib.backend_bases.MouseEvent
- événement de souris
- Retours :
- contient booléen
Indique si des valeurs se trouvent dans le rayon.
- dictée des détails
Un dictionnaire spécifique à l'artiste des détails du contexte de l'événement, tels que les points contenus dans le rayon de sélection. Voir les sous-classes individuelles d'artistes pour plus de détails.
- draw ( moteur de rendu ) [source] #
Dessinez l'artiste (et ses enfants) à l'aide du moteur de rendu donné.
Cela n'a aucun effet si l'artiste n'est pas visible (
Artist.get_visible
renvoie Faux).- Paramètres :
- sous-classe de moteur de rendu .
RendererBase
- sous-classe de moteur de rendu .
Remarques
Cette méthode est remplacée dans les sous-classes Artist.
- get_tightbbox ( moteur de rendu = Aucun ) [source] #
Comme
Artist.get_window_extent
, mais inclut tout découpage.- Paramètres :
- sous-classe de moteur de rendu
RendererBase
moteur de rendu qui sera utilisé pour dessiner les figures (c'est-à-dire
fig.canvas.get_renderer()
)
- sous-classe de moteur de rendu
- Retours :
Bbox
La boîte englobante englobante (en coordonnées de pixels de la figure).
- get_window_extent ( moteur de rendu = Aucun ) [source] #
Obtenez la boîte englobante de l'artiste dans l'espace d'affichage.
La largeur et la hauteur de la boîte englobante sont non négatives.
Les sous-classes doivent être remplacées pour être incluses dans le calcul « serré » de la boîte englobante. La valeur par défaut est de renvoyer une boîte englobante vide à 0, 0.
Soyez prudent lorsque vous utilisez cette fonction, les résultats ne seront pas mis à jour si l'étendue de la fenêtre d'artiste de l'artiste change. L'étendue peut changer en raison de toute modification de la pile de transformation, telle que la modification des limites des axes, de la taille de la figure ou du canevas utilisé (comme cela se fait lors de l'enregistrement d'une figure). Cela peut entraîner un comportement inattendu où les figures interactives s'afficheront correctement à l'écran, mais ne seront pas enregistrées correctement.
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , annotation_clip=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , fontsize=<UNSET > , gid=<UNSET> , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<NON DÉFINI>, transform=<UNSET> ,url=<UNSET> , visible=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
annotation_clip
booléen ou Aucun
bourdonner
Patch ou (chemin, transformation) ou aucun
inconnue
inconnue
chaîne
bourdonner
objet
bourdonner
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
chaîne
bourdonner
flotteur
- set_figure ( figure ) [source] #
Définissez l'
Figure
instance à laquelle appartient l'artiste.- Paramètres :
- figure
Figure
- figure
- set_fontsize ( s = Aucun ) [source] #
Définissez la taille de la police en points.
Si s n'est pas donné, réinitialisez à
rcParams["legend.fontsize"]
(par défaut :'medium'
).
- update_positions ( moteur de rendu ) [source] #
Mettez à jour les positions des pixels pour le point annoté, le texte et la flèche.
- propriété xyann #
- zordre = 3 #
- classe matplotlib.offsetbox. AuxTransformBox ( aux_transform ) [source] #
Socles :
OffsetBox
Boîte de décalage avec le aux_transform. Ses enfants seront d'abord transformés avec le aux_transform puis seront décalés. La coordonnée absolue de aux_transform est significative car elle sera automatiquement ajustée afin que le coin inférieur gauche de la boîte englobante des enfants soit défini sur (0, 0) avant la transformation de décalage.
Il est similaire à la zone de dessin, sauf que l'étendue de la boîte n'est pas prédéterminée mais calculée à partir de l'étendue de la fenêtre de ses enfants. De plus, l'étendue des enfants sera calculée dans la coordonnée transformée.
- draw ( moteur de rendu ) [source] #
Mettez à jour l'emplacement des enfants si nécessaire et dessinez-les vers le moteur de rendu donné .
- get_extent ( moteur de rendu ) [source] #
Renvoie un tuple de la boîte.
width, height, xdescent, ydescent
- get_window_extent ( moteur de rendu = Aucun ) [source] #
Obtenez la boîte englobante de l'artiste dans l'espace d'affichage.
La largeur et la hauteur de la boîte englobante sont non négatives.
Les sous-classes doivent être remplacées pour être incluses dans le calcul « serré » de la boîte englobante. La valeur par défaut est de renvoyer une boîte englobante vide à 0, 0.
Soyez prudent lorsque vous utilisez cette fonction, les résultats ne seront pas mis à jour si l'étendue de la fenêtre d'artiste de l'artiste change. L'étendue peut changer en raison de toute modification de la pile de transformation, telle que la modification des limites des axes, de la taille de la figure ou du canevas utilisé (comme cela se fait lors de l'enregistrement d'une figure). Cela peut entraîner un comportement inattendu où les figures interactives s'afficheront correctement à l'écran, mais ne seront pas enregistrées correctement.
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , gid=<UNSET> , height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> ,transform=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
(flotter, flotter)
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
inconnue
chaîne
bourdonner
flotteur
flotteur
- classe matplotlib.offsetbox. DraggableAnnotation ( annotation , use_blit = False ) [source] #
Socles :
DraggableBase
- classe matplotlib.offsetbox. DraggableBase ( ref_artist , use_blit = False ) [source] #
Socles :
object
Classe de base d'assistance pour un artiste déplaçable (légende, offsetbox).
Les classes dérivées doivent remplacer les méthodes suivantes :
def save_offset(self): ''' Called when the object is picked for dragging; should save the reference position of the artist. ''' def update_offset(self, dx, dy): ''' Called during the dragging; (*dx*, *dy*) is the pixel offset from the point where the mouse drag started. '''
Vous pouvez éventuellement remplacer la méthode suivante :
def finalize_offset(self): '''Called when the mouse is released.'''
Dans l'implémentation actuelle de
DraggableLegend
etDraggableAnnotation
,update_offset
place les artistes dans les coordonnées d'affichage etfinalize_offset
recalcule leur position dans les coordonnées des axes et définit un attribut pertinent.
- classe matplotlib.offsetbox. DraggableOffsetBox ( ref_artist , offsetbox , use_blit = False ) [source] #
Socles :
DraggableBase
- classe matplotlib.offsetbox. DrawingArea ( width , height , xdescent = 0.0 , ydescent = 0.0 , clip = False ) [source] #
Socles :
OffsetBox
La DrawingArea peut contenir n'importe quel artiste en tant qu'enfant. Le DrawingArea a une largeur et une hauteur fixes. La position des enfants par rapport au parent est fixe. Les enfants peuvent être coupés aux limites du parent.
- Paramètres :
- largeur, hauteur flotteur
Largeur et hauteur du conteneur.
- flotteur xdescent, ydescent
Descente de la boîte dans les directions x et y.
- clip bool
S'il faut clipser les enfants à la boîte.
- propriété clip_children #
Si les enfants de ce DrawingArea doivent être coupés par la zone de délimitation de DrawingArea.
- draw ( moteur de rendu ) [source] #
Mettez à jour l'emplacement des enfants si nécessaire et dessinez-les vers le moteur de rendu donné .
- get_extent ( moteur de rendu ) [source] #
Renvoyer largeur, hauteur, xdescent, ydescent de la boîte.
- get_window_extent ( moteur de rendu = Aucun ) [source] #
Obtenez la boîte englobante de l'artiste dans l'espace d'affichage.
La largeur et la hauteur de la boîte englobante sont non négatives.
Les sous-classes doivent être remplacées pour être incluses dans le calcul « serré » de la boîte englobante. La valeur par défaut est de renvoyer une boîte englobante vide à 0, 0.
Soyez prudent lorsque vous utilisez cette fonction, les résultats ne seront pas mis à jour si l'étendue de la fenêtre d'artiste de l'artiste change. L'étendue peut changer en raison de toute modification de la pile de transformation, telle que la modification des limites des axes, de la taille de la figure ou du canevas utilisé (comme cela se fait lors de l'enregistrement d'une figure). Cela peut entraîner un comportement inattendu où les figures interactives s'afficheront correctement à l'écran, mais ne seront pas enregistrées correctement.
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , gid=<UNSET> , height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> ,transform=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
(flotter, flotter)
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
inconnue
chaîne
bourdonner
flotteur
flotteur
- classe matplotlib.offsetbox. HPacker ( pad = None , sep = None , width = None , height = None , align = 'baseline' , mode = 'fixed' , children = None ) [source] #
Socles :
PackerBase
HPacker regroupe ses enfants horizontalement, ajustant automatiquement leurs positions relatives au moment du dessin.
- Paramètres :
- flotteur de coussinet , en option
Le rembourrage des limites en points.
- flotteur séparé , facultatif
L'espacement entre les éléments en points.
- largeur, hauteur flottante, en option
Largeur et hauteur de la boîte conteneur en pixels, calculées si None .
- aligner {'top', 'bottom', 'left', 'right', 'center', 'baseline'}, par défaut : 'baseline'
Alignement des cases.
- mode {'fixed', 'expand', 'equal'}, par défaut : 'fixed'
Le mode d'emballage.
'fixed' emballe le
Artist
s donné avec un espacement sep .'expand' utilise l'espace maximal disponible pour répartir les artistes avec un espacement égal entre eux.
'égal' : chaque artiste occupe une fraction égale de l'espace disponible et y est aligné à gauche (ou aligné en haut).
- liste des enfants de
Artist
Les artistes à emballer.
Remarques
pad et sep sont en points et seront mis à l'échelle avec le rendu dpi, tandis que width et height sont en pixels.
- get_extent_offsets ( moteur de rendu ) [source] #
Met à jour l'offset des enfants et renvoie l'étendue de la boîte.
- Paramètres :
- sous-classe de moteur de rendu
RendererBase
- sous-classe de moteur de rendu
- Retours :
- largeur
- la taille
- xdescente
- descente
- liste des paires (xoffset, yoffset)
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , gid=<UNSET> , height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> ,transform=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
(flottant, flottant) ou appelable
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
chaîne
bourdonner
flotteur
flotteur
- classe matplotlib.offsetbox. DécalageBox ( * args , ** kwargs ) [source] #
Socles :
Artist
L'OffsetBox est un simple artiste conteneur.
Les enfants artistes sont censés être dessinés à une position relative par rapport à leur parent.
Étant lui-même artiste, tous les paramètres sont transmis à
Artist
.- contient ( mouseevent ) [source] #
Déléguez l'événement souris contains-check aux enfants.
En tant que conteneur, le
OffsetBox
ne répond pas lui-même aux événements de souris.- Paramètres :
- événement de souris
matplotlib.backend_bases.MouseEvent
- événement de souris
- Retours :
- contient booléen
Indique si des valeurs se trouvent dans le rayon.
- dictée des détails
Un dictionnaire spécifique à l'artiste des détails du contexte de l'événement, tels que les points contenus dans le rayon de sélection. Voir les sous-classes individuelles d'artistes pour plus de détails.
Voir également
- draw ( moteur de rendu ) [source] #
Mettez à jour l'emplacement des enfants si nécessaire et dessinez-les vers le moteur de rendu donné .
- get_extent ( moteur de rendu ) [source] #
Renvoie un tuple de la boîte.
width, height, xdescent, ydescent
- get_extent_offsets ( moteur de rendu ) [source] #
Met à jour l'offset des enfants et renvoie l'étendue de la boîte.
- Paramètres :
- sous-classe de moteur de rendu
RendererBase
- sous-classe de moteur de rendu
- Retours :
- largeur
- la taille
- xdescente
- descente
- liste des paires (xoffset, yoffset)
- get_offset ( width , height , xdescent , ydescent , renderer ) [source] #
Renvoie le décalage sous la forme d'un tuple (x, y).
Les paramètres d'étendue doivent être fournis pour gérer le cas où le décalage est déterminé dynamiquement par un appelable (voir
set_offset
).- Paramètres :
- largeur, hauteur, xdescente, ydescente
Paramètres d'étendue.
- sous-classe de moteur de rendu
RendererBase
- get_window_extent ( moteur de rendu = Aucun ) [source] #
Obtenez la boîte englobante de l'artiste dans l'espace d'affichage.
La largeur et la hauteur de la boîte englobante sont non négatives.
Les sous-classes doivent être remplacées pour être incluses dans le calcul « serré » de la boîte englobante. La valeur par défaut est de renvoyer une boîte englobante vide à 0, 0.
Soyez prudent lorsque vous utilisez cette fonction, les résultats ne seront pas mis à jour si l'étendue de la fenêtre d'artiste de l'artiste change. L'étendue peut changer en raison de toute modification de la pile de transformation, telle que la modification des limites des axes, de la taille de la figure ou du canevas utilisé (comme cela se fait lors de l'enregistrement d'une figure). Cela peut entraîner un comportement inattendu où les figures interactives s'afficheront correctement à l'écran, mais ne seront pas enregistrées correctement.
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , gid=<UNSET> , height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> ,transform=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
(flottant, flottant) ou appelable
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
chaîne
bourdonner
flotteur
flotteur
- set_figure ( figure ) [source] #
Définissez le
Figure
pour leOffsetBox
et tous ses enfants.- Paramètres :
- figure
Figure
- figure
- set_offset ( xy ) [source] #
Définissez le décalage.
- Paramètres :
- xy (float, float) ou appelable
Coordonnées (x, y) du décalage en unités d'affichage. Ceux-ci peuvent être donnés explicitement sous la forme d'un tuple (x, y) ou en fournissant une fonction qui convertit l'étendue en décalage. Cette fonction doit avoir la signature :
def offset(width, height, xdescent, ydescent, renderer) -> (float, float)
- classe matplotlib.offsetbox. OffsetImage ( arr , * , zoom = 1 , cmap = None , norm = None , interpolation = None , origin = None , filternorm = True , filterrad = 4.0 , resample = False , dpi_cor = True , ** kwargs ) [source] #
Socles :
OffsetBox
- draw ( moteur de rendu ) [source] #
Mettez à jour l'emplacement des enfants si nécessaire et dessinez-les vers le moteur de rendu donné .
- get_extent ( moteur de rendu ) [source] #
Renvoie un tuple de la boîte.
width, height, xdescent, ydescent
- get_window_extent ( moteur de rendu = Aucun ) [source] #
Obtenez la boîte englobante de l'artiste dans l'espace d'affichage.
La largeur et la hauteur de la boîte englobante sont non négatives.
Les sous-classes doivent être remplacées pour être incluses dans le calcul « serré » de la boîte englobante. La valeur par défaut est de renvoyer une boîte englobante vide à 0, 0.
Soyez prudent lorsque vous utilisez cette fonction, les résultats ne seront pas mis à jour si l'étendue de la fenêtre d'artiste de l'artiste change. L'étendue peut changer en raison de toute modification de la pile de transformation, telle que la modification des limites des axes, de la taille de la figure ou du canevas utilisé (comme cela se fait lors de l'enregistrement d'une figure). Cela peut entraîner un comportement inattendu où les figures interactives s'afficheront correctement à l'écran, mais ne seront pas enregistrées correctement.
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , data=<UNSET> , gid=<UNSET > , height=<UNSET> , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> ,snap=<UNSET> ,transform=<UNSET> , url=<UNSET> , visible=<UNSET> , width=<UNSET> , zoom=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
bourdonner
Patch ou (chemin, transformation) ou aucun
inconnue
chaîne
flotteur
bourdonner
objet
bourdonner
(flottant, flottant) ou appelable
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
chaîne
bourdonner
flotteur
inconnue
flotteur
- classe matplotlib.offsetbox. PackerBase ( pad = None , sep = None , width = None , height = None , align = 'baseline' , mode = 'fixed' , children = None ) [source] #
Socles :
OffsetBox
- Paramètres :
- flotteur de coussinet , en option
Le rembourrage des limites en points.
- flotteur séparé , facultatif
L'espacement entre les éléments en points.
- largeur, hauteur flottante, en option
Largeur et hauteur de la boîte conteneur en pixels, calculées si None .
- aligner {'top', 'bottom', 'left', 'right', 'center', 'baseline'}, par défaut : 'baseline'
Alignement des cases.
- mode {'fixed', 'expand', 'equal'}, par défaut : 'fixed'
Le mode d'emballage.
'fixed' emballe le
Artist
s donné avec un espacement sep .'expand' utilise l'espace maximal disponible pour répartir les artistes avec un espacement égal entre eux.
'égal' : chaque artiste occupe une fraction égale de l'espace disponible et y est aligné à gauche (ou aligné en haut).
- liste des enfants de
Artist
Les artistes à emballer.
Remarques
pad et sep sont en points et seront mis à l'échelle avec le rendu dpi, tandis que width et height sont en pixels.
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , gid=<UNSET> , height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> ,transform=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
(flottant, flottant) ou appelable
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
chaîne
bourdonner
flotteur
flotteur
- classe matplotlib.offsetbox. PaddedBox ( enfant , pad = Aucun , * , draw_frame = False , patch_attrs = Aucun ) [source] #
Socles :
OffsetBox
Un conteneur pour ajouter un rembourrage autour d'un fichier
Artist
.Le
PaddedBox
contient unFancyBboxPatch
qui est utilisé pour le visualiser lors du rendu.- Paramètres :
- enfant
Artist
Le contenu
Artist
.- coussin flotteur
Le rembourrage en points. Cela sera mis à l'échelle avec le rendu dpi. En revanche , la largeur et la hauteur sont en pixels et ne sont donc pas mises à l'échelle.
- draw_frame booléen
Que ce soit pour dessiner le contenu
FancyBboxPatch
.- patch_attrs dict ou Aucun
Paramètres supplémentaires passés au contenu
FancyBboxPatch
.
- enfant
- draw ( moteur de rendu ) [source] #
Mettez à jour l'emplacement des enfants si nécessaire et dessinez-les vers le moteur de rendu donné .
- get_extent_offsets ( moteur de rendu ) [source] #
Met à jour l'offset des enfants et renvoie l'étendue de la boîte.
- Paramètres :
- sous-classe de moteur de rendu
RendererBase
- sous-classe de moteur de rendu
- Retours :
- largeur
- la taille
- xdescente
- descente
- liste des paires (xoffset, yoffset)
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , gid=<UNSET> , height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> ,transform=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
(flottant, flottant) ou appelable
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
chaîne
bourdonner
flotteur
flotteur
- classe matplotlib.offsetbox. TextArea ( s , * , textprops = None , multilinebaseline = False ) [source] #
Socles :
OffsetBox
Le TextArea est un artiste conteneur pour une seule instance de texte.
Le texte est placé à (0, 0) avec un alignement ligne de base+gauche, par défaut. La largeur et la hauteur de l'instance TextArea correspondent à la largeur et à la hauteur de son texte enfant.
- Paramètres :
- s str
Le texte à afficher.
- textprops dict, par défaut : {}
Dictionnaire des paramètres de mots clés à transmettre à l'
Text
instance dans TextArea.- multilinebaseline bool, par défaut : False
Indique si la ligne de base du texte multiligne est ajustée de sorte qu'elle soit (approximativement) alignée au centre du texte sur une seule ligne.
- draw ( moteur de rendu ) [source] #
Mettez à jour l'emplacement des enfants si nécessaire et dessinez-les vers le moteur de rendu donné .
- get_extent ( moteur de rendu ) [source] #
Renvoie un tuple de la boîte.
width, height, xdescent, ydescent
- get_window_extent ( moteur de rendu = Aucun ) [source] #
Obtenez la boîte englobante de l'artiste dans l'espace d'affichage.
La largeur et la hauteur de la boîte englobante sont non négatives.
Les sous-classes doivent être remplacées pour être incluses dans le calcul « serré » de la boîte englobante. La valeur par défaut est de renvoyer une boîte englobante vide à 0, 0.
Soyez prudent lorsque vous utilisez cette fonction, les résultats ne seront pas mis à jour si l'étendue de la fenêtre d'artiste de l'artiste change. L'étendue peut changer en raison de toute modification de la pile de transformation, telle que la modification des limites des axes, de la taille de la figure ou du canevas utilisé (comme cela se fait lors de l'enregistrement d'une figure). Cela peut entraîner un comportement inattendu où les figures interactives s'afficheront correctement à l'écran, mais ne seront pas enregistrées correctement.
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , gid=<UNSET> , height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , multilinebaseline=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<DÉFINI>, snap=<UNSET> ,text=<UNSET> , transform=<UNSET> , url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
inconnue
(flotter, flotter)
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
inconnue
inconnue
chaîne
bourdonner
flotteur
flotteur
- set_multilinebaseline ( t ) [source] #
Définir la ligne de base multiligne.
Si True, la ligne de base du texte multiligne est ajustée de sorte qu'elle soit (approximativement) alignée au centre avec le texte sur une seule ligne. Ceci est utilisé par exemple par l'implémentation de la légende afin que les étiquettes à une seule ligne soient alignées sur la ligne de base, mais que les étiquettes multilignes soient alignées "au centre" avec elles.
- classe matplotlib.offsetbox. VPacker ( pad = None , sep = None , width = None , height = None , align = 'baseline' , mode = 'fixed' , children = None ) [source] #
Socles :
PackerBase
VPacker regroupe ses enfants verticalement, ajustant automatiquement leurs positions relatives au moment du dessin.
- Paramètres :
- flotteur de coussinet , en option
Le rembourrage des limites en points.
- flotteur séparé , facultatif
L'espacement entre les éléments en points.
- largeur, hauteur flottante, en option
Largeur et hauteur de la boîte conteneur en pixels, calculées si None .
- aligner {'top', 'bottom', 'left', 'right', 'center', 'baseline'}, par défaut : 'baseline'
Alignement des cases.
- mode {'fixed', 'expand', 'equal'}, par défaut : 'fixed'
Le mode d'emballage.
'fixed' emballe le
Artist
s donné avec un espacement sep .'expand' utilise l'espace maximal disponible pour répartir les artistes avec un espacement égal entre eux.
'égal' : chaque artiste occupe une fraction égale de l'espace disponible et y est aligné à gauche (ou aligné en haut).
- liste des enfants de
Artist
Les artistes à emballer.
Remarques
pad et sep sont en points et seront mis à l'échelle avec le rendu dpi, tandis que width et height sont en pixels.
- get_extent_offsets ( moteur de rendu ) [source] #
Met à jour l'offset des enfants et renvoie l'étendue de la boîte.
- Paramètres :
- sous-classe de moteur de rendu
RendererBase
- sous-classe de moteur de rendu
- Retours :
- largeur
- la taille
- xdescente
- descente
- liste des paires (xoffset, yoffset)
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , gid=<UNSET> , height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET> , picker=<UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> ,transform=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> ) [source] #
Définissez plusieurs propriétés à la fois.
Les propriétés prises en charge sont
Propriété
La description
une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
scalaire ou Aucun
bourdonner
bourdonner
Patch ou (chemin, transformation) ou aucun
chaîne
flotteur
bourdonner
objet
bourdonner
(flottant, flottant) ou appelable
Aucun ou bool ou flottant ou appelable
bourdonner
(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
booléen ou Aucun
chaîne
bourdonner
flotteur
flotteur