Skip to content

Added support for zoom factor in links #401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 26, 2014
Merged

Added support for zoom factor in links #401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2ce150
Added support for zoom factor in links
Flamenco Nov 24, 2014
1f5f0bc
Merge remote-tracking branch 'mr_rio/master'
Flamenco Nov 25, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 66 additions & 12 deletions jspdf.plugin.annotations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
* This plugin current supports <br />
* <li> Goto Page (set pageNumber in options)
* <li> Goto URL (set url in options)
*
* <p>
* The destination magnification factor can also be specified when goto is a page number or a named destination. (see documentation below)
* (set magFactor in options). XYZ is the default.
* </p>
* <p>
* Options In PDF spec Not Implemented Yet
* <li> link border
Expand All @@ -25,13 +28,22 @@
* </p>
*/

function notEmpty(obj) {
if (typeof obj != 'undefined') {
if (obj != '') {
return true;
}
}
}
/*
Destination Magnification Factors
See PDF 1.3 Page 386 for meanings and options

[supported]
XYZ (options; left top zoom)
Fit (no options)
FitH (options: top)
FitV (options: left)

[not supported]
FitR
FitB
FitBH
FitBV
*/

(function(jsPDFAPI) {
'use strict';
Expand All @@ -45,6 +57,14 @@ function notEmpty(obj) {

f2 : function(number) {
return number.toFixed(2);
},

notEmpty : function(obj) {
if (typeof obj != 'undefined') {
if (obj != '') {
return true;
}
}
}
};

Expand All @@ -64,7 +84,7 @@ function notEmpty(obj) {
for (var a = 0; a < pageAnnos.length; a++) {
var anno = pageAnnos[a];
if (anno.type === 'link') {
if (notEmpty(anno.options.url) || notEmpty(anno.options.pageNumber)) {
if (annotationPlugin.notEmpty(anno.options.url) || annotationPlugin.notEmpty(anno.options.pageNumber)) {
found = true;
break;
}
Expand All @@ -78,17 +98,50 @@ function notEmpty(obj) {
var f2 = this.annotationPlugin.f2;
for (var a = 0; a < pageAnnos.length; a++) {
var anno = pageAnnos[a];

var k = this.internal.scaleFactor;
var pageHeight = this.internal.pageSize.height;
//var pageHeight = this.internal.pageSize.height * this.internal.scaleFactor;
var rect = "/Rect [" + f2(anno.x * k) + " " + f2((pageHeight - anno.y) * k) + " " + f2(anno.x + anno.w * k) + " " + f2(pageHeight - (anno.y + anno.h) * k) + "] ";

var line = '';
if (anno.options.url) {
this.internal.write('<</Type /Annot /Subtype /Link ' + rect + '/Border [0 0 0] /A <</S /URI /URI (' + anno.options.url + ') >> >>')
line = '<</Type /Annot /Subtype /Link ' + rect + '/Border [0 0 0] /A <</S /URI /URI (' + anno.options.url + ') >>';
} else if (anno.options.pageNumber) {
// first page is 0
this.internal.write('<</Type /Annot /Subtype /Link ' + rect + '/Border [0 0 0] /Dest [' + (anno.options.pageNumber - 1) + ' /XYZ 0 ' + pageHeight + ' 0] >>')
var pageObjId = anno.options.pageNumber * 2 + 1;
line = '<</Type /Annot /Subtype /Link ' + rect + '/Border [0 0 0] /Dest [' + pageObjId + " 0 R";
anno.options.magFactor = anno.options.magFactor || "XYZ";
switch (anno.options.magFactor) {
case 'Fit':
line += ' /Fit]';
break;
case 'FitH':
anno.options.top = anno.options.top || f2(pageHeight * k);
line += ' /FitH ' + anno.options.top + ']';
break;
case 'FitV':
anno.options.left = anno.options.left || 0;
line += ' /FitV ' + anno.options.left + ']';
break;
case 'XYZ':
default:
anno.options.top = anno.options.top || f2(pageHeight * k);
anno.options.left = anno.options.left || 0;
// 0 or null zoom will not change zoom factor
if (typeof anno.options.zoom === 'undefined'){
anno.options.zoom = 0;
}
line += ' /XYZ ' + anno.options.left + ' ' + anno.options.top + ' ' + anno.options.zoom + ']';
break;
}
} else {
// TODO error - should not be here
}
if (line != '') {
line += " >>";
this.internal.write(line);
}
}
this.internal.write("]");
}
Expand All @@ -112,6 +165,7 @@ function notEmpty(obj) {

/**
* Currently only supports single line text.
* Returns the width of the text/link
*/
jsPDFAPI.textWithLink = function(text,x,y,options) {
'use strict';
Expand All @@ -122,7 +176,7 @@ function notEmpty(obj) {
// Or ability to draw text on top, bottom, center, or baseline.
y += height * .2;
this.link(x, y - height, width, height, options);
return this;
return width;
};

//TODO move into external library
Expand Down
24 changes: 24 additions & 0 deletions test/test_annotation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
// Create pages with a table of contents.
// TOC links to each page
// Each page links back to TOC and to an external URL
// Supported magnification Options are included.
var y = 20;
var text = 'Table of Contents';
pdf.text(text, 20, y);
Expand All @@ -40,8 +41,24 @@
text = "Page " + i;
pdf.textWithLink(text, 20, y, {pageNumber:i});
y += pdf.getLineHeight();

var x = 20;
var width = pdf.textWithLink(" [100%]", x, y, {pageNumber:i, magFactor:'XYZ', zoom:1});
x += width;
var width = pdf.textWithLink(" [200%]", x, y, {pageNumber:i, magFactor:'XYZ', zoom:2});
x += width;
var width = pdf.textWithLink(" [50%]", x, y, {pageNumber:i, magFactor:'XYZ', zoom:.5});
x += width;
var width = pdf.textWithLink(" [Fit]", x, y, {pageNumber:i, magFactor:'Fit'});
x += width;
var width = pdf.textWithLink(" [FitH]", x, y, {pageNumber:i, magFactor:'FitH'});
x += width;
var width = pdf.textWithLink(" [FitV]", x, y, {pageNumber:i, magFactor:'FitV'});

y += pdf.getLineHeight();
}

// Create Test Pages
for (var i=2; i<10; i++){
pdf.addPage();
y = 20;
Expand Down Expand Up @@ -99,6 +116,13 @@
</head>

<body style='background-color: silver; margin: 0;'>
<p>
Chrome default PDF reader currently does not support magFactor links, although links still work after manualy changing magFactor.
<br />
Firefox has a bug displaying annotations after the magFactor changes, but links do work.
<br />
To test magFactor links [...] without bugs, use Adobe Reader or compatible application.
</p>
<pre id='sourcecode'></pre>
<iframe id='pdfframe' style='width: 100%; height: 100%; position: absolute'></iframe>
</body>
Expand Down