modules/annotations.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. /**
  10.  * jsPDF Annotations PlugIn
  11.  *
  12.  * There are many types of annotations in a PDF document. Annotations are placed
  13.  * on a page at a particular location. They are not 'attached' to an object.
  14.  * <br />
  15.  * This plugin current supports <br />
  16.  * <li> Goto Page (set pageNumber and top in options)
  17.  * <li> Goto Name (set name and top in options)
  18.  * <li> Goto URL (set url in options)
  19.  * <p>
  20.  * 	The destination magnification factor can also be specified when goto is a page number or a named destination. (see documentation below)
  21.  *  (set magFactor in options).  XYZ is the default.
  22.  * </p>
  23.  * <p>
  24.  *  Links, Text, Popup, and FreeText are supported.
  25.  * </p>
  26.  * <p>
  27.  * Options In PDF spec Not Implemented Yet
  28.  * <li> link border
  29.  * <li> named target
  30.  * <li> page coordinates
  31.  * <li> destination page scaling and layout
  32.  * <li> actions other than URL and GotoPage
  33.  * <li> background / hover actions
  34.  * </p>
  35.  * @name annotations
  36.  * @module
  37.  */
  39. /*
  40.     Destination Magnification Factors
  41.     See PDF 1.3 Page 386 for meanings and options
  43.     [supported]
  44. 	XYZ (options; left top zoom)
  45. 	Fit (no options)
  46. 	FitH (options: top)
  47. 	FitV (options: left)
  49. 	[not supported]
  50. 	FitR
  51. 	FitB
  52. 	FitBH
  53. 	FitBV
  54.  */
  56. import { jsPDF } from "../jspdf.js";
  58. (function(jsPDFAPI) {
  59.   "use strict";
  61.   var notEmpty = function(obj) {
  62.     if (typeof obj != "undefined") {
  63.       if (obj != "") {
  64.         return true;
  65.       }
  66.     }
  67.   };
  69.   jsPDF.API.events.push([
  70.     "addPage",
  71.     function(addPageData) {
  72.       var pageInfo = this.internal.getPageInfo(addPageData.pageNumber);
  73.       pageInfo.pageContext.annotations = [];
  74.     }
  75.   ]);
  77.   jsPDFAPI.events.push([
  78.     "putPage",
  79.     function(putPageData) {
  80.       var getHorizontalCoordinateString = this.internal.getCoordinateString;
  81.       var getVerticalCoordinateString = this.internal
  82.         .getVerticalCoordinateString;
  83.       var pageInfo = this.internal.getPageInfoByObjId(putPageData.objId);
  84.       var pageAnnos = putPageData.pageContext.annotations;
  86.       var anno, rect, line;
  87.       var found = false;
  88.       for (var a = 0; a < pageAnnos.length && !found; a++) {
  89.         anno = pageAnnos[a];
  90.         switch (anno.type) {
  91.           case "link":
  92.             if (
  93.               notEmpty(anno.options.url) ||
  94.               notEmpty(anno.options.pageNumber)
  95.             ) {
  96.               found = true;
  97.             }
  98.             break;
  99.           case "reference":
  100.           case "text":
  101.           case "freetext":
  102.             found = true;
  103.             break;
  104.         }
  105.       }
  106.       if (found == false) {
  107.         return;
  108.       }
  110.       this.internal.write("/Annots [");
  111.       for (var i = 0; i < pageAnnos.length; i++) {
  112.         anno = pageAnnos[i];
  113.         var escape = this.internal.pdfEscape;
  114.         var encryptor = this.internal.getEncryptor(putPageData.objId);
  116.         switch (anno.type) {
  117.           case "reference":
  118.             // References to Widget Annotations (for AcroForm Fields)
  119.             this.internal.write(" " + anno.object.objId + " 0 R ");
  120.             break;
  121.           case "text":
  122.             // Create a an object for both the text and the popup
  123.             var objText = this.internal.newAdditionalObject();
  124.             var objPopup = this.internal.newAdditionalObject();
  125.             var encryptorText = this.internal.getEncryptor(objText.objId);
  127.             var title = anno.title || "Note";
  128.             rect =
  129.               "/Rect [" +
  130.               getHorizontalCoordinateString(anno.bounds.x) +
  131.               " " +
  132.               getVerticalCoordinateString(anno.bounds.y + anno.bounds.h) +
  133.               " " +
  134.               getHorizontalCoordinateString(anno.bounds.x + anno.bounds.w) +
  135.               " " +
  136.               getVerticalCoordinateString(anno.bounds.y) +
  137.               "] ";
  139.             line =
  140.               "<</Type /Annot /Subtype /" +
  141.               "Text" +
  142.               " " +
  143.               rect +
  144.               "/Contents (" +
  145.               escape(encryptorText(anno.contents)) +
  146.               ")";
  147.             line += " /Popup " + objPopup.objId + " 0 R";
  148.             line += " /P " + pageInfo.objId + " 0 R";
  149.             line += " /T (" + escape(encryptorText(title)) + ") >>";
  150.             objText.content = line;
  152.             var parent = objText.objId + " 0 R";
  153.             var popoff = 30;
  154.             rect =
  155.               "/Rect [" +
  156.               getHorizontalCoordinateString(anno.bounds.x + popoff) +
  157.               " " +
  158.               getVerticalCoordinateString(anno.bounds.y + anno.bounds.h) +
  159.               " " +
  160.               getHorizontalCoordinateString(
  161.                 anno.bounds.x + anno.bounds.w + popoff
  162.               ) +
  163.               " " +
  164.               getVerticalCoordinateString(anno.bounds.y) +
  165.               "] ";
  166.             line =
  167.               "<</Type /Annot /Subtype /" +
  168.               "Popup" +
  169.               " " +
  170.               rect +
  171.               " /Parent " +
  172.               parent;
  173.             if (anno.open) {
  174.               line += " /Open true";
  175.             }
  176.             line += " >>";
  177.             objPopup.content = line;
  179.             this.internal.write(objText.objId, "0 R", objPopup.objId, "0 R");
  181.             break;
  182.           case "freetext":
  183.             rect =
  184.               "/Rect [" +
  185.               getHorizontalCoordinateString(anno.bounds.x) +
  186.               " " +
  187.               getVerticalCoordinateString(anno.bounds.y) +
  188.               " " +
  189.               getHorizontalCoordinateString(anno.bounds.x + anno.bounds.w) +
  190.               " " +
  191.               getVerticalCoordinateString(anno.bounds.y + anno.bounds.h) +
  192.               "] ";
  193.             var color = anno.color || "#000000";
  194.             line =
  195.               "<</Type /Annot /Subtype /" +
  196.               "FreeText" +
  197.               " " +
  198.               rect +
  199.               "/Contents (" +
  200.               escape(encryptor(anno.contents)) +
  201.               ")";
  202.             line +=
  203.               " /DS(font: Helvetica,sans-serif 12.0pt; text-align:left; color:#" +
  204.               color +
  205.               ")";
  206.             line += " /Border [0 0 0]";
  207.             line += " >>";
  208.             this.internal.write(line);
  209.             break;
  210.           case "link":
  211.             if (anno.options.name) {
  212.               var loc = this.annotations._nameMap[anno.options.name];
  213.               anno.options.pageNumber = loc.page;
  214.               anno.options.top = loc.y;
  215.             } else {
  216.               if (!anno.options.top) {
  217.                 anno.options.top = 0;
  218.               }
  219.             }
  221.             rect =
  222.               "/Rect [" +
  223.               anno.finalBounds.x +
  224.               " " +
  225.               anno.finalBounds.y +
  226.               " " +
  227.               anno.finalBounds.w +
  228.               " " +
  229.               anno.finalBounds.h +
  230.               "] ";
  232.             line = "";
  233.             if (anno.options.url) {
  234.               line =
  235.                 "<</Type /Annot /Subtype /Link " +
  236.                 rect +
  237.                 "/Border [0 0 0] /A <</S /URI /URI (" +
  238.                 escape(encryptor(anno.options.url)) +
  239.                 ") >>";
  240.             } else if (anno.options.pageNumber) {
  241.               // first page is 0
  242.               var info = this.internal.getPageInfo(anno.options.pageNumber);
  243.               line =
  244.                 "<</Type /Annot /Subtype /Link " +
  245.                 rect +
  246.                 "/Border [0 0 0] /Dest [" +
  247.                 info.objId +
  248.                 " 0 R";
  249.               anno.options.magFactor = anno.options.magFactor || "XYZ";
  250.               switch (anno.options.magFactor) {
  251.                 case "Fit":
  252.                   line += " /Fit]";
  253.                   break;
  254.                 case "FitH":
  255.                   line += " /FitH " + anno.options.top + "]";
  256.                   break;
  257.                 case "FitV":
  258.                   anno.options.left = anno.options.left || 0;
  259.                   line += " /FitV " + anno.options.left + "]";
  260.                   break;
  261.                 case "XYZ":
  262.                 default:
  263.                   var top = getVerticalCoordinateString(anno.options.top);
  264.                   anno.options.left = anno.options.left || 0;
  265.                   // 0 or null zoom will not change zoom factor
  266.                   if (typeof anno.options.zoom === "undefined") {
  267.                     anno.options.zoom = 0;
  268.                   }
  269.                   line +=
  270.                     " /XYZ " +
  271.                     anno.options.left +
  272.                     " " +
  273.                     top +
  274.                     " " +
  275.                     anno.options.zoom +
  276.                     "]";
  277.                   break;
  278.               }
  279.             }
  281.             if (line != "") {
  282.               line += " >>";
  283.               this.internal.write(line);
  284.             }
  285.             break;
  286.         }
  287.       }
  288.       this.internal.write("]");
  289.     }
  290.   ]);
  292.   /**
  293.    * @name createAnnotation
  294.    * @function
  295.    * @param {Object} options
  296.    */
  297.   jsPDFAPI.createAnnotation = function(options) {
  298.     var pageInfo = this.internal.getCurrentPageInfo();
  299.     switch (options.type) {
  300.       case "link":
  301.         this.link(
  302.           options.bounds.x,
  303.           options.bounds.y,
  304.           options.bounds.w,
  305.           options.bounds.h,
  306.           options
  307.         );
  308.         break;
  309.       case "text":
  310.       case "freetext":
  311.         pageInfo.pageContext.annotations.push(options);
  312.         break;
  313.     }
  314.   };
  316.   /**
  317.    * Create a link
  318.    *
  319.    * valid options
  320.    * <li> pageNumber or url [required]
  321.    * <p>If pageNumber is specified, top and zoom may also be specified</p>
  322.    * @name link
  323.    * @function
  324.    * @param {number} x
  325.    * @param {number} y
  326.    * @param {number} w
  327.    * @param {number} h
  328.    * @param {Object} options
  329.    */
  330.   jsPDFAPI.link = function(x, y, w, h, options) {
  331.     var pageInfo = this.internal.getCurrentPageInfo();
  332.     var getHorizontalCoordinateString = this.internal.getCoordinateString;
  333.     var getVerticalCoordinateString = this.internal.getVerticalCoordinateString;
  335.     pageInfo.pageContext.annotations.push({
  336.       finalBounds: {
  337.         x: getHorizontalCoordinateString(x),
  338.         y: getVerticalCoordinateString(y),
  339.         w: getHorizontalCoordinateString(x + w),
  340.         h: getVerticalCoordinateString(y + h)
  341.       },
  342.       options: options,
  343.       type: "link"
  344.     });
  345.   };
  347.   /**
  348.    * Currently only supports single line text.
  349.    * Returns the width of the text/link
  350.    *
  351.    * @name textWithLink
  352.    * @function
  353.    * @param {string} text
  354.    * @param {number} x
  355.    * @param {number} y
  356.    * @param {Object} options
  357.    * @returns {number} width the width of the text/link
  358.    */
  359.   jsPDFAPI.textWithLink = function(text, x, y, options) {
  360.     var totalLineWidth = this.getTextWidth(text);
  361.     var lineHeight = this.internal.getLineHeight() / this.internal.scaleFactor;
  362.     var linkHeight, linkWidth;
  364.     // Checking if maxWidth option is passed to determine lineWidth and number of lines for each line
  365.     if (options.maxWidth !== undefined) {
  366.       var { maxWidth } = options;
  367.       linkWidth = maxWidth;
  368.       var numOfLines = this.splitTextToSize(text, linkWidth).length;
  369.       linkHeight = Math.ceil(lineHeight * numOfLines);
  370.     } else {
  371.       linkWidth = totalLineWidth;
  372.       linkHeight = lineHeight;
  373.     }
  375.     this.text(text, x, y, options);
  377.     //TODO We really need the text baseline height to do this correctly.
  378.     // Or ability to draw text on top, bottom, center, or baseline.
  379.     y += lineHeight * 0.2;
  380.     //handle x position based on the align option
  381.     if (options.align === "center") {
  382.       x = x - totalLineWidth / 2; //since starting from center move the x position by half of text width
  383.     }
  384.     if (options.align === "right") {
  385.       x = x - totalLineWidth;
  386.     }
  387.     this.link(x, y - lineHeight, linkWidth, linkHeight, options);
  388.     return totalLineWidth;
  389.   };
  391.   //TODO move into external library
  392.   /**
  393.    * @name getTextWidth
  394.    * @function
  395.    * @param {string} text
  396.    * @returns {number} txtWidth
  397.    */
  398.   jsPDFAPI.getTextWidth = function(text) {
  399.     var fontSize = this.internal.getFontSize();
  400.     var txtWidth =
  401.       (this.getStringUnitWidth(text) * fontSize) / this.internal.scaleFactor;
  402.     return txtWidth;
  403.   };
  405.   return this;
  406. })(jsPDF.API);