backend_pdf

Un backend PDF Matplotlib.

Auteur : Jouni K Seppänen < jks @ iki . fi > et autres.

matplotlib.backends.backend_pdf. FigureCanvas

pseudonyme deFigureCanvasPdf

classe matplotlib.backends.backend_pdf. FigureCanvasPdf ( figure = Aucun )

Socles :FigureCanvasBase

dessiner ( )

Rendre le Figure.

Cette méthode doit parcourir l'arborescence des artistes, même si aucune sortie n'est produite, car elle déclenche un travail différé auquel les utilisateurs peuvent souhaiter accéder avant d'enregistrer la sortie sur le disque. Par exemple, calculer des limites, des limites automatiques et des valeurs de tick.

types de fichiers = {'pdf' : ' Format de document portable'}

fixed_dpi = 72

get_default_filetype ( )

Renvoie le format de fichier savefig par défaut tel que spécifié dans rcParams["savefig.format"](par défaut : 'png').

La chaîne renvoyée n'inclut pas de point. Cette méthode est remplacée dans les backends qui ne prennent en charge qu'un seul type de fichier.

print_pdf ( filename , * , bbox_inches_restore = None , metadata = None )

classe matplotlib.backends.backend_pdf. GraphicsContextPdf ( fichier )

Socles :GraphicsContextBase

alpha_cmd ( alpha , forcé , efficace_alphas )

capstyle_cmd ( style )

capstyles = {'butt' : 0, 'projecting' : 2, 'round' : 1}

clip_cmd ( cliprect , clippath )

Définir le rectangle du clip. Appels pop()et push().

commandes = ((('_cliprect', '_clippath'), <fonction GraphicsContextPdf.clip_cmd>), (('_alpha', '_forced_alpha', '_effective_alphas'), <fonction GraphicsContextPdf.alpha_cmd>), (('_capstyle' ,), <fonction GraphicsContextPdf.capstyle_cmd>), (('_fillcolor',), <fonction GraphicsContextPdf.fillcolor_cmd>), (('_joinstyle',), <fonction GraphicsContextPdf.joinstyle_cmd>), (('_linewidth',) , <fonction GraphicsContextPdf.linewidth_cmd>), (('_dashes',), <fonction GraphicsContextPdf.dash_cmd>), (('_rgb',), <fonction GraphicsContextPdf.rgb_cmd>), (('_hatch', '_hatch_color'), <fonction GraphicsContextPdf.hatch_cmd>))

copy_properties ( autre )

Copiez les propriétés de l'autre dans vous-même.

dash_cmd ( tirets )

delta ( autre )

Copiez les propriétés de l'autre dans vous-même et renvoyez les commandes PDF nécessaires pour vous transformer en autre.

remplir ( * args )

Prédicat : le chemin doit-il être rempli ?

Un argument facultatif peut être utilisé pour spécifier un _fillcolor alternatif, tel que requis par RendererPdf.draw_markers.

fillcolor_cmd ( rgb )

finaliser ( )

Assurez-vous que chaque état graphique poussé est sauté.

hatch_cmd ( hatch , hatch_color )

joinstyle_cmd ( style )

joinstyles = {'bevel' : 2, 'miter' : 0, 'round' : 1}

linewidth_cmd ( largeur )

peinture ( )

Renvoie l'opérateur pdf approprié pour que le chemin soit tracé, rempli ou les deux.

pop ( )

pousser ( )

rgb_cmd ( rgb )

trait ( )

Prédicat : le chemin doit-il être tracé (son contour dessiné) ? Cela teste les diverses conditions qui désactivent le tracé du chemin, auquel cas il serait vraisemblablement rempli.

classe matplotlib.backends.backend_pdf. Nom ( nom )

Socles :object

Objet de nom PDF.

static hexify ( match )

[ Obsolète ]

Remarques

Obsolète depuis la version 3.6 :

nom

pdfRepr ( )

classe matplotlib.backends.backend_pdf. Op ( valeur )

Socles :Enum

Opérateurs PDF (liste non exhaustive).

begin_text = b'BT'

clip = b'W'

close_fill_stroke = b'b'

close_stroke = b's'

closepath = b'h'

concat_matrix = b'cm'

courbeto = b'c'

end_text = b'ET'

endpath = b'n'

fill = b'f'

fill_stroke = b'B'

grestore = b'Q'

gsave = b'q'

lineto = b'l'

moveto = b'm'

propriété op

classmethod paint_path ( fill , stroke )

Renvoyez l'opérateur PDF pour peindre un chemin.

Paramètres :

remplir booléen

Remplissez le chemin avec la couleur de remplissage.

booléen _

Contournez le contour du chemin avec la couleur de la ligne.

pdfRepr ( )

rectangle = b're'

selectfont = b'Tf'

setcolor_nonstroke = b'scn'

setcolor_stroke = b'SCN'

setcolorspace_nonstroke = b'cs'

setcolorspace_stroke = b'CS'

setdash = b'd'

setgray_nonstroke = b'g'

setgray_stroke = b'G'

setgstate = b'gs'

setlinecap = b'J'

setlinejoin = b'j'

setlinewidth = b'w'

setrgb_nonstroke = b'rg'

setrgb_stroke = b'RG'

ombrage = b'sh'

show = b'Tj'

showkern = b'TJ'

trait = b'S'

textmatrix = b'Tm'

textpos = b'Td'

use_xobject = b'Faire'

classe matplotlib.backends.backend_pdf. Opérateur ( op )

Socles :object

[ Obsolète ]

Remarques

Obsolète depuis la version 3.6 :

opération

pdfRepr ( )

classe matplotlib.backends.backend_pdf. PdfFile ( filename , metadata = None )

Socles :object

Objet de fichier PDF.

Paramètres :

nom de fichier str ou comme chemin ou comme fichier

Cible de sortie ; s'il s'agit d'une chaîne, un fichier sera ouvert en écriture.

métadonnées dict des chaînes aux chaînes et aux dates

Objet du dictionnaire d'informations (voir la section de référence PDF 10.2.1 'Dictionnaire d'informations sur le document'), par exemple : .{'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome'}

Les clés standard sont 'Title', 'Author', 'Subject', 'Keywords', 'Creator', 'Producter', 'CreationDate', 'ModDate' et 'Trapped'. Des valeurs ont été prédéfinies pour 'Creator', 'Producer' et 'CreationDate'. Ils peuvent être supprimés en les définissant sur None.

addGouraudTriangles ( points , couleurs )

Ajoutez un ombrage triangle de Gouraud.

Paramètres :

points np.ndarray

Sommets du triangle, forme (n, 3, 2) où n = nombre de triangles, 3 = sommets, 2 = x, y.

couleurs np.ndarray

Couleurs des sommets, forme (n, 3, 1) ou (n, 3, 4) comme pour les points, mais la dernière dimension est soit (gris,) soit (r, g, b, alpha).

Retours :

Nom, Référence

alphaState ( alpha )

Renvoie le nom d'un ExtGState qui définit alpha sur la valeur donnée.

beginStream ( id , len , extra = None , png = None )

fermer ( )

Videz tous les tampons et libérez toutes les ressources.

createType1Descriptor ( t1font , fontfile )

dviFontName ( dvifont )

Étant donné un objet de police dvi, renvoie un nom approprié pour Op.selectfont. Cela enregistre les informations de police self.dviFontInfosi elles ne sont pas encore enregistrées.

embedTTF ( nom de fichier , caractères )

Incorporez la police TTF du fichier nommé dans le document.

endStream ( )

finaliser ( )

Rédigez les différents objets différés et le sujet final du pdf.

fontName ( fontprop )

Sélectionnez une police basée sur fontprop et renvoyez un nom adapté à Op.selectfont. Si fontprop est une chaîne, elle sera interprétée comme le nom de fichier de la police.

hatchPattern ( hatch_style )

imageObjet ( image )

Renvoie le nom d'un XObject image représentant l'image donnée.

markerObject ( path , trans , fill , stroke , lw , joinstyle , capstyle )

Renvoie le nom d'un marqueur XObject représentant le chemin donné.

nouvellePage ( largeur , hauteur )

newTextnote ( text , positionRect = [-100, -100, 0, 0] )

sortie ( * données )

outputStream ( ref , data , * , extra = None )

pathCollectionObject ( gc , path , trans , padding , filled , stroked )

static pathOperations ( chemin , transformation , clip = Aucun , simplifier = Aucun , croquis = Aucun )

recordXref ( id )

reserveObject ( nom = '' )

Réserver un ID pour un objet indirect.

Le nom est utilisé pour le débogage au cas où nous oublierions d'imprimer l'objet avec writeObject.

écrire ( données )

writeExtGSTates ( )

writeFonts ( )

écrireGouraudTriangles ( )

écrireHachures ( )

écrireImages ( )

écrireInfoDict ( )

Rédigez le dictionnaire d'informations, en vérifiant sa bonne forme

writeMarkers ( )

writeObject ( objet , contenu )

writePath ( path , transform , clip = False , sketch = None )

writePathCollectionTemplates ( )

écrireTrailer ( )

Rédigez la bande-annonce PDF.

écrireXref ( )

Écrivez la table xréf.

classe matplotlib.backends.backend_pdf. PdfPages ( filename , keep_empty = True , metadata = None )

Socles :object

Un fichier PDF de plusieurs pages.

Remarques

En réalité , il PdfPagesy a une fine enveloppe autour PdfFilede , afin d'éviter toute confusion lors de l'utilisation savefiget de l'oubli de l'argument format.

Exemples

>>> import matplotlib.pyplot as plt
>>> # Initialize:
>>> with PdfPages('foo.pdf') as pdf:
...     # As many times as you like, create a figure fig and save it:
...     fig = plt.figure()
...     pdf.savefig(fig)
...     # When no figure is specified the current figure is saved
...     pdf.savefig()

Créez un nouvel objet PdfPages.

Paramètres :

nom de fichier str ou comme chemin ou comme fichier

Les tracés utilisant PdfPages.savefigseront écrits dans un fichier à cet emplacement. Le fichier est ouvert immédiatement et tout fichier plus ancien portant le même nom est écrasé.

keep_empty booléen , facultatif

S'il est défini sur False, les fichiers pdf vides seront automatiquement supprimés lors de la fermeture.

dict de métadonnées , facultatif

Objet du dictionnaire d'informations (voir la section de référence PDF 10.2.1 'Dictionnaire d'informations sur le document'), par exemple : .{'Creator': 'My software', 'Author': 'Me', 'Title': 'Awesome'}

Les clés standard sont 'Title', 'Author', 'Subject', 'Keywords', 'Creator', 'Producter', 'CreationDate', 'ModDate' et 'Trapped'. Des valeurs ont été prédéfinies pour 'Creator', 'Producer' et 'CreationDate'. Ils peuvent être supprimés en les définissant sur None.

attach_note ( texte , positionRect = [-100, -100, 0, 0] )

Ajoutez une nouvelle note de texte à la page à enregistrer ensuite. L'option positionRect spécifie la position de la nouvelle note sur la page. Il est en dehors de la page par défaut pour s'assurer qu'il est invisible sur les impressions.

fermer ( )

Finalisez cet objet, transformant le fichier sous-jacent en un fichier PDF complet.

get_pagecount ( )

Renvoie le nombre actuel de pages dans le fichier pdf multipage.

infodict ( )

Renvoie un objet dictionnaire d'informations modifiable (voir référence PDF section 10.2.1 'Dictionnaire d'informations sur le document').

keep_empty

savefig ( figure = None , ** kwargs )

Enregistrez un Figuredans ce fichier en tant que nouvelle page.

Tous les autres arguments de mots-clés sont passés à savefig.

Paramètres :

chiffre Figureou int, par défaut : le chiffre actif

La figure, ou l'index de la figure, qui est enregistré dans le fichier.

classe matplotlib.backends.backend_pdf. Référence ( id )

Socles :object

Objet de référence PDF.

Utilisez PdfFile.reserveObject() pour créer des références.

pdfRepr ( )

écrire ( contenu , fichier )

classe matplotlib.backends.backend_pdf. RendererPdf ( fichier , image_dpi , hauteur , largeur )

Socles :RendererPDFPSBase

check_gc ( gc , fillcolor = None )

draw_gouraud_triangle ( gc , points , colors , trans )

Dessinez un triangle ombré de Gouraud.

Paramètres :

gcGraphicsContextBase

Le contexte graphique.

points (3, 2) en forme de tableau

Tableau de (x, y) points pour le triangle.

couleurs (3, 4) en forme de tableau

Couleurs RGBA pour chaque point du triangle.

transformermatplotlib.transforms.Transform

Une transformation affine à appliquer aux points.

draw_gouraud_triangles ( gc , points , colors , trans )

Dessinez une série de triangles de Gouraud.

Paramètres :

points (N, 3, 2) en forme de tableau

Tableau de N (x, y) points pour les triangles.

couleurs (N, 3, 4) en forme de tableau

Tableau de N couleurs RGBA pour chaque point des triangles.

transformermatplotlib.transforms.Transform

Une transformation affine à appliquer aux points.

draw_image ( gc , x , y , im , transform = None )

Dessinez une image RGBA.

Paramètres :

gcGraphicsContextBase

Un contexte graphique avec des informations de découpage.

x scalaire

La distance en unités physiques (c'est-à-dire, points ou pixels) depuis le côté gauche du canevas.

y scalaire

La distance en unités physiques (c'est-à-dire, points ou pixels) depuis le bas du canevas.

im (N, M, 4) comme un tableau de np.uint8

Un tableau de pixels RGBA.

transformermatplotlib.transforms.Affine2DBase

Si et seulement si le backend concret est écrit de telle sorte que option_scale_imagerenvoie True, une transformation affine (c'est-à-dire un Affine2DBase) peut être passée à draw_image. Le vecteur de translation de la transformation est donné en unités physiques (c'est-à-dire points ou pixels). Notez que la transformation ne remplace pas x et y , et doit être appliquée avant de traduire le résultat par x et y (cela peut être accompli en ajoutant x et y au vecteur de translation défini par transform ).

draw_markers ( gc , marker_path , marker_trans , path , trans , rgbFace = None )

Dessinez un marqueur à chacun des sommets du chemin (à l'exclusion des points de contrôle).

L'implémentation de base (de secours) effectue plusieurs appels à draw_path. Les backends peuvent souhaiter remplacer cette méthode afin de dessiner le marqueur une seule fois et de le réutiliser plusieurs fois.

Paramètres :

gcGraphicsContextBase

Le contexte graphique.

marqueur_transmatplotlib.transforms.Transform

Une transformation affine appliquée au marqueur.

transmatplotlib.transforms.Transform

Une transformation affine appliquée au chemin.

draw_mathtext ( gc , x , y , s , prop , angle )

draw_path ( gc , path , transform , rgbFace = None )

Dessinez une Pathinstance à l'aide de la transformation affine donnée.

draw_path_collection ( gc , master_transform , paths , all_transforms , offsets , offset_trans , facecolors , edgecolors , linewidths , linestyles , antialiased , urls , offset_position )

Dessinez une collection de chemins .

Chaque chemin est d'abord transformé par l'entrée correspondante dans all_transforms (une liste de matrices (3, 3)) puis par master_transform . Ils sont ensuite traduits par l'entrée correspondante dans offsets , qui a d'abord été transformée par offset_trans .

facecolors , edgecolors , linewidths , linestyles et antialiased sont des listes qui définissent les propriétés correspondantes.

offset_position n'est plus utilisé maintenant, mais l'argument est conservé pour la compatibilité descendante.

L'implémentation de base (de secours) effectue plusieurs appels à draw_path. Les backends peuvent vouloir remplacer cela afin de rendre chaque ensemble de données de chemin une seule fois, puis référencer ce chemin plusieurs fois avec les différents décalages, couleurs, styles, etc. Les méthodes du générateur _iter_collection_raw_pathset _iter_collectionsont fournies pour aider (et normaliser) la mise en œuvre à travers les back-ends. Il est fortement recommandé d'utiliser ces générateurs, afin que les changements de comportement de draw_path_collectionpuissent être effectués globalement.

draw_tex ( gc , x , y , s , prop , angle , * , mtext = None )

draw_text ( gc , x , y , s , prop , angle , ismath = False , mtext = None )

Dessinez une instance de texte.

Paramètres :

gcGraphicsContextBase

Le contexte graphique.

x flotteur

L'emplacement x du texte dans les coordonnées d'affichage.

je flotte

L'emplacement y de la ligne de base du texte dans les coordonnées d'affichage.

s str

La chaîne de texte.

soutenirmatplotlib.font_manager.FontProperties

Les propriétés de la police.

flotteur d' angle

L'angle de rotation en degrés dans le sens inverse des aiguilles d'une montre.

textmultmatplotlib.text.Text

L'objet texte d'origine à rendre.

Remarques

Remarque pour les implémenteurs backend :

Lorsque vous essayez de déterminer si vous avez correctement défini votre cadre de délimitation (ce qui permet à la disposition/à l'alignement du texte de fonctionner correctement), il est utile de modifier la ligne dans text.py :

if 0: bbox_artist(self, renderer)

à si 1, puis la zone de délimitation réelle sera tracée avec votre texte.

encode_string ( s , fonttype )

finaliser ( )

get_image_magnification ( )

Obtenez le facteur d'agrandissement des images transmises à draw_image. Permet à un backend d'avoir des images à une résolution différente de celle des autres artistes.

nouveau_gc ( )

Renvoie une instance d'un GraphicsContextBase.

classe matplotlib.backends.backend_pdf. Flux ( id , len , fichier , extra = Aucun , png = Aucun )

Socles :object

Objet de flux PDF.

Cela n'a pas de méthode pdfRepr. Au lieu de cela, appelez begin(), puis affichez le contenu du flux en appelant write(), et enfin appelez end().

Paramètres :

identifiant entier

ID d'objet du flux.

len Référence ou Aucun

Un objet Reference inutilisé pour la longueur du flux ; Aucun signifie utiliser une mémoire tampon pour que la longueur puisse être intégrée.

fichier PdfFichier

L'objet sous-jacent dans lequel écrire le flux.

dict supplémentaire de Nom à n'importe quoi, ou Aucun

Paires clé-valeur supplémentaires à inclure dans l'en-tête du flux.

png dict ou Aucun

Si les données sont déjà encodées en png, les paramètres de décodage.

compressobj

fin ( )

Finaliser le flux.

supplémentaire

fichier

identifiant

len

pdfFichier

position

écrire ( données )

Écrivez des données sur le flux.

classe matplotlib.backends.backend_pdf. Verbatim ( x )

Socles :object

Stockez le contenu des commandes PDF textuelles pour une inclusion ultérieure dans le flux.

pdfRepr ( )

matplotlib.backends.backend_pdf. fill ( strings , linelen = 75 )

[ Obsolète ]

Remarques

Obsolète depuis la version 3.6 : utilisez plutôt une copie du fournisseur de _fill.

matplotlib.backends.backend_pdf. pdfRepr ( obj )

Mappez les objets Python à la syntaxe PDF.