PDFKit è una libreria Node.js che semplifica agli sviluppatori la creazione e l'utilizzo di file PDF. Offre un'API semplice ma efficace per la produzione di PDF e l'aggiunta di diversi tipi di contenuto, come testo, immagini e forme.
Scopri come utilizzare PDF Kit per creare PDF in Node.js.
Configurazione di PDFkit
Tu devi avere Node.js e npm (il gestore di pacchetti Node.js) installati sulla tua macchina da seguire.
Assicurati di aver installato questi strumenti eseguendo i seguenti comandi del terminale:
nodo -v
npm -v
Per iniziare a utilizzare PDFKit nel tuo progetto Node.js, installalo eseguendo il seguente comando npm:
npm installa pdfkit
Questo comando installerà PDFKit e lo aggiungerà alle dipendenze del tuo progetto.
Creazione di un documento PDF con PDFKit
Per creare un documento PDF utilizzando PDFKit, è necessario il file pdfkit pacchetto e il fs (file system) nel file di script:
cost PDFDocumento = richiedere('kit pdf');
cost fs = richiedere('fs');
Successivamente, crea una nuova istanza di Documento PDF classe. Questa classe rappresenta un file PDF:
cost doc = nuovo Documento PDF();
L'istanza creata è un flusso leggibile, il che significa che puoi usare il file tubo() metodo per salvarne il contenuto in un file.
Per fare ciò, pipa il doc instance in un flusso scrivibile creato da fs.createWriteStream:
doc.pipe (fs.createWriteStream('Il mioPDFDDoc.pdf'));
IL createWriteStream Il metodo salva il contenuto di un file PDF in una posizione specificata nel file system locale.
Il blocco di codice precedente salverà il file PDF risultante nella directory di lavoro corrente, con il nome Il mio PDFDoc.pdf.
È importante terminare sempre il flusso dopo aver aggiunto contenuto al PDF. Puoi farlo usando questo comando:
doc.end();
Ora esegui il comando node nodo [nome script] per creare il file PDF Il mio PDFDoc.pdf nella tua attuale directory di lavoro.
Aggiunta di testo con PDFKit
Prima di reindirizzare il documento per salvarlo, puoi apportare varie modifiche. PDFKit semplifica l'aggiunta di testo ai documenti e include molte opzioni per personalizzare la visualizzazione dell'output.
Per aggiungere testo al documento, basta chiamare il testo() metodo e passare il testo che si desidera aggiungere come argomento:
doc.testo("Codificare è facile!")
Man mano che PDFKIT aggiunge testo al documento, tiene traccia delle posizioni X e Y correnti di quel testo. Quindi, ogni volta che chiami il metodo di testo, PDFKit aggiungerà una nuova riga sotto quella precedente.
Tuttavia, fornendo le coordinate X e Y al metodo text dopo il testo stesso, puoi cambiarne la posizione:
doc.testo("Codificare è facile!", 100, 100)
Per spostarti su o giù di una riga, chiama il abbassati O andare avanti metodo con il numero di righe che il testo deve spostare:
doc.moveDown(3);
doc.moveUp();
Per impostazione predefinita, chiamare uno dei due metodi senza passare un argomento lo farà spostare di una sola riga.
PDFKit supporta ciascuno dei 14 caratteri standard definiti dal formato PDF. IL Documentazione di testo PDFKit ha un elenco completo di questi caratteri standard.
Usa il font() metodo per specificare il carattere richiesto. Basta passare il nome del carattere corrispondente come stringa:
doc.font('Times-Roman')
.testo("Codificare è facile!");Puoi anche modificare la dimensione del carattere e il colore del testo utilizzando il dimensione del font() e il colore di riempimento() metodi, rispettivamente.
Per esempio:
// Questo cambia il colore del testo in rosso e gli dà una dimensione del carattere di 8
doc.fillColor('rosso')
.dimensione del font(8)
.testo("Codificare è facile!");
Aggiunta di immagini con PDFKit
A un'immagine nel tuo documento PDF, passa semplicemente il suo percorso al file Immagine metodo sull'istanza del documento:
doc.immagine('percorso/verso/immagine.jpeg')
PDFKit ti consente di aggiungere immagini in entrambi Formato JPEG o PNG.
Per impostazione predefinita, PDFKit inserirà l'immagine nella sua dimensione nativa. Puoi modificare le dimensioni di un'immagine fornendo un oggetto contenente coppie chiave-valore come argomento a Immagine() metodo. È possibile specificare larghezza, altezza e allineamento orizzontale e verticale.
Per esempio:
// Specificando solo la larghezza
doc.immagine('percorso/verso/immagine.jpg', { larghezza: 300 });
// Specifica sia la larghezza che l'altezza
doc.immagine('percorso/verso/immagine.jpg', { larghezza: 300, altezza:200 })
Aggiunta di pagine con PDFKit
Per aggiungere nuove pagine al documento PDF, basta chiamare il file Aggiungi pagina metodo sull'istanza del documento:
doc.addPage()
Per aggiungere automaticamente contenuto ogni volta che aggiungi una nuova pagina, utilizza il file pageAdded evento sull'istanza del documento.
Per esempio:
doc.on('pagina aggiunta', () => doc.testo("Codificare è facile!"));
PDFKit ti consente di specificare le dimensioni della pagina quando crei un nuovo documento o aggiungi una nuova pagina a una esistente. Ci sono diverse dimensioni di pagina predefinite che il file Documentazione cartacea PDFKit spiega.
Per utilizzare una qualsiasi di queste dimensioni di pagina predefinite, passare un oggetto al file Documento PDF costruttore o il Aggiungi pagina() metodo. Utilizzare la proprietà size per specificare una stringa che è il nome del formato carta.
Per esempio:
// costruttore
cost doc = nuovo Documento PDF({ misurare: 'A5' });
// funzione addPage
doc.addPage({ misurare: 'A7' });
Passando questo oggetto options al file Documento PDF costruttore imposta la dimensione della pagina predefinita per l'intero documento. È quindi possibile sovrascrivere questo valore predefinito passando un valore diverso a Aggiungi pagina metodo.
Puoi impostare i margini della pagina passando un oggetto al file margini proprietà quando si aggiungono pagine.
IL margini proprietà prende un oggetto con in alto, in basso, a sinistra, E Giusto proprietà che rappresentano ciascun margine.
Per esempio:
// Aggiungi margini diversi su ciascun lato
doc.addPage({
margini: {
superiore: 72,
metter il fondo a: 72,
Sinistra: 50,
Giusto: 50
}
});
Questo codice imposta i margini superiore e inferiore a 72 punti e i margini sinistro e destro a 50 punti. Tieni presente che il margine predefinito per i documenti creati da PDFKit è un margine di 1 pollice (72 punti) su tutti i lati.
Per impostare tutti i margini superiore, inferiore, sinistro e destro allo stesso valore, passa semplicemente un oggetto con a margine proprietà al Aggiungi pagina metodo:
doc.addPage({ margine: 60 }) // aggiunge un margine di 60 punti su ciascun lato
I vantaggi della creazione di PDF con PDFKit in Node.js
PDFKit ti consente di produrre documenti standard e supportati dalle tue applicazioni Node.js. Con PDFKit, puoi gestire facilmente documenti complessi. Inoltre, può facilitare la consegna dei documenti agli utenti e semplificarne la condivisione e la stampa.
