Figure.text¶
Ici vous aurez des explications sur la commande et ses différents paramètres.
Figure.text(textfiles=None, x=None, y=None, position=None, text=None,
angle=None, font=None, justify=None, \*, region=None, projection=None,
frame=None, clearance=None, offset=None, fill=None, no_clip=None,
verbose=None, pen=None, aspatial=None, panel=None, find=None,
coltypes=None, header=None, use_word=None, perspective=None,
transparency=None, wrap=None, \**kwargs)
Utilité :¶
Tracez ou mettez en forme des chaînes de texte de taille variable, de type de police et d’orientation différents.
Vous devez fournir au moins l’une des combinaisons suivantes en tant qu’entrée :
fichier texte
x/y et texte
position et texte
Paramètres :¶
textfiles (str or list) - Un nom de fichier de données texte, ou une liste de noms de fichiers contenant 1 ou plusieurs enregistrements avec (x, y[, angle, font, justify], text).
x/y (float ou tableaux 1D) - Les coordonnées x et y, ou un tableau de coordonnées x et y pour afficher le texte.
position (str) - Définir le point de référence sur la carte pour le texte en utilisant les coordonnées x, y extraites de la région au lieu de les fournir via x/y. Spécifiez avec un code de deux lettres (sans ordre spécifique), choisi parmi :
Horizontal : L(eft) (gauche), C(entre) (centre), R(ight) (droite)
Vertical : T(op) (haut), M(iddle) (milieu), B(ottom) (bas)
Par exemple, position= »TL » place le texte dans le coin supérieur gauche de la carte.
text (str ou tableau 1D) - La chaîne de texte, ou un tableau de chaînes à afficher sur la figure.
angle (int, float, str ou bool) - Définir l’angle mesuré en degrés dans le sens contraire des aiguilles d’une montre par rapport à l’horizontale (par exemple, 30 définit le texte à 30 degrés). Si aucun angle n’est spécifié explicitement (c’est-à-dire angle=True), alors l’entrée de textfiles doit avoir cette colonne.
font (str ou bool) - Définir la spécification de police avec le format taille, police, couleur où la taille est la taille du texte en points, la police est la police à utiliser et la couleur définit la couleur de la police. Par exemple, font= »12p,Helvetica-Bold,red » sélectionne une police Helvetica-Bold de 12 points en rouge. Si aucune information de police n’est spécifiée explicitement (c’est-à-dire font=True), alors l’entrée de textfiles doit avoir ces informations dans l’une de ses colonnes.
justify (str ou bool) - Définir l’alignement qui fait référence à la partie de la chaîne de texte qui sera mappée sur le point (x, y). Choisissez une combinaison de deux lettres parmi L, C, R (pour gauche, centre ou droite) et T, M, B (pour haut, milieu ou bas). Par exemple, BL pour bas gauche. Si aucune justification n’est spécifiée explicitement (c’est-à-dire justify=True), alors l’entrée de textfiles doit avoir cette colonne.
projection (str) - projcode[projparams/]width. Sélectionnez la projection de la carte.
region (str ou liste) - xmin/xmax/ymin/ymax[+r][+uunit]. Spécifiez la région d’intérêt. Requis si c’est la première commande de tracé.
clearance (str) - [dx/dy][+to|O|c|C]. Ajustez l’espace libre entre le texte et la boîte qui l’entoure [par défaut, 15% de la taille de la police]. Utilisé uniquement si pen ou fill sont spécifiés. Ajoutez l’unité souhaitée (c pour centimètres, i pour pouces ou p pour points ; si elle n’est pas spécifiée, nous consultons l’unité de longueur PROJ). Facultativement, utilisez le modificateur +t pour définir la forme de la boîte de texte lors de l’utilisation de fill et/ou pen. Ajoutez la lettre minuscule o pour obtenir un rectangle droit [par défaut]. Ajoutez la lettre majuscule O pour obtenir un rectangle arrondi. En mode paragraphe (paragraph), vous pouvez également ajouter la lettre minuscule c pour obtenir un rectangle concave ou ajouter la lettre majuscule C pour obtenir un rectangle convexe.
fill (str) - Définir la couleur de remplissage des boîtes de texte [par défaut, pas de remplissage].
offset (str) - [j|J]dx[/dy][+v[pen]]. Décalage du texte à partir du point projeté (x, y) par dx/dy [par défaut, « 0/0 »]. Si dy n’est pas spécifié, il est défini égal à dx. Utilisez j pour décaler le texte loin du point (c’est-à-dire, l’alignement du texte déterminera la direction du décalage). L’utilisation de J raccourcira les décalages diagonaux aux coins par sqrt(2). Facultativement, ajoutez +v pour tracer une ligne du point d’origine au point décalé ; ajoutez un stylo pour modifier les attributs de cette ligne.
pen (str) - Définir le stylo utilisé pour tracer un rectangle autour de la chaîne de texte (voir clearance) [par défaut, « 0.25p,black,solid »].
no_clip (bool) - Ne pas découper le texte aux limites du cadre [par défaut, False].
verbose (bool ou str) -
Sélectionnez le niveau de verbosité [par défaut, w], qui module les messages écrits dans stderr. Choisissez parmi les 7 niveaux de verbosité :
q : Silencieux, aucun message d’erreur fatal n’est produit.
e : Messages d’erreur uniquement.
w : Avertissements [par défaut].
t : Durées (rapporte les temps d’exécution pour les algorithmes gourmands en temps).
i : Messages informatifs (identique à verbose=True).
c : Avertissements de compatibilité.
d : Messages de débogage.
aspatial (bool ou str) - [col=]name[,…]. Contrôle la façon dont les données aspatiales sont gérées lors de l’entrée et de la sortie. La documentation complète se trouve à l’adresse https://docs.generic-mapping-tools.org/latest/gmt.html#aspatial-full.
panel (bool ou int ou liste) - [row,col|index]. Sélectionnez un panneau spécifique de sous-tracé. Autorisé uniquement en mode subplot. Utilisez panel=True pour passer au panneau suivant dans l’ordre sélectionné. Au lieu de row, col, vous pouvez également donner une valeur scalaire index qui dépend de l’ordre défini via autolabel lorsque le sous-tracé a été défini. Notez que row, col et index commencent tous à 0.
find (str) - [~] »motif » | [~]/expression_régulière/[i]. Passez uniquement les enregistrements qui correspondent au motif ou aux expressions régulières spécifiées [par défaut, tous les enregistrements sont traités]. Préfixez ~ au motif ou à l’expression régulière pour passer uniquement les expressions de données qui ne correspondent pas au motif. Ajoutez i pour une correspondance insensible à la casse. Cela ne s’applique pas aux en-têtes ou aux en-têtes de segment.
coltypes (str) - [i|o]colinfo. Spécifie les types de données des colonnes d’entrée et/ou de sortie (données temporelles ou géographiques). La documentation complète se trouve à l’adresse https://docs.generic-mapping-tools.org/latest/gmt.html#f-full.
header (str) -
[i|o][n][+c][+d][+msegheader][+rremark][+ttitle]. Spécifie que le(s) fichier(s) d’entrée et/ou de sortie a/ont n enregistrement(s) d’en-tête [par défaut, 0]. Préfixez i si seul l’entrée principale doit avoir des enregistrements d’en-tête. Préfixez o pour contrôler l’écriture des enregistrements d’en-tête, avec les modificateurs suivants pris en charge :
+d pour supprimer les enregistrements d’en-tête existants.
+c pour ajouter un commentaire d’en-tête avec les noms des colonnes à la sortie [par défaut, pas de noms de colonnes].
+m pour ajouter un en-tête de segment segheader à la sortie après le bloc d’en-tête [par défaut, pas d’en-tête de segment].
+r pour ajouter un commentaire remarque à la sortie [par défaut, pas de commentaire]. La chaîne de remarque peut contenir n pour indiquer des sauts de ligne.
+t pour ajouter un commentaire de titre à la sortie [par défaut, pas de titre]. La chaîne de titre peut contenir n pour indiquer des sauts de ligne.
Les lignes vides et les lignes commençant par # sont toujours ignorées.
use_word (int) - Sélectionnez un mot spécifique à partir du texte en fin de ligne, le premier mot étant 0 [par défaut, l’ensemble du texte en fin de ligne]. Aucune colonne numérique ne peut être spécifiée.
perspective (liste ou str) - [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]. Sélectionnez la vue en perspective et définissez l’azimut et l’angle d’élévation du point de vue [par défaut, [180, 90]]. La documentation complète se trouve à l’adresse https://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full.
transparency (int ou float) - Définir le niveau de transparence, dans la plage de 0 à 100 pourcent [par défaut, 0, c’est-à-dire opaque]. Visible uniquement lorsque le format de sortie est PDF ou raster. Seule la sélection du format PNG ajoute une couche de transparence à l’image (pour un traitement ultérieur). La transparence peut également être un tableau 1-D pour définir une transparence variable pour les textes, mais cette option n’est valide que si vous utilisez x/y et text.
wrap (str) - y|a|w|d|h|m|s|cperiode[/phase][+ccol]. Convertit la coordonnée x d’entrée en une coordonnée cyclique, ou une colonne différente si sélectionnée via +ccol. Les transformations de coordonnées cycliques suivantes sont prises en charge :
y : cycle annuel (normalisé)
a : cycle annuel (mensuel)
w : cycle hebdomadaire (jour)
d : cycle quotidien (heure)
h : cycle horaire (minute)
m : cycle minute (seconde)
s : cycle seconde (seconde)
c : cycle personnalisé (normalisé)