@pdftron/pdfnet-node-samples 9.2.0 → 9.4.0

package/samples/HTML2PDFTest/HTML2PDFTest.js

@@ -1,5 +1,5 @@
 //---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
+// Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
 // Consult legal.txt regarding legal and license information.
 //---------------------------------------------------------------------------------------
 
@@ -29,17 +29,28 @@ const PDFTronLicense = require('../LicenseKey/LicenseKey');
   exports.runHTML2PDFTest = () => {
     const main = async () => {
       const outputPath = '../TestFiles/Output/html2pdf_example';
-      const host = 'http://www.gutenberg.org/';
-      const page0 = 'wiki/Main_Page';
-      const page1 = 'catalog/';
-      const page2 = 'browse/recent/last1';
-      const page3 = 'wiki/Gutenberg:The_Sheet_Music_Project';
-
-	// For HTML2PDF we need to locate the html2pdf module. If placed with the 
-	// PDFNet library, or in the current working directory, it will be loaded
-	// automatically. Otherwise, it must be set manually using HTML2PDF.setModulePath.
+      const host = 'https://www.pdftron.com';
+      const page0 = '/';
+      const page1 = '/support';
+      const page2 = '/blog';
+      // For HTML2PDF we need to locate the html2pdf module. If placed with the 
+      // PDFNet library, or in the current working directory, it will be loaded
+      // automatically. Otherwise, it must be set manually using HTML2PDF.setModulePath.
       await PDFNet.HTML2PDF.setModulePath('../../lib/');
 
+      try {
+           if(await !PDFNet.HTML2PDF.isModuleAvailable()){
+            console.log('Unable to run HTML2PDFTest: PDFTron SDK HTML2PDF module not available.');
+            console.log('---------------------------------------------------------------');
+            console.log('The HTML2PDF module is an optional add-on, available for download');
+            console.log('at https://www.pdftron.com/. If you have already downloaded this');
+            console.log('module, ensure that the SDK is able to find the required files');
+            console.log('using the HTML2PDF.setModulePath() function.');
+        }
+      } catch (err) {
+        console.log(err);
+      }
+
       //--------------------------------------------------------------------------------
       // Example 1) Simple conversion of a web page to a PDF doc. 
 
@@ -69,16 +80,16 @@ const PDFTronLicense = require('../LicenseKey/LicenseKey');
 
         // create the HTML2PDF converter object and modify the output of the PDF pages
         const html2pdf = await PDFNet.HTML2PDF.create();
-        html2pdf.setImageQuality(25);
         html2pdf.setPaperSize(PDFNet.PrinterMode.PaperSize.e_11x17);
 
         // insert the web page to convert
         html2pdf.insertFromUrl(host.concat(page0));
+
         // convert the web page, appending generated PDF pages to doc
         if (await html2pdf.convert(doc)) {
           doc.save(outputPath.concat('_02.pdf'), PDFNet.SDFDoc.SaveOptions.e_linearized);
         } else {
-          console.log('conversion failed. HTTP Code: ' + await html2pdf.getHttpErrorCode());
+          console.log('Conversion failed. HTTP Code: ' + await html2pdf.getHttpErrorCode());
           console.log(await html2pdf.getLog());
         }
       } catch (err) {
@@ -86,41 +97,40 @@ const PDFTronLicense = require('../LicenseKey/LicenseKey');
       }
 
       //--------------------------------------------------------------------------------
-      // Example 3) Convert multiple web pages, adding a table of contents, and setting
-      // the first page as a cover page, not to be included with the table of contents outline. 
+      // Example 3) Convert multiple web pages
 
       try {
-        // Add a cover page, which is excluded from the outline, and ignore any errors
-        const cover = await PDFNet.HTML2PDF.WebPageSettings.create();
-        cover.setLoadErrorHandling(PDFNet.HTML2PDF.WebPageSettings.ErrorHandling.e_ignore);
-        await cover.setIncludeInOutline(false);
-
-        const html2pdf = await PDFNet.HTML2PDF.create();
-        html2pdf.insertFromUrl2(host.concat(page3), cover);
-
-        // Add a table of contents settings (modifying the settings is optional)
-        const toc = await PDFNet.HTML2PDF.TOCSettings.create();
-        await toc.setDottedLines(false);
-        html2pdf.insertTOC2(toc);
-
-        // Now add the rest of the web pages, disabling external links and 
-        // skipping any web pages that fail to load.
-        //
-        // Note that the order of insertion matters, so these will appear
-        // after the cover and table of contents, in the order below.
-        const settings = await PDFNet.HTML2PDF.WebPageSettings.create();
-        settings.setLoadErrorHandling(PDFNet.HTML2PDF.WebPageSettings.ErrorHandling.e_skip);
-        await settings.setExternalLinks(false);
+        // convert page 0 into pdf
+        const doc = await PDFNet.PDFDoc.create();
 
-        html2pdf.insertFromUrl2(host.concat(page0), settings);
-        html2pdf.insertFromUrl2(host.concat(page1), settings);
-        html2pdf.insertFromUrl2(host.concat(page2), settings);
+        const converter = await PDFNet.HTML2PDF.create();
 
-        const doc = await PDFNet.PDFDoc.create();
-        if (await html2pdf.convert(doc)) {
+        const header = '<div style=\'width:15%;margin-left:0.5cm;text-align:left;font-size:10px;color:#0000FF\'><span class=\'date\'></span></div><div style=\'width:70%;direction:rtl;white-space:nowrap;overflow:hidden;text-overflow:clip;text-align:center;font-size:10px;color:#0000FF\'><span>PDFTRON HEADER EXAMPLE</span></div><div style=\'width:15%;margin-right:0.5cm;text-align:right;font-size:10px;color:#0000FF\'><span class=\'pageNumber\'></span> of <span class=\'totalPages\'></span></div>';
+        const footer = '<div style=\'width:15%;margin-left:0.5cm;text-align:left;font-size:7px;color:#FF00FF\'><span class=\'date\'></span></div><div style=\'width:70%;direction:rtl;white-space:nowrap;overflow:hidden;text-overflow:clip;text-align:center;font-size:7px;color:#FF00FF\'><span>PDFTRON FOOTER EXAMPLE</span></div><div style=\'width:15%;margin-right:0.5cm;text-align:right;font-size:7px;color:#FF00FF\'><span class=\'pageNumber\'></span> of <span class=\'totalPages\'></span></div>';
+        converter.setHeader(header);
+        converter.setFooter(footer);
+        converter.setMargins('1cm', '2cm', '.5cm', '1.5cm');
+        const settings = await PDFNet.HTML2PDF.WebPageSettings.create();
+        await settings.setZoom(0.5);
+        converter.insertFromUrl2(host.concat(page0), settings);
+        const is_conversion_0_successful = await converter.convert(doc);
+
+        // convert page 1 with the same settings, appending generated PDF pages to doc
+        converter.insertFromUrl2(host.concat(page1), settings);
+        const is_conversion_1_successful = await converter.convert(doc);
+
+        // convert page 2 with different settings, appending generated PDF pages to doc
+        const another_converter = await PDFNet.HTML2PDF.create();
+        another_converter.setLandscape(true);
+        const another_settings =  await PDFNet.HTML2PDF.WebPageSettings.create();
+        another_settings.setPrintBackground(false);
+        another_converter.insertFromUrl2(host.concat(page2), another_settings);
+        const is_conversion_2_successful = await another_converter.convert(doc);
+
+         if(is_conversion_0_successful && is_conversion_1_successful && is_conversion_2_successful) {
           doc.save(outputPath.concat('_03.pdf'), PDFNet.SDFDoc.SaveOptions.e_linearized);
         } else {
-          console.log('conversion failed. HTTP Code: ' + await html2pdf.getHttpErrorCode());
+          console.log('Conversion failed. HTTP Code: ' + await html2pdf.getHttpErrorCode());
           console.log(await html2pdf.getLog());
         }
       } catch (err) {
@@ -133,13 +143,13 @@ const PDFTronLicense = require('../LicenseKey/LicenseKey');
       try {
         const html2pdf = await PDFNet.HTML2PDF.create();
         const doc = await PDFNet.PDFDoc.create();
-        const html = '<html><body><h1>Heading</h1><p>Paragraph.</p></body></html>'
+        const html = '<html><body><h1>Heading</h1><p>Paragraph.</p></body></html>';
 
         html2pdf.insertFromHtmlString(html);
         if (await html2pdf.convert(doc)) {
           doc.save(outputPath.concat('_04.pdf'), PDFNet.SDFDoc.SaveOptions.e_linearized);
         } else {
-          console.log('conversion failed. HTTP Code: ' + await html2pdf.getHttpErrorCode());
+          console.log('Conversion failed. HTTP Code: ' + await html2pdf.getHttpErrorCode());
           console.log(await html2pdf.getLog());
         }
       } catch (err) {

package/samples/HighlightsTest/HighlightsTest.js

@@ -0,0 +1,97 @@
+//---------------------------------------------------------------------------------------
+// Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
+// Consult legal.txt regarding legal and license information.
+//---------------------------------------------------------------------------------------
+
+
+const { PDFNet } = require('@pdftron/pdfnet-node');
+const PDFTronLicense = require('../LicenseKey/LicenseKey');
+
+// This sample illustrates the basic text highlight capabilities of PDFNet.
+// It simulates a full-text search engine that finds all occurrences of the word 'Federal'.
+// It then highlights those words on the page.
+//
+// Note: The TextSearch class is the preferred solution for searching text within a single
+// PDF file. TextExtractor provides search highlighting capabilities where a large number
+// of documents are indexed using a 3rd party search engine.
+((exports) => {
+
+  exports.runHighlightsTest = async () => {
+    const main = async () => {
+      // eslint-disable-next-line no-unused-vars
+      let ret = 0;
+
+      // Relative path to the folder containing test files.
+      const inputPath = '../TestFiles/';
+      const outputPath = '../TestFiles/Output/';
+      const inputFilename = 'paragraphs_and_tables.pdf';
+
+      try {
+        await PDFNet.startDeallocateStack();
+        const doc = await PDFNet.PDFDoc.createFromFilePath(inputPath + inputFilename);
+        doc.initSecurityHandler();
+
+        const page = await doc.getPage(1);
+
+        if (page.id === '0') {
+          console.log('Page not found.');
+          return 1;
+        }
+
+        const txt = await PDFNet.TextExtractor.create();
+        txt.begin(page);
+
+        // Do not dehyphenate; that would interfere with character offsets
+        const dehyphen = false;
+        // Retrieve the page text
+        const pageText = await txt.getAsText(dehyphen);
+        
+        // Simulating a full-text search engine that finds all occurrences of the word 'Federal'.
+        // In a real application, plug in your own search engine here.
+        const searchText = 'Federal';
+        let charRanges = [];
+        let ofs = pageText.indexOf(searchText);
+        while (ofs >= 0) {
+          const range = { index: ofs, length: searchText.length };
+          charRanges.push(range); // character offset + length
+          ofs = pageText.indexOf(searchText, ofs + 1);
+        }
+
+        // Retrieve Highlights object and apply annotations to the page
+        const hlts = await txt.getHighlights(charRanges);
+        await hlts.begin(doc);
+        while ((await hlts.hasNext())) {
+          const curPage = await doc.getPage((await hlts.getCurrentPageNumber()));
+          const quadArr = await hlts.getCurrentQuads();
+          for (let i = 0; i < quadArr.length; ++i) {
+            const currQuad = quadArr[i];
+            const x1 = Math.min(Math.min(Math.min(currQuad.p1x, currQuad.p2x), currQuad.p3x), currQuad.p4x);
+            const x2 = Math.max(Math.max(Math.max(currQuad.p1x, currQuad.p2x), currQuad.p3x), currQuad.p4x);
+            const y1 = Math.min(Math.min(Math.min(currQuad.p1y, currQuad.p2y), currQuad.p3y), currQuad.p4y);
+            const y2 = Math.max(Math.max(Math.max(currQuad.p1y, currQuad.p2y), currQuad.p3y), currQuad.p4y);
+
+            const highlight = await PDFNet.HighlightAnnot.create(doc, (await PDFNet.Rect.init(x1, y1, x2, y2)));
+            await highlight.refreshAppearance();
+            await curPage.annotPushBack(highlight);
+
+            console.log('[' + x1.toFixed(2) + ', ' + y1.toFixed(2) + ', ' + x2.toFixed(2) + ', ' + y2.toFixed(2) + ']');
+          }
+          hlts.next();
+        }
+
+        // Output highlighted PDF doc
+        await doc.save(outputPath + 'search_highlights.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
+
+        await PDFNet.endDeallocateStack();
+      } catch (err) {
+        console.log(err);
+        console.log(err.stack);
+        ret = 1;
+      }
+    };
+    PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function (error) { console.log('Error: ' + JSON.stringify(error)); }).then(function () { return PDFNet.shutdown(); });
+  };
+  exports.runHighlightsTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
+//# sourceURL=HighlightsTest.js

package/samples/ImageExtractTest/ImageExtractTest.js

@@ -1,5 +1,5 @@
 //---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
+// Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
 // Consult legal.txt regarding legal and license information.
 //---------------------------------------------------------------------------------------
 

package/samples/ImpositionTest/ImpositionTest.js

@@ -1,5 +1,5 @@
 //---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
+// Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
 // Consult legal.txt regarding legal and license information.
 //---------------------------------------------------------------------------------------
 

package/samples/InteractiveFormsTest/InteractiveFormsTest.js

@@ -1,5 +1,5 @@
 //---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
+// Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
 // Consult legal.txt regarding legal and license information.
 //---------------------------------------------------------------------------------------
 

package/samples/JBIG2Test/JBIG2Test.js

@@ -1,5 +1,5 @@
 //---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
+// Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
 // Consult legal.txt regarding legal and license information.
 //---------------------------------------------------------------------------------------
 

package/samples/LicenseKey/LicenseKey.js

@@ -1,11 +1,11 @@
-//---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
-// Consult legal.txt regarding legal and license information.
-//---------------------------------------------------------------------------------------
-
-//"Enter your key here. If you don't have it, please go to https://www.pdftron.com/pws/get-key to obtain a demo license or https://www.pdftron.com/form/contact-sales to obtain a production key.
-const LicenseKey = 'YOUR_PDFTRON_LICENSE_KEY';
-if(LicenseKey == 'YOUR_PDFTRON_LICENSE_KEY'){
-    throw ('Please enter your license key by replacing \'YOUR_PDFTRON_LICENSE_KEY\' that is assigned to the LicenseKey variable in Samples/LicenseKey/LicenseKey.js. If you do not have a license key, please go to https://www.pdftron.com/pws/get-key to obtain a demo license or https://www.pdftron.com/form/contact-sales to obtain a production key.');
-}
-exports.Key = LicenseKey;
+//---------------------------------------------------------------------------------------
+// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
+// Consult legal.txt regarding legal and license information.
+//---------------------------------------------------------------------------------------
+
+//"Enter your key here. If you don't have it, please go to https://www.pdftron.com/pws/get-key to obtain a demo license or https://www.pdftron.com/form/contact-sales to obtain a production key.
+const LicenseKey = 'YOUR_PDFTRON_LICENSE_KEY';
+if(LicenseKey == 'YOUR_PDFTRON_LICENSE_KEY'){
+    throw ('Please enter your license key by replacing \'YOUR_PDFTRON_LICENSE_KEY\' that is assigned to the LicenseKey variable in Samples/LicenseKey/LicenseKey.js. If you do not have a license key, please go to https://www.pdftron.com/pws/get-key to obtain a demo license or https://www.pdftron.com/form/contact-sales to obtain a production key.');
+}
+exports.Key = LicenseKey;