modules/annotations.js

  1. /* global jsPDF */
  2. /**
  3.  * @license
  4.  * Copyright (c) 2014 Steven Spungin (TwelveTone LLC)  steven@twelvetone.tv
  5.  *
  6.  * Licensed under the MIT License.
  7.  * http://opensource.org/licenses/mit-license
  8.  */
  10. /**
  11.  * jsPDF Annotations PlugIn
  12.  *
  13.  * There are many types of annotations in a PDF document. Annotations are placed
  14.  * on a page at a particular location. They are not 'attached' to an object.
  15.  * <br />
  16.  * This plugin current supports <br />
  17.  * <li> Goto Page (set pageNumber and top in options)
  18.  * <li> Goto Name (set name and top in options)
  19.  * <li> Goto URL (set url in options)
  20.  * <p>
  21.  * 	The destination magnification factor can also be specified when goto is a page number or a named destination. (see documentation below)
  22.  *  (set magFactor in options).  XYZ is the default.
  23.  * </p>
  24.  * <p>
  25.  *  Links, Text, Popup, and FreeText are supported.
  26.  * </p>
  27.  * <p>
  28.  * Options In PDF spec Not Implemented Yet
  29.  * <li> link border
  30.  * <li> named target
  31.  * <li> page coordinates
  32.  * <li> destination page scaling and layout
  33.  * <li> actions other than URL and GotoPage
  34.  * <li> background / hover actions
  35.  * </p>
  36.  * @name annotations
  37.  * @module
  38.  */
  40. /*
  41.     Destination Magnification Factors
  42.     See PDF 1.3 Page 386 for meanings and options
  44.     [supported]
  45. 	XYZ (options; left top zoom)
  46. 	Fit (no options)
  47. 	FitH (options: top)
  48. 	FitV (options: left)
  50. 	[not supported]
  51. 	FitR
  52. 	FitB
  53. 	FitBH
  54. 	FitBV
  55.  */
  56. (function (jsPDFAPI) {
  57. 	'use strict';
  59. 	var notEmpty = function (obj) {
  60. 		if (typeof obj != 'undefined') {
  61. 			if (obj != '') {
  62. 				return true;
  63. 			}
  64. 		}
  65. 	};
  67. 	jsPDF.API.events.push(['addPage', function (addPageData) {
  68. 		var pageInfo = this.internal.getPageInfo(addPageData.pageNumber);
  69. 		pageInfo.pageContext.annotations = [];
  70. 	}]);
  72. 	jsPDFAPI.events.push(['putPage', function (putPageData) {
  73. 		var getHorizontalCoordinateString = this.internal.getCoordinateString;
  74. 		var getVerticalCoordinateString = this.internal.getVerticalCoordinateString;
  75. 		var pageInfo = this.internal.getPageInfoByObjId(putPageData.objId);
  76. 		var pageAnnos = putPageData.pageContext.annotations;
  78. 		var found = false;
  79. 		for (var a = 0; a < pageAnnos.length && !found; a++) {
  80. 			var anno = pageAnnos[a];
  81. 			switch (anno.type) {
  82. 				case 'link':
  83. 					if (notEmpty(anno.options.url) || notEmpty(anno.options.pageNumber)) {
  84. 						found = true;
  85. 					}
  86. 					break;
  87. 				case 'reference':
  88. 				case 'text':
  89. 				case 'freetext':
  90. 					found = true;
  91. 					break;
  92. 			}
  93. 		}
  94. 		if (found == false) {
  95. 			return;
  96. 		}
  98. 		this.internal.write("/Annots [");
  99. 		for (var i = 0; i < pageAnnos.length; i++) {
  100. 			var anno = pageAnnos[i];
  102. 			switch (anno.type) {
  103. 				case 'reference':
  104. 					// References to Widget Annotations (for AcroForm Fields)
  105. 					this.internal.write(' ' + anno.object.objId + ' 0 R ');
  106. 					break;
  107. 				case 'text':
  108. 					// Create a an object for both the text and the popup
  109. 					var objText = this.internal.newAdditionalObject();
  110. 					var objPopup = this.internal.newAdditionalObject();
  112. 					var title = anno.title || 'Note';
  113. 					var rect = "/Rect [" + getHorizontalCoordinateString(anno.bounds.x) + " " + getVerticalCoordinateString(anno.bounds.y + anno.bounds.h) + " " + getHorizontalCoordinateString(anno.bounds.x + anno.bounds.w) + " " + getVerticalCoordinateString(anno.bounds.y) + "] ";
  114. 					line = '<</Type /Annot /Subtype /' + 'Text' + ' ' + rect + '/Contents (' + anno.contents + ')';
  115. 					line += ' /Popup ' + objPopup.objId + " 0 R";
  116. 					line += ' /P ' + pageInfo.objId + " 0 R";
  117. 					line += ' /T (' + title + ') >>';
  118. 					objText.content = line;
  120. 					var parent = objText.objId + ' 0 R';
  121. 					var popoff = 30;
  122. 					var rect = "/Rect [" + getHorizontalCoordinateString(anno.bounds.x + popoff) + " " + getVerticalCoordinateString(anno.bounds.y + anno.bounds.h) + " " + getHorizontalCoordinateString(anno.bounds.x + anno.bounds.w + popoff) + " " + getVerticalCoordinateString(anno.bounds.y) + "] ";
  123. 					line = '<</Type /Annot /Subtype /' + 'Popup' + ' ' + rect + ' /Parent ' + parent;
  124. 					if (anno.open) {
  125. 						line += ' /Open true';
  126. 					}
  127. 					line += ' >>';
  128. 					objPopup.content = line;
  130. 					this.internal.write(objText.objId, '0 R', objPopup.objId, '0 R');
  132. 					break;
  133. 				case 'freetext':
  134. 					var rect = "/Rect [" + getHorizontalCoordinateString(anno.bounds.x) + " " + getVerticalCoordinateString(anno.bounds.y) + " " + getHorizontalCoordinateString(anno.bounds.x + anno.bounds.w) + " " + getVerticalCoordinateString(anno.bounds.y + anno.bounds.h) + "] ";
  135. 					var color = anno.color || '#000000';
  136. 					line = '<</Type /Annot /Subtype /' + 'FreeText' + ' ' + rect + '/Contents (' + anno.contents + ')';
  137. 					line += ' /DS(font: Helvetica,sans-serif 12.0pt; text-align:left; color:#' + color + ')';
  138. 					line += ' /Border [0 0 0]';
  139. 					line += ' >>';
  140. 					this.internal.write(line);
  141. 					break;
  142. 				case 'link':
  143. 					if (anno.options.name) {
  144. 						var loc = this.annotations._nameMap[anno.options.name];
  145. 						anno.options.pageNumber = loc.page;
  146. 						anno.options.top = loc.y;
  147. 					} else {
  148. 						if (!anno.options.top) {
  149. 							anno.options.top = 0;
  150. 						}
  151. 					}
  153. 					var rect = "/Rect [" + getHorizontalCoordinateString(anno.x) + " " + getVerticalCoordinateString(anno.y) + " " + getHorizontalCoordinateString(anno.x + anno.w) + " " + getVerticalCoordinateString(anno.y + anno.h) + "] ";
  155. 					var line = '';
  156. 					if (anno.options.url) {
  157. 						line = '<</Type /Annot /Subtype /Link ' + rect + '/Border [0 0 0] /A <</S /URI /URI (' + anno.options.url + ') >>';
  158. 					} else if (anno.options.pageNumber) {
  159. 						// first page is 0
  160. 						var info = this.internal.getPageInfo(anno.options.pageNumber);
  161. 						line = '<</Type /Annot /Subtype /Link ' + rect + '/Border [0 0 0] /Dest [' + info.objId + " 0 R";
  162. 						anno.options.magFactor = anno.options.magFactor || "XYZ";
  163. 						switch (anno.options.magFactor) {
  164. 							case 'Fit':
  165. 								line += ' /Fit]';
  166. 								break;
  167. 							case 'FitH':
  168. 								line += ' /FitH ' + anno.options.top + ']';
  169. 								break;
  170. 							case 'FitV':
  171. 								anno.options.left = anno.options.left || 0;
  172. 								line += ' /FitV ' + anno.options.left + ']';
  173. 								break;
  174. 							case 'XYZ':
  175. 							default:
  176. 								var top = getVerticalCoordinateString(anno.options.top);
  177. 								anno.options.left = anno.options.left || 0;
  178. 								// 0 or null zoom will not change zoom factor
  179. 								if (typeof anno.options.zoom === 'undefined') {
  180. 									anno.options.zoom = 0;
  181. 								}
  182. 								line += ' /XYZ ' + anno.options.left + ' ' + top + ' ' + anno.options.zoom + ']';
  183. 								break;
  184. 						}
  185. 					}
  187. 					if (line != '') {
  188. 						line += " >>";
  189. 						this.internal.write(line);
  190. 					}
  191. 					break;
  192. 			}
  193. 		}
  194. 		this.internal.write("]");
  195. 	}]);
  197. 	/**
  198. 	* @name createAnnotation
  199. 	* @function
  200. 	* @param {Object} options 
  201. 	*/
  202. 	jsPDFAPI.createAnnotation = function (options) {
  203. 		var pageInfo = this.internal.getCurrentPageInfo();
  204. 		switch (options.type) {
  205. 			case 'link':
  206. 				this.link(options.bounds.x, options.bounds.y, options.bounds.w, options.bounds.h, options);
  207. 				break;
  208. 			case 'text':
  209. 			case 'freetext':
  210. 				pageInfo.pageContext.annotations.push(options);
  211. 				break;
  212. 		}
  213. 	}
  215. 	/**
  216. 	 * Create a link
  217. 	 *
  218. 	 * valid options
  219. 	 * <li> pageNumber or url [required]
  220. 	 * <p>If pageNumber is specified, top and zoom may also be specified</p>
  221. 	 * @name link
  222. 	 * @function
  223. 	 * @param {number} x
  224. 	 * @param {number} y
  225. 	 * @param {number} w
  226. 	 * @param {number} h
  227. 	 * @param {Object} options
  228. 	 */
  229. 	jsPDFAPI.link = function (x, y, w, h, options) {
  230. 		var pageInfo = this.internal.getCurrentPageInfo();
  231. 		pageInfo.pageContext.annotations.push({
  232. 			x: x,
  233. 			y: y,
  234. 			w: w,
  235. 			h: h,
  236. 			options: options,
  237. 			type: 'link'
  238. 		});
  239. 	};
  241. 	/**
  242. 	 * Currently only supports single line text.
  243. 	 * Returns the width of the text/link
  244. 	 *
  245. 	 * @name textWithLink
  246. 	 * @function
  247. 	 * @param {string} text
  248. 	 * @param {number} x
  249. 	 * @param {number} y
  250. 	 * @param {Object} options
  251. 	 * @returns {number} width the width of the text/link
  252. 	 */
  253. 	jsPDFAPI.textWithLink = function (text, x, y, options) {
  254. 		var width = this.getTextWidth(text);
  255. 		var height = this.internal.getLineHeight() / this.internal.scaleFactor;
  256. 		this.text(text, x, y, options);
  257. 		//TODO We really need the text baseline height to do this correctly.
  258. 		// Or ability to draw text on top, bottom, center, or baseline.
  259. 		y += height * .2;
  260. 		this.link(x, y - height, width, height, options);
  261. 		return width;
  262. 	};
  264. 	//TODO move into external library
  265. 	/**
  266. 	* @name getTextWidth
  267. 	* @function
  268. 	* @param {string} text
  269. 	* @returns {number} txtWidth
  270. 	*/
  271. 	jsPDFAPI.getTextWidth = function (text) {
  272. 		var fontSize = this.internal.getFontSize();
  273. 		var txtWidth = this.getStringUnitWidth(text) * fontSize / this.internal.scaleFactor;
  274. 		return txtWidth;
  275. 	};
  277. 	return this;
  279. })(jsPDF.API);