modules/viewerpreferences.js

  1. /**
  2.  * @license
  3.  * jsPDF viewerPreferences Plugin
  4.  * @author Aras Abbasi (github.com/arasabbasi)
  5.  * Licensed under the MIT License.
  6.  * http://opensource.org/licenses/mit-license
  7.  */
  9. import { jsPDF } from "../jspdf.js";
  11. /**
  12.  * Adds the ability to set ViewerPreferences and by thus
  13.  * controlling the way the document is to be presented on the
  14.  * screen or in print.
  15.  * @name viewerpreferences
  16.  * @module
  17.  */
  18. (function(jsPDFAPI) {
  19.   "use strict";
  20.   /**
  21.    * Set the ViewerPreferences of the generated PDF
  22.    *
  23.    * @name viewerPreferences
  24.    * @function
  25.    * @public
  26.    * @param {Object} options Array with the ViewerPreferences<br />
  27.    * Example: doc.viewerPreferences({"FitWindow":true});<br />
  28.    * <br />
  29.    * You can set following preferences:<br />
  30.    * <br/>
  31.    * <b>HideToolbar</b> <i>(boolean)</i><br />
  32.    * Default value: false<br />
  33.    * <br />
  34.    * <b>HideMenubar</b> <i>(boolean)</i><br />
  35.    * Default value: false.<br />
  36.    * <br />
  37.    * <b>HideWindowUI</b> <i>(boolean)</i><br />
  38.    * Default value: false.<br />
  39.    * <br />
  40.    * <b>FitWindow</b> <i>(boolean)</i><br />
  41.    * Default value: false.<br />
  42.    * <br />
  43.    * <b>CenterWindow</b> <i>(boolean)</i><br />
  44.    * Default value: false<br />
  45.    * <br />
  46.    * <b>DisplayDocTitle</b> <i>(boolean)</i><br />
  47.    * Default value: false.<br />
  48.    * <br />
  49.    * <b>NonFullScreenPageMode</b> <i>(string)</i><br />
  50.    * Possible values: UseNone, UseOutlines, UseThumbs, UseOC<br />
  51.    * Default value: UseNone<br/>
  52.    * <br />
  53.    * <b>Direction</b> <i>(string)</i><br />
  54.    * Possible values: L2R, R2L<br />
  55.    * Default value: L2R.<br />
  56.    * <br />
  57.    * <b>ViewArea</b> <i>(string)</i><br />
  58.    * Possible values: MediaBox, CropBox, TrimBox, BleedBox, ArtBox<br />
  59.    * Default value: CropBox.<br />
  60.    * <br />
  61.    * <b>ViewClip</b> <i>(string)</i><br />
  62.    * Possible values: MediaBox, CropBox, TrimBox, BleedBox, ArtBox<br />
  63.    * Default value: CropBox<br />
  64.    * <br />
  65.    * <b>PrintArea</b> <i>(string)</i><br />
  66.    * Possible values: MediaBox, CropBox, TrimBox, BleedBox, ArtBox<br />
  67.    * Default value: CropBox<br />
  68.    * <br />
  69.    * <b>PrintClip</b> <i>(string)</i><br />
  70.    * Possible values: MediaBox, CropBox, TrimBox, BleedBox, ArtBox<br />
  71.    * Default value: CropBox.<br />
  72.    * <br />
  73.    * <b>PrintScaling</b> <i>(string)</i><br />
  74.    * Possible values: AppDefault, None<br />
  75.    * Default value: AppDefault.<br />
  76.    * <br />
  77.    * <b>Duplex</b> <i>(string)</i><br />
  78.    * Possible values: Simplex, DuplexFlipLongEdge, DuplexFlipShortEdge
  79.    * Default value: none<br />
  80.    * <br />
  81.    * <b>PickTrayByPDFSize</b> <i>(boolean)</i><br />
  82.    * Default value: false<br />
  83.    * <br />
  84.    * <b>PrintPageRange</b> <i>(Array)</i><br />
  85.    * Example: [[1,5], [7,9]]<br />
  86.    * Default value: as defined by PDF viewer application<br />
  87.    * <br />
  88.    * <b>NumCopies</b> <i>(Number)</i><br />
  89.    * Possible values: 1, 2, 3, 4, 5<br />
  90.    * Default value: 1<br />
  91.    * <br />
  92.    * For more information see the PDF Reference, sixth edition on Page 577
  93.    * @param {boolean} doReset True to reset the settings
  94.    * @function
  95.    * @returns jsPDF jsPDF-instance
  96.    * @example
  97.    * var doc = new jsPDF()
  98.    * doc.text('This is a test', 10, 10)
  99.    * doc.viewerPreferences({'FitWindow': true}, true)
  100.    * doc.save("viewerPreferences.pdf")
  101.    *
  102.    * // Example printing 10 copies, using cropbox, and hiding UI.
  103.    * doc.viewerPreferences({
  104.    *   'HideWindowUI': true,
  105.    *   'PrintArea': 'CropBox',
  106.    *   'NumCopies': 10
  107.    * })
  108.    */
  109.   jsPDFAPI.viewerPreferences = function(options, doReset) {
  110.     options = options || {};
  111.     doReset = doReset || false;
  113.     var configuration;
  114.     var configurationTemplate = {
  115.       HideToolbar: {
  116.         defaultValue: false,
  117.         value: false,
  118.         type: "boolean",
  119.         explicitSet: false,
  120.         valueSet: [true, false],
  121.         pdfVersion: 1.3
  122.       },
  123.       HideMenubar: {
  124.         defaultValue: false,
  125.         value: false,
  126.         type: "boolean",
  127.         explicitSet: false,
  128.         valueSet: [true, false],
  129.         pdfVersion: 1.3
  130.       },
  131.       HideWindowUI: {
  132.         defaultValue: false,
  133.         value: false,
  134.         type: "boolean",
  135.         explicitSet: false,
  136.         valueSet: [true, false],
  137.         pdfVersion: 1.3
  138.       },
  139.       FitWindow: {
  140.         defaultValue: false,
  141.         value: false,
  142.         type: "boolean",
  143.         explicitSet: false,
  144.         valueSet: [true, false],
  145.         pdfVersion: 1.3
  146.       },
  147.       CenterWindow: {
  148.         defaultValue: false,
  149.         value: false,
  150.         type: "boolean",
  151.         explicitSet: false,
  152.         valueSet: [true, false],
  153.         pdfVersion: 1.3
  154.       },
  155.       DisplayDocTitle: {
  156.         defaultValue: false,
  157.         value: false,
  158.         type: "boolean",
  159.         explicitSet: false,
  160.         valueSet: [true, false],
  161.         pdfVersion: 1.4
  162.       },
  163.       NonFullScreenPageMode: {
  164.         defaultValue: "UseNone",
  165.         value: "UseNone",
  166.         type: "name",
  167.         explicitSet: false,
  168.         valueSet: ["UseNone", "UseOutlines", "UseThumbs", "UseOC"],
  169.         pdfVersion: 1.3
  170.       },
  171.       Direction: {
  172.         defaultValue: "L2R",
  173.         value: "L2R",
  174.         type: "name",
  175.         explicitSet: false,
  176.         valueSet: ["L2R", "R2L"],
  177.         pdfVersion: 1.3
  178.       },
  179.       ViewArea: {
  180.         defaultValue: "CropBox",
  181.         value: "CropBox",
  182.         type: "name",
  183.         explicitSet: false,
  184.         valueSet: ["MediaBox", "CropBox", "TrimBox", "BleedBox", "ArtBox"],
  185.         pdfVersion: 1.4
  186.       },
  187.       ViewClip: {
  188.         defaultValue: "CropBox",
  189.         value: "CropBox",
  190.         type: "name",
  191.         explicitSet: false,
  192.         valueSet: ["MediaBox", "CropBox", "TrimBox", "BleedBox", "ArtBox"],
  193.         pdfVersion: 1.4
  194.       },
  195.       PrintArea: {
  196.         defaultValue: "CropBox",
  197.         value: "CropBox",
  198.         type: "name",
  199.         explicitSet: false,
  200.         valueSet: ["MediaBox", "CropBox", "TrimBox", "BleedBox", "ArtBox"],
  201.         pdfVersion: 1.4
  202.       },
  203.       PrintClip: {
  204.         defaultValue: "CropBox",
  205.         value: "CropBox",
  206.         type: "name",
  207.         explicitSet: false,
  208.         valueSet: ["MediaBox", "CropBox", "TrimBox", "BleedBox", "ArtBox"],
  209.         pdfVersion: 1.4
  210.       },
  211.       PrintScaling: {
  212.         defaultValue: "AppDefault",
  213.         value: "AppDefault",
  214.         type: "name",
  215.         explicitSet: false,
  216.         valueSet: ["AppDefault", "None"],
  217.         pdfVersion: 1.6
  218.       },
  219.       Duplex: {
  220.         defaultValue: "",
  221.         value: "none",
  222.         type: "name",
  223.         explicitSet: false,
  224.         valueSet: [
  225.           "Simplex",
  226.           "DuplexFlipShortEdge",
  227.           "DuplexFlipLongEdge",
  228.           "none"
  229.         ],
  230.         pdfVersion: 1.7
  231.       },
  232.       PickTrayByPDFSize: {
  233.         defaultValue: false,
  234.         value: false,
  235.         type: "boolean",
  236.         explicitSet: false,
  237.         valueSet: [true, false],
  238.         pdfVersion: 1.7
  239.       },
  240.       PrintPageRange: {
  241.         defaultValue: "",
  242.         value: "",
  243.         type: "array",
  244.         explicitSet: false,
  245.         valueSet: null,
  246.         pdfVersion: 1.7
  247.       },
  248.       NumCopies: {
  249.         defaultValue: 1,
  250.         value: 1,
  251.         type: "integer",
  252.         explicitSet: false,
  253.         valueSet: null,
  254.         pdfVersion: 1.7
  255.       }
  256.     };
  258.     var configurationKeys = Object.keys(configurationTemplate);
  260.     var rangeArray = [];
  261.     var i = 0;
  262.     var j = 0;
  263.     var k = 0;
  264.     var isValid;
  266.     var method;
  267.     var value;
  269.     function arrayContainsElement(array, element) {
  270.       var iterator;
  271.       var result = false;
  273.       for (iterator = 0; iterator < array.length; iterator += 1) {
  274.         if (array[iterator] === element) {
  275.           result = true;
  276.         }
  277.       }
  278.       return result;
  279.     }
  281.     if (this.internal.viewerpreferences === undefined) {
  282.       this.internal.viewerpreferences = {};
  283.       this.internal.viewerpreferences.configuration = JSON.parse(
  284.         JSON.stringify(configurationTemplate)
  285.       );
  286.       this.internal.viewerpreferences.isSubscribed = false;
  287.     }
  288.     configuration = this.internal.viewerpreferences.configuration;
  290.     if (options === "reset" || doReset === true) {
  291.       var len = configurationKeys.length;
  293.       for (k = 0; k < len; k += 1) {
  294.         configuration[configurationKeys[k]].value =
  295.           configuration[configurationKeys[k]].defaultValue;
  296.         configuration[configurationKeys[k]].explicitSet = false;
  297.       }
  298.     }
  300.     if (typeof options === "object") {
  301.       for (method in options) {
  302.         value = options[method];
  303.         if (
  304.           arrayContainsElement(configurationKeys, method) &&
  305.           value !== undefined
  306.         ) {
  307.           if (
  308.             configuration[method].type === "boolean" &&
  309.             typeof value === "boolean"
  310.           ) {
  311.             configuration[method].value = value;
  312.           } else if (
  313.             configuration[method].type === "name" &&
  314.             arrayContainsElement(configuration[method].valueSet, value)
  315.           ) {
  316.             configuration[method].value = value;
  317.           } else if (
  318.             configuration[method].type === "integer" &&
  319.             Number.isInteger(value)
  320.           ) {
  321.             configuration[method].value = value;
  322.           } else if (configuration[method].type === "array") {
  323.             for (i = 0; i < value.length; i += 1) {
  324.               isValid = true;
  325.               if (value[i].length === 1 && typeof value[i][0] === "number") {
  326.                 rangeArray.push(String(value[i] - 1));
  327.               } else if (value[i].length > 1) {
  328.                 for (j = 0; j < value[i].length; j += 1) {
  329.                   if (typeof value[i][j] !== "number") {
  330.                     isValid = false;
  331.                   }
  332.                 }
  333.                 if (isValid === true) {
  334.                   rangeArray.push([value[i][0] - 1, value[i][1] - 1].join(" "));
  335.                 }
  336.               }
  337.             }
  338.             configuration[method].value = "[" + rangeArray.join(" ") + "]";
  339.           } else {
  340.             configuration[method].value = configuration[method].defaultValue;
  341.           }
  343.           configuration[method].explicitSet = true;
  344.         }
  345.       }
  346.     }
  348.     if (this.internal.viewerpreferences.isSubscribed === false) {
  349.       this.internal.events.subscribe("putCatalog", function() {
  350.         var pdfDict = [];
  351.         var vPref;
  352.         for (vPref in configuration) {
  353.           if (configuration[vPref].explicitSet === true) {
  354.             if (configuration[vPref].type === "name") {
  355.               pdfDict.push("/" + vPref + " /" + configuration[vPref].value);
  356.             } else {
  357.               pdfDict.push("/" + vPref + " " + configuration[vPref].value);
  358.             }
  359.           }
  360.         }
  361.         if (pdfDict.length !== 0) {
  362.           this.internal.write(
  363.             "/ViewerPreferences\n<<\n" + pdfDict.join("\n") + "\n>>"
  364.           );
  365.         }
  366.       });
  367.       this.internal.viewerpreferences.isSubscribed = true;
  368.     }
  370.     this.internal.viewerpreferences.configuration = configuration;
  371.     return this;
  372.   };
  373. })(jsPDF.API);