HTML JPG PDF XML DOCX
Product Family
PDF

Add Image to Header of PDF in Node.js SDK

Add Image in Header of PDF Document using Cloud Node.js SDK

Get Started
 

Aspose.PDF Cloud Node.js SDK Aspose.PDF Cloud Node.js SDK

Overview

GitHub Learn Buy

How to add Header via Node.js SDK

In order to add Image Header to PDF, we’ll use Aspose.PDF Cloud Node.js SDK. This Cloud SDK assists Node.js programmers in developing cloud-based PDF creator, annotator, editor, and converter apps using Node.js programming language via Aspose.PDF REST API. Simply create an account at Aspose for Cloud and get your application information. Once you have the App SID & key, you are ready to give the Aspose.PDF Cloud Node.js SDK.

Package Manager Console Command


     
    npm install asposepdfcloud --save
     
     

Steps to add Header via Cloud Node.js

Aspose.PDF Cloud developers can easily add Image in Header of PDF in just a few lines of code.

  1. Create an object to connect to the Pdf.Cloud API
  2. Upload your document file
  3. Perform the retreiving link annotattions from Pdf document using getPageLinkAnnotations() function
  4. Check result and perform some actions with result.body object
  5. Create a new Link Annotation with the required properties
  6. Append new Link Annotation to the document using postPageLinkAnnotations() function
  7. Perform some action after successful addition
  8. Download the result if needed it
 

This sample code shows adding Header using Node.js


    import credentials from "./credentials.json"  with { type: "json" };    // json-file in this format: { "id": "*****", "key": "*******" }
    import fs from 'node:fs/promises';
    import path from 'node:path';
    import { PdfApi } from "asposepdfcloud";
    import { ImageHeader } from "asposepdfcloud/src/models/imageHeader.js";
    import { HorizontalAlignment } from "asposepdfcloud/src/models/horizontalAlignment.js";

    const configParams = {
        LOCAL_FOLDER: "C:\\Samples\\",
        PDF_DOCUMENT_NAME: "sample.pdf",
        LOCAL_RESULT_DOCUMENT_NAME: "output_sample.pdf",
        IMAGE_HEADER_FILE: "sample.png",
        PAGE_NUMBER: 2,     // Your document page number...
    };

    const pdfApi = new PdfApi(credentials.id, credentials.key);

    const pdfHederFooter = {
        async uploadFile (fileName) {
            const pdfFileData = await fs.readFile(configParams.LOCAL_FOLDER + fileName);
            await pdfApi.uploadFile(fileName, pdfFileData);
        },

        async uploadDocument () {
            await pdfHederFooter.uploadFile(configParams.PDF_DOCUMENT_NAME);
        },

        async downloadResult() {
            const changedPdfData = await pdfApi.downloadFile(configParams.PDF_DOCUMENT_NAME);
            const filePath = path.join(configParams.LOCAL_FOLDER, configParams.LOCAL_RESULT_DOCUMENT_NAME);
            await fs.writeFile(filePath, changedPdfData.body);
            console.log("Downloaded: " + filePath);
        },

        async adddImageHeader () {
            const imageHeader = new ImageHeader();
            imageHeader.background = true;
            imageHeader.value = "TEST HEADER VALUE";
            imageHeader.horizontalAlignment = HorizontalAlignment.Center;
            imageHeader.fileName = configParams.IMAGE_HEADER_FILE;
            imageHeader.width = 24;
            imageHeader.height = 24;

            const resultLinks = await pdfApi.postDocumentImageHeader(configParams.PDF_DOCUMENT_NAME, imageHeader);

            if (resultLinks.body.code == 200) {
                return resultLinks.body;
            }
            else
                throw new Error("Unexpected error : can't append Text Header!");
        },
    }

    async function main() {
        try {
            await pdfHederFooter.uploadDocument();
            await pdfHederFooter.uploadFile(configParams.IMAGE_HEADER_FILE);
            await pdfHederFooter.adddImageHeader();
            await pdfHederFooter.downloadResult();
        } catch (error) {
            console.error("Error:", error.message);
        }
    }
 

Work with the Header via Node.js SDK

Adding an image to the header of a PDF enhances branding, professionalism, readability, and security. It ensures consistency in business, legal, marketing, and technical documents, making them more visually appealing and functional. Add the Header into PDF documents with Aspose.PDF Cloud Node.js SDK.

With our Node.js library you can

  • Add PDF document’s header & footer in text or image format.
  • Add tables & stamps (text or image) to PDF documents.
  • Append multiple PDF documents to an existing file.
  • Work with PDF attachments, annotations, & form fields.
  • Apply encryption or decryption to PDF documents & set a password.
  • Delete all stamps & tables from a page or entire PDF document.
  • Delete a specific stamp or table from the PDF document by its ID.
  • Replace single or multiple instances of text on a PDF page or from the entire document.
  • Extensive support for converting PDF documents to various other file formats.
  • Extract various elements of PDF files & make PDF documents optimized.
  • You can try out our free Apps to test the functionality online.