modules/outline.js

  1. /**
  2.  * @license
  3.  * Copyright (c) 2014 Steven Spungin (TwelveTone LLC)  steven@twelvetone.tv
  4.  *
  5.  * Licensed under the MIT License.
  6.  * http://opensource.org/licenses/mit-license
  7.  */
  9. import { jsPDF } from "../jspdf.js";
  11. /**
  12.  * jsPDF Outline PlugIn
  13.  *
  14.  * Generates a PDF Outline
  15.  * @name outline
  16.  * @module
  17.  */
  18. (function(jsPDFAPI) {
  19.   "use strict";
  21.   var namesOid;
  22.   //var destsGoto = [];
  24.   jsPDFAPI.events.push([
  25.     "postPutResources",
  26.     function() {
  27.       var pdf = this;
  28.       var rx = /^(\d+) 0 obj$/;
  30.       // Write action goto objects for each page
  31.       // this.outline.destsGoto = [];
  32.       // for (var i = 0; i < totalPages; i++) {
  33.       // var id = pdf.internal.newObject();
  34.       // this.outline.destsGoto.push(id);
  35.       // pdf.internal.write("<</D[" + (i * 2 + 3) + " 0 R /XYZ null
  36.       // null null]/S/GoTo>> endobj");
  37.       // }
  38.       //
  39.       // for (var i = 0; i < dests.length; i++) {
  40.       // pdf.internal.write("(page_" + (i + 1) + ")" + dests[i] + " 0
  41.       // R");
  42.       // }
  43.       //
  44.       if (this.outline.root.children.length > 0) {
  45.         var lines = pdf.outline.render().split(/\r\n/);
  46.         for (var i = 0; i < lines.length; i++) {
  47.           var line = lines[i];
  48.           var m = rx.exec(line);
  49.           if (m != null) {
  50.             var oid = m[1];
  51.             pdf.internal.newObjectDeferredBegin(oid, false);
  52.           }
  53.           pdf.internal.write(line);
  54.         }
  55.       }
  57.       // This code will write named destination for each page reference
  58.       // (page_1, etc)
  59.       if (this.outline.createNamedDestinations) {
  60.         var totalPages = this.internal.pages.length;
  61.         // WARNING: this assumes jsPDF starts on page 3 and pageIDs
  62.         // follow 5, 7, 9, etc
  63.         // Write destination objects for each page
  64.         var dests = [];
  65.         for (var i = 0; i < totalPages; i++) {
  66.           var id = pdf.internal.newObject();
  67.           dests.push(id);
  68.           var info = pdf.internal.getPageInfo(i + 1);
  69.           pdf.internal.write(
  70.             "<< /D[" + info.objId + " 0 R /XYZ null null null]>> endobj"
  71.           );
  72.         }
  74.         // assign a name for each destination
  75.         var names2Oid = pdf.internal.newObject();
  76.         pdf.internal.write("<< /Names [ ");
  77.         for (var i = 0; i < dests.length; i++) {
  78.           pdf.internal.write("(page_" + (i + 1) + ")" + dests[i] + " 0 R");
  79.         }
  80.         pdf.internal.write(" ] >>", "endobj");
  82.         // var kids = pdf.internal.newObject();
  83.         // pdf.internal.write('<< /Kids [ ' + names2Oid + ' 0 R');
  84.         // pdf.internal.write(' ] >>', 'endobj');
  86.         namesOid = pdf.internal.newObject();
  87.         pdf.internal.write("<< /Dests " + names2Oid + " 0 R");
  88.         pdf.internal.write(">>", "endobj");
  89.       }
  90.     }
  91.   ]);
  93.   jsPDFAPI.events.push([
  94.     "putCatalog",
  95.     function() {
  96.       var pdf = this;
  97.       if (pdf.outline.root.children.length > 0) {
  98.         pdf.internal.write(
  99.           "/Outlines",
  100.           this.outline.makeRef(this.outline.root)
  101.         );
  102.         if (this.outline.createNamedDestinations) {
  103.           pdf.internal.write("/Names " + namesOid + " 0 R");
  104.         }
  105.         // Open with Bookmarks showing
  106.         // pdf.internal.write("/PageMode /UseOutlines");
  107.       }
  108.     }
  109.   ]);
  111.   jsPDFAPI.events.push([
  112.     "initialized",
  113.     function() {
  114.       var pdf = this;
  116.       pdf.outline = {
  117.         createNamedDestinations: false,
  118.         root: {
  119.           children: []
  120.         }
  121.       };
  123.       /**
  124.        * Options: pageNumber
  125.        */
  126.       pdf.outline.add = function(parent, title, options) {
  127.         var item = {
  128.           title: title,
  129.           options: options,
  130.           children: []
  131.         };
  132.         if (parent == null) {
  133.           parent = this.root;
  134.         }
  135.         parent.children.push(item);
  136.         return item;
  137.       };
  139.       pdf.outline.render = function() {
  140.         this.ctx = {};
  141.         this.ctx.val = "";
  142.         this.ctx.pdf = pdf;
  144.         this.genIds_r(this.root);
  145.         this.renderRoot(this.root);
  146.         this.renderItems(this.root);
  148.         return this.ctx.val;
  149.       };
  151.       pdf.outline.genIds_r = function(node) {
  152.         node.id = pdf.internal.newObjectDeferred();
  153.         for (var i = 0; i < node.children.length; i++) {
  154.           this.genIds_r(node.children[i]);
  155.         }
  156.       };
  158.       pdf.outline.renderRoot = function(node) {
  159.         this.objStart(node);
  160.         this.line("/Type /Outlines");
  161.         if (node.children.length > 0) {
  162.           this.line("/First " + this.makeRef(node.children[0]));
  163.           this.line(
  164.             "/Last " + this.makeRef(node.children[node.children.length - 1])
  165.           );
  166.         }
  167.         this.line(
  168.           "/Count " +
  169.             this.count_r(
  170.               {
  171.                 count: 0
  172.               },
  173.               node
  174.             )
  175.         );
  176.         this.objEnd();
  177.       };
  179.       pdf.outline.renderItems = function(node) {
  180.         var getVerticalCoordinateString = this.ctx.pdf.internal
  181.           .getVerticalCoordinateString;
  182.         for (var i = 0; i < node.children.length; i++) {
  183.           var item = node.children[i];
  184.           this.objStart(item);
  186.           this.line("/Title " + this.makeString(item.title));
  188.           this.line("/Parent " + this.makeRef(node));
  189.           if (i > 0) {
  190.             this.line("/Prev " + this.makeRef(node.children[i - 1]));
  191.           }
  192.           if (i < node.children.length - 1) {
  193.             this.line("/Next " + this.makeRef(node.children[i + 1]));
  194.           }
  195.           if (item.children.length > 0) {
  196.             this.line("/First " + this.makeRef(item.children[0]));
  197.             this.line(
  198.               "/Last " + this.makeRef(item.children[item.children.length - 1])
  199.             );
  200.           }
  202.           var count = (this.count = this.count_r(
  203.             {
  204.               count: 0
  205.             },
  206.             item
  207.           ));
  208.           if (count > 0) {
  209.             this.line("/Count " + count);
  210.           }
  212.           if (item.options) {
  213.             if (item.options.pageNumber) {
  214.               // Explicit Destination
  215.               //WARNING this assumes page ids are 3,5,7, etc.
  216.               var info = pdf.internal.getPageInfo(item.options.pageNumber);
  217.               this.line(
  218.                 "/Dest " +
  219.                   "[" +
  220.                   info.objId +
  221.                   " 0 R /XYZ 0 " +
  222.                   getVerticalCoordinateString(0) +
  223.                   " 0]"
  224.               );
  225.               // this line does not work on all clients (pageNumber instead of page ref)
  226.               //this.line('/Dest ' + '[' + (item.options.pageNumber - 1) + ' /XYZ 0 ' + this.ctx.pdf.internal.pageSize.getHeight() + ' 0]');
  228.               // Named Destination
  229.               // this.line('/Dest (page_' + (item.options.pageNumber) + ')');
  231.               // Action Destination
  232.               // var id = pdf.internal.newObject();
  233.               // pdf.internal.write('<</D[' + (item.options.pageNumber - 1) + ' /XYZ null null null]/S/GoTo>> endobj');
  234.               // this.line('/A ' + id + ' 0 R' );
  235.             }
  236.           }
  237.           this.objEnd();
  238.         }
  239.         for (var z = 0; z < node.children.length; z++) {
  240.           this.renderItems(node.children[z]);
  241.         }
  242.       };
  244.       pdf.outline.line = function(text) {
  245.         this.ctx.val += text + "\r\n";
  246.       };
  248.       pdf.outline.makeRef = function(node) {
  249.         return node.id + " 0 R";
  250.       };
  252.       pdf.outline.makeString = function(val) {
  253.         return "(" + pdf.internal.pdfEscape(val) + ")";
  254.       };
  256.       pdf.outline.objStart = function(node) {
  257.         this.ctx.val += "\r\n" + node.id + " 0 obj" + "\r\n<<\r\n";
  258.       };
  260.       pdf.outline.objEnd = function() {
  261.         this.ctx.val += ">> \r\n" + "endobj" + "\r\n";
  262.       };
  264.       pdf.outline.count_r = function(ctx, node) {
  265.         for (var i = 0; i < node.children.length; i++) {
  266.           ctx.count++;
  267.           this.count_r(ctx, node.children[i]);
  268.         }
  269.         return ctx.count;
  270.       };
  271.     }
  272.   ]);
  274.   return this;
  275. })(jsPDF.API);