@pdftron/pdfnet-node-samples 9.4.2 → 9.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/package.json +18 -18
  2. package/readme.md +12 -12
  3. package/samples/AddImageTest/AddImageTest.js +1 -1
  4. package/samples/AddImageTest/NODEJS/AddImageTest.js +116 -0
  5. package/samples/AddImageTest/NODEJS/RunTest.sh +2 -0
  6. package/samples/AdvancedImagingTest/AdvancedImagingTest.js +1 -1
  7. package/samples/AdvancedImagingTest/NODEJS/AdvancedImagingTest.js +78 -0
  8. package/samples/AdvancedImagingTest/NODEJS/RunTest.sh +2 -0
  9. package/samples/AnnotationTest/AnnotationTest.js +1 -1
  10. package/samples/AnnotationTest/NODEJS/AnnotationTest.js +642 -0
  11. package/samples/AnnotationTest/NODEJS/RunTest.sh +2 -0
  12. package/samples/BookmarkTest/BookmarkTest.js +1 -1
  13. package/samples/BookmarkTest/NODEJS/BookmarkTest.js +220 -0
  14. package/samples/BookmarkTest/NODEJS/RunTest.sh +2 -0
  15. package/samples/CAD2PDFTest/CAD2PDFTest.js +79 -79
  16. package/samples/CAD2PDFTest/NODEJS/CAD2PDFTest.js +80 -0
  17. package/samples/CAD2PDFTest/NODEJS/RunTest.sh +2 -0
  18. package/samples/ContentReplacerTest/ContentReplacerTest.js +1 -1
  19. package/samples/ContentReplacerTest/NODEJS/ContentReplacerTest.js +75 -0
  20. package/samples/ContentReplacerTest/NODEJS/RunTest.sh +2 -0
  21. package/samples/ConvertTest/ConvertTest.js +270 -256
  22. package/samples/ConvertTest/NODEJS/ConvertTest.js +270 -0
  23. package/samples/ConvertTest/NODEJS/RunTest.sh +2 -0
  24. package/samples/DataExtractionTest/DataExtractionTest.js +180 -0
  25. package/samples/DataExtractionTest/NODEJS/DataExtractionTest.js +180 -0
  26. package/samples/DataExtractionTest/NODEJS/RunTest.sh +2 -0
  27. package/samples/DigitalSignaturesTest/DigitalSignaturesTest.js +526 -526
  28. package/samples/DigitalSignaturesTest/NODEJS/DigitalSignaturesTest.js +527 -0
  29. package/samples/DigitalSignaturesTest/NODEJS/RunTest.sh +2 -0
  30. package/samples/ElementBuilderTest/ElementBuilderTest.js +1 -1
  31. package/samples/ElementBuilderTest/NODEJS/ElementBuilderTest.js +514 -0
  32. package/samples/ElementBuilderTest/NODEJS/RunTest.sh +2 -0
  33. package/samples/ElementEditTest/ElementEditTest.js +1 -1
  34. package/samples/ElementEditTest/NODEJS/ElementEditTest.js +111 -0
  35. package/samples/ElementEditTest/NODEJS/RunTest.sh +2 -0
  36. package/samples/ElementReaderAdvTest/ElementReaderAdvTest.js +1 -1
  37. package/samples/ElementReaderAdvTest/NODEJS/ElementReaderAdvTest.js +305 -0
  38. package/samples/ElementReaderAdvTest/NODEJS/RunTest.sh +2 -0
  39. package/samples/ElementReaderTest/ElementReaderTest.js +1 -1
  40. package/samples/ElementReaderTest/NODEJS/ElementReaderTest.js +77 -0
  41. package/samples/ElementReaderTest/NODEJS/RunTest.sh +2 -0
  42. package/samples/EncTest/EncTest.js +1 -1
  43. package/samples/EncTest/NODEJS/EncTest.js +176 -0
  44. package/samples/EncTest/NODEJS/RunTest.sh +2 -0
  45. package/samples/FDFTest/FDFTest.js +218 -218
  46. package/samples/FDFTest/NODEJS/FDFTest.js +219 -0
  47. package/samples/FDFTest/NODEJS/RunTest.sh +2 -0
  48. package/samples/HTML2PDFTest/HTML2PDFTest.js +165 -165
  49. package/samples/HTML2PDFTest/NODEJS/HTML2PDFTest.js +166 -0
  50. package/samples/HTML2PDFTest/NODEJS/RunTest.sh +2 -0
  51. package/samples/HighlightsTest/HighlightsTest.js +1 -1
  52. package/samples/HighlightsTest/NODEJS/HighlightsTest.js +97 -0
  53. package/samples/HighlightsTest/NODEJS/RunTest.sh +2 -0
  54. package/samples/ImageExtractTest/ImageExtractTest.js +129 -129
  55. package/samples/ImageExtractTest/NODEJS/ImageExtractTest.js +130 -0
  56. package/samples/ImageExtractTest/NODEJS/RunTest.sh +2 -0
  57. package/samples/ImpositionTest/ImpositionTest.js +86 -86
  58. package/samples/ImpositionTest/NODEJS/ImpositionTest.js +87 -0
  59. package/samples/ImpositionTest/NODEJS/RunTest.sh +2 -0
  60. package/samples/InteractiveFormsTest/InteractiveFormsTest.js +381 -381
  61. package/samples/InteractiveFormsTest/NODEJS/InteractiveFormsTest.js +382 -0
  62. package/samples/InteractiveFormsTest/NODEJS/RunTest.sh +2 -0
  63. package/samples/JBIG2Test/JBIG2Test.js +88 -88
  64. package/samples/JBIG2Test/NODEJS/JBIG2Test.js +89 -0
  65. package/samples/JBIG2Test/NODEJS/RunTest.sh +2 -0
  66. package/samples/LicenseKey/NODEJS/LicenseKey.js +11 -0
  67. package/samples/LogicalStructureTest/LogicalStructureTest.js +1 -1
  68. package/samples/LogicalStructureTest/NODEJS/LogicalStructureTest.js +251 -0
  69. package/samples/LogicalStructureTest/NODEJS/RunTest.sh +2 -0
  70. package/samples/OCRTest/NODEJS/OCRTest.js +235 -0
  71. package/samples/OCRTest/NODEJS/RunTest.sh +2 -0
  72. package/samples/OCRTest/OCRTest.js +234 -234
  73. package/samples/OfficeTemplateTest/NODEJS/OfficeTemplateTest.js +79 -0
  74. package/samples/OfficeTemplateTest/NODEJS/RunTest.sh +2 -0
  75. package/samples/OfficeTemplateTest/OfficeTemplateTest.js +79 -77
  76. package/samples/OfficeToPDFTest/NODEJS/OfficeToPDFTest.js +125 -0
  77. package/samples/OfficeToPDFTest/NODEJS/RunTest.sh +2 -0
  78. package/samples/OfficeToPDFTest/OfficeToPDFTest.js +125 -125
  79. package/samples/OptimizerTest/NODEJS/OptimizerTest.js +192 -0
  80. package/samples/OptimizerTest/NODEJS/RunTest.sh +2 -0
  81. package/samples/OptimizerTest/OptimizerTest.js +191 -191
  82. package/samples/PDF2HtmlTest/NODEJS/PDF2HtmlTest.js +123 -0
  83. package/samples/PDF2HtmlTest/NODEJS/RunTest.sh +2 -0
  84. package/samples/PDF2HtmlTest/PDF2HtmlTest.js +1 -1
  85. package/samples/PDF2OfficeTest/NODEJS/PDF2OfficeTest.js +158 -0
  86. package/samples/PDF2OfficeTest/NODEJS/RunTest.sh +2 -0
  87. package/samples/PDF2OfficeTest/PDF2OfficeTest.js +1 -1
  88. package/samples/PDFATest/NODEJS/PDFATest.js +85 -0
  89. package/samples/PDFATest/NODEJS/RunTest.sh +2 -0
  90. package/samples/PDFATest/PDFATest.js +1 -1
  91. package/samples/PDFDocMemoryTest/NODEJS/PDFDocMemoryTest.js +85 -0
  92. package/samples/PDFDocMemoryTest/NODEJS/RunTest.sh +2 -0
  93. package/samples/PDFDocMemoryTest/PDFDocMemoryTest.js +84 -84
  94. package/samples/PDFDrawTest/NODEJS/PDFDrawTest.js +306 -0
  95. package/samples/PDFDrawTest/NODEJS/RunTest.sh +2 -0
  96. package/samples/PDFDrawTest/PDFDrawTest.js +1 -1
  97. package/samples/PDFLayersTest/NODEJS/PDFLayersTest.js +295 -0
  98. package/samples/PDFLayersTest/NODEJS/RunTest.sh +2 -0
  99. package/samples/PDFLayersTest/PDFLayersTest.js +1 -1
  100. package/samples/PDFPackageTest/NODEJS/PDFPackageTest.js +112 -0
  101. package/samples/PDFPackageTest/NODEJS/RunTest.sh +2 -0
  102. package/samples/PDFPackageTest/PDFPackageTest.js +111 -111
  103. package/samples/PDFPageTest/NODEJS/PDFPageTest.js +190 -0
  104. package/samples/PDFPageTest/NODEJS/RunTest.sh +2 -0
  105. package/samples/PDFPageTest/PDFPageTest.js +1 -1
  106. package/samples/PDFRedactTest/NODEJS/PDFRedactTest.js +75 -0
  107. package/samples/PDFRedactTest/NODEJS/RunTest.sh +2 -0
  108. package/samples/PDFRedactTest/PDFRedactTest.js +1 -1
  109. package/samples/PageLabelsTest/NODEJS/PageLabelsTest.js +139 -0
  110. package/samples/PageLabelsTest/NODEJS/RunTest.sh +2 -0
  111. package/samples/PageLabelsTest/PageLabelsTest.js +138 -138
  112. package/samples/PatternTest/NODEJS/PatternTest.js +227 -0
  113. package/samples/PatternTest/NODEJS/RunTest.sh +2 -0
  114. package/samples/PatternTest/PatternTest.js +226 -226
  115. package/samples/RectTest/NODEJS/RectTest.js +41 -0
  116. package/samples/RectTest/NODEJS/RunTest.sh +2 -0
  117. package/samples/RectTest/RectTest.js +1 -1
  118. package/samples/SDFTest/NODEJS/RunTest.sh +2 -0
  119. package/samples/SDFTest/NODEJS/SDFTest.js +88 -0
  120. package/samples/SDFTest/SDFTest.js +2 -3
  121. package/samples/StamperTest/NODEJS/RunTest.sh +2 -0
  122. package/samples/StamperTest/NODEJS/StamperTest.js +256 -0
  123. package/samples/StamperTest/StamperTest.js +1 -1
  124. package/samples/TestFiles/financial.pdf +0 -0
  125. package/samples/TestFiles/formfields-scanned.pdf +0 -0
  126. package/samples/TestFiles/formfields.pdf +0 -0
  127. package/samples/TestFiles/table.pdf +0 -0
  128. package/samples/TestFiles/tiger.svg +378 -0
  129. package/samples/TextExtractTest/NODEJS/RunTest.sh +2 -0
  130. package/samples/TextExtractTest/NODEJS/TextExtractTest.js +287 -0
  131. package/samples/TextExtractTest/TextExtractTest.js +1 -1
  132. package/samples/TextSearchTest/NODEJS/RunTest.sh +2 -0
  133. package/samples/TextSearchTest/NODEJS/TextSearchTest.js +122 -0
  134. package/samples/TextSearchTest/TextSearchTest.js +1 -1
  135. package/samples/U3DTest/NODEJS/RunTest.sh +2 -0
  136. package/samples/U3DTest/NODEJS/U3DTest.js +105 -0
  137. package/samples/U3DTest/U3DTest.js +104 -104
  138. package/samples/UndoRedoTest/NODEJS/RunTest.sh +2 -0
  139. package/samples/UndoRedoTest/NODEJS/UndoRedoTest.js +101 -0
  140. package/samples/UndoRedoTest/UndoRedoTest.js +1 -1
  141. package/samples/UnicodeWriteTest/NODEJS/RunTest.sh +2 -0
  142. package/samples/UnicodeWriteTest/NODEJS/UnicodeWriteTest.js +174 -0
  143. package/samples/UnicodeWriteTest/UnicodeWriteTest.js +1 -1
  144. package/samples/WebViewerConvertTest/NODEJS/RunTest.sh +2 -0
  145. package/samples/WebViewerConvertTest/NODEJS/WebViewerConvertTest.js +136 -0
  146. package/samples/WebViewerConvertTest/WebViewerConvertTest.js +135 -135
  147. package/samples/runall.bat +12 -12
@@ -0,0 +1,139 @@
1
+ //---------------------------------------------------------------------------------------
2
+ // Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
3
+ // Consult legal.txt regarding legal and license information.
4
+ //---------------------------------------------------------------------------------------
5
+
6
+ //-----------------------------------------------------------------------------------
7
+ // The sample illustrates how to work with PDF page labels.
8
+ //
9
+ // PDF page labels can be used to describe a page. This is used to
10
+ // allow for non-sequential page numbering or the addition of arbitrary
11
+ // labels for a page (such as the inclusion of Roman numerals at the
12
+ // beginning of a book). PDFNet PageLabel object can be used to specify
13
+ // the numbering style to use (for example, upper- or lower-case Roman,
14
+ // decimal, and so forth), the starting number for the first page,
15
+ // and an arbitrary prefix to be pre-appended to each number (for
16
+ // example, 'A-' to generate 'A-1', 'A-2', 'A-3', and so forth.)
17
+ //-----------------------------------------------------------------------------------
18
+
19
+ const { PDFNet } = require('../../../lib/pdfnet.js');
20
+ const PDFTronLicense = require('../../LicenseKey/NODEJS/LicenseKey');
21
+
22
+ ((exports) => {
23
+ 'use strict';
24
+
25
+ exports.runPageLabelsTest = () => {
26
+ const main = async () => {
27
+ const inputPath = '../../TestFiles/';
28
+ const outputPath = inputPath + 'Output/';
29
+ const outputFile = outputPath + 'newsletter_with_pagelabels.pdf';
30
+
31
+ try {
32
+ //-----------------------------------------------------------
33
+ // Example 1: Add page labels to an existing or newly created PDF
34
+ // document.
35
+ //-----------------------------------------------------------
36
+ {
37
+ const doc = await PDFNet.PDFDoc.createFromFilePath(inputPath + 'newsletter.pdf');
38
+ doc.initSecurityHandler();
39
+
40
+ // Create a page labeling scheme that starts with the first page in
41
+ // the document (page 1) and is using uppercase roman numbering
42
+ // style.
43
+ const L1 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_roman_uppercase, 'My Prefix ', 1);
44
+ doc.setPageLabel(1, L1);
45
+
46
+ // Create a page labeling scheme that starts with the fourth page in
47
+ // the document and is using decimal Arabic numbering style.
48
+ // Also the numeric portion of the first label should start with number
49
+ // 4 (otherwise the first label would be 'My Prefix 1').
50
+ const L2 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'My Prefix ', 4);
51
+ doc.setPageLabel(4, L2);
52
+
53
+ // Create a page labeling scheme that starts with the seventh page in
54
+ // the document and is using alphabetic numbering style. The numeric
55
+ // portion of the first label should start with number 1.
56
+ const L3 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_alphabetic_uppercase, 'My Prefix ', 1);
57
+ doc.setPageLabel(7, L3);
58
+
59
+ doc.save(outputFile, PDFNet.SDFDoc.SaveOptions.e_linearized);
60
+ console.log('Done. Result saved in newsletter_with_pagelabels.pdf...');
61
+ }
62
+
63
+ //-----------------------------------------------------------
64
+ // Example 2: Read page labels from an existing PDF document.
65
+ //-----------------------------------------------------------
66
+ {
67
+ const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
68
+ doc.initSecurityHandler();
69
+
70
+ const page_num = await doc.getPageCount();
71
+ for (let i = 1; i <= page_num; ++i) {
72
+ console.log('Page number: ' + i);
73
+ const label = await doc.getPageLabel(i);
74
+ if (await label.isValid()) {
75
+ console.log(' Label: ' + await label.getLabelTitle(i));
76
+ }
77
+ else {
78
+ console.log(' No Label.');
79
+ }
80
+ }
81
+ }
82
+
83
+ //-----------------------------------------------------------
84
+ // Example 3: Modify page labels from an existing PDF document.
85
+ //-----------------------------------------------------------
86
+ {
87
+ const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
88
+ doc.initSecurityHandler();
89
+
90
+ // Remove the alphabetic labels from example 1.
91
+ doc.removePageLabel(7);
92
+
93
+ // Replace the Prefix in the decimal labels (from example 1).
94
+ const label = await doc.getPageLabel(4);
95
+ if (await label.isValid()) {
96
+ await label.setPrefix('A');
97
+ label.setStart(1);
98
+ }
99
+
100
+ // Add a new label
101
+ const new_label = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'B', 1);
102
+ doc.setPageLabel(10, new_label); // starting from page 10.
103
+
104
+ doc.save(outputPath + 'newsletter_with_pagelabels_modified.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
105
+ console.log('Done. Result saved in newsletter_with_pagelabels_modified.pdf...');
106
+
107
+ const page_num = await doc.getPageCount();
108
+ for (let i = 1; i <= page_num; ++i) {
109
+ console.log('Page number: ' + i);
110
+ const label = await doc.getPageLabel(i);
111
+ if (await label.isValid()) {
112
+ console.log(' Label: ' + await label.getLabelTitle(i));
113
+ }
114
+ else {
115
+ console.log(' No Label.');
116
+ }
117
+ }
118
+ }
119
+
120
+ //-----------------------------------------------------------
121
+ // Example 4: Delete all page labels in an existing PDF document.
122
+ //-----------------------------------------------------------
123
+ {
124
+ const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
125
+ (await doc.getRoot()).eraseFromKey('PageLabels');
126
+ }
127
+
128
+ } catch (err) {
129
+ console.log(err);
130
+ }
131
+ }
132
+ PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error) {
133
+ console.log('Error: ' + JSON.stringify(error));
134
+ }).then(function(){ return PDFNet.shutdown(); });
135
+ };
136
+ exports.runPageLabelsTest();
137
+ })(exports);
138
+ // eslint-disable-next-line spaced-comment
139
+ //# sourceURL=PageLabelsTest.js
@@ -0,0 +1,2 @@
1
+ #!/bin/sh
2
+ node PageLabelsTest.js
@@ -1,139 +1,139 @@
1
- //---------------------------------------------------------------------------------------
2
- // Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
3
- // Consult legal.txt regarding legal and license information.
4
- //---------------------------------------------------------------------------------------
5
-
6
- //-----------------------------------------------------------------------------------
7
- // The sample illustrates how to work with PDF page labels.
8
- //
9
- // PDF page labels can be used to describe a page. This is used to
10
- // allow for non-sequential page numbering or the addition of arbitrary
11
- // labels for a page (such as the inclusion of Roman numerals at the
12
- // beginning of a book). PDFNet PageLabel object can be used to specify
13
- // the numbering style to use (for example, upper- or lower-case Roman,
14
- // decimal, and so forth), the starting number for the first page,
15
- // and an arbitrary prefix to be pre-appended to each number (for
16
- // example, 'A-' to generate 'A-1', 'A-2', 'A-3', and so forth.)
17
- //-----------------------------------------------------------------------------------
18
-
19
- const { PDFNet } = require('@pdftron/pdfnet-node');
20
- const PDFTronLicense = require('../LicenseKey/LicenseKey');
21
-
22
- ((exports) => {
23
- 'use strict';
24
-
25
- exports.runPageLabelsTest = () => {
26
- const main = async () => {
27
- const inputPath = '../TestFiles/';
28
- const outputPath = inputPath + 'Output/';
29
- const outputFile = outputPath + 'newsletter_with_pagelabels.pdf';
30
-
31
- try {
32
- //-----------------------------------------------------------
33
- // Example 1: Add page labels to an existing or newly created PDF
34
- // document.
35
- //-----------------------------------------------------------
36
- {
37
- const doc = await PDFNet.PDFDoc.createFromFilePath(inputPath + 'newsletter.pdf');
38
- doc.initSecurityHandler();
39
-
40
- // Create a page labeling scheme that starts with the first page in
41
- // the document (page 1) and is using uppercase roman numbering
42
- // style.
43
- const L1 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_roman_uppercase, 'My Prefix ', 1);
44
- doc.setPageLabel(1, L1);
45
-
46
- // Create a page labeling scheme that starts with the fourth page in
47
- // the document and is using decimal Arabic numbering style.
48
- // Also the numeric portion of the first label should start with number
49
- // 4 (otherwise the first label would be 'My Prefix 1').
50
- const L2 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'My Prefix ', 4);
51
- doc.setPageLabel(4, L2);
52
-
53
- // Create a page labeling scheme that starts with the seventh page in
54
- // the document and is using alphabetic numbering style. The numeric
55
- // portion of the first label should start with number 1.
56
- const L3 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_alphabetic_uppercase, 'My Prefix ', 1);
57
- doc.setPageLabel(7, L3);
58
-
59
- doc.save(outputFile, PDFNet.SDFDoc.SaveOptions.e_linearized);
60
- console.log('Done. Result saved in newsletter_with_pagelabels.pdf...');
61
- }
62
-
63
- //-----------------------------------------------------------
64
- // Example 2: Read page labels from an existing PDF document.
65
- //-----------------------------------------------------------
66
- {
67
- const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
68
- doc.initSecurityHandler();
69
-
70
- const page_num = await doc.getPageCount();
71
- for (let i = 1; i <= page_num; ++i) {
72
- console.log('Page number: ' + i);
73
- const label = await doc.getPageLabel(i);
74
- if (await label.isValid()) {
75
- console.log(' Label: ' + await label.getLabelTitle(i));
76
- }
77
- else {
78
- console.log(' No Label.');
79
- }
80
- }
81
- }
82
-
83
- //-----------------------------------------------------------
84
- // Example 3: Modify page labels from an existing PDF document.
85
- //-----------------------------------------------------------
86
- {
87
- const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
88
- doc.initSecurityHandler();
89
-
90
- // Remove the alphabetic labels from example 1.
91
- doc.removePageLabel(7);
92
-
93
- // Replace the Prefix in the decimal labels (from example 1).
94
- const label = await doc.getPageLabel(4);
95
- if (await label.isValid()) {
96
- await label.setPrefix('A');
97
- label.setStart(1);
98
- }
99
-
100
- // Add a new label
101
- const new_label = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'B', 1);
102
- doc.setPageLabel(10, new_label); // starting from page 10.
103
-
104
- doc.save(outputPath + 'newsletter_with_pagelabels_modified.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
105
- console.log('Done. Result saved in newsletter_with_pagelabels_modified.pdf...');
106
-
107
- const page_num = await doc.getPageCount();
108
- for (let i = 1; i <= page_num; ++i) {
109
- console.log('Page number: ' + i);
110
- const label = await doc.getPageLabel(i);
111
- if (await label.isValid()) {
112
- console.log(' Label: ' + await label.getLabelTitle(i));
113
- }
114
- else {
115
- console.log(' No Label.');
116
- }
117
- }
118
- }
119
-
120
- //-----------------------------------------------------------
121
- // Example 4: Delete all page labels in an existing PDF document.
122
- //-----------------------------------------------------------
123
- {
124
- const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
125
- (await doc.getRoot()).eraseFromKey('PageLabels');
126
- }
127
-
128
- } catch (err) {
129
- console.log(err);
130
- }
131
- }
132
- PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error) {
133
- console.log('Error: ' + JSON.stringify(error));
134
- }).then(function(){ return PDFNet.shutdown(); });
135
- };
136
- exports.runPageLabelsTest();
137
- })(exports);
138
- // eslint-disable-next-line spaced-comment
1
+ //---------------------------------------------------------------------------------------
2
+ // Copyright (c) 2001-2023 by PDFTron Systems Inc. All Rights Reserved.
3
+ // Consult legal.txt regarding legal and license information.
4
+ //---------------------------------------------------------------------------------------
5
+
6
+ //-----------------------------------------------------------------------------------
7
+ // The sample illustrates how to work with PDF page labels.
8
+ //
9
+ // PDF page labels can be used to describe a page. This is used to
10
+ // allow for non-sequential page numbering or the addition of arbitrary
11
+ // labels for a page (such as the inclusion of Roman numerals at the
12
+ // beginning of a book). PDFNet PageLabel object can be used to specify
13
+ // the numbering style to use (for example, upper- or lower-case Roman,
14
+ // decimal, and so forth), the starting number for the first page,
15
+ // and an arbitrary prefix to be pre-appended to each number (for
16
+ // example, 'A-' to generate 'A-1', 'A-2', 'A-3', and so forth.)
17
+ //-----------------------------------------------------------------------------------
18
+
19
+ const { PDFNet } = require('@pdftron/pdfnet-node');
20
+ const PDFTronLicense = require('../LicenseKey/LicenseKey');
21
+
22
+ ((exports) => {
23
+ 'use strict';
24
+
25
+ exports.runPageLabelsTest = () => {
26
+ const main = async () => {
27
+ const inputPath = '../TestFiles/';
28
+ const outputPath = inputPath + 'Output/';
29
+ const outputFile = outputPath + 'newsletter_with_pagelabels.pdf';
30
+
31
+ try {
32
+ //-----------------------------------------------------------
33
+ // Example 1: Add page labels to an existing or newly created PDF
34
+ // document.
35
+ //-----------------------------------------------------------
36
+ {
37
+ const doc = await PDFNet.PDFDoc.createFromFilePath(inputPath + 'newsletter.pdf');
38
+ doc.initSecurityHandler();
39
+
40
+ // Create a page labeling scheme that starts with the first page in
41
+ // the document (page 1) and is using uppercase roman numbering
42
+ // style.
43
+ const L1 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_roman_uppercase, 'My Prefix ', 1);
44
+ doc.setPageLabel(1, L1);
45
+
46
+ // Create a page labeling scheme that starts with the fourth page in
47
+ // the document and is using decimal Arabic numbering style.
48
+ // Also the numeric portion of the first label should start with number
49
+ // 4 (otherwise the first label would be 'My Prefix 1').
50
+ const L2 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'My Prefix ', 4);
51
+ doc.setPageLabel(4, L2);
52
+
53
+ // Create a page labeling scheme that starts with the seventh page in
54
+ // the document and is using alphabetic numbering style. The numeric
55
+ // portion of the first label should start with number 1.
56
+ const L3 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_alphabetic_uppercase, 'My Prefix ', 1);
57
+ doc.setPageLabel(7, L3);
58
+
59
+ doc.save(outputFile, PDFNet.SDFDoc.SaveOptions.e_linearized);
60
+ console.log('Done. Result saved in newsletter_with_pagelabels.pdf...');
61
+ }
62
+
63
+ //-----------------------------------------------------------
64
+ // Example 2: Read page labels from an existing PDF document.
65
+ //-----------------------------------------------------------
66
+ {
67
+ const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
68
+ doc.initSecurityHandler();
69
+
70
+ const page_num = await doc.getPageCount();
71
+ for (let i = 1; i <= page_num; ++i) {
72
+ console.log('Page number: ' + i);
73
+ const label = await doc.getPageLabel(i);
74
+ if (await label.isValid()) {
75
+ console.log(' Label: ' + await label.getLabelTitle(i));
76
+ }
77
+ else {
78
+ console.log(' No Label.');
79
+ }
80
+ }
81
+ }
82
+
83
+ //-----------------------------------------------------------
84
+ // Example 3: Modify page labels from an existing PDF document.
85
+ //-----------------------------------------------------------
86
+ {
87
+ const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
88
+ doc.initSecurityHandler();
89
+
90
+ // Remove the alphabetic labels from example 1.
91
+ doc.removePageLabel(7);
92
+
93
+ // Replace the Prefix in the decimal labels (from example 1).
94
+ const label = await doc.getPageLabel(4);
95
+ if (await label.isValid()) {
96
+ await label.setPrefix('A');
97
+ label.setStart(1);
98
+ }
99
+
100
+ // Add a new label
101
+ const new_label = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'B', 1);
102
+ doc.setPageLabel(10, new_label); // starting from page 10.
103
+
104
+ doc.save(outputPath + 'newsletter_with_pagelabels_modified.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
105
+ console.log('Done. Result saved in newsletter_with_pagelabels_modified.pdf...');
106
+
107
+ const page_num = await doc.getPageCount();
108
+ for (let i = 1; i <= page_num; ++i) {
109
+ console.log('Page number: ' + i);
110
+ const label = await doc.getPageLabel(i);
111
+ if (await label.isValid()) {
112
+ console.log(' Label: ' + await label.getLabelTitle(i));
113
+ }
114
+ else {
115
+ console.log(' No Label.');
116
+ }
117
+ }
118
+ }
119
+
120
+ //-----------------------------------------------------------
121
+ // Example 4: Delete all page labels in an existing PDF document.
122
+ //-----------------------------------------------------------
123
+ {
124
+ const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
125
+ (await doc.getRoot()).eraseFromKey('PageLabels');
126
+ }
127
+
128
+ } catch (err) {
129
+ console.log(err);
130
+ }
131
+ }
132
+ PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error) {
133
+ console.log('Error: ' + JSON.stringify(error));
134
+ }).then(function(){ return PDFNet.shutdown(); });
135
+ };
136
+ exports.runPageLabelsTest();
137
+ })(exports);
138
+ // eslint-disable-next-line spaced-comment
139
139
  //# sourceURL=PageLabelsTest.js
@@ -0,0 +1,227 @@
1
+ //---------------------------------------------------------------------------------------
2
+ // Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
3
+ // Consult legal.txt regarding legal and license information.
4
+ //---------------------------------------------------------------------------------------
5
+
6
+ const { PDFNet } = require('../../../lib/pdfnet.js');
7
+ const PDFTronLicense = require('../../LicenseKey/NODEJS/LicenseKey');
8
+
9
+ ((exports) => {
10
+ 'use strict';
11
+
12
+ exports.runPatternTest = () => {
13
+ const createTilingPattern = async (doc) => {
14
+ const writer = await PDFNet.ElementWriter.create();
15
+ const eb = await PDFNet.ElementBuilder.create();
16
+
17
+ // Create a new pattern content stream - a heart. ------------
18
+ writer.begin(doc);
19
+ eb.pathBegin();
20
+ eb.moveTo(0, 0);
21
+ eb.curveTo(500, 500, 125, 625, 0, 500);
22
+ eb.curveTo(-125, 625, -500, 500, 0, 0);
23
+ const heart = await eb.pathEnd();
24
+ heart.setPathFill(true);
25
+
26
+ // Set heart color to red.
27
+ const gstate = await heart.getGState();
28
+ gstate.setFillColorSpace(await PDFNet.ColorSpace.createDeviceRGB());
29
+ gstate.setStrokeColorWithColorPt(await PDFNet.ColorPt.init(1, 0, 0));
30
+ writer.writeElement(heart);
31
+
32
+ const patternDict = await writer.end();
33
+
34
+ // Initialize pattern dictionary. For details on what each parameter represents please
35
+ // refer to Table 4.22 (Section '4.6.2 Tiling Patterns') in PDF Reference Manual.
36
+ patternDict.putName('Type', 'Pattern');
37
+ patternDict.putNumber('PatternType', 1);
38
+
39
+ // TilingType - Constant spacing.
40
+ patternDict.putNumber('TilingType', 1);
41
+
42
+ // This is a Type1 pattern - A colored tiling pattern.
43
+ patternDict.putNumber('PaintType', 1);
44
+
45
+ // Set bounding box
46
+ patternDict.putRect('BBox', -253, 0, 253, 545);
47
+
48
+ // Create and set the matrix
49
+ const pattern_mtx = await PDFNet.Matrix2D.create(0.04, 0, 0, 0.04, 0, 0);
50
+ patternDict.putMatrix('Matrix', pattern_mtx);
51
+
52
+ // Set the desired horizontal and vertical spacing between pattern cells,
53
+ // measured in the pattern coordinate system.
54
+ patternDict.putNumber('XStep', 1000);
55
+ await patternDict.putNumber('YStep', 1000);
56
+
57
+ return patternDict; // finished creating the Pattern resource
58
+ }
59
+
60
+ const createImageTilingPattern = async (doc) => {
61
+ const writer = await PDFNet.ElementWriter.create();
62
+ const eb = await PDFNet.ElementBuilder.create();
63
+
64
+ // Create a new pattern content stream - a single bitmap object ----------
65
+ writer.begin(doc);
66
+ const image = await PDFNet.Image.createFromFile(doc, '../../TestFiles/dice.jpg');
67
+ const imgElement = await eb.createImageScaled(image, 0, 0, await image.getImageWidth(), await image.getImageHeight());
68
+ writer.writePlacedElement(imgElement);
69
+
70
+ const patternDict = await writer.end();
71
+
72
+ // Initialize pattern dictionary. For details on what each parameter represents please
73
+ // refer to Table 4.22 (Section '4.6.2 Tiling Patterns') in PDF Reference Manual.
74
+ patternDict.putName('Type', 'Pattern');
75
+ patternDict.putNumber('PatternType', 1);
76
+
77
+ // TilingType - Constant spacing.
78
+ patternDict.putNumber('TilingType', 1);
79
+
80
+ // This is a Type1 pattern - A colored tiling pattern.
81
+ patternDict.putNumber('PaintType', 1);
82
+
83
+ // Set bounding box
84
+ patternDict.putRect('BBox', -253, 0, 253, 545);
85
+
86
+ // Create and set the matrix
87
+ const pattern_mtx = await PDFNet.Matrix2D.create(0.3, 0, 0, 0.3, 0, 0);
88
+ patternDict.putMatrix('Matrix', pattern_mtx);
89
+
90
+ // Set the desired horizontal and vertical spacing between pattern cells,
91
+ // measured in the pattern coordinate system.
92
+ patternDict.putNumber('XStep', 300);
93
+ await patternDict.putNumber('YStep', 300);
94
+
95
+ return patternDict; // finished creating the Pattern resource
96
+ }
97
+
98
+ const createAxialShading = async (doc) => {
99
+ // Create a new Shading object ------------
100
+ const patternDict = await doc.createIndirectDict();
101
+
102
+ // Initialize pattern dictionary. For details on what each parameter represents
103
+ // please refer to Tables 4.30 and 4.26 in PDF Reference Manual
104
+ patternDict.putName('Type', 'Pattern');
105
+ patternDict.putNumber('PatternType', 2); // 2 stands for shading
106
+
107
+ const shadingDict = await patternDict.putDict('Shading');
108
+ shadingDict.putNumber('ShadingType', 2);
109
+ shadingDict.putName('ColorSpace', 'DeviceCMYK');
110
+
111
+ // pass the coordinates of the axial shading to the output
112
+ const shadingCoords = await shadingDict.putArray('Coords');
113
+ shadingCoords.pushBackNumber(0);
114
+ shadingCoords.pushBackNumber(0);
115
+ shadingCoords.pushBackNumber(612);
116
+ shadingCoords.pushBackNumber(794);
117
+
118
+ // pass the function to the axial shading
119
+ const func = await shadingDict.putDict('Function');
120
+ const C0 = await func.putArray('C0');
121
+ C0.pushBackNumber(1);
122
+ C0.pushBackNumber(0);
123
+ C0.pushBackNumber(0);
124
+ await C0.pushBackNumber(0);
125
+
126
+ const C1 = await func.putArray('C1');
127
+ C1.pushBackNumber(0);
128
+ C1.pushBackNumber(1);
129
+ C1.pushBackNumber(0);
130
+ await C1.pushBackNumber(0);
131
+
132
+ const domain = await func.putArray('Domain');
133
+ domain.pushBackNumber(0);
134
+ await domain.pushBackNumber(1);
135
+
136
+ func.putNumber('FunctionType', 2);
137
+ await func.putNumber('N', 1);
138
+
139
+ return patternDict;
140
+ }
141
+
142
+ const main = async () => {
143
+ try {
144
+ const doc = await PDFNet.PDFDoc.create();
145
+ const writer = await PDFNet.ElementWriter.create();
146
+ var eb = await PDFNet.ElementBuilder.create();
147
+
148
+ // The following sample illustrates how to create and use tiling patterns
149
+ var page = await doc.pageCreate();
150
+ writer.beginOnPage(page);
151
+
152
+ var element = await eb.createTextBeginWithFont(await PDFNet.Font.createAndEmbed(doc, PDFNet.Font.StandardType1Font.e_times_bold), 1);
153
+ writer.writeElement(element); // Begin the text block
154
+
155
+ const data = 'G';
156
+ element = await eb.createNewTextRun(data);
157
+ element.setTextMatrixEntries(720, 0, 0, 720, 20, 240);
158
+ var gs = await element.getGState();
159
+ gs.setTextRenderMode(PDFNet.GState.TextRenderingMode.e_fill_stroke_text);
160
+ gs.setLineWidth(4);
161
+
162
+ // Set the fill color space to the Pattern color space.
163
+ gs.setFillColorSpace(await PDFNet.ColorSpace.createPattern());
164
+ var patterColor = await PDFNet.PatternColor.create(await createTilingPattern(doc));
165
+ gs.setFillColorWithPattern(patterColor);
166
+
167
+ writer.writeElement(element);
168
+ writer.writeElement(await eb.createTextEnd()); // Finish the text block
169
+
170
+ writer.end(); // Save the page
171
+ doc.pagePushBack(page);
172
+ //-----------------------------------------------
173
+
174
+ /// The following sample illustrates how to create and use image tiling pattern
175
+ page = await doc.pageCreate();
176
+ writer.beginOnPage(page);
177
+
178
+ eb.reset();
179
+ element = await eb.createRect(0, 0, 612, 794);
180
+
181
+ // Set the fill color space to the Pattern color space.
182
+ gs = await element.getGState();
183
+ gs.setFillColorSpace(await PDFNet.ColorSpace.createPattern());
184
+ patterColor = await PDFNet.PatternColor.create(await createImageTilingPattern(doc));
185
+ gs.setFillColorWithPattern(patterColor);
186
+ element.setPathFill(true);
187
+
188
+ writer.writeElement(element);
189
+
190
+ await writer.end(); // Save the page
191
+ doc.pagePushBack(page);
192
+ //-----------------------------------------------
193
+
194
+ /// The following sample illustrates how to create and use PDF shadings
195
+ page = await doc.pageCreate();
196
+ writer.beginOnPage(page);
197
+
198
+ eb.reset();
199
+ element = await eb.createRect(0, 0, 612, 794);
200
+
201
+ // Set the fill color space to the Pattern color space.
202
+ gs = await element.getGState();
203
+ gs.setFillColorSpace(await PDFNet.ColorSpace.createPattern());
204
+ patterColor = await PDFNet.PatternColor.create(await createAxialShading(doc));
205
+ gs.setFillColorWithPattern(patterColor);
206
+ element.setPathFill(true);
207
+
208
+ writer.writeElement(element);
209
+
210
+ await writer.end(); // Save the page
211
+ doc.pagePushBack(page);
212
+ //-----------------------------------------------
213
+
214
+ await doc.save('../../TestFiles/Output/patterns.pdf', PDFNet.SDFDoc.SaveOptions.e_remove_unused);
215
+ console.log('Done. Result saved in patterns.pdf...');
216
+ } catch (err) {
217
+ console.log(err);
218
+ }
219
+ }
220
+ PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error) {
221
+ console.log('Error: ' + JSON.stringify(error));
222
+ }).then(function(){ return PDFNet.shutdown(); });
223
+ };
224
+ exports.runPatternTest();
225
+ })(exports);
226
+ // eslint-disable-next-line spaced-comment
227
+ //# sourceURL=PatternTest.js
@@ -0,0 +1,2 @@
1
+ #!/bin/sh
2
+ node PatternTest.js